{ "opencollection": "1.0.0", "info": { "name": "Qargo TMS API / Accounting Use case / Master data sync API", "version": "1.2.0" }, "items": [ { "info": { "name": "Use case / Master data sync", "type": "folder" }, "items": [ { "info": { "name": "List Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/accounting/accounts", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "archived", "value": "", "type": "query", "description": "Filter by archived status. Omit to return all accounts." }, { "name": "billing_entity_code", "value": "", "type": "query", "description": "Filter by billing entity code." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists accounting codes (GL / nominal codes) for the tenant, with optional filtering and pagination." }, { "info": { "name": "List Exchange Rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/accounting/exchange-rate", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "from_currency", "value": "", "type": "query", "description": "Filter by source currency code (ISO 4217)." }, { "name": "to_currency", "value": "", "type": "query", "description": "Filter by target currency code (ISO 4217)." }, { "name": "exchange_rate_date:gte", "value": "", "type": "query", "description": "Filter exchange rates on or after this date." }, { "name": "exchange_rate_date:lte", "value": "", "type": "query", "description": "Filter exchange rates on or before this date." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a list of exchange rates with optional currency and date filters. When filtering by both from_currency and to_currency, results are returned in the requested direction regardless of how they are stored internally." }, { "info": { "name": "Create An Exchange Rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.qargo.com/v1/accounting/exchange-rate", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an exchange rate in Qargo for the given currency pair and date." }, { "info": { "name": "List Tax Rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/accounting/tax-rates", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "archived", "value": "", "type": "query", "description": "Filter by archived status. Omit to return all tax rates." }, { "name": "billing_entity_code", "value": "", "type": "query", "description": "Filter by billing entity code." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists tax rates for the tenant, with optional filtering and pagination." }, { "info": { "name": "Download Document", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/documents/document/:id/download", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "direct", "value": "", "type": "query", "description": "Query parameter to indicate that the response should contain all the document bytes" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Download a document by its ID. You can choose to download the document directly or stream it." }, { "info": { "name": "List Companies", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/companies/company", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "updated_after", "value": "", "type": "query", "description": "Filter to fetch the companies updated after this time. Format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List Companies" }, { "info": { "name": "Create Company", "type": "http" }, "http": { "method": "POST", "url": "https://api.qargo.com/v1/companies/company", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create Company" }, { "info": { "name": "Get Company Documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/companies/company/:company_id/documents", "params": [ { "name": "company_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetch all documents for a specific company." }, { "info": { "name": "Create Company Document", "type": "http" }, "http": { "method": "POST", "url": "https://api.qargo.com/v1/companies/company/:company_id/documents", "params": [ { "name": "company_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload a document for a specific company." }, { "info": { "name": "List Company Validities", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/companies/company/:company_id/validity", "params": [ { "name": "company_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "start_time", "value": "", "type": "query", "description": "Filter to fetch unavailabilities after this time" }, { "name": "end_time", "value": "", "type": "query", "description": "Filter to fetch unavailabilities before this time" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all validities for a company." }, { "info": { "name": "Create Company Validity Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.qargo.com/v1/companies/company/:company_id/validity", "params": [ { "name": "company_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new validity request for a company." }, { "info": { "name": "Get Company Validity", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/companies/company/:company_id/validity/:id", "params": [ { "name": "company_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetches a specific validity for a company." }, { "info": { "name": "Update Company Validity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qargo.com/v1/companies/company/:company_id/validity/:id", "params": [ { "name": "company_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing validity for a company." }, { "info": { "name": "Delete Company Validity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qargo.com/v1/companies/company/:company_id/validity/:id", "params": [ { "name": "company_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a company validity." }, { "info": { "name": "Get Company Validity Documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/companies/company/:company_id/validity/:id/documents", "params": [ { "name": "company_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetch all documents associated with a specific company validity." }, { "info": { "name": "Get Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/companies/company/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Company" }, { "info": { "name": "Update Company", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qargo.com/v1/companies/company/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update Company" }, { "info": { "name": "Update Company", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.qargo.com/v1/companies/company/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update Company" }, { "info": { "name": "Archive Company", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qargo.com/v1/companies/company/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Archive the company. This is a soft-delete: the company record is preserved and its `archived_customer`, `archived_subcontractor`, and `archived_buyer_or_seller` flags are set to `true` so it no longer appears in active lists." }, { "info": { "name": "List Resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "updated_after", "value": "", "type": "query", "description": "Filter to fetch the resources updated after this time. Timestamp format is ISO 8601 YYYY-MM-DDTHH:MM:SSZ" }, { "name": "external_id", "value": "", "type": "query", "description": "External resource identifier to match exactly." }, { "name": "external_id:in", "value": "", "type": "query", "description": "External resource identifiers to match. Comma-separated list." }, { "name": "resource_type", "value": "", "type": "query", "description": "Resource type to match exactly." }, { "name": "resource_type:in", "value": "", "type": "query", "description": "Resource types to match. Comma-separated list." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all resources" }, { "info": { "name": "Create Resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.qargo.com/v1/resources/resource", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new resource." }, { "info": { "name": "Get Resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource/:resource_id", "params": [ { "name": "resource_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetches a resource" }, { "info": { "name": "Update Resource", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qargo.com/v1/resources/resource/:resource_id", "params": [ { "name": "resource_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing resource." }, { "info": { "name": "Patch Resource", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.qargo.com/v1/resources/resource/:resource_id", "params": [ { "name": "resource_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Partially update an existing resource." }, { "info": { "name": "Archive Resource", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qargo.com/v1/resources/resource/:resource_id", "params": [ { "name": "resource_id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Archive a resource" }, { "info": { "name": "List Resource Unavailabilities", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/unavailability", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "start_time", "value": "", "type": "query", "description": "Filter to fetch unavailabilities after this time" }, { "name": "end_time", "value": "", "type": "query", "description": "Filter to fetch unavailabilities before this time" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all unavailabilities for a resource" }, { "info": { "name": "Create Resource Unavailabilities", "type": "http" }, "http": { "method": "POST", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/unavailability", "params": [ { "name": "resource_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new unavailability for a resource." }, { "info": { "name": "Get Resource Unavailability", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/unavailability/:id", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetch a resource unavailability" }, { "info": { "name": "Update Resource Unavailabilities", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/unavailability/:id", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing unavailability for a resource." }, { "info": { "name": "Delete Resource Unavailabilities", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/unavailability/:id", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a resource unavailability" }, { "info": { "name": "List Resource Validities", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/validity", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" }, { "name": "start_time", "value": "", "type": "query", "description": "Filter to fetch unavailabilities after this time" }, { "name": "end_time", "value": "", "type": "query", "description": "Filter to fetch unavailabilities before this time" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all validities for a resource" }, { "info": { "name": "Create Resource Validity Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/validity", "params": [ { "name": "resource_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new validity request for a resource." }, { "info": { "name": "Get Resource Validity", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/validity/:id", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetches a specific validity for a resource" }, { "info": { "name": "Update Resource Validity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/validity/:id", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing validity for a resource." }, { "info": { "name": "Delete Resource Validity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/validity/:id", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a resource validity" }, { "info": { "name": "Get Resource Validity Documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource/:resource_id/validity/:id/documents", "params": [ { "name": "resource_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Fetch all documents associated with a specific resource validity." }, { "info": { "name": "List Resource Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.qargo.com/v1/resources/resource_groups", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Mutually exclusive with other query parameters" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/v1/auth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List the resource groups resources can be allocated to. Archived resource groups are not included." } ] } ], "bundled": true }