API Key Practical Use
Use API key and Party ID for Authentication
Usage instructions:
-
- For general API calls, include your API Key in the request header.
- To specify the company for the API call, include the Company/PartyID in the request. This detail is essential when your account is linked to multiple companies.
- For accountants managing multiple companies, include both the ContextCompanyID (accountant's ID) and the PartyID (company's ID) in the request headers.
Summary
| Requried | Header field name | Example Value |
|---|---|---|
| Yes | apiKey | "YourAPIKey" |
| As Needed | partyID | Company ID |
| For accountants cases | ContextPartyID | Accountant's Company ID |
Where to find
Your API Key is found under 'Profile' -> 'Users & API Key'.
My profile:
API key in Detail Screen My Profile
Party ID: click on My company, and in the URL the company ID will appears (numeric):
Usage instructions:
The Base URL in the Endpoint should refer to Sandbox or Production : https://docs.billit.be/docs/sandbox-vs-production-1
When you start with sandbox, this is: https://my.sandbox.billit.be.
Updated 1 day ago