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,
          "catalogItemId": "<string>"
        }
      ],
      "discount": {
        "type": "percentage",
        "percent": 123
      },
      "tax": {
        "type": "percentage",
        "percent": 123
      }
    },
    "memo": "<string>",
    "ccEmails": [
      "<string>"
    ]
  },
  "paymentMethods": [
    {
      "method": "ach_debit",
      "config": {
        "passFeeToPayer": true
      }
    }
  ],
  "accountId": "<string>",
  "nextScheduledDate": "2023-11-07T05:31:56Z",
  "legalEntityContactId": "<string>",
  "legalEntityCustomerId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.slash.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

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
(PaymentMethodAchDebit · object | PaymentMethodCryptoDeposit · object | PaymentMethodInboundAchTransfer · object | PaymentMethodInboundInternationalWire · object | PaymentMethodInboundRtp · object | PaymentMethodInboundWireTransfer · object)[]
required
accountId
string
required
nextScheduledDate
string<date-time> | null