About Bulk
The Bulk API can make multiple API calls, such as create multiple vendors, bills and more. A bulk operation must apply to a single entity type with a single operation.
Note: The maximum number of API calls in a bulk operation is 100.
For example, 100 vendors can be created in one request. All calls must be of a single operation (such as, Create, Update, Delete and Undelete). If you attempt to mix and match, the entire call returns an error.
The Bulk API is transaction-based, where all objects/operations succeed or all fail. The response lists each object/operation in the same order as the request.
Example
Format:<API_URL_EndPoint>/Bulk/Crud/OPERATION/ENTITY
Request
<API_URL_EndPoint>/Bulk/Crud/Create/Vendor
data={
"bulk" : [ {
"obj" : {
"entity" : "Vendor",
"name" : "Vendor 1"
}
}, {
"obj" : {
"entity" : "Vendor",
"name" : "Vendor 2"
}
}, {
"obj" : {
"entity" : "Vendor",
"name" : "Vendor 3"
}
} ]
}
Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"bulk" : [ {
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Vendor",
"id" : "00901TGRSNBUDSA2pfcb",
"isActive" : "1",
"name" : "Vendor 1",
"shortName" : null,
"nameOnCheck" : null,
"companyName" : null,
"accNumber" : null,
"taxId" : null,
"track1099" : false,
"address1" : null,
"address2" : null,
"address3" : null,
"address4" : null,
"addressCity" : null,
"addressState" : null,
"addressZip" : null,
"addressCountry" : null,
"email" : null,
"fax" : null,
"phone" : null,
"payBy" : "0",
"paymentEmail" : null,
"paymentPhone" : null,
"description" : null,
"createdTime" : "2016-08-17T20:50:52.000+0000",
"updatedTime" : "2016-08-17T20:50:52.000+0000",
"contactFirstName" : null,
"contactLastName" : null,
"mergedIntoId" : "00000000000000000000",
"accountType" : "0"
}
}, {
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Vendor",
"id" : "00901PQKGVFMCQU2pfcc",
"isActive" : "1",
"name" : "Vendor 2",
"shortName" : null,
"nameOnCheck" : null,
"companyName" : null,
"accNumber" : null,
"taxId" : null,
"track1099" : false,
"address1" : null,
"address2" : null,
"address3" : null,
"address4" : null,
"addressCity" : null,
"addressState" : null,
"addressZip" : null,
"addressCountry" : null,
"email" : null,
"fax" : null,
"phone" : null,
"payBy" : "0",
"paymentEmail" : null,
"paymentPhone" : null,
"description" : null,
"createdTime" : "2016-08-17T20:50:52.000+0000",
"updatedTime" : "2016-08-17T20:50:52.000+0000",
"contactFirstName" : null,
"contactLastName" : null,
"mergedIntoId" : "00000000000000000000",
"accountType" : "0"
}
}, {
"response_status" : 0,
"response_message" : "Success",
"response_data" : {
"entity" : "Vendor",
"id" : "00901SJDGWFDAKD2pfcd",
"isActive" : "1",
"name" : "Vendor 3",
"shortName" : null,
"nameOnCheck" : null,
"companyName" : null,
"accNumber" : null,
"taxId" : null,
"track1099" : false,
"address1" : null,
"address2" : null,
"address3" : null,
"address4" : null,
"addressCity" : null,
"addressState" : null,
"addressZip" : null,
"addressCountry" : null,
"email" : null,
"fax" : null,
"phone" : null,
"payBy" : "0",
"paymentEmail" : null,
"paymentPhone" : null,
"description" : null,
"createdTime" : "2016-08-17T20:50:52.000+0000",
"updatedTime" : "2016-08-17T20:50:52.000+0000",
"contactFirstName" : null,
"contactLastName" : null,
"mergedIntoId" : "00000000000000000000",
"accountType" : "0"
}
} ]
}
}
Resources
Parameters
The data field would take in the following parameters.
Field Name | Description | Required? |
---|---|---|
bulk | Array of API call data. To create vendors, provide the vendor data in an array. | Y |