Send a payment reminder

POST

invoices

{invoiceId}

send-reminder

curl --request POST \
  --url https://api.slash.com/v2/invoices/{invoiceId}/send-reminder \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

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

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

import requests

url = "https://api.slash.com/v2/invoices/{invoiceId}/send-reminder"

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

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

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/invoices/{invoiceId}/send-reminder"

	req, _ := http.NewRequest("POST", 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))

}

{
  "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"
}

See Reminders.

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]+$

Path Parameters

invoiceId

string

required

Invoice id with the inv_ prefix.

Response

The invoice.

A request for payment you send a customer. Slash emails it, hosts a payment page at payUrl, matches incoming deposits to it and keeps its status and amounts up to date. All amounts are in USD.

string

required

Invoice id with the inv_ prefix.

Example:

"inv_2rj4l7hmrrrcv"

number

string

required

Unique per legal entity.

Example:

"INV-1042"

status

enum<string>

required

See Invoice lifecycle.

Available options:

scheduled,

unpaid,

partially_paid,

paid,

void

overdue

boolean

required

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

accountId

string

required

The account payments settle into, with the sa_group_ prefix.

Example:

"sa_group_2rj4l7hmrrrcv"

issueDate

string<date>

required

dueDate

string<date>

required

timezone

string

required

The IANA timezone the invoice's dates are in.

Example:

"America/New_York"

lineItems

InvoiceLineItem · object[]

required

Hide child attributes

lineItems.name

string

required

Example:

"Robot arm maintenance"

lineItems.quantity

number

required

Example:

2

lineItems.unitAmount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

lineItems.unitAmount.amount

integer

required

Amount in the currency's minor units.

lineItems.unitAmount.currency

string

required

Uppercase ISO 4217 currency code.

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

lineItems.total

Money · object

required

quantity times unitAmount.

Hide child attributes

lineItems.total.amount

integer

required

Amount in the currency's minor units.

lineItems.total.currency

string

required

Uppercase ISO 4217 currency code.

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

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.

amounts

object

required

Hide child attributes

amounts.subtotal

Money · object

required

The line items' totals added up.

Hide child attributes

amounts.subtotal.amount

integer

required

Amount in the currency's minor units.

amounts.subtotal.currency

string

required

Uppercase ISO 4217 currency code.

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

amounts.discount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amounts.discount.amount

integer

required

Amount in the currency's minor units.

amounts.discount.currency

string

required

Uppercase ISO 4217 currency code.

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

amounts.tax

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amounts.tax.amount

integer

required

Amount in the currency's minor units.

amounts.tax.currency

string

required

Uppercase ISO 4217 currency code.

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

amounts.total

Money · object

required

What the customer owes in all.

Hide child attributes

amounts.total.amount

integer

required

Amount in the currency's minor units.

amounts.total.currency

string

required

Uppercase ISO 4217 currency code.

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

amounts.paid

Money · object

required

What has been paid so far.

Hide child attributes

amounts.paid.amount

integer

required

Amount in the currency's minor units.

amounts.paid.currency

string

required

Uppercase ISO 4217 currency code.

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

amounts.outstanding

Money · object

required

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

Hide child attributes

amounts.outstanding.amount

integer

required

Amount in the currency's minor units.

amounts.outstanding.currency

string

required

Uppercase ISO 4217 currency code.

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

ccEmails

string[]

required

Also copied on the invoice and its reminders.

billedTo

object

required

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

Hide child attributes

billedTo.name

string

required

billedTo.email

string

required

billedTo.address

Address · object

Hide child attributes

billedTo.address.line1

string

required

Minimum string length: 1

billedTo.address.city

string

required

Minimum string length: 1

billedTo.address.line2

string

billedTo.address.state

string

billedTo.address.postalCode

string

billedTo.address.countryCode

string

ISO 3166-1 alpha-2 country code.

Required string length: 2

paymentMethods

InvoicePaymentMethod · object[]

required

Hide child attributes

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

paymentMethods.passFeeToPayer

boolean

required

Whether the payer covers the method's processing fee.

payments

InvoicePayment · object[]

required

Oldest first.

Hide child attributes

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"

payments.amount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

payments.amount.amount

integer

required

Amount in the currency's minor units.

payments.amount.currency

string

required

Uppercase ISO 4217 currency code.

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

payments.paidOn

string<date>

required

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

payments.method

enum<string>

required

How the money arrived.

Available options:

ach,

wire,

international_wire,

realtime,

ach_debit,

card,

crypto,

other

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

payments.createdAt

string<date-time>

required

When the payment was recorded.

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"

payUrl

string

required

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

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"

createdAt

string<date-time>

required

customerId

string

Customer id with the le_cus_ prefix.

Example:

"le_cus_2rj4l7hmrrrcv"

virtualAccountId

string

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

seriesId

string

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

scheduledSendDate

string<date>

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

discount

Percentage · object

Taken off the line items' subtotal before tax.

Percentage
Fixed

Hide child attributes

discount.type

enum<string>

required

Available options:

percentage

discount.percent

number

required

Percent of the subtotal. 10 means 10%.

Example:

10

taxRate

number

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

Example:

8.5

memo

string

A note printed on the invoice.

nextReminderAt

string<date-time>

When the next automatic reminder is due to go out.

paidAt

string<date-time>

When the invoice became paid.

voidedAt

string<date-time>

When the invoice was voided.

⌘I

Send a payment reminder

curl --request POST \
  --url https://api.slash.com/v2/invoices/{invoiceId}/send-reminder \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

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

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

import requests

url = "https://api.slash.com/v2/invoices/{invoiceId}/send-reminder"

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

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

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/invoices/{invoiceId}/send-reminder"

	req, _ := http.NewRequest("POST", 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))

}

{
  "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"
}

Banking

Money movement

Bill pay

Invoicing

Accounting

Platform

Send a payment reminder

Authorizations

Headers

Path Parameters

Response