Skip to content

Create Company

Request

Security
oAuth2ClientCredentials
Bodyapplication/jsonrequired
is_customerboolean(Is Customer)

Indicate that this company is a customer

Default:false
is_buyer_or_sellerboolean or null(Is Buyer Or Seller)
Any of:

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

boolean
namestring or null(Name)
Any of:

Name of the company.

string
codestring or null(Code)
Any of:

External reference to this company record

string
currencystring(Currency)required

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

custom_fieldsobject or null(Custom Fields)
Any of:

Custom fields of the company

object
credit_policyCreditPolicyInput (object) or null
Any of:

Credit policy of the customer

default_invoice_customer_idstring or null(Default Invoice Customer Id)
Any of:

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

string (uuid)
is_subcontractorboolean(Is Subcontractor)

Indicate that this company is a subcontractor (supplier)

Default:false
archived_customerboolean or null(Archived Customer)
Any of:

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

boolean
archived_subcontractorboolean or null(Archived Subcontractor)
Any of:

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

boolean
legal_namestring or null(Legal Name)
Any of:

Legal name of the company.

string
localestring or null(Locale)
Any of:

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

string
vat_numberstring or null(Vat Number)
Any of:

VAT number of the company.

string
reference_numbersCompanyReferenceNumbers (object) or null
Any of:

Reference numbers of the company

notestring or null(Note)
Any of:

Additional notes about the company

string
tax_typeTaxTypeEnum (string) or null
Any of:

DESCRIPTION_HERE

string(TaxTypeEnum)
Enum:"VAT""REVERSE_CHARGE""TRANSIT""NO_VAT""CO_CONTRACTING""OTHER"
bank_accountsArray of objects or null(Bank Accounts)
Any of:

List of associated bank accounts.

accounting_codestring or null(Accounting Code)
Any of:

Code linked to the accounting system

string
billing_locationBillingLocation (object) or null
Any of:

Billing address of the company.

payment_termBasePaymentTerm (object) or null
Any of:

Payment term information of the company

contactsArray of objects or null(Contacts)
Any of:

List of contacts associated with the company

salesobject(SalesCompanyFields)

Sales related fields of the company

purchaseobject(PurchaseCompanyFields)

Purchase related fields of the company

credit_limit_totalnumber or null(Credit Limit Total)
Any of:

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

number
is_blockedboolean or null(Is Blocked)
Any of:

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.

boolean
statusCustomerStatus (string) or null
Any of:

The status indicates whether an order can be linked to this customer. The available statuses are:

  • PROSPECT: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.
  • NOT_APPROVED: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.
  • APPROVED: The customer is approved. Orders can be placed without restrictions.
  • WARNING: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.
  • BLOCKED: The customer is blocked; no new orders can be created.

For a company representing other companies, it can only create orders if it holds the APPROVED status.Note: Deprecated in favor of status under the sales and purchase fields.

string(CustomerStatus)
Enum:"PROSPECT""NOT_APPROVED""APPROVED""WARNING""BLOCKED"
POST
/v1/companies/company
{
  "is_customer": false,
  "is_buyer_or_seller": true,
  "name": "John Doe",
  "code": "",
  "currency": "EUR",
  "custom_fields": {},
  "credit_policy": {
    "limit": 10000
  },
  "default_invoice_customer_id": "ac42f3df-acf0-4ad4-b51e-0c0e4d45f598",
  "is_subcontractor": false,
  "archived_customer": true,
  "archived_subcontractor": true,
  "legal_name": "John Doe",
  "locale": "en",
  "vat_number": "BE1234.123.123",
  "reference_numbers": {
    "eori_number": "",
    "duns_number": "",
    "scac_code": "",
    "company_registration_number": "",
    "tss_registration_number": ""
  },
  "note": "",
  "tax_type": "VAT",
  "bank_accounts": [],
  "accounting_code": "1234",
  "billing_location": {
    "code": "",
    "display_name": "Main Office",
    "external_id": "string",
    "address": "Gaston Crommenlaan 4",
    "address_second_line": "",
    "city": "Ghent",
    "state": "",
    "country": "BE",
    "postal_code": "9050",
    "name": "Qargo HQ"
  },
  "payment_term": {
    "code": "END_OF_MONTH_2"
  },
  "contacts": [
    { … }
  ],
  "sales": {
    "payment_term": { … },
    "billing_entities": [ … ],
    "status": "PROSPECT"
  },
  "purchase": {
    "payment_term": { … },
    "billing_entities": [ … ],
    "status": "NOT_APPROVED"
  },
  "credit_limit_total": 12000,
  "is_blocked": true,
  "status": "PROSPECT"
}

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)required

The unique identifier of the company.

codestring or null(Code)
Any of:

External reference to this company record

string
currencystring(Currency)required

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

