List invoices

GET

invoices

List invoices

curl --request GET \
  --url https://api.slash.com/v2/invoices \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "items": [
    {
      "id": "inv_2rj4l7hmrrrcv",
      "number": "INV-1042",
      "status": "scheduled",
      "overdue": true,
      "accountId": "sa_group_2rj4l7hmrrrcv",
      "issueDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "timezone": "America/New_York",
      "lineItems": [
        {
          "name": "Robot arm maintenance",
          "quantity": 2,
          "unitAmount": {
            "amount": 123,
            "currency": "<string>"
          },
          "total": {
            "amount": 123,
            "currency": "<string>"
          },
          "catalogItemId": "<string>"
        }
      ],
      "amounts": {
        "subtotal": {
          "amount": 123,
          "currency": "<string>"
        },
        "discount": {
          "amount": 123,
          "currency": "<string>"
        },
        "tax": {
          "amount": 123,
          "currency": "<string>"
        },
        "total": {
          "amount": 123,
          "currency": "<string>"
        },
        "paid": {
          "amount": 123,
          "currency": "<string>"
        },
        "outstanding": {
          "amount": 123,
          "currency": "<string>"
        }
      },
      "ccEmails": [
        "<string>"
      ],
      "billedTo": {
        "name": "<string>",
        "email": "<string>",
        "address": {
          "line1": "<string>",
          "city": "<string>",
          "line2": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>"
        }
      },
      "paymentMethods": [
        {
          "type": "bank_transfer",
          "passFeeToPayer": true
        }
      ],
      "payments": [
        {
          "id": "inv_tr_link_2rj4l7hmrrrcv",
          "amount": {
            "amount": 123,
            "currency": "<string>"
          },
          "paidOn": "2023-12-25",
          "method": "ach",
          "matchedBy": "automatic",
          "createdAt": "2023-11-07T05:31:56Z",
          "transactionId": "agg_tx_2rj4l7hmrrrcv"
        }
      ],
      "payUrl": "<string>",
      "documentId": "st_2rj4l7hmrrrcv",
      "createdAt": "2023-11-07T05:31:56Z",
      "customerId": "le_cus_2rj4l7hmrrrcv",
      "virtualAccountId": "<string>",
      "seriesId": "<string>",
      "scheduledSendDate": "2023-12-25",
      "discount": {
        "type": "percentage",
        "percent": 10
      },
      "taxRate": 8.5,
      "memo": "<string>",
      "nextReminderAt": "2023-11-07T05:31:56Z",
      "paidAt": "2023-11-07T05:31:56Z",
      "voidedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "count": 1,
    "nextCursor": "<string>"
  },
  "summary": {
    "count": 1,
    "outstanding": {
      "amount": 123,
      "currency": "<string>"
    }
  }
}

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Query Parameters

cursor

string

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limit

integer

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

Required range: 1 <= x <= 100

sort

enum<string>

default:createdAt

Field to order the page by. Each value has its own default direction, used unless sortDirection is passed. See Sorting.

createdAt (default) — descending
issueDate — descending
dueDate — descending
total — descending

Available options:

createdAt,

issueDate,

dueDate,

total

sortDirection

enum<string>

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

Available options:

asc,

desc

status

enum<string>[]

Return only invoices in these statuses.

Available options:

scheduled,

unpaid,

partially_paid,

paid,

void

overdue

boolean

true returns only invoices that are overdue; false excludes them.

customerId

string

Return only invoices for one customer.

accountId

string

Return only invoices that settle into one account.

seriesId

string

Return only invoices issued by one recurring series.

number

string

Return only the invoice with exactly this number.

Required string length: 1 - 50

Pattern: ^[A-Z0-9_-]+$

dueFrom

string<date>

Return only invoices due on or after this YYYY-MM-DD date.

dueTo

string<date>

Return only invoices due on or before this YYYY-MM-DD date.

issueDateFrom

string<date>

Return only invoices issued on or after this YYYY-MM-DD date.

issueDateTo

string<date>

Return only invoices issued on or before this YYYY-MM-DD date.

amountMin

integer

Return only invoices whose total is at least this many cents.

Required range: x >= 0

amountMax

integer

Return only invoices whose total is at most this many cents.

Required range: x >= 0

string

Match invoices by number, memo or customer name.

Required string length: 1 - 255

includeSummary

boolean

true adds a summary covering every invoice the filters match, not just the current page.

Response

A page of invoices.

items

Invoice · object[]

required

Hide child attributes

items.id

string

required

Invoice id with the inv_ prefix.

Example:

"inv_2rj4l7hmrrrcv"

items.number

string

required

Unique per legal entity.

Example:

"INV-1042"

items.status

enum<string>

required

