API / Company
Use case / Master data sync
List Companies
Changed onget/v1/companies/company
Request
- Base URL: https://api.qargo.com
- URL: https://api.qargo.com/v1/companies/company
- Auth: OAuth 2 (client credentials, token URL /v1/auth/token)
Query parameters
cursorstring nullable
Pagination cursor. Mutually exclusive with other query parameters
updated_afterstring date-time nullable
Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ
codestring nullable
Company code to match exactly.
code:instring nullable
Company codes to match. Comma-separated list.
accounting_customer_codestring nullable
Accounting customer code to match exactly. Holds the code of the default billing entity.
accounting_customer_code:instring nullable
Accounting customer codes to match. Comma-separated list. Holds the code of the default billing entity.
Response
Successful Response
Example response
{
"items": [
{
"currency": "EUR",
"name": "John Doe",
"legal_name": "John Doe",
"vat_number": "BE1234.123.123",
"accounting_code": "1234",
"billing_location": {
"code": "LOC123",
"display_name": "Main Office",
"address": "Gaston Crommenlaan 4",
"city": "Ghent",
"country": "BE",
"postal_code": "9050",
"name": "Qargo HQ"
},
"locale": "en",
"credit_policy": {
"limit": 10000
},
"default_invoice_customer": {
"name": "John Doe",
"code": "CUST-001"
},
"contacts": [
{
"name": "John Doe",
"phone_number": "+32485123456"
}
],
"credit_limit_total": 12000
}
]
}Changes
- warning
added the new
UK_REVERSE_CHARGEenum value to the///response property for the response status
- warning
- info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status
- info