POST
/
invoices
/
search

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id
string
required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id
string

Unique request ID

Query Parameters

fetchOnlyIds
boolean
default: false
offset
integer
default: 0

Number of records to skip before returning all records. Default is 0 if no value is specified.

limit
integer
default: 10

Maximum number of records returned per page. Default is 10 if no value is specified.

Required range: 1 < x < 100

Body

application/json

Sort and filter criteria for invoice search

filters
object[]
required
sort
string
default: -invoice.invoicedAt

Property by which data is sorted. Note: - refers to descending and + refers to ascending order

Response

200 - application/json

Invoice search response

data
object[]
pagination
object

Pagination response

Was this page helpful?

Get invoice by IDOverview