Bill.com API Reference Overview

Use the Bill.com API to integrate your application with Bill.com's Accounts Receivable (AR) and Accounts Payable (AP) automation capabilities.

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

Prerequisites

Sign up to create your Bill.com sandbox developer account. Retrieve your userName, password, orgId, and devKey.

Sign in credentials

Description

Username

Your username is the email address used to sign in to your Bill.com sandbox developer account.

Password

Your password is used to sign in to your Bill.com sandbox developer account.

Organization ID

Your Bill.com sandbox developer account represents your organization in Bill.com. The organization ID is a unique alphanumeric value that begins with 008.

Developer key

Your developer key is used to uniquely identify your developer account in your API requests.

Sandbox API base URL

https://api-sandbox.bill.com/api/v2/

Test with the /Login.json cURL command

Sign in to your Bill.com sandbox developer account with the /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 /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 sandbox sign up process. See Bill.com 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.com 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 /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 /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.