An Invoice is created to request payment. One of settlement_account_type or settlement_account_id must be specified but not both.
Name | Type | Description | Notes |
---|---|---|---|
InvoiceId | Guid | This is the uuid of the invoice. This will be used for and 'GET' of the invoice and in webhooks about this invoice NB this is generated and must not be supplied when creating an invoice. | [optional] |
FirmId | Guid | The firm the invoice is raised for. | |
Matter | Matter | [optional] | |
Debtor | Debtor | [optional] | |
ExternalId | string | This is the id supplied by the channel partner / PMS and can be used for filtering invoices. This should be unique for the PMS but this is not enforced. | |
ExternalReference | string | This a reference supplied by the channel partner / PMS and can be used for filtering invoices. | [optional] |
Amount | string | The total amount the invoice is for. | |
AmountDue | string | The total amount outstanding on this invoice. | [optional] |
Currency | Currency | [optional] | |
DueDate | DateTime | [optional] | |
SettlementAccountType | AccountType | [optional] | |
SettlementAccountId | Guid | The id of the account the invoice settlement should be paid to. NB, if both the settlement_account_type and settlement_account_id are specified, it is a bad request | [optional] |
LineItems | List<LineItem> | [optional] | |
Notes | List<string> | Freeform notes on the invoice | [optional] |
Payments | List<Payment> | List of payments made against this invoice | [optional] |
PaymentMethodsOverride | List<PaymentMethod> | [optional] | |
SurchargeChoiceOverride | SurchargeChoice | [optional] | |
Description | string | Freeform text for API user. | [optional] |
PaymentUri | string | The URI to get the client payment instructions for this invoice | [optional] |
Status | string | The status of the invoice | [optional] |