Description
This document describes the ISPnext API entry point for Vendors.
General
Entry Point Reference
Methods
POST Vendors
Location
https://XXX.vendorlink.nl/API/Vendors/Vendors
Header
- Key "Authorization", Value "Bearer <accessToken>"
Querystring parameters
- none
Body
{ "version": 1, "operation": string, (supported values: "insert", "update", "delete") "data": [ { "SupplierId": int (optional, mandatory for delete, update when no ExternalId supplied), "ExternalId": string (optional, mandatory for insert, update when no SupplierId supplied), "Name": string (optional, mandatory for insert), "Archived": boolean (optional), "MainAddress": string (optional), "MainAddressNum": string (optional), "MainAddressNumAdd": string (optional), "MainZipcode": string (optional), "MainState": string (optional), "MainTown": string (optional), "MainCountryCode": string (optional, 2 char ISO code), "VatCode": string (optional), "KvkNumber": string (optional), "Tel": string (optional), "OrderEmail": string (optional), "GeneralEmail": string (optional), "WebsiteUrl": string (optional), "PostalAddress": string (optional), "PostalAddressNum": string (optional), "PostalAddressNumAdd": string (optional), "PostalZipcode": string (optional), "PostalTown": string (optional), "PostalCountryCode": string (optional), "PostalState": string (optional), "Categories": array (optional) [ { "CategoryId": int (optional, mandatory when code is omitted), "Code": string (optional, mandatory when categoryId is omitted) } ], "CustomFields": array (optional) [ { "Name": string (mandatory), "Value": string (mandatory) } ],
"CompanyList": object (optional)
{
"CompanyCodes":[
{
"Operation" : "Insert/Delete",
"Code" : "<companycode>"
}
]
},
"PayTerm": object (optional)
{
"Ref": "<payterm reference>"
},
"VatGroup": object (optional)
{
"Ref": "<vatgroup reference>"
},
"Vat": object (optional)
{
"Ref": "<vatpercentage>",
"Description": "<vatdescription>"
},
"Currency": string (optional) "<ISO>",
"BusinessArea": string (optional),
"GLN":string (optional),
"SupplyingCountry": string (optional) "<ISO>",
"Discount": object (optional)
{
"Ref": string "<discount reference>",
},
"BankAccountList": object (optional)
{
"BankAccounts":[
{
"Operation":"<Insert/Delete/Update>",
"Key":"<bankreference>",
"Iban":"<banknumber>",
"Country":"<ISO>",
"Name":"<bankname>"
}
]
} } ] }
Response
{
"hasErrors": bool,
"messages": array
}
Remarks
The messages array consists of objects:
{
severity: string,
message: string,
Data: object
}
Please note that data will contain the original sent object that was inserted, or for which the error occurred.
Opmerkingen
0 opmerkingen
Artikel is gesloten voor opmerkingen.