Skip to main content

Public REST/JSON reference

Revenue Recognition API

ASC 606 / IFRS 15 revenue recognition built on top of your Stripe subscription data. Sync contracts, walk recognition schedules period-by-period, pull recognized vs deferred revenue at any point in the close, and surface judgment-call flags (multi-element arrangements, mid-term modifications, large refunds, variable consideration) to your auditor — each with a full audit trail. 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

11

Response models rendered

15

GET/api/v1/revrec/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/revrec/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/revrec/customers

List customers

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/revrec/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of customers

Missing or invalid API key.

POST/api/v1/revrec/customers

Provision a customer

Idempotent customer provision.

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: CreateCustomerRequest

Sample JSON payload for evaluation.

{
  "email": "[email protected]",
  "name": "Example Inc."
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/revrec/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","name":"Example Inc."}'

Responses

Customer created or returned

Invalid email or missing name

Missing or invalid API key.

GET/api/v1/revrec/customers/{id}

Get a customer by id

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/revrec/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Customer record

Missing or invalid API key.

Customer not found

PUT/api/v1/revrec/customers/{id}

Update a customer

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 body (required)

Schema: UpdateCustomerRequest

Request example

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

curl -X PUT "https://api.logicigniter.com/api/v1/revrec/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

Updated customer

Invalid update

Missing or invalid API key.

Customer not found

POST/api/v1/revrec/contracts/sync

Sync contracts from Stripe

Pull the latest subscription/contract data from the connected Stripe account and reconcile against the workspace's contract table. Returns the count of contracts synced. Run on a schedule (daily) or on-demand from your close runbook.

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/revrec/contracts/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 contract listing for up to 10 contracts; paid plans unlock unlimited contracts, automatic recognition, audit trails, and flag review.

Stripe credentials missing or invalid

GET/api/v1/revrec/contracts

List contracts

Return the workspace's synced contracts, paginated. Each contract has its Stripe subscription id, customer link, total contract value (cents), status, and start/end dates.

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/revrec/contracts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of contracts

Missing or invalid API key.

GET/api/v1/revrec/contracts/{contract_id}

Get a contract with performance obligations

Return one contract along with its performance obligations — the discrete promises identified during ASC 606 step 2, each with its standalone selling price and the recognition method (over-time / point-in-time).

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
contract_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/revrec/contracts/:contract_id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Contract detail

Missing or invalid API key.

Contract not found

GET/api/v1/revrec/contracts/{contract_id}/schedule

Get the revenue schedule for a contract

Walk the contract month-by-month with recognized and deferred revenue (in cents) per period. The standard view your audit team will want when ticking and tying to GL.

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
contract_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/revrec/contracts/:contract_id/schedule" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Revenue schedule

Missing or invalid API key.

Contract not found

GET/api/v1/revrec/revenue/recognized

Recognized revenue for a period

Sum recognized revenue across all contracts for a single close period. Period is an ISO month (e.g. `2026-04`) or quarter (`2026-Q2`).

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
periodrequiredquerystring

Request example

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

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

Responses

Recognized revenue

Missing or malformed period parameter

Missing or invalid API key.

GET/api/v1/revrec/revenue/deferred

Deferred revenue at this moment

Total deferred revenue across all contracts as of now. Useful as a balance-sheet figure — also useful for a quick sanity check that recognized + deferred ≈ contract 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.

Request example

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

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

Responses

Deferred revenue

Missing or invalid API key.

Data models

Error

FieldTypeNotes
errorrequiredstring

ContractStatus

SyncResult

FieldTypeNotes
idstring (uuid)
contracts_syncedinteger

Contract

FieldTypeNotes
idstring (uuid)
stripe_subscription_idstringExample: "sub_1NX..."
customer_idstring (uuid)
total_value_centsinteger (int64)
statusContractStatus
start_datestring (date-time)
end_datestring (date-time)

ContractsResponse

FieldTypeNotes
itemsarray<Contract>
next_page_tokenstring
total_countinteger

PerformanceObligation

FieldTypeNotes
idstring (uuid)
descriptionstring
standalone_price_centsinteger (int64)
recognition_methodstring

ContractDetail

FieldTypeNotes
idstring (uuid)
customer_idstring (uuid)
total_value_centsinteger (int64)
statusContractStatus
obligationsarray<PerformanceObligation>
start_datestring (date-time)
end_datestring (date-time)

ScheduleEntry

FieldTypeNotes
periodstring
recognized_centsinteger (int64)
deferred_centsinteger (int64)

RevenueSchedule

FieldTypeNotes
idstring (uuid)
contract_idstring (uuid)
entriesarray<ScheduleEntry>

RecognizedRevenue

FieldTypeNotes
idstring (uuid)
periodstring
total_recognized_centsinteger (int64)

DeferredRevenue

FieldTypeNotes
idstring (uuid)
total_deferred_centsinteger (int64)

CreateCustomerRequest

FieldTypeNotes
emailrequiredstring (email)
namerequiredstring

UpdateCustomerRequest

FieldTypeNotes
emailstring (email)
namestring

Customer

FieldTypeNotes
idstring (uuid)
emailstring (email)
namestring
created_atstring (date-time)

CustomersResponse

FieldTypeNotes
itemsarray<Customer>
next_page_tokenstring
total_countinteger