BILL API Reference Overview

The API Reference section enables you to view sample code in your choice of language and also test API calls in the documentation.

Use the BILL API to integrate your application with BILL Accounts Receivable (AR) and Accounts Payable (AP) automation capabilities. When you begin testing with the BILL API, you are in the API sandbox environment.

Sandbox API sign up

Your first step is to sign-up and set up your credentials for working with the BILL v2 API. See Sandbox API sign up for more information.

When your sign-up is complete, you can sign in with /v2/Login.json. You can then perform a set of BILL API operations. This includes adding a vendor, creating a bill, setting up an organization bank account, and submitting a payment.

Prerequisites

Sign in to your BILL developer account with the /v2/Login.json API endpoint. The required fields for signing in are username, password, orgId, and devKey.

Test with the /v2/Login.json cURL command

Sign in to your BILL sandbox developer account with the /v2/Login.json API endpoint. The required fields for signing in are userName, password, orgId, and devKey.

Set the required values in the cURL command example and run the command in the Mac Terminal, Windows Command Prompt, or your choice of command line interface.

curl --request POST \
--url 'https://api-sandbox.bill.com/api/v2/Login.json' \
--header 'content-type: application/x-www-form-urlencoded' \
--data 'userName={username}' \
--data 'password={password}' \
--data 'orgId={organization_id}' \
--data 'devKey={developer_key}'

In the response, your API session is created and a sessionId is generated. Save this sessionId value. All subsequent API requests require a sessionId and devKey for confirming that you are in a signed-in session.

Test with /v2/Login.json on this website

You can fill in required fields, test sandbox API calls, and retrieve server responses on this website.

1. Select Login > Login.
2. In the FORM DATA section, enter userName, password, devKey, and orgId. You retrieve these values as part of your API sandbox sign up process. See BILL sign up process for more information.
3. Click Try It!. In the response, a sessionId is generated.

Save this sessionId value. All subsequent API requests require a sessionId and devKey for confirming that you are in a signed in session.

👍

View example API requests

In the REQUEST section of any API endpoint, select Request Example from the Examples list to view an example API request with all the fields and their respective data types displayed.

API reference documentation

The API request and response fields are documented for each BILL API endpoint.

Request fields

In the FORM DATA section, you can view the documentation for each request field. If an API request requires additional objects, expand the object to view the documentation for each request field.

For example, in the /v2/Crud/Create/Customer.json endpoint (Customers > Create a customer), the FORM DATA section lists the documentation for each request field. Expand the DATA OBJECT to view the documentation for each request field.

Response fields

In the RESPONSE section, you can view the documentation for each response field.

For example, in the /v2/Crud/Create/Customer.json endpoint (Customers > Create a customer), the RESPONSE section lists the documentation for each response field. Click 200 Success to view the documentation for each response field.

More information

See Using this website to learn about using this API documentation website.