Chilkat Online Tools

phpExt / Zoho CRM REST APIs / Invoices

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "data": [
//     {
//       "Product_Details": [
//         {
//           "product": {
//             "name": "sample",
//             "id": "{{product_id}}"
//           },
//           "quantity": 1
//         }
//       ],
//       "Invoice_Date": "2021-01-21",
//       "Account_Name": {
//         "name": "Zylker",
//         "id": "{{account_id}}"
//       },
//       "Sales_Order": {
//         "name": "SalesOrder1001",
//         "id": "{{sales_order_id}}"
//       },
//       "Subject": "Invoice101",
//       "Contact_Name": {
//         "name": "Patricia Boyle",
//         "id": "{{contact_id}}"
//       }
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('data[0].Product_Details[0].product.name','sample');
$json->UpdateString('data[0].Product_Details[0].product.id','{{product_id}}');
$json->UpdateInt('data[0].Product_Details[0].quantity',1);
$json->UpdateString('data[0].Invoice_Date','2021-01-21');
$json->UpdateString('data[0].Account_Name.name','Zylker');
$json->UpdateString('data[0].Account_Name.id','{{account_id}}');
$json->UpdateString('data[0].Sales_Order.name','SalesOrder1001');
$json->UpdateString('data[0].Sales_Order.id','{{sales_order_id}}');
$json->UpdateString('data[0].Subject','Invoice101');
$json->UpdateString('data[0].Contact_Name.name','Patricia Boyle');
$json->UpdateString('data[0].Contact_Name.id','{{contact_id}}');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/crm/v2.1/Invoices/upsert','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "data": [
        {
            "Product_Details": [
                {
                    "product": {
                        "name": "sample",
                        "id": "{{product_id}}"
                    },
                    "quantity": 1
                }
            ],
            "Invoice_Date": "2021-01-21",
            "Account_Name": {
                "name": "Zylker",
                "id": "{{account_id}}"
            },
            "Sales_Order": {
                "name": "SalesOrder1001",
                "id": "{{sales_order_id}}"
            },
            "Subject": "Invoice101",
            "Contact_Name": {
                "name": "Patricia Boyle",
                "id": "{{contact_id}}"
            }
        }
    ]
}'
https://domain.com/crm/v2.1/Invoices/upsert

Postman Collection Item JSON

{
  "name": "Invoices",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{access-token}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"data\": [\n        {\n            \"Product_Details\": [\n                {\n                    \"product\": {\n                        \"name\": \"sample\",\n                        \"id\": \"{{product_id}}\"\n                    },\n                    \"quantity\": 1\n                }\n            ],\n            \"Invoice_Date\": \"2021-01-21\",\n            \"Account_Name\": {\n                \"name\": \"Zylker\",\n                \"id\": \"{{account_id}}\"\n            },\n            \"Sales_Order\": {\n                \"name\": \"SalesOrder1001\",\n                \"id\": \"{{sales_order_id}}\"\n            },\n            \"Subject\": \"Invoice101\",\n            \"Contact_Name\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"{{contact_id}}\"\n            }\n        }\n    ]\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{api-domain}}/crm/v2.1/Invoices/upsert",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "Invoices",
        "upsert"
      ]
    },
    "description": "To add new entities to the invoices module."
  },
  "response": [
  ]
}