Skip to main content
PATCH
/
invoice
/
series
/
{invoiceSeriesId}
cURL
curl --request PATCH \
  --url https://api.slash.com/invoice/series/{invoiceSeriesId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "accountId": "<string>",
  "recurrenceRule": {
    "type": "weekly",
    "dayOfWeek": 3
  },
  "paymentTermsDays": 1,
  "invoiceTz": "America/New_York",
  "startDate": "2023-12-25",
  "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>"
    ]
  },
  "legalEntityContactId": "<string>",
  "legalEntityCustomerId": "<string>",
  "paymentMethods": [
    {
      "method": "ach_debit",
      "config": {
        "passFeeToPayer": true
      }
    }
  ]
}
'
{
  "invoiceSeries": {
    "$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>"
  },
  "invoiceAggregate": {
    "invoice": {
      "id": "<string>",
      "status": "void",
      "collectedAmountCents": 123,
      "invoiceDetailsId": "<string>",
      "accountId": "<string>",
      "invoiceTransactions": [
        {
          "transactionType": "external",
          "transaction": {
            "paymentMethod": {
              "method": "ach_debit",
              "config": {
                "passFeeToPayer": true
              }
            },
            "paidAt": "<string>"
          }
        }
      ],
      "legalEntityContactId": "<string>",
      "legalEntityCustomerId": "<string>",
      "invoicePaymentMethods": [
        {
          "method": "ach_debit",
          "config": {
            "passFeeToPayer": true
          }
        }
      ],
      "closedAt": "2023-11-07T05:31:56Z",
      "invoiceSeriesId": "<string>",
      "scheduledSendDate": "2023-11-07T05:31:56Z"
    },
    "invoiceDetails": {
      "id": "<string>",
      "issuedAt": "2023-11-07T05:31:56Z",
      "dueAt": "2023-11-07T05:31:56Z",
      "invoiceTz": "America/New_York",
      "currency": "<string>",
      "lineItemsAndTotals": {
        "lineItems": [
          {
            "name": "<string>",
            "quantity": 123,
            "priceCents": 123,
            "catalogItemId": "<string>"
          }
        ],
        "subtotalCents": 123,
        "totalAmountCents": 123,
        "discount": {
          "type": "percentage",
          "percent": 123
        },
        "tax": {
          "type": "percentage",
          "percent": 123
        }
      },
      "invoiceNumber": "<string>",
      "documentId": "<string>",
      "billedTo": {
        "name": "<string>",
        "email": "<string>",
        "address": {
          "addressLine": "<string>",
          "addressCity": "<string>",
          "addressState": "<string>",
          "addressZip": "<string>",
          "addressLine2": "<string>",
          "addressCountry": "<string>"
        },
        "ccEmails": [
          "<string>"
        ]
      },
      "version": 2,
      "memo": "<string>"
    },
    "invoiceAccount": {
      "id": "<string>",
      "name": "<string>",
      "slashAccountGroupId": "<string>",
      "accountType": "default",
      "accountNumber": "<string>",
      "routingNumber": "<string>",
      "closedAt": "<string>"
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Authentication from public API requests

Path Parameters

​
invoiceSeriesId
string
required

Body

application/json

Input for creating or editing a recurring invoice series

​
accountId
string
required
​
recurrenceRule
InvoiceSeriesRecurrenceRule · object
required

Discriminated union defining when a recurring invoice series issues invoices

​
paymentTermsDays
integer
required

Number of days after issuance that the invoice is due. 0 = Due on Receipt.

Required range: x >= 0
​
invoiceTz
string
required

IANA timezone identifier used for date calculations

Example:

"America/New_York"

​
startDate
string<date>
required

Date (in invoiceTz) from which to begin generating invoices

​
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

​
legalEntityContactId
string

Immutable after creation. Ignored on edit.

​
legalEntityCustomerId
string

The legal entity customer this series is for. Optional during transition.

​
paymentMethods
(PaymentMethodAchDebit · object | PaymentMethodCryptoDeposit · object | PaymentMethodInboundAchTransfer · object | PaymentMethodInboundInternationalWire · object | PaymentMethodInboundRtp · object | PaymentMethodInboundWireTransfer · object)[]

Response

OK

​
invoiceSeries
InvoiceSeries · object
required

Invoice series model for API responses

​
invoiceAggregate
InvoiceAggregate · object

Aggregate model for an invoice