Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The UUID of the business to fetch the vendor credit for
The UUID of the vendor credit to fetch
Response
Success
Unique identifier for the vendor credit
The vendor associated with this credit
Timestamp when the vendor credit was received
List of line items for this vendor credit
Timestamp when the vendor credit was created
Timestamp when the vendor credit was last updated
List of tags associated with this vendor credit
External identifier for the vendor credit
List of allocations for this vendor credit
Timestamp when the vendor credit was deleted, if applicable
Memo for any text you would like to associate with the vendor credit (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the vendor credit. Can be used to filter when listing vendor credits.