Payment
Money that moved against invoices: a customer paying us (receivable), us paying a vendor (payable), or a refund of either.
| Pack | Billing |
| Version | v1 (latest) |
| URN | urn:postware:billing:payment |
| Identity | identifiers |
| Status categories | pending, succeeded, failed, cancelled |
Fields
| Field | Type | Req | Notes |
|---|---|---|---|
direction | enum(receivable| | yes | default receivable |
kind | enum(payment| | yes | default payment |
counterparty | Ref<Organization | | yes | |
amount | Money | yes | |
paid_at | datetime | yes | |
method | enum(card| | no | |
status | Status(pending| | yes | default map[category:succeeded] |
applied | object[] | no | {invoice: Ref<Invoice>, amount: Money} |
refund_of | Ref<Payment> | no | |
reference | string | no | check number, bank reference, processor id or remittance text |
Events
payment.succeeded when status.category becomes succeeded; payment.failed when status.category becomes failed.