SLslashfi

List invoices

Changed on

List invoices. Add includeSummary=true for the count and outstanding balance of every invoice the filters match.

get/v2/invoices

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/invoices
  • Auth
    API key in header X-API-Key

Query parameters

cursorstring

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limitinteger

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

sort'createdAt' | 'issueDate' | 'dueDate' | 'total'

Field to order the page by. Each value has its own default direction, used unless sortDirection is passed. See Sorting.

  • createdAt (default) — descending
  • issueDate — descending
  • dueDate — descending
  • total — descending
sortDirection'asc' | 'desc'

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

statusstring[]

Return only invoices in these statuses.

overdueboolean

true returns only invoices that are overdue; false excludes them.

customerIdstring

Return only invoices for one customer.

accountIdstring

Return only invoices that settle into one account.

seriesIdstring

Return only invoices issued by one recurring series.

numberstring

Return only the invoice with exactly this number.

dueFromstring date

Return only invoices due on or after this YYYY-MM-DD date.

dueTostring date

Return only invoices due on or before this YYYY-MM-DD date.

issueDateFromstring date

Return only invoices issued on or after this YYYY-MM-DD date.

issueDateTostring date

Return only invoices issued on or before this YYYY-MM-DD date.

amountMininteger

Return only invoices whose total is at least this many cents.

amountMaxinteger

Return only invoices whose total is at most this many cents.

searchstring

Match invoices by number, memo or customer name.

includeSummaryboolean

true adds a summary covering every invoice the filters match, not just the current page.

Response

A page of invoices.

Example response

{
  "items": [
    {
      "id": "inv_2rj4l7hmrrrcv",
      "number": "INV-1042",
      "customerId": "le_cus_2rj4l7hmrrrcv",
      "accountId": "sa_group_2rj4l7hmrrrcv",
      "timezone": "America/New_York",
      "lineItems": [
        {
          "name": "Robot arm maintenance",
          "quantity": 2
        }
      ],
      "discount": {
        "percent": 10
      },
      "taxRate": 8.5,
      "payments": [
        {
          "id": "inv_tr_link_2rj4l7hmrrrcv",
          "transactionId": "agg_tx_2rj4l7hmrrrcv"
        }
      ],
      "documentId": "st_2rj4l7hmrrrcv"
    }
  ]
}

Changes