PayOSOrg Structure
Invoice
Billing invoice issued to an organisation. Amounts in pennies. Includes hosted invoice and PDF URLs for customer access.
19 fields3 relationships
Fields
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | Provider invoice ID. |
| org_id | uuid | yes | Owning organisation. |
| number | string | — | Human-readable invoice number. |
| status | enum | yes | draft | open | paid | void | uncollectible. |
| currency | string | — | ISO 4217 currency. |
| subtotal | pennies | — | Pre-tax total in pennies. |
| tax | pennies | — | Tax amount in pennies. |
| total | pennies | — | Total including tax. |
| amount_due | pennies | — | Amount outstanding. |
| amount_paid | pennies | — | Amount collected. |
| amount_remaining | pennies | — | Remaining balance. |
| period_start | datetime | — | Period covered start. |
| period_end | datetime | — | Period covered end. |
| due_date | datetime | — | Payment due date. |
| paid_at | datetime | — | When paid. |
| created_at | datetime | yes | Created. |
| billing_reason | enum | — | subscription_create | subscription_cycle | subscription_update | manual. |
| hosted_invoice_url | string | — | Public URL where customer views/pays. |
| pdf_url | string | — | Direct PDF download URL. |
Relationships
Outbound (2)
- Invoice[:HAS_LINE_ITEM]→InvoiceLineItem
- Invoice[:HAS_CREDIT_NOTE]→CreditNote
Inbound (1)
- Subscription[:HAS_INVOICE]→Invoice