Ramp: Fetch a vendor credit — response body

API reference · Contract 2026-10-27

SDK schema: Fetch a vendor credit — response body

Field	Type	Presence	Description and constraints
$	object	Root
accounting_date	string	Required within parent	Accounting date of the vendor credit Format: date
accounting_field_selections	array	Required within parent	List of accounting field selections associated with this vendor credit Read only: true
accounting_field_selections[]	Model	Each item	Expand Hold Bill — response body — accounting field selections item
applied_bills	array	Required within parent	Bills that this Vendor Credit has been applied to. A Vendor Credit can be applied to multiple Bills Read only: true
applied_bills[]	Model	Each item	Expand Fetch a vendor credit — response body — applied bills item
applied_draft_bills	array	Required within parent	Draft Bills that this Vendor Credit has been applied to. A Vendor Credit can be applied to multiple Draft Bills Read only: true
applied_draft_bills[]	Model	Each item	Expand Fetch a vendor credit — response body — applied bills item
archived_at	JSON	Required within parent
archived_at (anyOf 1)	string	Alternative	The datetime the vendor credit was archived. Null for active credits. Archived credits cannot be applied to bills, even when remaining_amount is positive. Format: date-time
archived_at (anyOf 2)	null	Alternative
created_at	JSON	Required within parent
created_at (anyOf 1)	string	Alternative	Date and time when the vendor credit was created Format: date-time
created_at (anyOf 2)	null	Alternative
entity_id	JSON	Required within parent
entity_id (anyOf 1)	string	Alternative	UUID of the business entity associated with this vendor credit Format: uuid
entity_id (anyOf 2)	null	Alternative
expense_line_items	array	Required within parent	Expense line items of the vendor credit. Expense line items contain an overall amount.
expense_line_items[]	Model	Each item	Expand Fetch a vendor credit — response body — expense line items item
id	string	Required within parent	Unique identifier for the vendor credit
inventory_line_items	array	Required within parent	Inventory line items of the vendor credit. Inventory line items are tied to a particular good or service.
inventory_line_items[]	Model	Each item	Expand Fetch a vendor credit — response body — inventory line items item
reference_bill_id	JSON	Required within parent
reference_bill_id (anyOf 1)	string	Alternative	UUID of the bill that was the origin of this vendor credit, if any Format: uuid
reference_bill_id (anyOf 2)	null	Alternative
reference_number	JSON	Required within parent
reference_number (anyOf 1)	string	Alternative	Reference number from the vendor credit memo
reference_number (anyOf 2)	null	Alternative
remaining_amount	Model	Required within parent	Expand Hold Bill — response body — amount Unapplied amount, equal to total_amount minus total_applied_amount. This amount is retained for archived credits and does not indicate eligibility to apply the credit. Credits with a non-null archived_at cannot be applied. Currently only USD is supported for Vendor Credits. Read only: true
total_amount	Model	Required within parent	Expand Hold Bill — response body — amount Total amount of the vendor credit, sum of all line items. Currently only USD is supported for Vendor Credits. Read only: true
total_applied_amount	Model	Required within parent	Expand Hold Bill — response body — amount Total amount that has been applied to bills and/or draft bills. Currently only USD is supported for Vendor Credits. Read only: true
vendor_id	string	Required within parent	UUID of the payee associated with this vendor credit Format: uuid

Referenced models: Hold Bill — response body — accounting field selections item, Hold Bill — response body — amount, Fetch a vendor credit — response body — applied bills item, Fetch a vendor credit — response body — expense line items item, Fetch a vendor credit — response body — inventory line items item