Invoice

Get payments for an invoice

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

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/invoices/{invoiceId}/payments
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303
invoiceIdstring required

Represents an invoice identifier across the system.

Example:78a687e29ae1f428e7ebe303

Query parameters

pageinteger

Page number.

Example:1
page-sizeinteger

Page size.

Example:50

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."
  }
]

Changes

  • a5b636acbcd8Revision changes
    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status