API / Accounting
Use case / Accounting

Update Company (Deprecated)

Changed on

(deprecated, use /company/{id} instead)

patch/v1/accounting/company/{id}

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/accounting/company/{id}
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Path parameters

idstring uuid required

Request body

is_customerboolean nullable

Indicate that this company is a customer. At least one of is_customer or is_subcontractor must be set.

is_buyer_or_sellerboolean nullable

Indicates that this company is a buyer or seller of a consignment

namestring nullable

Name of the company.

codestring nullable

External reference to this company record

currencystring nullable

Currency of the company (ISO 4217, 3 letter code)

custom_fieldsobject nullable

Custom fields of the company

default_invoice_customer_idstring uuid nullable

ID of the default invoice customer (bill-to) for this company. When set, charges for this customer are billed to the referenced company instead.

is_subcontractorboolean nullable

Indicate that this company is a subcontractor (supplier). At least one of is_customer or is_subcontractor must be set.

archived_customerboolean nullable

Set to true to archive the customer role of this company, or false to reactivate it. Has no effect if is_customer is false.

archived_subcontractorboolean nullable

Set to true to archive the subcontractor role of this company, or false to reactivate it. Has no effect if is_subcontractor is false.

legal_namestring nullable

Legal name of the company.

localestring nullable

Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.

vat_numberstring nullable

VAT number of the company.

notestring nullable

Additional notes about the company

tax_type'VAT' | 'REVERSE_CHARGE' | 'UK_REVERSE_CHARGE' | 'TRANSIT' | 'NO_VAT' | 'CO_CONTRACTING' | 'OTHER'
accounting_codestring nullable

Code linked to the accounting system

credit_limit_totalnumber nullable

The limit for total amount that has been invoiced but not paid. Deprecated: use credit_policy.limit instead.

is_blockedboolean nullable

Set to true to disallow new order creation for companies representing companies.

Note: Deprecated in favor of status under the sales and purchase fields.an update of status will always prevail over is_blocked update.

status'PROSPECT' | 'NOT_APPROVED' | 'APPROVED' | 'WARNING' | 'BLOCKED'

Example request

{
  "name": "Acme Logistics BV",
  "sales": {
    "status": "WARNING"
  }
}

Response

Successful Response

idstring uuid required

The unique identifier of the company.

codestring nullable

External reference to this company record

currencystring required

Currency of the company (ISO 4217, 3 letter code)

custom_fieldsobject nullable

Custom fields of the company

is_customerboolean

Indicate that this company is a customer

is_subcontractorboolean

Indicate that this company is a subcontractor (supplier)

is_buyer_or_sellerboolean nullable

Indicates that this company is a buyer or seller of a consignment

namestring required

Name of the company.

legal_namestring nullable

Legal name of the company.

vat_numberstring nullable

VAT number of the company.

notestring nullable

Additional notes about the company

tax_type'VAT' | 'REVERSE_CHARGE' | 'UK_REVERSE_CHARGE' | 'TRANSIT' | 'NO_VAT' | 'CO_CONTRACTING' | 'OTHER'
status'PROSPECT' | 'NOT_APPROVED' | 'APPROVED' | 'WARNING' | 'BLOCKED'
accounting_codestring nullable

Default customer accounting code linked to the accounting system. Please use the accounting codes on the billing entities, as these are split per billing entity and between sales/purchase sides.

localestring required

Locale of the company. Format: ISO 639-1 language code, optionally followed by a dash and ISO 3166-1 alpha-2 country code.

archived_customerboolean required

Indicate that this company is archived as a customer

archived_subcontractorboolean required

Indicate that this company is archived as a subcontractor

archived_buyer_or_sellerboolean required

Indicates that this company is archived as buyer/seller of a consignment

timestamp_updatedstring date-time required

The date and time when the company was last updated.

is_blockedboolean

Set to true to disallow new order creation for companies representing companies.

Note: Deprecated in favor of status.

credit_limit_totalnumber nullable

The limit for total amount that has been invoiced but not paid. Deprecated: use credit_policy.limit instead.

Example response

{
  "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

  • cf0a203f13f4Revision changes
    • warning

      added the new UK_REVERSE_CHARGE enum value to the / response property for the response status

    • info

      added the new UK_REVERSE_CHARGE enum value to the request property /

  • 6abdfcd1a541Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status