Vendor Credits
A
VendorCredit is transaction issued by a vendor to the accounting company, indicating a reduction or cancellation of the amount owed to the vendor. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a purchasing transaction. A VendorCredit can be applied to Accounts Payable Invoices to decrease the overall amount of the Invoice.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
numberStringOptional
The vendor credit's number.
transaction_dateDateTime (ISO 8601)Optional
The vendor credit's transaction date.
vendorUUIDOptional
The vendor that owes the gift or refund.
total_amountNumberOptional
The vendor credit's total amount.
currencyEnumOptional
The vendor credit's currency. Possible values include:
XUA, AFN, AFA, ALL, ALK, DZD, ADP, AOA, AOK, AON, AOR, ARA, ARS, ARM, ARP, ARL, AMD, AWG, AUD, ATS, AZN, AZM, BSD, BHD, BDT, BBD, BYN, BYB, BYR, BEF, BEC, BEL, BZD, BMD, BTN, BOB, BOL, BOV, BOP, BAM, BAD, BAN, BWP, BRC, BRZ, BRE, BRR, BRN, BRB, BRL, GBP, BND, BGL, BGN, BGO, BGM, BUK, BIF, XPF, KHR, CAD, CVE, KYD, XAF, CLE, CLP, CLF, CNX, CNY, CNH, COP, COU, KMF, CDF, CRC, HRD, HRK, CUC, CUP, CYP, CZK, CSK, DKK, DJF, DOP, NLG, XCD, DDM, ECS, ECV, EGP, GQE, ERN, EEK, ETB, EUR, XBA, XEU, XBB, XBC, XBD, FKP, FJD, FIM, FRF, XFO, XFU, GMD, GEK, GEL, DEM, GHS, GHC, GIP, XAU, GRD, GTQ, GWP, GNF, GNS, GYD, HTG, HNL, HKD, HUF, IMP, ISK, ISJ, INR, IDR, IRR, IQD, IEP, ILS, ILP, ILR, ITL, JMD, JPY, JOD, KZT, KES, KWD, KGS, LAK, LVL, LVR, LBP, LSL, LRD, LYD, LTL, LTT, LUL, LUC, LUF, MOP, MKD, MKN, MGA, MGF, MWK, MYR, MVR, MVP, MLF, MTL, MTP, MRU, MRO, MUR, MXV, MXN, MXP, MDC, MDL, MCF, MNT, MAD, MAF, MZE, MZN, MZM, MMK, NAD, NPR, ANG, TWD, NZD, NIO, NIC, NGN, KPW, NOK, OMR, PKR, XPD, PAB, PGK, PYG, PEI, PEN, PES, PHP, XPT, PLN, PLZ, PTE, GWE, QAR, XRE, RHD, RON, ROL, RUB, RUR, RWF, SVC, WST, SAR, RSD, CSD, SCR, SLL, XAG, SGD, SKK, SIT, SBD, SOS, ZAR, ZAL, KRH, KRW, KRO, SSP, SUR, ESP, ESA, ESB, XDR, LKR, SHP, XSU, SDD, SDG, SDP, SRD, SRG, SZL, SEK, CHF, SYP, STN, STD, TVD, TJR, TJS, TZS, XTS, THB, XXX, TPE, TOP, TTD, TND, TRY, TRL, TMT, TMM, USD, USN, USS, UGX, UGS, UAH, UAK, AED, UYW, UYU, UYP, UYI, UZS, VUV, VES, VEB, VEF, VND, VNN, CHE, CHW, XOF, YDD, YER, YUN, YUD, YUM, YUR, ZWN, ZRN, ZRZ, ZMW, ZMK, ZWD, ZWR, ZWL. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.exchange_rateStringOptional
The vendor credit's exchange rate.
inclusive_of_taxBooleanOptional
If the transaction is inclusive or exclusive of tax.
True if inclusive, False if exclusive.companyUUIDOptional
The company the vendor credit belongs to.
linesVendorCreditLine[]Required
The VendorCreditLine object
The
VendorCreditLine object is used to represent a vendor credit's line items.Properties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
net_amountNumberOptional
The full value of the credit.
tracking_categoriesArrayRequired
The vendor credit line item's associated tracking categories.
descriptionStringOptional
The line's description.
accountUUIDOptional
The line's account.
companyUUIDOptional
The company the line belongs to.
tax_rateUUIDOptional
The tax rate that applies to this line item.
exchange_rateStringOptional
The vendor credit line item's exchange rate.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
tracking_categoriesArrayRequired
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
accounting_periodUUIDOptional
The accounting period that the VendorCredit was generated in.
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/vendor-credits
https://api.merge.dev/api/accounting/v1/vendor-credits
US
EU
APAC
Returns a list of VendorCredit objects.
Query & Path Parameters
company_idStringOptional
If provided, will only return vendor credits for this company.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
transaction_date_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
transaction_date_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarrayaccountstringtax_ratestringaccounting_periodUUIDcompanyUUIDcurrencyEnumexchange_rateStringinclusive_of_taxBooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)vendorUUID
QuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarraydescriptionstringaccountstringcurrencyEnumexchange_rateStringnumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)vendorUUID
Sage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarraydescriptionstringaccountstringcompanystringtax_ratestringexchange_ratestringcompanyUUIDcurrencyEnumexchange_rateStringnumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertransaction_dateDateTime (ISO 8601)vendorUUID
Xero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarraydescriptionstringaccountstringtax_ratestringcurrencyEnumexchange_rateStringinclusive_of_taxBooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertransaction_dateDateTime (ISO 8601)vendorUUIDGET
/vendor-credits/{id}
https://api.merge.dev/api/accounting/v1/vendor-credits/{id}
US
EU
APAC
Returns a VendorCredit object with the given id.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
NetSuite
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarrayaccountstringtax_ratestringaccounting_periodUUIDcompanyUUIDcurrencyEnumexchange_rateStringinclusive_of_taxBooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)vendorUUIDQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarraydescriptionstringaccountstringcurrencyEnumexchange_rateStringnumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertracking_categoriesArraytransaction_dateDateTime (ISO 8601)vendorUUIDSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarraydescriptionstringaccountstringcompanystringtax_ratestringexchange_ratestringcompanyUUIDcurrencyEnumexchange_rateStringnumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertransaction_dateDateTime (ISO 8601)vendorUUIDXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
linesVendorCreditLine[]remote_idstringnet_amountnumbertracking_categoriesarraydescriptionstringaccountstringtax_ratestringcurrencyEnumexchange_rateStringinclusive_of_taxBooleannumberStringremote_dataRemoteData[]pathstringdatastringremote_idStringtotal_amountNumbertransaction_dateDateTime (ISO 8601)vendorUUID