See Invoice lifecycle.

Available options:

scheduled,

unpaid,

partially_paid,

paid,

void

items.overdue

boolean

required

Whether the invoice is unpaid or partially_paid and its due date has passed in its timezone.

items.accountId

string

required

The account payments settle into, with the sa_group_ prefix.

Example:

"sa_group_2rj4l7hmrrrcv"

items.issueDate

string<date>

required

items.dueDate

string<date>

required

items.timezone

string

required

The IANA timezone the invoice's dates are in.

Example:

"America/New_York"

items.lineItems

InvoiceLineItem · object[]

required

Hide child attributes

items.lineItems.name

string

required

Example:

"Robot arm maintenance"

items.lineItems.quantity

number

required

Example:

2

items.lineItems.unitAmount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

items.lineItems.unitAmount.amount

integer

required

Amount in the currency's minor units.

items.lineItems.unitAmount.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.lineItems.total

Money · object

required

quantity times unitAmount.

Hide child attributes

items.lineItems.total.amount

integer

required

Amount in the currency's minor units.

items.lineItems.total.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.lineItems.catalogItemId

string

The catalog item the line was added from, with the cat_item_ prefix. The line keeps the name and price it was written with.

items.amounts

object

required

Hide child attributes

items.amounts.subtotal

Money · object

required

The line items' totals added up.

Hide child attributes

items.amounts.subtotal.amount

integer

required

Amount in the currency's minor units.

items.amounts.subtotal.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.amounts.discount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

items.amounts.discount.amount

integer

required

Amount in the currency's minor units.

items.amounts.discount.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.amounts.tax

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

items.amounts.tax.amount

integer

required

Amount in the currency's minor units.

items.amounts.tax.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.amounts.total

Money · object

required

What the customer owes in all.

Hide child attributes

items.amounts.total.amount

integer

required

Amount in the currency's minor units.

items.amounts.total.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.amounts.paid

Money · object

required

What has been paid so far.

Hide child attributes

items.amounts.paid.amount

integer

required

Amount in the currency's minor units.

items.amounts.paid.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.amounts.outstanding

Money · object

required

What is still owed. Zero once the invoice is paid or void.

Hide child attributes

items.amounts.outstanding.amount

integer

required

Amount in the currency's minor units.

items.amounts.outstanding.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.ccEmails

string[]

required

Also copied on the invoice and its reminders.

items.billedTo

object

required

The customer's details as they were when the invoice was created.

Hide child attributes

items.billedTo.name

string

required

items.billedTo.email

string

required

items.billedTo.address

Address · object

Hide child attributes

items.billedTo.address.line1

string

required

Minimum string length: 1

items.billedTo.address.city

string

required

Minimum string length: 1

items.billedTo.address.line2

string

items.billedTo.address.state

string

items.billedTo.address.postalCode

string

items.billedTo.address.countryCode

string

ISO 3166-1 alpha-2 country code.

Required string length: 2

items.paymentMethods

InvoicePaymentMethod · object[]

required

Hide child attributes

items.paymentMethods.type

enum<string>

required

