GET /invoices?{query-parameters}

Get a list of all invoices.

Search Parameters

name format description
customerEmail Max Length 64 Limits results to Invoices with a customerEmail starting with the specified string
customerFirstName Max Length 64 Limits results to Invoices with a customerFirstName starting with the specified string
customerLastName Max Length 64 Limits results to Invoices with a customerLastName starting with the specified string
invoiceNumber Max Length 64 Limits results to Invoices with an invoiceNumber starting with the specified string
status OPEN | PAID | VOID Limits results to Invoices in the status specified

Paging and Sorting Parameters

name format description
limit Max 50 Limits the number of results per page. See Pagination.
offset Max 2^31 The index at which to start returning results. See Pagination.
order asc | desc Sorts in ascending (asc) or descending (desc) order based on the sort parameter
sort created | completedAt Changes the order in which results are indexed, defaults to created

Example Request

curl https://api.payjunction.com/invoices/?limit=10&order=asc&sort=completedAt&customerEmail=jdoe&status=OPEN \
  -u "login:password" \
  -H "Accept: application/json" \
  -H "X-PJ-Application-Key: YOUR_PRODUCTION_APP_KEY"

Example Response

{
  "next" : "https://api.payjunction.com/invoices?offset=10&limit=10&order=asc&sort=completedAt&customerEmail=jdoe&status=OPEN",
  "results" : [ {
    "amountBase" : "1.99",
    "created" : "2020-11-24T01:19:23Z",
    "customerEmail" : "jdoe@payjunction.com",
    "customerFirstName" : "John",
    "customerIdentifier" : "customer-id",
    "customerLastName" : "Doe",
    "invoiceId" : "e321790e-c030-4501-aa99-09e35158c1a6",
    "invoiceNumber" : "TO-123456",
    "lastModified" : "2020-11-24T01:19:23Z",
    "message" : "Invoice for takeout order #123456",
    "status" : "OPEN",
    "terminalId" : 1
  }, {
    "amountBase" : "5.99",
    "created" : "2020-11-29T05:11:47Z",
    "customerEmail" : "jdoe@payjunction.com",
    "customerFirstName" : "John",
    "customerIdentifier" : "customer-id",
    "customerLastName" : "Doe",
    "invoiceId" : "2dcd72bb-94b7-43b7-b40f-642331de0f72",
    "invoiceNumber" : "TO-123789",
    "lastModified" : "2020-11-29T05:11:47Z",
    "message" : "Invoice for takeout order #123789",
    "status" : "OPEN",
    "terminalId" : 1
  }, {
    ...
  } ]
}