Invoice

Change an invoice status

Changed on
patch/v1/workspaces/{workspaceId}/invoices/{invoiceId}/status

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/invoices/{invoiceId}/status
  • 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

invoiceStatus'UNSENT' | 'SENT' | 'PAID' | 'PARTIALLY_PAID' | 'VOID' | 'OVERDUE'

Represents the invoice status to be set.

Example request

{
  "invoiceStatus": "PAID"
}

Response

OK

Changes