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

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Path Parameters

invoiceSeriesId
string
required

Response

OK

invoiceSeries
InvoiceSeries · object
required

Invoice series model for API responses

voidedInvoice
InvoiceAggregate · object

Aggregate model for an invoice