CreateContactRequest
Creates a contact. The code is generated from the display name. The role-specific parts may be omitted: a CIS
subcontractor without cisDetails gets an empty identity of type SoleTrader, and a supplier without
supplierSettings gets a default VAT rate that follows the VAT-registered flag.
Properties
| Name | Type | Description |
|---|---|---|
| isCustomer* | boolean | Whether the tenant invoices this contact |
Whether the tenant invoices this contact | ||
| isSupplier* | boolean | Whether this contact invoices the tenant. Required for a CIS subcontractor. |
Whether this contact invoices the tenant. Required for a CIS subcontractor. | ||
| isCisSubcontractor* | boolean | Whether the tenant pays this contact under the Construction Industry Scheme |
Whether the tenant pays this contact under the Construction Industry Scheme | ||
| displayName* | string | Display name of the contact |
Display name of the contact | ||
| title | string | Title (e.g. Mr, Mrs, Ms) |
Title (e.g. Mr, Mrs, Ms) | ||
| firstName | string | First name |
First name | ||
| secondName | string | Second (middle) name |
Second (middle) name | ||
| lastName | string | Last name |
Last name | ||
| emailAddress | string | Email address |
Email address | ||
| telephone | string | Telephone number |
Telephone number | ||
| address | AddressDto | Postal address |
Postal address | ||
| isVatRegistered* | boolean | Whether the contact is VAT registered |
Whether the contact is VAT registered | ||
| vatRegistrationNumber | string | VAT registration number |
VAT registration number | ||
| defaultRate | number | Default rate for the contact |
Default rate for the contact | ||
| cisDetails | CisDetailsDto | CIS identity details. Only for a CIS subcontractor. |
CIS identity details. Only for a CIS subcontractor. | ||
| supplierSettings | SupplierSettingsDto | Defaults for the invoices received from the contact. Only for a supplier. |
Defaults for the invoices received from the contact. Only for a supplier. | ||
| externalId | string | Your own identifier for the contact, e.g. its id in an external system. Set once, on creation. |
Your own identifier for the contact, e.g. its id in an external system. Set once, on creation. | ||
JSON Example
{
"isCustomer": false,
"isSupplier": false,
"isCisSubcontractor": false,
"displayName": "string",
"title": "string",
"isVatRegistered": false
}