Vendor Payout object
A Vendor Payout represents a transfer of funds from a Business to vendors through a payment processor or platform.
Vendor payouts typically include the total amount of bill payments made to vendors, minus any vendor refunds received, and are the AP equivalent of Customer Payouts.
Attributes
Unique identifier for the vendor payout.
Unique ID of the vendor payout in your system for linking purposes and idempotency.
ID of the Business that made the vendor payout.
The amount of the vendor payout, in cents. This amount can be negative if vendor refunds exceed bill payments.
Processor used to make the payment. Any processor name can be provided and will be tracked. If not null, every bill payment or vendor refund payment associated with the vendor payout must have the same processor.
Timestamp of when the vendor payout was imported into Layer.
Timestamp of when the vendor payout was completed.
The transaction match associated with the vendor payout, if any.
A list of Bill Payments associated with the vendor payout. Note: Unlike customer payouts, you must reference existing bill payments - new bill payments cannot be created as part of vendor payout creation.
List of Vendor Refund Payments associated with this vendor payout. Note: You must reference existing vendor refund payments, not vendor refunds themselves.
A list of other transactions associated with the vendor payout for adjustments or fees.
List of suggested bank transaction matches for the vendor payout.
Tags associated with the vendor payout.
Memo for any text you would like to associate with the vendor payout (for example, to display to end users).
Arbitrary metadata you can include with the vendor payout