bank_transfer (ACH, wire or realtime payment to the account's details) is always offered.

Available options:

bank_transfer,

ach_debit,

card,

crypto

items.paymentMethods.passFeeToPayer

boolean

required

Whether the payer covers the method's processing fee.

items.payments

InvoicePayment · object[]

required

Oldest first.

Hide child attributes

items.payments.id

string

required

Payment id with the inv_tr_link_ prefix. Remove it with DELETE /v2/invoices/{invoiceId}/payments/{paymentId}.

Example:

"inv_tr_link_2rj4l7hmrrrcv"

items.payments.amount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

items.payments.amount.amount

integer

required

Amount in the currency's minor units.

items.payments.amount.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

items.payments.paidOn

string<date>

required

The day the payment arrived, in the invoice's timezone.

items.payments.method

enum<string>

required

How the money arrived.

Available options:

ach,

wire,

international_wire,

realtime,

ach_debit,

card,

crypto,

other

items.payments.matchedBy

enum<string>

required

automatic when Slash matched the deposit or the payer paid on the payment page; manual when it was recorded by hand.

Available options:

automatic,

manual

items.payments.createdAt

string<date-time>

required

When the payment was recorded.

items.payments.transactionId

string

The deposit, with the agg_tx_ prefix, readable at GET /v2/transactions/{transactionId}. Absent for payments received outside Slash.

Example:

"agg_tx_2rj4l7hmrrrcv"

items.payUrl

string

required

The hosted page where the customer views and pays the invoice.

items.documentId

string

required

The invoice's PDF, with the st_ prefix. Download it with GET /v2/documents/{documentId}. Each edit issues a new PDF.

Example:

"st_2rj4l7hmrrrcv"

items.createdAt

string<date-time>

required

items.customerId

string

Customer id with the le_cus_ prefix.

Example:

"le_cus_2rj4l7hmrrrcv"

items.virtualAccountId

string

The virtual account payments settle into, with the subaccount_ prefix. Absent when they settle into the account's primary virtual account.

items.seriesId

string

The recurring series that issued the invoice, with the inv_series_ prefix.

items.scheduledSendDate

string<date>

When a scheduled invoice will be emailed, at 9:00 in its timezone.

items.discount

Percentage · object

Taken off the line items' subtotal before tax.

Percentage
Fixed

Hide child attributes

items.discount.type

enum<string>

required

Available options:

percentage

items.discount.percent

number

required

Percent of the subtotal. 10 means 10%.

Example:

10

items.taxRate

number

Tax as a percent of the subtotal after the discount. 8.5 means 8.5%.

Example:

8.5

items.memo

string

A note printed on the invoice.

items.nextReminderAt

string<date-time>

When the next automatic reminder is due to go out.

items.paidAt

string<date-time>

When the invoice became paid.

items.voidedAt

string<date-time>

When the invoice was voided.

metadata

PaginationMetadata · object

required

Hide child attributes

metadata.count

integer

required

Number of items in this page.

Required range: x >= 0

metadata.nextCursor

string

Opaque cursor for the next page. Omitted on the final page.

summary

InvoiceSummary · object

Totals across every invoice the filters match, not just the current page.

Hide child attributes

summary.count

integer

required

How many invoices match.

Required range: x >= 0

summary.outstanding

Money · object

required

What the matching invoices still owe.

Hide child attributes

summary.outstanding.amount

integer

required

Amount in the currency's minor units.

summary.outstanding.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

⌘I

List invoices

curl --request GET \
  --url https://api.slash.com/v2/invoices \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'GET',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/invoices"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "items": [
    {
      "id": "inv_2rj4l7hmrrrcv",
      "number": "INV-1042",
      "status": "scheduled",
      "overdue": true,
      "accountId": "sa_group_2rj4l7hmrrrcv",
      "issueDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "timezone": "America/New_York",
      "lineItems": [
        {
          "name": "Robot arm maintenance",
          "quantity": 2,
          "unitAmount": {
            "amount": 123,
            "currency": "<string>"
          },
          "total": {
            "amount": 123,
            "currency": "<string>"
          },
          "catalogItemId": "<string>"
        }
      ],
      "amounts": {
        "subtotal": {
          "amount": 123,
          "currency": "<string>"
        },
        "discount": {
          "amount": 123,
          "currency": "<string>"
        },
        "tax": {
          "amount": 123,
          "currency": "<string>"
        },
        "total": {
          "amount": 123,
          "currency": "<string>"
        },
        "paid": {
          "amount": 123,
          "currency": "<string>"
        },
        "outstanding": {
          "amount": 123,
          "currency": "<string>"
        }
      },
      "ccEmails": [
        "<string>"
      ],
      "billedTo": {
        "name": "<string>",
        "email": "<string>",
        "address": {
          "line1": "<string>",
          "city": "<string>",
          "line2": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "countryCode": "<string>"
        }
      },
      "paymentMethods": [
        {
          "type": "bank_transfer",
          "passFeeToPayer": true
        }
      ],
      "payments": [
        {
          "id": "inv_tr_link_2rj4l7hmrrrcv",
          "amount": {
            "amount": 123,
            "currency": "<string>"
          },
          "paidOn": "2023-12-25",
          "method": "ach",
          "matchedBy": "automatic",
          "createdAt": "2023-11-07T05:31:56Z",
          "transactionId": "agg_tx_2rj4l7hmrrrcv"
        }
      ],
      "payUrl": "<string>",
      "documentId": "st_2rj4l7hmrrrcv",
      "createdAt": "2023-11-07T05:31:56Z",
      "customerId": "le_cus_2rj4l7hmrrrcv",
      "virtualAccountId": "<string>",
      "seriesId": "<string>",
      "scheduledSendDate": "2023-12-25",
      "discount": {
        "type": "percentage",
        "percent": 10
      },
      "taxRate": 8.5,
      "memo": "<string>",
      "nextReminderAt": "2023-11-07T05:31:56Z",
      "paidAt": "2023-11-07T05:31:56Z",
      "voidedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "count": 1,
    "nextCursor": "<string>"
  },
  "summary": {
    "count": 1,
    "outstanding": {
      "amount": 123,
      "currency": "<string>"
    }
  }
}

Banking

Money movement

Bill pay

Invoicing

Accounting

Platform

List invoices

Authorizations

Headers

Query Parameters

Response