Magidoc

FinanceVendorPaymentAllocation
Object

Fields

#

_id

ID !
Non-null

externalId

The provider's identity for the settled document. Null on natively authored payments, which settle a Hive purchase-order bill and have no external origin.

externalType

vendorInvoiceId

The bill document this allocation settles — a Hive vendor bill's own _id when a payment run swept one, or the provider's document on an imported payment. A purchase-order bill is named by purchaseOrderId with vendorInvoiceLinkId instead.

vendorCreditId

purchaseOrderId

The purchase-order bill this allocation settles. Set by native vendor payments; it is what the AP subledger and cash-basis settlement follow back to the bill.

vendorInvoiceLinkId

The _id of the bill link on that order — which of the order's bills this allocation settled. Set by native vendor payments; null on imported ones, which name the provider's document in vendorInvoiceId instead.

expenseReportId

The expense report this allocation reimburses. Set by reimbursement payments, whose payee is an employee rather than a vendor; it is what the AP subledger and cash-basis settlement follow back to the report.

amount

Non-null

documentNumber

The number of whichever document this allocation settles, joined for the reader. One field over four references because a register row states one fact — what this payment was applied to — and which of the four ids carries it is the payment rail's business rather than the reader's. Null where the document cannot be resolved (an imported allocation naming a provider's document, another workspace's id, a deleted one), so the surface renders the reference as unresolved instead of printing a stored id at a bookkeeper.

Usages

#

References

#