Search for invoices with search criteria and retrieve a paged list of invoices.

Valid filters are:

  • All valid parameters of /invoice/list
  • Filters specific to /invoice/search as detailed below. TODO

Pagination has the defaults as specified in its schema, but 'pagination' is an optional search request attribute!
Filters can have three items that apply to pagination (Supported by /invoice/list and factored in for compatibility):

  • offset
  • limit
  • ignoreLimit
    The precedence of these filter items and pagination attributes are as follows:
  • No attributes from either set provided: Pagination defaults apply
  • No Pagination and some 'pagination' filters: Pagination defaults with overrides as follows when applicable:
    PageNumber: offset / ItemsPerPage
    TotalItems: limit if ignoreLimit==false else ItemsPerPage
    TotalPages: 1
    ItemsPerPage: 20
  • Pagination provided: limit filters are completely ignored

NOTE: The following pattern in the request body/shape constitutes a request for "the default Pagination settings"
and will cause 'limit' filters to be IGNORED because you are providing explicit Pagination:
{
"pagination": ""
}

Filters:

  • Valid parameters of /invoice/list
    Examples:
    Include voided invoices:

      "filters": [
        {
          "type": "boolean",
          "field": "includevoided",
          "value": "true"
        }
      ]
    

    Multiple, specific invoices:

      "filters": [
        {
          "type": "list",
          "field": "invoiceids",
          "value": "A1A1A1A1A1A1A1A1,B2B2B2B2B2B2B2B2,C3C3C3C3C3C3C3C3"
        }
      ]
    

    Weak pagination via limit and offset:

      "filters": [
        {
          "type": "integer",
          "field": "limit",
          "value": "10"
        },
        {
          "type": "integer",
          "field": "offset",
          "value": "10"
        },
        {
          "type": "boolean",
          "field": "includevoided",
          "value": "true"
        }
      ]
    

    Better pagination:

      "filters": [
        {
          "type": "boolean",
          "field": "includevoided",
          "value": "true"
        }
      ],
      "pagination": {
        "TotalItems": 20,
        "ItemsPerPage": 10,
        "PageNumber": 2
      }
    
Language
Authentication
URL
Click Try It! to start a request and see the response here!