---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Invoices"
description: "The `invoices` collection of Sylphx Billing: An Invoice is one org's bill for one billing period: per-service meter lines, the plan fee, and late usage from earlier periods."
type: reference
product: platform
summary: "An Invoice is one org's bill for one billing period: per-service meter lines, the plan fee, and late usage from earlier periods."
updated: 2026-09-28
order: 900
---

> **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`

**Not available yet.** Sylphx Billing is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/invoices/{invoice}`. |
| `uid` | `string` | `inv_<cell><ulid>`. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. Output only. |
| `number` | `string` | The human-readable invoice number, unique per org. Output only. |
| `state` | `InvoiceState` | The invoice's lifecycle state. Output only. One of `draft`, `open`, `paid`, `void`, `uncollectible`. |
| `currency_code` | `string` | ISO 4217 currency of every amount. Output only. |
| `period_start_time` | `timestamp` | The start of the billed period. Output only. |
| `period_end_time` | `timestamp` | The end of the billed period. Output only. |
| `lines` | `InvoiceLine[]` | The lines, grouped by service. Output only. |
| `subtotal` | `Money` | The sum of the rounded lines before tax. Output only. |
| `tax` | `Money` | Tax. Output only. |
| `total` | `Money` | Subtotal plus tax. Output only. |
| `amount_due` | `Money` | What is still owed. Output only. |
| `amount_paid` | `Money` | What has been paid, confirmed by provider readback. Output only. |
| `finalize_time` | `timestamp` | When the invoice was finalized. Output only. |
| `due_time` | `timestamp` | When payment is due. Output only. |
| `paid_time` | `timestamp` | When the invoice was paid in full. Output only. |
| `completeness` | `double` | The 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_notes` | `CreditNote[]` | Credit notes issued against this invoice, 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.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/invoices#get) | Gets an invoice. |
| `GET` | [`list`](/docs/api/invoices#list) | Lists 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](/docs/api/invoices/get)

## 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](/docs/api/invoices/list)