Get invoice by query

Retrieves invoice by query

Authorizations

Authorization

string

headerrequired

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

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

LibQuery Model

filters

object

required

JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc

Show child attributes

limit

integer

default: 10

Numbers of records to be returned.

offset

integer

default: 0

Number of records to skipped.

sortBy

string

default: updatedAt

Item property on which data needed to be sorted on.

sortDirection

enum<string>

default: desc

Direction of sorting i.e ascending or descending

Available options:

asc,

desc

Response

200 - application/json

LibQueryResponse Model

count

integer

limit

integer

offset

integer