CustomerDto
Customer data retrieved from third-party accounting platforms (Xero, QuickBooks, FreeAgent, etc.).
Represents a customer/client as stored in the accounting system, including contact details and financial balances.
Used for importing clients and syncing financial data.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Platform-specific customer identifier (unique within the accounting platform) |
Platform-specific customer identifier (unique within the accounting platform) | ||
| name | string | Customer/company name from the accounting platform |
Customer/company name from the accounting platform | ||
| firstName | string | Contact first name (if available from platform) |
Contact first name (if available from platform) | ||
| lastName | string | Contact last name (if available from platform) |
Contact last name (if available from platform) | ||
| string | Primary email address for the customer | |
Primary email address for the customer | ||
| contactNumber | string | Primary contact phone number |
Primary contact phone number | ||
| isActive | boolean | Whether the customer is active in the accounting platform |
Whether the customer is active in the accounting platform | ||
| externalUrl | string | Direct link to view the customer in the accounting platform |
Direct link to view the customer in the accounting platform | ||
| outstandingBalance | number | Outstanding amount owed by the customer |
Outstanding amount owed by the customer | ||
| overdueBalance | number | Overdue amount owed by the customer |
Overdue amount owed by the customer | ||
| totalInvoiced | number | Total amount invoiced to the customer (sum of all invoices) |
Total amount invoiced to the customer (sum of all invoices) | ||
| platformData | object | Platform-specific data that doesn't fit into the common model |
Platform-specific data that doesn't fit into the common model | ||
JSON Example
{
"id": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"email": "string"
}