Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
https://<service base>/services/DataObjects/<Service DataObject Name>

Sample End Point

Code Block
https://<service base>/services/DataObjects/spGetCompanyAccountSummary

 

Headers

In order to receive search results, you must send the AptifyAuthorization header.

Header NameHeader Value
AptifyAuthorization<AuthType> <TokenId>

 

For the Above sample End point expect two parameters which are defined in Web service Application.The parameters are CompanyId and Convermulticurrency.

Parameters

ParameterQuery Param?DescriptionExample
CompanyIdYesID of Company10
ConvertmulticurrencyfalseBoolean value represent Convert Multi currencyfalse

 

 

Here is sample data from Company EntityEntity 

Code Block
titleURL
 https://<service base>/services/DataObjects/spGetCompanyAccountSummary?CompanyID=10&Convertmulticurrency=false

...

The search results are represented as a JSON array of JSON objects, where each object contains record data. The properties of the objects will be some of the fields of the record, always including the ID and Name field.

Here is sample result for above 

Code Block
titleSample Search Data
{
"dataObjectName":"spGetCompanyAccountSummary",
 "results":
	[
		{
			"OrderTotal":39414.6200,
			"PaymentTotal":4407.2000,
			"BalanceTotal":35007.4200
		}
	]
}