Toll free - 1800 102 9944Mon - Sat 9am to 6pm IST+91 7305654908Contact Us

Purchase Receives

A new purchase receive can a be created.To create Purchase receive, URL parameter purchaseorder_id is needed.

Attribute

  • purchaseorder_idlong

    Unique ID generated by the server for the Purchase Order.

  • purchaseorder_numberstring

    Purchase Order number.

  • receive_idlong

    Unique ID generated by the server for the Purchase Receive. This is used as identifier.

  • receive_numberstring

    Number of the Purchase Receive.

  • datestring

    Date of Purchase Order

  • vendor_idlong

    Unique ID generated by the server for the vendor.

  • vendor_namestring

    Name of the vendor.

  • contact_personsarray

    Array of contact person IDs.

  • notesstring

    Purchase Receive notes.

  • line_itemsarray

    Number of line items for purchase receive. Each line item contains line_item_id, item_id, name, description, item_order, quantity and unit.

    Show Sub-Attributes

    • line_item_idlong

      Unique ID generated by the server for each line item. This is used as an identifier.

    • item_idlong

      Unique ID generated by the server for the item. This is used as an identifier.

    • namestring

      Name of the line item.

    • descriptionstring

      Description of the line item.

    • item_orderinteger

      The order of the line items, starts from 0 by default.

    • quantitydouble

      Quantity of the line item.

    • unitstring

      Unit of line item.

  • billing_addressarray

    Customer's billing address. It contains - address, city, state, zip, country and fax.

    Show Sub-Attributes

    • addressstring

      Name of the street of the customer’s billing address.

    • citystring

      Name of the city of the customer’s billing address.

    • statestring

      Name of the state of the customer's billing address.

    • zipstring

      Zip code of the customer’s billing address.

    • countrystring

      Name of the country of the customer’s billing address.

    • faxstring

      Fax number of the customer’s billing address.

  • shipping_addressarray

    Customer's shipping address. It contains - address, city, state, zip, country and fax.

    Show Sub-Attributes

    • addressstring

      Name of the street of the customer’s billing address.

    • citystring

      Name of the city of the customer’s billing address.

    • statestring

      Name of the state of the customer's billing address.

    • zipstring

      Zip code of the customer’s billing address.

    • countrystring

      Name of the country of the customer’s billing address.

    • faxstring

      Fax number of the customer’s billing address.

  • created_timestring

    Time at which the Purchase Receive was created.

  • last_modified_timestring

    Time at which the Purchase Order details were last modified.

End Points
ExampleCopy
{
    "purchaseorder_id": 4815000000044972,
    "purchaseorder_number": "PO-00002",
    "receive_id": 4815000000045035,
    "receive_number": "PR-00002",
    "date": "2015-05-28",
    "vendor_id": 4815000000044080,
    "vendor_name": "Molly",
    "contact_persons": 4815000000044080,
    "notes": "Sample Note.",
    "line_items": [
        {
            "line_item_id": 4815000000044897,
            "item_id": 4815000000044100,
            "name": "Laptop-white/15inch/dell",
            "description": "Just a sample description.",
            "item_order": 0,
            "quantity": 2,
            "unit": "qty"
        }
    ],
    "billing_address": [
        {
            "address": "No:234,90 Church Street",
            "city": "New York City",
            "state": "New York",
            "zip": 10048,
            "country": "U.S.A",
            "fax": "324-524242"
        }
    ],
    "shipping_address": [
        {
            "address": "No:234,90 Church Street",
            "city": "New York City",
            "state": "New York",
            "zip": 10048,
            "country": "U.S.A",
            "fax": "324-524242"
        }
    ],
    "created_time": "2015-05-28T00:00:00.000Z",
    "last_modified_time": "2015-05-28T00:00:00.000Z"
}

Create a purchase receive

A new purchase receive can a be created.To create Purchase receive, URL parameter purchaseorder_id is needed.

OAuth Scope : ZakyaAPI.purchasereceives.CREATE

Arguments

  • receive_numberstring (Required)

    Number of the Purchase Receive.

  • datestring

    Date of Purchase Order

  • notesstring

    Purchase Receive notes.

  • line_itemsarray (Required)

    Number of line items for purchase receive. Each line item contains line_item_id, item_id, name, description, item_order, quantity and unit.

    Show Sub-Attributes

    • line_item_idlong

      Unique ID generated by the server for each line item. This is used as an identifier.

    • item_idlong

      Unique ID generated by the server for the item. This is used as an identifier.

    • namestring

      Name of the line item.

    • descriptionstring

      Description of the line item.

    • item_orderinteger

      The order of the line items, starts from 0 by default.

    • quantitydouble

      Quantity of the line item.

    • unitstring

      Unit of line item.

Request ExampleCopy
curl --request POST \
  --url 'https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: 
]
info response;
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();
const http = require("https");

