Accounts3

Approval Policies8

Bank Transfers4

Bills6

Budgets2

Cash Sales5

Classifications6

Classifications Lines1

Companies2

Contracts5

Custom Fields5

Customer Credits5

Customer Deposits5

Customer Payments5

Customer Prepayment Applications6

Customer Prepayments6

Customer Refunds5

Customers6

Data Exports3

Direct Expenses5

Exchange Rates1

Fixed Assets6

Health1

Inbox5

Invoices7

Items6

Journal Entries5

Paper Checks6

Purchase Orders5

Recurring Bills5

Recurring Invoices5

Recurring Journal Entries5

Sales Orders5

Statistical Journals5

Vendor Credits4

Vendor Payments4

Vendor Prepayment Applications4

Vendor Prepayments4

Vendor Refunds5

Vendors6

Webhooks8

Vendor Credits

Update VendorCredit record

Update an existing VendorCredit record with the provided data. Validates all required fields and business rules.

put/public/v1/vendor-credits/{record_number}/

Path parameters

record_numberinteger required

The number attribute of the record.

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

supply_datestring date nullable

place_of_supplystring nullable

custom_fieldsobject[] nullable

datestring date required

transaction_datestring date nullable

bill_numberinteger nullable

direct_expense_numberinteger nullable

vendor_idinteger required

company_idinteger required

currency_iso_4217_code'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' required

memostring

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

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 16 revisions of this API.230

Sep 3, 2026b922fa27f8b53See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
Aug 22, 2026db5c5da9869c218See 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, 2026af0ec77e52771See the full diff
- ○
  added the new optional header request parameter Idempotency-Key
  new-optional-request-parameter
Aug 12, 20261f38ce6f7ff24See the full diff
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  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, 202677cd3c6ec7194See the full diff
- ○
  added the new optional request property ////
  new-optional-request-property
- ○
  added the new optional request property ////
  new-optional-request-property
- ○
  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

Full history