GET /vendors
Changed onGets the latest vendors/suppliers for a business.
Request
- Base URLhttps://api.railz.ai
- AuthHTTP bearer
Query parameters
The offset is the position in the dataset of a particular record.
This is the size of the results set you would like (default: 100).
Response
Example response
{
"count": 1,
"meta": {
"reportId": [
"5fad8a342a88364234392fb5",
"5fad8a342a88364234392fb6"
],
"serviceName": "xero",
"businessName": "Railz",
"createdAt": "2020-11-25T01:02:03Z",
"updatedAt": "2020-11-30T01:02:03Z"
},
"data": [
{
"id": "1",
"vendorName": "ACME Inc.",
"contactName": "Jane Smith",
"emailAddress": "email@acme.com",
"website": "www.acme.com",
"phone": "8889990000",
"taxNumber": "987654321",
"subsidiaryRefs": [
{
"id": "1",
"name": "Railz Financial"
}
],
"sourceModifiedDate": "2021-03-09T08:49:36.035Z",
"parentRef": {
"id": "434",
"name": "Region"
},
"defaultCurrency": {
"id": "CAD",
"name": "Canadian Dollar",
"symbol": "USD,CAD"
},
"addresses": [
{
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
}
],
"contacts": [
{
"name": "John Smith",
"email": "jsmith@company.com",
"phone": "8887779999",
"address": {
"line1": "1234 Park Street",
"line2": "Suite 1000",
"city": "Toronto",
"region": "ON",
"country": "CAN",
"postalCode": "A0B1C2"
},
"modifiedDate": "2021-03-09T08:49:36.035Z"
}
]
}
]
}Changes
- info
api tag
Vendoradded
- info
- breaking
removed the enum value
plaidfrom thequeryrequest parameterserviceName - breaking
removed the enum value
shopifyfrom thequeryrequest parameterserviceName - breaking
removed the enum value
squarefrom thequeryrequest parameterserviceName - breaking
the response property
////became optional for the status - breaking
the response property
////became optional for the status - breaking
the response property
//became optional for the status - breaking
the response property
//became optional for the status - warning
added the new
byodenum value to the/response property for the response status - warning
added the new
byodenum value to the/response property for the response status - warning
added the new
dynamics365Financeenum value to the/response property for the response status - warning
added the new
dynamics365Financeenum value to the/response property for the response status - warning
added the new
dynamicsBusinessCentralenum value to the/response property for the response status - warning
added the new
dynamicsBusinessCentralenum value to the/response property for the response status - warning
added the new
freshbooksenum value to the/response property for the response status - warning
added the new
freshbooksenum value to the/response property for the response status - warning
added the new
myobenum value to the/response property for the response status - warning
added the new
myobenum value to the/response property for the response status - warning
added the new
oracleNetsuiteenum value to the/response property for the response status - warning
added the new
oracleNetsuiteenum value to the/response property for the response status - warning
added the new
quickbooksenum value to the/response property for the response status - warning
added the new
quickbooksenum value to the/response property for the response status - warning
added the new
quickbooksDesktopenum value to the/response property for the response status - warning
added the new
quickbooksDesktopenum value to the/response property for the response status - warning
added the new
sageBusinessCloudenum value to the/response property for the response status - warning
added the new
sageBusinessCloudenum value to the/response property for the response status - warning
added the new
sageIntacctenum value to the/response property for the response status - warning
added the new
sageIntacctenum value to the/response property for the response status - warning
added the new
waveenum value to the/response property for the response status - warning
added the new
waveenum value to the/response property for the response status - warning
added the new
xeroenum value to the/response property for the response status - warning
added the new
xeroenum value to the/response property for the response status - warning
added the new
zohoBooksenum value to the/response property for the response status - warning
added the new
zohoBooksenum value to the/response property for the response status - info
added the new enum value
dynamics365Financeto thequeryrequest parameterserviceName - info
added the new enum value
zohoBooksto thequeryrequest parameterserviceName - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
response property
countdeprecated - info
response property
countdeprecated
- breaking