InvoiceDepositRequestInfoDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Read-only view of an invoice's deposit request, projected from the owned `InvoiceDepositRequest` value object. Exposes the resolved deposit amount and due date so consumers (pay surface, rendering, notifications) can display and enforce the deposit-first flow.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||
|---|---|---|---|---|---|---|
depositType
required |
InvoiceDepositType InvoiceDepositType | Whether the deposit is a percentage of the total or a fixed amount.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
depositValue
required |
number (double) | The configured percentage (e.g. 25 for 25%) or fixed amount.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
depositAmount
required |
number (double) | The resolved absolute deposit amount (rounded to the cent).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
depositDueDate
required |
string (date-time) | When the deposit is due; null when due on receipt with the invoice.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
isSatisfied
required |
boolean | True once the deposit has been fully collected.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.