Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Invoice

Add an invoice

post/v1/workspaces/{workspaceId}/invoices

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Request body

clientIdstring required

Represents a client identifier across the system.

currencystring required

Represents the currency used by the invoice.

dueDatestring date-time required

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

issuedDatestring date-time required

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

numberstring required

Represents an invoice number.

timeViewMode'TIME_SENSITIVE_VIEW' | 'AGGREGATED_TIME_VIEW'

Example request

{
  "clientId": "98h687e29ae1f428e7ebe707",
  "currency": "USD",
  "dueDate": "2020-06-01T08:00:00Z",
  "issuedDate": "2020-01-01T08:00:00Z",
  "number": "202306121129"
}

Response

Created

billFromstring

Represents to whom the invoice should be billed from.

clientIdstring

Represents client identifier across the system.

currencystring

Represents the currency used by the invoice.

dueDatestring date-time

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

idstring

Represents invoice identifier across the system.

issuedDatestring date-time

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

numberstring

Represents an invoice number.

Example response

{
  "billFrom": "Business X",
  "clientId": "34p687e29ae1f428e7ebe562",
  "currency": "USD",
  "dueDate": "2020-06-01T08:00:00Z",
  "id": "78a687e29ae1f428e7ebe303",
  "issuedDate": "2020-01-01T08:00:00Z",
  "number": "202306121129"
}