Customer credit object
A Customer Credit represents a transaction that reduces accounts payable to a customer, typically due to returned goods. Each customer credit has one or more line items specifying debited revenue accounts, and zero or more allocations applying portions of the credit to invoices.
Attributes
Unique identifier for the customer credit.
Unique ID of the customer credit in your system for linking purposes. Idempotency key.
Time when the customer credit was sent.
Line items included in this customer credit. See Customer Credit Line Item Object for details.
Allocations of this customer credit to invoices. See Customer Credit Allocation Object for details.
Time when the customer credit was created in Layer.
Time when the customer credit was last updated in Layer.
Time when the customer credit was deleted, if applicable.
Tags associated with the customer credit.
Arbitrary metadata you can include with the customer credit
Customer Credit Line Item Object
A Customer Credit Line Item represents an individual revenue account being credited by the Customer Credit.
Unique identifier for the customer credit line item.
Ledger account associated with this line item.
Amount for the line item in cents.
Description or notes for the line item.
Customer Credit Allocation Object
A Customer Credit Allocation represents how a portion of a customer credit is applied to a specific invoice. By allocating customer credits to invoices, the amount owed to customers can be reduced accordingly.
Unique identifier for the customer credit allocation.
ID of the customer credit this allocation belongs to.
ID of the invoice this allocation is for.
Amount of the allocation in cents.