The customer is a company that utilizes diagnostic services for vehicles.
id | string <uuid> Customer identifier. |
allow_ticket_without_product | boolean Whether the customer is allowed to create a ticket without products. |
bic | string or null <iso-9362> The customer's Business Identifier Code (BIC). |
branding_profile_id | string <uuid> The identifier of the branding profile of this customer. Defaults to the default branding profile of your provider. |
company_name | string [ 2 .. 255 ] characters A customer's company name. |
created_at | string <date-time> Date-time on which the customer was created. |
currency | string <iso-4217> The currency of the customer. Defaults to the currency of your provider. |
enabled | boolean Whether the customer is enabled. A customer that is not enabled is prohibited from creating tickets and its users cannot access the Customer Portal. |
external_reference | string [ 0 .. 255 ] characters Reference field for external usage. |
financial_contact_point_id | string or null <uuid> The identifier of the financial contact point. |
general_contact_point_id | string or null <uuid> The identifier of the general contact point. |
iban | string or null <iso-13616> The customer's International Bank Account Number (IBAN). |
invoice_debtor_id | string or null <uuid> A customer's invoice debtor is another customer that receives a customer's ticket invoices. If |
locale | string <bcp47> A customer's correspondence language. Only supported system locales are allowed. |
price_list_code_id | string or null <uuid> The identifier of the price list code of this customer. |
primary_location_id | string or null <uuid> The identifier of a location that is the primary location. |
reference | string [ 0 .. 255 ] characters ^[a-zA-Z0-9_.-]*$ Human readable identifier for internal usage. If left empty this field will automatically be set to a unique sequential number determined at customer creation. |
updated_at | string <date-time> Date-time on which the customer was last updated. |
vat_number | string or null [ 2 .. 15 ] characters The customer's VAT number. |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allow_ticket_without_product": true,
- "bic": "AABNNL2AXXX",
- "branding_profile_id": "689a2a03-e128-4810-8e21-33ad1d360fe1",
- "company_name": "Meilink Motor Experts",
- "created_at": "2023-03-07T16:34:15+0100",
- "currency": "EUR",
- "enabled": true,
- "external_reference": "ERP_CUSTOMER_4453",
- "financial_contact_point_id": "a3b4a732-e9a6-4b5e-8a8b-b78185d0665d",
- "general_contact_point_id": "d4695b76-3bc2-41d9-b244-8b681e7ef27a",
- "iban": "NL02ABNA0123456789",
- "invoice_debtor_id": "f57b36b6-2796-4ceb-b5f0-441d98eff1bd",
- "locale": "en-GB",
- "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434",
- "primary_location_id": "4aa156f0-1b2f-4d41-9d31-fa4edd773c3b",
- "reference": "JRD_0005",
- "updated_at": "2023-03-07T16:34:15+0100",
- "vat_number": "1234"
}
The custom field values of a customer.
customer_id | string or null <uuid> Reference to a customer. |
field_1 | string [ 0 .. 255 ] characters Custom field 1. |
field_2 | string [ 0 .. 255 ] characters Custom field 2. |
field_3 | string [ 0 .. 255 ] characters Custom field 3. |
field_4 | string [ 0 .. 255 ] characters Custom field 4. |
field_5 | string [ 0 .. 255 ] characters Custom field 5. |
field_6 | string [ 0 .. 255 ] characters Custom field 6. |
field_7 | string [ 0 .. 255 ] characters Custom field 7. |
field_8 | string [ 0 .. 255 ] characters Custom field 8. |
field_9 | string [ 0 .. 255 ] characters Custom field 9. |
field_10 | string [ 0 .. 255 ] characters Custom field 10. |
{- "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
- "field_1": "1394425330",
- "field_2": "EXT_14599",
- "field_3": "string",
- "field_4": "string",
- "field_5": "string",
- "field_6": "string",
- "field_7": "string",
- "field_8": "string",
- "field_9": "string",
- "field_10": "string"
}
Retrieve a list of customers.
Successful response.
An error occurred - see status code and problem response for more information.
{- "query": {
- "limit": 25,
- "offset": 0,
- "sort_by": {
- "company_name": "asc"
}
}, - "result": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allow_ticket_without_product": true,
- "bic": "AABNNL2AXXX",
- "branding_profile_id": "689a2a03-e128-4810-8e21-33ad1d360fe1",
- "company_name": "Meilink Motor Experts",
- "created_at": "2023-03-07T16:34:15+0100",
- "currency": "EUR",
- "enabled": true,
- "external_reference": "ERP_CUSTOMER_4453",
- "financial_contact_point_id": "a3b4a732-e9a6-4b5e-8a8b-b78185d0665d",
- "general_contact_point_id": "d4695b76-3bc2-41d9-b244-8b681e7ef27a",
- "iban": "NL02ABNA0123456789",
- "invoice_debtor_id": "f57b36b6-2796-4ceb-b5f0-441d98eff1bd",
- "locale": "en-GB",
- "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434",
- "primary_location_id": "4aa156f0-1b2f-4d41-9d31-fa4edd773c3b",
- "reference": "JRD_0005",
- "updated_at": "2023-03-07T16:34:15+0100",
- "vat_number": "1234"
}
], - "total": 3255
}
Add a new customer.
The customer you wish to add.
allow_ticket_without_product | boolean Default: false Whether the customer is allowed to create a ticket without products. |
bic | string or null <iso-9362> Default: null The customer's Business Identifier Code (BIC). |
branding_profile_id | string <uuid> The identifier of the branding profile of this customer. Defaults to the default branding profile of your provider. |
company_name required | string [ 2 .. 255 ] characters A customer's company name. |
currency | string <iso-4217> The currency of the customer. Defaults to the currency of your provider. |
enabled | boolean Default: true Whether the customer is enabled. A customer that is not enabled is prohibited from creating tickets and its users cannot access the Customer Portal. |
external_reference | string [ 0 .. 255 ] characters Default: "" Reference field for external usage. |
iban | string or null <iso-13616> Default: null The customer's International Bank Account Number (IBAN). |
invoice_debtor_id | string or null <uuid> Default: null A customer's invoice debtor is another customer that receives a customer's ticket invoices. If |
locale | string <bcp47> A customer's correspondence language. Only supported system locales are allowed. |
price_list_code_id | string or null <uuid> Default: null The identifier of the price list code of this customer. |
reference required | string [ 0 .. 255 ] characters ^[a-zA-Z0-9_.-]*$ Human readable identifier for internal usage. If left empty this field will automatically be set to a unique sequential number determined at customer creation. |
vat_number | string or null [ 2 .. 15 ] characters Default: null The customer's VAT number. |
Created.
id | string <uuid> Customer identifier. |
allow_ticket_without_product | boolean Whether the customer is allowed to create a ticket without products. |
bic | string or null <iso-9362> The customer's Business Identifier Code (BIC). |
branding_profile_id | string <uuid> The identifier of the branding profile of this customer. Defaults to the default branding profile of your provider. |
company_name | string [ 2 .. 255 ] characters A customer's company name. |
created_at | string <date-time> Date-time on which the customer was created. |
currency | string <iso-4217> The currency of the customer. Defaults to the currency of your provider. |
enabled | boolean Whether the customer is enabled. A customer that is not enabled is prohibited from creating tickets and its users cannot access the Customer Portal. |
external_reference | string [ 0 .. 255 ] characters Reference field for external usage. |
financial_contact_point_id | string or null <uuid> The identifier of the financial contact point. |
general_contact_point_id | string or null <uuid> The identifier of the general contact point. |
iban | string or null <iso-13616> The customer's International Bank Account Number (IBAN). |
invoice_debtor_id | string or null <uuid> A customer's invoice debtor is another customer that receives a customer's ticket invoices. If |
locale | string <bcp47> A customer's correspondence language. Only supported system locales are allowed. |
price_list_code_id | string or null <uuid> The identifier of the price list code of this customer. |
primary_location_id | string or null <uuid> The identifier of a location that is the primary location. |
reference | string [ 0 .. 255 ] characters ^[a-zA-Z0-9_.-]*$ Human readable identifier for internal usage. If left empty this field will automatically be set to a unique sequential number determined at customer creation. |
updated_at | string <date-time> Date-time on which the customer was last updated. |
vat_number | string or null [ 2 .. 15 ] characters The customer's VAT number. |
An error occurred - see status code and problem response for more information.
{- "allow_ticket_without_product": false,
- "bic": null,
- "branding_profile_id": "689a2a03-e128-4810-8e21-33ad1d360fe1",
- "company_name": "Meilink Motor Experts",
- "currency": "EUR",
- "enabled": true,
- "external_reference": "",
- "financial_contact_point_id": "a3b4a732-e9a6-4b5e-8a8b-b78185d0665d",
- "general_contact_point_id": "d4695b76-3bc2-41d9-b244-8b681e7ef27a",
- "iban": null,
- "invoice_debtor_id": null,
- "locale": "en-GB",
- "price_list_code_id": null,
- "primary_location_id": "4aa156f0-1b2f-4d41-9d31-fa4edd773c3b",
- "reference": "JRD_0005",
- "vat_number": null
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allow_ticket_without_product": true,
- "bic": "AABNNL2AXXX",
- "branding_profile_id": "689a2a03-e128-4810-8e21-33ad1d360fe1",
- "company_name": "Meilink Motor Experts",
- "created_at": "2023-03-07T16:34:15+0100",
- "currency": "EUR",
- "enabled": true,
- "external_reference": "ERP_CUSTOMER_4453",
- "financial_contact_point_id": "a3b4a732-e9a6-4b5e-8a8b-b78185d0665d",
- "general_contact_point_id": "d4695b76-3bc2-41d9-b244-8b681e7ef27a",
- "iban": "NL02ABNA0123456789",
- "invoice_debtor_id": "f57b36b6-2796-4ceb-b5f0-441d98eff1bd",
- "locale": "en-GB",
- "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434",
- "primary_location_id": "4aa156f0-1b2f-4d41-9d31-fa4edd773c3b",
- "reference": "JRD_0005",
- "updated_at": "2023-03-07T16:34:15+0100",
- "vat_number": "1234"
}
Retrieves the details of an existing customer using the provided identifier.
Successful response.
id | string <uuid> Customer identifier. |
allow_ticket_without_product | boolean Whether the customer is allowed to create a ticket without products. |
bic | string or null <iso-9362> The customer's Business Identifier Code (BIC). |
branding_profile_id | string <uuid> The identifier of the branding profile of this customer. Defaults to the default branding profile of your provider. |
company_name | string [ 2 .. 255 ] characters A customer's company name. |
created_at | string <date-time> Date-time on which the customer was created. |
currency | string <iso-4217> The currency of the customer. Defaults to the currency of your provider. |
enabled | boolean Whether the customer is enabled. A customer that is not enabled is prohibited from creating tickets and its users cannot access the Customer Portal. |
external_reference | string [ 0 .. 255 ] characters Reference field for external usage. |
financial_contact_point_id | string or null <uuid> The identifier of the financial contact point. |
general_contact_point_id | string or null <uuid> The identifier of the general contact point. |
iban | string or null <iso-13616> The customer's International Bank Account Number (IBAN). |
invoice_debtor_id | string or null <uuid> A customer's invoice debtor is another customer that receives a customer's ticket invoices. If |
locale | string <bcp47> A customer's correspondence language. Only supported system locales are allowed. |
price_list_code_id | string or null <uuid> The identifier of the price list code of this customer. |
primary_location_id | string or null <uuid> The identifier of a location that is the primary location. |
reference | string [ 0 .. 255 ] characters ^[a-zA-Z0-9_.-]*$ Human readable identifier for internal usage. If left empty this field will automatically be set to a unique sequential number determined at customer creation. |
updated_at | string <date-time> Date-time on which the customer was last updated. |
vat_number | string or null [ 2 .. 15 ] characters The customer's VAT number. |
An error occurred - see status code and problem response for more information.
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allow_ticket_without_product": true,
- "bic": "AABNNL2AXXX",
- "branding_profile_id": "689a2a03-e128-4810-8e21-33ad1d360fe1",
- "company_name": "Meilink Motor Experts",
- "created_at": "2023-03-07T16:34:15+0100",
- "currency": "EUR",
- "enabled": true,
- "external_reference": "ERP_CUSTOMER_4453",
- "financial_contact_point_id": "a3b4a732-e9a6-4b5e-8a8b-b78185d0665d",
- "general_contact_point_id": "d4695b76-3bc2-41d9-b244-8b681e7ef27a",
- "iban": "NL02ABNA0123456789",
- "invoice_debtor_id": "f57b36b6-2796-4ceb-b5f0-441d98eff1bd",
- "locale": "en-GB",
- "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434",
- "primary_location_id": "4aa156f0-1b2f-4d41-9d31-fa4edd773c3b",
- "reference": "JRD_0005",
- "updated_at": "2023-03-07T16:34:15+0100",
- "vat_number": "1234"
}
Update a customer by its identifier.
The updated customer.
allow_ticket_without_product | boolean Whether the customer is allowed to create a ticket without products. |
bic required | string or null <iso-9362> The customer's Business Identifier Code (BIC). |
branding_profile_id required | string <uuid> The identifier of the branding profile of this customer. Defaults to the default branding profile of your provider. |
company_name required | string [ 2 .. 255 ] characters A customer's company name. |
currency required | string <iso-4217> The currency of the customer. Defaults to the currency of your provider. |
enabled required | boolean Whether the customer is enabled. A customer that is not enabled is prohibited from creating tickets and its users cannot access the Customer Portal. |
external_reference required | string [ 0 .. 255 ] characters Reference field for external usage. |
financial_contact_point_id required | string or null <uuid> The identifier of the financial contact point. |
general_contact_point_id required | string or null <uuid> The identifier of the general contact point. |
iban required | string or null <iso-13616> The customer's International Bank Account Number (IBAN). |
invoice_debtor_id required | string or null <uuid> A customer's invoice debtor is another customer that receives a customer's ticket invoices. If |
locale required | string <bcp47> A customer's correspondence language. Only supported system locales are allowed. |
price_list_code_id required | string or null <uuid> The identifier of the price list code of this customer. |
primary_location_id required | string or null <uuid> The identifier of a location that is the primary location. |
reference required | string [ 0 .. 255 ] characters ^[a-zA-Z0-9_.-]*$ Human readable identifier for internal usage. If left empty this field will automatically be set to a unique sequential number determined at customer creation. |
vat_number required | string or null [ 2 .. 15 ] characters The customer's VAT number. |
Successful response.
id | string <uuid> Customer identifier. |
allow_ticket_without_product | boolean Whether the customer is allowed to create a ticket without products. |
bic | string or null <iso-9362> The customer's Business Identifier Code (BIC). |
branding_profile_id | string <uuid> The identifier of the branding profile of this customer. Defaults to the default branding profile of your provider. |
company_name | string [ 2 .. 255 ] characters A customer's company name. |
created_at | string <date-time> Date-time on which the customer was created. |
currency | string <iso-4217> The currency of the customer. Defaults to the currency of your provider. |
enabled | boolean Whether the customer is enabled. A customer that is not enabled is prohibited from creating tickets and its users cannot access the Customer Portal. |
external_reference | string [ 0 .. 255 ] characters Reference field for external usage. |
financial_contact_point_id | string or null <uuid> The identifier of the financial contact point. |
general_contact_point_id | string or null <uuid> The identifier of the general contact point. |
iban | string or null <iso-13616> The customer's International Bank Account Number (IBAN). |
invoice_debtor_id | string or null <uuid> A customer's invoice debtor is another customer that receives a customer's ticket invoices. If |
locale | string <bcp47> A customer's correspondence language. Only supported system locales are allowed. |
price_list_code_id | string or null <uuid> The identifier of the price list code of this customer. |
primary_location_id | string or null <uuid> The identifier of a location that is the primary location. |
reference | string [ 0 .. 255 ] characters ^[a-zA-Z0-9_.-]*$ Human readable identifier for internal usage. If left empty this field will automatically be set to a unique sequential number determined at customer creation. |
updated_at | string <date-time> Date-time on which the customer was last updated. |
vat_number | string or null [ 2 .. 15 ] characters The customer's VAT number. |
An error occurred - see status code and problem response for more information.
{- "allow_ticket_without_product": true,
- "bic": "AABNNL2AXXX",
- "branding_profile_id": "689a2a03-e128-4810-8e21-33ad1d360fe1",
- "company_name": "Meilink Motor Experts",
- "currency": "EUR",
- "enabled": true,
- "external_reference": "ERP_CUSTOMER_4453",
- "financial_contact_point_id": "a3b4a732-e9a6-4b5e-8a8b-b78185d0665d",
- "general_contact_point_id": "d4695b76-3bc2-41d9-b244-8b681e7ef27a",
- "iban": "NL02ABNA0123456789",
- "invoice_debtor_id": "f57b36b6-2796-4ceb-b5f0-441d98eff1bd",
- "locale": "en-GB",
- "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434",
- "primary_location_id": "4aa156f0-1b2f-4d41-9d31-fa4edd773c3b",
- "reference": "JRD_0005",
- "vat_number": "1234"
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "allow_ticket_without_product": true,
- "bic": "AABNNL2AXXX",
- "branding_profile_id": "689a2a03-e128-4810-8e21-33ad1d360fe1",
- "company_name": "Meilink Motor Experts",
- "created_at": "2023-03-07T16:34:15+0100",
- "currency": "EUR",
- "enabled": true,
- "external_reference": "ERP_CUSTOMER_4453",
- "financial_contact_point_id": "a3b4a732-e9a6-4b5e-8a8b-b78185d0665d",
- "general_contact_point_id": "d4695b76-3bc2-41d9-b244-8b681e7ef27a",
- "iban": "NL02ABNA0123456789",
- "invoice_debtor_id": "f57b36b6-2796-4ceb-b5f0-441d98eff1bd",
- "locale": "en-GB",
- "price_list_code_id": "a29db1be-1640-4931-9c6f-2a65a84af434",
- "primary_location_id": "4aa156f0-1b2f-4d41-9d31-fa4edd773c3b",
- "reference": "JRD_0005",
- "updated_at": "2023-03-07T16:34:15+0100",
- "vat_number": "1234"
}
Retrieves the custom field values of an existing customer using the provided identifier.
Successful response.
customer_id | string or null <uuid> Reference to a customer. |
field_1 | string [ 0 .. 255 ] characters Custom field 1. |
field_2 | string [ 0 .. 255 ] characters Custom field 2. |
field_3 | string [ 0 .. 255 ] characters Custom field 3. |
field_4 | string [ 0 .. 255 ] characters Custom field 4. |
field_5 | string [ 0 .. 255 ] characters Custom field 5. |
field_6 | string [ 0 .. 255 ] characters Custom field 6. |
field_7 | string [ 0 .. 255 ] characters Custom field 7. |
field_8 | string [ 0 .. 255 ] characters Custom field 8. |
field_9 | string [ 0 .. 255 ] characters Custom field 9. |
field_10 | string [ 0 .. 255 ] characters Custom field 10. |
An error occurred - see status code and problem response for more information.
{- "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
- "field_1": "1394425330",
- "field_2": "EXT_14599",
- "field_3": "string",
- "field_4": "string",
- "field_5": "string",
- "field_6": "string",
- "field_7": "string",
- "field_8": "string",
- "field_9": "string",
- "field_10": "string"
}
Update the custom field values of an existing customer using the provided identifier.
The updated custom field values.
field_1 | string [ 0 .. 255 ] characters Custom field 1. |
field_2 | string [ 0 .. 255 ] characters Custom field 2. |
field_3 | string [ 0 .. 255 ] characters Custom field 3. |
field_4 | string [ 0 .. 255 ] characters Custom field 4. |
field_5 | string [ 0 .. 255 ] characters Custom field 5. |
field_6 | string [ 0 .. 255 ] characters Custom field 6. |
field_7 | string [ 0 .. 255 ] characters Custom field 7. |
field_8 | string [ 0 .. 255 ] characters Custom field 8. |
field_9 | string [ 0 .. 255 ] characters Custom field 9. |
field_10 | string [ 0 .. 255 ] characters Custom field 10. |
Successful response.
customer_id | string or null <uuid> Reference to a customer. |
field_1 | string [ 0 .. 255 ] characters Custom field 1. |
field_2 | string [ 0 .. 255 ] characters Custom field 2. |
field_3 | string [ 0 .. 255 ] characters Custom field 3. |
field_4 | string [ 0 .. 255 ] characters Custom field 4. |
field_5 | string [ 0 .. 255 ] characters Custom field 5. |
field_6 | string [ 0 .. 255 ] characters Custom field 6. |
field_7 | string [ 0 .. 255 ] characters Custom field 7. |
field_8 | string [ 0 .. 255 ] characters Custom field 8. |
field_9 | string [ 0 .. 255 ] characters Custom field 9. |
field_10 | string [ 0 .. 255 ] characters Custom field 10. |
An error occurred - see status code and problem response for more information.
{- "field_1": "1394425330",
- "field_2": "EXT_14599",
- "field_3": "string",
- "field_4": "string",
- "field_5": "string",
- "field_6": "string",
- "field_7": "string",
- "field_8": "string",
- "field_9": "string",
- "field_10": "string"
}
{- "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
- "field_1": "1394425330",
- "field_2": "EXT_14599",
- "field_3": "string",
- "field_4": "string",
- "field_5": "string",
- "field_6": "string",
- "field_7": "string",
- "field_8": "string",
- "field_9": "string",
- "field_10": "string"
}