API Docs / Schemas / PaymentDto

PaymentDto

A payment of any invoice of a direction, with the invoice and contact it belongs to.

Properties

Name Type Description
code*string

The payment's identifier within its invoice

The payment's identifier within its invoice

invoice*integer

The invoice's number

The invoice's number

invoiceDate*string

The invoice's date

The invoice's date

dueDate*string

The invoice's due date

The invoice's due date

yourReferencestring

The invoice's "your reference"

The invoice's "your reference"

theirReferencestring

The invoice's "their reference"

The invoice's "their reference"

contact*string

The invoice's contact (code)

The invoice's contact (code)

contactName*string

The contact's name

The contact's name

date*string

When it was paid

When it was paid

amount*number

The amount paid

The amount paid

deduction*number

The share of the invoice's CIS deduction this payment carries

The share of the invoice's CIS deduction this payment carries

taxYear*integer

The CIS tax year the payment falls in

The CIS tax year the payment falls in

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

createdDate*string

When the payment was recorded

When the payment was recorded

JSON Example

{
  "code": "00000000-0000-0000-0000-000000000000",
  "invoice": 0,
  "invoiceDate": "2024-01-01T00:00:00Z",
  "dueDate": "2024-01-01T00:00:00Z",
  "yourReference": "string",
  "contact": "string",
  "contactName": "string",
  "date": "2024-01-01T00:00:00Z",
  "amount": 0,
  "deduction": 0,
  "taxYear": 0,
  "taxMonth": 0,
  "createdDate": "2024-01-01T00:00:00Z"
}