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
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
number
StringOptional
The vendor credit's number.
transaction_date
DateTime (ISO 8601)Optional
The vendor credit's transaction date.
vendor
UUIDOptional
The vendor that owes the gift or refund.
total_amount
NumberOptional
The vendor credit's total amount.
currency
EnumOptional
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.exchange_rate
StringOptional
The vendor credit's exchange rate.
inclusive_of_tax
BooleanOptional
If the transaction is inclusive or exclusive of tax.
True
if inclusive, False
if exclusive.company
UUIDOptional
The company the vendor credit belongs to.
lines
VendorCreditLine[]Required
The VendorCreditLine object
The
VendorCreditLine
object is used to represent a vendor credit's line items.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
net_amount
NumberOptional
The full value of the credit.
tracking_categories
ArrayRequired
The vendor credit line item's associated tracking categories.
description
StringOptional
The line's description.
account
UUIDOptional
The line's account.
company
UUIDOptional
The company the line belongs to.
tax_rate
UUIDOptional
The tax rate that applies to this line item.
exchange_rate
StringOptional
The vendor credit line item's exchange rate.
remote_was_deleted
BooleanRequired
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_categories
ArrayRequired
remote_was_deleted
BooleanRequired
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_period
UUIDOptional
The accounting period that the VendorCredit was generated in.
field_mappings
ObjectOptional
remote_data
RemoteData[]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_id
StringOptional
If provided, will only return vendor credits for this company.
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
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_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
BooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
transaction_date_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
transaction_date_before
DateTime (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
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arrayaccount
stringtax_rate
stringaccounting_period
UUIDcompany
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)vendor
UUIDQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arraydescription
stringaccount
stringcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)vendor
UUIDSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arraydescription
stringaccount
stringcompany
stringtax_rate
stringexchange_rate
stringcompany
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertransaction_date
DateTime (ISO 8601)vendor
UUIDXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arraydescription
stringaccount
stringtax_rate
stringcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertransaction_date
DateTime (ISO 8601)vendor
UUIDGET
/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
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
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
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arrayaccount
stringtax_rate
stringaccounting_period
UUIDcompany
UUIDcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)vendor
UUIDQuickBooks Online
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arraydescription
stringaccount
stringcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertracking_categories
Arraytransaction_date
DateTime (ISO 8601)vendor
UUIDSage Intacct
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arraydescription
stringaccount
stringcompany
stringtax_rate
stringexchange_rate
stringcompany
UUIDcurrency
Enumexchange_rate
Stringnumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertransaction_date
DateTime (ISO 8601)vendor
UUIDXero
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
lines
VendorCreditLine[]remote_id
stringnet_amount
numbertracking_categories
arraydescription
stringaccount
stringtax_rate
stringcurrency
Enumexchange_rate
Stringinclusive_of_tax
Booleannumber
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringtotal_amount
Numbertransaction_date
DateTime (ISO 8601)vendor
UUID