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

👍
Important
This section is about sign-up and authentication to begin testing with the BILL AP & AR API. See Authentication with Spend & Expense API token for information about authentication for the Spend & Expense API endpoints.

Use the BILL v3 API to integrate your application with the BILL AP and AR 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 v3 API. See Sandbox API sign up for more information.

When your sign-up is complete, you can sign in with POST/v3/login. You can then perform a set of BILL v3 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 POST /v3/login API endpoint. The required fields for signing in are username, password, organizationId, and devKey.

Sign in credentials	Description
Username	Your username is the email address used to sign in to your BILL developer account.
Password	Your password is used to sign in to your BILL developer account.
Organization ID	Your BILL developer account represents your organization in BILL. The organization ID is a unique alphanumeric value that begins with `008`.
Developer key	Your developer key is used to identify your developer account in your API requests.

You sign in as an organization user

When you sign in to your BILL developer account, you sign in as a user of your BILL organization. In the API response, userId is the BILL-generated ID of the signed-in user.

👍
Who is a BILL partner?
A BILL partner can perform partner-level operations, which includes creating an organization, and then creating and managing users for that organization. See BILL partner operations for more information.
If you are interested in becoming a BILL partner, please reach out to your account manager for more information.

Sample API login request

In this cURL example, you sign in to your BILL developer account in the API sandbox environment with POST /v3/login. See Sandbox vs Production for information about the API sandbox and production environments.

📘
The v3 API header value
The header value in the v3 API requests is content-type: application/json.

curl --request POST \
--url 'https://gateway.stage.bill.com/connect/v3/login' \
--header 'content-type: application/json' \
--data '{
  "username": "{username}", 
  "password": "{password}",
  "organizationId": "{organization_id}", 
  "devKey": "{developer_key}"
}'

Response

In the response, your API session is created and a generated sessionId is available. Use the sessionId in all subsequent API calls to confirm that you are in a signed-in API session. In addition, userId is the BILL-generated ID of the signed-in user.

{
    "sessionId": "{session_id}",
    "organizationId": "{organization_id}",
    "userId": "{user_id}",
    "trusted": false

}

`sessionId` properties

If your API session is inactive for 35 minutes, the session expires and you are automatically signed out. In addition, when you sign in with POST /v3/login, the generated sessionId in the response is available only for the selected devKey in your request. This sessionId does not work with another devKey.

See API login in the API reference for more information.