POST /v1/invoices/{id}/reminders

POST

/v1/invoices/{id}/reminders

curl --request POST \
  --url https://api.asap.cool/v1/invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/reminders \
  --header 'Authorization: Bearer <token>'

• Production

(Re)generates the reminder ladder from the document’s due_date: arms the missing occurrences (re-arming a cancelled one), leaves already-scheduled or sent ones untouched, and enqueues a delayed job per newly-armed occurrence. An empty future schedule (a long-overdue invoice) is a benign 200.

Authorizations

• api_key
  invoice:write
• session

Parameters

Path Parameters

id

required

string format: uuid

Document identifier.

Responses

200

Reminder ladder after (re)scheduling.

Media type application/json

The reminder ladder for a document.

object

reminders

required

Reminders ordered by scheduled send time.

Array<object>

Public projection of a [Reminder].

object

created_at

required

RFC3339 creation timestamp.

string

document_id

required

Document the reminder targets.

string format: uuid

id

required

Stable identifier.

string format: uuid

kind

required

Reminder kind (before_due/overdue_7/overdue_14/overdue_30).

string

scheduled_at

required

RFC3339 scheduled send time.

string

sent_at

RFC3339 actual send time; absent while pending.

string | null

Example ^generated

{
  "reminders": [
    {
      "created_at": "example",
      "document_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "kind": "example",
      "scheduled_at": "example",
      "sent_at": "example"
    }
  ]
}

401

No active org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

403

Missing invoice:write scope.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

404

Not found or cross-org.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}

422

Document is not an invoice/deposit, or has no due date.

Media type application/json

Generic error body returned by API handlers when they fail. code is a stable machine-readable token; message is human-friendly and meant for surfacing to end users.

object

code

required

Stable machine token (e.g. invalid_credentials).

string

field

Offending request field for validation errors, when known.

string | null

message

required

Human-readable message.

string

Example ^generated

{
  "code": "example",
  "field": "example",
  "message": "example"
}