Qargo Use case / Accounting API
Required role: `API_ACCOUNTING`.See [Accounting](/docs/section/accounting) for more information.
Qargo Use case / Accounting 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 / Accounting. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 48 operations across 36 paths, and defines 94 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.
48 operations
36 paths
94 schemas
1 DELETE24 GET8 PATCH14 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qargo Use case / Accounting 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 48
Across 36 paths, the API surfaces 48 operations — 1 DELETE, 24 GET, 8 PATCH, 14 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Use case / Accounting 48
Required role: APIACCOUNTING. See [Accounting](/docs/section/accounting) for more information.
GET
/v1/accounting/accounts
List Accounts
GET
/v1/accounting/accounts/{id}
Retrieve Account
POST
/v1/accounting/exchange-rate
Create An Exchange Rate
GET
/v1/accounting/exchange-rate
List Exchange Rates
GET
/v1/accounting/purchase-credit-note/{id}
Retrieve Purchase Credit Note
PATCH
/v1/accounting/purchase-credit-note/{id}
Update Purchase Credit Note
GET
/v1/accounting/purchase-credit-note/{id}/documents
Retrieve Purchase Credit Note Documents
POST
/v1/accounting/purchase-credit-note/{id}/refund/update-status
Report Refund Status For Purchase Credit Note
GET
/v1/accounting/purchase-invoice/{id}
Retrieve Purchase Invoice
PATCH
/v1/accounting/purchase-invoice/{id}
Update Purchase Invoice
GET
/v1/accounting/purchase-invoice/{id}/documents
Retrieve Purchase Invoice Documents
POST
/v1/accounting/purchase-invoice/{id}/payment/update-status
Report Payment Status For Purchase Invoice
POST
/v1/accounting/sales-credit-note/
Create A Sales Credit Note
GET
/v1/accounting/sales-credit-note/{id}
Retrieve Sales Credit Note
PATCH
/v1/accounting/sales-credit-note/{id}
Update Credit Note
GET
/v1/accounting/sales-credit-note/{id}/documents
Retrieve Sales Credit Note Documents
POST
/v1/accounting/sales-credit-note/{id}/refund/update-status
Report Refund Status For Sales Credit Note
POST
/v1/accounting/sales-invoice/
Create A Sales Invoice
GET
/v1/accounting/sales-invoice/{id}
Retrieve Sales Invoice
PATCH
/v1/accounting/sales-invoice/{id}
Update Sales Invoice
GET
/v1/accounting/sales-invoice/{id}/documents
Retrieve Sales Invoice Documents
POST
/v1/accounting/sales-invoice/{id}/payment/update-status
Report Payment Status For Sales Invoice
GET
/v1/accounting/sync-tasks
List Invoices/Credit Notes To Sync
GET
/v1/accounting/sync-tasks/{id}
Get Details Of Invoice/Credit Note To Sync
POST
/v1/accounting/sync-tasks/{id}/update-status
Report Sync Status For Invoice/Credit Note
GET
/v1/accounting/tax-rates
List Tax Rates
GET
/v1/accounting/tax-rates/{id}
Retrieve Tax Rate
GET
/v1/documents/document/{id}/download
Download Document
POST
/v1/webhook/billing-document-update
External Billing Document (Invoice/Credit-Note) Update
POST
https://
Accounting Visibility Event
GET
/v1/accounting/companydeprecated
List Companies (Deprecated)
POST
/v1/accounting/companydeprecated
Create Company (Deprecated)
GET
/v1/accounting/company/{id}deprecated
Get Company (Deprecated)
PUT
/v1/accounting/company/{id}deprecated
Update Company (Deprecated)
PATCH
/v1/accounting/company/{id}deprecated
Update Company (Deprecated)
DELETE
/v1/accounting/company/{id}deprecated
Archive Company (Deprecated)
GET
/v1/accounting/purchase_invoice/{id}deprecated
Retrieve Purchase Invoice (Deprecated)
PATCH
/v1/accounting/purchase_invoice/{id}deprecated
Update Purchase Invoice (Deprecated)
GET
/v1/accounting/purchase_invoice/{id}/documentsdeprecated
Retrieve Purchase Invoice Documents (Deprecated)
POST
/v1/accounting/purchase_invoice/{id}/payment/update-statusdeprecated
Report Payment Status For Purchase Invoice (Deprecated)
GET
/v1/accounting/sales_credit_note/{id}deprecated
Retrieve Sales Credit Note (Deprecated)
PATCH
/v1/accounting/sales_credit_note/{id}deprecated
Update Credit Note (Deprecated)
GET
/v1/accounting/sales_credit_note/{id}/documentsdeprecated
Retrieve Sales Credit Note Documents (Deprecated)
POST
/v1/accounting/sales_credit_note/{id}/refund/update-statusdeprecated
Report Refund Status For Sales Credit Note (Deprecated)
GET
/v1/accounting/sales_invoice/{id}deprecated
Retrieve Sales Invoice (Deprecated)
PATCH
/v1/accounting/sales_invoice/{id}deprecated
Update Sales Invoice (Deprecated)
GET
/v1/accounting/sales_invoice/{id}/documentsdeprecated
Retrieve Sales Invoice Documents (Deprecated)
POST
/v1/accounting/sales_invoice/{id}/payment/update-statusdeprecated
Report Payment Status For Sales Invoice (Deprecated)
Schemas 94
The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are CompanyDetailOutput (30 properties), CompanyInput (27 properties), CompanyPartialInput (27 properties), LineItem (22 properties). Each schema is shown below with its type and property counts.
LineItem
object
Represents a single invoice/credit line item. Note that a single invoice line can be split up in multiple line items if revenue split is enabled.
22 properties
6 required
SalesCreditNoteOutput
object
15 properties
10 required
CompanyInput
object
27 properties
1 required
PriceListItemReference
object
1 property
1 required
ListTaxRateOutput
object
2 properties
1 required
AvailableTasks
object
1 property
1 required
BasePaymentTerm
object
1 property
1 required
SalesInvoiceMatch
object
1 property
ValidationErrorResponse
object
2 properties
2 required
TaskStatusInput
string
CompanyDetailOutput
object
30 properties
8 required
SalesCompanyFields-Output
object
3 properties
BillingEntity
object
6 properties
5 required
BillingDocumentMatchTarget
object
1 property
SubcontractorStatus
string
PurchaseCreditNoteStatusUpdate
object
3 properties
3 required
PurchaseInvoiceStatusUpdate
object
3 properties
3 required
TaskInstanceExecutionMetadata
object
1 property
ExchangeRateInput
object
5 properties
5 required
BillingDocumentMatchInput
object
1 property
1 required
RefundStatusUpdate
object
1 property
1 required
CurrencyCode
string
api__accounting__models__invoice__TaxRate
object
5 properties
ListCompanyOutput
object
2 properties
1 required
HTTPValidationError
object
1 property
InvoiceStatus
string
Status description: - DRAFT: Invoice is in draft state and not yet invoiced. - PREINVOICED: Invoice is in pre-invoiced state and not yet invoiced (Purchase inv…
TaxRateType
string
TaxRateInvoiceType
string
SalesInvoicePatchInput
object
1 property
PurchaseCompanyFields-Output
object
3 properties
PaymentStatus
string
ExchangeRate
object
3 properties
2 required
TaskStatus
string
TaskType
string
TaxTypeEnum
string
ExchangeRateOutput
object
6 properties
6 required
SalesCreditNotePatchInput
object
1 property
api__order__models__charge__AccountOutput
object
1 property
PurchaseCreditNote
object
15 properties
10 required
ChargeInput
object
6 properties
2 required
ValidationError
object
3 properties
3 required
TaxRateReference
object
1 property
1 required
SalesInvoiceOutput
object
16 properties
11 required
SalesInvoiceUpdate
object
3 properties
ListAccountOutput
object
2 properties
1 required
TaskUpdateInput
object
Update task status on completion/failure. The failure field can be used to provide more information on failure.
2 properties
1 required
SalesInvoiceInput
object
9 properties
4 required
TaskPayload
object
Task execution input data.
4 properties
3 required
ListExchangeRateOutput
object
2 properties
1 required
BillingEntityReference
object
1 property
1 required
Document
object
6 properties
4 required
CompanyPartialInput
object
27 properties
RefundStatus
string
SalesCreditNoteStatusUpdate
object
3 properties
3 required
PurchaseInvoice
object
16 properties
11 required
CustomerStatus
string
AccountingVisibilityUpdate
object
2 properties
2 required
CreditNoteStatus
string
Status description: - DRAFT: Credit note is in draft state and not yet credited. - PREINVOICED: Credit note is in pre-invoiced state and not yet credited (Purc…
TaskUpdate
object
Update task status result.
1 property
1 required
PurchaseCompanyFields-Input
object
3 properties
SalesCompanyFields-Input
object
3 properties
CompanySummaryOutput
object
17 properties
3 required
ErrorType
string
FieldMatchInput
object
1 property
TaxRateOutput
object
10 properties
9 required
api__accounting__models__company__CompanyReferenceOutput
object
3 properties
2 required
SubjectType
string
ContactType
string
SalesInvoiceStatusUpdate
object
3 properties
3 required
PaymentTermCode
string
BankAccount
object
2 properties
BillingDocumentUpdate
object
1 property
CompanyContactInput
object
7 properties
ExternalExecutionMetadata
object
1 property
ValidationErrorDetail
object
4 properties
1 required
BillingDocumentUpdatePayload
object
1 property
PurchaseCreditNoteInput
object
1 property
CreditPolicyInput
object
1 property
SalesCreditNoteInput
object
8 properties
4 required
LocationOutput
object
13 properties
BaseTaxRate
object
Original base tax rate, before applying customer/transport specific tax rules.
1 property
EInvoicingOutput
object
3 properties
CompanyBillingEntity
object
3 properties
CustomerReference
object
2 properties
api__accounting__models__master_data__AccountOutput
object
5 properties
5 required
CompanyContactOutput
object
6 properties
TaskFailureStatus
object
2 properties
1 required
TaskDetail
object
6 properties
3 required
PurchaseInvoiceInput
object
1 property
BillingLocation
object
10 properties
CompanyReferenceNumbers
object
5 properties
PaymentStatusUpdate
object
1 property
1 required
CreditPolicyOutput
object
1 property
AvailableTask
object
Reference to a task available for processing.
4 properties
3 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 / Customer portal API
#Use case / Accounting