Skip to main content
GET
/
invoice
/
series
cURL
curl --request GET \
  --url https://api.slash.com/invoice/series \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "$entity": "invoice_series",
      "id": "<string>",
      "status": "active",
      "recurrenceRule": {
        "type": "weekly",
        "dayOfWeek": 3
      },
      "paymentTermsDays": 123,
      "invoiceTz": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endCondition": {
        "type": "never"
      },
      "template": {
        "lineItemsAndTotals": {
          "lineItems": [
            {
              "name": "<string>",
              "quantity": 123,
              "priceCents": 123
            }
          ],
          "discount": {
            "type": "percentage",
            "percent": 123
          },
          "tax": {
            "type": "percentage",
            "percent": 123
          }
        },
        "memo": "<string>",
        "ccEmails": [
          "<string>"
        ]
      },
      "paymentMethods": [
        {
          "method": "inbound_ach_transfer",
          "config": {
            "passFeeToPayer": true
          }
        }
      ],
      "accountId": "<string>",
      "legalEntityContactId": "<string>",
      "nextScheduledDate": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Query Parameters

cursor
string

A cursor string to fetch the next page of results

Filter invoice series by legal entity ID. Required if authenticating via bearer token with access to multiple legal entities.

filter:status
enum<string>

Filter invoice series by status.

Available options:
active,
ended,
cancelled

Filter invoice series by contact (customer) ID.

filter:accountId
string

Filter invoice series by receiving account ID.

sort
enum<string>

Sort invoice series by a field. Default is by status then start date.

Available options:
startDate,
nextScheduledDate
sortDirection
enum<string>

The direction to sort by. Defaults to DESC when sorting by startDate or nextScheduledDate, ASC otherwise.

Available options:
ASC,
DESC

Response

OK

items
InvoiceSeries · object[]
required
metadata
PaginationResponse · object

Response sent when requesting a list of data