Chilkat Online Tools

phpAx / Fatture in Cloud API v2 - API Reference / Create Supplier

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

// 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": {
//     "name": "<string>",
//     "id": "<integer>",
//     "code": "<string>",
//     "type": null,
//     "first_name": "<string>",
//     "last_name": "<string>",
//     "contact_person": "<string>",
//     "vat_number": "<string>",
//     "tax_code": "<string>",
//     "address_street": "<string>",
//     "address_postal_code": "<string>",
//     "address_city": "<string>",
//     "address_province": "<string>",
//     "address_extra": "<string>",
//     "country": "Italia",
//     "email": "<string>",
//     "certified_email": "<string>",
//     "phone": "<string>",
//     "fax": "<string>",
//     "notes": "<string>",
//     "bank_iban": "<string>",
//     "created_at": "<string>",
//     "updated_at": "<string>"
//   }
// }

$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('data.name','<string>');
$json->UpdateString('data.id','<integer>');
$json->UpdateString('data.code','<string>');
$json->UpdateNull('data.type');
$json->UpdateString('data.first_name','<string>');
$json->UpdateString('data.last_name','<string>');
$json->UpdateString('data.contact_person','<string>');
$json->UpdateString('data.vat_number','<string>');
$json->UpdateString('data.tax_code','<string>');
$json->UpdateString('data.address_street','<string>');
$json->UpdateString('data.address_postal_code','<string>');
$json->UpdateString('data.address_city','<string>');
$json->UpdateString('data.address_province','<string>');
$json->UpdateString('data.address_extra','<string>');
$json->UpdateString('data.country','Italia');
$json->UpdateString('data.email','<string>');
$json->UpdateString('data.certified_email','<string>');
$json->UpdateString('data.phone','<string>');
$json->UpdateString('data.fax','<string>');
$json->UpdateString('data.notes','<string>');
$json->UpdateString('data.bank_iban','<string>');
$json->UpdateString('data.created_at','<string>');
$json->UpdateString('data.updated_at','<string>');

$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('Accept','application/json');

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PostJson3('https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": {
//     "id": "<integer>",
//     "code": "<string>",
//     "name": "<string>",
//     "type": null,
//     "first_name": "<string>",
//     "last_name": "<string>",
//     "contact_person": "<string>",
//     "vat_number": "<string>",
//     "tax_code": "<string>",
//     "address_street": "<string>",
//     "address_postal_code": "<string>",
//     "address_city": "<string>",
//     "address_province": "<string>",
//     "address_extra": "<string>",
//     "country": "<string>",
//     "email": "<string>",
//     "certified_email": "<string>",
//     "phone": "<string>",
//     "fax": "<string>",
//     "notes": "<string>",
//     "bank_iban": "<string>",
//     "created_at": "<string>",
//     "updated_at": "<string>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$Id = $jResp->stringOf('data.id');
$Code = $jResp->stringOf('data.code');
$Name = $jResp->stringOf('data.name');
$v_Type = $jResp->stringOf('data.type');
$First_name = $jResp->stringOf('data.first_name');
$Last_name = $jResp->stringOf('data.last_name');
$Contact_person = $jResp->stringOf('data.contact_person');
$Vat_number = $jResp->stringOf('data.vat_number');
$Tax_code = $jResp->stringOf('data.tax_code');
$Address_street = $jResp->stringOf('data.address_street');
$Address_postal_code = $jResp->stringOf('data.address_postal_code');
$Address_city = $jResp->stringOf('data.address_city');
$Address_province = $jResp->stringOf('data.address_province');
$Address_extra = $jResp->stringOf('data.address_extra');
$Country = $jResp->stringOf('data.country');
$v_Email = $jResp->stringOf('data.email');
$Certified_email = $jResp->stringOf('data.certified_email');
$Phone = $jResp->stringOf('data.phone');
$Fax = $jResp->stringOf('data.fax');
$Notes = $jResp->stringOf('data.notes');
$Bank_iban = $jResp->stringOf('data.bank_iban');
$Created_at = $jResp->stringOf('data.created_at');
$Updated_at = $jResp->stringOf('data.updated_at');

?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "data": {
    "name": "<string>",
    "id": "<integer>",
    "code": "<string>",
    "type": null,
    "first_name": "<string>",
    "last_name": "<string>",
    "contact_person": "<string>",
    "vat_number": "<string>",
    "tax_code": "<string>",
    "address_street": "<string>",
    "address_postal_code": "<string>",
    "address_city": "<string>",
    "address_province": "<string>",
    "address_extra": "<string>",
    "country": "Italia",
    "email": "<string>",
    "certified_email": "<string>",
    "phone": "<string>",
    "fax": "<string>",
    "notes": "<string>",
    "bank_iban": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}'
https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers

Postman Collection Item JSON

{
  "name": "Create Supplier",
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": [
        {
          "key": "scope",
          "value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
          "type": "string"
        },
        {
          "key": "redirect_uri",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "accessTokenUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "authUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/authorize",
          "type": "string"
        },
        {
          "key": "grant_type",
          "value": "authorization_code",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"code\": \"<string>\",\n    \"type\": null,\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"contact_person\": \"<string>\",\n    \"vat_number\": \"<string>\",\n    \"tax_code\": \"<string>\",\n    \"address_street\": \"<string>\",\n    \"address_postal_code\": \"<string>\",\n    \"address_city\": \"<string>\",\n    \"address_province\": \"<string>\",\n    \"address_extra\": \"<string>\",\n    \"country\": \"Italia\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/entities/suppliers",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "suppliers"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Creates a new supplier."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"data\": {\n    \"name\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"code\": \"<string>\",\n    \"type\": null,\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"contact_person\": \"<string>\",\n    \"vat_number\": \"<string>\",\n    \"tax_code\": \"<string>\",\n    \"address_street\": \"<string>\",\n    \"address_postal_code\": \"<string>\",\n    \"address_city\": \"<string>\",\n    \"address_province\": \"<string>\",\n    \"address_extra\": \"<string>\",\n    \"country\": \"Italia\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/entities/suppliers",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": {\n    \"id\": \"<integer>\",\n    \"code\": \"<string>\",\n    \"name\": \"<string>\",\n    \"type\": null,\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"contact_person\": \"<string>\",\n    \"vat_number\": \"<string>\",\n    \"tax_code\": \"<string>\",\n    \"address_street\": \"<string>\",\n    \"address_postal_code\": \"<string>\",\n    \"address_city\": \"<string>\",\n    \"address_province\": \"<string>\",\n    \"address_extra\": \"<string>\",\n    \"country\": \"<string>\",\n    \"email\": \"<string>\",\n    \"certified_email\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"fax\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"bank_iban\": \"<string>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\"\n  }\n}"
    }
  ]
}