Sign in
Invoice

Filter out invoices

post/v1/workspaces/{workspaceId}/invoices/info

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Request body

exactAmountinteger

Represents an invoice amount. If provided, you'll get a filtered list of invoices that has the equal amount as specified.

exactBalanceinteger

Represents an invoice balance. If provided, you'll get a filtered list of invoices that has the equal balance as specified.

greaterThanAmountinteger

Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount greater than specified.

greaterThanBalanceinteger

Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance greater than specified.

invoiceNumberstring

If provided, you'll get a filtered list of invoices that contain the provided string in their invoice number.

lessThanAmountinteger

Represents an invoice amount. If provided, you'll get a filtered list of invoices that has amount less than specified.

lessThanBalanceinteger

Represents an invoice balance. If provided, you'll get a filtered list of invoices that has balance less than specified.

pageinteger

Page number.

pageSizeinteger

Page size.

sortColumn'ID' | 'CLIENT' | 'DUE_ON' | 'ISSUE_DATE' | 'AMOUNT' | 'BALANCE'

Represents the column name to be used as sorting criteria.

sortOrder'ASCENDING' | 'DESCENDING'

Represents the sorting order.

statusesstring[]

Represents a list of invoice statuses. If provided, you'll get a filtered list of invoices that matches any of the invoice status provided.

strictSearchboolean

Flag to toggle on/off strict search mode. When set to true, search by invoice number only will return invoices whose number exactly matches the string value given for the 'invoiceNumber' parameter. When set to false, results will also include invoices whose number contain the string value, but could be longer than the string value itself. For example, if there is an invoice with the number '123456', and the search value is '123', setting strict-name-search to true will not return that invoice in the results, whereas setting it to false will.

Example request

{
  "clients": {
    "contains": "CONTAINS",
    "ids": [
      "5a0ab5acb07987125438b60f",
      "64c777ddd3fcab07cfbb210c"
    ],
    "status": "ACTIVE"
  },
  "companies": {
    "contains": "CONTAINS",
    "ids": [
      "5a0ab5acb07987125438b60f",
      "64c777ddd3fcab07cfbb210c"
    ]
  },
  "exactAmount": 1000,
  "exactBalance": 1000,
  "greaterThanAmount": 500,
  "greaterThanBalance": 500,
  "invoiceNumber": "Invoice-01",
  "issueDate": {
    "issue-date-end": "2020-01-01",
    "issue-date-start": "2020-01-01"
  },
  "lessThanAmount": 500,
  "lessThanBalance": 500,
  "sortColumn": "ID",
  "sortOrder": "ASCENDING",
  "statuses": [
    "SENT",
    "PAID",
    "PARTIALLY_PAID"
  ]
}

Response

OK

invoicesInvoiceInfoV1[] — unresolved $ref

Represents a list of invoice info.

totalinteger

Represents the total invoice count.

Changes