Ready to get started with Slash? Get Started →
curl --request POST \
--url https://api.slash.com/invoice/series \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"accountId": "<string>",
"legalEntityContactId": "<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
}
],
"discount": {
"type": "percentage",
"percent": 123
},
"tax": {
"type": "percentage",
"percent": 123
}
},
"memo": "<string>",
"ccEmails": [
"<string>"
]
},
"paymentMethods": [
{
"method": "inbound_ach_transfer",
"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
}
],
"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"
},
"invoiceAggregate": {
"invoice": {
"id": "<string>",
"status": "void",
"collectedAmountCents": 123,
"invoiceDetailsId": "<string>",
"accountId": "<string>",
"legalEntityContactId": "<string>",
"invoiceTransactions": [
{
"transactionType": "external",
"transaction": {
"paymentMethod": "inbound_ach_transfer",
"paidAt": "<string>"
}
}
],
"invoicePaymentMethods": [
{
"method": "inbound_ach_transfer",
"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
}
],
"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>"
}
}
}Create a new invoice series (recurring invoice). The series will automatically generate invoices according to the specified recurrence rule.
curl --request POST \
--url https://api.slash.com/invoice/series \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"accountId": "<string>",
"legalEntityContactId": "<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
}
],
"discount": {
"type": "percentage",
"percent": 123
},
"tax": {
"type": "percentage",
"percent": 123
}
},
"memo": "<string>",
"ccEmails": [
"<string>"
]
},
"paymentMethods": [
{
"method": "inbound_ach_transfer",
"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
}
],
"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"
},
"invoiceAggregate": {
"invoice": {
"id": "<string>",
"status": "void",
"collectedAmountCents": 123,
"invoiceDetailsId": "<string>",
"accountId": "<string>",
"legalEntityContactId": "<string>",
"invoiceTransactions": [
{
"transactionType": "external",
"transaction": {
"paymentMethod": "inbound_ach_transfer",
"paidAt": "<string>"
}
}
],
"invoicePaymentMethods": [
{
"method": "inbound_ach_transfer",
"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
}
],
"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>"
}
}
}Authentication from public API requests
Input for creating or editing a recurring invoice series
Immutable after creation. Ignored on edit.
Discriminated union defining when a recurring invoice series issues invoices
Show child attributes
Number of days after issuance that the invoice is due. 0 = Due on Receipt.
x >= 0IANA timezone identifier used for date calculations
"America/New_York"
Date (in invoiceTz) from which to begin generating invoices
Discriminated union defining when a recurring invoice series stops generating invoices
Show child attributes
Template data used to generate each invoice in a recurring series
Show child attributes
Show child attributes