BillingProfileDto
The caller's billing profile: the address their invoices are made out to and the state of their direct debit
mandate. One per user, covering every tenant they own; empty until an address is set or a mandate is started.
Properties
| Name | Type | Description |
|---|---|---|
| mandateStatus* | enum | The direct debit mandate's state |
The direct debit mandate's state | ||
| mandateCreatedDate | string | When the mandate was created, if one was |
When the mandate was created, if one was | ||
| hasActiveMandate* | boolean | Whether payments can be collected: the mandate is active |
Whether payments can be collected: the mandate is active | ||
| canAcceptPayments* | boolean | Whether a payment could be submitted now: the mandate is active or on its way through the banks |
Whether a payment could be submitted now: the mandate is active or on its way through the banks | ||
| billingEmail | string | The address invoice notifications go to; the account's email address when blank |
The address invoice notifications go to; the account's email address when blank | ||
| companyName | string | The company name invoices are made out to; the user's name when blank |
The company name invoices are made out to; the user's name when blank | ||
| addressLine1 | string | Billing address, first line |
Billing address, first line | ||
| addressLine2 | string | Billing address, second line |
Billing address, second line | ||
| addressLine3 | string | Billing address, third line |
Billing address, third line | ||
| addressLine4 | string | Billing address, fourth line |
Billing address, fourth line | ||
| postcode | string | Billing address postcode |
Billing address postcode | ||
| country | string | Billing address country |
Billing address country | ||
JSON Example
{
"mandateStatus": "NotStarted",
"mandateCreatedDate": "2024-01-01T00:00:00Z",
"hasActiveMandate": false,
"canAcceptPayments": false,
"billingEmail": "string"
}