Sign up process

Developer environments

There are two API environments available for developers.

• Production environment
  The Production environment is where all the accounting actions, such as invoices, bills, money movements, and schedules occur. For more information on the Production environment, see Production Environment.
• Sandbox environment
  The Sandbox environment is provided to test your application logic and confirm your expectation of the APIs. The Sandbox environment is completely standalone and does not affect your Production environment. For more information on the Sandbox environment, see Sandbox Environment.

Sandbox sign up process

Complete the sandbox sign up process to begin building and testing with the Bill.com API.

1. Reach out to your Bill.com sales representative or account manager to begin the sign up process.
2. Your contact reviews your request and reaches out to you to discuss your objectives. In addition, they walk you through creating your Bill.com sandbox developer account.
3. After creating your account, set your password and sign in to your Bill.com sandbox web app. This account also represents your organization in the sandbox environment. See Organization for more information.
4. The Bill.com team provisions API access to your account. In a separate email, we send you the information required for your API sign-in.

API sign in

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 \
'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. Use the sessionId in all subsequent API calls to confirm that you are in a signed in session. See Login for more information.

Retrieve your organization ID

You can retrieve the organization ID (orgId) linked to your sandbox account with /ListOrgs.json.

curl --request POST \
'https://api-sandbox.bill.com/api/v2/ListOrgs.json' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data 'devKey={developer_key}' \
--data 'userName={email_address}' \
--data 'password={password}'

See ListOrgs for more information.

What's next

Once your account has been created, go through the Startup Checklist.

• New UI's Get Started Checklist
• Traditional UI's Startup Checklist (to be deprecated)