Example

{
  "id": "955ec6d3-2414-4508-aa9a-3e340651fb06",
  "referenceNumber": "ACH-0001",
  "receivedOn": "2023-03-01",
  "notes": "Payment for invoice INV-0001",
  "currency": "USD",
  "amount": 1000,
  "createdAt": "2024-03-14T21:04:19.630Z",
  "paymentMethod": {
    "id": "105b6640-f874-4756-a58e-dbc55ab067b5",
    "name": "ACH"
  },
  "client": {
    "id": "8128c932-bbea-4ca9-b5e7-043af1437920",
    "name": "Acme"
  },
  "invoices": [
    {
      "id": "f1961bf8-f575-4343-8a71-e8de2e3eac74",
      "number": "INV-0001",
      "amount": 1000
    }
  ]
}

Attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`referenceNumber`	`string`	Reference number associated with the payment.
`receivedOn`	`date`	Date when the payment was received. Will be in the form `YYYY-MM-DD`.
`notes`	`string`	Additional notes or description regarding the payment.
`currency`	`string`	Currency in which the payment was made.
`amount`	`number`	The amount of the payment.
`createdAt`	`timestamp`	The timestamp when the object was created.
`client`	`object`	A simple object to the related client. See attributes.
`paymentMethod`	`object`	A simple object to the related payment method. See attributes.
`invoices`	`array of objects`	An array of the invoices that this payment applied to. See attributes .

Client attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the client.

Payment method attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the payment method.

Invoice attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`number`	`string`	Number assigned to the invoice.
`amount`	`number`	The payment amount applied to the invoice.