v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
accounting
vendorcredit

Retrieve a vendorcredit

get/accounting/{connection_id}/vendorcredit/{id}

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Vendorcredit

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
due_atstring date-time
posted_atstring date-time
total_amountnumber
balance_amountnumber
account_idstring
currencystring
contact_idstring
bill_idstring
notesstring
status'DRAFT' | 'VOIDED' | 'AUTHORIZED' | 'PAID' | 'PARTIALLY_PAID' | 'PARTIALLY_REFUNDED' | 'REFUNDED' | 'SUBMITTED' | 'DELETED' | 'OVERDUE'
organization_idstring
apply_amountnumber
rawobject