Skip to content
Console
On this page

Invoices

An Invoice is one org's bill for one billing period: per-service meter lines, the plan fee, and late usage from earlier periods.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

An Invoice is one org's bill for one billing period: per-service meter lines, the plan fee, and late usage from earlier periods. Finalization freezes it; a correction is a credit note, never an edit.

Service Sylphx Billing · Resource type billing.sylphx.com/Invoice · Name pattern orgs/{org}/invoices/{invoice} · Shape record

Fields

FieldTypeWhat it is
namestringorgs/{org}/invoices/{invoice}.
uidstringinv_<cell><ulid>. Output only.
metaResourceMetaResource metadata. Output only.
numberstringThe human-readable invoice number, unique per org. Output only.
stateInvoiceStateThe invoice's lifecycle state. Output only. One of draft, open, paid, void, uncollectible, credited.
currency_codestringISO 4217 currency of every amount. Output only.
period_start_timetimestampThe start of the billed period. Output only.
period_end_timetimestampThe end of the billed period. Output only.
linesInvoiceLine[]The lines, grouped by service. Output only.
subtotalMoneyThe sum of the rounded lines before tax. Output only.
taxMoneyTax. Output only.
totalMoneySubtotal plus tax. Output only.
amount_dueMoneyWhat is still owed. Output only.
amount_paidMoneyWhat has been paid, confirmed by provider readback or authorized settlement. Output only.
finalize_timetimestampWhen the invoice was finalized. Output only.
due_timetimestampWhen payment is due. Output only.
paid_timetimestampWhen the invoice was paid in full. Output only.
completenessdoubleThe share of the period's usage that had reached Billing when the invoice was finalized, from 0 to 1; below 1 the invoice carries a note. Output only.
credit_notesCreditNote[]Credit notes issued against this invoice, oldest first. Output only.
settlementsInvoiceSettlement[]Immutable authorized external payment records, oldest first. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets an invoice.
POSTrecord_paymentA seller operator records an externally verified full invoice payment. The platform-only scope cannot be granted by customer owners/admins. The invoice name identifies the customer, not the seller. References are immutable and idempotent per org and method; conflicting reuse is refused.
GETlistLists an org's invoices.

get

Gets an invoice.

GET https://api.sylphx.com/v1/orgs/acme/invoices/invoice · scope billing:read · effect read · not available yet · Request, response and examples

record_payment

A seller operator records an externally verified full invoice payment. The platform-only scope cannot be granted by customer owners/admins. The invoice name identifies the customer, not the seller. References are immutable and idempotent per org and method; conflicting reuse is refused.

POST https://api.sylphx.com/v1/orgs/acme/invoices/invoice:recordPayment · scope billing:payments:record · effect write · not available yet · Request, response and examples

list

Lists an org's invoices.

GET https://api.sylphx.com/v1/orgs/acme/invoices · scope billing:read · effect read · not available yet · paginated · Request, response and examples