clients

Add a new client to the database.

POST

/client

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/client \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "additional_app_name": "<string>",
  "address": "<string>",
  "admission_key": "<string>",
  "admission_type": "<string>",
  "attention_of": "<string>",
  "bank_account_holder": "<string>",
  "bank_account_number": "<string>",
  "categories": [
    {
      "code": "<string>",
      "description": "<string>",
      "id": 123,
      "name": "<string>"
    }
  ],
  "cc_emails": [
    "<string>"
  ],
  "coc_number": "<string>",
  "code": "<string>",
  "commerce_location_key": "<string>",
  "coordinates": "<string>",
  "country": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "debnumber": "<string>",
  "default_vat_rate_id": 123,
  "deleted_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "due_date_amount": 123,
  "due_date_type": "<string>",
  "email": "<string>",
  "exclude_questions": 123,
  "extra_data": {},
  "g_account_active": 123,
  "id": 123,
  "internal_description": "<string>",
  "invoicing_bottom_comment": "<string>",
  "invoicing_default_merge_items": 123,
  "invoicing_default_template_id": 123,
  "invoicing_email": "<string>",
  "invoicing_export_man_day": 123,
  "invoicing_export_presets": 123,
  "invoicing_presets": [
    "<string>"
  ],
  "invoicing_top_comment": "<string>",
  "locations": [
    {
      "active": true,
      "address": "<string>",
      "client_id": 123,
      "coordinates": "<string>",
      "data": "<string>",
      "id": 123,
      "is_primary": true,
      "postal_code": "<string>",
      "reference": "<string>"
    }
  ],
  "manure_code": "<string>",
  "manure_number": "<string>",
  "manure_number2": "<string>",
  "name": "<string>",
  "order_form_bottom_comment": "<string>",
  "order_form_default_merge_items": 123,
  "order_form_default_template_id": 123,
  "order_form_email": [
    "<string>"
  ],
  "order_form_export_man_day": 123,
  "order_form_export_presets": 123,
  "order_form_presets": [
    "<string>"
  ],
  "order_form_shift_vat": 123,
  "order_form_top_comment": "<string>",
  "phone": "<string>",
  "phone2": "<string>",
  "plots": [
    {
      "active": true,
      "address": "<string>",
      "client_id": 123,
      "coordinates": "<string>",
      "data": "<string>",
      "id": 123,
      "reference": "<string>"
    }
  ],
  "postalcode": "<string>",
  "pricing_zone_id": 123,
  "relation_number": "<string>",
  "salutation": "<string>",
  "sort_order": 123,
  "storage_number": "<string>",
  "subcontractors": [
    {
      "client": {
        "code": "<string>",
        "debnumber": "<string>",
        "email": "<string>",
        "id": 123,
        "name": "<string>",
        "phone": "<string>"
      },
      "client_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "external_ids": {},
      "id": 123,
      "name": "<string>",
      "phone": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "town": "<string>",
  "types": [
    "<string>"
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "vat_number": "<string>",
  "vihb_number": "<string>"
}
'

{
  "data": {
    "client": {
      "additional_app_name": "<string>",
      "address": "<string>",
      "admission_key": "<string>",
      "admission_type": "<string>",
      "attention_of": "<string>",
      "bank_account_holder": "<string>",
      "bank_account_number": "<string>",
      "categories": [
        {
          "code": "<string>",
          "description": "<string>",
          "id": 123,
          "name": "<string>"
        }
      ],
      "cc_emails": [
        "<string>"
      ],
      "coc_number": "<string>",
      "code": "<string>",
      "commerce_location_key": "<string>",
      "coordinates": "<string>",
      "country": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "debnumber": "<string>",
      "default_vat_rate_id": 123,
      "deleted_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "due_date_amount": 123,
      "due_date_type": "<string>",
      "email": "<string>",
      "exclude_questions": 123,
      "extra_data": {},
      "g_account_active": 123,
      "id": 123,
      "internal_description": "<string>",
      "invoicing_bottom_comment": "<string>",
      "invoicing_default_merge_items": 123,
      "invoicing_default_template_id": 123,
      "invoicing_email": "<string>",
      "invoicing_export_man_day": 123,
      "invoicing_export_presets": 123,
      "invoicing_presets": [
        "<string>"
      ],
      "invoicing_top_comment": "<string>",
      "locations": [
        {
          "active": true,
          "address": "<string>",
          "client_id": 123,
          "coordinates": "<string>",
          "data": "<string>",
          "id": 123,
          "is_primary": true,
          "postal_code": "<string>",
          "reference": "<string>"
        }
      ],
      "manure_code": "<string>",
      "manure_number": "<string>",
      "manure_number2": "<string>",
      "name": "<string>",
      "order_form_bottom_comment": "<string>",
      "order_form_default_merge_items": 123,
      "order_form_default_template_id": 123,
      "order_form_email": [
        "<string>"
      ],
      "order_form_export_man_day": 123,
      "order_form_export_presets": 123,
      "order_form_presets": [
        "<string>"
      ],
      "order_form_shift_vat": 123,
      "order_form_top_comment": "<string>",
      "phone": "<string>",

Autorisaties

X-API-Keystringheaderverplicht

Body

Client object.

additional_app_namestring

An additional name shown for this client in the app.

addressstring

The street address of this client.

admission_keystring

The admission (recognition) number of this client.

admission_typestring

The admission (recognition) type of this client.

attention_ofstring

The person that documents for this client are addressed to (attention of).

bank_account_holderstring

The holder of the bank account, defaulting to the client name when a bank account number is set.

bank_account_numberstring

The bank account number (IBAN) of this client.

categoriesobject[]

The client categories this client belongs to.

child attributes tonen

cc_emailsstring[]

The email addresses that receive a copy (CC) of emails sent to this client.

coc_numberstring

The Chamber of Commerce (KVK) number of this client.

codestring

The search name of this client, generated from the name when left empty.

commerce_location_keystring

The Chamber of Commerce (KVK) establishment number of this client.

coordinatesstring

The coordinates of this client's address as 'latitude,longitude', geocoded from the address.

countrystring

The country of this client as a lowercase ISO 3166-1 alpha-2 code, defaulting to 'nl'.

created_atstring

The date and time this client was created.

debnumberstring

The debtor number of this client, generated from the configured number structure when left empty.

default_vat_rate_idinteger

The ID of the default VAT rate for this client.

deleted_atstring

The date and time this client was archived, or null when it is active.

descriptionstring

A note about this client.

due_date_amountinteger

The payment term of invoices for this client, counted in the unit of due_date_type.

due_date_typestring

The unit of the payment term, either 'd' (days), 'w' (weeks), 'm' (months) or 'y' (years).

emailstring

The email address of this client.

exclude_questionsinteger

Whether questions are skipped on tasks for this client. Returned as 1 (yes) or 0 (no).

extra_dataobject

The values of the custom fields, keyed by custom field code.

g_account_activeinteger

Whether invoices for this client use a G-account (G-rekening), or null to follow the invoicing setting. Returned as 1 (yes) or 0 (no).

idintegerverplicht

The ID of this client.

internal_descriptionstring

An internal note about this client.

invoicing_bottom_commentstring

The personalized footer note on invoices for this client, as HTML.

invoicing_default_merge_itemsinteger

Whether invoice items for this client are merged into one invoice line by default. Returned as 1 (yes) or 0 (no).

invoicing_default_template_idinteger

The ID of the default invoice layout for this client.

invoicing_emailstring

The email address invoices for this client are sent to.

invoicing_export_man_dayinteger

Whether the man-day register is included on invoices for this client by default. Returned as 1 (yes) or 0 (no).

invoicing_export_presetsinteger

Whether the task overview is included on invoices for this client by default. Returned as 1 (yes) or 0 (no).

invoicing_presetsstring[]

The IDs of the presets used for the task overview on invoices for this client.

invoicing_top_commentstring

The personalized header note on invoices for this client, as HTML.

locationsobject[]

The locations of this client.

child attributes tonen

manure_codestring

The RVO manure code of this client, e.g. '14'.

manure_numberstring

The UBN (unique business number) of this client.

manure_number2string

The BRS number of this client.

namestring

The company name of this client.

order_form_bottom_commentstring

The personalized footer note on cost overviews for this client, as HTML.

order_form_default_merge_itemsinteger

Whether cost overview items for this client are merged into one line by default. Returned as 1 (yes) or 0 (no).

order_form_default_template_idinteger

The ID of the default cost overview layout for this client.

order_form_emailstring[]

The email addresses cost overviews for this client are sent to.

order_form_export_man_dayinteger

Whether the man-day register is included on cost overviews for this client by default. Returned as 1 (yes) or 0 (no).

order_form_export_presetsinteger

Whether the task overview is included on cost overviews for this client by default. Returned as 1 (yes) or 0 (no).

order_form_presetsstring[]

The IDs of the presets used for the task overview on cost overviews for this client.

order_form_shift_vatinteger

Whether VAT is shifted (reverse charged) on cost overviews for this client. Returned as 1 (yes) or 0 (no).

order_form_top_commentstring

The personalized header note on cost overviews for this client, as HTML.

phonestring

The primary phone number of this client.

phone2string

The secondary phone number of this client.

plotsobject[]

The plots of this client.

child attributes tonen

postalcodestring

The postal code of this client.

pricing_zone_idinteger

The ID of the default pricing zone of this client.

relation_numberstring

The relation number of this client.

salutationstring

The salutation used in email templates for this client.

sort_orderinteger

The sort order of this client.

storage_numberstring

The storage number of this client.

subcontractorsobject[]

The subcontractors (contact persons) of this client.

child attributes tonen

townstring

The town (city) of this client.

typesstring[]

The types of this client, one or more of 'client' and 'supplier'.

updated_atstring

The date and time this client was last updated.

vat_numberstring

The VAT number of this client.

vihb_numberstring

The VIHB number (waste transport registration) of this client.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team