On This Page
FILTER BY TAG

Generate an Endpoint with Query Parameters

You can filter your search results by creating a query-string that you append to the endpoint. A query-string consists of one or more optional query parameters.
Begin each string with a question mark (
?
) to designate the start of the query parameters, and include an ampersand (
&
) at the beginning of each consecutive query parameter.
Use this format for appending a string of query parameters as name-value pairs:
?name1=value&name2=value&nameN=value
These are the query parameters to filter the retrieved list results:
Query Parameters
Query Parameter
Description
offset
The page offset number. This determines the order in which the invoices are retrieved, beginning with the consecutive number from the string value. For example, an offset of
3
 results in a filtered list that begins with the fourth listed invoice.
Set to a whole number.
limit
The maximum number of items being retrieved.
Set to a whole number.
status
The status of the invoice.
Set to one of these possible values:
  • CANCELED
  • CREATED
  • DRAFT
  • PAID
  • PARTIAL
  • PENDING
    : The customer has initiated a payment for an invoice that is in the
    CREATED
    ,
    SENT
    , or
    PARTIAL
     status. The invoice can no longer be edited, and the customer can no longer initiate an payment in order to avoid a double payment. If the invoice payment requires a fraud review, the invoice will remain in the
    PENDING
     status until you approve or reject it.
  • SENT
In this example, up to 100 draft invoices are retrieved beginning with the fourth listed invoice:
GET 
https://apitest.cybersource.com
/invoicing/v2/invoices?offset=3&limit=100&status=DRAFT
RELATED TO THIS PAGE