FinanceVendorPayment Object
Fields
#
glCompanyId
The company of the vouchers this payment settles, and the series its documentNumber was drawn under. Equal to the voucher company for every payment Hive authors, which is what the write boundary enforces; the QuickBooks import writes payments straight to the collection past that boundary, so imported rows are unstamped whatever their vouchers carry. Null there, on payments predating company scope, and in workspaces that provisioned no companies.
vendorAccountId
employeeUserId
The employee this payment reimburses, when the payee is a person rather than a vendor. Exactly one of vendorAccountId and employeeUserId is set on a payment Hive writes — an employee is never given a vendor account, which would put a person on the vendor tax and 1099 rails.
vendorAccountName
The payee's name, joined from the CRM account vendorAccountId points at. Null on a reimbursement, and null when this workspace cannot resolve the account — the register then says the reference is unresolved rather than printing the stored id in a Payee column.
employeeName
The payee's name, joined from the user employeeUserId points at. Null on a vendor payment, and null when this workspace cannot resolve the user, for the reason the vendor arm gives.
paymentAccountId
paymentAccountName
The GL account the money left, named. The register states which books a disbursement came out of, and a stored id in that column is a fact no reader can check.
documentNumber
payType
printStatus
privateNote
linkedTransactions
currencyConversion
reference
Free-text payment reference — check number, ACH trace. Distinct from documentNumber, which is the reserved BP- series number.
journalId
postingBatchId
postedAt
postedBy
voidVendorPaymentId
On a payment that has been voided: the offsetting document that voided it. Its presence is what a surface reads to stop offering the void again.
voidedAt
voidedBy
voidReason
voidsVendorPaymentId
On an offsetting document: the payment it voids. A negative amount alone would also describe a refund from a vendor, so this is what identifies the document as a void.
Usages
#
References
#
- Field getVendorPayments from Query
- Field createVendorPayment from Mutation
- Field voidVendorPayment from Mutation