GET /v1/invoices/reminders/tracking

GET

/v1/invoices/reminders/tracking

curl --request GET \
  --url https://api.asap.cool/v1/invoices/reminders/tracking \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key
  invoice:read
• session

Responses

200

Unsettled issued documents with their reminder-ladder state.

Media type application/json

Response body of GET /v1/invoices/reminders/tracking.

object

items

required

Tracked documents, most-urgent first (exhausted ladders, then most overdue, then soonest next reminder). At most 20.

Array<object>

One row of the reminder-tracking card: an unsettled, issued billing document with its ladder state.

object

balance_cents

required

Remaining balance (centimes), always strictly positive here.

integer format: int64

contact_name

Displayable contact name, None when the contact has vanished.

string | null

days_overdue

required

Days past the due date, floored at 0.

integer format: int32

document_id

required

Tracked document identifier.

string format: uuid

due_date

Due date (YYYY-MM-DD), None when unset.

string | null

exhausted

required

true when the ladder is fully sent yet the document is still unpaid.

boolean

next_at

RFC3339 send time of the next pending reminder, None when exhausted.

string | null

number

Sequential number, None for an un-numbered document.

string | null

pending_count

required

Reminders still pending.

integer format: int64

sent_count

required

Reminders already sent.

integer format: int64

total_ttc_cents

required

Document total including VAT (centimes).

integer format: int64

Example ^generated

{
  "items": [
    {
      "balance_cents": 1,
      "contact_name": "example",
      "days_overdue": 1,
      "document_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "due_date": "example",
      "exhausted": true,
      "next_at": "example",
      "number": "example",
      "pending_count": 1,
      "sent_count": 1,
      "total_ttc_cents": 1
    }
  ]
}

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:read 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"
}