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

Update VendorCredit record

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

put/public/v2/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

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 6 of the 15 revisions of this API.4439

Aug 28, 202648edcb3acb7445See the full diff
- ●
  removed the optional property expenses_count from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property expenses_has_more from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items_count from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items_has_more from the response with the 200 status
  response-optional-property-removed
- ○
  api operation id update_VendorCreditV2_record removed and replaced with update_VendorCredit_record
  api-operation-id-removed
- ○
  the response property expenses became required for the status 200
  response-property-became-required
- ○
  the response property items became required for the status 200
  response-property-became-required
- ○
  the expenses response's property default value was removed for the status 200
  response-property-default-value-removed
- ○
  the items response's property default value was removed for the status 200
  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 expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ▲
  the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response's property type/format changed from string/ to / for status 200
  response-property-type-changed
- ○
  added GstComponentType TaxFamily to the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added GstComponentType TaxFamily to the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  removed the CESS enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the CESS enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the CGST enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the CGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the GST enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the GST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the HST enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the HST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the IGST enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the IGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the PST enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the PST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the QST enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the QST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the SGST enum value from the expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the SGST enum value from the items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_components/items/component_type response property for the response status 200
  response-property-enum-value-removed
Aug 12, 202634b7cf5b4b6c1See the full diff
- ○
  added the new optional header request parameter Idempotency-Key
  new-optional-request-parameter
Aug 12, 20261690a2e6f8e94See the full diff
- ○
  added the new optional request property expenses/items/company_id
  new-optional-request-property
- ○
  added the new optional request property items/items/company_id
  new-optional-request-property
- ○
  added the optional property expenses/items/company_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/company_id to the response with the 200 status
  response-optional-property-added
Aug 5, 2026525a590a98f84See the full diff
- ○
  added the new optional request property expenses/items/tax/anyOf[subschema #1: ItemTaxData]/tax_metadata
  new-optional-request-property
- ○
  added the new optional request property items/items/tax/anyOf[subschema #1: ItemTaxData]/tax_metadata
  new-optional-request-property
- ○
  added the optional property expenses/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_metadata to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/tax/anyOf[subschema #1: ItemTaxDataOut]/tax_metadata to the response with the 200 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 expenses became optional for the status 200
  response-property-became-optional
- ▲
  the response property items became optional for the status 200
  response-property-became-optional
- ○
  api operation id update_VendorCredit_record removed and replaced with update_VendorCreditV2_record
  api-operation-id-removed
- ○
  added the optional property expenses_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property expenses_has_more to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items_count to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items_has_more to the response with the 200 status
  response-optional-property-added
- ○
  the expenses response's property default value was added for the status 200
  response-property-default-value-added
- ○
  the items response's property default value was added for the status 200
  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