Retrieves details of a specific business object

Request

This API returns detailed information about a given business object.

Path

bizObjectNamestringrequired
The name of the business object

Example: AR_CUSTOMER

Responses

Returns application business object details

Body application/json

namenumber or string
Example: AR_PM
One of:
number
datasetsArray of objects (BizObjectInfoDataset)
Show 2 properties
- namenumber or string
  Example: MainDataSet
  One of:
  number
- fieldsArray of strings

get /api/app/biz-objects/{bizObjectName}

curl -X GET \
  https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/app/biz-objects/AR_CUSTOMER

const url = 'https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/app/biz-objects/AR_CUSTOMER';
const options = {method: 'GET'};

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/app/biz-objects/AR_CUSTOMER';
const options = {method: 'GET'};

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/app/biz-objects/AR_CUSTOMER"

response = requests.get(url)

print(response.json())

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/app/biz-objects/AR_CUSTOMER")
  .get()
  .build();

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://www.beehexa.com/_mock/api/sql-account-rest-api/customized-by-beehexa/api/app/biz-objects/AR_CUSTOMER"),
};
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/app/biz-objects/AR_CUSTOMER",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

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

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

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

}

Response

application/json

{
  "name": "AR_CUSTOMER",
  "datasets": [
    {
      "name": "MainDataSet",
      "fields": [
        "CODE",
        "CONTROLACCOUNT",
        "COMPANYNAME",
        "COMPANYNAME2",
        "COMPANYCATEGORY",
        "AREA",
        "AGENT",
        "BIZNATURE",
        "CREDITTERM",
        "CREDITLIMIT",
        "OVERDUELIMIT",
        "STATEMENTTYPE",
        "CURRENCYCODE",
        "OUTSTANDING",
        "ALLOWEXCEEDCREDITLIMIT",
        "ADDPDCTOCRLIMIT",
        "AGINGON",
        "PRICETAG",
        "CREATIONDATE",
        "TAX",
        "TAXEXEMPTNO",
        "TAXEXPDATE",
        "BRN",
        "BRN2",
        "GSTNO",
        "SALESTAXNO",
        "SERVICETAXNO",
        "TIN",
        "IDType",
        "IDNo",
        "TourismNo",
        "SIC",
        "SUBMISSIONTYPE",
        "IRBM_Classification",
        "PeppolID",
        "BusinessUnit",
        "TAXAREA",
        "ATTACHMENTS",
        "REMARK",
        "NOTE",
        "STATUS",
        "LASTMODIFIED",
        "DIRTY",
        "sdsBranch",
        "sdsCreditControl",
        "sdsBankAcc",
        "sdsTariff"
      ]
    },
    {
      "name": "cdsBranch",
      "fields": [
        "DTLKEY",
        "CODE",
        "BRANCHTYPE",
        "BRANCHNAME",
        "ADDRESS1",
        "ADDRESS2",
        "ADDRESS3",
        "ADDRESS4",
        "POSTCODE",
        "CITY",
        "STATE",
        "COUNTRY",
        "GEOCOORDINATE",
        "ATTENTION",
        "PHONE1",
        "PHONE2",
        "MOBILE",
        "FAX1",
        "FAX2",
        "EMAIL"
      ]
    },
    {
      "name": "cdsCreditControl",
      "fields": [
        "DTLKEY",
        "CODE",
        "DOCTYPE",
        "CONTROLTYPE",
        "SUSPENDMSG"
      ]
    },
    {
      "name": "cdsBankAcc",
      "fields": [
        "AUTOKEY",
        "CODE",
        "BANK",
        "ACCNO",
        "ACCNAME",
        "IDTYPE",
        "ID",
        "ISACTIVE",
        "GIRO",
        "REF"
      ]
    },
    {
      "name": "cdsTariff",
      "fields": [
        "AUTOKEY",
        "CODE",
        "TARIFF",
        "TAX",
        "ROWVER"
      ]
    }
  ]
}

Retrieves details of a specific business object

Request

Path

Responses200400

Body application/json

Body application/json

Responses