Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Invoice

Get payments for an invoice

get/v1/workspaces/{workspaceId}/invoices/{invoiceId}/payments

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

invoiceIdstring required

Represents an invoice identifier across the system.

Example:78a687e29ae1f428e7ebe303

Represents an invoice identifier across the system.

Query parameters

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

Response

OK

amountinteger

Represents an invoice payment amount as long.

authorstring

Represents an invoice payment author.

datestring date-time

Represents an invoice payment date in yyyy-MM-ddThh:mm:ssZ format.

idstring

Represents invoice payment identifier across the system.

notestring

Represents an invoice payment note.

Example response

[
  {
    "amount": 100,
    "author": "John Doe",
    "date": "2021-01-01T12:00:00Z",
    "id": "78a687e29ae1f428e7ebe303",
    "note": "This is a sample note for this invoice payment."
  }
]