Chilkat Online Tools

Foxpro / Fatture in Cloud API v2 - API Reference / Modify Supplier

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcCode
LOCAL lcName
LOCAL lcV_Type
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcContact_person
LOCAL lcVat_number
LOCAL lcTax_code
LOCAL lcAddress_street
LOCAL lcAddress_postal_code
LOCAL lcAddress_city
LOCAL lcAddress_province
LOCAL lcAddress_extra
LOCAL lcCountry
LOCAL lcV_Email
LOCAL lcCertified_email
LOCAL lcPhone
LOCAL lcFax
LOCAL lcNotes
LOCAL lcBank_iban
LOCAL lcCreated_at
LOCAL lcUpdated_at

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.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>"
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("data.name","<string>")
loJson.UpdateString("data.id","<integer>")
loJson.UpdateString("data.code","<string>")
loJson.UpdateNull("data.type")
loJson.UpdateString("data.first_name","<string>")
loJson.UpdateString("data.last_name","<string>")
loJson.UpdateString("data.contact_person","<string>")
loJson.UpdateString("data.vat_number","<string>")
loJson.UpdateString("data.tax_code","<string>")
loJson.UpdateString("data.address_street","<string>")
loJson.UpdateString("data.address_postal_code","<string>")
loJson.UpdateString("data.address_city","<string>")
loJson.UpdateString("data.address_province","<string>")
loJson.UpdateString("data.address_extra","<string>")
loJson.UpdateString("data.country","Italia")
loJson.UpdateString("data.email","<string>")
loJson.UpdateString("data.certified_email","<string>")
loJson.UpdateString("data.phone","<string>")
loJson.UpdateString("data.fax","<string>")
loJson.UpdateString("data.notes","<string>")
loJson.UpdateString("data.bank_iban","<string>")
loJson.UpdateString("data.created_at","<string>")
loJson.UpdateString("data.updated_at","<string>")

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://api-v2.fattureincloud.it/c/:company_id/entities/suppliers/:supplier_id",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcId = loJResp.StringOf("data.id")
lcCode = loJResp.StringOf("data.code")
lcName = loJResp.StringOf("data.name")
lcV_Type = loJResp.StringOf("data.type")
lcFirst_name = loJResp.StringOf("data.first_name")
lcLast_name = loJResp.StringOf("data.last_name")
lcContact_person = loJResp.StringOf("data.contact_person")
lcVat_number = loJResp.StringOf("data.vat_number")
lcTax_code = loJResp.StringOf("data.tax_code")
lcAddress_street = loJResp.StringOf("data.address_street")
lcAddress_postal_code = loJResp.StringOf("data.address_postal_code")
lcAddress_city = loJResp.StringOf("data.address_city")
lcAddress_province = loJResp.StringOf("data.address_province")
lcAddress_extra = loJResp.StringOf("data.address_extra")
lcCountry = loJResp.StringOf("data.country")
lcV_Email = loJResp.StringOf("data.email")
lcCertified_email = loJResp.StringOf("data.certified_email")
lcPhone = loJResp.StringOf("data.phone")
lcFax = loJResp.StringOf("data.fax")
lcNotes = loJResp.StringOf("data.notes")
lcBank_iban = loJResp.StringOf("data.bank_iban")
lcCreated_at = loJResp.StringOf("data.created_at")
lcUpdated_at = loJResp.StringOf("data.updated_at")

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -X PUT
	-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/:supplier_id

Postman Collection Item JSON

{
  "name": "Modify 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": "PUT",
    "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/:supplier_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "entities",
        "suppliers",
        ":supplier_id"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        },
        {
          "key": "supplier_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Modifies the specified supplier."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "PUT",
        "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/:supplier_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers",
            ":supplier_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "supplier_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}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "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/:supplier_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers",
            ":supplier_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "supplier_id"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "Not Found",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "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/:supplier_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "entities",
            "suppliers",
            ":supplier_id"
          ],
          "variable": [
            {
              "key": "company_id"
            },
            {
              "key": "supplier_id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}