Skip to content
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

NameTypeReqDescription
idstringyesProvider invoice ID.
org_iduuidyesOwning organisation.
numberstringnoHuman-readable invoice number.
statusenumyesdraft | open | paid | void | uncollectible.
currencystringnoISO 4217 currency.
subtotalpenniesnoPre-tax total in pennies.
taxpenniesnoTax amount in pennies.
totalpenniesnoTotal including tax.
amount_duepenniesnoAmount outstanding.
amount_paidpenniesnoAmount collected.
amount_remainingpenniesnoRemaining balance.
period_startdatetimenoPeriod covered start.
period_enddatetimenoPeriod covered end.
due_datedatetimenoPayment due date.
paid_atdatetimenoWhen paid.
created_atdatetimeyesCreated.
billing_reasonenumnosubscription_create | subscription_cycle | subscription_update | manual.
hosted_invoice_urlstringnoPublic URL where customer views/pays.
pdf_urlstringnoDirect PDF download URL.

Relationships

Outbound (2)
Inbound (1)