custom_fieldsobject or null(Custom Fields)
Any of:

Custom fields of the company

object
is_customerboolean(Is Customer)

Indicate that this company is a customer

Default:false
is_subcontractorboolean(Is Subcontractor)

Indicate that this company is a subcontractor (supplier)

Default:false
is_buyer_or_sellerboolean or null(Is Buyer Or Seller)
Any of:

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

boolean
namestring(Name)required

Name of the company.

legal_namestring or null(Legal Name)
Any of:

Legal name of the company.

string
vat_numberstring or null(Vat Number)
Any of:

VAT number of the company.

string
notestring or null(Note)
Any of:

Additional notes about the company

string
tax_typeTaxTypeEnum (string) or null
Any of:

default tax type of the company

string(TaxTypeEnum)
Enum:"VAT""REVERSE_CHARGE""TRANSIT""NO_VAT""CO_CONTRACTING""OTHER"
statusstring(CustomerStatus)

The status indicates whether an order can be linked to this customer. The available statuses are:

  • PROSPECT: The company is a potential customer but not yet approved. Only quotes can be created; no orders can be placed.
  • NOT_APPROVED: The company is not yet fully approved as a customer. This is an intermediary step between PROSPECT and APPROVED. Same permissions as PROSPECT apply.
  • APPROVED: The customer is approved. Orders can be placed without restrictions.
  • WARNING: The customer is approved, but a warning is triggered when attempting to create an order in Qargo. The operator can dismiss the warning and proceed with the order.
  • BLOCKED: The customer is blocked; no new orders can be created.

For a company representing other companies, it can only create orders if it holds the APPROVED status.

Default:"APPROVED"
Enum:"PROSPECT""NOT_APPROVED""APPROVED""WARNING""BLOCKED"
accounting_codestring or null(Accounting Code)
Any of:

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.

string
billing_locationLocationOutput (object) or null
Any of:

Billing address of the company.

payment_termBasePaymentTerm (object) or null
Any of:

Payment term information of the company

localestring(Locale)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(Archived Customer)required

Indicate that this company is archived as a customer

archived_subcontractorboolean(Archived Subcontractor)required

Indicate that this company is archived as a subcontractor

archived_buyer_or_sellerboolean(Archived Buyer Or Seller)required

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

credit_policyCreditPolicyOutput (object) or null
Any of:

Credit policy of the customer

default_invoice_customerCompanyReferenceOutput (object) or null
Any of:

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

reference_numbersobject(CompanyReferenceNumbers)

Reference numbers of the company

bank_accountsArray of objects(Bank Accounts)

List of associated bank accounts.

contactsArray of objects or null(Contacts)
Any of:

List of contacts associated with the company

salesobject(SalesCompanyFields)

Sales related fields of the company

purchaseobject(PurchaseCompanyFields)

Purchase related fields of the company

timestamp_updatedstring, (date-time)(Timestamp Updated)required

The date and time when the company was last updated.

credit_limit_totalnumber or null(Credit Limit Total)
Any of:

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

number
is_blockedboolean(Is Blocked)deprecated

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

Note: Deprecated in favor of status.

Default:false
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "",
  "currency": "EUR",
  "custom_fields": {},
  "is_customer": false,
  "is_subcontractor": false,
  "is_buyer_or_seller": true,
  "name": "John Doe",
  "legal_name": "John Doe",
  "vat_number": "BE1234.123.123",
  "note": "",
  "tax_type": "VAT",
  "status": "PROSPECT",
  "accounting_code": "1234",
  "billing_location": {
    "code": "LOC123",
    "display_name": "Main Office",
    "external_id": "string",
    "address": "Gaston Crommenlaan 4",
    "address_second_line": "",
    "city": "Ghent",
    "state": "",
    "country": "BE",
    "postal_code": "9050",
    "name": "Qargo HQ",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "latitude": 0,
    "longitude": 0
  },
  "payment_term": {
    "code": "END_OF_MONTH_2"
  },
  "locale": "en",
  "archived_customer": true,
  "archived_subcontractor": true,
  "archived_buyer_or_seller": true,
  "credit_policy": {
    "limit": 10000
  },
  "default_invoice_customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "John Doe",
    "code": "CUST-001"
  },
  "reference_numbers": {
    "eori_number": "",
    "duns_number": "",
    "scac_code": "",
    "company_registration_number": "",
    "tss_registration_number": ""
  },
  "bank_accounts": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "sales": {
    "payment_term": { … },
    "billing_entities": [ … ],
    "status": "PROSPECT"
  },
  "purchase": {
    "payment_term": { … },
    "billing_entities": [ … ],
    "status": "NOT_APPROVED"
  },
  "timestamp_updated": "2019-08-24T14:15:22Z",
  "is_blocked": false,
  "credit_limit_total": 12000
}