API Docs / Schemas / InvoicePaymentDto

InvoicePaymentDto

A payment recorded against an invoice.

Properties

Name Type Description
code*string

The payment's identifier within the invoice

The payment's identifier within the invoice

date*string

When it was paid

When it was paid

amount*number

The amount paid

The amount paid

taxMonth*integer

The CIS tax month (1 = the month ending 5 May) the payment falls in

The CIS tax month (1 = the month ending 5 May) the payment falls in

taxYear*integer

The CIS tax year the payment falls in

The CIS tax year the payment falls in

monthlyReturnStatus*enum

The status of the CIS monthly return for that tax month (Open when the return does not exist yet)

Open Submitted Accepted Error

The status of the CIS monthly return for that tax month (Open when the return does not exist yet)

Open Submitted Accepted Error

percentageOfInvoiceCovered*number

The share of the invoice's amount payable this payment covers (0 to 1)

The share of the invoice's amount payable this payment covers (0 to 1)

createdDate*string

When the payment was recorded

When the payment was recorded

JSON Example

{
  "code": "00000000-0000-0000-0000-000000000000",
  "date": "2024-01-01T00:00:00Z",
  "amount": 0,
  "taxMonth": 0,
  "taxYear": 0,
  "monthlyReturnStatus": "Open",
  "percentageOfInvoiceCovered": 0,
  "createdDate": "2024-01-01T00:00:00Z"
}

Used By Operations