Update vendor refund
Fully replaces an existing vendor refund. All allocations and payments will be replaced with the new values provided. This will reverse any existing ledger entries and create new ones based on the updated refund data.
Documentation Index
Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json.
Path Parameters
The UUID of the business to update the vendor refund for.
The UUID of the vendor refund to update.
Body
Itemized vendor refund creation parameters. Provides full control over refund allocations and payments. The sum of allocation amounts must equal the refunded_amount.
The total amount of the vendor refund in cents. This value must be positive and equal to the sum of all allocation amounts.
The time the vendor refund was completed.
The targets of the vendor refund. Each allocation specifies how much of the refund should be applied to a specific bill, line item, payment, or vendor.
The payment methods and amounts used to process the vendor refund.
An external identifier for the vendor refund transaction.
Tags to associate with the vendor refund.
Memo for any text you would like to associate with the vendor refund (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB.
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the vendor refund. Can be used to filter when listing vendor refunds.
Response
Vendor refund updated successfully.
A vendor refund represents a transaction where a vendor returns value to a business. A specific bill can be refunded or a general refund can be applied to a vendor.
Unique identifier for the vendor refund.
Unique ID of the vendor refund in your system for linking purposes. Idempotency key.
"vendor-refund-123"
Amount refunded to the business in cents.
Status of the vendor refund.
"PAID"
Time when the vendor refund was completed.
Allocations associated with this vendor refund.
Payments associated with this vendor refund.
Memo for any text you would like to associate with the vendor refund (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 1KB.
{
"custom_field": "value",
"any valid json": "below 1kb",
"nested": { "meaning of life": 42, "array": [] }
}Any (typically user-visible) identifier you would like to associate with the vendor refund. Can be used to filter when listing vendor refunds.