Skip to main content
GET
/
invoice
cURL
curl --request GET \
  --url https://api.slash.com/invoice \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "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"
      },
      "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>"
      }
    }
  ],
  "metadata": {
    "nextCursor": "<string>",
    "count": 123
  }
}

Authorizations

X-API-Key
string
header
required

Authentication from public API requests

Query Parameters

cursor
string

A cursor string to fetch the next page of results

Filter invoices by legal entity ID. Required if authenticating via bearer token with access to multiple legal entities.

filter:status
enum<string>

Filter invoices by status.

Available options:
unpaid,
paid,
paid_partially,
overdue,
void

Filter invoices by contact (customer) ID.

filter:accountId
string

Filter invoices by receiving account ID.

sort
enum<string>

Sort invoices by a field. Default is by status then due date.

Available options:
issuedAt,
dueAt
sortDirection
enum<string>

The direction to sort by. Defaults to DESC when sorting by issuedAt or dueAt, ASC otherwise.

Available options:
ASC,
DESC

Response

OK

items
InvoiceAggregate · object[]
required
metadata
PaginationResponse · object

Response sent when requesting a list of data