Skip to content
Merchant API/
/
List all invoices

List all invoices

Request

Return a list of invoices.

Security
bearerAuth or basicAuth
Query
limitinteger, [ 25 .. 100 ]

Limit the number of invoices returned.

Default:25
pagestring

Specify the page of invoices returned.

Default:"1"
filterobject

Filter invoices by the specified fields.

Filter semantics: filter[field][operator]=value.

Available filter operators:

  • eq - equal (=)
  • ne - not equal (!=)
  • gt - greater than (>)
  • gte - greater than or equal (>=)
  • lt - less than (<)
  • lte - less than or equal (<=)

Filtering is allowed by the following fields:

  • number (eq)
  • order_number (eq)
  • po_number (eq)
  • customer_id (eq)
  • advance_requested (eq)
  • created_at (eq, gt, lt, gte, lte)
  • fully_paid (eq, ne)
  • fully_paid_at (eq, gt, lt, gte, lte)
  • amount_due (eq, gt, lt, gte, lte)
  • amount_balance (eq, gt, lt, gte, lte)
  • amount_pending (eq, gt, lt, gte, lte)
  • amount_refunded (eq, gt, lt, gte, lte)
  • archived (eq, ne)

Example: filter[number][eq]=100

Note: filter with the eq operator is equivalent to the following filter filter[field]=value

curl -i -X GET \
  'https://docs.resolvepay.com/_mock/merchant-api/openapi/invoices?limit=25&page=1&filter=%7B%22number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22order_number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22po_number%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22customer_id%22%3A%7B%22eq%22%3A%22string%22%7D%2C%22created_at%22%3A%7B%22eq%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gte%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lte%22%3A%222019-08-24T14%3A15%3A22Z%22%7D%2C%22fully_paid%22%3A%7B%22eq%22%3Atrue%2C%22ne%22%3Atrue%7D%2C%22fully_paid_at%22%3A%7B%22eq%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lt%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22gte%22%3A%222019-08-24T14%3A15%3A22Z%22%2C%22lte%22%3A%222019-08-24T14%3A15%3A22Z%22%7D%2C%22amount_due%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_balance%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_pending%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22amount_refunded%22%3A%7B%22eq%22%3A0%2C%22gt%22%3A0%2C%22lt%22%3A0%2C%22gte%22%3A0%2C%22lte%22%3A0%7D%2C%22archived%22%3A%7B%22eq%22%3Atrue%2C%22ne%22%3Atrue%7D%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An object with an array of results containing up to the limit. If no invoices are found, the results array will be empty.

Bodyapplication/json
countinteger
Example:1
limitinteger
Example:25
pageinteger
Example:1
resultsArray of objects(Invoice)
Response
{
  "count": 1,
  "limit": 25,
  "page": 1,
  "results": [
    { … }
  ]
}