Accounts3

Approval Policies8

Bank Connections7

Bank Match8

Bank Transfers4

Bills6

Budgets2

Cash Sales5

Classifications6

Classifications Lines1

Companies2

Contracts11

Custom Fields5

Customer Credits5

Customer Deposits5

Customer Payments5

Customer Prepayment Applications6

Customer Prepayments6

Customer Refunds5

Customers6

Data Exports3

Depreciation Books2

Direct Expenses5

Exchange Rates1

Fixed Assets7

GST Tax Rates2

Health1

Inbox5

Intercompany Journal Entries4

Invoices7

Items6

Journal Entries5

OAuth3

Paper Checks6

Product Tax Codes5

Purchase Orders5

Recurring Bills5

Recurring Invoices5

Recurring Journal Entries5

Sales Orders5

Statistical Journals5

VAT Rates2

Vendor Credits4

Vendor Payments4

Vendor Prepayment Applications4

Vendor Prepayments4

Vendor Refunds5

Vendors6

Webhooks8

Vendor Credits

Get VendorCredit record

Retrieve a specific VendorCredit record by its record number with all related data.

get/public/v2/vendor-credits/{record_number}/

Path parameters

record_numberinteger required

The number attribute of the record.

Query parameters

searchstring nullable

company_idinteger[] nullable

numberinteger[] nullable

vendor_idinteger[] nullable

start_datestring date nullable

end_datestring date nullable

transaction_currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'

record_statusRecordStatus[] nullable

bill_numberinteger[] nullable

updated_afterstring date-time nullable

updated_beforestring date-time nullable

Response

supply_datestring date nullable required

place_of_supplystring nullable

transaction_idsinteger[] required

internal_idinteger required

numberinteger required

bill_numberinteger nullable

direct_expense_numberinteger nullable

datestring date required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_datestring date required

Transaction date (inception date) - the date when the transaction actually occurred

company_idinteger required

company_namestring required

company_currencystring required

vendor_idinteger required

vendor_namestring required

currency_iso_4217_codestring nullable required

exchange_ratestring required

memostring required

amountstring required

Total transaction amount

used_amountstring required

Amount that was already applied to Bills through Vendor Refunds or Vendor Prepayment Applications

remaining_amountstring required

Amount that can be applied to Bills through Vendor Refunds or Vendor Prepayment Applications

record_status'draft' | 'posted' | 'archived' required

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

Changes

Changed in 5 of the 15 revisions of this API.4434

Aug 28, 202648edcb3acb7445See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  api operation id get_VendorCreditV2_record removed and replaced with get_VendorCredit_record
  api-operation-id-removed
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response's property default value was removed for the status
  response-property-default-value-removed
- ○
  the response's property default value was removed for the status
  response-property-default-value-removed
This revision also has 93 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 22, 2026dcb8297898a2218See the full diff
- ▲
  the ////// response's property type changed from string to no type for status
  response-property-type-changed
- ▲
  the ////// response's property type changed from string to no type for status
  response-property-type-changed
- ○
  added to the ////// response property anyOf list for the response status
  response-property-any-of-added
- ○
  added to the ////// response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed the CESS enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the CESS enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the CGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the CGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the GST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the GST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the HST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the HST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the IGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the IGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the PST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the PST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the QST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the QST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the SGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
- ○
  removed the SGST enum value from the ////// response property for the response status
  response-property-enum-value-removed
Aug 12, 20261690a2e6f8e92See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Aug 5, 2026525a590a98f82See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 202664136e8e19bb27See the full diff
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ○
  api operation id get_VendorCredit_record removed and replaced with get_VendorCreditV2_record
  api-operation-id-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  the response's property default value was added for the status
  response-property-default-value-added
- ○
  the response's property default value was added for the status
  response-property-default-value-added
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history