Vendor Credits

The VendorCredit object is used to represent a company's vendor credits.

The VendorCredit object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

numberString
Optional
The vendor credit's number.

transaction_dateString
Optional
The vendor credit's transaction date.

vendorString
Optional

total_amountNumber
Optional
The vendor credit's total amount.

currencyEnum
Optional
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, or - in cases where there is no clear mapping - the original value passed through.

linesVendorCreditLine[]
Required

The VendorCreditLine object

The VendorCreditLine object is used to represent a vendor credit's line items.
{
"remote_id": "121222",
"net_amount": 25.54,
"tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
"description": "Gifted Merge Credit",
"account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
}

Properties


remote_idString
Optional
The third-party API ID of the matching object.

net_amountNumber
Optional
The line's net amount.

tracking_categoryString
Optional
The line's associated tracking category.

descriptionString
Optional
The line's description.

accountString
Optional
The line's account.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The VendorCredit object
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "088899",
"number": "6",
"transaction_date": "2020-03-31T00:00:00Z",
"vendor": "3d263469-51a1-4766-9205-f6c997826be1",
"total_amount": 10000,
"currency": "USD",
"lines": [
{
"remote_id": "121222",
"net_amount": 25.54,
"tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
"description": "Gifted Merge Credit",
"account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
},
{
"remote_id": "121223",
"net_amount": 10,
"tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
"description": "Refund for overpayment",
"account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
}
],
"remote_was_deleted": true
}

GET

/vendor-credits

Returns a list of VendorCredit objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "088899",
"number": "6",
"transaction_date": "2020-03-31T00:00:00Z",
"vendor": "3d263469-51a1-4766-9205-f6c997826be1",
"total_amount": 10000,
"currency": "USD",
"lines": [
{
"remote_id": "121222",
"net_amount": 25.54,
"tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
"description": "Gifted Merge Credit",
"account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
},
{
"remote_id": "121223",
"net_amount": 10,
"tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
"description": "Refund for overpayment",
"account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
}
],
"remote_was_deleted": true
}
]
}
Field support by platform

Netsuite

Netsuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


numberString

remote_idString

total_amountNumber

transaction_dateString

vendorString

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

numberString

remote_idString

total_amountNumber

transaction_dateString

vendorString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remote_idString

total_amountNumber

transaction_dateString

vendorString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/vendor-credits/{id}

Returns a VendorCredit object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
"id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
"remote_id": "088899",
"number": "6",
"transaction_date": "2020-03-31T00:00:00Z",
"vendor": "3d263469-51a1-4766-9205-f6c997826be1",
"total_amount": 10000,
"currency": "USD",
"lines": [
{
"remote_id": "121222",
"net_amount": 25.54,
"tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
"description": "Gifted Merge Credit",
"account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
},
{
"remote_id": "121223",
"net_amount": 10,
"tracking_category": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
"description": "Refund for overpayment",
"account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
}
],
"remote_was_deleted": true
}
Field support by platform

Netsuite

Netsuite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


numberString

remote_idString

total_amountNumber

transaction_dateString

vendorString

Quickbooks Online

Quickbooks Online

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

numberString

remote_idString

total_amountNumber

transaction_dateString

vendorString

Xero

Xero

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


currencyEnum

remote_idString

total_amountNumber

transaction_dateString

vendorString
Hint: Use the /linked-accounts endpoint to pull platform support information.