{ "opencollection": "1.0.0", "info": { "name": "Qargo TMS API / Accounting API / Company API", "version": "1.2.0" }, "items": [ { "info": { "name": "API / Company", "type": "folder" }, "items": [ { "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." } ] } ], "bundled": true }