Schema
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.
numberstringHuman-readable invoice number.
statusenumyesdraft | open | paid | void | uncollectible.
currencystringISO 4217 currency.
subtotalpenniesPre-tax total in pennies.
taxpenniesTax amount in pennies.
totalpenniesTotal including tax.
amount_duepenniesAmount outstanding.
amount_paidpenniesAmount collected.
amount_remainingpenniesRemaining balance.
period_startdatetimePeriod covered start.
period_enddatetimePeriod covered end.
due_datedatetimePayment due date.
paid_atdatetimeWhen paid.
created_atdatetimeyesCreated.
billing_reasonenumsubscription_create | subscription_cycle | subscription_update | manual.
hosted_invoice_urlstringPublic URL where customer views/pays.
pdf_urlstringDirect PDF download URL.

Relationships

Outbound (2)
Inbound (1)