ContactDto
A contact: a person or organisation the tenant does business with, in one or more roles. Customers are
invoiced by the tenant; suppliers invoice the tenant; CIS subcontractors are suppliers paid under the
Construction Industry Scheme. The role-specific parts (CIS identity and verification, supplier settings) are
present only for the roles the contact holds.
Properties
| Name | Type | Description |
|---|---|---|
| code* | string | Unique code within the tenant (uppercase letters and digits, up to 20). Generated on creation. |
Unique code within the tenant (uppercase letters and digits, up to 20). Generated on creation. | ||
| displayName* | string | Display name of the contact |
Display name of the contact | ||
| isCustomer* | boolean | Whether the tenant invoices this contact |
Whether the tenant invoices this contact | ||
| isSupplier* | boolean | Whether this contact invoices the tenant. Always true for a CIS subcontractor. |
Whether this contact invoices the tenant. Always true 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 | ||
| 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 | ||
| externalId | string | Your own identifier for the contact, set on creation |
Your own identifier for the contact, set on creation | ||
| lastSdc | string | Date of the most recent SDC (Supervision, Direction and Control) questionnaire. Maintained by the system. |
Date of the most recent SDC (Supervision, Direction and Control) questionnaire. Maintained by the system. | ||
| cisDetails | CisDetailsDto | CIS identity details. Present only for a CIS subcontractor. |
CIS identity details. Present only for a CIS subcontractor. | ||
| supplierSettings | SupplierSettingsDto | Defaults for the invoices received from the contact. Present only for a supplier. |
Defaults for the invoices received from the contact. Present only for a supplier. | ||
| verification | SubcontractorVerificationDto | Current CIS verification (read-only). Present only for a CIS subcontractor. |
Current CIS verification (read-only). Present only for a CIS subcontractor. | ||
| invoicing* | ContactInvoicingDto | The invoices received from and issued to the contact (read-only) |
The invoices received from and issued to the contact (read-only) | ||
| createdDate* | string | When the contact was created |
When the contact was created | ||
| updatedDate | string | When the contact was last updated |
When the contact was last updated | ||
JSON Example
{
"code": "string",
"displayName": "string",
"isCustomer": false,
"isSupplier": false,
"isCisSubcontractor": false,
"address": {
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postcode": "string"
},
"isVatRegistered": false,
"invoicing": {
"in": "...",
"out": "..."
},
"createdDate": "2024-01-01T00:00:00Z"
}