Skip to main content

ClientDetailDto

idnumberrequired

Unique identifier for the client

namestringrequired

Name of the client/company

Possible values: >= 2 characters

Example: Acme Corporation
emailstring<email>

Email address of the client

Example: contact@acme.com
citystring

City where the client is located

Example: New York
phonestring

Phone number of the client

Example: +1-555-0123
addressstring

Street address of the client

Example: 123 Business Street
postalCodestring

Postal code of the client

Example: 10001
customerIdstring

Custom customer ID assigned by the workspace

Example: CUST-001
countrystring

Country where the client is located

Example: United States
languagestring

Primary language of the client

Example: en
privatebooleanrequired

Whether the client is private or business

Example: false
contactPersons object[]

Contact persons associated with the client, not available for private clients

  • Array [
    • idnumberrequired

    Unique identifier for the contact person

    namestringrequired

    Name of the contact person

    Example: Jane Smith
    emailstringrequired

    Email address of the contact person

    Example: jane.smith@acme.com
  • ]
    • websitestring<uri>

    Website URL of the client

    Example: https://acme.com
    cocNumberstring

    Chamber of Commerce number

    Example: COC123456
    vatNumberstring

    VAT number of the client

    Example: VAT987654321
    ibanstring

    IBAN bank account number

    Example: GB82WEST12345698765432
    currencystring

    Client currency

    Possible values: [USD, AUD, GBP, CAD, CNY, EUR, INR, JPY, AED, CHF, BTC, ETH]

    tags object[]required

    Array of custom tags/fields associated with the client

  • Array [
    • idnumberrequired

    Unique identifier for the tag

    label object

    Multilingual label for the tag

    nlstring

    Dutch label

    Example: Industrie
    enstring

    English label

    Example: Industry
    destring

    German label

    Example: Branche
    valuestringrequired

    The actual value/content of the tag

    Example: Software & IT
  • ]
    • createdAtstring<date-time>required

    Date when the client was created

    updatedAtstring<date-time>required

    Date when the client was last updated

    ClientDetailDto
    {
      "id": 0,
      "name": "Acme Corporation",
      "email": "contact@acme.com",
      "city": "New York",
      "phone": "+1-555-0123",
      "address": "123 Business Street",
      "postalCode": "10001",
      "customerId": "CUST-001",
      "country": "United States",
      "language": "en",
      "private": false,
      "contactPersons": [
        {
          "id": 0,
          "name": "Jane Smith",
          "email": "jane.smith@acme.com"
        }
      ],
      "website": "https://acme.com",
      "cocNumber": "COC123456",
      "vatNumber": "VAT987654321",
      "iban": "GB82WEST12345698765432",
      "currency": "USD",
      "tags": [
        {
          "id": 0,
          "label": {
            "nl": "Industrie",
            "en": "Industry",
            "de": "Branche"
          },
          "value": "Software & IT"
        }
      ],
      "createdAt": "2024-07-29T15:51:28.071Z",
      "updatedAt": "2024-07-29T15:51:28.071Z"
    }