Updates an existing business object

Request

This endpoint updates a business object by matching the specified field key and value. The request body should contain the updated data.

Path

entityTypestringrequired
The type of business object

Example: ST_ITEM
Default:
fieldKeystringrequired
Field key used to identify the object

Example: CODE
Default:
fieldValuestringrequired
Field value corresponding to the key

Example: ISCT
Default:

Body application/json

Updated business object data

mainKeynumber or string
Example: DOCKEY
One of:
number
dataobject

Responses

Returns the updated business object details

Body application/json

put /api/biz-objects/{entityType}/{fieldKey}/{fieldValue}

curl -X PUT \
  https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT \
  -H 'Content-Type: application/json' \
  -d '{
  "mainKey": "DOCKEY",
  "data": {
    "DESCRIPTION": "Test Description",
    "cdsUOM": [
      {
        "REFPRICE": "6868"
      }
    ]
  }
}'

const url = 'https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"mainKey":"DOCKEY","data":{"DESCRIPTION":"Test Description","cdsUOM":[{"REFPRICE":"6868"}]}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const fetch = require('node-fetch');

const url = 'https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"mainKey":"DOCKEY","data":{"DESCRIPTION":"Test Description","cdsUOM":[{"REFPRICE":"6868"}]}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import requests

url = "https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT"

payload = {
  "mainKey": "DOCKEY",
  "data": {
    "DESCRIPTION": "Test Description",
    "cdsUOM": [{ "REFPRICE": "6868" }]
  }
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.json())

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"mainKey\": \"DOCKEY\",\n  \"data\": {\n    \"DESCRIPTION\": \"Test Description\",\n    \"cdsUOM\": [\n      {\n        \"REFPRICE\": \"6868\"\n      }\n    ]\n  }\n}");
Request request = new Request.Builder()
  .url("https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT"),
  Content = new StringContent("{\n  \"mainKey\": \"DOCKEY\",\n  \"data\": {\n    \"DESCRIPTION\": \"Test Description\",\n    \"cdsUOM\": [\n      {\n        \"REFPRICE\": \"6868\"\n      }\n    ]\n  }\n}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'mainKey' => 'DOCKEY',
    'data' => [
        'DESCRIPTION' => 'Test Description',
        'cdsUOM' => [
                [
                                'REFPRICE' => '6868'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/biz-objects/ST_ITEM/CODE/ISCT"

	payload := strings.NewReader("{\n  \"mainKey\": \"DOCKEY\",\n  \"data\": {\n    \"DESCRIPTION\": \"Test Description\",\n    \"cdsUOM\": [\n      {\n        \"REFPRICE\": \"6868\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response

application/json

{
  "DOCKEY": 10,
  "CODE": "ISCT",
  "DESCRIPTION": "Test Description",
  "DESCRIPTION2": {},
  "DESCRIPTION3": {},
  "STOCKGROUP": "FURNITURE",
  "STOCKCONTROL": "T",
  "COSTINGMETHOD": 1,
  "SERIALNUMBER": "F",
  "SHELF": {},
  "MINQTY": 0,
  "MAXQTY": 0,
  "SUOM": {},
  "REORDERLEVEL": 0,
  "REORDERQTY": 1,
  "SLTAX": {},
  "PHTAX": {},
  "TARIFF": {},
  "IRBM_Classification": 22,
  "STOCKMATRIX": {},
  "DEFUOM_ST": {},
  "DEFUOM_SL": {},
  "DEFUOM_PH": {},
  "SCRIPTCODE": {},
  "ISACTIVE": "T",
  "CREATIONDATE": "2024-08-08T00:00:00",
  "PICTURE": {},
  "PICTURECLASS": {},
  "ATTACHMENTS": {},
  "NOTE": {},
  "UOM": "UNIT",
  "REFCOST": 220,
  "REFPRICE": 6868,
  "ITEMTYPE": "-",
  "LEADTIME": 0,
  "BOM_LEADTIME": 0,
  "BOM_ASMCOST": 0,
  "BALSQTY": 10,
  "BALSUOMQTY": 0,
  "REMARK1": {},
  "REMARK2": {},
  "BARCODE": {},
  "LASTMODIFIED": 1741254748,
  "DIRTY": true,
  "sdsUOM": [
    "ISCT",
    "UNIT",
    1,
    220,
    6868,
    {},
    {},
    {},
    {},
    1
  ],
  "sdsOpeningBalance": [
    4,
    "ISCT",
    "----",
    "",
    "----",
    1000,
    10,
    0,
    220,
    2200,
    2200
  ],
  "sdsCustomerPrice": [
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "sdsSupplierPrice": [
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "sdsCategory": [
    {},
    {}
  ],
  "sdsBOM": [
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "sdsAltStockItem": [
    {},
    {},
    {}
  ],
  "sdsCustomerItem": [
    {},
    {},
    {},
    {},
    {}
  ],
  "sdsSupplierItem": [
    {},
    {},
    {},
    {},
    {}
  ],
  "sdsBarcode": [
    {},
    {},
    {},
    {}
  ]
}

Updates an existing business object

Request

Path

Body application/json

Responses200400

Body application/json

Body application/json

Responses