Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Invoice

Get all invoices on a workspace

get/v1/workspaces/{workspaceId}/invoices

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Query parameters

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

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

If provided, you'll get a filtered result of invoices that matches the provided string in the user ID linked to the expense.

sort-column'ID' | 'CLIENT' | 'DUE_ON' | 'ISSUE_DATE' | 'AMOUNT' | 'BALANCE'

Valid column name as sorting criteria. Default: ID

sort-order'ASCENDING' | 'DESCENDING'

Sort order. Default: ASCENDING

Response

OK

totalinteger

Represents the total invoice count.

Example response

{
  "invoices": [
    {
      "amount": 100,
      "balance": 50,
      "clientId": "98h687e29ae1f428e7ebe707",
      "clientName": "Client X",
      "currency": "USD",
      "dueDate": "2020-06-01T08:00:00Z",
      "id": "78a687e29ae1f428e7ebe303",
      "issuedDate": "2020-01-01T08:00:00Z",
      "number": "202306121129",
      "paid": 50,
      "status": "PAID"
    }
  ],
  "total": 100
}