Invoice

Add payment to an invoice

Changed on
post/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

Request body

amountinteger

Represents an invoice payment amount as long.

notestring

Represents an invoice payment note.

paymentDatestring

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

Example request

{
  "amount": 100,
  "note": "This is a sample note for this invoice payment.",
  "paymentDate": "2021-01-01T12:00:00Z"
}

Response

Created

InvoiceOverviewDtoV1 required(unresolved $ref)

Changes

    • info

      the request property default value was added

    • info

      the request property default value was added

    • 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

    • 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

    • 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

    • 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

    • 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

    • info

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

    • info

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