Skip to main content
GET
/
invoice
/
series
/
{invoiceSeriesId}
cURL
curl --request GET \
  --url https://api.slash.com/invoice/series/{invoiceSeriesId} \
  --header 'X-API-Key: <api-key>'
{
  "$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"
}

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Path Parameters

invoiceSeriesId
string
required

Response

OK

Invoice series model for API responses

$entity
enum<string>
required
Available options:
invoice_series
id
string
required
status
enum<string>
required
Available options:
active,
ended,
cancelled
recurrenceRule
InvoiceSeriesRecurrenceRule · object
required

Discriminated union defining when a recurring invoice series issues invoices

paymentTermsDays
integer
required
invoiceTz
string
required
startDate
string<date-time>
required
endCondition
InvoiceSeriesEndCondition · object
required

Discriminated union defining when a recurring invoice series stops generating invoices

template
InvoiceSeriesTemplate · object
required

Template data used to generate each invoice in a recurring series

paymentMethods
InvoiceSlashPaymentMethod · object[]
required
accountId
string
required
nextScheduledDate
string<date-time> | null