Skip to content
Bottle

Check payment reminders before sending

POST
/invoices/reminders/preview
curl --request POST \
  --url https://example.com/invoices/reminders/preview \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "invoiceIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ] }'

For the invoices picked: who each reminder would go to, which cannot go and why, and the wording it would use. Nothing is sent.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
invoiceIds
required
Array<string>
>= 1 items <= 500 items

Responses

Section titled “Responses”

200

Section titled “200”

The reminders as they would go

Media typeapplication/json
object
items
required
Array<object>
object
invoiceId
required

UUID v7

string format: uuid
number
required
string
customerId
required

UUID v7

string | null format: uuid
customerName
required
string | null
owedPence
required
integer
dueOn
required
string format: date
daysOverdue
required
integer
remindersSent
required
integer
lastRemindedAt
required
string | null format: date-time
emails
required
Array<string>
skip
required
string | null
Allowed values: not_found paid void no_email just_reminded
subject
required
string
message
required
string
custom
required
boolean

Example 

{
  "items": [
    {
      "invoiceId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "skip": "not_found"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}