const options = {
  "method": "POST",
  "hostname": "api.zakya.com",
  "port": null,
  "path": "/inventory/v1/purchasereceives?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import http.client

conn = http.client.HTTPSConnection("api.zakya.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/purchasereceives?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Create a purchase receive

A new purchase receive can a be created.To create Purchase receive, URL parameter purchaseorder_id is needed.

OAuth Scope : ZakyaAPI.purchasereceives.CREATE

Arguments

  • receive_numberstring (Required)

    Number of the Purchase Receive.

  • datestring

    Date of Purchase Order

  • notesstring

    Purchase Receive notes.

  • line_itemsarray (Required)

    Number of line items for purchase receive. Each line item contains line_item_id, item_id, name, description, item_order, quantity and unit.

    Show Sub-Attributes

    • line_item_idlong

      Unique ID generated by the server for each line item. This is used as an identifier.

    • item_idlong

      Unique ID generated by the server for the item. This is used as an identifier.

    • namestring

      Name of the line item.

    • descriptionstring

      Description of the line item.

    • item_orderinteger

      The order of the line items, starts from 0 by default.

    • quantitydouble

      Quantity of the line item.

    • unitstring

      Unit of line item.

Request ExampleCopy
curl --request POST \
  --url 'https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'
parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: 
]
info response;
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();
const http = require("https");

const options = {
  "method": "POST",
  "hostname": "api.zakya.com",
  "port": null,
  "path": "/inventory/v1/purchasereceives?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://api.zakya.com/inventory/v1/purchasereceives?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import http.client

conn = http.client.HTTPSConnection("api.zakya.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v1/purchasereceives?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
Body ParametersCopy
{
    "receive_number": "PR-00002",
    "date": "2015-05-28",
    "notes": "Sample Note.",
    "line_items": [
        {
            "line_item_id": 4815000000044897,
            "item_id": 4815000000044100,
            "name": "Laptop-white/15inch/dell",
            "description": "Just a sample description.",
            "item_order": 0,
            "quantity": 2,
            "unit": "qty"
        }
    ]
}
Response ExampleCopy
{
    "code": 0,
    "message": "success",
    "purchase_receive": {
        "purchaseorder_id": 4815000000044972,
        "purchaseorder_number": "PO-00002",
        "receive_id": 4815000000045035,
        "receive_number": "PR-00002",
        "date": "2015-05-28",
        "vendor_id": 4815000000044080,
        "vendor_name": "Molly",
        "contact_persons": 4815000000044080,
        "notes": "Sample Note.",
        "line_items": [
            {
                "line_item_id": 4815000000044897,
                "item_id": 4815000000044100,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "item_order": 0,
                "quantity": 2,
                "unit": "qty"
            }
        ],
        "billing_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "shipping_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "created_time": "2015-05-28T00:00:00.000Z",
        "last_modified_time": "2015-05-28T00:00:00.000Z"
    }
}

Retrieve a Purchase Receive

Fetches a Purchase Receive from Zakya.

OAuth Scope : ZakyaAPI.purchasereceives.READ

Request ExampleCopy
curl --request GET \
  --url 'https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695"
type: GET
headers: headers_data
connection: 
]
info response;
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();
const http = require("https");

const options = {
  "method": "GET",
  "hostname": "api.zakya.com",
  "port": null,
  "path": "/inventory/v1/purchasereceives/?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import http.client

conn = http.client.HTTPSConnection("api.zakya.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v1/purchasereceives/?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
Response ExampleCopy
{
    "code": 0,
    "message": "success",
    "purchase_receive": {
        "purchaseorder_id": 4815000000044972,
        "purchaseorder_number": "PO-00002",
        "receive_id": 4815000000045035,
        "receive_number": "PR-00002",
        "date": "2015-05-28",
        "vendor_id": 4815000000044080,
        "vendor_name": "Molly",
        "contact_persons": 4815000000044080,
        "notes": "Sample Note.",
        "line_items": [
            {
                "line_item_id": 4815000000044897,
                "item_id": 4815000000044100,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "item_order": 0,
                "quantity": 2,
                "unit": "qty"
            }
        ],
        "billing_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "shipping_address": [
            {
                "address": "No:234,90 Church Street",
                "city": "New York City",
                "state": "New York",
                "zip": 10048,
                "country": "U.S.A",
                "fax": "324-524242"
            }
        ],
        "created_time": "2015-05-28T00:00:00.000Z",
        "last_modified_time": "2015-05-28T00:00:00.000Z"
    }
}

Delete a Purchase Receive

Deletes a Purchase Receive from Zakya.

OAuth Scope : ZakyaAPI.purchasereceives.DELETE

Request ExampleCopy
curl --request DELETE \
  --url 'https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695"
type: DELETE
headers: headers_data
connection: 
]
info response;
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();
const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "api.zakya.com",
  "port": null,
  "path": "/inventory/v1/purchasereceives/?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://api.zakya.com/inventory/v1/purchasereceives/?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import http.client

conn = http.client.HTTPSConnection("api.zakya.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/inventory/v1/purchasereceives/?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
Response ExampleCopy
{
    "code": 0,
    "message": "The Purchase Receive has been deleted."
}