Qargo Use case / Master data sync API
Required api role: `API_MASTER_DATA`, or `API_ACCOUNTING` for company sync only.
Qargo Use case / Master data sync API is one of 26 APIs that Qargo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Use case / Master data sync. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 37 operations across 18 paths, and defines 111 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.
Requests are made against a single base URL, https://api.qargo.com.
37 operations
18 paths
111 schemas
5 DELETE18 GET2 PATCH7 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qargo Use case / Master data sync API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow.
It accepts HTTP basic authentication (BasicAuthWebhookCredentials).
Paths & Operations 37
Across 18 paths, the API surfaces 37 operations — 5 DELETE, 18 GET, 2 PATCH, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Use case / Master data sync 37
Required api role: APIMASTERDATA, or APIACCOUNTING for company sync only.
GET
/v1/accounting/accounts
List Accounts
POST
/v1/accounting/exchange-rate
Create An Exchange Rate
GET
/v1/accounting/exchange-rate
List Exchange Rates
GET
/v1/accounting/tax-rates
List Tax Rates
GET
/v1/documents/document/{id}/download
Download Document
GET
/v1/companies/company
List Companies
POST
/v1/companies/company
Create Company
GET
/v1/companies/company/{company_id}/documents
Get Company Documents
POST
/v1/companies/company/{company_id}/documents
Create Company Document
GET
/v1/companies/company/{company_id}/validity
List Company Validities
POST
/v1/companies/company/{company_id}/validity
Create Company Validity Request
GET
/v1/companies/company/{company_id}/validity/{id}
Get Company Validity
PUT
/v1/companies/company/{company_id}/validity/{id}
Update Company Validity
DELETE
/v1/companies/company/{company_id}/validity/{id}
Delete Company Validity
GET
/v1/companies/company/{company_id}/validity/{id}/documents
Get Company Validity Documents
GET
/v1/companies/company/{id}
Get Company
PUT
/v1/companies/company/{id}
Update Company
PATCH
/v1/companies/company/{id}
Update Company
DELETE
/v1/companies/company/{id}
Archive Company
POST
/v1/resources/resource
Create Resource
GET
/v1/resources/resource
List Resources
PUT
/v1/resources/resource/{resource_id}
Update Resource
PATCH
/v1/resources/resource/{resource_id}
Patch Resource
DELETE
/v1/resources/resource/{resource_id}
Archive Resource
GET
/v1/resources/resource/{resource_id}
Get Resource
GET
/v1/resources/resource/{resource_id}/unavailability
List Resource Unavailabilities
POST
/v1/resources/resource/{resource_id}/unavailability
Create Resource Unavailabilities
GET
/v1/resources/resource/{resource_id}/unavailability/{id}
Get Resource Unavailability
PUT
/v1/resources/resource/{resource_id}/unavailability/{id}
Update Resource Unavailabilities
DELETE
/v1/resources/resource/{resource_id}/unavailability/{id}
Delete Resource Unavailabilities
GET
/v1/resources/resource/{resource_id}/validity
List Resource Validities
POST
/v1/resources/resource/{resource_id}/validity
Create Resource Validity Request
GET
/v1/resources/resource/{resource_id}/validity/{id}
Get Resource Validity
PUT
/v1/resources/resource/{resource_id}/validity/{id}
Update Resource Validity
DELETE
/v1/resources/resource/{resource_id}/validity/{id}
Delete Resource Validity
GET
/v1/resources/resource/{resource_id}/validity/{id}/documents
Get Resource Validity Documents
GET
/v1/resources/resource_groups
List Resource Groups
Schemas 111
The contract defines 111 schemas that model the data the API accepts and returns. The most detailed are CompanyDetailOutput (30 properties), CompanyPartialInput (27 properties), CompanyInput (27 properties), DriverResourceOutput (16 properties). Each schema is shown below with its type and property counts.
VanProperties-Output
object
16 properties
ResourceExtraOutput
object
3 properties
3 required
TractorResourceInput
object
11 properties
1 required
SubcontractorValidityReason
string
ListResourceGroupOutput
object
2 properties
1 required
PartialDriverResourceInput
object
12 properties
ContainerResourceInput
object
11 properties
1 required
VanResourceInput
object
11 properties
1 required
TrailerProperties-Input
object
13 properties
CompanyInput
object
27 properties
1 required
ListTaxRateOutput
object
2 properties
1 required
TruckProperties-Output
object
16 properties
BasePaymentTerm
object
1 property
1 required
UploadedDocumentBase_Union_ContainerDocumentTypes__DriverDocumentTypes__VehicleDocumentTypes__
object
3 properties
3 required
ValidationErrorResponse
object
2 properties
2 required
ListResourceOutput
object
2 properties
1 required
CompanyDetailOutput
object
30 properties
8 required
SalesCompanyFields-Output
object
3 properties
BillingEntity
object
6 properties
5 required
DriverResourceOutput
object
16 properties
2 required
SubcontractorStatus
string
ExchangeRateInput
object
5 properties
5 required
ResourceValidityOutput
object
8 properties
3 required
PartialVanResourceInput
object
12 properties
CurrencyCode
string
ContainerProperties
object
4 properties
UploadedDocumentBase_Union_SubcontractorDocumentWithValidityTypeInput__SubcontractorInsuranceDocumentTypeInput__
object
3 properties
3 required
ListCompanyOutput
object
2 properties
1 required
HTTPValidationError
object
1 property
CompanyValidity
object
7 properties
2 required
TaxRateType
string
SubcontractorDocumentWithValidityTypeInput
string
TaxRateInvoiceType
string
ResourceTypeEnum
string
PurchaseCompanyFields-Output
object
3 properties
PartialBaseResourceInput
object
11 properties
ChassisResourceInput
object
11 properties
1 required
PartialChassisResourceInput
object
12 properties
ResourceValidityReason
string
VanProperties-Input
object
16 properties
UnavailabilityReason
string
TaxTypeEnum
string
ResourceUnavailabilityInput
object
5 properties
2 required
PartialTruckResourceInput
object
12 properties
ChassisProperties-Input
object
10 properties
TractorProperties-Output
object
11 properties
ExchangeRateOutput
object
6 properties
6 required
ResourceGroupOutput
object
3 properties
1 required
ResourceGroupReference
object
1 property
1 required
UploadedCompanyDocumentWithValidity
object
4 properties
3 required
CompanyReference
object
1 property
1 required
CompanyValidityOutput
object
8 properties
3 required
CompanyDocumentOutput
object
7 properties
4 required
TruckResourceOutput
object
16 properties
2 required
ListCompanyDocumentOutput
object
2 properties
1 required
ListResourceValidityOutput
object
2 properties
1 required
ValidationError
object
3 properties
3 required
PartialTrailerResourceInput
object
12 properties
ListAccountOutput
object
2 properties
1 required
ChassisProperties-Output
object
10 properties
ChassisResourceOutput
object
16 properties
2 required
TractorProperties-Input
object
11 properties
ListResourceUnavailabilityOutput
object
2 properties
1 required
ResourceValidityInput
object
8 properties
2 required
ListExchangeRateOutput
object
2 properties
1 required
BillingEntityReference
object
1 property
1 required
DriverProperties
object
6 properties
Document
object
6 properties
4 required
CompanyPartialInput
object
27 properties
ListCompanyValidityOutput
object
2 properties
1 required
CustomerStatus
string
PurchaseCompanyFields-Input
object
3 properties
DriverDocumentTypes
string
SubcontractorDocumentWithoutValidityTypeInput
string
SalesCompanyFields-Input
object
3 properties
ContainerDocumentTypes
string
FullTrailerResourceInput
object
11 properties
1 required
TaxRateOutput
object
10 properties
9 required
ResourceExtraInput
object
1 property
1 required
api__accounting__models__company__CompanyReferenceOutput
object
3 properties
2 required
CompanyValidityInput
object
8 properties
2 required
TruckProperties-Input
object
16 properties
ContactType
string
PaymentTermCode
string
BankAccount
object
2 properties
CompanyContactInput
object
7 properties
TractorResourceOutput
object
16 properties
2 required
ValidationErrorDetail
object
4 properties
1 required
TruckResourceInput
object
11 properties
1 required
TrailerResourceOutput
object
16 properties
2 required
CreditPolicyInput
object
1 property
PartialTractorResourceInput
object
12 properties
LocationOutput
object
13 properties
CompanyBillingEntity
object
3 properties
VanResourceOutput
object
16 properties
2 required
VehicleDocumentTypes
string
TrailerProperties-Output
object
13 properties
api__accounting__models__master_data__AccountOutput
object
5 properties
5 required
CompanyContactOutput
object
6 properties
TrailerResourceInput
object
11 properties
1 required
FullTrailerResourceOutput
object
16 properties
2 required
ContainerResourceOutput
object
16 properties
2 required
DriverResourceInput
object
11 properties
1 required
BillingLocation
object
10 properties
CustomerDocumentTypeInput
string
CompanyReferenceNumbers
object
5 properties
ResourceUnavailabilityOutput
object
6 properties
3 required
SubcontractorInsuranceDocumentTypeInput
string
PartialFullTrailerResourceInput
object
12 properties
CreditPolicyOutput
object
1 property
LocationReference
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qargo 12
Other APIs Qargo publishes across the network.
Qargo Subcontractor API
Qargo Customer API
Qargo API / Accounting API
Qargo API / Authentication API
Qargo API / Company API
Qargo API / Document API
Qargo API / Order API
Qargo API / Resource API
Qargo API / Task API
Qargo API / Trip API
Qargo System API
Qargo Use case / Accounting API
#Use case / Master data sync