Skip to main content

Public REST/JSON reference

Invoice Delay API

Sync your AR invoices, predict per-invoice pay-date and delay-risk score, see which clients pay slowly (and how consistently), surface the highest-risk open invoices, and project cash-flow inflow N days ahead. Send graduated reminders (HIGH then CRITICAL) automatically as risk crosses your thresholds. Part of the Logic Igniter Finance & Revenue Intelligence bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Operations rendered

10

Response models rendered

18

GET/api/v1/invoicedelay/health

Service liveness

Liveness probe — returns 200 if the service is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/invoicedelay/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

POST/api/v1/invoicedelay/invoices/sync

Sync invoices from your AR system

Pull the latest invoices from the connected accounting/AR integration. Each is scored for delay risk on ingest; subsequent calls re-score open invoices.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/invoicedelay/invoices/sync" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Sync result

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers daily sync + read-only invoice listing; paid plans unlock predictions, reminders, and cash-flow projection.

AR integration not configured

GET/api/v1/invoicedelay/invoices

List invoices

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/invoicedelay/invoices" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of invoices

Missing or invalid API key.

GET/api/v1/invoicedelay/invoices/{id}/prediction

Predicted pay date + risk for one invoice

Returns the predicted_pay_date, delay risk_score (0–100), and confidence in the prediction. The prediction is a function of the client's historical payment behavior + invoice attributes (amount, terms, due_date).

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/invoicedelay/invoices/:id/prediction" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Delay prediction

Missing or invalid API key.

Invoice not found

GET/api/v1/invoicedelay/reminders

List sent reminders

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/invoicedelay/reminders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of reminders

Missing or invalid API key.

POST/api/v1/invoicedelay/reminders

Send a reminder for an invoice

Send a graduated reminder. The reminder type (HIGH or CRITICAL) is selected automatically based on the invoice's days-overdue and risk_score.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: SendReminderRequest

Sample JSON payload for evaluation.

{
  "invoice_id": "11111111-1111-1111-1111-111111111111"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/invoicedelay/reminders" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"invoice_id":"11111111-1111-1111-1111-111111111111"}'

Responses

Reminder sent

Missing invoice_id

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers daily sync + read-only invoice listing; paid plans unlock predictions, reminders, and cash-flow projection.

Invoice not found

PUT/api/v1/invoicedelay/reminders/config

Configure reminder lead-time

Set how many days before due_date the system sends the first reminder. Default: 7 days.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: ConfigureRequest

Sample JSON payload for evaluation.

{
  "lead_days": 7
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/invoicedelay/reminders/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"lead_days":7}'

Responses

Updated config

Invalid lead_days

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers daily sync + read-only invoice listing; paid plans unlock predictions, reminders, and cash-flow projection.

GET/api/v1/invoicedelay/risk

Client risk profile

Returns avg_days_to_pay and a payment_consistency_score for one client across their full payment history.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
client_idrequiredquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/invoicedelay/risk" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Client risk profile

Missing client_id

Missing or invalid API key.

Client not found

GET/api/v1/invoicedelay/risk/high

List high-risk open invoices

Workspace-wide list of open invoices ranked by risk_score descending. Pull this list to drive the next batch of reminders.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/invoicedelay/risk/high" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

High-risk invoices

Missing or invalid API key.

GET/api/v1/invoicedelay/cashflow/projection

Cash-flow projection

Projects daily inflow N days ahead, using each open invoice's predicted_pay_date weighted by confidence. Returns one entry per day with both projected_inflow_cents (risk-weighted) and invoices_due_cents (face value).

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
days_aheadqueryinteger

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/invoicedelay/cashflow/projection" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Projection entries

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers daily sync + read-only invoice listing; paid plans unlock predictions, reminders, and cash-flow projection.

Data models

Error

FieldTypeNotes
errorrequiredstring

InvoiceStatus

ReminderType

SyncResult

FieldTypeNotes
idstring (uuid)
invoices_syncedinteger
synced_atstring (date-time)

Invoice

FieldTypeNotes
idstring (uuid)
external_idstring
client_idstring
amount_centsinteger (int64)
issued_datestring (date-time)
due_datestring (date-time)
paid_datestring (date-time)
statusInvoiceStatus
risk_scorenumber (double)

InvoicesResponse

FieldTypeNotes
itemsarray<Invoice>
next_page_tokenstring
total_countinteger

DelayPrediction

FieldTypeNotes
idstring (uuid)
invoice_idstring (uuid)
predicted_pay_datestring (date-time)
risk_scorenumber (double)
confidencenumber (double)

SendReminderRequest

FieldTypeNotes
invoice_idrequiredstring (uuid)

ReminderResult

FieldTypeNotes
idstring (uuid)
successboolean
sent_atstring (date-time)

ConfigureRequest

FieldTypeNotes
lead_daysrequiredinteger

ReminderConfig

FieldTypeNotes
idstring (uuid)
lead_daysinteger

Reminder

FieldTypeNotes
idstring (uuid)
invoice_idstring (uuid)
reminder_typeReminderType
sent_atstring (date-time)

RemindersResponse

FieldTypeNotes
itemsarray<Reminder>
next_page_tokenstring
total_countinteger

ClientRisk

FieldTypeNotes
idstring (uuid)
client_idstring
namestring
avg_days_to_paynumber (double)
payment_consistency_scorenumber (double)

HighRiskInvoice

FieldTypeNotes
idstring (uuid)
client_idstring
amount_centsinteger (int64)
due_datestring (date-time)
risk_scorenumber (double)

HighRiskResponse

FieldTypeNotes
itemsarray<HighRiskInvoice>
next_page_tokenstring
total_countinteger

ProjectionEntry

FieldTypeNotes
datestring (date-time)
projected_inflow_centsinteger (int64)
invoices_due_centsinteger (int64)

CashFlowProjection

FieldTypeNotes
idstring (uuid)
entriesarray<ProjectionEntry>