6/7/24, 15:42 Service Layer API Reference

Service Layer API Reference

This document is intended to provide all APIs exposed by Service Layer for users to reference during programming. The exposures covers all entities and actions. The API
follows OData 3.0 protocol, which defines a uniform REST way to manipulate service data, thus making it technically feasible for users to leverage OData libraries (e.g.
WCF) to consume data service provided by Service Layer.

Actions:
Actions are used to extend the set of operations that are able to be performed on services or entities. For example, the standard CRUD (create/read/update/delete)
operations cannot be applied to cancel a sales order, but cancel action defined on orders service allows to easily implement it. In SAP Business One, actions are defined in
the manner of business services.

AccountCategoryService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AccountCategoryService'.

POST AccountCategoryService_GetCategoryList

Invoke the method 'GetCategoryList' on this service.

Example

POST [Link]

AccountsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AccountsService'.

POST AccountsService_CreateOpenBalance

Invoke the method 'CreateOpenBalance' on this service by specifying the payload 'OpenningBalanceAccount,GLAccounts' in the JSON format.

Example

POST [Link]

{
"GLAccounts": {
"Code": "test"
},
"OpenningBalanceAccount": {
"Date": "2016-08-29"
}
}

AccrualTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AccrualTypesService'.

POST AccrualTypesService_GetAccrualTypeList

Invoke the method 'GetAccrualTypeList' on this service.

Example

POST [Link]

ActivitiesService

[Link] Layer API [Link] 1/334

6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ActivitiesService'.

POST ActivitiesService_GetActivityList
Invoke the method 'GetActivityList' on this service.

Example

POST [Link]

POST ActivitiesService_GetSingleInstanceFromSeries
Invoke the method 'GetSingleInstanceFromSeries' on this service by specifying the payload 'ActivityInstanceParams' in the JSON format.

Example

POST [Link]

{
"ActivityInstanceParams": {
"ActivityCode": "3",
"InstanceDate": "2016-08-30"
}
}

POST ActivitiesService_UpdateSingleInstanceInSeries
Invoke the method 'UpdateSingleInstanceInSeries' on this service by specifying the payload 'Activity' in the JSON format.

Example

POST [Link]

{
"Activity": {
"ActivityDate": "2016-08-30",
"ActivityTime": "08:13:00",
"CardCode": "C01",
"DocEntry": "3",
"DocNum": "1",
"DocType": "17",
"Duration": 15,
"DurationType": "du_Minuts",
"EndDueDate": "2016-08-30",
"EndTime": "08:28:00",
"Reminder": "tYES",
"ReminderPeriod": 15,
"ReminderType": "du_Minuts",
"StartDate": "2016-08-30",
"StartTime": "08:13:00"
}
}

POST ActivitiesService_DeleteSingleInstanceFromSeries
Invoke the method 'DeleteSingleInstanceFromSeries' on this service by specifying the payload 'ActivityInstanceParams' in the JSON format.

Example

POST [Link]

{
"ActivityInstanceParams": {
"ActivityCode": "3",
"InstanceDate": "2016-08-30"
}
}

POST ActivitiesService_GetTopNActivityInstances
Invoke the method 'GetTopNActivityInstances' on this service by specifying the payload 'ActivityInstancesListParams' in the JSON format.

Example

POST [Link]

[Link] Layer API [Link] 2/334

6/7/24, 15:42 Service Layer API Reference
"ActivityInstancesListParams": {
"ActivityInstancesListParams": {
"StartDate": "2016-08-30"
}
}
}

ActivityRecipientListsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ActivityRecipientListsService'.

POST ActivityRecipientListsService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

AlternativeItemsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AlternativeItemsService'.

POST AlternativeItemsService_AddItem

Invoke the method 'AddItem' on this service by specifying the payload 'OriginalItem' in the JSON format.

Example

POST [Link]

{
"OriginalItem": {
"AlternativeItems": [
{
"AlternativeItemCode": "B001",
"MatchFactor": 100,
"Remarks": "B001"
},
{
"AlternativeItemCode": "I002",
"MatchFactor": 100,
"Remarks": "I002"
},
{
"AlternativeItemCode": "I003",
"MatchFactor": 100,
"Remarks": "I003"
}
],
"ItemCode": "I001",
"ItemName": null
}
}

POST AlternativeItemsService_UpdateItem

Invoke the method 'UpdateItem' on this service by specifying the payload 'OriginalItem' in the JSON format.

Example

POST [Link]

{
"OriginalItem": {
"AlternativeItems": [
{
"AlternativeItemCode": "B001",
"MatchFactor": 100,
"Remarks": "B001"
},
{
"AlternativeItemCode": "I002",
"MatchFactor": 100,

[Link] Layer API [Link] 3/334

6/7/24, 15:42 Service Layer API Reference
"Remarks": "I002"
},
{
"AlternativeItemCode": "I003",
"MatchFactor": 100,
"Remarks": "I003"
}
],
"ItemCode": "I001",
"ItemName": null
}
}

POST AlternativeItemsService_DeleteItem
Invoke the method 'DeleteItem' on this service by specifying the payload 'OriginalItemParams' in the JSON format.

Example

POST [Link]

{
"OriginalItem": {
"ItemCode": "I001",
"ItemName": "I001"
}
}

POST AlternativeItemsService_GetItem
Invoke the method 'GetItem' on this service by specifying the payload 'OriginalItemParams' in the JSON format.

Example

POST [Link]

{
"OriginalItem": {
"ItemCode": "I001",
"ItemName": "I001"
}
}

ApprovalRequestsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ApprovalRequestsService'.

POST ApprovalRequestsService_GetApprovalRequestList

Invoke the method 'GetApprovalRequestList' on this service.

Example

POST [Link]

POST ApprovalRequestsService_GetOpenApprovalRequestList

Invoke the method 'GetOpenApprovalRequestList' on this service.

Example

POST [Link]

POST ApprovalRequestsService_GetAllApprovalRequestsList

Invoke the method 'GetAllApprovalRequestsList' on this service.

Example

POST [Link]

[Link] Layer API [Link] 4/334

6/7/24, 15:42 Service Layer API Reference

ApprovalStagesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ApprovalStagesService'.

POST ApprovalStagesService_GetApprovalStageList
Invoke the method 'GetApprovalStageList' on this service.

Example

POST [Link]

ApprovalTemplatesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ApprovalTemplatesService'.

POST ApprovalTemplatesService_GetApprovalTemplateList

Invoke the method 'GetApprovalTemplateList' on this service.

Example

POST [Link]

AssetCapitalizationCreditMemoService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetCapitalizationCreditMemoService'.

POST AssetCapitalizationCreditMemoService_Cancel

Invoke the method 'Cancel' on this service by specifying the payload 'AssetDocumentParams' in the JSON format.

Example

POST [Link]

{
"AssetDocumentParams": {
"CancellationOption": "coByCurrentSystemDate",
"Code": "1"
}
}

POST AssetCapitalizationCreditMemoService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

AssetCapitalizationService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetCapitalizationService'.

POST AssetCapitalizationService_Cancel
[Link] Layer API [Link] 5/334
6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Cancel' on this service by specifying the payload 'AssetDocumentParams' in the JSON format.

Example

POST [Link]

{
"AssetDocumentParams": {
"CancellationOption": "coByCurrentSystemDate",
"Code": "1"
}
}

POST AssetCapitalizationService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

AssetClassesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetClassesService'.

POST AssetClassesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

AssetDepreciationGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetDepreciationGroupsService'.

POST AssetDepreciationGroupsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

AssetGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetGroupsService'.

POST AssetGroupsService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

AssetManualDepreciationService
[Link] Layer API [Link] 6/334
6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetManualDepreciationService'.

POST AssetManualDepreciationService_Cancel
Invoke the method 'Cancel' on this service by specifying the payload 'AssetDocumentParams' in the JSON format.

Example

POST [Link]

{
"AssetDocumentParams": {
"CancellationOption": "coByCurrentSystemDate",
"Code": "2"
}
}

POST AssetManualDepreciationService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

AssetRetirementService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetRetirementService'.

POST AssetRetirementService_Cancel

Invoke the method 'Cancel' on this service by specifying the payload 'AssetDocumentParams' in the JSON format.

Example

POST [Link]

{
"AssetDocumentParams": {
"CancellationOption": "coByCurrentSystemDate",
"Code": "9"
}
}

POST AssetRetirementService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

AssetTransferService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AssetTransferService'.

POST AssetTransferService_Cancel

Invoke the method 'Cancel' on this service by specifying the payload 'AssetDocumentParams' in the JSON format.

Example

[Link] Layer API [Link] 7/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"AssetDocumentParams": {
"CancellationOption": "coByOriginalDocumentDate",
"Code": "2"
}
}

POST AssetTransferService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

AttributeGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'AttributeGroupsService'.

POST AttributeGroupsService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

BankChargesAllocationCodesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BankChargesAllocationCodesService'.

POST BankChargesAllocationCodesService_GetBankChargesAllocationCodeList

Invoke the method 'GetBankChargesAllocationCodeList' on this service.

Example

POST [Link]

BankStatementsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BankStatementsService'.

POST BankStatementsService_GetBankStatementList

Invoke the method 'GetBankStatementList' on this service by specifying the payload 'BankStatementsFilter' in the JSON format.

Example

POST [Link]

{
"BankStatementsFilter": {
"Account": "111",
"Bank": "10000000",
"Country": "DE"
}
}

[Link] Layer API [Link] 8/334

6/7/24, 15:42 Service Layer API Reference

BarCodesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BarCodesService'.

POST BarCodesService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

BinLocationAttributesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BinLocationAttributesService'.

POST BinLocationAttributesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

BinLocationFieldsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BinLocationFieldsService'.

POST BinLocationFieldsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

BinLocationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BinLocationsService'.

POST BinLocationsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

BlanketAgreementsService
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 9/334

6/7/24, 15:42 Service Layer API Reference
This API enables you to invoke the interfaces defined on 'BlanketAgreementsService'.

POST BlanketAgreementsService_GetBlanketAgreementList
Invoke the method 'GetBlanketAgreementList' on this service.

Example

POST [Link]

BOEDocumentTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BOEDocumentTypesService'.

POST BOEDocumentTypesService_GetBOEDocumentTypeList
Invoke the method 'GetBOEDocumentTypeList' on this service.

Example

POST [Link]

BOEInstructionsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BOEInstructionsService'.

POST BOEInstructionsService_GetBOEInstructionList

Invoke the method 'GetBOEInstructionList' on this service.

Example

POST [Link]

BOELinesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BOELinesService'.

POST BOELinesService_GetBOELine

Invoke the method 'GetBOELine' on this service by specifying the payload 'BOELineParams' in the JSON format.

Example

POST [Link]

{
"BOELineParams": {
"BOEKey": "1"
}
}

BOEPortfoliosService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BOEPortfoliosService'.

[Link] Layer API [Link] 10/334

6/7/24, 15:42 Service Layer API Reference
POST BOEPortfoliosService_GetBOEPortfolioList

Invoke the method 'GetBOEPortfolioList' on this service.

Example

POST [Link]

BPOpeningBalanceService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BPOpeningBalanceService'.

POST BPOpeningBalanceService_CreateOpenBalance

Invoke the method 'CreateOpenBalance' on this service by specifying the payload 'OpenningBalanceAccount,BPCodes' in the JSON format.

Example

POST [Link]

{
"BPCodes": [
{
"Code": "C01",
"Debit": "1000"
},
{
"Code": "V01",
"Debit": "1000"
}
],
"OpenningBalanceAccount": {
"Details": "Transfer balance to BP",
"OpenBalanceAccount": "999100"
}
}

BranchesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BranchesService'.

POST BranchesService_GetBranchList
Invoke the method 'GetBranchList' on this service.

Example

POST [Link]

BrazilBeverageIndexersService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BrazilBeverageIndexersService'.

POST BrazilBeverageIndexersService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

BrazilFuelIndexersService
[Link] Layer API [Link] 11/334
6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BrazilFuelIndexersService'.

POST BrazilFuelIndexersService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

BusinessPartnerPropertiesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BusinessPartnerPropertiesService'.

POST BusinessPartnerPropertiesService_GetBusinessPartnerPropertyList
Invoke the method 'GetBusinessPartnerPropertyList' on this service.

Example

POST [Link]

BusinessPartnersService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'BusinessPartnersService'.

POST BusinessPartnersService_CreateOpenBalance

Invoke the method 'CreateOpenBalance' on this service by specifying the payload 'OpenningBalanceAccount,BPCodes' in the JSON format.

Example

POST [Link]

{
"BPCodes": [
{
"Code": "HU1006",
"Credit": 300
},
{
"Code": "HU1007",
"Credit": 300
}
],
"OpenningBalanceAccount": {
"Date": "2016-09-19",
"Details": "Bp Accounts Opening Balance",
"OpenBalanceAccount": "_SYS00000000078"
}
}

CampaignResponseTypeService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CampaignResponseTypeService'.

POST CampaignResponseTypeService_GetResponseTypeList

Invoke the method 'GetResponseTypeList' on this service.

[Link] Layer API [Link] 12/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

CampaignsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CampaignsService'.

POST CampaignsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

CashDiscountsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CashDiscountsService'.

POST CashDiscountsService_GetCashDiscountList
Invoke the method 'GetCashDiscountList' on this service.

Example

POST [Link]

CashFlowLineItemsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CashFlowLineItemsService'.

POST CashFlowLineItemsService_GetCashFlowLineItemList

Invoke the method 'GetCashFlowLineItemList' on this service.

Example

POST [Link]

CertificateSeriesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CertificateSeriesService'.

POST CertificateSeriesService_GetCertificateSeriesList

Invoke the method 'GetCertificateSeriesList' on this service.

Example

POST [Link]

[Link] Layer API [Link] 13/334

6/7/24, 15:42 Service Layer API Reference

ChangeLogsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ChangeLogsService'.

POST ChangeLogsService_GetChangeLog
Invoke the method 'GetChangeLog' on this service by specifying the payload 'GetChangeLogParams' in the JSON format.

Example

POST [Link]

{
"GetChangeLogParams": {
"Object": "clPurchaseOrders",
"PrimaryKey": "7",
"UDOObjectCode": "3"
}
}

POST ChangeLogsService_GetChangeLogDifferences
Invoke the method 'GetChangeLogDifferences' on this service by specifying the payload 'ShowDifferenceParams' in the JSON format.

Example

POST [Link]

{
"ShowDifferenceParams": {
"LogInstance": 1,
"LogInstance2": 2,
"Object": "clPurchaseOrders",
"PrimaryKey": "7",
"UDOObjectCode": "3"
}
}

CheckLinesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CheckLinesService'.

POST CheckLinesService_GetCheckLine

Invoke the method 'GetCheckLine' on this service by specifying the payload 'CheckLineParams' in the JSON format.

Example

POST [Link]

{
"CheckLinesParams": [
{
"CheckKey": 1
}
]
}

POST CheckLinesService_GetValidCheckLineList

Invoke the method 'GetValidCheckLineList' on this service.

Example

POST [Link]

CockpitsService
Show/Hide
List Operations
[Link] Layer API [Link] 14/334
6/7/24, 15:42 Service Layer API Reference
Expand Operations

This API enables you to invoke the interfaces defined on 'CockpitsService'.

POST CockpitsService_GetCockpitList
Invoke the method 'GetCockpitList' on this service.

Example

POST [Link]

POST CockpitsService_PublishCockpit
Invoke the method 'PublishCockpit' on this service by specifying the payload 'Cockpit' in the JSON format.

Example

POST [Link]

{
"Cockpit": {}
}

POST CockpitsService_GetUserCockpitList
Invoke the method 'GetUserCockpitList' on this service.

Example

POST [Link]

POST CockpitsService_GetTemplateCockpitList
Invoke the method 'GetTemplateCockpitList' on this service.

Example

POST [Link]

CompanyService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CompanyService'.

POST CompanyService_GetCompanyInfo

Invoke the method 'GetCompanyInfo' on this service. It returns the 'CompanyInfo' data structure, including initial parameters related to the company.
The default values of some of the properties vary according to the country localization.

Example

POST [Link]

POST CompanyService_UpdateCompanyInfo

Invoke the method 'UpdateCompanyInfo' on this service by specifying the payload 'CompanyInfo' in the JSON format. It includes the initial parameters
related to the company. The default values of some of the properties vary according to the country localization.

Example

POST [Link]

{
"CompanyInfo": {
"EnableAccountSegmentation": "tYES",
"EnableExpensesManagement": "tYES",
"MaxRecordsInChooseFromList": 0,
"MinimumAmountForAnnualList": 0,

[Link] Layer API [Link] 15/334

6/7/24, 15:42 Service Layer API Reference
"MinimumAmountForAppndixOP": 0,
"MinimumBaseAmountPerDoc": 0,
"PercentOfTotalAcquisition": 0,
"Version": "910190"
}
}

POST CompanyService_GetAdminInfo
Invoke the method 'GetAdminInfo' on this service. It Returns the 'AdminInfo' data structure, including administration properties for system
initialization and various definitions, such as financials and banking.

Example

POST [Link]

POST CompanyService_UpdateAdminInfo
Invoke the method 'UpdateAdminInfo' on this service by specifying the payload 'AdminInfo' in the JSON format.

Example

POST [Link]

{
"AdminInfo": {
"CalculateBudget": "tYES",
"ChangeDefReconAPAccounts": "tYES",
"ChangeDefReconARAccounts": "tYES",
"ChartofAccountsTemplate": "C",
"Code": 1,
"CompanyName": "USTest",
"ContinuousStockManagement": "tYES",
"Country": "US",
"CreditBalancewithMinusSign": "tYES",
"DefaultWarehouse": "01",
"ExtendedAdminInfo": {},
"LocalCurrency": "$",
"MultiLanguageSupportEnable": "tYES",
"RoundingMethod": "tYES",
"SetItemsWarehouses": "tYES",
"SplitPO": "tYES",
"SystemCurrency": "$",
"UniqueSerialNo": "usn_MfrSerialNumber"
}
}

POST CompanyService_CreatePeriod
Invoke the method 'CreatePeriod' on this service by specifying the payload 'PeriodCategory' in the JSON format. It returns the 'PeriodCategoryParams'
identification key based on the 'PeriodCategory' data structure. The 'PeriodCategory' object provides two types of properties: [Link] that access
existing Accounts and function as foreign keys to the ChartOfAccounts object. [Link] that define new accounts by using Posting and Sub-Period
definitions.

Example

POST [Link]

{
"PeriodCategory": {
"BeginningofFinancialYear": "2010-01-01",
"NumberOfPeriods": 1,
"PeriodCategory": "2010",
"PeriodName": "2010",
"SubPeriodType": "spt_Year"
}
}

POST CompanyService_GetPeriods
Invoke the method 'GetPeriods' on this service. It returns the 'PeriodCategoryParamsCollection', which is a collection of 'PeriodCategoryParams'
identification keys.

Example

POST [Link]

POST CompanyService_GetPeriod

[Link] Layer API [Link] 16/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'GetPeriod' on this service by specifying the payload 'PeriodCategoryParams' in the JSON format. It returns the 'PeriodCategory'
data structure according to the specified period category key parameters. The 'PeriodCategory' object provides two types of properties: [Link] that
access existing Accounts and function as foreign keys to the ChartOfAccounts object. [Link] that define new accounts by using Posting and Sub-
Period definitions.

Example

POST [Link]

{
"PeriodCategoryParams": {}
}

POST CompanyService_UpdatePeriod

Invoke the method 'UpdatePeriod' on this service by specifying the payload 'PeriodCategory' in the JSON format.

Example

POST [Link]

{
"PeriodCategory": {
"AbsoluteEntry": 1,
"AccountforCashReceipt": "_SYS00000000003",
"BeginningofFinancialYear": "2015-01-01",
"NumberOfPeriods": 12,
"PeriodCategory": "2015",
"SubPeriodType": "spt_Months"
}
}

POST CompanyService_GetFinancePeriods

Invoke the method 'GetFinancePeriods' on this service by specifying the payload 'PeriodCategoryParams' in the JSON format. It returns the
'FinancePeriods' collection according to the specified period category key parameters. The object is used to identify and define a new 'FinancePeriods'.

Example

POST [Link]

{
"PeriodCategoryParams": {
"AbsoluteEntry": 1
}
}

POST CompanyService_GetFinancePeriod

Invoke the method 'GetFinancePeriod' on this service by specifying the payload 'FinancePeriodParams' in the JSON format. It returns a 'FinancePeriod'
data structure according to the specified finance period key parameters. The object is used to identify and define a new 'FinancePeriod'.

Example

POST [Link]

{
"FinancePeriodParams": {}
}

POST CompanyService_UpdateFinancePeriod

Invoke the method 'UpdateFinancePeriod' on this service by specifying the payload 'FinancePeriod' in the JSON format.

Example

POST [Link]

{
"FinancePeriod": {
"AbsoluteEntry": 6,
"ActiveforFeed": "tNO",
"PeriodCode": "2015-06",
"PeriodName": "2015-06",
"PostingDateFrom": "2015-06-01",
"PostingDateTo": "2015-06-30",
"TaxDateFrom": "2015-01-01",
"TaxDateTo": "2015-12-31",
"ValueDateFrom": "2015-01-01",
"ValueDateTo": "2015-12-31"
}
}

[Link] Layer API [Link] 17/334

6/7/24, 15:42 Service Layer API Reference
POST CompanyService_RemoveFinancePeriod

Invoke the method 'RemoveFinancePeriod' on this service by specifying the payload 'FinancePeriodParams' in the JSON format.

Example

POST [Link]

{
"FinancePeriods": [
{
"AbsoluteEntry": "1"
}
]
}

POST CompanyService_CreatePeriodWithFinanceParams

Invoke the method 'CreatePeriodWithFinanceParams' on this service by specifying the payload 'PeriodCategory' in the JSON format. It returns a
'PeriodCategoryParams' identification key, extended with finance parameters derived by the 'FinancePeriodParams' identification key (system number,
period indicator). The PeriodCategory object provides two types of properties: [Link] that access existing Accounts and function as foreign keys
to the 'ChartOfAccounts' object. [Link] that define new accounts by using Posting and Sub-Period definitions. The 'FinancePeriodParams'
specifies the identification key(system number, period indicator ) to which the 'CompanyService' is related.

Example

POST [Link]

{
"FinancePeriodParams": {
"PeriodIndicator": "Default"
},
"PeriodCategory": {
"BeginningofFinancialYear": "2010-01-01",
"NumberOfPeriods": 1,
"PeriodCategory": "2010",
"PeriodName": "2010",
"SubPeriodType": "spt_Year"
}
}

POST CompanyService_GetFeaturesStatus

Invoke the method 'GetFeaturesStatus' on this service. It returns the 'FeatureStatusCollection'. A feature status can be either blocked or not. This object
represents the status of a specified feature in the application, whether it is blocked or not according to the installation type: new 2007 release installation
or upgrade installation prior to 2007 release.

Example

POST [Link]

POST CompanyService_GetPathAdmin

Invoke the method 'GetPathAdmin' on this service.

Example

POST [Link]

POST CompanyService_UpdatePathAdmin

Invoke the method 'UpdatePathAdmin' on this service by specifying the payload 'PathAdmin' in the JSON format.

Example

POST [Link]

{
"PathAdmin": {
"AttachmentsFolderPath": "/usr/sap/SAPBusinessOne/ServiceLayer/modules",
"ExtensionsFolderPath": null,
"PicturesFolderPath": null,
"PrintId": "USBO",
"WordTemplateFolderPath": null
}
}

POST CompanyService_RoundDecimal
[Link] Layer API [Link] 18/334
6/7/24, 15:42 Service Layer API Reference
Invoke the method 'RoundDecimal' on this service by specifying the payload 'DecimalData' in the JSON format. It rounds data to a specified number of
decimal places or to a whole number if no decimal places are specified.

Example

POST [Link]

{
"DecimalData": {
"Context": "rcPrice",
"Currency": "$",
"Value": 12.345
}
}

POST CompanyService_GetItemPrice

Invoke the method 'GetItemPrice' on this service by specifying the payload 'ItemPriceParams' in the JSON format. It returns a business object that
contains the item price for specified business partner and item, based on the amount and transaction date.

Example

POST [Link]

{
"ItemPriceParams": {
"CardCode": "Customer",
"ItemCode": "Item"
}
}

POST CompanyService_GetAdvancedGLAccount

Invoke the method 'GetAdvancedGLAccount' on this service by specifying the payload 'AdvancedGLAccountParams' in the JSON format.

Example

POST [Link]

{
"AdvancedGLAccountParams": {}
}

CorrectionInvoiceReversalService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CorrectionInvoiceReversalService'.

POST CorrectionInvoiceReversalService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"Comments": "add correction invoice reversal based on correction invoice",
"DocDate": "2014-12-06",
"DocDueDate": "2014-12-06",
"InternalCorrectedDocNum": "10"
}
}

POST CorrectionInvoiceReversalService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

CorrectionInvoiceService
[Link] Layer API [Link] 19/334
6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CorrectionInvoiceService'.

POST CorrectionInvoiceService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"Comments": "Added by Service Layer",
"DocumentLines": [
{
"CorrectionInvoiceItem": "ciis_ShouldBe",
"ItemCode": "item01",
"Price": "310",
"Quantity": "10",
"VatGroup": "B4"
},
{
"CorrectionInvoiceItem": "ciis_Was",
"ItemCode": "item01",
"Price": "110",
"Quantity": "10",
"VatGroup": "B4"
}
]
}
}

POST CorrectionInvoiceService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

CorrectionPurchaseInvoiceReversalService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CorrectionPurchaseInvoiceReversalService'.

POST CorrectionPurchaseInvoiceReversalService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "v001",
"Comments": "add correction invoice reversal based on correction invoice",
"DocDate": "2014-12-06",
"DocDueDate": "2014-12-06",
"InternalCorrectedDocNum": "8"
}
}

POST CorrectionPurchaseInvoiceReversalService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

[Link] Layer API [Link] 20/334

6/7/24, 15:42 Service Layer API Reference

CorrectionPurchaseInvoiceService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CorrectionPurchaseInvoiceService'.

POST CorrectionPurchaseInvoiceService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "v001",
"Comments": "Added by Service Layer",
"DocumentLines": [
{
"CorrectionInvoiceItem": "ciis_ShouldBe",
"ItemCode": "item01",
"Price": "310",
"Quantity": "10",
"VatGroup": "B4"
},
{
"CorrectionInvoiceItem": "ciis_Was",
"ItemCode": "item01",
"Price": "110",
"Quantity": "10",
"VatGroup": "B4"
}
]
}
}

POST CorrectionPurchaseInvoiceService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

CostCenterTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CostCenterTypesService'.

POST CostCenterTypesService_GetCostCenterTypeList

Invoke the method 'GetCostCenterTypeList' on this service.

Example

POST [Link]

CostElementService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CostElementService'.

POST CostElementService_GetCostElementList

Invoke the method 'GetCostElementList' on this service.

Example

[Link] Layer API [Link] 21/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

CountriesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CountriesService'.

POST CountriesService_GetCountryList
Invoke the method 'GetCountryList' on this service.

Example

POST [Link]

CreditLinesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CreditLinesService'.

POST CreditLinesService_GetCreditLine

Invoke the method 'GetCreditLine' on this service by specifying the payload 'CreditLineParams' in the JSON format.

Example

POST [Link]

{
"CreditLinesParams": [
{
"AbsId": 1
}
]
}

POST CreditLinesService_GetValidCreditLineList

Invoke the method 'GetValidCreditLineList' on this service.

Example

POST [Link]

CreditNotesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CreditNotesService'.

POST CreditNotesService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Price": 100,
"Quantity": 1,
"TaxCode": "T1"

[Link] Layer API [Link] 22/334

6/7/24, 15:42 Service Layer API Reference
}
]
}
}

POST CreditNotesService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

POST CreditNotesService_RequestApproveCancellation
Invoke the method 'RequestApproveCancellation' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"DocEntry": "123"
}
}

CycleCountDeterminationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'CycleCountDeterminationsService'.

POST CycleCountDeterminationsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

DashboardPackagesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DashboardPackagesService'.

POST DashboardPackagesService_ImportDashboardPackage

Invoke the method 'ImportDashboardPackage' on this service by specifying the payload 'DashboardPackageImportParams' in the JSON format.

Example

POST [Link]

{
"DashboardPackageImportParams": {}
}

DeductionTaxSubGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DeductionTaxSubGroupsService'.

POST DeductionTaxSubGroupsService_GetDeductionTaxSubGroupList

Invoke the method 'GetDeductionTaxSubGroupList' on this service.

[Link] Layer API [Link] 23/334
6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

DeliveryNotesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DeliveryNotesService'.

POST DeliveryNotesService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}
}

POST DeliveryNotesService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

DepartmentsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DepartmentsService'.

POST DepartmentsService_GetDepartmentList
Invoke the method 'GetDepartmentList' on this service.

Example

POST [Link]

DepositsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DepositsService'.

POST DepositsService_GetDepositList

Invoke the method 'GetDepositList' on this service.

Example

POST [Link]

[Link] Layer API [Link] 24/334

6/7/24, 15:42 Service Layer API Reference

POST DepositsService_CancelCheckRow
Invoke the method 'CancelCheckRow' on this service by specifying the payload 'CancelCheckRowParams' in the JSON format.

Example

POST [Link]

{
"CancelCheckRowParams": {
"CheckID": 1,
"DepositID": 11
}
}

POST DepositsService_CancelCheckRowbyCurrentSystemDate
Invoke the method 'CancelCheckRowbyCurrentSystemDate' on this service by specifying the payload 'CancelCheckRowParams' in the JSON format.

Example

POST [Link]

{
"CancelCheckRowParams": {
"CheckID": 2,
"DepositID": 11
}
}

DepreciationAreasService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DepreciationAreasService'.

POST DepreciationAreasService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

DepreciationTypePoolsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DepreciationTypePoolsService'.

POST DepreciationTypePoolsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

DepreciationTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DepreciationTypesService'.

POST DepreciationTypesService_GetList

Invoke the method 'GetList' on this service.

[Link] Layer API [Link] 25/334
6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

DeterminationCriteriasService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DeterminationCriteriasService'.

POST DeterminationCriteriasService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

DimensionsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DimensionsService'.

POST DimensionsService_GetDimensionList
Invoke the method 'GetDimensionList' on this service.

Example

POST [Link]

DistributionRulesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DistributionRulesService'.

POST DistributionRulesService_GetDistributionRuleList

Invoke the method 'GetDistributionRuleList' on this service.

Example

POST [Link]

DNFCodeSetupService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DNFCodeSetupService'.

POST DNFCodeSetupService_GetDNFCodeSetupList

Invoke the method 'GetDNFCodeSetupList' on this service.

Example

POST [Link]

[Link] Layer API [Link] 26/334

6/7/24, 15:42 Service Layer API Reference

DownPaymentsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DownPaymentsService'.

POST DownPaymentsService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
],
"DownPaymentType": "dptInvoice"
}

POST DownPaymentsService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

DraftsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DraftsService'. It represents the preliminary version of a document or report.

POST DraftsService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocObjectCode": "23",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}
}

POST DraftsService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

POST DraftsService_SaveDraftToDocument

[Link] Layer API [Link] 27/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'SaveDraftToDocument' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"DocDueDate": "2017-01-28",
"DocEntry": "3"
}
}

DunningTermsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'DunningTermsService'.

POST DunningTermsService_GetDunningTermList

Invoke the method 'GetDunningTermList' on this service.

Example

POST [Link]

ElectronicCommunicationActionService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ElectronicCommunicationActionService'. This API is deprecated while
'ElectronicCommunicationActionsService' is recommended. As such, this object would be removed and not exposed in the future patches.

POST ElectronicCommunicationActionService_GetAction

Invoke the method 'GetAction' on this service by specifying the payload 'ECMCodeParams' in the JSON format.

Example

POST [Link]

{
"ECMCodeParams": {}
}

POST ElectronicCommunicationActionService_UpdateAction

Invoke the method 'UpdateAction' on this service by specifying the payload 'ECMActionStatusData' in the JSON format.

Example

POST [Link]

{
"ECMActionStatusData": {}
}

POST ElectronicCommunicationActionService_ConfirmSuccessOfCommunication

Invoke the method 'ConfirmSuccessOfCommunication' on this service by specifying the payload 'ECMCodeParams' in the JSON format.

Example

POST [Link]

{
"ECMCodeParams": {}
}

POST ElectronicCommunicationActionService_ReportErrorAndContinue

[Link] Layer API [Link] 28/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'ReportErrorAndContinue' on this service by specifying the payload 'ECMCodeParams' in the JSON format.

Example

POST [Link]

{
"ECMCodeParams": {}
}

POST ElectronicCommunicationActionService_ReportErrorAndStop

Invoke the method 'ReportErrorAndStop' on this service by specifying the payload 'ECMCodeParams' in the JSON format.

Example

POST [Link]

{
"ECMCodeParams": {}
}

ElectronicCommunicationActionsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ElectronicCommunicationActionsService'. This API depends on EFM runtime.

POST ElectronicCommunicationActionsService_GetEcmAction

Invoke the method 'GetEcmAction' on this service by specifying the payload 'EcmActionParams' in the JSON format.

Example

POST [Link]

{
"EcmActionParams": {}
}

POST ElectronicCommunicationActionsService_AddEcmAction

Invoke the method 'AddEcmAction' on this service by specifying the payload 'EcmAction' in the JSON format.

Example

POST [Link]

{
"EcmAction": {}
}

POST ElectronicCommunicationActionsService_UpdateEcmAction

Invoke the method 'UpdateEcmAction' on this service by specifying the payload 'EcmAction' in the JSON format.

Example

POST [Link]

{
"EcmAction": {}
}

POST ElectronicCommunicationActionsService_DeleteEcmAction

Invoke the method 'DeleteEcmAction' on this service by specifying the payload 'EcmAction' in the JSON format.

Example

POST [Link]

{
"EcmAction": {}
}

[Link] Layer API [Link] 29/334

6/7/24, 15:42 Service Layer API Reference
POST ElectronicCommunicationActionsService_GetEcmActionByDoc

Invoke the method 'GetEcmActionByDoc' on this service by specifying the payload 'EcmActionDocParams' in the JSON format.

Example

POST [Link]

{
"EcmActionDocParams": {}
}

POST ElectronicCommunicationActionsService_GetEcmActionLogList

Invoke the method 'GetEcmActionLogList' on this service by specifying the payload 'EcmAction' in the JSON format.

Example

POST [Link]

{
"EcmAction": {}
}

POST ElectronicCommunicationActionsService_GetEcmActionLog

Invoke the method 'GetEcmActionLog' on this service by specifying the payload 'EcmActionLogParams' in the JSON format.

Example

POST [Link]

{
"EcmActionLogParams": {}
}

POST ElectronicCommunicationActionsService_AddEcmActionLog

Invoke the method 'AddEcmActionLog' on this service by specifying the payload 'EcmActionLog' in the JSON format.

Example

POST [Link]

{
"EcmActionLog": {}
}

ElectronicFileFormatsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ElectronicFileFormatsService'.

POST ElectronicFileFormatsService_GetElectronicFileFormatList
Invoke the method 'GetElectronicFileFormatList' on this service.

Example

POST [Link]

EmailGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'EmailGroupsService'.

POST EmailGroupsService_GetList

Invoke the method 'GetList' on this service.

[Link] Layer API [Link] 30/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

EmployeeIDTypeService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'EmployeeIDTypeService'.

POST EmployeeIDTypeService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

EmployeePositionService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'EmployeePositionService'.

POST EmployeePositionService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

EmployeeRolesSetupService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'EmployeeRolesSetupService'.

POST EmployeeRolesSetupService_GetEmployeeRoleSetupList

Invoke the method 'GetEmployeeRoleSetupList' on this service.

Example

POST [Link]

EmployeeStatusService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'EmployeeStatusService'.

POST EmployeeStatusService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

[Link] Layer API [Link] 31/334

6/7/24, 15:42 Service Layer API Reference

EmployeeTransfersService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'EmployeeTransfersService'.

POST EmployeeTransfersService_GetEmployeeTransferList
Invoke the method 'GetEmployeeTransferList' on this service.

Example

POST [Link]

EnhancedDiscountGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'EnhancedDiscountGroupsService'.

POST EnhancedDiscountGroupsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

ExtendedTranslationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ExtendedTranslationsService'.

POST ExtendedTranslationsService_GetExtendedTranslationList

Invoke the method 'GetExtendedTranslationList' on this service.

Example

POST [Link]

ExternalCallsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ExternalCallsService'.

POST ExternalCallsService_SendCall

Invoke the method 'SendCall' on this service by specifying the payload 'ExternalCall' in the JSON format.

Example

POST [Link]

{
"ExternalCall": {}
}

POST ExternalCallsService_UpdateCall

Invoke the method 'UpdateCall' on this service by specifying the payload 'ExternalCall' in the JSON format.

[Link] Layer API [Link] 32/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"ExternalCall": {}
}

POST ExternalCallsService_GetCall

Invoke the method 'GetCall' on this service by specifying the payload 'ExternalCallParams' in the JSON format.

Example

POST [Link]

{
"ExternalCallParams": {}
}

ExternalReconciliationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ExternalReconciliationsService'.

POST ExternalReconciliationsService_Reconcile
Invoke the method 'Reconcile' on this service by specifying the payload 'ExternalReconciliation' in the JSON format.

Example

POST [Link]

{
"ExternalReconciliation": {
"ReconciliationAccountType": "rat_BusinessPartner",
"ReconciliationBankStatementLines": [
{
"BankStatementAccountCode": "C1",
"Sequence": 1
},
{
"BankStatementAccountCode": "C1",
"Sequence": 2
}
],
"ReconciliationJournalEntryLines": [
{
"LineNumber": 1,
"TransactionNumber": 1
},
{
"LineNumber": 2,
"TransactionNumber": 2
}
]
}
}

POST ExternalReconciliationsService_GetReconciliation
Invoke the method 'GetReconciliation' on this service by specifying the payload 'ExternalReconciliationParams' in the JSON format. It retrieves an
external reconciliation.

Example

POST [Link]

{
"ExternalReconciliationParams": {
"AccountCode": "_SYS00000000001",
"ReconciliationNo": 1
}
}

POST ExternalReconciliationsService_CancelReconciliation
Invoke the method 'CancelReconciliation' on this service by specifying the payload 'ExternalReconciliationParams' in the JSON format.

[Link] Layer API [Link] 33/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"ExternalReconciliationParams": {
"AccountCode": "_SYS00000000001",
"ReconciliationNo": 1
}
}

POST ExternalReconciliationsService_GetReconciliationList

Invoke the method 'GetReconciliationList' on this service by specifying the payload 'ExternalReconciliationFilterParams' in the JSON format. It returns
the 'ExternalReconciliationsParamsCollection' data collection that identifies all eternal reconciliations with the optional filter payload.

Example

POST [Link]

POST [Link]

{
"ExternalReconciliationFilterParams": {
"AccountCodeFrom": "_SYS00000000001",
"AccountCodeTo": "_SYS00000000002",
"ReconciliationAccountType": "rat_GLAccount",
"ReconciliationDateFrom": "2016-05-03",
"ReconciliationDateTo": "2016-12-03",
"ReconciliationNoFrom": 1,
"ReconciliationNoTo": 2
}
}

FAAccountDeterminationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'FAAccountDeterminationsService'.

POST FAAccountDeterminationsService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

FinancialYearsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'FinancialYearsService'.

POST FinancialYearsService_GetFinancialYearList
Invoke the method 'GetFinancialYearList' on this service.

Example

POST [Link]

FiscalPrinterService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'FiscalPrinterService'.

POST FiscalPrinterService_GetFiscalPrinterList

[Link] Layer API [Link] 34/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'GetFiscalPrinterList' on this service.

Example

POST [Link]

FixedAssetItemsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'FixedAssetItemsService'.

POST FixedAssetItemsService_GetAssetValuesList

Invoke the method 'GetAssetValuesList' on this service by specifying the payload 'FixedAssetValuesParams' in the JSON format.

Example

POST [Link]

{
"FixedAssetValuesParams": {}
}

POST FixedAssetItemsService_GetAssetEndBalance

Invoke the method 'GetAssetEndBalance' on this service by specifying the payload 'FixedAssetValuesParams' in the JSON format.

Example

POST [Link]

{
"FixedAssetValuesParams": {}
}

POST FixedAssetItemsService_UpdateAssetEndBalance

Invoke the method 'UpdateAssetEndBalance' on this service by specifying the payload 'FixedAssetValuesParams,FixedAssetEndBalance' in the JSON
format.

Example

POST [Link]

{
"FixedAssetEndBalance": {},
"FixedAssetValuesParams": {}
}

GLAccountAdvancedRulesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'GLAccountAdvancedRulesService'.

POST GLAccountAdvancedRulesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

GoodsReturnRequestService
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 35/334

6/7/24, 15:42 Service Layer API Reference
This API enables you to invoke the interfaces defined on 'GoodsReturnRequestService'.

POST GoodsReturnRequestService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST GoodsReturnRequestService_Preview
Invoke the method 'Preview' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST GoodsReturnRequestService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

GovPayCodesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'GovPayCodesService'.

POST GovPayCodesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

GTIsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'GTIsService'.

[Link] Layer API [Link] 36/334

6/7/24, 15:42 Service Layer API Reference
POST GTIsService_Import

Invoke the method 'Import' on this service by specifying the payload 'GTIParams' in the JSON format.

Example

POST [Link]

{
"GTIParams": {}
}

IntegrationPackagesConfigureService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'IntegrationPackagesConfigureService'.

POST IntegrationPackagesConfigureService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

InternalReconciliationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InternalReconciliationsService'.

POST InternalReconciliationsService_GetOpenTransactions
Invoke the method 'GetOpenTransactions' on this service by specifying the payload 'InternalReconciliationOpenTransParams' in the JSON format.

Example

POST [Link]

{
"InternalReconciliationOpenTransParams": {
"CardOrAccount": "coaCard",
"InternalReconciliationBPs": [
{
"BPCode": "v01"
}
],
"ReconDate": "2017-11-15"
}
}

POST InternalReconciliationsService_Cancel
Invoke the method 'Cancel' on this service by specifying the payload 'InternalReconciliationParams' in the JSON format.

Example

POST [Link]

{
"InternalReconciliationParams": {
"ReconNum": "4"
}
}

POST InternalReconciliationsService_RequestApproveCancellation
Invoke the method 'RequestApproveCancellation' on this service by specifying the payload 'InternalReconciliationParams' in the JSON format.

Example

[Link] Layer API [Link] 37/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"InternalReconciliationParams": {
"ReconNum": "4"
}
}

IntrastatConfigurationService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'IntrastatConfigurationService'.

POST IntrastatConfigurationService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

InventoryCountingsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InventoryCountingsService'.

POST InventoryCountingsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

InventoryGenEntryService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InventoryGenEntryService'.

POST InventoryGenEntryService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"UnitPrice": "1"
}
]
}
}

POST InventoryGenEntryService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

[Link] Layer API [Link] 38/334

6/7/24, 15:42 Service Layer API Reference

InventoryGenExitService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InventoryGenExitService'.

POST InventoryGenExitService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100"
}
]
}
}

POST InventoryGenExitService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

InventoryOpeningBalancesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InventoryOpeningBalancesService'.

POST InventoryOpeningBalancesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

InventoryPostingsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InventoryPostingsService'.

POST InventoryPostingsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

POST InventoryPostingsService_SetCopyOption

Invoke the method 'SetCopyOption' on this service by specifying the payload 'InventoryPostingCopyOption' in the JSON format.

[Link] Layer API [Link] 39/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"InventoryPostingCopyOption": {}
}

InventoryTransferRequestsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InventoryTransferRequestsService'.

POST InventoryTransferRequestsService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'StockTransfer' in the JSON format.

Example

POST [Link]

{
"StockTransfer": {
"StockTransferLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"UnitPrice": "100",
"WarehouseCode": "w001"
}
]
}
}

POST InventoryTransferRequestsService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

InvoicesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'InvoicesService'.

POST InvoicesService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}
}

POST InvoicesService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

[Link] Layer API [Link] 40/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

POST InvoicesService_RequestApproveCancellation

Invoke the method 'RequestApproveCancellation' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"DocEntry": "123"
}
}

JournalEntryDocumentTypeService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'JournalEntryDocumentTypeService'.

POST JournalEntryDocumentTypeService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

JournalVouchersService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'JournalVouchersService'.

POST JournalVouchersService_Add
Invoke the method 'Add' on this service by specifying the payload 'Collection(JournalEntry)' in the JSON format.

Example

POST [Link]

{
"JournalVoucher": {
"JournalEntry": {
"DueDate": "2014-12-06",
"JournalEntryLines": [
{
"AccountCode": "_SYS00000000094",
"Credit": "0",
"Debit": "123"
},
{
"AccountCode": "_SYS00000000019",
"Credit": "123",
"Debit": "0"
}
],
"ReferenceDate": "2014-12-06"
}
}
}

KPIsService
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 41/334

6/7/24, 15:42 Service Layer API Reference
This API enables you to invoke the interfaces defined on 'KPIsService'.

POST KPIsService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

LandedCostsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'LandedCostsService'.

POST LandedCostsService_GetLandedCostList
Invoke the method 'GetLandedCostList' on this service.

Example

POST [Link]

LicenseService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'LicenseService'.

POST LicenseService_GetInstallationNumber

Invoke the method 'GetInstallationNumber' on this service.

Example

POST [Link]

Login
Show/Hide
List Operations
Expand Operations

Log in Service Layer with the specified credentials. Generally it is the first step to using the Service Layer API. Calling the Service Layer API without a login will
result in failure. After logging in successfully, one session ID will be returned in HTTP response body. At the same time, two HTTP cookie items named
"B1SESSION" and "ROUTEID" will be set. You do not need to relate to them if calling the Service Layer API in a browser because the browser will send them to
Service Layer automatically in subsequent HTTP requests. You do need to add them to your HTTP header in a subsequent Service Layer API call. Otherwise,
Service Layer will consider them as a bad request without a login.

POST Login

Login Service Layer with the specified credentials.

Example

POST [Link]

{
"CompanyDB": "SBODEMOUS",
"Password": "1234",
"UserName": "manager"
}

Logout
Show/Hide
List Operations

[Link] Layer API [Link] 42/334

6/7/24, 15:42 Service Layer API Reference
Expand Operations

By default, a login session will expire and the user will be logged out automatically if there is no new request within 30 minutes. You can change the default expire
time by modifying the value of the "SessionTimeout" property in file "{USER_INSTALL_DIR}/ServiceLayer/conf/[Link]". Here, "{USER_INSTALL_DIR}"
stands for the installation folder.

POST Logout
Logout.

Example

POST [Link]

MaterialGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'MaterialGroupsService'.

POST MaterialGroupsService_GetMaterialGroupList
Invoke the method 'GetMaterialGroupList' on this service.

Example

POST [Link]

MaterialRevaluationFIFOService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'MaterialRevaluationFIFOService'.

POST MaterialRevaluationFIFOService_GetMaterialRevaluationFIFO

Invoke the method 'GetMaterialRevaluationFIFO' on this service by specifying the payload 'MaterialRevaluationFIFOParams' in the JSON format.

Example

POST [Link]

{
"MaterialRevaluationFIFOParams": {
"ItemCode": "I001",
"LocationCode": null,
"LocationType": null,
"ShowIssuedLayers": "tNO"
}
}

MaterialRevaluationSNBService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'MaterialRevaluationSNBService'.

POST MaterialRevaluationSNBService_GetList

Invoke the method 'GetList' on this service by specifying the payload 'MaterialRevaluationSNBParam' in the JSON format.

Example

POST [Link]

{
"MaterialRevaluationSNBParam": {}
}

[Link] Layer API [Link] 43/334

6/7/24, 15:42 Service Layer API Reference

MessagesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'MessagesService'. To be specific, this service enables to manage the inbox and outbox messages, and to
send messages.

POST MessagesService_GetInbox
Invoke the method 'GetInbox' on this service.

Example

POST [Link]

POST MessagesService_GetOutbox
Invoke the method 'GetOutbox' on this service.

Example

POST [Link]

POST MessagesService_GetSentMessages
Invoke the method 'GetSentMessages' on this service.

Example

POST [Link]

MobileAddOnSettingService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'MobileAddOnSettingService'.

POST MobileAddOnSettingService_GetMobileAddOnSettingList

Invoke the method 'GetMobileAddOnSettingList' on this service.

Example

POST [Link]

MobileAppService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'MobileAppService'.

POST MobileAppService_GetCurrentServerDateTime

Invoke the method 'GetCurrentServerDateTime' on this service.

Example

POST [Link]

POST MobileAppService_GetDppChangeParams

Invoke the method 'GetDppChangeParams' on this service by specifying the payload 'DppChangeParams' in the JSON format.

[Link] Layer API [Link] 44/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"DppChangeParams": {
"FromDate": "2018-03-30",
"FromTime": "17:30:00"
}
}

POST MobileAppService_GetTechnicianSchedulings

Invoke the method 'GetTechnicianSchedulings' on this service by specifying the payload 'TechnicianSchedulingsParams' in the JSON format.

Example

POST [Link]

{
"TechnicianSchedulingsParams": {
"EndDate": "2017-12-31",
"StartDate": "2017-08-10",
"Technician": "2"
}
}

POST MobileAppService_GetEmployeeFullNames

Invoke the method 'GetEmployeeFullNames' on this service by specifying the payload 'EmployeeFullNamesParamsCollection' in the JSON format.

Example

POST [Link]

{
"EmployeeFullNamesParamsCollection": [
{
"EmployeeFullName": "",
"EmployeeID": 2
},
{
"EmployeeFullName": "",
"EmployeeID": 3
}
]
}

POST MobileAppService_GetTechnicianSettings

Invoke the method 'GetTechnicianSettings' on this service by specifying the payload 'TechnicianSettingsParams' in the JSON format.

Example

POST [Link]

{
"TechnicianSettingsParams": {}
}

POST MobileAppService_UpdateTechnicianSettings

Invoke the method 'UpdateTechnicianSettings' on this service by specifying the payload 'TechnicianSettings' in the JSON format.

Example

POST [Link]

{
"TechnicianSettings": {}
}

POST MobileAppService_GetTechnicianSettingsGroup

Invoke the method 'GetTechnicianSettingsGroup' on this service.

Example

POST [Link]

[Link] Layer API [Link] 45/334

6/7/24, 15:42 Service Layer API Reference
"TechnicianSettingsGroupParams": {
"Code": -1,
"Name": "TEST1"
}
}

POST MobileAppService_UpdateTechnicianSettingsGroup
Invoke the method 'UpdateTechnicianSettingsGroup' on this service by specifying the payload 'TechnicianSettingsGroup' in the JSON format.

Example

POST [Link]

{
"AdvancedDashBoard": -4,
"Code": -1,
"CustomizedGroup": "tNO",
"EnableActualDuration": "tNO",
"EnableEditTime": "tNO",
"EnableFollowup": "tNO",
"EnableReject": "tNO",
"EnableResign": "tNO",
"EnableSignature": "tNO",
"EnableStarRating": "tNO",
"Name": "TESTCODE-1"
}

POST MobileAppService_GetSalesAppSetting
Invoke the method 'GetSalesAppSetting' on this service.

Example

POST [Link]

{
"SalesAppSettingParams": {
"Code": -1,
"Name": "TEST1"
}
}

POST MobileAppService_UpdateSalesAppSetting
Invoke the method 'UpdateSalesAppSetting' on this service by specifying the payload 'SalesAppSetting' in the JSON format.

Example

POST [Link]

{
"AdvancedDashBoard": -1,
"Code": -1,
"CustomerAdvancedDashBoard": -2,
"Name": "TESTCODE-1"
}

POST MobileAppService_GetServiceAppReportContent
Invoke the method 'GetServiceAppReportContent' on this service by specifying the payload 'ServiceAppReportParams' in the JSON format.

Example

POST [Link]

{
"ServiceAppReportParams": {
"Code": -1,
"ReportChoice": "marCustomizedReport"
}
}

POST MobileAppService_UpdateServiceAppReportContent
Invoke the method 'UpdateServiceAppReportContent' on this service by specifying the payload 'ServiceAppReportParams,ServiceAppReportContent'
in the JSON format.

Example

[Link] Layer API [Link] 46/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"ServiceAppReportContent": {
"ReportContent": ""
},
"ServiceAppReportParams": {
"Code": -1,
"ReportChoice": "marCustomizedReport"
}
}

POST MobileAppService_GetServiceAppReport
Invoke the method 'GetServiceAppReport' on this service by specifying the payload 'ServiceAppReportParams' in the JSON format.

Example

POST [Link]

{
"ServiceAppReportParams": {
"Code": -1,
"ReportChoice": "S"
}
}

POST MobileAppService_UpdateServiceAppReport
Invoke the method 'UpdateServiceAppReport' on this service by specifying the payload 'ServiceAppReport' in the JSON format.

Example

POST [Link]

{
"ServiceAppReport": {
"Code": -1,
"ReportChoice": "marCustomizedReport"
}
}

NatureOfAssesseesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'NatureOfAssesseesService'.

POST NatureOfAssesseesService_GetNatureOfAssesseeList

Invoke the method 'GetNatureOfAssesseeList' on this service.

Example

POST [Link]

NCMCodesSetupService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'NCMCodesSetupService'.

POST NCMCodesSetupService_GetNCMCodeSetupList

Invoke the method 'GetNCMCodeSetupList' on this service.

Example

POST [Link]

NFModelsService

[Link] Layer API [Link] 47/334

6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'NFModelsService'.

POST NFModelsService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

NFTaxCategoriesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'NFTaxCategoriesService'.

POST NFTaxCategoriesService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

OccurrenceCodesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'OccurrenceCodesService'.

POST OccurrenceCodesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

OrdersService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'OrdersService'.

POST OrdersService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocDueDate": "2014-04-04",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

[Link] Layer API [Link] 48/334

6/7/24, 15:42 Service Layer API Reference
}

POST OrdersService_Preview
Invoke the method 'Preview' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocDueDate": "2014-04-04",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}
}

POST OrdersService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PartnersSetupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PartnersSetupsService'.

POST PartnersSetupsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

PaymentBlocksService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PaymentBlocksService'.

POST PaymentBlocksService_GetPaymentBlockList

Invoke the method 'GetPaymentBlockList' on this service.

Example

POST [Link]

PaymentCalculationService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PaymentCalculationService'.

[Link] Layer API [Link] 49/334

6/7/24, 15:42 Service Layer API Reference
POST PaymentCalculationService_GetPaymentAmount

Invoke the method 'GetPaymentAmount' on this service by specifying the payload 'PaymentBPCode,PaymentInvoiceEntries' in the JSON format.

Example

POST [Link]

{
"PaymentBPCode": {
"BPCode": "C01",
"Date": "2016-08-30"
},
"PaymentInvoiceEntries": [
{
"DocEntry": "12",
"DocType": "itARInvoice"
}
]
}

PaymentTermsTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PaymentTermsTypesService'.

POST PaymentTermsTypesService_UpdateWithBPs

Invoke the method 'UpdateWithBPs' on this service by specifying the payload 'PaymentTermsType' in the JSON format.

Example

POST [Link]

{
"PaymentTermsType": {}
}

PickListsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PickListsService'.

POST PickListsService_Close
Invoke the method 'Close' on this service by specifying the payload 'PickList' in the JSON format.

Example

POST [Link]

{
"PickList": {
"Absoluteentry": 3
}
}

POST PickListsService_UpdateReleasedAllocation
Invoke the method 'UpdateReleasedAllocation' on this service by specifying the payload 'PickList' in the JSON format.

Example

POST [Link]

{
"PickList": {
"Absoluteentry": 3,
"Name": "manager",
"ObjectType": "156",
"OwnerCode": 1,
"PickDate": "2016-08-25",
"PickListsLines": [
{
"AbsoluteEntry": 3,

[Link] Layer API [Link] 50/334

6/7/24, 15:42 Service Layer API Reference
"BaseObjectType": 17,
"DocumentLinesBinAllocations": [
{
"BinAbsEntry": 2,
"Quantity": 1,
"SerialAndBatchNumbersBaseLine": 0
}
],
"LineNumber": 0,
"OrderEntry": 9,
"OrderRowID": 0,
"PickStatus": "ps_Released",
"PickedQuantity": 0,
"PreviouslyReleasedQuantity": 1,
"ReleasedQuantity": 1,
"SerialNumbers": [
{
"InternalSerialNumber": 4,
"ManufacturerSerialNumber": 4,
"Quantity": 1
}
]
}
],
"Status": "ps_Released",
"UseBaseUnits": "tNO"
}
}

PredefinedTextsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PredefinedTextsService'.

POST PredefinedTextsService_GetPredefinedTextList
Invoke the method 'GetPredefinedTextList' on this service.

Example

POST [Link]

ProfitCentersService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ProfitCentersService'.

POST ProfitCentersService_GetProfitCenterList

Invoke the method 'GetProfitCenterList' on this service.

Example

POST [Link]

ProjectManagementConfigurationService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ProjectManagementConfigurationService'.

POST ProjectManagementConfigurationService_GetSubprojectTypes

Invoke the method 'GetSubprojectTypes' on this service.

Example

POST [Link]

[Link] Layer API [Link] 51/334

6/7/24, 15:42 Service Layer API Reference
POST ProjectManagementConfigurationService_AddSubprojectTypes

Invoke the method 'AddSubprojectTypes' on this service by specifying the payload 'Collection(PMC_SubprojectTypeData)' in the JSON format.

Example

POST [Link]

{
"PMC_SubprojectTypeData": {
"SubprojectTypeID": "1",
"SubprojectTypeName": "subproject 01"
}
}

POST ProjectManagementConfigurationService_UpdateSubprojectTypes

Invoke the method 'UpdateSubprojectTypes' on this service by specifying the payload 'Collection(PMC_SubprojectTypeData)' in the JSON format.

Example

POST [Link]

{
"PMC_SubprojectTypeData": {
"SubprojectTypeID": "1",
"SubprojectTypeName": "changed subproject 01 name"
}
}

POST ProjectManagementConfigurationService_DeleteSubprojectTypes

Invoke the method 'DeleteSubprojectTypes' on this service by specifying the payload 'Collection(PMC_SubprojectTypeData)' in the JSON format.

Example

POST [Link]

{
"PMC_SubprojectTypeData": {
"SubprojectTypeID": "1"
}
}

POST ProjectManagementConfigurationService_GetStageTypes

Invoke the method 'GetStageTypes' on this service.

Example

POST [Link]

POST ProjectManagementConfigurationService_AddStageTypes

Invoke the method 'AddStageTypes' on this service by specifying the payload 'Collection(PMC_StageTypeData)' in the JSON format.

Example

POST [Link]

{
"PMC_StageTypeData": {
"StageDescription": "stage 01",
"StageName": "stage01"
}
}

POST ProjectManagementConfigurationService_UpdateStageTypes

Invoke the method 'UpdateStageTypes' on this service by specifying the payload 'Collection(PMC_StageTypeData)' in the JSON format.

Example

POST [Link]

{
"PMC_StageTypeData": {
"StageDescription": "update stage 01 description",
"StageID": 6,

[Link] Layer API [Link] 52/334

6/7/24, 15:42 Service Layer API Reference
"StageName": "stage01"
}
}

POST ProjectManagementConfigurationService_DeleteStageTypes
Invoke the method 'DeleteStageTypes' on this service by specifying the payload 'Collection(PMC_StageTypeData)' in the JSON format.

Example

POST [Link]

{
"PMC_StageTypeData": {
"StageID": 6
}
}

POST ProjectManagementConfigurationService_GetAreas
Invoke the method 'GetAreas' on this service.

Example

POST [Link]

POST ProjectManagementConfigurationService_AddAreas
Invoke the method 'AddAreas' on this service by specifying the payload 'Collection(PMC_AreaData)' in the JSON format.

Example

POST [Link]

{
"PMC_AreaData": {
"AreaName": "area 1"
}
}

POST ProjectManagementConfigurationService_UpdateAreas
Invoke the method 'UpdateAreas' on this service by specifying the payload 'Collection(PMC_AreaData)' in the JSON format.

Example

POST [Link]

{
"PMC_AreaData": {
"AreaID": "1",
"AreaName": "update area 1 name"
}
}

POST ProjectManagementConfigurationService_DeleteAreas
Invoke the method 'DeleteAreas' on this service by specifying the payload 'Collection(PMC_AreaData)' in the JSON format.

Example

POST [Link]

{
"PMC_AreaData": {
"AreaID": "1"
}
}

POST ProjectManagementConfigurationService_GetPriorities
Invoke the method 'GetPriorities' on this service.

Example

POST [Link]

[Link] Layer API [Link] 53/334

6/7/24, 15:42 Service Layer API Reference

POST ProjectManagementConfigurationService_AddPriorities
Invoke the method 'AddPriorities' on this service by specifying the payload 'Collection(PMC_PriorityData)' in the JSON format.

Example

POST [Link]

{
"PMC_PriorityData": {
"PriorityName": "Middle level"
}
}

POST ProjectManagementConfigurationService_UpdatePriorities
Invoke the method 'UpdatePriorities' on this service by specifying the payload 'Collection(PMC_PriorityData)' in the JSON format.

Example

POST [Link]

{
"PMC_PriorityData": {
"PriorityID": 1,
"PriorityName": "Lowest level"
}
}

POST ProjectManagementConfigurationService_DeletePriorities
Invoke the method 'DeletePriorities' on this service by specifying the payload 'Collection(PMC_PriorityData)' in the JSON format.

Example

POST [Link]

{
"PMC_PriorityData": {
"PriorityID": 1,
"PriorityName": "Lowest level"
}
}

POST ProjectManagementConfigurationService_GetActivities
Invoke the method 'GetActivities' on this service.

Example

POST [Link]

POST ProjectManagementConfigurationService_AddActivities
Invoke the method 'AddActivities' on this service by specifying the payload 'Collection(PMC_ActivityData)' in the JSON format.

Example

POST [Link]

{
"PMC_ActivityData": {
"ActivityType": "calls",
"IsChargeable": "tYES"
}
}

POST ProjectManagementConfigurationService_UpdateActivities
Invoke the method 'UpdateActivities' on this service by specifying the payload 'Collection(PMC_ActivityData)' in the JSON format.

Example

POST [Link]

[Link] Layer API [Link] 54/334

6/7/24, 15:42 Service Layer API Reference
"PMC_ActivityData": {
"ActivityID": 1,
"ActivityType": "email"
}
}

POST ProjectManagementConfigurationService_DeleteActivities
Invoke the method 'DeleteActivities' on this service by specifying the payload 'Collection(PMC_ActivityData)' in the JSON format.

Example

POST [Link]

{
"PMC_ActivityData": {
"ActivityID": 1,
"ActivityType": "calls"
}
}

POST ProjectManagementConfigurationService_GetTasks
Invoke the method 'GetTasks' on this service.

Example

POST [Link]

POST ProjectManagementConfigurationService_AddTasks
Invoke the method 'AddTasks' on this service by specifying the payload 'Collection(PMC_TaskData)' in the JSON format.

Example

POST [Link]

{
"PMC_TaskData": {
"TaskName": "plans"
}
}

POST ProjectManagementConfigurationService_UpdateTasks
Invoke the method 'UpdateTasks' on this service by specifying the payload 'Collection(PMC_TaskData)' in the JSON format.

Example

POST [Link]

{
"PMC_TaskData": {
"TaskName": "change plans"
}
}

POST ProjectManagementConfigurationService_DeleteTasks
Invoke the method 'DeleteTasks' on this service by specifying the payload 'Collection(PMC_TaskData)' in the JSON format.

Example

POST [Link]

{
"PMC_TaskData": {
"TaskID": 2,
"TaskName": "change plans"
}
}

ProjectManagementService
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 55/334

6/7/24, 15:42 Service Layer API Reference
This API enables you to invoke the interfaces defined on 'ProjectManagementService'.

POST ProjectManagementService_GetSubprojectsList
Invoke the method 'GetSubprojectsList' on this service by specifying the payload 'PM_SubprojectParams' in the JSON format.

Example

POST [Link]

{
"PM_SubprojectParams": {
"AbsEntry": 2
}
}

POST ProjectManagementService_GetSubproject
Invoke the method 'GetSubproject' on this service by specifying the payload 'PM_SubprojectDocumentParams' in the JSON format.

Example

POST [Link]

{
"PM_SubprojectDocumentParams": {
"AbsEntry": 1
}
}

POST ProjectManagementService_AddSubproject
Invoke the method 'AddSubproject' on this service by specifying the payload 'PM_SubprojectDocumentData' in the JSON format.

Example

POST [Link]

{
"PM_SubprojectDocumentData": {
"Owner": 2,
"PMS_StagesCollection": [
{
"CloseDate": "2016-08-31",
"StageType": 7,
"StartDate": "2016-08-31"
}
],
"ProjectID": "2",
"StartDate": "2016-08-31",
"SubprojectEndDate": "2016-08-31",
"SubprojectName": "subProject1"
}
}

POST ProjectManagementService_UpdateSubproject
Invoke the method 'UpdateSubproject' on this service by specifying the payload 'PM_SubprojectDocumentData' in the JSON format.

Example

POST [Link]

{
"PM_SubprojectDocumentData": {
"AbsEntry": 1,
"ProjectID": "2",
"StartDate": "2016-08-30",
"SubprojectName": "new subProject1"
}
}

POST ProjectManagementService_DeleteSubproject
Invoke the method 'DeleteSubproject' on this service by specifying the payload 'PM_SubprojectDocumentParams' in the JSON format.

Example

POST [Link]

{
"PM_SubprojectDocumentParams": {

[Link] Layer API [Link] 56/334

6/7/24, 15:42 Service Layer API Reference
"AbsEntry": 1
}
}

ProjectsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ProjectsService'.

POST ProjectsService_GetProjectList
Invoke the method 'GetProjectList' on this service.

Example

POST [Link]

PurchaseCreditNotesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseCreditNotesService'.

POST PurchaseCreditNotesService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}
}

POST PurchaseCreditNotesService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PurchaseDeliveryNotesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseDeliveryNotesService'.

POST PurchaseDeliveryNotesService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {

[Link] Layer API [Link] 57/334

6/7/24, 15:42 Service Layer API Reference
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "c001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST PurchaseDeliveryNotesService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PurchaseDownPaymentsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseDownPaymentsService'.

POST PurchaseDownPaymentsService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
],
"DownPaymentType": "dptInvoice"
}
}

POST PurchaseDownPaymentsService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PurchaseInvoicesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseInvoicesService'.

POST PurchaseInvoicesService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",

[Link] Layer API [Link] 58/334

6/7/24, 15:42 Service Layer API Reference
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST PurchaseInvoicesService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PurchaseOrdersService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseOrdersService'.

POST PurchaseOrdersService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST PurchaseOrdersService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PurchaseQuotationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseQuotationsService'.

POST PurchaseQuotationsService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{

[Link] Layer API [Link] 59/334

6/7/24, 15:42 Service Layer API Reference
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
],
"RequriedDate": "2014-04-04"
}
}

POST PurchaseQuotationsService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PurchaseRequestService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseRequestService'.

POST PurchaseRequestService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"DocumentLines": [
{
"ItemCode": "i001",
"LineVendor": "v001",
"Quantity": "11"
}
],
"RequriedDate": "2014-03-18"
}
}

POST PurchaseRequestService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

PurchaseReturnsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'PurchaseReturnsService'.

POST PurchaseReturnsService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",

[Link] Layer API [Link] 60/334

6/7/24, 15:42 Service Layer API Reference
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}
}

POST PurchaseReturnsService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

QueryService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'QueryService'.

POST QueryService_PostQuery
Invoke the method 'PostQuery' on this service. To fully comply with OData, Service Layer exposes a new query service for the row level filter, which is
implemented based on the $crossjoin capabilities by separating the QueryPath and QueryOption in the query URL.

Example

POST [Link]

{
"QueryOption": "$expand=Orders($select=DocEntry, DocNum),Orders/DocumentLines($select=ItemCode,LineNum)&$filter=Orders/DocEntry eq Ord
"QueryPath": "$crossjoin(Orders,Orders/DocumentLines)"
}

QuotationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'QuotationsService'.

POST QuotationsService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}
}

POST QuotationsService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

RecurringTransactionService
[Link] Layer API [Link] 61/334
6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'RecurringTransactionService'.

POST RecurringTransactionService_GetAvailableRecurringTransactions
Invoke the method 'GetAvailableRecurringTransactions' on this service.

Example

POST [Link]

POST RecurringTransactionService_DeleteRecurringTransactions
Invoke the method 'DeleteRecurringTransactions' on this service by specifying the payload 'RclRecurringTransactionParamsCollection' in the JSON
format.

Example

POST [Link]

{
"RclRecurringTransactionParamsCollection": [
{},
{}
]
}

POST RecurringTransactionService_GetRecurringTransaction
Invoke the method 'GetRecurringTransaction' on this service by specifying the payload 'RclRecurringTransactionParams' in the JSON format.

Example

POST [Link]

{
"RclRecurringTransactionParams": {}
}

POST RecurringTransactionService_ExecuteRecurringTransactions
Invoke the method 'ExecuteRecurringTransactions' on this service by specifying the payload
'RclRecurringTransactionParamsCollection,RclRecurringExecutionParams' in the JSON format.

Example

POST [Link]

{
"RclRecurringExecutionParams": {},
"RclRecurringTransactionParamsCollection": [
{},
{}
]
}

ReportFilterService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ReportFilterService'.

POST ReportFilterService_GetTaxReportFilterList

Invoke the method 'GetTaxReportFilterList' on this service by specifying the payload 'TaxReportFilterParams' in the JSON format.

Example

POST [Link]

{
"TaxReportFilterParams": {
"Code": 1

[Link] Layer API [Link] 62/334

6/7/24, 15:42 Service Layer API Reference
}
}

ReportLayoutsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ReportLayoutsService'.

POST ReportLayoutsService_SetDefaultReport
Invoke the method 'SetDefaultReport' on this service by specifying the payload 'DefaultReportParams' in the JSON format.

Example

POST [Link]

{
"DefaultReportParams": {
"LayoutCode": "POR10007",
"ReportCode": "POR1"
}
}

POST ReportLayoutsService_GetDefaultReport
Invoke the method 'GetDefaultReport' on this service by specifying the payload 'ReportParams' in the JSON format.

Example

POST [Link]

{
"ReportParams": {
"ReportCode": "POR1"
}
}

POST ReportLayoutsService_AddReportLayout

Invoke the method 'AddReportLayout' on this service by specifying the payload 'ReportLayout' in the JSON format.

Example

POST [Link]

{
"ReportLayout": {
"LayoutCode": "POR10007",
"Name": "layout 123",
"TypeCode": "POR1"
}
}

POST ReportLayoutsService_UpdatePrinterSettings

Invoke the method 'UpdatePrinterSettings' on this service by specifying the payload 'ReportLayout' in the JSON format.

Example

POST [Link]

{
"ReportLayout": {
"LayoutCode": "POR10007",
"Name": "aaaaaa",
"Printer": "Fax",
"TypeCode": "POR1"
}
}

POST ReportLayoutsService_DeleteReportLayout

Invoke the method 'DeleteReportLayout' on this service by specifying the payload 'ReportLayoutParams' in the JSON format.

Example

[Link] Layer API [Link] 63/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"ReportLayoutParams": {
"LayoutCode": "POR10007"
}
}

POST ReportLayoutsService_GetReportLayout
Invoke the method 'GetReportLayout' on this service by specifying the payload 'ReportLayoutParams' in the JSON format.

Example

POST [Link]

{
"ReportLayoutParams": {
"LayoutCode": "POR10007"
}
}

POST ReportLayoutsService_GetDefaultReportLayout
Invoke the method 'GetDefaultReportLayout' on this service by specifying the payload 'ReportParams' in the JSON format.

Example

POST [Link]

{
"ReportParams": {
"ReportCode": "POR1"
}
}

POST ReportLayoutsService_GetReportLayoutList
Invoke the method 'GetReportLayoutList' on this service by specifying the payload 'ReportParams' in the JSON format.

Example

POST [Link]

{
"ReportParams": {
"ReportCode": "POR1"
}
}

POST ReportLayoutsService_UpdateLanguageReport
Invoke the method 'UpdateLanguageReport' on this service by specifying the payload 'ReportLayout' in the JSON format.

Example

POST [Link]

{
"ReportLayout": {
"LayoutCode": "POR10007",
"language": 35
}
}

POST ReportLayoutsService_AddReportLayoutToMenu
Invoke the method 'AddReportLayoutToMenu' on this service by specifying the payload 'ReportLayout,ReportInputParams' in the JSON format.

Example

POST [Link]

{
"ReportInputParams": {
"ReportLayoutMenuID": 1
},
"ReportLayout": {
"AllignFooterToBottom": "tNO",
"Author": null,
"B1Version": null,
"BottomMargin": 10,

[Link] Layer API [Link] 64/334

6/7/24, 15:42 Service Layer API Reference
"CRVersion": null,
"Category": "rlcPLD",
"ChangeFontSizeForEMail": -1,
"ChangeFontSizeInPreview": -1,
"ConvertFontForEMail": "tNO",
"ConvertFontInPrintPreview": "tNO",
"EMailFont": "Arial",
"Editable": "tYES",
"ExtensionErrorAction": "eeaStop",
"ExtensionName": null,
"FollowUpReport": null,
"ForeignLanguageReport": "tNO",
"GridSize": 10,
"GridType": "gtCombination",
"Height": 842,
"ImpExpObjCode": 0,
"LayoutCode": "POR10005",
"LeaderReport": null,
"LeftMargin": 10,
"Localization": null,
"Name": "layout 125",
"NumberOfCopies": 1,
"Orientation": "ortVertical",
"PaperSize": "A4",
"Picture": null,
"PreviewPrintingFont": "Arial",
"Printer": null,
"PrinterFirstPage": null,
"Query": null,
"QueryType": "qtRegular",
"Remarks": null,
"RepetitiveAreasNumber": 0,
"ReportLayoutItems": [],
"ReportLayout_TranslationLines": [],
"RightMargin": 30,
"ShowGrid": "tYES",
"SnapToGrid": "tYES",
"Sortable": "tYES",
"TopMargin": 10,
"TypeCode": "POR1",
"TypeDetail": null,
"UseFirstPrinter": "tNO",
"Width": 595,
"language": 31
}
}

POST ReportLayoutsService_DeleteReportLayoutAndMenu
Invoke the method 'DeleteReportLayoutAndMenu' on this service by specifying the payload 'ReportLayoutParams' in the JSON format.

Example

POST [Link]

{
"ReportLayoutParams": {
"LayoutCode": "POR10007"
}
}

ReportTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ReportTypesService'.

POST ReportTypesService_GetReportTypeList
Invoke the method 'GetReportTypeList' on this service.

Example

POST [Link]

ResourceCapacitiesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ResourceCapacitiesService'.

[Link] Layer API [Link] 65/334

6/7/24, 15:42 Service Layer API Reference
POST ResourceCapacitiesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

POST ResourceCapacitiesService_GetListWithFilter

Invoke the method 'GetListWithFilter' on this service by specifying the payload 'ResourceCapacityWithFilterParams' in the JSON format.

Example

POST [Link]

{
"ResourceCapacityWithFilterParams": {}
}

ResourceGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ResourceGroupsService'.

POST ResourceGroupsService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

ResourcePropertiesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ResourcePropertiesService'.

POST ResourcePropertiesService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

ResourcesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ResourcesService'.

POST ResourcesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

RetornoCodesService
[Link] Layer API [Link] 66/334
6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'RetornoCodesService'.

POST RetornoCodesService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

ReturnRequestService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ReturnRequestService'.

POST ReturnRequestService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST ReturnRequestService_Preview

Invoke the method 'Preview' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST ReturnRequestService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

ReturnsService
Show/Hide
List Operations
[Link] Layer API [Link] 67/334
6/7/24, 15:42 Service Layer API Reference
Expand Operations

This API enables you to invoke the interfaces defined on 'ReturnsService'.

POST ReturnsService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'Document' in the JSON format.

Example

POST [Link]

{
"Document": {
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}
}

POST ReturnsService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

RouteStagesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'RouteStagesService'.

POST RouteStagesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

SalesOpportunityCompetitorsSetupService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'SalesOpportunityCompetitorsSetupService'.

POST SalesOpportunityCompetitorsSetupService_GetSalesOpportunityCompetitorSetupList

Invoke the method 'GetSalesOpportunityCompetitorSetupList' on this service.

Example

POST [Link]

SalesOpportunityInterestsSetupService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'SalesOpportunityInterestsSetupService'.

[Link] Layer API [Link] 68/334

6/7/24, 15:42 Service Layer API Reference
POST SalesOpportunityInterestsSetupService_GetSalesOpportunityInterestSetupList

Invoke the method 'GetSalesOpportunityInterestSetupList' on this service.

Example

POST [Link]

SalesOpportunityReasonsSetupService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'SalesOpportunityReasonsSetupService'.

POST SalesOpportunityReasonsSetupService_GetSalesOpportunityReasonSetupList

Invoke the method 'GetSalesOpportunityReasonSetupList' on this service.

Example

POST [Link]

SalesOpportunitySourcesSetupService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'SalesOpportunitySourcesSetupService'.

POST SalesOpportunitySourcesSetupService_GetSalesOpportunitySourceSetupList
Invoke the method 'GetSalesOpportunitySourceSetupList' on this service.

Example

POST [Link]

SBOBobService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'SBOBobService'.

POST SBOBobService_GetSystemPermission

Invoke the method 'GetSystemPermission' on this service by specifying the payload 'UserCode,PermissionID' in the JSON format.

Example

POST [Link]

{
"PermissionID": "142",
"UserCode": "manager"
}

POST SBOBobService_GetSystemCurrency

Invoke the method 'GetSystemCurrency' on this service.

Example

POST [Link]

POST SBOBobService_GetDueDate

[Link] Layer API [Link] 69/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'GetDueDate' on this service by specifying the payload 'CardCode,RefDate' in the JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"RefDate": "20151001"
}

POST SBOBobService_GetLocalCurrency

Invoke the method 'GetLocalCurrency' on this service.

Example

POST [Link]

POST SBOBobService_GetCurrencyRate

Invoke the method 'GetCurrencyRate' on this service by specifying the payload 'Currency,Date' in the JSON format.

Example

POST [Link]

{
"Currency": "eur",
"Date": "20151001"
}

POST SBOBobService_GetIndexRate

Invoke the method 'GetIndexRate' on this service by specifying the payload 'Index,Date' in the JSON format.

Example

POST [Link]

{
"Date": "20151001",
"Index": "1"
}

POST SBOBobService_Format_MoneyToString

Invoke the method 'Format_MoneyToString' on this service by specifying the payload 'InMoney,InPrecision' in the JSON format.

Example

POST [Link]

{
"InMoney": "1234.458",
"InPrecision": "mpt_Sum"
}

POST SBOBobService_SetCurrencyRate

Invoke the method 'SBOBobService_SetCurrencyRate' on this service by specifying the payload 'RateDate,Currency,Rate' in the JSON format.

Example

POST [Link]

{
"Currency": "EUR",
"Rate": "4.8",
"RateDate": "20161129"
}

SectionsService
Show/Hide
List Operations

[Link] Layer API [Link] 70/334

6/7/24, 15:42 Service Layer API Reference
Expand Operations

This API enables you to invoke the interfaces defined on 'SectionsService'.

POST SectionsService_GetSectionList
Invoke the method 'GetSectionList' on this service.

Example

POST [Link]

SeriesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'SeriesService'.

POST SeriesService_AddSeries
Invoke the method 'AddSeries' on this service by specifying the payload 'Series' in the JSON format.

Example

POST [Link]

{
"Series": {
"ATDocumentType": null,
"BPLID": null,
"DigitNumber": 2,
"Document": "2",
"DocumentSubType": "C",
"GroupCode": "sg_Group1",
"InitialNumber": 21,
"IsDigitalSeries": "tNO",
"IsElectronicCommEnabled": "tNO",
"LastNumber": 30,
"Locked": "tNO",
"Name": "New2",
"NextNumber": 21,
"PeriodIndicator": "Default",
"Prefix": "S",
"Remarks": "test",
"Series": 70,
"SeriesType": "stBusinessPartner",
"Suffix": "b"
}
}

POST SeriesService_RemoveSeries

Invoke the method 'RemoveSeries' on this service by specifying the payload 'SeriesParams' in the JSON format.

Example

POST [Link]

{
"Series": {
"ATDocumentType": null,
"BPLID": null,
"DigitNumber": 2,
"Document": "2",
"DocumentSubType": "C",
"GroupCode": "sg_Group1",
"InitialNumber": 21,
"IsDigitalSeries": "tNO",
"IsElectronicCommEnabled": "tNO",
"LastNumber": 30,
"Locked": "tNO",
"Name": "New2",
"NextNumber": 21,
"PeriodIndicator": "Default",
"Prefix": "S",
"Remarks": "test",
"Series": 70,
"SeriesType": "stBusinessPartner",
"Suffix": "b"
}
}

[Link] Layer API [Link] 71/334

6/7/24, 15:42 Service Layer API Reference
POST SeriesService_AttachSeriesToDocument

Invoke the method 'AttachSeriesToDocument' on this service by specifying the payload 'DocumentSeriesParams' in the JSON format.

Example

POST [Link]

{
"DocumentSeriesParams": {}
}

POST SeriesService_UnattachSeriesFromDocument

Invoke the method 'UnattachSeriesFromDocument' on this service by specifying the payload 'DocumentSeriesParams' in the JSON format.

Example

POST [Link]

{
"DocumentSeriesParams": {}
}

POST SeriesService_SetDefaultSeriesForAllUsers

Invoke the method 'SetDefaultSeriesForAllUsers' on this service by specifying the payload 'DocumentSeriesParams' in the JSON format.

Example

POST [Link]

{
"DocumentSeriesParams": {}
}

POST SeriesService_SetDefaultSeriesForCurrentUser

Invoke the method 'SetDefaultSeriesForCurrentUser' on this service by specifying the payload 'DocumentSeriesParams' in the JSON format.

Example

POST [Link]

{
"DocumentSeriesParams": {}
}

POST SeriesService_SetDefaultSeriesForUser

Invoke the method 'SetDefaultSeriesForUser' on this service by specifying the payload 'DocumentSeriesUserParams' in the JSON format.

Example

POST [Link]

{
"DocumentSeriesUserParams": {}
}

POST SeriesService_UpdateSeries

Invoke the method 'UpdateSeries' on this service by specifying the payload 'Series' in the JSON format.

Example

POST [Link]

{
"Series": {}
}

POST SeriesService_GetDefaultSeries

Invoke the method 'GetDefaultSeries' on this service by specifying the payload 'DocumentTypeParams' in the JSON format.

Example
[Link] Layer API [Link] 72/334
6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"DocumentTypeParams": {}
}

POST SeriesService_GetDocumentSeries
Invoke the method 'GetDocumentSeries' on this service by specifying the payload 'DocumentTypeParams' in the JSON format.

Example

POST [Link]

{
"DocumentTypeParams": {
"Document": "2",
"DocumentSubType": "C"
}
}

POST SeriesService_GetSeries
Invoke the method 'GetSeries' on this service by specifying the payload 'SeriesParams' in the JSON format.

Example

POST [Link]

{
"SeriesParams": {}
}

POST SeriesService_GetDocumentChangedMenuName
Invoke the method 'GetDocumentChangedMenuName' on this service by specifying the payload 'DocumentTypeParams' in the JSON format.

Example

POST [Link]

{
"DocumentTypeParams": {}
}

POST SeriesService_ChangeDocumentMenuName
Invoke the method 'ChangeDocumentMenuName' on this service by specifying the payload 'DocumentChangeMenuName' in the JSON format.

Example

POST [Link]

{
"DocumentChangeMenuName": {}
}

POST SeriesService_GetElectronicSeries
Invoke the method 'GetElectronicSeries' on this service by specifying the payload 'ElectronicSeriesParams' in the JSON format.

Example

POST [Link]

{
"ElectronicSeriesParams": {}
}

POST SeriesService_AddElectronicSeries
Invoke the method 'AddElectronicSeries' on this service by specifying the payload 'ElectronicSeries' in the JSON format.

Example

POST [Link]

[Link] Layer API [Link] 73/334

6/7/24, 15:42 Service Layer API Reference
"ElectronicSeries": {}
}

POST SeriesService_RemoveElectronicSeries
Invoke the method 'RemoveElectronicSeries' on this service by specifying the payload 'ElectronicSeriesParams' in the JSON format.

Example

POST [Link]

{
"ElectronicSeriesParams": {}
}

POST SeriesService_UpdateElectronicSeries
Invoke the method 'UpdateElectronicSeries' on this service by specifying the payload 'ElectronicSeries' in the JSON format.

Example

POST [Link]

{
"ElectronicSeries": {}
}

POST SeriesService_GetDefaultElectronicSeries
Invoke the method 'GetDefaultElectronicSeries' on this service by specifying the payload 'SeriesParams' in the JSON format.

Example

POST [Link]

{
"SeriesParams": {}
}

POST SeriesService_SetDefaultElectronicSeries
Invoke the method 'SetDefaultElectronicSeries' on this service by specifying the payload 'DefaultElectronicSeriesParams' in the JSON format.

Example

POST [Link]

{
"DefaultElectronicSeriesParams": {}
}

ServiceCallOriginsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceCallOriginsService'.

POST ServiceCallOriginsService_GetServiceCallOriginList

Invoke the method 'GetServiceCallOriginList' on this service.

Example

POST [Link]

ServiceCallProblemSubTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceCallProblemSubTypesService'.

[Link] Layer API [Link] 74/334

6/7/24, 15:42 Service Layer API Reference
POST ServiceCallProblemSubTypesService_GetServiceCallProblemSubTypeList

Invoke the method 'GetServiceCallProblemSubTypeList' on this service.

Example

POST [Link]

ServiceCallProblemTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceCallProblemTypesService'.

POST ServiceCallProblemTypesService_GetServiceCallProblemTypeList

Invoke the method 'GetServiceCallProblemTypeList' on this service.

Example

POST [Link]

ServiceCallSolutionStatusService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceCallSolutionStatusService'.

POST ServiceCallSolutionStatusService_GetServiceCallSolutionStatusList
Invoke the method 'GetServiceCallSolutionStatusList' on this service.

Example

POST [Link]

ServiceCallStatusService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceCallStatusService'.

POST ServiceCallStatusService_GetServiceCallStatusList

Invoke the method 'GetServiceCallStatusList' on this service.

Example

POST [Link]

ServiceCallTypesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceCallTypesService'.

POST ServiceCallTypesService_GetServiceCallTypeList

Invoke the method 'GetServiceCallTypeList' on this service.

Example

[Link] Layer API [Link] 75/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

ServiceGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceGroupsService'.

POST ServiceGroupsService_GetServiceGroupList
Invoke the method 'GetServiceGroupList' on this service.

Example

POST [Link]

ServiceTaxPostingService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ServiceTaxPostingService'.

POST ServiceTaxPostingService_PostServiceTax

Invoke the method 'PostServiceTax' on this service by specifying the payload 'ServiceTaxPostingParams' in the JSON format.

Example

POST [Link]

{
"ServiceTaxPostingParams": {
"DocEntry": 5
}
}

POST ServiceTaxPostingService_GetTaxableDeliveries

Invoke the method 'GetTaxableDeliveries' on this service.

Example

POST [Link]

StatesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'StatesService'.

POST StatesService_GetStateList

Invoke the method 'GetStateList' on this service.

Example

POST [Link]

StockTransferDraftService
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 76/334

6/7/24, 15:42 Service Layer API Reference
This API enables you to invoke the interfaces defined on 'StockTransferDraftService'.

POST StockTransferDraftService_GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'StockTransfer' in the JSON format.

Example

POST [Link]

{
"StockTransfer": {}
}

POST StockTransferDraftService_HandleApprovalRequest
Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

StockTransferService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'StockTransferService'.

POST StockTransferService_GetApprovalTemplates

Invoke the method 'GetApprovalTemplates' on this service by specifying the payload 'StockTransfer' in the JSON format.

Example

POST [Link]

{
"StockTransfer": {
"CardCode": "C001",
"StockTransferLines": [
{
"DocDate": "2016-08-31",
"ItemCode": "I001",
"WarehouseCode": "10"
}
]
}
}

POST StockTransferService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST [Link]

TargetGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'TargetGroupsService'.

POST TargetGroupsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

[Link] Layer API [Link] 77/334

6/7/24, 15:42 Service Layer API Reference

TaxCodeDeterminationsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'TaxCodeDeterminationsService'.

POST TaxCodeDeterminationsService_GetTaxCodeDeterminationList
Invoke the method 'GetTaxCodeDeterminationList' on this service.

Example

POST [Link]

TaxCodeDeterminationsTCDService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'TaxCodeDeterminationsTCDService'.

POST TaxCodeDeterminationsTCDService_GetTaxCodeDeterminationTCDList

Invoke the method 'GetTaxCodeDeterminationTCDList' on this service.

Example

POST [Link]

TaxWebSitesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'TaxWebSitesService'.

POST TaxWebSitesService_GetTaxWebSiteList

Invoke the method 'GetTaxWebSiteList' on this service.

Example

POST [Link]

POST TaxWebSitesService_GetDefaultWebSite

Invoke the method 'GetDefaultWebSite' on this service.

Example

POST [Link]

TerminationReasonService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'TerminationReasonService'.

POST TerminationReasonService_GetList

Invoke the method 'GetList' on this service.

Example

[Link] Layer API [Link] 78/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

TrackingNotesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'TrackingNotesService'.

POST TrackingNotesService_GetList
Invoke the method 'GetList' on this service.

Example

POST [Link]

TransactionCodesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'TransactionCodesService'.

POST TransactionCodesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

UnitOfMeasurementGroupsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'UnitOfMeasurementGroupsService'.

POST UnitOfMeasurementGroupsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

UnitOfMeasurementsService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'UnitOfMeasurementsService'.

POST UnitOfMeasurementsService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

UserMenuService

[Link] Layer API [Link] 79/334

6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'UserMenuService'.

POST UserMenuService_GetCurrentUserMenu
Invoke the method 'GetCurrentUserMenu' on this service.

Example

POST [Link]

POST UserMenuService_UpdateCurrentUserMenu
Invoke the method 'UpdateCurrentUserMenu' on this service by specifying the payload 'Collection(UserMenuItem)' in the JSON format.

Example

POST [Link]

{
"UserMenuItems": [
{
"LinkedFormMenuID": "11",
"LinkedFormNum": null,
"LinkedObjKey": null,
"LinkedObjType": null,
"Name": "Forms",
"Position": 1,
"ReportPath": "11",
"Type": "umitFolder"
},
{
"LinkedFormMenuID": null,
"LinkedFormNum": null,
"LinkedObjKey": null,
"LinkedObjType": null,
"Name": "Reports",
"Position": 2,
"ReportPath": "",
"Type": "umitFolder"
},
{
"LinkedFormMenuID": null,
"LinkedFormNum": null,
"LinkedObjKey": null,
"LinkedObjType": null,
"Name": "Queries",
"Position": 3,
"ReportPath": "",
"Type": "umitFolder"
},
{
"LinkedFormMenuID": null,
"LinkedFormNum": null,
"LinkedObjKey": null,
"LinkedObjType": null,
"Name": "Links",
"Position": 4,
"ReportPath": "",
"Type": "umitFolder"
}
]
}

POST UserMenuService_GetUserMenu
Invoke the method 'GetUserMenu' on this service by specifying the payload 'UserMenuParams' in the JSON format.

Example

POST [Link]

{
"UserMenuParams": {}
}

POST UserMenuService_UpdateUserMenu
Invoke the method 'UpdateUserMenu' on this service by specifying the payload 'UserMenuParams' in the JSON format.

Example

[Link] Layer API [Link] 80/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"UserMenuParams": {}
}

ValueMappingService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'ValueMappingService'.

POST ValueMappingService_GetMappedB1Value
Invoke the method 'GetMappedB1Value' on this service by specifying the payload 'VM_B1ValuesData' in the JSON format. Retreives value from
Business One universe, that is mapped to specific 3th party value.

Example

POST [Link]

{
"ObjectId": 37,
"VM_ThirdPartyValuesData": {
"ThirdPartySystemId": 1,
"ThirdPartyValue": "AED"
}
}

POST ValueMappingService_GetThirdPartyValuesForB1Value
Invoke the method 'GetThirdPartyValuesForB1Value' on this service by specifying the payload 'VM_B1ValuesData' in the JSON format. Retrieves all
3th party values for the specific value from Business One universe.

Example

POST [Link]

{
"ObjectAbsEntry": "CHF",
"ObjectId": 37
}

POST ValueMappingService_RemoveMappedValue

Invoke the method 'RemoveMappedValue' on this service by specifying the payload 'VM_ThirdPartyValuesData' in the JSON format. Removes one 3th
party value from the collection of mapped values to one specific value from Business One universe.

Example

POST [Link]

{
"AbsEntry": 6,
"LineId": 2,
"ThirdPartySystemId": 1
}

WarehouseSublevelCodesService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'WarehouseSublevelCodesService'.

POST WarehouseSublevelCodesService_GetList

Invoke the method 'GetList' on this service.

Example

POST [Link]

[Link] Layer API [Link] 81/334

6/7/24, 15:42 Service Layer API Reference

WorkflowTaskService
Show/Hide
List Operations
Expand Operations

This API enables you to invoke the interfaces defined on 'WorkflowTaskService'.

POST WorkflowTaskService_Complete
Invoke the method 'Complete' on this service by specifying the payload 'WorkflowTaskCompleteParams' in the JSON format.

Example

POST [Link]

{
"WorkflowTaskCompleteParams": {
"Note": "Default Comment",
"TaskID": "4",
"TriggerParams": "<Params><Param><Key>Result</Key><Value Type="string">1</Value></Param></Params>"
}
}

POST WorkflowTaskService_GetApprovalTaskList
Invoke the method 'GetApprovalTaskList' on this service by specifying the payload 'WorkflowApprovalTaskListParams' in the JSON format.

Example

POST [Link]

{
"WorkflowApprovalTaskListParams": {
"Status": "G|W"
}
}

Entities:
Entities represent the individual instances of objects (such as BusinessPartners and Orders). An entity type defines the category to which an entity belongs. Entity
properties describe some aspects of the entity. A key must be supplied for one entity type to uniquely identify each instance of the entity type.
Basically, almost all entities support POST/GET/PATCH/DELETE operations, except for some special entities due to the special business logic. Besides, as Service Layer
is based on OData protocol, OData query can be applied to both collection of entities and single entity via the HTTP method GET, but differs in the aspect of query
options.

GET Entities

Query Options on entities

$filter Restrict the set of business objects returned.

$orderby Specify the order in which business objects are returned from the service.
$select Restrict the service to return only the properties requested by the client.
$skip Specify that the result excludes the first n entities.
$top Specify that only the first n records should be returned.

GET Entity(id)

Query Options on single entity

$select Restrict the service to return only the properties requested by the client.

AccountCategory
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AccountCategory'.

GET AccountCategory(id)
Retrieve all or some selected properties from an instance of 'AccountCategory' with the given id.

Example

[Link] Layer API [Link] 82/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link]

GET AccountCategory
Retrieve a collection of 'AccountCategory' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=

POST AccountCategory
Create an instance of 'AccountCategory' with the given payload of type 'AccountCategory' in JSON format.

Example

POST [Link]

{
"CategoryCode": 1,
"CategoryName": "test1"
}

PATCH AccountCategory(id)
Update an instance of 'AccountCategory' with the given payload of type 'AccountCategory' in JSON format and with the specified id.

Example

PATCH [Link]

{
"CategoryCode": 1,
"CategoryName": "test123"
}

DELETE AccountCategory(id)
Delete an instance of 'AccountCategory' with the specified id.

Example

DELETE [Link]

AccountSegmentationCategories
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AccountSegmentationCategories'. It represents the categories under each of the account segments.

GET AccountSegmentationCategories(id)

Retrieve all or some selected properties from an instance of 'AccountSegmentationCategories' with the given id.

Example

GET [Link]

GET [Link]

GET AccountSegmentationCategories

Retrieve a collection of 'AccountSegmentationCategories' with all or some selected properties in the given order by specifying the given filter
condition.

[Link] Layer API [Link] 83/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link] ge 123 and startswith(Code,

POST AccountSegmentationCategories

Create an instance of 'AccountSegmentationCategories' with the given payload of type 'AccountSegmentationCategory' in JSON format.

Example

POST [Link]

{
"Code": "50",
"Name": "Sales Department",
"SegmentID": "3",
"ShortName": "SD"
}

PATCH AccountSegmentationCategories(id)

Update an instance of 'AccountSegmentationCategories' with the given payload of type 'AccountSegmentationCategory' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"Name": "General Administration"
}

DELETE AccountSegmentationCategories(id)

Delete an instance of 'AccountSegmentationCategories' with the specified id.

Example

DELETE [Link]

AccountSegmentations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AccountSegmentations'.

GET AccountSegmentations(id)
Retrieve all or some selected properties from an instance of 'AccountSegmentations' with the given id.

Example

GET [Link]

GET [Link]

GET AccountSegmentations
Retrieve a collection of 'AccountSegmentations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Numerator&$top=10&$

[Link] Layer API [Link] 84/334

6/7/24, 15:42 Service Layer API Reference
POST AccountSegmentations

Create an instance of 'AccountSegmentations' with the given payload of type 'AccountSegmentation' in JSON format.

Example

POST [Link]

{
"AccountSegmentationsCategories": [
{
"Code": "50",
"Name": "Sales Department",
"SegmentID": "3",
"ShortName": "SD"
}
],
"Name": "Division2",
"Size": 2,
"Type": "ast_Alphanumeric"
}

PATCH AccountSegmentations(id)

Update an instance of 'AccountSegmentations' with the given payload of type 'AccountSegmentation' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Division3"
}

DELETE AccountSegmentations(id)

Delete an instance of 'AccountSegmentations' with the specified id.

Example

DELETE [Link]

AccrualTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AccrualTypes'.

GET AccrualTypes(id)
Retrieve all or some selected properties from an instance of 'AccrualTypes' with the given id.

Example

GET [Link]

GET [Link]

GET AccrualTypes
Retrieve a collection of 'AccrualTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$ski

POST AccrualTypes
Create an instance of 'AccrualTypes' with the given payload of type 'AccrualType' in JSON format.

[Link] Layer API [Link] 85/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"CalculationAccount": "2110",
"Code": "Accrual1",
"InterimAccount": "2120",
"Name": "Accrual1",
"PostingAccount": "2107"
}

PATCH AccrualTypes(id)

Update an instance of 'AccrualTypes' with the given payload of type 'AccrualType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PostingAccount": "2140"
}

DELETE AccrualTypes(id)

Delete an instance of 'AccrualTypes' with the specified id.

Example

DELETE [Link]

Activities
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Activities'.

GET Activities(id)
Retrieve all or some selected properties from an instance of 'Activities' with the given id.

Example

GET [Link]

GET [Link]

GET Activities
Retrieve a collection of 'Activities' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=ActivityCode&$top=10

POST Activities
Create an instance of 'Activities' with the given payload of type 'Activity' in JSON format.

Example

POST [Link]

{
"ActivityDate": "2016-08-30",
"ActivityTime": "08:13:00",
"CardCode": "C01",
"DocEntry": "3",
"DocNum": "1",

[Link] Layer API [Link] 86/334

6/7/24, 15:42 Service Layer API Reference
"DocType": "17",
"Duration": 15,
"DurationType": "du_Minuts",
"EndDueDate": "2016-08-30",
"EndTime": "08:28:00",
"Reminder": "tYES",
"ReminderPeriod": 15,
"ReminderType": "du_Minuts",
"StartDate": "2016-08-30",
"StartTime": "08:13:00"
}

PATCH Activities(id)
Update an instance of 'Activities' with the given payload of type 'Activity' in JSON format and with the specified id.

Example

PATCH [Link]

{
"StartTime": "12:00:00"
}

DELETE Activities(id)
Delete an instance of 'Activities' with the specified id.

Example

DELETE [Link]

ActivityLocations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ActivityLocations'. It represents locations where activities with your business partners take place.

GET ActivityLocations(id)

Retrieve all or some selected properties from an instance of 'ActivityLocations' with the given id.

Example

GET [Link]

GET [Link]

GET ActivityLocations

Retrieve a collection of 'ActivityLocations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST ActivityLocations

Create an instance of 'ActivityLocations' with the given payload of type 'ActivityLocation' in JSON format.

Example

POST [Link]

{
"Name": "SH Room1"
}

PATCH ActivityLocations(id)
[Link] Layer API [Link] 87/334
6/7/24, 15:42 Service Layer API Reference
Update an instance of 'ActivityLocations' with the given payload of type 'ActivityLocation' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "SH Room1 updated"
}

ActivityRecipientLists
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ActivityRecipientLists'.

GET ActivityRecipientLists(id)

Retrieve all or some selected properties from an instance of 'ActivityRecipientLists' with the given id.

Example

GET [Link]

GET [Link]

GET ActivityRecipientLists

Retrieve a collection of 'ActivityRecipientLists' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST ActivityRecipientLists

Create an instance of 'ActivityRecipientLists' with the given payload of type 'ActivityRecipientList' in JSON format.

Example

POST [Link]

{
"Active": "tYES",
"ActivityRecipientCollection": [
{
"LineNumber": 1,
"RecipientCode": "2",
"RecipientType": "rtUser"
},
{
"LineNumber": 2,
"RecipientCode": "4",
"RecipientType": "rtUser"
}
],
"Code": 1,
"IsMultiple": "tNO",
"Name": "RP1"
}

PATCH ActivityRecipientLists(id)

Update an instance of 'ActivityRecipientLists' with the given payload of type 'ActivityRecipientList' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE ActivityRecipientLists(id)
[Link] Layer API [Link] 88/334
6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'ActivityRecipientLists' with the specified id.

Example

DELETE [Link]

ActivityStatuses
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ActivityStatuses'. It is a business object that enables to define statuses for Task type activities in the Business Partners
module.

GET ActivityStatuses(id)

Retrieve all or some selected properties from an instance of 'ActivityStatuses' with the given id.

Example

GET [Link]

GET [Link]

GET ActivityStatuses

Retrieve a collection of 'ActivityStatuses' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=StatusId

POST ActivityStatuses

Create an instance of 'ActivityStatuses' with the given payload of type 'ActivityStatus' in JSON format.

Example

POST [Link]

{
"StatusDescription": "Task in progress",
"StatusName": "In Progress"
}

PATCH ActivityStatuses(id)

Update an instance of 'ActivityStatuses' with the given payload of type 'ActivityStatus' in JSON format and with the specified id.

Example

PATCH [Link]

{
"StatusDescription": "Finished"
}

DELETE ActivityStatuses(id)

Delete an instance of 'ActivityStatuses' with the specified id.

Example

DELETE [Link]

ActivityTypes
[Link] Layer API [Link] 89/334
6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ActivityTypes'. You may have different activities with your business partners, for example, phone calls and meetings.

GET ActivityTypes(id)
Retrieve all or some selected properties from an instance of 'ActivityTypes' with the given id.

Example

GET [Link]

GET [Link]

GET ActivityTypes
Retrieve a collection of 'ActivityTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST ActivityTypes
Create an instance of 'ActivityTypes' with the given payload of type 'ActivityType' in JSON format.

Example

POST [Link]

{
"Name": "Special"
}

PATCH ActivityTypes(id)
Update an instance of 'ActivityTypes' with the given payload of type 'ActivityType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Others"
}

DELETE ActivityTypes(id)
Delete an instance of 'ActivityTypes' with the specified id.

Example

DELETE [Link]

AdditionalExpenses
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AdditionalExpenses'. It represents additional expenses for transporting freight or delivering services, such as delivery fees
and tax deposits.

GET AdditionalExpenses(id)

Retrieve all or some selected properties from an instance of 'AdditionalExpenses' with the given id.

[Link] Layer API [Link] 90/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET AdditionalExpenses

Retrieve a collection of 'AdditionalExpenses' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Expe

POST AdditionalExpenses

Create an instance of 'AdditionalExpenses' with the given payload of type 'AdditionalExpense' in JSON format.

Example

POST [Link]

{
"DistributionMethod": "aed_None",
"ExpenseAccount": "_SYS00000000002",
"FixedAmountExpenses": "20",
"FixedAmountRevenues": "10",
"Name": "road fee",
"RevenuesAccount": "_SYS00000000082"
}

PATCH AdditionalExpenses(id)

Update an instance of 'AdditionalExpenses' with the given payload of type 'AdditionalExpense' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DistributionMethod": "aed_Equally"
}

DELETE AdditionalExpenses(id)

Delete an instance of 'AdditionalExpenses' with the specified id.

Example

DELETE [Link]

AlertManagements
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AlertManagements'. For each alert, you need to define its priority, the users and documents to which the alert applies, and the
conditions that trigger the alert. In addition to activating system alerts, you can also add alerts based on user-defined queries.

GET AlertManagements(id)
Retrieve all or some selected properties from an instance of 'AlertManagements' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 91/334

6/7/24, 15:42 Service Layer API Reference

GET AlertManagements
Retrieve a collection of 'AlertManagements' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST AlertManagements
Create an instance of 'AlertManagements' with the given payload of type 'AlertManagement' in JSON format.

Example

POST [Link]

{
"Active": "tYES",
"AlertManagementRecipients": [
{
"SendInternal": "tYES",
"UserCode": "1"
}
],
"FrequencyInterval": "1",
"FrequencyType": "atfi_Hours",
"Name": "task alert",
"Priority": "atp_Normal",
"QueryID": "282"
}

PATCH AlertManagements(id)
Update an instance of 'AlertManagements' with the given payload of type 'AlertManagement' in JSON format and with the specified id.

Example

PATCH [Link]

{
"FrequencyType": "atfi_Weeks"
}

DELETE AlertManagements(id)
Delete an instance of 'AlertManagements' with the specified id.

Example

DELETE [Link]

POST AlertManagements(id)/GetAlertManagement
Invoke the method 'GetAlertManagement' on this EntitySet with the specified id.

Example

POST [Link]

POST AlertManagements(id)/GetAlertManagementList
Invoke the method 'GetAlertManagementList' on this EntitySet with the specified id.

Example

POST [Link]

[Link] Layer API [Link] 92/334

6/7/24, 15:42 Service Layer API Reference

AlternateCatNum
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AlternateCatNum'. It represents the alternative catalog numbers in the Business Partners module.

GET AlternateCatNum(id)
Retrieve all or some selected properties from an instance of 'AlternateCatNum' with the given id.

Example

GET [Link]

GET [Link]

GET AlternateCatNum
Retrieve a collection of 'AlternateCatNum' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'i') and startswith(C

POST AlternateCatNum
Create an instance of 'AlternateCatNum' with the given payload of type 'AlternateCatNum' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DisplayBPCatalogNumber": "tNO",
"ItemCode": "item01",
"Substitute": "BP01"
}

PATCH AlternateCatNum(id)
Update an instance of 'AlternateCatNum' with the given payload of type 'AlternateCatNum' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DisplayBPCatalogNumber": "tYES"
}

DELETE AlternateCatNum(id)
Delete an instance of 'AlternateCatNum' with the specified id.

Example

DELETE [Link]

ApprovalRequests
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ApprovalRequests' and retrieve approval requests for various approval processes.

GET ApprovalRequests(id)
[Link] Layer API [Link] 93/334
6/7/24, 15:42 Service Layer API Reference
Retrieve all or some selected properties from an instance of 'ApprovalRequests' with the given id.

Example

GET [Link]

GET [Link]

GET ApprovalRequests

Retrieve a collection of 'ApprovalRequests' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

PATCH ApprovalRequests(id)

Update an instance of 'ApprovalRequests' with the given payload of type 'ApprovalRequest' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ApprovalRequestLines": [
{
"StageCode": 3,
"Status": "ardPending",
"UserID": 1
}
],
"CurrentStage": 3,
"IsDraft": "Y",
"ObjectEntry": 14,
"ObjectType": "112",
"OriginatorID": 38,
"Remarks": "Please Approve, dear Master",
"Status": "arsPending"
}

ApprovalStages
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ApprovalStages'.

GET ApprovalStages(id)

Retrieve all or some selected properties from an instance of 'ApprovalStages' with the given id.

Example

GET [Link]

GET [Link]

GET ApprovalStages

Retrieve a collection of 'ApprovalStages' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip

POST ApprovalStages
[Link] Layer API [Link] 94/334
6/7/24, 15:42 Service Layer API Reference
Create an instance of 'ApprovalStages' with the given payload of type 'ApprovalStage' in JSON format.

Example

POST [Link]

{
"ApprovalStageApprovers": [
{
"UserID": "1"
}
],
"Name": "stage01",
"NoOfApproversRequired": "1",
"Remarks": "Approved by Manager"
}

PATCH ApprovalStages(id)

Update an instance of 'ApprovalStages' with the given payload of type 'ApprovalStage' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "Approved by Director"
}

DELETE ApprovalStages(id)

Delete an instance of 'ApprovalStages' with the specified id. However, you are not allowed to remove the stage that is linked to an approval template.

Example

DELETE [Link]

POST ApprovalStages(id)/GetApprovalStage

Invoke the method 'GetApprovalStage' on this EntitySet with the specified id.

Example

POST [Link]

POST ApprovalStages(id)/RemoveApprovalStage

Invoke the method 'RemoveApprovalStage' on this EntitySet with the specified id.

Example

POST [Link]

ApprovalTemplates
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ApprovalTemplates'. Each template specifies an approval procedure, and the users and transactions to which the procedure
applies.

GET ApprovalTemplates(id)

Retrieve all or some selected properties from an instance of 'ApprovalTemplates' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 95/334

6/7/24, 15:42 Service Layer API Reference
GET ApprovalTemplates

Retrieve a collection of 'ApprovalTemplates' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST ApprovalTemplates

Create an instance of 'ApprovalTemplates' with the given payload of type 'ApprovalTemplate' in JSON format.

Example

POST [Link]

{
"ApprovalTemplateDocuments": [
{
"DocumentType": "atdtDelivery"
}
],
"ApprovalTemplateStages": [
{
"ApprovalStageCode": "3",
"SortID": "1"
}
],
"ApprovalTemplateUsers": [
{
"UserID": "1"
}
],
"Name": "ShipDocTemp",
"Remarks": "Delivery approval"
}

PATCH ApprovalTemplates(id)

Update an instance of 'ApprovalTemplates' with the given payload of type 'ApprovalTemplate' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "Shipping"
}

DELETE ApprovalTemplates(id)

Delete an instance of 'ApprovalTemplates' with the specified id.

Example

DELETE [Link]

POST ApprovalTemplates(id)/GetApprovalTemplate

Invoke the method 'GetApprovalTemplate' on this EntitySet with the specified id.

Example

POST [Link]

POST ApprovalTemplates(id)/RemoveApprovalTemplate

Invoke the method 'RemoveApprovalTemplate' on this EntitySet with the specified id.

Example

POST [Link]

[Link] Layer API [Link] 96/334

6/7/24, 15:42 Service Layer API Reference

AssetCapitalization
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetCapitalization'.

GET AssetCapitalization(id)
Retrieve all or some selected properties from an instance of 'AssetCapitalization' with the given id.

Example

GET [Link]

GET [Link]

GET AssetCapitalization
Retrieve a collection of 'AssetCapitalization' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=DocEntry&$top=10&$sk

POST AssetCapitalization
Create an instance of 'AssetCapitalization' with the given payload of type 'AssetDocument' in JSON format.

Example

POST [Link]

{
"AssetDocumentLineCollection": [
{
"AssetNumber": "FA1",
"Quantity": 1,
"TotalLC": 1000
}
],
"AssetValueDate": "2016-08-29",
"DocumentDate": "2016-08-29",
"PostingDate": "2016-08-29"
}

PATCH AssetCapitalization(id)
Update an instance of 'AssetCapitalization' with the given payload of type 'AssetDocument' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AssetDocumentLineCollection": [
{
"LineNumber": 1,
"Remarks": "Remark is 0"
}
]
}

AssetCapitalizationCreditMemo
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetCapitalizationCreditMemo'.

GET AssetCapitalizationCreditMemo(id)

[Link] Layer API [Link] 97/334

6/7/24, 15:42 Service Layer API Reference
Retrieve all or some selected properties from an instance of 'AssetCapitalizationCreditMemo' with the given id.

Example

GET [Link]

GET [Link]

GET AssetCapitalizationCreditMemo

Retrieve a collection of 'AssetCapitalizationCreditMemo' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=DocEntry&$

POST AssetCapitalizationCreditMemo

Create an instance of 'AssetCapitalizationCreditMemo' with the given payload of type 'AssetDocument' in JSON format.

Example

POST [Link]

{
"AssetDocumentLineCollection": [
{
"AssetNumber": "FA1",
"Quantity": 1,
"TotalLC": 1000
}
],
"AssetValueDate": "2016-08-29",
"DocumentDate": "2016-08-29",
"PostingDate": "2016-08-29"
}

PATCH AssetCapitalizationCreditMemo(id)

Update an instance of 'AssetCapitalizationCreditMemo' with the given payload of type 'AssetDocument' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AssetDocumentLineCollection": [
{
"LineNumber": 1,
"Remarks": "Remark is 0"
}
]
}

AssetClasses
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetClasses'.

GET AssetClasses(id)

Retrieve all or some selected properties from an instance of 'AssetClasses' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 98/334

6/7/24, 15:42 Service Layer API Reference
GET AssetClasses

Retrieve a collection of 'AssetClasses' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$s

POST AssetClasses

Create an instance of 'AssetClasses' with the given payload of type 'AssetClass' in JSON format.

Example

POST [Link]

{
"AssetClassCollection": [
{
"AccountDetermination": "1001",
"ActiveStatus": "tYES",
"Code": "TEST",
"DepreciationAreaID": "100",
"DepreciationTypeID": "LINP",
"LineNumber": 0,
"UseLife": 36
},
{
"AccountDetermination": null,
"ActiveStatus": "tYES",
"Code": "TEST",
"DepreciationAreaID": "300",
"DepreciationTypeID": "LINP",
"LineNumber": 1,
"UseLife": 36
}
],
"AssetType": "atAssetTypeGeneral",
"Code": "TEST",
"Description": "test AssetClasses"
}

PATCH AssetClasses(id)

Update an instance of 'AssetClasses' with the given payload of type 'AssetClass' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AssetType": "atAssetTypeLowValueAsset",
"Description": "test AssetClasses",
"ValueLimitFrom": "600",
"ValueLimitTo": "2000"
}

DELETE AssetClasses(id)

Delete an instance of 'AssetClasses' with the specified id.

Example

DELETE [Link]

AssetDepreciationGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetDepreciationGroups'.

GET AssetDepreciationGroups(id)
Retrieve all or some selected properties from an instance of 'AssetDepreciationGroups' with the given id.

[Link] Layer API [Link] 99/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET AssetDepreciationGroups

Retrieve a collection of 'AssetDepreciationGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'ADG') &$orderby=Code&$

POST AssetDepreciationGroups

Create an instance of 'AssetDepreciationGroups' with the given payload of type 'AssetDepreciationGroup' in JSON format.

Example

POST [Link]

{
"Code": "ADG",
"Description": "AssetDepreciationGroups",
"Group": "Group1"
}

PATCH AssetDepreciationGroups(id)

Update an instance of 'AssetDepreciationGroups' with the given payload of type 'AssetDepreciationGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test",
"Group": "Group123"
}

DELETE AssetDepreciationGroups(id)

Delete an instance of 'AssetDepreciationGroups' with the specified id.

Example

DELETE [Link]

AssetGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetGroups'.

GET AssetGroups(id)
Retrieve all or some selected properties from an instance of 'AssetGroups' with the given id.

Example

GET [Link]

GET [Link]

GET AssetGroups
[Link] Layer API [Link] 100/334
6/7/24, 15:42 Service Layer API Reference
Retrieve a collection of 'AssetGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'AG') &$orderby=Code&$top=10&$skip=1

POST AssetGroups

Create an instance of 'AssetGroups' with the given payload of type 'AssetGroup' in JSON format.

Example

POST [Link]

{
"Code": "AG",
"Description": "AssetGroups"
}

PATCH AssetGroups(id)

Update an instance of 'AssetGroups' with the given payload of type 'AssetGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test1"
}

DELETE AssetGroups(id)

Delete an instance of 'AssetGroups' with the specified id.

Example

DELETE [Link]

AssetManualDepreciation
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetManualDepreciation'.

GET AssetManualDepreciation(id)

Retrieve all or some selected properties from an instance of 'AssetManualDepreciation' with the given id.

Example

GET [Link]

GET [Link]

GET AssetManualDepreciation

Retrieve a collection of 'AssetManualDepreciation' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=DocEntry&$top=10

[Link] Layer API [Link] 101/334

6/7/24, 15:42 Service Layer API Reference
POST AssetManualDepreciation

Create an instance of 'AssetManualDepreciation' with the given payload of type 'AssetDocument' in JSON format.

Example

POST [Link]

{
"AssetDocumentLineCollection": [
{
"AssetNumber": "FA1",
"GLAccount": null,
"Quantity": 0,
"Remarks": "test1",
"TotalFC": 0,
"TotalLC": 100,
"TotalSC": 100
}
],
"AssetValueDate": "2016-08-31",
"DepreciationArea": "*",
"DocumentDate": "2016-08-31",
"DocumentTotal": 100,
"DocumentType": "adtUnplannedDepreciation",
"PostingDate": "2016-08-31",
"SummerizeByDistributionRules": "tYES",
"SummerizeByProjects": "tYES"
}

PATCH AssetManualDepreciation(id)

Update an instance of 'AssetManualDepreciation' with the given payload of type 'AssetDocument' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AssetDocumentLineCollection": [
{
"LineNumber": 1,
"Remarks": "123"
}
]
}

AssetRetirement
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetRetirement'.

GET AssetRetirement(id)
Retrieve all or some selected properties from an instance of 'AssetRetirement' with the given id.

Example

GET [Link]

GET [Link]

GET AssetRetirement
Retrieve a collection of 'AssetRetirement' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 9 &$orderby=DocEntry&$top=10&$skip=1

POST AssetRetirement
Create an instance of 'AssetRetirement' with the given payload of type 'AssetDocument' in JSON format.
[Link] Layer API [Link] 102/334
6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"AssetDocumentLineCollection": [
{
"AssetNumber": "FA1",
"Quantity": 1,
"TotalLC": 1000
}
],
"AssetValueDate": "2016-08-29",
"DocumentDate": "2016-08-29",
"PostingDate": "2016-08-29"
}

PATCH AssetRetirement(id)

Update an instance of 'AssetRetirement' with the given payload of type 'AssetDocument' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AssetDocumentLineCollection": [
{
"LineNumber": 1,
"Remarks": "Remark is 0"
}
]
}

AssetTransfer
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetTransfer'.

GET AssetTransfer(id)
Retrieve all or some selected properties from an instance of 'AssetTransfer' with the given id.

Example

GET [Link]

GET [Link]

GET AssetTransfer
Retrieve a collection of 'AssetTransfer' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=DocEntry&$top=10&$skip=1

POST AssetTransfer
Create an instance of 'AssetTransfer' with the given payload of type 'AssetDocument' in JSON format.

Example

POST [Link]

{
"AssetDocumentLineCollection": [
{
"AssetNumber": "FA4",
"NewAssetNumber": "FA3"
}
],
"AssetValueDate": "2017-01-01",

[Link] Layer API [Link] 103/334

6/7/24, 15:42 Service Layer API Reference
"DepreciationArea": "*",
"DocumentDate": "2017-01-01",
"DocumentType": "adtAssetTransfer",
"PostingDate": "2017-01-01"
}

PATCH AssetTransfer(id)
Update an instance of 'AssetTransfer' with the given payload of type 'AssetDocument' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AssetDocumentLineCollection": [
{
"LineNumber": 1,
"Remarks": "Remark is 0"
}
]
}

Attachments2
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Attachments2'.

GET Attachments2(id)
Retrieve all or some selected properties from an instance of 'Attachments2' with the given id.

Example

GET [Link]

GET [Link]

GET Attachments2

Retrieve a collection of 'Attachments2' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsoluteEn

POST Attachments2

Create an instance of 'Attachments2' with the given payload of type 'Attachments2' in JSON format.

Example

POST [Link]

{
"Attachments2_Lines": [
{
"FileExtension": "so",
"FileName": "mod_negotiation",
"SourcePath": "/usr/sap/SAPBusinessOne/ServiceLayer/modules",
"UserID": "1"
}
]
}

PATCH Attachments2(id)

Update an instance of 'Attachments2' with the given payload of type 'Attachments2' in JSON format and with the specified id.

Example

[Link] Layer API [Link] 104/334

6/7/24, 15:42 Service Layer API Reference
PATCH [Link]

{
"Attachments2_Lines": [
{
"FileExtension": "so",
"FileName": "mod_negotiation",
"SourcePath": "/usr/sap/SAPBusinessOne/ServiceLayer/modules",
"UserID": "1"
},
{
"FileExtension": "so",
"FileName": "mod_negotiation2",
"SourcePath": "/usr/sap/SAPBusinessOne/ServiceLayer/modules",
"UserID": "1"
}
]
}

DELETE Attachments2(id)
Delete an instance of 'Attachments2' with the specified id.

Example

DELETE [Link]

AttributeGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AttributeGroups'.

GET AttributeGroups(id)
Retrieve all or some selected properties from an instance of 'AttributeGroups' with the given id.

Example

GET [Link]

GET [Link]

GET AttributeGroups

Retrieve a collection of 'AttributeGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=Code&$top=10&$skip=1

POST AttributeGroups

Create an instance of 'AttributeGroups' with the given payload of type 'AttributeGroup' in JSON format.

Example

POST [Link]

{
"AttributeGroupCollection": [
{
"AttributeID": 1,
"AttributeName": "test 1",
"DefaultValue": "5"
},
{
"AttributeID": 2,
"AttributeName": "test 2",
"DefaultValue": "6"
}
],
"Code": 1,

[Link] Layer API [Link] 105/334

6/7/24, 15:42 Service Layer API Reference
"Name": "test Attribute"
}

PATCH AttributeGroups(id)
Update an instance of 'AttributeGroups' with the given payload of type 'AttributeGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AttributeGroupCollection": [
{
"AttributeID": 1,
"AttributeName": "test 123",
"DefaultValue": "123",
"SortNumber": 1
}
]
}

DELETE AttributeGroups(id)
Delete an instance of 'AttributeGroups' with the specified id.

Example

DELETE [Link]

B1Sessions
Show/Hide
List Operations
Expand Operations

This entity is just used to enable Service Layer to be able to work with WCF. Currently, it has no practical usage and does not support CURD.

BankChargesAllocationCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BankChargesAllocationCodes'.

GET BankChargesAllocationCodes(id)

Retrieve all or some selected properties from an instance of 'BankChargesAllocationCodes' with the given id.

Example

GET [Link]

GET [Link]

GET BankChargesAllocationCodes

Retrieve a collection of 'BankChargesAllocationCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=1

POST BankChargesAllocationCodes

Create an instance of 'BankChargesAllocationCodes' with the given payload of type 'BankChargesAllocationCode' in JSON format.

Example

[Link] Layer API [Link] 106/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"Code": "001",
"Description": "bank charge allocation 001"
}

PATCH BankChargesAllocationCodes(id)
Update an instance of 'BankChargesAllocationCodes' with the given payload of type 'BankChargesAllocationCode' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"Description": "updated by Service Layer"
}

DELETE BankChargesAllocationCodes(id)
Delete an instance of 'BankChargesAllocationCodes' with the specified id.

Example

DELETE [Link]

POST BankChargesAllocationCodes(id)/SetDefaultBankChargesAllocationCode
Invoke the method 'SetDefaultBankChargesAllocationCode' on this EntitySet with the specified id.

Example

POST [Link]

BankPages
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BankPages'. It represents external bank statements in the Banking module.

GET BankPages(id)

Retrieve all or some selected properties from an instance of 'BankPages' with the given id.

Example

GET [Link]

GET [Link]

GET BankPages

Retrieve a collection of 'BankPages' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and Sequence ge

POST BankPages

Create an instance of 'BankPages' with the given payload of type 'BankPage' in JSON format.

Example

[Link] Layer API [Link] 107/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"AccountCode": "_SYS00000000001",
"CardCode": "c001",
"CreditAmount": "111",
"DocNumberType": "bpdt_DocNum",
"PaymentReference": "first pay"
}

PATCH BankPages(id)
Update an instance of 'BankPages' with the given payload of type 'BankPage' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PaymentReference": "Pay reference 01"
}

DELETE BankPages(id)
Delete an instance of 'BankPages' with the specified id.

Example

DELETE [Link]

Banks
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Banks'.

GET Banks(id)

Retrieve all or some selected properties from an instance of 'Banks' with the given id.

Example

GET [Link]

GET [Link]

GET Banks

Retrieve a collection of 'Banks' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Absolut

POST Banks

Create an instance of 'Banks' with the given payload of type 'Bank' in JSON format.

Example

POST [Link]

{
"BankCode": "b001",
"BankName": "US National Bank",
"CountryCode": "US",
"SwiftNo": "123456789"
}

[Link] Layer API [Link] 108/334

6/7/24, 15:42 Service Layer API Reference
PATCH Banks(id)

Update an instance of 'Banks' with the given payload of type 'Bank' in JSON format and with the specified id.

Example

PATCH [Link]

{
"BankName": "US Bank"
}

DELETE Banks(id)

Delete an instance of 'Banks' with the specified id.

Example

DELETE [Link]

BankStatements
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BankStatements'.

GET BankStatements(id)
Retrieve all or some selected properties from an instance of 'BankStatements' with the given id.

Example

GET [Link]

GET [Link]

GET BankStatements
Retrieve a collection of 'BankStatements' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orde

POST BankStatements
Create an instance of 'BankStatements' with the given payload of type 'BankStatement' in JSON format.

Example

POST [Link]

{
"BankAccountKey ": 1,
"BankStatementRows": [
{
"ExternalCode": "E1"
}
],
"MultiplePayments": [
{
"AmountFC": 20,
"IsDebit": "tYES"
}
]
}

PATCH BankStatements(id)

[Link] Layer API [Link] 109/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'BankStatements' with the given payload of type 'BankStatement' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Currency": "USD"
}

DELETE BankStatements(id)

Delete an instance of 'BankStatements' with the specified id.

Example

DELETE [Link]

BarCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BarCodes'.

GET BarCodes(id)

Retrieve all or some selected properties from an instance of 'BarCodes' with the given id.

Example

GET [Link]

GET [Link]

GET BarCodes

Retrieve a collection of 'BarCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$skip=1

POST BarCodes

Create an instance of 'BarCodes' with the given payload of type 'BarCode' in JSON format.

Example

POST [Link]

{
"AbsEntry": 1,
"Barcode": "1000001",
"FreeText": "01",
"ItemNo": "I001",
"UoMEntry": -1
}

PATCH BarCodes(id)

Update an instance of 'BarCodes' with the given payload of type 'BarCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Barcode": "500001"

[Link] Layer API [Link] 110/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE BarCodes(id)
Delete an instance of 'BarCodes' with the specified id.

Example

DELETE [Link]

BatchNumberDetails
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BatchNumberDetails'.

GET BatchNumberDetails(id)
Retrieve all or some selected properties from an instance of 'BatchNumberDetails' with the given id.

Example

GET [Link]

GET [Link]

GET BatchNumberDetails

Retrieve a collection of 'BatchNumberDetails' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry

PATCH BatchNumberDetails(id)

Update an instance of 'BatchNumberDetails' with the given payload of type 'BatchNumberDetail' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Status": "bdsStatus_Locked"
}

BillOfExchangeTransactions
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BillOfExchangeTransactions'.

GET BillOfExchangeTransactions(id)

Retrieve all or some selected properties from an instance of 'BillOfExchangeTransactions' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 111/334

6/7/24, 15:42 Service Layer API Reference
GET BillOfExchangeTransactions

Retrieve a collection of 'BillOfExchangeTransactions' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123

POST BillOfExchangeTransactions

Create an instance of 'BillOfExchangeTransactions' with the given payload of type 'BillOfExchangeTransactions' in JSON format.

Example

POST [Link]

{
"BillOfExchangeTransactionLines": [
{
"BillOfExchangeDueDate": "2014-12-10",
"BillOfExchangeNo": 1,
"BillOfExchangeType": "bobt_Outgoing"
}
],
"IsBoeReconciled": "tNO",
"StatusFrom": "btfs_Generated",
"StatusTo": "btts_Paid"
}

BinLocationAttributes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BinLocationAttributes'.

GET BinLocationAttributes(id)
Retrieve all or some selected properties from an instance of 'BinLocationAttributes' with the given id.

Example

GET [Link]

GET [Link]

GET BinLocationAttributes
Retrieve a collection of 'BinLocationAttributes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=1

POST BinLocationAttributes
Create an instance of 'BinLocationAttributes' with the given payload of type 'BinLocationAttribute' in JSON format.

Example

POST [Link]

{
"AbsEntry": 3,
"Attribute": 5,
"Code": "BinAttr03"
}

[Link] Layer API [Link] 112/334

6/7/24, 15:42 Service Layer API Reference
PATCH BinLocationAttributes(id)

Update an instance of 'BinLocationAttributes' with the given payload of type 'BinLocationAttribute' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Code": "BinAttr0212"
}

DELETE BinLocationAttributes(id)

Delete an instance of 'BinLocationAttributes' with the specified id.

Example

DELETE [Link]

BinLocationFields
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BinLocationFields'.

GET BinLocationFields(id)
Retrieve all or some selected properties from an instance of 'BinLocationFields' with the given id.

Example

GET [Link]

GET [Link]

GET BinLocationFields
Retrieve a collection of 'BinLocationFields' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$to

PATCH BinLocationFields(id)
Update an instance of 'BinLocationFields' with the given payload of type 'BinLocationField' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DefaultFieldName": "default_field"
}

BinLocations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BinLocations'.

GET BinLocations(id)

Retrieve all or some selected properties from an instance of 'BinLocations' with the given id.

[Link] Layer API [Link] 113/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET BinLocations

Retrieve a collection of 'BinLocations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$s

POST BinLocations

Create an instance of 'BinLocations' with the given payload of type 'BinLocation' in JSON format.

Example

POST [Link]

{
"BinCode": "02-PVG",
"Description": null,
"Inactive": "tNO",
"ReceivingBinLocation": "tNO",
"RestrictedItemType": "briNone",
"RestrictedUoMType": "bruNone",
"Sublevel1": "PVG",
"Warehouse": "02"
}

PATCH BinLocations(id)

Update an instance of 'BinLocations' with the given payload of type 'BinLocation' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "updated from sl"
}

DELETE BinLocations(id)

Delete an instance of 'BinLocations' with the specified id.

Example

DELETE [Link]

BlanketAgreements
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BlanketAgreements'.

GET BlanketAgreements(id)
Retrieve all or some selected properties from an instance of 'BlanketAgreements' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 114/334

6/7/24, 15:42 Service Layer API Reference

GET BlanketAgreements
Retrieve a collection of 'BlanketAgreements' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AgreementNo&$t

POST BlanketAgreements
Create an instance of 'BlanketAgreements' with the given payload of type 'BlanketAgreement' in JSON format.

Example

POST [Link]

{
"AgreementType": "atGeneral",
"BPCode": "C01",
"BlanketAgreements_ItemsLines": [
{
"ItemNo": "I01",
"PlannedQuantity": 100,
"UnitPrice": 100
},
{
"ItemNo": "I02",
"PlannedQuantity": 100,
"UnitPrice": 100
}
],
"EndDate": "2016-08-29",
"Status": "asDraft"
}

PATCH BlanketAgreements(id)
Update an instance of 'BlanketAgreements' with the given payload of type 'BlanketAgreement' in JSON format and with the specified id.

Example

PATCH [Link]

{
"BlanketAgreements_ItemsLines": [
{
"ItemNo": "I03",
"PlannedQuantity": 100,
"UnitPrice": 100
}
],
"Description": "Add a new item",
"EndDate": "2016-12-30",
"Status": "asApproved"
}

POST BlanketAgreements(id)/CancelBlanketAgreement
Invoke the method 'CancelBlanketAgreement' on this EntitySet with the specified id.

Example

POST [Link]

POST BlanketAgreements(id)/GetRelatedDocuments
Invoke the method 'GetRelatedDocuments' on this EntitySet with the specified id.

Example

POST [Link]

[Link] Layer API [Link] 115/334

6/7/24, 15:42 Service Layer API Reference

BOEDocumentTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BOEDocumentTypes'.

GET BOEDocumentTypes(id)
Retrieve all or some selected properties from an instance of 'BOEDocumentTypes' with the given id.

Example

GET [Link]

GET [Link]

GET BOEDocumentTypes
Retrieve a collection of 'BOEDocumentTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$to

POST BOEDocumentTypes
Create an instance of 'BOEDocumentTypes' with the given payload of type 'BOEDocumentType' in JSON format.

Example

POST [Link]

{
"DocDescription": "testing",
"DocType": "11"
}

PATCH BOEDocumentTypes(id)
Update an instance of 'BOEDocumentTypes' with the given payload of type 'BOEDocumentType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DocDescription": "testing",
"DocType": "11"
}

DELETE BOEDocumentTypes(id)
Delete an instance of 'BOEDocumentTypes' with the specified id.

Example

DELETE [Link]

BOEInstructions
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BOEInstructions'.

GET BOEInstructions(id)

[Link] Layer API [Link] 116/334

6/7/24, 15:42 Service Layer API Reference
Retrieve all or some selected properties from an instance of 'BOEInstructions' with the given id.

Example

GET [Link]

GET [Link]

GET BOEInstructions

Retrieve a collection of 'BOEInstructions' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 12

POST BOEInstructions

Create an instance of 'BOEInstructions' with the given payload of type 'BOEInstruction' in JSON format.

Example

POST [Link]

{
"InstructionCode": "01",
"InstructionDesc": "01",
"IsCancelInstruction": "tYES"
}

PATCH BOEInstructions(id)

Update an instance of 'BOEInstructions' with the given payload of type 'BOEInstruction' in JSON format and with the specified id.

Example

PATCH [Link]

{
"InstructionCode": "02",
"InstructionDesc": "02",
"IsCancelInstruction": "tNO"
}

DELETE BOEInstructions(id)

Delete an instance of 'BOEInstructions' with the specified id.

Example

DELETE [Link]

BOEPortfolios
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BOEPortfolios'.

GET BOEPortfolios(id)

Retrieve all or some selected properties from an instance of 'BOEPortfolios' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 117/334

6/7/24, 15:42 Service Layer API Reference

GET BOEPortfolios
Retrieve a collection of 'BOEPortfolios' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=

POST BOEPortfolios
Create an instance of 'BOEPortfolios' with the given payload of type 'BOEPortfolio' in JSON format.

Example

POST [Link]

{
"PortfolioCode": "01",
"PortfolioDescription": "01",
"PortfolioID": "01",
"PortfolioNum": "01"
}

PATCH BOEPortfolios(id)
Update an instance of 'BOEPortfolios' with the given payload of type 'BOEPortfolio' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PortfolioCode": "02",
"PortfolioDescription": "02",
"PortfolioID": "02",
"PortfolioNum": "02"
}

DELETE BOEPortfolios(id)
Delete an instance of 'BOEPortfolios' with the specified id.

Example

DELETE [Link]

BPPriorities
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BPPriorities'.

GET BPPriorities(id)

Retrieve all or some selected properties from an instance of 'BPPriorities' with the given id.

Example

GET [Link]

GET [Link]

GET BPPriorities

Retrieve a collection of 'BPPriorities' with all or some selected properties in the given order by specifying the given filter condition.

[Link] Layer API [Link] 118/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link] ge 123 &$orderby=Priority&$top=10&$s

POST BPPriorities

Create an instance of 'BPPriorities' with the given payload of type 'BPPriority' in JSON format.

Example

POST [Link]

{
"Priority": "P4",
"PriorityDescription": "Third"
}

PATCH BPPriorities(id)

Update an instance of 'BPPriorities' with the given payload of type 'BPPriority' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PriorityDescription": "HighPri"
}

DELETE BPPriorities(id)

Delete an instance of 'BPPriorities' with the specified id.

Example

DELETE [Link]

Branches
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Branches'.

GET Branches(id)
Retrieve all or some selected properties from an instance of 'Branches' with the given id.

Example

GET [Link]

GET [Link]

GET Branches
Retrieve a collection of 'Branches' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST Branches

[Link] Layer API [Link] 119/334

6/7/24, 15:42 Service Layer API Reference
Create an instance of 'Branches' with the given payload of type 'Branch' in JSON format.

Example

POST [Link]

{
"Description": "Main Branch",
"Name": "Branch2"
}

PATCH Branches(id)

Update an instance of 'Branches' with the given payload of type 'Branch' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "Main Branch updated"
}

DELETE Branches(id)

Delete an instance of 'Branches' with the specified id.

Example

DELETE [Link]

BrazilBeverageIndexers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BrazilBeverageIndexers'.

GET BrazilBeverageIndexers(id)

Retrieve all or some selected properties from an instance of 'BrazilBeverageIndexers' with the given id.

Example

GET [Link]

GET [Link]

GET BrazilBeverageIndexers

Retrieve a collection of 'BrazilBeverageIndexers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST BrazilBeverageIndexers

Create an instance of 'BrazilBeverageIndexers' with the given payload of type 'BrazilBeverageIndexer' in JSON format.

Example

POST [Link]

{
"BeverageCommercialBrandCode": 52,
"BeverageGroupCode": "13",
"BeverageTableCode": "07"
}

[Link] Layer API [Link] 120/334

6/7/24, 15:42 Service Layer API Reference
DELETE BrazilBeverageIndexers(id)

Delete an instance of 'BrazilBeverageIndexers' with the specified id.

Example

DELETE [Link]

BrazilFuelIndexers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BrazilFuelIndexers'.

GET BrazilFuelIndexers(id)

Retrieve all or some selected properties from an instance of 'BrazilFuelIndexers' with the given id.

Example

GET [Link]

GET [Link]

GET BrazilFuelIndexers
Retrieve a collection of 'BrazilFuelIndexers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 797 &$orderby=FuelID&$top=10

POST BrazilFuelIndexers
Create an instance of 'BrazilFuelIndexers' with the given payload of type 'BrazilFuelIndexer' in JSON format.

Example

POST [Link]

{
"Description": "999999999-Description",
"FuelCode": "999999999",
"FuelGroupCode": "1"
}

DELETE BrazilFuelIndexers(id)
Delete an instance of 'BrazilFuelIndexers' with the specified id.

Example

DELETE [Link]

BrazilMultiIndexers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BrazilMultiIndexers'.

GET BrazilMultiIndexers(id)

Retrieve all or some selected properties from an instance of 'BrazilMultiIndexers' with the given id.

[Link] Layer API [Link] 121/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET BrazilMultiIndexers

Retrieve a collection of 'BrazilMultiIndexers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 670 &$orderby=ID&$top=10&$skip=1

POST BrazilMultiIndexers

Create an instance of 'BrazilMultiIndexers' with the given payload of type 'BrazilMultiIndexer' in JSON format.

Example

POST [Link]

{
"Code": "1114",
"Description": "Gasolinas, Exceto Gasolina de Avia\u00e7\u00e3o",
"FirstRefIndexerCode": "1",
"IndexerType": "bmitIncomeNature",
"SecondRefIndexerCode": "101",
"ThirdRefIndexerCode": null
}

DELETE BrazilMultiIndexers(id)

Delete an instance of 'BrazilMultiIndexers' with the specified id.

Example

DELETE [Link]

POST BrazilMultiIndexers(id)/GetIndexerTypeList

Invoke the method 'GetIndexerTypeList' on this EntitySet with the specified id.

Example

POST [Link]

BrazilNumericIndexers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BrazilNumericIndexers'.

GET BrazilNumericIndexers(id)
Retrieve all or some selected properties from an instance of 'BrazilNumericIndexers' with the given id.

Example

GET [Link]

GET [Link]

GET BrazilNumericIndexers

[Link] Layer API [Link] 122/334

6/7/24, 15:42 Service Layer API Reference
Retrieve a collection of 'BrazilNumericIndexers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1119 &$orderby=ID&$top=10&$ski

POST BrazilNumericIndexers

Create an instance of 'BrazilNumericIndexers' with the given payload of type 'BrazilNumericIndexer' in JSON format.

Example

POST [Link]

{
"Code": "15",
"Description": "Sociedade empres\u00e1ria em geral",
"IndexerType": "bnitNatureOfCompany"
}

DELETE BrazilNumericIndexers(id)

Delete an instance of 'BrazilNumericIndexers' with the specified id.

Example

DELETE [Link]

POST BrazilNumericIndexers(id)/GetIndexerTypeList

Invoke the method 'GetIndexerTypeList' on this EntitySet with the specified id.

Example

POST [Link]

BrazilStringIndexers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BrazilStringIndexers'.

GET BrazilStringIndexers(id)

Retrieve all or some selected properties from an instance of 'BrazilStringIndexers' with the given id.

Example

GET [Link]

GET [Link]

GET BrazilStringIndexers

Retrieve a collection of 'BrazilStringIndexers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 849 &$orderby=ID&$top=10&$skip=

POST BrazilStringIndexers

[Link] Layer API [Link] 123/334

6/7/24, 15:42 Service Layer API Reference
Create an instance of 'BrazilStringIndexers' with the given payload of type 'BrazilStringIndexer' in JSON format.

Example

POST [Link]

{
"Code": "3",
"Description": "aaaaaaaa",
"IndexerType": "bsitIPIPeriod"
}

DELETE BrazilStringIndexers(id)

Delete an instance of 'BrazilStringIndexers' with the specified id.

Example

DELETE [Link]

POST BrazilStringIndexers(id)/GetIndexerTypeList

Invoke the method 'GetIndexerTypeList' on this EntitySet with the specified id.

Example

POST [Link]

BudgetDistributions
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BudgetDistributions'.

GET BudgetDistributions(id)

Retrieve all or some selected properties from an instance of 'BudgetDistributions' with the given id.

Example

GET [Link]

GET [Link]

GET BudgetDistributions

Retrieve a collection of 'BudgetDistributions' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DivisionCode&$t

POST BudgetDistributions

Create an instance of 'BudgetDistributions' with the given payload of type 'BudgetDistribution' in JSON format.

Example

POST [Link]

{
"BudgetAmount": 1.0,
"Description": "DisRule",
"September": 1.0
}

[Link] Layer API [Link] 124/334

6/7/24, 15:42 Service Layer API Reference
PATCH BudgetDistributions(id)

Update an instance of 'BudgetDistributions' with the given payload of type 'BudgetDistribution' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "Budget Distribution"
}

DELETE BudgetDistributions(id)

Delete an instance of 'BudgetDistributions' with the specified id.

Example

DELETE [Link]

Budgets
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Budgets' based on G/L accounts.

GET Budgets(id)
Retrieve all or some selected properties from an instance of 'Budgets' with the given id.

Example

GET [Link]

GET [Link]

GET Budgets
Retrieve a collection of 'Budgets' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST Budgets
Create an instance of 'Budgets' with the given payload of type 'Budget' in JSON format.

Example

POST [Link]

{
"AccountCode": "_SYS00000000220",
"StartofFiscalYear": "2014-01-01",
"TotalAnnualBudgetDebitLoc": "0.894"
}

PATCH Budgets(id)
Update an instance of 'Budgets' with the given payload of type 'Budget' in JSON format and with the specified id.

Example

PATCH [Link]

{
"TotalAnnualBudgetDebitLoc": "12.345"

[Link] Layer API [Link] 125/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE Budgets(id)
Delete an instance of 'Budgets' with the specified id.

Example

DELETE [Link]

BudgetScenarios
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BudgetScenarios'.

GET BudgetScenarios(id)
Retrieve all or some selected properties from an instance of 'BudgetScenarios' with the given id.

Example

GET [Link]

GET [Link]

GET BudgetScenarios

Retrieve a collection of 'BudgetScenarios' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderb

POST BudgetScenarios

Create an instance of 'BudgetScenarios' with the given payload of type 'BudgetScenario' in JSON format.

Example

POST [Link]

{
"BasicBudget": "1",
"InitialRatioPercentage": "100",
"Name": "newScenario",
"RoundingMethod": "borm_NoRounding",
"StartofFiscalYear": "2014-01-01"
}

PATCH BudgetScenarios(id)

Update an instance of 'BudgetScenarios' with the given payload of type 'BudgetScenario' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "new2014"
}

DELETE BudgetScenarios(id)

Delete an instance of 'BudgetScenarios' with the specified id.

Example

[Link] Layer API [Link] 126/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

BusinessPartnerGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BusinessPartnerGroups'. It represents the setup of customer and vendor groups. Used for classifying business partners
according to different criteria, such as sector or size.

GET BusinessPartnerGroups(id)
Retrieve all or some selected properties from an instance of 'BusinessPartnerGroups' with the given id.

Example

GET [Link]

GET [Link]

GET BusinessPartnerGroups
Retrieve a collection of 'BusinessPartnerGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST BusinessPartnerGroups

Create an instance of 'BusinessPartnerGroups' with the given payload of type 'BusinessPartnerGroup' in JSON format.

Example

POST [Link]

{
"Name": "newGroup",
"Type": "bbpgt_CustomerGroup"
}

PATCH BusinessPartnerGroups(id)

Update an instance of 'BusinessPartnerGroups' with the given payload of type 'BusinessPartnerGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "bigCustomer"
}

DELETE BusinessPartnerGroups(id)

Delete an instance of 'BusinessPartnerGroups' with the specified id.

Example

DELETE [Link]

BusinessPartnerProperties
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 127/334

6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'BusinessPartnerProperties'.

GET BusinessPartnerProperties(id)
Retrieve all or some selected properties from an instance of 'BusinessPartnerProperties' with the given id.

Example

GET [Link]

GET [Link]

GET BusinessPartnerProperties
Retrieve a collection of 'BusinessPartnerProperties' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=Propert

PATCH BusinessPartnerProperties(id)
Update an instance of 'BusinessPartnerProperties' with the given payload of type 'BusinessPartnerProperty' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PropertyName": "test"
}

BusinessPartners
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BusinessPartners'. It represents the business partners master data in the Business Partners module. You can use this data to
record and retrieve business partner (customers, vendors, and leads) information and schedule business partner activities.

GET BusinessPartners(id)

Retrieve all or some selected properties from an instance of 'BusinessPartners' with the given id.

Example

GET [Link]

GET [Link]

GET BusinessPartners

Retrieve a collection of 'BusinessPartners' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=CardCod

POST BusinessPartners

Create an instance of 'BusinessPartners' with the given payload of type 'BusinessPartner' in JSON format.

Example

[Link] Layer API [Link] 128/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"CardCode": "c001",
"CardName": "c001",
"CardType": "C"
}

PATCH BusinessPartners(id)
Update an instance of 'BusinessPartners' with the given payload of type 'BusinessPartner' in JSON format and with the specified id.

Example

PATCH [Link]

{
"CardName": "Updated customer name"
}

DELETE BusinessPartners(id)
Delete an instance of 'BusinessPartners' with the specified id.

Example

DELETE [Link]

BusinessPlaces
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BusinessPlaces'. It represents a company's business locations.

GET BusinessPlaces(id)

Retrieve all or some selected properties from an instance of 'BusinessPlaces' with the given id.

Example

GET [Link]

GET [Link]

GET BusinessPlaces

Retrieve a collection of 'BusinessPlaces' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=BPLID&$top=10&$skip=

POST BusinessPlaces

Create an instance of 'BusinessPlaces' with the given payload of type 'BusinessPlace' in JSON format.

Example

POST [Link]

{
"Address": "No. 1001 Chenghui road",
"BPLName": "LG",
"BPLNameForeign": "LG",
"Industry": "manufacture",
"RepName": "new LG",
"VATRegNum": "222-33-47528"
}

[Link] Layer API [Link] 129/334

6/7/24, 15:42 Service Layer API Reference
PATCH BusinessPlaces(id)

Update an instance of 'BusinessPlaces' with the given payload of type 'BusinessPlace' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Address": "No. 101 Huaxia Road"
}

DELETE BusinessPlaces(id)

Delete an instance of 'BusinessPlaces' with the specified id.

Example

DELETE [Link]

CampaignResponseType
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CampaignResponseType'.

GET CampaignResponseType(id)
Retrieve all or some selected properties from an instance of 'CampaignResponseType' with the given id.

Example

GET [Link]

GET [Link]

GET CampaignResponseType
Retrieve a collection of 'CampaignResponseType' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST CampaignResponseType
Create an instance of 'CampaignResponseType' with the given payload of type 'CampaignResponseType' in JSON format.

Example

POST [Link]

{
"IsActive": "tYES",
"ResponseType": "01",
"ResponseTypeDescription": "001"
}

PATCH CampaignResponseType(id)
Update an instance of 'CampaignResponseType' with the given payload of type 'CampaignResponseType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"IsActive": "tNO"

[Link] Layer API [Link] 130/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE CampaignResponseType(id)
Delete an instance of 'CampaignResponseType' with the specified id.

Example

DELETE [Link]

Campaigns
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Campaigns'.

GET Campaigns(id)
Retrieve all or some selected properties from an instance of 'Campaigns' with the given id.

Example

GET [Link]

GET [Link]

GET Campaigns

Retrieve a collection of 'Campaigns' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=Campai

POST Campaigns

Create an instance of 'Campaigns' with the given payload of type 'Campaign' in JSON format.

Example

POST [Link]

{
"CampaignBusinessPartners": [
{
"BPCode": "C01"
},
{
"BPCode": "V01"
}
],
"CampaignName": "Party",
"CampaignType": "ctEmail",
"StartDate": "2016-12-30"
}

PATCH Campaigns(id)

Update an instance of 'Campaigns' with the given payload of type 'Campaign' in JSON format and with the specified id.

Example

PATCH [Link]

{
"StartDate": "2016-10-30"
}

DELETE Campaigns(id)
[Link] Layer API [Link] 131/334
6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'Campaigns' with the specified id.

Example

DELETE [Link]

POST Campaigns(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

CashDiscounts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CashDiscounts'.

GET CashDiscounts(id)

Retrieve all or some selected properties from an instance of 'CashDiscounts' with the given id.

Example

GET [Link]

GET [Link]

GET CashDiscounts

Retrieve a collection of 'CashDiscounts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '') &$orderby=Code&$top=10&$skip=1

POST CashDiscounts

Create an instance of 'CashDiscounts' with the given payload of type 'CashDiscount' in JSON format.

Example

POST [Link]

{
"ByDate": "tNO",
"Code": "EPDiscount",
"DiscountLines": [
{
"Discount": 15,
"DiscountCode": "EPDiscount",
"LineId": 0,
"NumOfDays": 10
},
{
"Discount": 25,
"DiscountCode": "EPDiscount",
"LineId": 1,
"NumOfDays": 15
}
],
"Freight": "tYES",
"Name": "Early Pay Discount",
"Tax": "tYES"
}

PATCH CashDiscounts(id)

[Link] Layer API [Link] 132/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'CashDiscounts' with the given payload of type 'CashDiscount' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DiscountLines": [
{
"Discount": 20,
"LineId": 0,
"NumOfDays": 20
},
{
"Discount": 30,
"LineId": 1,
"NumOfDays": 25
},
{
"Discount": 35,
"LineId": 2,
"NumOfDays": 35
}
],
"Name": "Early Pay changed"
}

DELETE CashDiscounts(id)

Delete an instance of 'CashDiscounts' with the specified id.

Example

DELETE [Link]

CashFlowLineItems
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CashFlowLineItems'.

GET CashFlowLineItems(id)

Retrieve all or some selected properties from an instance of 'CashFlowLineItems' with the given id.

Example

GET [Link]

GET [Link]

GET CashFlowLineItems

Retrieve a collection of 'CashFlowLineItems' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=Line

CertificateSeries
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CertificateSeries'.

GET CertificateSeries(id)

Retrieve all or some selected properties from an instance of 'CertificateSeries' with the given id.

[Link] Layer API [Link] 133/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET CertificateSeries

Retrieve a collection of 'CertificateSeries' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$ski

POST CertificateSeries

Create an instance of 'CertificateSeries' with the given payload of type 'CertificateSeries' in JSON format.

Example

POST [Link]

{
"AbsEntry": 1,
"Code": "D1",
"DefaultSeries": 0,
"Location": -1,
"Section": 1,
"SeriesLines": [
{
"FirstNum": 1,
"LastNum": null,
"NextNum": 1,
"Prefix": "D",
"Series": 0
}
]
}

PATCH CertificateSeries(id)

Update an instance of 'CertificateSeries' with the given payload of type 'CertificateSeries' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Code": "C123"
}

DELETE CertificateSeries(id)

Delete an instance of 'CertificateSeries' with the specified id.

Example

DELETE [Link]

ChartOfAccounts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ChartOfAccounts'. It represents the General Ledger (G/L) accounts in the Finance module. The Chart of Accounts is an index
of all G/L accounts that are used by one or more companies. For every G/L account there is an account number, an account description, and information that
determines the function of the account.

GET ChartOfAccounts(id)
Retrieve all or some selected properties from an instance of 'ChartOfAccounts' with the given id.

[Link] Layer API [Link] 134/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET ChartOfAccounts

Retrieve a collection of 'ChartOfAccounts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$skip=1

POST ChartOfAccounts

Create an instance of 'ChartOfAccounts' with the given payload of type 'ChartOfAccount' in JSON format.

Example

POST [Link]

{
"FatherAccountKey": "100000000000000k",
"FormatCode": "100000000100101",
"Name": "Test Account"
}

PATCH ChartOfAccounts(id)

Update an instance of 'ChartOfAccounts' with the given payload of type 'ChartOfAccount' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Updated Account"
}

DELETE ChartOfAccounts(id)

Delete an instance of 'ChartOfAccounts' with the specified id.

Example

DELETE [Link]

ChecksforPayment
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ChecksforPayment'. It represents checks payable that are not tied to a document.

GET ChecksforPayment(id)
Retrieve all or some selected properties from an instance of 'ChecksforPayment' with the given id.

Example

GET [Link]

GET [Link]

GET ChecksforPayment

[Link] Layer API [Link] 135/334

6/7/24, 15:42 Service Layer API Reference
Retrieve a collection of 'ChecksforPayment' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=CheckKey&$top=

POST ChecksforPayment

Create an instance of 'ChecksforPayment' with the given payload of type 'ChecksforPayment' in JSON format.

Example

POST [Link]

{
"AccountNumber": "11123456",
"BankCode": "bank01",
"Branch": "123",
"CardOrAccount": "cfp_Account",
"ChecksforPaymentLines": [
{
"RowTotal": "315"
}
],
"CountryCode": "US",
"CustomerAccountCode": "_SYS00000000052",
"Details": "Add checks for payment",
"VendorCode": "_SYS00000000006"
}

PATCH ChecksforPayment(id)

Update an instance of 'ChecksforPayment' with the given payload of type 'ChecksforPayment' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Details": "update check payment"
}

ChooseFromList
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ChooseFromList'.

GET ChooseFromList(id)

Retrieve all or some selected properties from an instance of 'ChooseFromList' with the given id.

Example

GET [Link]

GET [Link]

GET ChooseFromList

Retrieve a collection of 'ChooseFromList' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Ob

POST ChooseFromList

[Link] Layer API [Link] 136/334

6/7/24, 15:42 Service Layer API Reference
Create an instance of 'ChooseFromList' with the given payload of type 'ChooseFromList' in JSON format.

Example

POST [Link]

{
"ChooseFromList_Lines": [
{
"DisplayedName": "Weight",
"FieldNo": "1",
"ShowType": "tYES",
"SortOrder": "soAscending",
"Visible": "tNO"
}
],
"ObjectName": "ITM1"
}

PATCH ChooseFromList(id)

Update an instance of 'ChooseFromList' with the given payload of type 'ChooseFromList' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ChooseFromList_Lines": [
{
"FieldNo": "1",
"Visible": "tYES"
}
]
}

DELETE ChooseFromList(id)

Delete an instance of 'ChooseFromList' with the specified id.

Example

DELETE [Link]

Cockpits
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Cockpits'.

GET Cockpits(id)

Retrieve all or some selected properties from an instance of 'Cockpits' with the given id.

Example

GET [Link]

GET [Link]

GET Cockpits

Retrieve a collection of 'Cockpits' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$skip=1

POST Cockpits

[Link] Layer API [Link] 137/334

6/7/24, 15:42 Service Layer API Reference
Create an instance of 'Cockpits' with the given payload of type 'Cockpit' in JSON format.

Example

POST [Link]

{
"AbsEntry": 4,
"CockpitType": "cptt_UserCockpit",
"Code": 1,
"Date": null,
"Description": null,
"Manufacturer": "SAP",
"Name": "Home11",
"Publisher": null,
"Time": null,
"UserSignature": 1
}

PATCH Cockpits(id)

Update an instance of 'Cockpits' with the given payload of type 'Cockpit' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test"
}

DELETE Cockpits(id)

Delete an instance of 'Cockpits' with the specified id.

Example

DELETE [Link]

CommissionGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CommissionGroups'. It defines commission groups for a sales employee, an item, or a customer.

GET CommissionGroups(id)

Retrieve all or some selected properties from an instance of 'CommissionGroups' with the given id.

Example

GET [Link]

GET [Link]

GET CommissionGroups

Retrieve a collection of 'CommissionGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST CommissionGroups

Create an instance of 'CommissionGroups' with the given payload of type 'CommissionGroup' in JSON format.

Example

[Link] Layer API [Link] 138/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"CommissionGroupName": "Medium Commission",
"CommissionPercentage": "10"
}

PATCH CommissionGroups(id)
Update an instance of 'CommissionGroups' with the given payload of type 'CommissionGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"CommissionPercentage": "28"
}

DELETE CommissionGroups(id)
Delete an instance of 'CommissionGroups' with the specified id.

Example

DELETE [Link]

Contacts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Contacts'. It represents the activities carried out with customers and vendors.

GET Contacts(id)

Retrieve all or some selected properties from an instance of 'Contacts' with the given id.

Example

GET [Link]

GET [Link]

GET Contacts

Retrieve a collection of 'Contacts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=ContactCode&$top=10&$s

POST Contacts

Create an instance of 'Contacts' with the given payload of type 'Contact' in JSON format.

Example

POST [Link]

{
"Activity": "cn_Meeting",
"CardCode": "v001",
"Details": "create meeting type activity"
}

PATCH Contacts(id)

Update an instance of 'Contacts' with the given payload of type 'Contact' in JSON format and with the specified id.

[Link] Layer API [Link] 139/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"Details": "follow up meeting"
}

DELETE Contacts(id)

Delete an instance of 'Contacts' with the specified id.

Example

DELETE [Link]

ContractTemplates
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ContractTemplates'.

GET ContractTemplates(id)
Retrieve all or some selected properties from an instance of 'ContractTemplates' with the given id.

Example

GET [Link]

GET [Link]

GET ContractTemplates
Retrieve a collection of 'ContractTemplates' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST ContractTemplates
Create an instance of 'ContractTemplates' with the given payload of type 'ContractTemplate' in JSON format.

Example

POST [Link]

{
"ContractType": "ct_SerialNumber",
"Description": "for service",
"MondayEnabled": "tNO",
"Remarks": "Create new Contract Template",
"TemplateName": "newTemplate"
}

PATCH ContractTemplates(id)
Update an instance of 'ContractTemplates' with the given payload of type 'ContractTemplate' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Details": "new service contract template"
}

[Link] Layer API [Link] 140/334

6/7/24, 15:42 Service Layer API Reference
DELETE ContractTemplates(id)

Delete an instance of 'ContractTemplates' with the specified id.

Example

DELETE [Link]

CorrectionInvoice
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CorrectionInvoice'.

GET CorrectionInvoice(id)

Retrieve all or some selected properties from an instance of 'CorrectionInvoice' with the given id.

Example

GET [Link]

GET [Link]

GET CorrectionInvoice
Retrieve a collection of 'CorrectionInvoice' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$s

POST CorrectionInvoice
Create an instance of 'CorrectionInvoice' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"Comments": "Added by Service Layer",
"DocumentLines": [
{
"CorrectionInvoiceItem": "ciis_ShouldBe",
"ItemCode": "item01",
"Price": "310",
"Quantity": "10",
"VatGroup": "B4"
},
{
"CorrectionInvoiceItem": "ciis_Was",
"ItemCode": "item01",
"Price": "110",
"Quantity": "10",
"VatGroup": "B4"
}
]
}

PATCH CorrectionInvoice(id)
Update an instance of 'CorrectionInvoice' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"

[Link] Layer API [Link] 141/334

6/7/24, 15:42 Service Layer API Reference
}

POST CorrectionInvoice(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionInvoice(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionInvoice(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionInvoice(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

CorrectionInvoiceReversal
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CorrectionInvoiceReversal'. It is used to reverse the correction invoice.

GET CorrectionInvoiceReversal(id)

Retrieve all or some selected properties from an instance of 'CorrectionInvoiceReversal' with the given id.

Example

GET [Link]

GET [Link]

GET CorrectionInvoiceReversal

Retrieve a collection of 'CorrectionInvoiceReversal' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$t

POST CorrectionInvoiceReversal

Create an instance of 'CorrectionInvoiceReversal' with the given payload of type 'Document' in JSON format.

[Link] Layer API [Link] 142/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"CardCode": "c001",
"Comments": "add correction invoice reversal based on correction invoice",
"DocDate": "2014-12-06",
"DocDueDate": "2014-12-06",
"InternalCorrectedDocNum": "10"
}

PATCH CorrectionInvoiceReversal(id)

Update an instance of 'CorrectionInvoiceReversal' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST CorrectionInvoiceReversal(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionInvoiceReversal(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionInvoiceReversal(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionInvoiceReversal(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

CorrectionPurchaseInvoice
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CorrectionPurchaseInvoice'. It is used to correct the purchase invoice.

GET CorrectionPurchaseInvoice(id)
Retrieve all or some selected properties from an instance of 'CorrectionPurchaseInvoice' with the given id.

Example

[Link] Layer API [Link] 143/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link]

GET CorrectionPurchaseInvoice
Retrieve a collection of 'CorrectionPurchaseInvoice' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$t

POST CorrectionPurchaseInvoice
Create an instance of 'CorrectionPurchaseInvoice' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "v001",
"Comments": "Added by Service Layer",
"DocumentLines": [
{
"CorrectionInvoiceItem": "ciis_ShouldBe",
"ItemCode": "item01",
"Price": "310",
"Quantity": "10",
"VatGroup": "B4"
},
{
"CorrectionInvoiceItem": "ciis_Was",
"ItemCode": "item01",
"Price": "110",
"Quantity": "10",
"VatGroup": "B4"
}
]
}

PATCH CorrectionPurchaseInvoice(id)
Update an instance of 'CorrectionPurchaseInvoice' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST CorrectionPurchaseInvoice(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionPurchaseInvoice(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionPurchaseInvoice(id)/Reopen

[Link] Layer API [Link] 144/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionPurchaseInvoice(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

CorrectionPurchaseInvoiceReversal
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CorrectionPurchaseInvoiceReversal'. It is used to reverse the correction purchase invoice.

GET CorrectionPurchaseInvoiceReversal(id)

Retrieve all or some selected properties from an instance of 'CorrectionPurchaseInvoiceReversal' with the given id.

Example

GET [Link]

GET [Link]

GET CorrectionPurchaseInvoiceReversal

Retrieve a collection of 'CorrectionPurchaseInvoiceReversal' with all or some selected properties in the given order by specifying the given filter
condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Doc

POST CorrectionPurchaseInvoiceReversal

Create an instance of 'CorrectionPurchaseInvoiceReversal' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "v001",
"Comments": "add correction invoice reversal based on correction invoice",
"DocDate": "2014-12-06",
"DocDueDate": "2014-12-06",
"InternalCorrectedDocNum": "8"
}

PATCH CorrectionPurchaseInvoiceReversal(id)

Update an instance of 'CorrectionPurchaseInvoiceReversal' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

[Link] Layer API [Link] 145/334

6/7/24, 15:42 Service Layer API Reference
POST CorrectionPurchaseInvoiceReversal(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionPurchaseInvoiceReversal(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionPurchaseInvoiceReversal(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST CorrectionPurchaseInvoiceReversal(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

CostCenterTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CostCenterTypes'.

GET CostCenterTypes(id)
Retrieve all or some selected properties from an instance of 'CostCenterTypes' with the given id.

Example

GET [Link]

GET [Link]

GET CostCenterTypes
Retrieve a collection of 'CostCenterTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 't

POST CostCenterTypes
Create an instance of 'CostCenterTypes' with the given payload of type 'CostCenterType' in JSON format.

Example

[Link] Layer API [Link] 146/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"CostCenterTypeCode": "test",
"CostCenterTypeName": "123"
}

PATCH CostCenterTypes(id)
Update an instance of 'CostCenterTypes' with the given payload of type 'CostCenterType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"CostCenterTypeName": "123"
}

DELETE CostCenterTypes(id)
Delete an instance of 'CostCenterTypes' with the specified id.

Example

DELETE [Link]

CostElements
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CostElements'.

GET CostElements(id)

Retrieve all or some selected properties from an instance of 'CostElements' with the given id.

Example

GET [Link]

GET [Link]

GET CostElements

Retrieve a collection of 'CostElements' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$sk

POST CostElements

Create an instance of 'CostElements' with the given payload of type 'CostElement' in JSON format.

Example

POST [Link]

{
"Code": "CE 01",
"Description": "Cost Element 001",
"IsActive": "tYES"
}

PATCH CostElements(id)

Update an instance of 'CostElements' with the given payload of type 'CostElement' in JSON format and with the specified id.

[Link] Layer API [Link] 147/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link] 01')

{
"Description": "Cost Element 000001",
"IsActive": "tNO"
}

DELETE CostElements(id)

Delete an instance of 'CostElements' with the specified id.

Example

DELETE [Link]

Countries
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Countries'. It manages the settings of each country, such as country code, country name and address format.

GET Countries(id)
Retrieve all or some selected properties from an instance of 'Countries' with the given id.

Example

GET [Link]

GET [Link]

GET Countries
Retrieve a collection of 'Countries' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$skip=1

POST Countries
Create an instance of 'Countries' with the given payload of type 'Country' in JSON format.

Example

POST [Link]

{
"Code": "NC",
"Name": "New Country"
}

PATCH Countries(id)
Update an instance of 'Countries' with the given payload of type 'Country' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Details": "created new country"
}

DELETE Countries(id)

[Link] Layer API [Link] 148/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'Countries' with the specified id.

Example

DELETE [Link]

CreditCardPayments
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CreditCardPayments'. It defines dates on which the credit card company credits the cardholder.

GET CreditCardPayments(id)

Retrieve all or some selected properties from an instance of 'CreditCardPayments' with the given id.

Example

GET [Link]

GET [Link]

GET CreditCardPayments

Retrieve a collection of 'CreditCardPayments' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$

POST CreditCardPayments

Create an instance of 'CreditCardPayments' with the given payload of type 'CreditCardPayment' in JSON format.

Example

POST [Link]

{
"DueDateCode": "code01",
"DueDateName": "10 days"
}

PATCH CreditCardPayments(id)

Update an instance of 'CreditCardPayments' with the given payload of type 'CreditCardPayment' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DueDateName": "15 days"
}

DELETE CreditCardPayments(id)

Delete an instance of 'CreditCardPayments' with the specified id.

Example

DELETE [Link]

CreditCards

[Link] Layer API [Link] 149/334

6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CreditCards'. It defines credit cards that the company can use for incoming and outgoing payments.

GET CreditCards(id)
Retrieve all or some selected properties from an instance of 'CreditCards' with the given id.

Example

GET [Link]

GET [Link]

GET CreditCards
Retrieve a collection of 'CreditCards' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Cre

POST CreditCards
Create an instance of 'CreditCards' with the given payload of type 'CreditCard' in JSON format.

Example

POST [Link]

{
"CompanyID": "123456789",
"CreditCardName": "Test",
"GLAccount": "_SYS00000000004",
"Telephone": "61087839"
}

PATCH CreditCards(id)
Update an instance of 'CreditCards' with the given payload of type 'CreditCard' in JSON format and with the specified id.

Example

PATCH [Link]

{
"CreditCardName": "Updated Name"
}

DELETE CreditCards(id)
Delete an instance of 'CreditCards' with the specified id.

Example

DELETE [Link]

CreditNotes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CreditNotes'. It is the clearing document for invoices and returns. If the goods were delivered to the customer and an invoice
has already been created, you can partially or completely reverse the transaction by creating a credit note.

GET CreditNotes(id)

[Link] Layer API [Link] 150/334

6/7/24, 15:42 Service Layer API Reference
Retrieve all or some selected properties from an instance of 'CreditNotes' with the given id.

Example

GET [Link]

GET [Link]

GET CreditNotes

Retrieve a collection of 'CreditNotes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=1

POST CreditNotes

Create an instance of 'CreditNotes' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Price": 100,
"Quantity": 1,
"TaxCode": "T1"
}
]
}

PATCH CreditNotes(id)

Update an instance of 'CreditNotes' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE CreditNotes(id)

Delete an instance of 'CreditNotes' with the specified id.

Example

DELETE [Link]

POST CreditNotes(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST CreditNotes(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 151/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

POST CreditNotes(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST CreditNotes(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

CreditPaymentMethods
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CreditPaymentMethods'. It defines credit card payment methods.

GET CreditPaymentMethods(id)

Retrieve all or some selected properties from an instance of 'CreditPaymentMethods' with the given id.

Example

GET [Link]

GET [Link]

GET CreditPaymentMethods

Retrieve a collection of 'CreditPaymentMethods' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1

POST CreditPaymentMethods

Create an instance of 'CreditPaymentMethods' with the given payload of type 'CreditPaymentMethod' in JSON format.

Example

POST [Link]

{
"Name": "Default 20D",
"PaymentCode": "20D"
}

PATCH CreditPaymentMethods(id)

Update an instance of 'CreditPaymentMethods' with the given payload of type 'CreditPaymentMethod' in JSON format and with the specified id.

Example

PATCH [Link]

{
"MinimumPaymentAmount": "100.11"

[Link] Layer API [Link] 152/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE CreditPaymentMethods(id)
Delete an instance of 'CreditPaymentMethods' with the specified id.

Example

DELETE [Link]

Currencies
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Currencies'. It represents the currency codes in the Administration module.

GET Currencies(id)
Retrieve all or some selected properties from an instance of 'Currencies' with the given id.

Example

GET [Link]

GET [Link]

GET Currencies

Retrieve a collection of 'Currencies' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$skip=1

POST Currencies

Create an instance of 'Currencies' with the given payload of type 'Currency' in JSON format.

Example

POST [Link]

{
"Code": "CNY",
"DocumentsCode": "CNY",
"InternationalDescription": "CN Yuan",
"Name": "CNY"
}

PATCH Currencies(id)

Update an instance of 'Currencies' with the given payload of type 'Currency' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "UpdatedCurrencyName"
}

DELETE Currencies(id)

Delete an instance of 'Currencies' with the specified id.

Example

[Link] Layer API [Link] 153/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

CustomerEquipmentCards
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CustomerEquipmentCards'. It represents the customer equipment cards. For each item sold and managed by a serial number,
you can create a customer equipment card to track the after-sales services provided for this item.

GET CustomerEquipmentCards(id)
Retrieve all or some selected properties from an instance of 'CustomerEquipmentCards' with the given id.

Example

GET [Link]

GET [Link]

GET CustomerEquipmentCards
Retrieve a collection of 'CustomerEquipmentCards' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1

POST CustomerEquipmentCards

Create an instance of 'CustomerEquipmentCards' with the given payload of type 'CustomerEquipmentCard' in JSON format.

Example

POST [Link]

{
"CustomerCode": "C30000",
"InstallLocation": "US location",
"InternalSerialNum": "A6-000005",
"ItemCode": "A00006",
"ManufacturerSerialNum": "S1-000001"
}

PATCH CustomerEquipmentCards(id)

Update an instance of 'CustomerEquipmentCards' with the given payload of type 'CustomerEquipmentCard' in JSON format and with the specified id.

Example

PATCH [Link]

{
"InstallLocation": "new US Location"
}

DELETE CustomerEquipmentCards(id)

Delete an instance of 'CustomerEquipmentCards' with the specified id.

Example

DELETE [Link]

CustomsDeclaration
Show/Hide

[Link] Layer API [Link] 154/334

6/7/24, 15:42 Service Layer API Reference
List Operations
Expand Operations

This entity enables you to manipulate 'CustomsDeclaration'.

GET CustomsDeclaration(id)
Retrieve all or some selected properties from an instance of 'CustomsDeclaration' with the given id.

Example

GET [Link]

GET [Link]

GET CustomsDeclaration
Retrieve a collection of 'CustomsDeclaration' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '2') &$orderby=CCDNum&$

POST CustomsDeclaration
Create an instance of 'CustomsDeclaration' with the given payload of type 'CustomsDeclaration' in JSON format.

Example

POST [Link]

{
"CCDNum": "2",
"CustomsBroker": "C01",
"CustomsTerminal": "C01",
"Date": "2016-08-31",
"DocDate": "2016-08-31",
"DocNum": "Exp./Imp. Doc. No.",
"PaymentKey": "PID",
"SupplyDate": "2016-08-31",
"SupplyNum": "Supply Agreement Num"
}

PATCH CustomsDeclaration(id)
Update an instance of 'CustomsDeclaration' with the given payload of type 'CustomsDeclaration' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DocNum": "123"
}

CustomsGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CustomsGroups'. It defines custom groups, which specify the customs duty for items purchased abroad that are liable for
customs.

GET CustomsGroups(id)

Retrieve all or some selected properties from an instance of 'CustomsGroups' with the given id.

Example

GET [Link]

[Link] Layer API [Link] 155/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET CustomsGroups
Retrieve a collection of 'CustomsGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST CustomsGroups
Create an instance of 'CustomsGroups' with the given payload of type 'CustomsGroup' in JSON format.

Example

POST [Link]

{
"Customs": "10",
"CustomsAllocationAccount": "_SYS00000000051",
"CustomsExpenseAccount": "_SYS00000000085",
"Name": "Exempt",
"Other": "30",
"Purchase": "20"
}

PATCH CustomsGroups(id)
Update an instance of 'CustomsGroups' with the given payload of type 'CustomsGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Custom exempt"
}

DELETE CustomsGroups(id)
Delete an instance of 'CustomsGroups' with the specified id.

Example

DELETE [Link]

CycleCountDeterminations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'CycleCountDeterminations'.

GET CycleCountDeterminations(id)

Retrieve all or some selected properties from an instance of 'CycleCountDeterminations' with the given warehouse code.

Example

GET [Link]

GET [Link]

GET CycleCountDeterminations

Retrieve a collection of 'CycleCountDeterminations' with all or some selected properties in the given order by specifying the given filter condition.

[Link] Layer API [Link] 156/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

PATCH CycleCountDeterminations(id)

Update an instance of 'CycleCountDeterminations' with the given payload of type 'CycleCountDetermination' in JSON format and with the specified id.

Example

PATCH [Link]

{
"CycleBy": "ccdcbItemGroup"
}

DeductionTaxGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DeductionTaxGroups'. It represents withholding tax deduction groups.

GET DeductionTaxGroups(id)
Retrieve all or some selected properties from an instance of 'DeductionTaxGroups' with the given id.

Example

GET [Link]

GET [Link]

GET DeductionTaxGroups
Retrieve a collection of 'DeductionTaxGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=GroupKey&$top

POST DeductionTaxGroups
Create an instance of 'DeductionTaxGroups' with the given payload of type 'DeductionTaxGroup' in JSON format.

Example

POST [Link]

{
"GroupExtendedCode": "01",
"GroupName": "Group 01",
"MaxRedin": 0.7746
}

PATCH DeductionTaxGroups(id)
Update an instance of 'DeductionTaxGroups' with the given payload of type 'DeductionTaxGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"GroupName": "Group 02"
}

[Link] Layer API [Link] 157/334

6/7/24, 15:42 Service Layer API Reference
DELETE DeductionTaxGroups(id)

Delete an instance of 'DeductionTaxGroups' with the specified id.

Example

DELETE [Link]

DeductionTaxHierarchies
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DeductionTaxHierarchies'. It defines taxation levels to withhold from payments to vendors.

GET DeductionTaxHierarchies(id)

Retrieve all or some selected properties from an instance of 'DeductionTaxHierarchies' with the given id.

Example

GET [Link]

GET [Link]

GET DeductionTaxHierarchies
Retrieve a collection of 'DeductionTaxHierarchies' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntr

POST DeductionTaxHierarchies
Create an instance of 'DeductionTaxHierarchies' with the given payload of type 'DeductionTaxHierarchy' in JSON format.

Example

POST [Link]

{
"BPCode": "v001",
"DeductionTaxHierarchies_Lines": [
{
"DeductionPercent": "12",
"MaximumTotal": "10000"
}
],
"HierarchyCode": "G01",
"HierarchyName": "new hierarchy group",
"ValidFrom": "2014-01-01",
"ValidUntil": "2014-12-31"
}

PATCH DeductionTaxHierarchies(id)
Update an instance of 'DeductionTaxHierarchies' with the given payload of type 'DeductionTaxHierarchy' in JSON format and with the specified id.

Example

PATCH [Link]

{
"HierarchyName": "vendor hierarchy group"
}

DELETE DeductionTaxHierarchies(id)
Delete an instance of 'DeductionTaxHierarchies' with the specified id.

[Link] Layer API [Link] 158/334

6/7/24, 15:42 Service Layer API Reference
Example

DELETE [Link]

DeductionTaxSubGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DeductionTaxSubGroups'.

GET DeductionTaxSubGroups(id)

Retrieve all or some selected properties from an instance of 'DeductionTaxSubGroups' with the given id.

Example

GET [Link]

GET [Link]

GET DeductionTaxSubGroups
Retrieve a collection of 'DeductionTaxSubGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '99') &$orderby=GroupCo

POST DeductionTaxSubGroups
Create an instance of 'DeductionTaxSubGroups' with the given payload of type 'DeductionTaxSubGroup' in JSON format.

Example

POST [Link]

{
"GroupCode": "99",
"GroupName": "test"
}

PATCH DeductionTaxSubGroups(id)
Update an instance of 'DeductionTaxSubGroups' with the given payload of type 'DeductionTaxSubGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"GroupName": "123"
}

DeliveryNotes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DeliveryNotes'. It is a legally binding document indicating that the shipment of goods or the delivery of services has
occurred.

GET DeliveryNotes(id)

Retrieve all or some selected properties from an instance of 'DeliveryNotes' with the given id.

Example

[Link] Layer API [Link] 159/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link]

GET DeliveryNotes
Retrieve a collection of 'DeliveryNotes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=

POST DeliveryNotes
Create an instance of 'DeliveryNotes' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

PATCH DeliveryNotes(id)
Update an instance of 'DeliveryNotes' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE DeliveryNotes(id)
Delete an instance of 'DeliveryNotes' with the specified id.

Example

DELETE [Link]

POST DeliveryNotes(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST DeliveryNotes(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

[Link] Layer API [Link] 160/334

6/7/24, 15:42 Service Layer API Reference
POST DeliveryNotes(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST DeliveryNotes(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

Departments
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Departments'.

GET Departments(id)
Retrieve all or some selected properties from an instance of 'Departments' with the given id.

Example

GET [Link]

GET [Link]

GET Departments
Retrieve a collection of 'Departments' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST Departments
Create an instance of 'Departments' with the given payload of type 'Department' in JSON format.

Example

POST [Link]

{
"Code": 1,
"Description": "General Department001",
"Name": "General001"
}

PATCH Departments(id)
Update an instance of 'Departments' with the given payload of type 'Department' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "General Department001"
}

[Link] Layer API [Link] 161/334

6/7/24, 15:42 Service Layer API Reference
DELETE Departments(id)

Delete an instance of 'Departments' with the specified id.

Example

DELETE [Link]

Deposits
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Deposits'.

GET Deposits(id)

Retrieve all or some selected properties from an instance of 'Deposits' with the given id.

Example

GET [Link]

GET [Link]

GET Deposits
Retrieve a collection of 'Deposits' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&

POST Deposits
Create an instance of 'Deposits' with the given payload of type 'Deposit' in JSON format.

Example

POST [Link]

{
"CreditLines": [
{
"AbsId": 1
}
],
"DepositAccount": "10000",
"DepositType": "dtCredit",
"VoucherAccount": "10100"
}

PATCH Deposits(id)
Update an instance of 'Deposits' with the given payload of type 'Deposit' in JSON format and with the specified id.

Example

PATCH [Link]

{
"JournalRemarks": "Updating existing deposit"
}

POST Deposits(id)/CancelDeposit
Invoke the method 'CancelDeposit' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 162/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

POST Deposits(id)/CancelDepositbyCurrentSystemDate
Invoke the method 'CancelDepositbyCurrentSystemDate' on this EntitySet with the specified id.

Example

POST [Link]

DepreciationAreas
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DepreciationAreas'.

GET DepreciationAreas(id)
Retrieve all or some selected properties from an instance of 'DepreciationAreas' with the given id.

Example

GET [Link]

GET [Link]

GET DepreciationAreas

Retrieve a collection of 'DepreciationAreas' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'test') &$ord

POST DepreciationAreas

Create an instance of 'DepreciationAreas' with the given payload of type 'DepreciationArea' in JSON format.

Example

POST [Link]

{
"AreaType": "atPostingtoGL",
"Code": "test",
"Description": "test Description",
"PostingOfDepreciation": "podIndirectPosting",
"RetirementMethod": "rmGross"
}

PATCH DepreciationAreas(id)

Update an instance of 'DepreciationAreas' with the given payload of type 'DepreciationArea' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "123"
}

DELETE DepreciationAreas(id)

Delete an instance of 'DepreciationAreas' with the specified id.

[Link] Layer API [Link] 163/334

6/7/24, 15:42 Service Layer API Reference
Example

DELETE [Link]

DepreciationTypePools
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DepreciationTypePools'.

GET DepreciationTypePools(id)

Retrieve all or some selected properties from an instance of 'DepreciationTypePools' with the given id.

Example

GET [Link]

GET [Link]

GET DepreciationTypePools
Retrieve a collection of 'DepreciationTypePools' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '1') &$orderby=Code&$top=10&$sk

POST DepreciationTypePools
Create an instance of 'DepreciationTypePools' with the given payload of type 'DepreciationTypePool' in JSON format.

Example

POST [Link]

{
"Code": "1",
"Description": "test"
}

PATCH DepreciationTypePools(id)
Update an instance of 'DepreciationTypePools' with the given payload of type 'DepreciationTypePool' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test123"
}

DELETE DepreciationTypePools(id)
Delete an instance of 'DepreciationTypePools' with the specified id.

Example

DELETE [Link]

DepreciationTypes
Show/Hide
List Operations
Expand Operations
[Link] Layer API [Link] 164/334
6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'DepreciationTypes'.

GET DepreciationTypes(id)
Retrieve all or some selected properties from an instance of 'DepreciationTypes' with the given id.

Example

GET [Link]

GET [Link]

GET DepreciationTypes
Retrieve a collection of 'DepreciationTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'test') &$orderb

POST DepreciationTypes
Create an instance of 'DepreciationTypes' with the given payload of type 'DepreciationType' in JSON format.

Example

POST [Link]

{
"AcquisitionPeriodControl": "apcProRataTemporis",
"AcquisitionProRataType": "aprtExactlyDailyBase",
"CalculationBase": "cbYearly",
"Code": "test",
"DepreciationMethod": "dmNoDepreciation",
"Description": "Test DepreciationTypes",
"IncludeSalvageInDepreciation": "tNO",
"MinimumDepreciatedValue": 0,
"PercentageOfDepreciationReversedInRetirementYear": 0,
"RetirementPeriodControl": "rpcProRataTemporis",
"RetirementProRataType": "rprtExactlyDailyBase",
"RoundYearEndBookValue": "tYES",
"SalvagePercentage": 0,
"StraightLineCalculationMethod": "slcmAuquisitionValueDividedByTotalUsefulLife",
"StraightLinePercentage": 0,
"StraightLinePeriodControlDepreciationPeriods": "slpcdpStandard",
"StraightLinePeriodControlFactor": 1,
"SubsequentAcquisitionPeriodControl": "sapcProRataTemporis",
"SubsequentAcquisitionProRataType": "saprtExactlyDailyBase",
"ValidFrom": "1900-01-01",
"ValidTo": "2099-12-31"
}

PATCH DepreciationTypes(id)
Update an instance of 'DepreciationTypes' with the given payload of type 'DepreciationType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "DepreciationTypes 123"
}

DELETE DepreciationTypes(id)
Delete an instance of 'DepreciationTypes' with the specified id.

Example

DELETE [Link]

DeterminationCriterias
[Link] Layer API [Link] 165/334
6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DeterminationCriterias'.

GET DeterminationCriterias(id)
Retrieve all or some selected properties from an instance of 'DeterminationCriterias' with the given id.

Example

GET [Link]

GET [Link]

GET DeterminationCriterias
Retrieve a collection of 'DeterminationCriterias' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=DmcId&

PATCH DeterminationCriterias(id)
Update an instance of 'DeterminationCriterias' with the given payload of type 'DeterminationCriteria' in JSON format and with the specified id.

Example

PATCH [Link]

{
"IsActive": "tYES"
}

Dimensions
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Dimensions'.

GET Dimensions(id)

Retrieve all or some selected properties from an instance of 'Dimensions' with the given id.

Example

GET [Link]

GET [Link]

GET Dimensions

Retrieve a collection of 'Dimensions' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=DimensionC

PATCH Dimensions(id)

Update an instance of 'Dimensions' with the given payload of type 'Dimension' in JSON format and with the specified id.

[Link] Layer API [Link] 166/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"DimensionCode": 1,
"DimensionDescription": "Dimension test",
"IsActive": "tYES"
}

DistributionRules
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DistributionRules'.

GET DistributionRules(id)

Retrieve all or some selected properties from an instance of 'DistributionRules' with the given id.

Example

GET [Link]

GET [Link]

GET DistributionRules
Retrieve a collection of 'DistributionRules' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'DR1'

POST DistributionRules
Create an instance of 'DistributionRules' with the given payload of type 'DistributionRule' in JSON format.

Example

POST [Link]

{
"Active": "tYES",
"Direct": "N",
"DistributionRuleLines": [
{
"CenterCode": "1",
"EffectiveFrom": "2016-09-01",
"EffectiveTo": "2016-12-01",
"TotalInCenter": 40
},
{
"CenterCode": "2",
"EffectiveFrom": "2016-09-01",
"EffectiveTo": "2016-12-01",
"TotalInCenter": 60
}
],
"FactorCode": "DR1",
"FactorDescription": "DistributionRules1",
"InWhichDimension": 1,
"TotalFactor": 100
}

POST [Link]

{
"Active": "tYES",
"Direct": "N",
"DistributionRuleLines": [
{
"CenterCode": "1",
"EffectiveFrom": "2016-09-01",
"EffectiveTo": "2016-12-01",
"TotalInCenter": 400
},

[Link] Layer API [Link] 167/334

6/7/24, 15:42 Service Layer API Reference
{
"CenterCode": "2",
"EffectiveFrom": "2016-09-01",
"EffectiveTo": "2016-12-01",
"TotalInCenter": 600
}
],
"FactorCode": "DR1",
"FactorDescription": "DistributionRules1",
"InWhichDimension": 1,
"IsFixedAmount": "tYES",
"TotalFactor": 0
}

PATCH DistributionRules(id)
Update an instance of 'DistributionRules' with the given payload of type 'DistributionRule' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DistributionRuleLines": [
{
"CenterCode": "1",
"EffectiveFrom": "2016-09-01",
"EffectiveTo": "2016-12-01",
"TotalInCenter": 50
},
{
"CenterCode": "2",
"EffectiveFrom": "2016-09-01",
"EffectiveTo": "2016-12-01",
"TotalInCenter": 50
}
],
"FactorDescription": "TEST"
}

DELETE DistributionRules(id)
Delete an instance of 'DistributionRules' with the specified id.

Example

DELETE [Link]

DNFCodeSetup
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DNFCodeSetup'.

GET DNFCodeSetup(id)

Retrieve all or some selected properties from an instance of 'DNFCodeSetup' with the given id.

Example

GET [Link]

GET [Link]

GET DNFCodeSetup

Retrieve a collection of 'DNFCodeSetup' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$skip=

[Link] Layer API [Link] 168/334

6/7/24, 15:42 Service Layer API Reference
POST DNFCodeSetup

Create an instance of 'DNFCodeSetup' with the given payload of type 'DNFCodeSetup' in JSON format.

Example

POST [Link]

{
"AbsEntry": 1,
"DNFCode": "1113",
"Factor": 15,
"NCMCode": 9774,
"UoM": "11"
}

PATCH DNFCodeSetup(id)

Update an instance of 'DNFCodeSetup' with the given payload of type 'DNFCodeSetup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DNFCode": "11131",
"Factor": 75,
"UoM": "112"
}

DELETE DNFCodeSetup(id)

Delete an instance of 'DNFCodeSetup' with the specified id.

Example

DELETE [Link]

DownPayments
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DownPayments'. It represents a document for ensuring that a customer is committed and will follow through with a placed
order.

GET DownPayments(id)
Retrieve all or some selected properties from an instance of 'DownPayments' with the given id.

Example

GET [Link]

GET [Link]

GET DownPayments
Retrieve a collection of 'DownPayments' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=1

POST DownPayments
Create an instance of 'DownPayments' with the given payload of type 'Document' in JSON format.

Example

[Link] Layer API [Link] 169/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
],
"DownPaymentType": "dptInvoice"
}

PATCH DownPayments(id)
Update an instance of 'DownPayments' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE DownPayments(id)
Delete an instance of 'DownPayments' with the specified id.

Example

DELETE [Link]

POST DownPayments(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST DownPayments(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST DownPayments(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST DownPayments(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

Drafts
Show/Hide
List Operations
[Link] Layer API [Link] 170/334
6/7/24, 15:42 Service Layer API Reference
Expand Operations

This entity enables you to manipulate 'Drafts'. It is the preliminary version of a document or report.

GET Drafts(id)
Retrieve all or some selected properties from an instance of 'Drafts' with the given id.

Example

GET [Link]

GET [Link]

GET Drafts
Retrieve a collection of 'Drafts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=1

POST Drafts
Create an instance of 'Drafts' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocObjectCode": "23",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

PATCH Drafts(id)
Update an instance of 'Drafts' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE Drafts(id)
Delete an instance of 'Drafts' with the specified id.

Example

DELETE [Link]

POST Drafts(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

[Link] Layer API [Link] 171/334

6/7/24, 15:42 Service Layer API Reference
POST Drafts(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST Drafts(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST Drafts(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

DunningLetters
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DunningLetters'. It represents a list of dunning levels that is used as a template when creating a new dunning term.

GET DunningLetters(id)
Retrieve all or some selected properties from an instance of 'DunningLetters' with the given id.

Example

GET [Link]

GET [Link]

GET DunningLetters
Retrieve a collection of 'DunningLetters' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=RowNumber&

POST DunningLetters
Create an instance of 'DunningLetters' with the given payload of type 'DunningLetter' in JSON format.

Example

POST [Link]

{
"Effectiveafter": "10",
"FeeCurrency": "RMB",
"Feeperletter": "20",
"LetterFormat": "DUN0",
"MinimumBalance": "2000",
"MinimumBalanceCurrency": "RMB",
"RowNumber": "1"
}

[Link] Layer API [Link] 172/334

6/7/24, 15:42 Service Layer API Reference
PATCH DunningLetters(id)

Update an instance of 'DunningLetters' with the given payload of type 'DunningLetter' in JSON format and with the specified id.

Example

PATCH [Link]

{
"MinimumBalance": "220"
}

DELETE DunningLetters(id)

Delete an instance of 'DunningLetters' with the specified id.

Example

DELETE [Link]

DunningTerms
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DunningTerms'.

GET DunningTerms(id)
Retrieve all or some selected properties from an instance of 'DunningTerms' with the given id.

Example

GET [Link]

GET [Link]

GET DunningTerms
Retrieve a collection of 'DunningTerms' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$ski

POST DunningTerms
Create an instance of 'DunningTerms' with the given payload of type 'DunningTerm' in JSON format.

Example

POST [Link]

{
"Code": "DT01",
"DaysInMonth": "10",
"DaysInYear": "2016",
"DunningTermLines": [
{
"Effectiveafter": "30",
"LetterFormat": "dltDunningLetter1",
"LevelNum": "001"
}
],
"GroupingMethod": "gmPerBP",
"Name": "DT01"
}

PATCH DunningTerms(id)

[Link] Layer API [Link] 173/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'DunningTerms' with the given payload of type 'DunningTerm' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DunningTermLines": [
{
"LevelNum": "1",
"MininumBalance": "1000",
"MininumBalanceCurrency": "EUR"
}
],
"Name": "Dunning Term 01"
}

DELETE DunningTerms(id)

Delete an instance of 'DunningTerms' with the specified id.

Example

DELETE [Link]

DynamicSystemStrings
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'DynamicSystemStrings' and enables modifying a field name and format in the interface to match the terms used in your
company.

GET DynamicSystemStrings(id)

Retrieve all or some selected properties from an instance of 'DynamicSystemStrings' with the given id.

Example

GET [Link]

GET [Link]

GET DynamicSystemStrings

Retrieve a collection of 'DynamicSystemStrings' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and startswith(Item

POST DynamicSystemStrings

Create an instance of 'DynamicSystemStrings' with the given payload of type 'DynamicSystemString' in JSON format.

Example

POST [Link]

{
"ColumnID": "-1",
"FormID": "139",
"ItemID": "230",
"ItemString": "new owner"
}

PATCH DynamicSystemStrings(id)

Update an instance of 'DynamicSystemStrings' with the given payload of type 'DynamicSystemString' in JSON format and with the specified id.

[Link] Layer API [Link] 174/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"ItemString": "Order Owner"
}

DELETE DynamicSystemStrings(id)

Delete an instance of 'DynamicSystemStrings' with the specified id.

Example

DELETE [Link]

ElectronicFileFormats
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ElectronicFileFormats'. It depends on EFM runtime.

GET ElectronicFileFormats(id)
Retrieve all or some selected properties from an instance of 'ElectronicFileFormats' with the given id.

Example

GET [Link]

GET [Link]

GET ElectronicFileFormats
Retrieve a collection of 'ElectronicFileFormats' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=FormatID&$top

POST ElectronicFileFormats
Create an instance of 'ElectronicFileFormats' with the given payload of type 'ElectronicFileFormat' in JSON format.

Example

POST [Link]

{}

PATCH ElectronicFileFormats(id)
Update an instance of 'ElectronicFileFormats' with the given payload of type 'ElectronicFileFormat' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE ElectronicFileFormats(id)
Delete an instance of 'ElectronicFileFormats' with the specified id.

Example

[Link] Layer API [Link] 175/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

EmailGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmailGroups'.

GET EmailGroups(id)
Retrieve all or some selected properties from an instance of 'EmailGroups' with the given id.

Example

GET [Link]

GET [Link]

GET EmailGroups
Retrieve a collection of 'EmailGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Ema

POST EmailGroups

Create an instance of 'EmailGroups' with the given payload of type 'EmailGroup' in JSON format.

Example

POST [Link]

{
"EmailGroupCode": "kun",
"EmailGroupName": "cnlin"
}

PATCH EmailGroups(id)

Update an instance of 'EmailGroups' with the given payload of type 'EmailGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"EmailGroupName": "cnlin0121"
}

DELETE EmailGroups(id)

Delete an instance of 'EmailGroups' with the specified id.

Example

DELETE [Link]

EmployeeIDType
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmployeeIDType'.

[Link] Layer API [Link] 176/334

6/7/24, 15:42 Service Layer API Reference
GET EmployeeIDType(id)

Retrieve all or some selected properties from an instance of 'EmployeeIDType' with the given id.

Example

GET [Link]

GET [Link]

GET EmployeeIDType

Retrieve a collection of 'EmployeeIDType' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=IDType&$top=10&$skip=1

POST EmployeeIDType

Create an instance of 'EmployeeIDType' with the given payload of type 'EmployeeIDType' in JSON format.

Example

POST [Link]

{
"IDType": "test"
}

PATCH EmployeeIDType(id)

Update an instance of 'EmployeeIDType' with the given payload of type 'EmployeeIDType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"IDType": "123"
}

DELETE EmployeeIDType(id)

Delete an instance of 'EmployeeIDType' with the specified id.

Example

DELETE [Link]

EmployeePosition
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmployeePosition'.

GET EmployeePosition(id)
Retrieve all or some selected properties from an instance of 'EmployeePosition' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 177/334

6/7/24, 15:42 Service Layer API Reference
GET EmployeePosition

Retrieve a collection of 'EmployeePosition' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=PositionID&$top=

POST EmployeePosition

Create an instance of 'EmployeePosition' with the given payload of type 'EmployeePosition' in JSON format.

Example

POST [Link]

{
"Description": "test1",
"Name": "test"
}

PATCH EmployeePosition(id)

Update an instance of 'EmployeePosition' with the given payload of type 'EmployeePosition' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "123"
}

DELETE EmployeePosition(id)

Delete an instance of 'EmployeePosition' with the specified id.

Example

DELETE [Link]

EmployeeRolesSetup
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmployeeRolesSetup'.

GET EmployeeRolesSetup(id)
Retrieve all or some selected properties from an instance of 'EmployeeRolesSetup' with the given id.

Example

GET [Link]

GET [Link]

GET EmployeeRolesSetup
Retrieve a collection of 'EmployeeRolesSetup' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=TypeID&$top=10&$skip=1

[Link] Layer API [Link] 178/334

6/7/24, 15:42 Service Layer API Reference

POST EmployeeRolesSetup
Create an instance of 'EmployeeRolesSetup' with the given payload of type 'EmployeeRoleSetup' in JSON format.

Example

POST [Link]

{
"Description": "test",
"Name": "test"
}

PATCH EmployeeRolesSetup(id)
Update an instance of 'EmployeeRolesSetup' with the given payload of type 'EmployeeRoleSetup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "test123"
}

DELETE EmployeeRolesSetup(id)
Delete an instance of 'EmployeeRolesSetup' with the specified id.

Example

DELETE [Link]

EmployeesInfo
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmployeesInfo'.

GET EmployeesInfo(id)

Retrieve all or some selected properties from an instance of 'EmployeesInfo' with the given id.

Example

GET [Link]

GET [Link]

GET EmployeesInfo

Retrieve a collection of 'EmployeesInfo' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=EmployeeID&$top

POST EmployeesInfo

Create an instance of 'EmployeesInfo' with the given payload of type 'EmployeeInfo' in JSON format.

Example

POST [Link]

[Link] Layer API [Link] 179/334

6/7/24, 15:42 Service Layer API Reference
{
"Branch": "-2",
"Department": "-2",
"FirstName": "Harry",
"JobTitle": "Tester",
"LastName": "Hu",
"Remarks": "Best Employee",
"WorkCountryCode": "US"
}

PATCH EmployeesInfo(id)
Update an instance of 'EmployeesInfo' with the given payload of type 'EmployeeInfo' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "new manager"
}

DELETE EmployeesInfo(id)
Delete an instance of 'EmployeesInfo' with the specified id.

Example

DELETE [Link]

POST EmployeesInfo(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST EmployeesInfo(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

EmployeeStatus
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmployeeStatus'.

GET EmployeeStatus(id)

Retrieve all or some selected properties from an instance of 'EmployeeStatus' with the given id.

Example

GET [Link]

GET [Link]

GET EmployeeStatus

Retrieve a collection of 'EmployeeStatus' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 180/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 1 &$orderby=StatusId&$top=10&$skip

POST EmployeeStatus
Create an instance of 'EmployeeStatus' with the given payload of type 'EmployeeStatus' in JSON format.

Example

POST [Link]

{
"Description": "post",
"Name": "post"
}

PATCH EmployeeStatus(id)
Update an instance of 'EmployeeStatus' with the given payload of type 'EmployeeStatus' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "closed"
}

DELETE EmployeeStatus(id)
Delete an instance of 'EmployeeStatus' with the specified id.

Example

DELETE [Link]

EmployeeTransfers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmployeeTransfers'.

GET EmployeeTransfers(id)

Retrieve all or some selected properties from an instance of 'EmployeeTransfers' with the given id.

Example

GET [Link]

GET [Link]

GET EmployeeTransfers

Retrieve a collection of 'EmployeeTransfers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=Tr

POST EmployeeTransfers

Create an instance of 'EmployeeTransfers' with the given payload of type 'EmployeeTransfer' in JSON format.

[Link] Layer API [Link] 181/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"Comment": "test",
"Status": "ets_Processing",
"TransEndDate": "2017-01-01",
"TransEndTime": "08:13:00",
"TransStartDate": "2017-01-01",
"TransStartTime": "08:13:00",
"TransferID": "1"
}

PATCH EmployeeTransfers(id)

Update an instance of 'EmployeeTransfers' with the given payload of type 'EmployeeTransfer' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comment": "123"
}

DELETE EmployeeTransfers(id)

Delete an instance of 'EmployeeTransfers' with the specified id.

Example

DELETE [Link]

EnhancedDiscountGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EnhancedDiscountGroups'.

GET EnhancedDiscountGroups(id)
Retrieve all or some selected properties from an instance of 'EnhancedDiscountGroups' with the given id.

Example

GET [Link]

GET [Link]

GET EnhancedDiscountGroups
Retrieve a collection of 'EnhancedDiscountGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top

POST EnhancedDiscountGroups
Create an instance of 'EnhancedDiscountGroups' with the given payload of type 'EnhancedDiscountGroup' in JSON format.

Example

POST [Link]

{
"Active": "tYES",
"DiscountRelations": "dgrLowestDiscount",
"ObjectCode": "101",

[Link] Layer API [Link] 182/334

6/7/24, 15:42 Service Layer API Reference
"Type": "dgt_CustomerGroup"
}

PATCH EnhancedDiscountGroups(id)
Update an instance of 'EnhancedDiscountGroups' with the given payload of type 'EnhancedDiscountGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Active": "tNO"
}

DELETE EnhancedDiscountGroups(id)
Delete an instance of 'EnhancedDiscountGroups' with the specified id.

Example

DELETE [Link]

ExtendedTranslations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ExtendedTranslations'.

GET ExtendedTranslations(id)

Retrieve all or some selected properties from an instance of 'ExtendedTranslations' with the given id.

Example

GET [Link]

GET [Link]

GET ExtendedTranslations

Retrieve a collection of 'ExtendedTranslations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=DocEntry&$top=10&$ski

POST ExtendedTranslations

Create an instance of 'ExtendedTranslations' with the given payload of type 'ExtendedTranslation' in JSON format.

Example

POST [Link]

{
"Category": "asEFMItem",
"ID": "test",
"SecondaryID": "SecondaryID"
}

PATCH ExtendedTranslations(id)

Update an instance of 'ExtendedTranslations' with the given payload of type 'ExtendedTranslation' in JSON format and with the specified id.

Example

[Link] Layer API [Link] 183/334

6/7/24, 15:42 Service Layer API Reference
PATCH [Link]

{
"ID": "123"
}

DELETE ExtendedTranslations(id)
Delete an instance of 'ExtendedTranslations' with the specified id.

Example

DELETE [Link]

FAAccountDeterminations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'FAAccountDeterminations'.

GET FAAccountDeterminations(id)
Retrieve all or some selected properties from an instance of 'FAAccountDeterminations' with the given id.

Example

GET [Link]

GET [Link]

GET FAAccountDeterminations

Retrieve a collection of 'FAAccountDeterminations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'tes

POST FAAccountDeterminations

Create an instance of 'FAAccountDeterminations' with the given payload of type 'FAAccountDetermination' in JSON format.

Example

POST [Link]

{
"AccumulatedOrdinaryDepr": "2180",
"AccumulatedSpecialDepr": "2185",
"AccumulatedUnplannedDepr": "2182",
"AssetBalanceSheetAccount": "0027",
"ClearingAccountAcquisition": "2307",
"Code": "test",
"Description": "Immaterielle Verm.",
"LeavewithExpenseNBVGross": "2310",
"LeavewithRevenueNBVGross": "2315",
"OrdinaryDepreciation": "4822",
"RetirementwithExpenseNet": "4850",
"RetirementwithRevenueNet": "4850",
"RevaluationReserveAccount": "4850",
"RevaluationReserveClearing": "4850",
"RevenueAccountforRetirement": "8837",
"RevenueClearingAccount": "4850",
"RevenuefromAssetSalesNet": "4850",
"SpecialDepreciation": "4850",
"UnplannedDepreciation": "4826"
}

PATCH FAAccountDeterminations(id)

Update an instance of 'FAAccountDeterminations' with the given payload of type 'FAAccountDetermination' in JSON format and with the specified id.

[Link] Layer API [Link] 184/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"RevenueClearingAccount": "2310"
}

DELETE FAAccountDeterminations(id)

Delete an instance of 'FAAccountDeterminations' with the specified id.

Example

DELETE [Link]

FactoringIndicators
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'FactoringIndicators'. It defines keys that can be recorded in certain journal entries and used as selection criteria in various
reports.

GET FactoringIndicators(id)
Retrieve all or some selected properties from an instance of 'FactoringIndicators' with the given id.

Example

GET [Link]

GET [Link]

GET FactoringIndicators
Retrieve a collection of 'FactoringIndicators' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderb

POST FactoringIndicators
Create an instance of 'FactoringIndicators' with the given payload of type 'FactoringIndicator' in JSON format.

Example

POST [Link]

{
"IndicatorCode": "abc",
"IndicatorName": "new indicator"
}

PATCH FactoringIndicators(id)
Update an instance of 'FactoringIndicators' with the given payload of type 'FactoringIndicator' in JSON format and with the specified id.

Example

PATCH [Link]

{
"IndicatorName": "customer indicator"
}

DELETE FactoringIndicators(id)

[Link] Layer API [Link] 185/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'FactoringIndicators' with the specified id.

Example

DELETE [Link]

FinancialYears
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'FinancialYears'.

GET FinancialYears(id)

Retrieve all or some selected properties from an instance of 'FinancialYears' with the given id.

Example

GET [Link]

GET [Link]

GET FinancialYears

Retrieve a collection of 'FinancialYears' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=AbsEntry&$top=10&$skip

POST FinancialYears

Create an instance of 'FinancialYears' with the given payload of type 'FinancialYear' in JSON format.

Example

POST [Link]

{
"AssessYear": "201718",
"Code": "201617",
"Description": "201617",
"EndDate": "2017-08-31",
"StartDate": "2016-09-01"
}

PATCH FinancialYears(id)

Update an instance of 'FinancialYears' with the given payload of type 'FinancialYear' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "TEST"
}

DELETE FinancialYears(id)

Delete an instance of 'FinancialYears' with the specified id.

Example

DELETE [Link]

[Link] Layer API [Link] 186/334

6/7/24, 15:42 Service Layer API Reference

FiscalPrinter
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'FiscalPrinter'.

GET FiscalPrinter(id)
Retrieve all or some selected properties from an instance of 'FiscalPrinter' with the given id.

Example

GET [Link]

GET [Link]

GET FiscalPrinter
Retrieve a collection of 'FiscalPrinter' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '1') &$orde

POST FiscalPrinter
Create an instance of 'FiscalPrinter' with the given payload of type 'FiscalPrinter' in JSON format.

Example

POST [Link]

{
"EquipmentNo": "1",
"FiscalDocumentModel": "FM",
"ManufacturerSerialN": "ManufacturerSerialN",
"Model": "Model",
"RegisterNo": "0123456789"
}

PATCH FiscalPrinter(id)
Update an instance of 'FiscalPrinter' with the given payload of type 'FiscalPrinter' in JSON format and with the specified id.

Example

PATCH [Link]

{
"EquipmentNo": "1",
"FiscalDocumentModel": "FM",
"ManufacturerSerialN": "ManufacturerSerialN",
"Model": "Model",
"RegisterNo": "0123456789"
}

DELETE FiscalPrinter(id)
Delete an instance of 'FiscalPrinter' with the specified id.

Example

DELETE [Link]

FormattedSearches
Show/Hide
List Operations
Expand Operations
[Link] Layer API [Link] 187/334
6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'FormattedSearches'. It allows to assign a formatted search function to a specified field, so that SAP Business One users can
enter values, originated by a pre-defined search process, to the field.

GET FormattedSearches(id)
Retrieve all or some selected properties from an instance of 'FormattedSearches' with the given id.

Example

GET [Link]

GET [Link]

GET FormattedSearches
Retrieve a collection of 'FormattedSearches' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 24488 &$orderby=Index&$top=10&$skip=1

POST FormattedSearches
Create an instance of 'FormattedSearches' with the given payload of type 'FormattedSearche' in JSON format.

Example

POST [Link]

{
"Action": "bofsaValidValues",
"ByField": "tYES",
"ColumnID": "-1",
"FormID": "139",
"Index": "24488",
"ItemID": "16"
}

PATCH FormattedSearches(id)
Update an instance of 'FormattedSearches' with the given payload of type 'FormattedSearche' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ItemID": "29"
}

DELETE FormattedSearches(id)
Delete an instance of 'FormattedSearches' with the specified id.

Example

DELETE [Link]

FormPreferences
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'FormPreferences'.

GET FormPreferences(id)

Retrieve all or some selected properties from an instance of 'FormPreferences' with the given id.

[Link] Layer API [Link] 188/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET FormPreferences

Retrieve a collection of 'FormPreferences' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 and startswith(FormID, 'a') and star

PATCH FormPreferences(id)

Update an instance of 'FormPreferences' with the given payload of type 'ColumnPreferences' in JSON format and with the specified id.

Example

PATCH [Link]

{
"VisibleInExpanded": "tNO"
}

DELETE FormPreferences(id)

Delete an instance of 'FormPreferences' with the specified id.

Example

DELETE [Link]

Forms1099
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Forms1099'. It defines new Form 1099 types in addition to the existing types: 1099 Miscellaneous, 1099 Interest, and 1099
Dividends.

GET Forms1099(id)
Retrieve all or some selected properties from an instance of 'Forms1099' with the given id.

Example

GET [Link]

GET [Link]

GET Forms1099
Retrieve a collection of 'Forms1099' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=FormCode&$top=10&$skip=

POST Forms1099

[Link] Layer API [Link] 189/334

6/7/24, 15:42 Service Layer API Reference
Create an instance of 'Forms1099' with the given payload of type 'Forms1099' in JSON format.

Example

POST [Link]

{
"Boxes1099": [
{
"Box1099": "01",
"BoxDescription": "Foreign tax paid",
"Minimum1099Amount": "11"
}
],
"Form1099": "1099 Tax"
}

PATCH Forms1099(id)

Update an instance of 'Forms1099' with the given payload of type 'Forms1099' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Boxes1099": [
{
"Minimum1099Amount": "30"
}
]
}

DELETE Forms1099(id)

Delete an instance of 'Forms1099' with the specified id.

Example

DELETE [Link]

GLAccountAdvancedRules
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'GLAccountAdvancedRules'.

GET GLAccountAdvancedRules(id)

Retrieve all or some selected properties from an instance of 'GLAccountAdvancedRules' with the given id.

Example

GET [Link]

GET [Link]

GET GLAccountAdvancedRules

Retrieve a collection of 'GLAccountAdvancedRules' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1

POST GLAccountAdvancedRules

Create an instance of 'GLAccountAdvancedRules' with the given payload of type 'GLAccountAdvancedRule' in JSON format.

[Link] Layer API [Link] 190/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"AbsoluteEntry": 1,
"BeginningofFinancialYear": "2016-01-01",
"Code": "Test1",
"Description": "Test Determination Rules1",
"EUExpensesAccount": "2730",
"EURevenuesAccount": "2725",
"ExpenseClearingAct": "2739",
"ExpensesAccount": "2720",
"FinancialYear": 2016,
"ForeignExpensAcc": "2735",
"ForeignRevenueAcc": "2732",
"FromDate": "2016-01-01",
"IsActive": "tNO",
"Period": "2016",
"RevenuesAccount": "2715",
"ToDate": "2016-12-31",
"Warehouse": "01"
}

PATCH GLAccountAdvancedRules(id)

Update an instance of 'GLAccountAdvancedRules' with the given payload of type 'GLAccountAdvancedRule' in JSON format and with the specified
id.

Example

PATCH [Link]

{
"AbsoluteEntry": 1,
"Description": "Test Determination Rules123",
"IsActive": "tYES"
}

DELETE GLAccountAdvancedRules(id)

Delete an instance of 'GLAccountAdvancedRules' with the specified id.

Example

DELETE [Link]

GoodsReturnRequest
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'GoodsReturnRequest'. A return is the clearing document for a delivery.

GET GoodsReturnRequest(id)
Retrieve all or some selected properties from an instance of 'GoodsReturnRequest' with the given id.

Example

GET [Link]

GET [Link]

GET GoodsReturnRequest
Retrieve a collection of 'GoodsReturnRequest' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$

[Link] Layer API [Link] 191/334

6/7/24, 15:42 Service Layer API Reference
POST GoodsReturnRequest

Create an instance of 'GoodsReturnRequest' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}

PATCH GoodsReturnRequest(id)

Update an instance of 'GoodsReturnRequest' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE GoodsReturnRequest(id)

Delete an instance of 'GoodsReturnRequest' with the specified id.

Example

DELETE [Link]

POST GoodsReturnRequest(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST GoodsReturnRequest(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST GoodsReturnRequest(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST GoodsReturnRequest(id)/SaveDraftToDocument

Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST [Link]

[Link] Layer API [Link] 192/334

6/7/24, 15:42 Service Layer API Reference

POST GoodsReturnRequest(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

GovPayCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'GovPayCodes'.

GET GovPayCodes(id)
Retrieve all or some selected properties from an instance of 'GovPayCodes' with the given id.

Example

GET [Link]

GET [Link]

GET GovPayCodes

Retrieve a collection of 'GovPayCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsId&$top=10&$skip=1

POST GovPayCodes

Create an instance of 'GovPayCodes' with the given payload of type 'GovPayCode' in JSON format.

Example

POST [Link]

{
"AbsId": 1,
"Code": "c1",
"Descr": "c1",
"GovPayCodeAuthorities": [],
"Prdcity": "gpcpMonth",
"StateTax": "tNO"
}

PATCH GovPayCodes(id)

Update an instance of 'GovPayCodes' with the given payload of type 'GovPayCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Descr": "c1211"
}

DELETE GovPayCodes(id)

Delete an instance of 'GovPayCodes' with the specified id.

Example

[Link] Layer API [Link] 193/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

HouseBankAccounts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'HouseBankAccounts'.

GET HouseBankAccounts(id)
Retrieve all or some selected properties from an instance of 'HouseBankAccounts' with the given id.

Example

GET [Link]

GET [Link]

GET HouseBankAccounts
Retrieve a collection of 'HouseBankAccounts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsoluteEntry&$t

POST HouseBankAccounts

Create an instance of 'HouseBankAccounts' with the given payload of type 'HouseBankAccount' in JSON format.

Example

POST [Link]

{
"AccNo": "11123456",
"BankCode": "HSBC",
"BankKey": "6",
"Branch": "123",
"Country": "US",
"GLAccount": "_SYS00000000001",
"GLInterimAccount": "_SYS00000000052",
"ZipCode": "201200"
}

PATCH HouseBankAccounts(id)

Update an instance of 'HouseBankAccounts' with the given payload of type 'HouseBankAccount' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ZipCode": "200-10"
}

DELETE HouseBankAccounts(id)

Delete an instance of 'HouseBankAccounts' with the specified id.

Example

DELETE [Link]

IncomingPayments

[Link] Layer API [Link] 194/334

6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'IncomingPayments'. It represents incoming payments from customers or, for returned goods, from vendors. Available
payment methods are cash, credit cards, checks, bank transfers, and in some localizations, bills of exchange.

GET IncomingPayments(id)
Retrieve all or some selected properties from an instance of 'IncomingPayments' with the given id.

Example

GET [Link]

GET [Link]

GET IncomingPayments
Retrieve a collection of 'IncomingPayments' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&

POST IncomingPayments
Create an instance of 'IncomingPayments' with the given payload of type 'Payment' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"CashAccount": "_SYS00000000002",
"CashFlowAssignments": [
{
"AmountLC": "110",
"PaymentMeans": "pmtCash"
}
],
"CashSum": "110"
}

PATCH IncomingPayments(id)
Update an instance of 'IncomingPayments' with the given payload of type 'Payment' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "new comments - modified by Service Layer"
}

POST IncomingPayments(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST IncomingPayments(id)/GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 195/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

POST IncomingPayments(id)/CancelbyCurrentSystemDate
Invoke the method 'CancelbyCurrentSystemDate' on this EntitySet with the specified id.

Example

POST [Link]

POST IncomingPayments(id)/RequestApproveCancellation
Invoke the method 'RequestApproveCancellation' on this EntitySet with the specified id.

Example

POST [Link]

Industries
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Industries'. It represents the industries list from which an industry can be associated with a sales opportunity.

GET Industries(id)

Retrieve all or some selected properties from an instance of 'Industries' with the given id.

Example

GET [Link]

GET [Link]

GET Industries

Retrieve a collection of 'Industries' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=

POST Industries

Create an instance of 'Industries' with the given payload of type 'Industry' in JSON format.

Example

POST [Link]

{
"IndustryDescription": "chemical industry",
"IndustryName": "chemical"
}

PATCH Industries(id)

Update an instance of 'Industries' with the given payload of type 'Industry' in JSON format and with the specified id.

Example

PATCH [Link]

{
"IndustryDescription": "oil"

[Link] Layer API [Link] 196/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE Industries(id)
Delete an instance of 'Industries' with the specified id.

Example

DELETE [Link]

IntegrationPackagesConfigure
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'IntegrationPackagesConfigure'.

GET IntegrationPackagesConfigure(id)
Retrieve all or some selected properties from an instance of 'IntegrationPackagesConfigure' with the given id.

Example

GET [Link]

GET [Link]

GET IntegrationPackagesConfigure

Retrieve a collection of 'IntegrationPackagesConfigure' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top

POST IntegrationPackagesConfigure

Create an instance of 'IntegrationPackagesConfigure' with the given payload of type 'IntegrationPackageConfigure' in JSON format.

Example

POST [Link]

{}

PATCH IntegrationPackagesConfigure(id)

Update an instance of 'IntegrationPackagesConfigure' with the given payload of type 'IntegrationPackageConfigure' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"IsEnable": "tYES"
}

DELETE IntegrationPackagesConfigure(id)

Delete an instance of 'IntegrationPackagesConfigure' with the specified id.

Example

DELETE [Link]

[Link] Layer API [Link] 197/334

6/7/24, 15:42 Service Layer API Reference

InternalReconciliations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InternalReconciliations'.

GET InternalReconciliations(id)
Retrieve all or some selected properties from an instance of 'InternalReconciliations' with the given id.

Example

GET [Link]

GET [Link]

POST InternalReconciliations
Create an instance of 'InternalReconciliations' with the given payload of type 'InternalReconciliation' in JSON format.

Example

POST [Link]

{
"CardOrAccount": "coaCard",
"InternalReconciliationOpenTransRows": [
{
"CashDiscount": null,
"CreditOrDebit": "codDebit",
"ReconcileAmount": 10,
"Selected": "tYES",
"ShortName": "v01",
"SrcObjAbs": 5,
"SrcObjTyp": "46",
"TransId": 41,
"TransRowId": 1
},
{
"CashDiscount": null,
"CreditOrDebit": "codCredit",
"ReconcileAmount": 10,
"Selected": "tYES",
"ShortName": "v01",
"SrcObjAbs": 11,
"SrcObjTyp": "18",
"TransId": 43,
"TransRowId": 0
}
],
"ReconDate": "2017-11-15"
}

IntrastatConfiguration
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'IntrastatConfiguration'.

GET IntrastatConfiguration(id)

Retrieve all or some selected properties from an instance of 'IntrastatConfiguration' with the given id.

Example

GET [Link]

GET [Link]

GET IntrastatConfiguration

Retrieve a collection of 'IntrastatConfiguration' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 198/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=1

POST IntrastatConfiguration
Create an instance of 'IntrastatConfiguration' with the given payload of type 'IntrastatConfiguration' in JSON format.

Example

POST [Link]

{
"AbsEntry": 1,
"Code": "c/k11",
"ConfID": "M:c/k:::",
"ConfType": "enAdditionalMeasureUnit",
"Country": null,
"DateFrom": null,
"DateTo": null,
"Descr": "test Quantidade de quilates (1 quilate metr. = 2 ?10-4 kg)",
"Export": "tYES",
"Import": "tYES",
"PrcstVal": 0,
"StatCode": "",
"SuppUnit": null
}

PATCH IntrastatConfiguration(id)
Update an instance of 'IntrastatConfiguration' with the given payload of type 'IntrastatConfiguration' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE IntrastatConfiguration(id)
Delete an instance of 'IntrastatConfiguration' with the specified id.

Example

DELETE [Link]

InventoryCountings
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InventoryCountings'.

GET InventoryCountings(id)

Retrieve all or some selected properties from an instance of 'InventoryCountings' with the given id.

Example

GET [Link]

GET [Link]

GET InventoryCountings

Retrieve a collection of 'InventoryCountings' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=D

[Link] Layer API [Link] 199/334

6/7/24, 15:42 Service Layer API Reference

POST InventoryCountings
Create an instance of 'InventoryCountings' with the given payload of type 'InventoryCounting' in JSON format.

Example

POST [Link]

{
"InventoryCountingLines": [
{
"ItemCode": "I003",
"WarehouseCode": "01"
}
]
}

PATCH InventoryCountings(id)
Update an instance of 'InventoryCountings' with the given payload of type 'InventoryCounting' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "updated by ServiceLayer"
}

DELETE InventoryCountings(id)
Delete an instance of 'InventoryCountings' with the specified id.

Example

DELETE [Link]

POST InventoryCountings(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

InventoryCycles
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InventoryCycles'. It allows to set up cycles of inventory counts and order intervals.

GET InventoryCycles(id)

Retrieve all or some selected properties from an instance of 'InventoryCycles' with the given id.

Example

GET [Link]

GET [Link]

GET InventoryCycles

Retrieve a collection of 'InventoryCycles' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 200/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 123 &$orderby=CycleCode&$top

POST InventoryCycles
Create an instance of 'InventoryCycles' with the given payload of type 'InventoryCycles' in JSON format.

Example

POST [Link]

{
"CycleName": "DailyCycle",
"Frequency": "bof_Daily"
}

PATCH InventoryCycles(id)
Update an instance of 'InventoryCycles' with the given payload of type 'InventoryCycles' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Frequency": "bof_OneTime"
}

DELETE InventoryCycles(id)
Delete an instance of 'InventoryCycles' with the specified id.

Example

DELETE [Link]

InventoryGenEntries
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InventoryGenEntries'. It represents inventory gains in quantities not resulting from doing business with vendors, for example,
receipt from production.

GET InventoryGenEntries(id)

Retrieve all or some selected properties from an instance of 'InventoryGenEntries' with the given id.

Example

GET [Link]

GET [Link]

GET InventoryGenEntries

Retrieve a collection of 'InventoryGenEntries' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&

POST InventoryGenEntries

Create an instance of 'InventoryGenEntries' with the given payload of type 'Document' in JSON format.

[Link] Layer API [Link] 201/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"UnitPrice": "1"
}
]
}

POST [Link]

{
"DocDate": "20170604",
"DocDueDate": "20170604",
"DocumentLines": [
{
"BaseEntry": "12861",
"BaseType": "202",
"CostingCode": "1020",
"DocumentLinesBinAllocations": [
{
"AllowNegativeQuantity": "Y",
"BinAbsEntry": "2",
"Quantity": 1
}
],
"Quantity": 1,
"WarehouseCode": "MD01"
},
{
"BaseEntry": "12861",
"BaseType": "202",
"CostingCode": "1177",
"DocumentLinesBinAllocations": [
{
"AllowNegativeQuantity": "Y",
"BinAbsEntry": "3",
"Quantity": 1
}
],
"Quantity": 1,
"WarehouseCode": "MD01"
},
{
"BaseEntry": "12861",
"BaseType": "202",
"CostingCode": "1301",
"DocumentLinesBinAllocations": [
{
"AllowNegativeQuantity": "Y",
"BinAbsEntry": "4",
"Quantity": 1
}
],
"Quantity": 1,
"WarehouseCode": "MD01"
}
]
}

PATCH InventoryGenEntries(id)

Update an instance of 'InventoryGenEntries' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST InventoryGenEntries(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST InventoryGenEntries(id)/Cancel

[Link] Layer API [Link] 202/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST InventoryGenEntries(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST InventoryGenEntries(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

InventoryGenExits
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InventoryGenExits'. It represents inventory losses in quantities not resulting from doing business with customers, for
example, issue for production.

GET InventoryGenExits(id)

Retrieve all or some selected properties from an instance of 'InventoryGenExits' with the given id.

Example

GET [Link]

GET [Link]

GET InventoryGenExits

Retrieve a collection of 'InventoryGenExits' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$s

POST InventoryGenExits

Create an instance of 'InventoryGenExits' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100"
}
]
}

POST [Link]

[Link] Layer API [Link] 203/334

6/7/24, 15:42 Service Layer API Reference
"DocDate": "20170604",
"DocDueDate": "20170604",
"DocumentLines": [
{
"BaseEntry": "12861",
"BaseLine": 0,
"CostingCode": "1020",
"DocumentLinesBinAllocations": [
{
"AllowNegativeQuantity": "Y",
"BinAbsEntry": "2",
"Quantity": 1
}
],
"Quantity": 1,
"WarehouseCode": "MD01"
},
{
"BaseEntry": "12861",
"BaseLine": 0,
"CostingCode": "1177",
"DocumentLinesBinAllocations": [
{
"AllowNegativeQuantity": "Y",
"BinAbsEntry": "3",
"Quantity": 1
}
],
"Quantity": 1,
"WarehouseCode": "MD01"
},
{
"BaseEntry": "12861",
"BaseLine": 0,
"CostingCode": "1301",
"DocumentLinesBinAllocations": [
{
"AllowNegativeQuantity": "Y",
"BinAbsEntry": "4",
"Quantity": 1
}
],
"Quantity": 1,
"WarehouseCode": "MD01"
}
]
}

POST [Link]

{
"Comments": "Test",
"DocDate": "2017-07-10",
"DocumentLines": [
{
"ItemCode": "ITEM01",
"Quantity": 1,
"UnitPrice": 10,
"WarehouseCode": "01"
}
],
"Document_ApprovalRequests": [
{
"ApprovalTemplatesID": 1,
"Remarks": "Please approve"
}
]
}

PATCH InventoryGenExits(id)
Update an instance of 'InventoryGenExits' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST InventoryGenExits(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

[Link] Layer API [Link] 204/334

6/7/24, 15:42 Service Layer API Reference
POST InventoryGenExits(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST InventoryGenExits(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST InventoryGenExits(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

InventoryOpeningBalances
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InventoryOpeningBalances'.

GET InventoryOpeningBalances(id)
Retrieve all or some selected properties from an instance of 'InventoryOpeningBalances' with the given id.

Example

GET [Link]

GET [Link]

GET InventoryOpeningBalances
Retrieve a collection of 'InventoryOpeningBalances' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$

POST InventoryOpeningBalances
Create an instance of 'InventoryOpeningBalances' with the given payload of type 'InventoryOpeningBalance' in JSON format.

Example

POST [Link]

{
"BranchID": null,
"DocObjectCodeEx": "310000001",
"DocumentDate": "2016-01-01",
"DocumentEntry": 4,
"DocumentNumber": 1,
"FinancialPeriod": 1,
"InventoryOpeningBalanceLines": [
{
"ActualPrice": 1,

[Link] Layer API [Link] 205/334

6/7/24, 15:42 Service Layer API Reference
"AllowBinNegativeQuantity": "tNO",
"BarCode": null,
"BinEntry": null,
"CostingCode": "",
"CostingCode2": "",
"CostingCode3": "",
"CostingCode4": "",
"CostingCode5": "",
"Currency": "R$",
"DocumentEntry": 4,
"InWarehouseQuantity": 0,
"InventoryOpeningBalanceBatchNumbers": [],
"InventoryOpeningBalanceSerialNumbers": [],
"ItemCode": "I02",
"ItemDescription": null,
"LineNumber": 1,
"Manufacturer": -1,
"OpenInventoryAccount": "[Link].01",
"OpeningBalance": 1,
"PostedValueLC": 1,
"PostedValueSC": 1,
"PreferredVendor": null,
"Price": 1,
"ProjectCode": null,
"Remarks": "",
"SupplierCatalogNo": null,
"Total": 1,
"VisualOrder": 1,
"WarehouseCode": "01"
}
],
"JournalRemark": "Inventory Opening Balances",
"PeriodIndicator": "Padr\u00e3o",
"PostingDate": "2016-01-01",
"PriceList": -1,
"PriceSource": "iobpsItemCost",
"Reference2": null,
"Remarks": null,
"Series": 43
}

PATCH InventoryOpeningBalances(id)
Update an instance of 'InventoryOpeningBalances' with the given payload of type 'InventoryOpeningBalance' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "test"
}

InventoryPostings
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InventoryPostings'.

GET InventoryPostings(id)
Retrieve all or some selected properties from an instance of 'InventoryPostings' with the given id.

Example

GET [Link]

GET [Link]

GET InventoryPostings

Retrieve a collection of 'InventoryPostings' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Do

[Link] Layer API [Link] 206/334

6/7/24, 15:42 Service Layer API Reference
POST InventoryPostings

Create an instance of 'InventoryPostings' with the given payload of type 'InventoryPosting' in JSON format.

Example

POST [Link]

{}

PATCH InventoryPostings(id)

Update an instance of 'InventoryPostings' with the given payload of type 'InventoryPosting' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE InventoryPostings(id)

Delete an instance of 'InventoryPostings' with the specified id.

Example

DELETE [Link]

InventoryTransferRequests
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'InventoryTransferRequests'. It represents a request to transfer inventory from one warehouse to another. After the requested
quantity is received by the receiving warehouse, you can close the inventory transfer request and create an inventory transfer document.

GET InventoryTransferRequests(id)
Retrieve all or some selected properties from an instance of 'InventoryTransferRequests' with the given id.

Example

GET [Link]

GET [Link]

GET InventoryTransferRequests
Retrieve a collection of 'InventoryTransferRequests' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$t

POST InventoryTransferRequests
Create an instance of 'InventoryTransferRequests' with the given payload of type 'StockTransfer' in JSON format.

Example

POST [Link]

{
"StockTransferLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"UnitPrice": "100",
"WarehouseCode": "w001"

[Link] Layer API [Link] 207/334

6/7/24, 15:42 Service Layer API Reference
}
]
}

PATCH InventoryTransferRequests(id)
Update an instance of 'InventoryTransferRequests' with the given payload of type 'StockTransfer' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST InventoryTransferRequests(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST InventoryTransferRequests(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST InventoryTransferRequests(id)/SaveDraftToDocument
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST [Link]

Invoices
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Invoices'.

GET Invoices(id)

Retrieve all or some selected properties from an instance of 'Invoices' with the given id.

Example

GET [Link]

GET [Link]

GET Invoices

Retrieve a collection of 'Invoices' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=1

[Link] Layer API [Link] 208/334

6/7/24, 15:42 Service Layer API Reference
POST Invoices

Create an instance of 'Invoices' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

PATCH Invoices(id)

Update an instance of 'Invoices' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST Invoices(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST Invoices(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST Invoices(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST Invoices(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

ItemGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ItemGroups'. It represents the definition of item groups in the Inventory module.

[Link] Layer API [Link] 209/334

6/7/24, 15:42 Service Layer API Reference
GET ItemGroups(id)

Retrieve all or some selected properties from an instance of 'ItemGroups' with the given id.

Example

GET [Link]

GET [Link]

GET ItemGroups

Retrieve a collection of 'ItemGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST ItemGroups

Create an instance of 'ItemGroups' with the given payload of type 'ItemGroups' in JSON format.

Example

POST [Link]

{
"GroupName": "ig001"
}

PATCH ItemGroups(id)

Update an instance of 'ItemGroups' with the given payload of type 'ItemGroups' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Alert": "tYES"
}

DELETE ItemGroups(id)

Delete an instance of 'ItemGroups' with the specified id.

Example

DELETE [Link]

ItemImages
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ItemImages'. It is a stream entity and relies on the entity 'Item'.

GET ItemImages(id)
Retrieve all or some selected properties from an instance of 'ItemImages' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 210/334

6/7/24, 15:42 Service Layer API Reference
PATCH ItemImages(id)

Update an instance of 'ItemImages' with an image of multipart/form-data format and with the specified id.

Example

PATCH [Link]

DELETE ItemImages(id)

Delete an instance of 'ItemImages' with the specified id.

Example

DELETE [Link]

ItemProperties
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ItemProperties'.

GET ItemProperties(id)
Retrieve all or some selected properties from an instance of 'ItemProperties' with the given id.

Example

GET [Link]

GET [Link]

GET ItemProperties
Retrieve a collection of 'ItemProperties' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 9124 &$orderby=Number&$top=10&$skip=1

POST ItemProperties
Create an instance of 'ItemProperties' with the given payload of type 'ItemProperty' in JSON format.

Example

POST [Link]

{
"Number": "9124",
"PropertyName": "Item Property 9124"
}

PATCH ItemProperties(id)
Update an instance of 'ItemProperties' with the given payload of type 'ItemProperty' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PropertyName": "new Item Property 9124"
}

DELETE ItemProperties(id)
[Link] Layer API [Link] 211/334
6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'ItemProperties' with the specified id.

Example

DELETE [Link]

Items
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Items'.

GET Items(id)

Retrieve all or some selected properties from an instance of 'Items' with the given id.

Example

GET [Link]

GET [Link]

GET Items

Retrieve a collection of 'Items' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=ItemCode&$top=1

POST Items

Create an instance of 'Items' with the given payload of type 'Item' in JSON format.

Example

POST [Link]

{
"ItemCode": "i001",
"ItemName": "Item1",
"ItemType": "itItems"
}

PATCH Items(id)

Update an instance of 'Items' with the given payload of type 'Item' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ItemName": "Updated Item Name"
}

DELETE Items(id)

Delete an instance of 'Items' with the specified id.

Example

DELETE [Link]

POST Items(id)/Cancel

[Link] Layer API [Link] 212/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

JournalEntries
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'JournalEntries'. It represents journal transactions.

GET JournalEntries(id)

Retrieve all or some selected properties from an instance of 'JournalEntries' with the given id.

Example

GET [Link]

GET [Link]

GET JournalEntries

Retrieve a collection of 'JournalEntries' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=JdtNum&$top=10&$ski

POST JournalEntries

Create an instance of 'JournalEntries' with the given payload of type 'JournalEntry' in JSON format.

Example

POST [Link]

{
"JournalEntryLines": [
{
"AccountCode": "_SYS00000000019",
"Credit": 100,
"Debit": 0
},
{
"AccountCode": "_SYS00000000164",
"Credit": 0,
"Debit": 100
}
]
}

PATCH JournalEntries(id)

Update an instance of 'JournalEntries' with the given payload of type 'JournalEntry' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Memo": "new memo - modified by Service Layer"
}

POST JournalEntries(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

[Link] Layer API [Link] 213/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

JournalEntryDocumentTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'JournalEntryDocumentTypes'.

GET JournalEntryDocumentTypes(id)

Retrieve all or some selected properties from an instance of 'JournalEntryDocumentTypes' with the given id.

Example

GET [Link]

GET [Link]

GET JournalEntryDocumentTypes
Retrieve a collection of 'JournalEntryDocumentTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST JournalEntryDocumentTypes
Create an instance of 'JournalEntryDocumentTypes' with the given payload of type 'JournalEntryDocumentType' in JSON format.

Example

POST [Link]

{
"DocTypeDescription": "my desc",
"JournalEntryType": "type1",
"ShortName": "my first type"
}

PATCH JournalEntryDocumentTypes(id)
Update an instance of 'JournalEntryDocumentTypes' with the given payload of type 'JournalEntryDocumentType' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"DocTypeDescription": "my desc - updated by Service Layer"
}

DELETE JournalEntryDocumentTypes(id)
Delete an instance of 'JournalEntryDocumentTypes' with the specified id.

Example

DELETE [Link]

KnowledgeBaseSolutions
Show/Hide
[Link] Layer API [Link] 214/334
6/7/24, 15:42 Service Layer API Reference
List Operations
Expand Operations

This entity enables you to manipulate 'KnowledgeBaseSolutions'. It represents the knowledge base solutions in the Service module.

GET KnowledgeBaseSolutions(id)
Retrieve all or some selected properties from an instance of 'KnowledgeBaseSolutions' with the given id.

Example

GET [Link]

GET [Link]

GET KnowledgeBaseSolutions
Retrieve a collection of 'KnowledgeBaseSolutions' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=SolutionCode

POST KnowledgeBaseSolutions
Create an instance of 'KnowledgeBaseSolutions' with the given payload of type 'KnowledgeBaseSolution' in JSON format.

Example

POST [Link]

{
"Description": "Application Crashed on Linux system",
"ItemCode": "item01",
"Solution": "Crash issue",
"Symptom": "Application Crashed"
}

PATCH KnowledgeBaseSolutions(id)
Update an instance of 'KnowledgeBaseSolutions' with the given payload of type 'KnowledgeBaseSolution' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Solution": "Application issue"
}

DELETE KnowledgeBaseSolutions(id)
Delete an instance of 'KnowledgeBaseSolutions' with the specified id.

Example

DELETE [Link]

KPIs
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'KPIs'.

GET KPIs(id)

Retrieve all or some selected properties from an instance of 'KPIs' with the given id.

[Link] Layer API [Link] 215/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET KPIs

Retrieve a collection of 'KPIs' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=KPICode&$top=10&$skip=1

POST KPIs

Create an instance of 'KPIs' with the given payload of type 'KPI' in JSON format.

Example

POST [Link]

{
"KPICode": "CFC001",
"KPIName": "Cash Flow Config001",
"KPIType": "asSingle",
"KPI_ItemLines": [
{
"KPICode": "CFC001",
"KPILineNumber": 1,
"KPIName": "No. of Days",
"KPIValue1": 5,
"KPIValue10": 0,
"KPIValue11": 0,
"KPIValue12": 0,
"KPIValue13": 0,
"KPIValue14": 0,
"KPIValue15": 0,
"KPIValue16": 0,
"KPIValue17": 0,
"KPIValue18": 0,
"KPIValue19": 0,
"KPIValue2": 0,
"KPIValue20": 0,
"KPIValue21": 0,
"KPIValue22": 0,
"KPIValue23": 0,
"KPIValue24": 0,
"KPIValue25": 0,
"KPIValue26": 0,
"KPIValue27": 0,
"KPIValue28": 0,
"KPIValue29": 0,
"KPIValue3": 0,
"KPIValue30": 0,
"KPIValue4": 0,
"KPIValue5": 0,
"KPIValue6": 0,
"KPIValue7": 0,
"KPIValue8": 0,
"KPIValue9": 0
}
],
"NumberOfColumns": 1
}

PATCH KPIs(id)

Update an instance of 'KPIs' with the given payload of type 'KPI' in JSON format and with the specified id.

Example

PATCH [Link]

{
"KPIName": "Cash Flow Config0012"
}

DELETE KPIs(id)

[Link] Layer API [Link] 216/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'KPIs' with the specified id.

Example

DELETE [Link]

LandedCosts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'LandedCosts'.

GET LandedCosts(id)

Retrieve all or some selected properties from an instance of 'LandedCosts' with the given id.

Example

GET [Link]

GET [Link]

GET LandedCosts

Retrieve a collection of 'LandedCosts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$t

POST LandedCosts

Create an instance of 'LandedCosts' with the given payload of type 'LandedCost' in JSON format.

Example

POST [Link]

{}

PATCH LandedCosts(id)

Update an instance of 'LandedCosts' with the given payload of type 'LandedCost' in JSON format and with the specified id.

Example

PATCH [Link]

{
"JournalRemarks": "update from sl"
}

DELETE LandedCosts(id)

Delete an instance of 'LandedCosts' with the specified id.

Example

DELETE [Link]

POST LandedCosts(id)/CloseLandedCost

Invoke the method 'CloseLandedCost' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 217/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

POST LandedCosts(id)/CancelLandedCost
Invoke the method 'CancelLandedCost' on this EntitySet with the specified id.

Example

POST [Link]

LandedCostsCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'LandedCostsCodes'. It defines various types of landed costs (for example, insurance, customs) and their default distribution
rules. When you record landed costs for deliveries, landed costs are allocated to the goods according to the distribution rule of each type.

GET LandedCostsCodes(id)
Retrieve all or some selected properties from an instance of 'LandedCostsCodes' with the given id.

Example

GET [Link]

GET [Link]

GET LandedCostsCodes

Retrieve a collection of 'LandedCostsCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$s

POST LandedCostsCodes

Create an instance of 'LandedCostsCodes' with the given payload of type 'LandedCostsCode' in JSON format.

Example

POST [Link]

{
"AllocationBy": "ab_Quantity",
"Code": "01",
"Name": "Insurance"
}

PATCH LandedCostsCodes(id)

Update an instance of 'LandedCostsCodes' with the given payload of type 'LandedCostsCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Shipping"
}

DELETE LandedCostsCodes(id)

Delete an instance of 'LandedCostsCodes' with the specified id.

Example

[Link] Layer API [Link] 218/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

LegalData
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'LegalData'.

GET LegalData(id)
Retrieve all or some selected properties from an instance of 'LegalData' with the given id.

Example

GET [Link]

GET [Link]

GET LegalData
Retrieve a collection of 'LegalData' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntr

POST LegalData

Create an instance of 'LegalData' with the given payload of type 'LegalData' in JSON format.

Example

POST [Link]

{
"DateOfPrinting": null,
"DocEntry": 1,
"DocumentNumber": "1",
"FiscalNumber": "1",
"FiscalSeries": "1",
"FiscalUserID": "1",
"LegalDataDetailCollection": [
{
"Amount": 10,
"DocEntry": 1,
"LineSequence": 1,
"LineType": "ldlt_DocumentTotal",
"TaxCode": "1",
"TaxRate": "1"
}
],
"PrinterBrand": "1",
"PrinterDllVersion": "1",
"PrinterFirmwareVersion": "1",
"PrinterModel": "1",
"PrinterType": "1",
"SourceObjectEntry": 5,
"SourceObjectType": "bodt_Invoice",
"TimeOfPrinting": null
}

PATCH LegalData(id)

Update an instance of 'LegalData' with the given payload of type 'LegalData' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PrinterType": "12"
}

[Link] Layer API [Link] 219/334

6/7/24, 15:42 Service Layer API Reference

LengthMeasures
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'LengthMeasures'. It defines the length and width measure units that are used for item records.

GET LengthMeasures(id)
Retrieve all or some selected properties from an instance of 'LengthMeasures' with the given id.

Example

GET [Link]

GET [Link]

GET LengthMeasures
Retrieve a collection of 'LengthMeasures' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=UnitCode&$top=10

POST LengthMeasures
Create an instance of 'LengthMeasures' with the given payload of type 'LengthMeasure' in JSON format.

Example

POST [Link]

{
"UnitCodeforQuantityDisplay": "kmm",
"UnitDisplay": "KM",
"UnitLengthinmm": "120",
"UnitName": "kilometer"
}

PATCH LengthMeasures(id)
Update an instance of 'LengthMeasures' with the given payload of type 'LengthMeasure' in JSON format and with the specified id.

Example

PATCH [Link]

{
"UnitLengthinmm": "240"
}

DELETE LengthMeasures(id)
Delete an instance of 'LengthMeasures' with the specified id.

Example

DELETE [Link]

LocalEra
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'LocalEra'.

GET LocalEra(id)
[Link] Layer API [Link] 220/334
6/7/24, 15:42 Service Layer API Reference
Retrieve all or some selected properties from an instance of 'LocalEra' with the given id.

Example

GET [Link]

GET [Link]

GET LocalEra

Retrieve a collection of 'LocalEra' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$skip=1

POST LocalEra

Create an instance of 'LocalEra' with the given payload of type 'LocalEra' in JSON format.

Example

POST [Link]

{
"Code": "D",
"EraName": "Showa",
"StartDate": "1923-12-25"
}

PATCH LocalEra(id)

Update an instance of 'LocalEra' with the given payload of type 'LocalEra' in JSON format and with the specified id.

Example

PATCH [Link]

{
"EraName": "Maruzen"
}

DELETE LocalEra(id)

Delete an instance of 'LocalEra' with the specified id.

Example

DELETE [Link]

Manufacturers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Manufacturers'. It defines manufacturers used in the Item master data.

GET Manufacturers(id)

Retrieve all or some selected properties from an instance of 'Manufacturers' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 221/334

6/7/24, 15:42 Service Layer API Reference
GET Manufacturers

Retrieve a collection of 'Manufacturers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST Manufacturers

Create an instance of 'Manufacturers' with the given payload of type 'Manufacturer' in JSON format.

Example

POST [Link]

{
"ManufacturerName": "Prosoft"
}

PATCH Manufacturers(id)

Update an instance of 'Manufacturers' with the given payload of type 'Manufacturer' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ManufacturerName": "Rainbow"
}

DELETE Manufacturers(id)

Delete an instance of 'Manufacturers' with the specified id.

Example

DELETE [Link]

MaterialGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'MaterialGroups'.

GET MaterialGroups(id)
Retrieve all or some selected properties from an instance of 'MaterialGroups' with the given id.

Example

GET [Link]

GET [Link]

GET MaterialGroups
Retrieve a collection of 'MaterialGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntr

[Link] Layer API [Link] 222/334

6/7/24, 15:42 Service Layer API Reference
POST MaterialGroups

Create an instance of 'MaterialGroups' with the given payload of type 'MaterialGroup' in JSON format.

Example

POST [Link]

{
"AbsEntry": 1,
"Description": "",
"MaterialGroupCode": "1"
}

PATCH MaterialGroups(id)

Update an instance of 'MaterialGroups' with the given payload of type 'MaterialGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test"
}

DELETE MaterialGroups(id)

Delete an instance of 'MaterialGroups' with the specified id.

Example

DELETE [Link]

MaterialRevaluation
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'MaterialRevaluation'. It allows to update the items' price (average price or standard price only), revaluate the stock, and create
journal entries accordingly.

GET MaterialRevaluation(id)
Retrieve all or some selected properties from an instance of 'MaterialRevaluation' with the given id.

Example

GET [Link]

GET [Link]

GET MaterialRevaluation
Retrieve a collection of 'MaterialRevaluation' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=1

POST MaterialRevaluation
Create an instance of 'MaterialRevaluation' with the given payload of type 'MaterialRevaluation' in JSON format.

Example

POST [Link]

[Link] Layer API [Link] 223/334

6/7/24, 15:42 Service Layer API Reference
"Comments": "Create new revaluation for item",
"DataSource": "I",
"MaterialRevaluationLines": [
{
"ItemCode": "item01",
"Price": "18805"
}
],
"RevalType": "P"
}

PATCH MaterialRevaluation(id)
Update an instance of 'MaterialRevaluation' with the given payload of type 'MaterialRevaluation' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE MaterialRevaluation(id)
Delete an instance of 'MaterialRevaluation' with the specified id.

Example

DELETE [Link]

POST MaterialRevaluation(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST MaterialRevaluation(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

Messages
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Messages'. You can also specify the OData query options to query the messages, which is a combination of Inbox messages,
Outbox messages and to-send messages.

GET Messages(id)

Retrieve all or some selected properties from an instance of 'Messages' with the given id.

Example

GET [Link]

GET [Link]

GET Messages

Retrieve a collection of 'Messages' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 224/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 1 &$orderby=Code&$top=10&$skip=1

POST Messages
Create an instance of 'Messages' with the given payload of type 'Message' in JSON format, which is functionally equivalent to the old method
'MessagesService_SendMessage'.

Example

POST [Link]

{
"MessageDataColumns": [
{
"ColumnName": "Document",
"Link": "tYES",
"MessageDataLines": [
{
"Object": "17",
"ObjectKey": "2",
"Value": "1"
}
]
}
],
"RecipientCollection": [
{
"SendInternal": "tYES",
"UserCode": "andy"
}
],
"Subject": "service layer subject 01",
"Text": "test by service layer"
}

POST Messages(id)/GetMessage
Invoke the method 'GetMessage' on this EntitySet with the specified id. It is functionally equivalent to 'GET Messages(id)'

Example

POST [Link]

MobileAddOnSetting
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'MobileAddOnSetting'.

GET MobileAddOnSetting(id)

Retrieve all or some selected properties from an instance of 'MobileAddOnSetting' with the given id.

Example

GET [Link]

GET [Link]

GET MobileAddOnSetting

Retrieve a collection of 'MobileAddOnSetting' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$s

POST MobileAddOnSetting
[Link] Layer API [Link] 225/334
6/7/24, 15:42 Service Layer API Reference
Create an instance of 'MobileAddOnSetting' with the given payload of type 'MobileAddOnSetting' in JSON format.

Example

POST [Link]

{}

PATCH MobileAddOnSetting(id)

Update an instance of 'MobileAddOnSetting' with the given payload of type 'MobileAddOnSetting' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE MobileAddOnSetting(id)

Delete an instance of 'MobileAddOnSetting' with the specified id.

Example

DELETE [Link]

MultiLanguageTranslations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'MultiLanguageTranslations'. It allows translating alphanumeric data of specified fields in master data objects (such as
BusinessPartners and Items) to foreign languages and then printing documents in the translated languages.

GET MultiLanguageTranslations(id)

Retrieve all or some selected properties from an instance of 'MultiLanguageTranslations' with the given id.

Example

GET [Link]

GET [Link]

GET MultiLanguageTranslations

Retrieve a collection of 'MultiLanguageTranslations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Num

POST MultiLanguageTranslations

Create an instance of 'MultiLanguageTranslations' with the given payload of type 'MultiLanguageTranslation' in JSON format.

Example

POST [Link]

{
"FieldAlias": "Free_Text",
"PrimaryKeyofobject": "v001",
"TableName": "OCRD",
"TranslationsInUserLanguages": [
{
"LanguageCodeOfUserLanguage": "8",
"Translationscontent": "Remarks"
}
]

[Link] Layer API [Link] 226/334

6/7/24, 15:42 Service Layer API Reference
}

PATCH MultiLanguageTranslations(id)
Update an instance of 'MultiLanguageTranslations' with the given payload of type 'MultiLanguageTranslation' in JSON format and with the specified
id.

Example

PATCH [Link]

{
"TranslationsInUserLanguages": [
{
"Translationscontent": "Description"
}
]
}

DELETE MultiLanguageTranslations(id)
Delete an instance of 'MultiLanguageTranslations' with the specified id.

Example

DELETE [Link]

NatureOfAssessees
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'NatureOfAssessees'.

GET NatureOfAssessees(id)

Retrieve all or some selected properties from an instance of 'NatureOfAssessees' with the given id.

Example

GET [Link]

GET [Link]

GET NatureOfAssessees

Retrieve a collection of 'NatureOfAssessees' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&

POST NatureOfAssessees

Create an instance of 'NatureOfAssessees' with the given payload of type 'NatureOfAssessee' in JSON format.

Example

POST [Link]

{
"AbsEntry": 4,
"AssesseeType": "atOthers",
"Code": "2HUF",
"Description": "11HUF"
}

PATCH NatureOfAssessees(id)

[Link] Layer API [Link] 227/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'NatureOfAssessees' with the given payload of type 'NatureOfAssessee' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "11HUF"
}

DELETE NatureOfAssessees(id)

Delete an instance of 'NatureOfAssessees' with the specified id.

Example

DELETE [Link]

NCMCodesSetup
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'NCMCodesSetup'.

GET NCMCodesSetup(id)

Retrieve all or some selected properties from an instance of 'NCMCodesSetup' with the given id.

Example

GET [Link]

GET [Link]

GET NCMCodesSetup

Retrieve a collection of 'NCMCodesSetup' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$

POST NCMCodesSetup

Create an instance of 'NCMCodesSetup' with the given payload of type 'NCMCodeSetup' in JSON format.

Example

POST [Link]

{
"AbsEntry": 2,
"Description": "Outros",
"NCMCode": "0905.59.901"
}

PATCH NCMCodesSetup(id)

Update an instance of 'NCMCodesSetup' with the given payload of type 'NCMCodeSetup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "111Outros"
}

[Link] Layer API [Link] 228/334

6/7/24, 15:42 Service Layer API Reference
DELETE NCMCodesSetup(id)

Delete an instance of 'NCMCodesSetup' with the specified id.

Example

DELETE [Link]

NFModels
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'NFModels'.

GET NFModels(id)

Retrieve all or some selected properties from an instance of 'NFModels' with the given id.

Example

GET [Link]

GET [Link]

GET NFModels
Retrieve a collection of 'NFModels' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=AbsEntry&$

POST NFModels
Create an instance of 'NFModels' with the given payload of type 'NFModel' in JSON format.

Example

POST [Link]

{
"AbsEntry": "55",
"NFMCode": "201",
"NFMDescription": "test",
"NFMName": "testModelo 21"
}

PATCH NFModels(id)
Update an instance of 'NFModels' with the given payload of type 'NFModel' in JSON format and with the specified id.

Example

PATCH [Link]

{
"NFMDescription": "02 Nota Fiscal de Venda a Consumidor"
}

DELETE NFModels(id)
Delete an instance of 'NFModels' with the specified id.

Example

DELETE [Link]

[Link] Layer API [Link] 229/334

6/7/24, 15:42 Service Layer API Reference

NFTaxCategories
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'NFTaxCategories'.

GET NFTaxCategories(id)
Retrieve all or some selected properties from an instance of 'NFTaxCategories' with the given id.

Example

GET [Link]

GET [Link]

GET NFTaxCategories
Retrieve a collection of 'NFTaxCategories' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsId&$top=10&$skip=1

POST NFTaxCategories
Create an instance of 'NFTaxCategories' with the given payload of type 'NFTaxCategory' in JSON format.

Example

POST [Link]

{
"AbsId": 1,
"Code": "PIS1",
"GPCId": -1,
"Locked": "tNO"
}

PATCH NFTaxCategories(id)
Update an instance of 'NFTaxCategories' with the given payload of type 'NFTaxCategory' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE NFTaxCategories(id)
Delete an instance of 'NFTaxCategories' with the specified id.

Example

DELETE [Link]

OccurrenceCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'OccurrenceCodes'.

GET OccurrenceCodes(id)

[Link] Layer API [Link] 230/334

6/7/24, 15:42 Service Layer API Reference
Retrieve all or some selected properties from an instance of 'OccurrenceCodes' with the given id.

Example

GET [Link]

GET [Link]

GET OccurrenceCodes

Retrieve a collection of 'OccurrenceCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$s

POST OccurrenceCodes

Create an instance of 'OccurrenceCodes' with the given payload of type 'OccurenceCode' in JSON format.

Example

POST [Link]

{
"Code": "01",
"Description": "001",
"RequestedBoeStatus": "boes_Created"
}

PATCH OccurrenceCodes(id)

Update an instance of 'OccurrenceCodes' with the given payload of type 'OccurenceCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "updating",
"RequestedBoeStatus": "boes_Deposited"
}

DELETE OccurrenceCodes(id)

Delete an instance of 'OccurrenceCodes' with the specified id.

Example

DELETE [Link]

Orders
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Orders'. It represents a commitment from a customer or lead to buy a product or service.

GET Orders(id)

Retrieve all or some selected properties from an instance of 'Orders' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 231/334

6/7/24, 15:42 Service Layer API Reference
GET Orders

Retrieve a collection of 'Orders' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=1

POST Orders

Create an instance of 'Orders' with the given payload of type 'Document' in JSON format. Under normal conditions, a new order would be created on
posting Orders. However, when activating approval procedures, a draft would be created due to the special business logic and service would return the
error code -2028. For this case, a header(Prefer: return-no-content) should be appended to avoid this error. Accordingly, service would return http staus
204, with empty response body. For more details, please see Working with SAP Business One Service [Link].

Example

POST [Link]

{
"CardCode": "c001",
"DocDueDate": "2014-04-04",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

PATCH Orders(id)

Update an instance of 'Orders' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST Orders(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST Orders(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST Orders(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST Orders(id)/CreateCancellationDocument

[Link] Layer API [Link] 232/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PackagesTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PackagesTypes'. It represents various packaging types for deliveries.

GET PackagesTypes(id)

Retrieve all or some selected properties from an instance of 'PackagesTypes' with the given id.

Example

GET [Link]

GET [Link]

GET PackagesTypes

Retrieve a collection of 'PackagesTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST PackagesTypes

Create an instance of 'PackagesTypes' with the given payload of type 'PackagesType' in JSON format.

Example

POST [Link]

{
"Height1": "60",
"Height1Unit": "4",
"Length1": "10",
"Length1Unit": "4",
"Type": "carton",
"VolumeUnit": "2",
"Weight1": "200",
"Weight1Unit": "3",
"Width1": "30",
"Width1Unit": "4"
}

PATCH PackagesTypes(id)

Update an instance of 'PackagesTypes' with the given payload of type 'PackagesType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Length1": "20"
}

DELETE PackagesTypes(id)

Delete an instance of 'PackagesTypes' with the specified id.

Example

[Link] Layer API [Link] 233/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

PartnersSetups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PartnersSetups'.

GET PartnersSetups(id)
Retrieve all or some selected properties from an instance of 'PartnersSetups' with the given id.

Example

GET [Link]

GET [Link]

GET PartnersSetups
Retrieve a collection of 'PartnersSetups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=PartnerID&$t

POST PartnersSetups

Create an instance of 'PartnersSetups' with the given payload of type 'PartnersSetupParams' in JSON format.

Example

POST [Link]

{
"DefaultRelationship": "01",
"Name": "Partner 01",
"RelatedBP": "C01"
}

PATCH PartnersSetups(id)

Update an instance of 'PartnersSetups' with the given payload of type 'PartnersSetupParams' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Details": "Updated related BP",
"RelatedBP": "V01"
}

DELETE PartnersSetups(id)

Delete an instance of 'PartnersSetups' with the specified id.

Example

DELETE [Link]

PaymentBlocks
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 234/334

6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'PaymentBlocks'.

GET PaymentBlocks(id)
Retrieve all or some selected properties from an instance of 'PaymentBlocks' with the given id.

Example

GET [Link]

GET [Link]

GET PaymentBlocks
Retrieve a collection of 'PaymentBlocks' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$ski

POST PaymentBlocks
Create an instance of 'PaymentBlocks' with the given payload of type 'PaymentBlock' in JSON format.

Example

POST [Link]

{
"PaymentBlockCode": "aaaaaa"
}

PATCH PaymentBlocks(id)
Update an instance of 'PaymentBlocks' with the given payload of type 'PaymentBlock' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PaymentBlockCode": "bbbbbbb"
}

DELETE PaymentBlocks(id)
Delete an instance of 'PaymentBlocks' with the specified id.

Example

DELETE [Link]

PaymentDrafts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PaymentDrafts'.

GET PaymentDrafts(id)

Retrieve all or some selected properties from an instance of 'PaymentDrafts' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 235/334

6/7/24, 15:42 Service Layer API Reference

GET PaymentDrafts
Retrieve a collection of 'PaymentDrafts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$sk

POST PaymentDrafts
Create an instance of 'PaymentDrafts' with the given payload of type 'Payment' in JSON format.

Example

POST [Link]

{}

PATCH PaymentDrafts(id)
Update an instance of 'PaymentDrafts' with the given payload of type 'Payment' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE PaymentDrafts(id)
Delete an instance of 'PaymentDrafts' with the specified id.

Example

DELETE [Link]

POST PaymentDrafts(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PaymentDrafts(id)/SaveDraftToDocument
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST [Link]

POST PaymentDrafts(id)/GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this EntitySet with the specified id.

Example

POST [Link]

POST PaymentDrafts(id)/CancelbyCurrentSystemDate
Invoke the method 'CancelbyCurrentSystemDate' on this EntitySet with the specified id.

[Link] Layer API [Link] 236/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

PaymentRunExport
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PaymentRunExport'. It allows you to export data of automatic payments for both incoming payments and outgoing payments
to vendors.

GET PaymentRunExport(id)

Retrieve all or some selected properties from an instance of 'PaymentRunExport' with the given id.

Example

GET [Link]

GET [Link]

GET PaymentRunExport
Retrieve a collection of 'PaymentRunExport' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Absolut

PaymentTermsTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PaymentTermsTypes'. It represents the types of payment terms in the Banking module. The payment terms define typical
agreements that apply to transactions with customers and vendors.

GET PaymentTermsTypes(id)
Retrieve all or some selected properties from an instance of 'PaymentTermsTypes' with the given id.

Example

GET [Link]

GET [Link]

GET PaymentTermsTypes
Retrieve a collection of 'PaymentTermsTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orde

POST PaymentTermsTypes

Create an instance of 'PaymentTermsTypes' with the given payload of type 'PaymentTermsType' in JSON format.

Example

[Link] Layer API [Link] 237/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"CreditLimit": "44",
"GeneralDiscount": "33",
"LoadLimit": "55",
"PaymentTermsGroupName": "10DTerm"
}

PATCH PaymentTermsTypes(id)
Update an instance of 'PaymentTermsTypes' with the given payload of type 'PaymentTermsType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"GeneralDiscount": "10"
}

DELETE PaymentTermsTypes(id)
Delete an instance of 'PaymentTermsTypes' with the specified id.

Example

DELETE [Link]

PickLists
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PickLists'. It supports the picking process of items from the warehouse. The picking process applies only to items that are
already approved in sales orders.

GET PickLists(id)

Retrieve all or some selected properties from an instance of 'PickLists' with the given id.

Example

GET [Link]

GET [Link]

GET PickLists

Retrieve a collection of 'PickLists' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=Absoluteentry&$top=

POST PickLists

Create an instance of 'PickLists' with the given payload of type 'PickList' in JSON format.

Example

POST [Link]

{
"ObjectType": "156",
"PickDate": "2016-08-25",
"PickListsLines": [
{
"BaseObjectType": 17,
"OrderEntry": 9,
"OrderRowID": 0,

[Link] Layer API [Link] 238/334

6/7/24, 15:42 Service Layer API Reference
"ReleasedQuantity": 1
}
]
}

PATCH PickLists(id)
Update an instance of 'PickLists' with the given payload of type 'PickList' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "Updated Remarks"
}

PUT PickLists(id)
PickList is a very special object. The exposed properties are not enough for Service Layer to finish a patch operation with 'PickListsLines'. In this way,
use 'put' instead.

Example

PUT [Link]

{
"Absoluteentry": 19,
"Name": "Jayson Butler",
"ObjectType": "156",
"OwnerCode": 1,
"OwnerName": null,
"PickDate": "2017-09-09",
"PickListsLines": [
{
"AbsoluteEntry": 19,
"BaseObjectType": 17,
"BatchNumbers": [],
"DocumentLinesBinAllocations": [
{
"AllowNegativeQuantity": "tNO",
"BaseLineNumber": 0,
"BinAbsEntry": 2,
"Quantity": 2,
"SerialAndBatchNumbersBaseLine": -1
}
],
"LineNumber": 0,
"OrderEntry": 378,
"OrderRowID": 0,
"PickStatus": "ps_Picked",
"PickedQuantity": 2,
"PreviouslyReleasedQuantity": 4,
"ReleasedQuantity": 2,
"SerialNumbers": []
}
],
"Remarks": "",
"Status": "ps_Picked",
"UseBaseUnits": "tNO"
}

POST PickLists(id)/GetReleasedAllocation
Invoke the method 'GetReleasedAllocation' on this EntitySet with the specified id.

Example

POST [Link]

POSDailySummary
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'POSDailySummary'.

GET POSDailySummary(id)

Retrieve all or some selected properties from an instance of 'POSDailySummary' with the given id.

[Link] Layer API [Link] 239/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET POSDailySummary

Retrieve a collection of 'POSDailySummary' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$s

POST POSDailySummary

Create an instance of 'POSDailySummary' with the given payload of type 'POSDailySummary' in JSON format.

Example

POST [Link]

{
"CounterPosition": "11",
"Date": "2016-08-30",
"EquipmentNo": "123",
"OperationCounter": "13",
"ResetCounterPosition": "12"
}

PATCH POSDailySummary(id)

Update an instance of 'POSDailySummary' with the given payload of type 'POSDailySummary' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Date": "2016-08-31",
"POSTotalizerCollection": [
{
"Code": "001",
"Description": "",
"Number": "2"
}
]
}

DELETE POSDailySummary(id)

Delete an instance of 'POSDailySummary' with the specified id.

Example

DELETE [Link]

PredefinedTexts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PredefinedTexts'.

GET PredefinedTexts(id)
Retrieve all or some selected properties from an instance of 'PredefinedTexts' with the given id.

Example

[Link] Layer API [Link] 240/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link]

GET PredefinedTexts
Retrieve a collection of 'PredefinedTexts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=Numerator&$top=10&$ski

POST PredefinedTexts
Create an instance of 'PredefinedTexts' with the given payload of type 'PredefinedText' in JSON format.

Example

POST [Link]

{
"Text": "V5's text",
"TextCode": "V5"
}

PATCH PredefinedTexts(id)
Update an instance of 'PredefinedTexts' with the given payload of type 'PredefinedText' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Text": "updating V5's text",
"TextCode": "V5"
}

DELETE PredefinedTexts(id)
Delete an instance of 'PredefinedTexts' with the specified id.

Example

DELETE [Link]

PriceLists
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PriceLists'. It represents the management of price lists in the Inventory module. An item can have several prices, with each
based on a different price list, for example, purchase price list, sales price list, distributor price list, and so on.

GET PriceLists(id)

Retrieve all or some selected properties from an instance of 'PriceLists' with the given id.

Example

GET [Link]

GET [Link]

GET PriceLists

Retrieve a collection of 'PriceLists' with all or some selected properties in the given order by specifying the given filter condition.

[Link] Layer API [Link] 241/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link] ge 123 &$orderby=PriceList

POST PriceLists

Create an instance of 'PriceLists' with the given payload of type 'PriceList' in JSON format.

Example

POST [Link]

{
"PriceListName": "Price List 30"
}

PATCH PriceLists(id)

Update an instance of 'PriceLists' with the given payload of type 'PriceList' in JSON format and with the specified id.

Example

PATCH [Link]

{
"PriceListName": "Price List 40"
}

DELETE PriceLists(id)

Delete an instance of 'PriceLists' with the specified id.

Example

DELETE [Link]

ProductionOrders
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ProductionOrders'.

GET ProductionOrders(id)
Retrieve all or some selected properties from an instance of 'ProductionOrders' with the given id.

Example

GET [Link]

GET [Link]

GET ProductionOrders
Retrieve a collection of 'ProductionOrders' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Abs

POST ProductionOrders
Create an instance of 'ProductionOrders' with the given payload of type 'ProductionOrder' in JSON format.

[Link] Layer API [Link] 242/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"DueDate": "2014-04-05",
"ItemNo": "bom1",
"PlannedQuantity": 100
}

POST [Link]

{
"DueDate": "20170604",
"ItemNo": "10000978",
"PlannedQuantity": 3,
"PostingDate": "20170604",
"Warehouse": "MD01"
}

PATCH ProductionOrders(id)

Update an instance of 'ProductionOrders' with the given payload of type 'ProductionOrder' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ProductionOrderStatus": "R",
"Remarks": "Updated Remarks"
}

POST ProductionOrders(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

ProductTrees
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ProductTrees'. It represents a completed product comprising parts and raw materials, which is described by means of a bill of
materials.

GET ProductTrees(id)
Retrieve all or some selected properties from an instance of 'ProductTrees' with the given id.

Example

GET [Link]

GET [Link]

GET ProductTrees
Retrieve a collection of 'ProductTrees' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=TreeCode&$t

POST ProductTrees
Create an instance of 'ProductTrees' with the given payload of type 'ProductTree' in JSON format.

[Link] Layer API [Link] 243/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"ProductTreeLines": [
{
"ItemCode": "i001",
"Quantity": 5
}
],
"TreeCode": "pt001",
"TreeType": "iProductionTree"
}

PATCH ProductTrees(id)

Update an instance of 'ProductTrees' with the given payload of type 'ProductTree' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Quantity": 20
}

DELETE ProductTrees(id)

Delete an instance of 'ProductTrees' with the specified id.

Example

DELETE [Link]

ProfitCenters
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ProfitCenters'.

GET ProfitCenters(id)
Retrieve all or some selected properties from an instance of 'ProfitCenters' with the given id.

Example

GET [Link]

GET [Link]

GET ProfitCenters
Retrieve a collection of 'ProfitCenters' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Cen

POST ProfitCenters
Create an instance of 'ProfitCenters' with the given payload of type 'ProfitCenter' in JSON format.

Example

POST [Link]

{
"CenterCode": "NY_B",
"CenterName": "New York Branch",

[Link] Layer API [Link] 244/334

6/7/24, 15:42 Service Layer API Reference
"EffectiveFrom": "2014-01-01",
"EffectiveTo": "2014-12-31"
}

PATCH ProfitCenters(id)
Update an instance of 'ProfitCenters' with the given payload of type 'ProfitCenter' in JSON format and with the specified id.

Example

PATCH [Link]

{
"CenterName": "General Center"
}

DELETE ProfitCenters(id)
Delete an instance of 'ProfitCenters' with the specified id.

Example

DELETE [Link]

ProjectManagements
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ProjectManagements'.

GET ProjectManagements(id)

Retrieve all or some selected properties from an instance of 'ProjectManagements' with the given id.

Example

GET [Link]

GET [Link]

GET ProjectManagements

Retrieve a collection of 'ProjectManagements' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=1

POST ProjectManagements

Create an instance of 'ProjectManagements' with the given payload of type 'PM_ProjectDocumentData' in JSON format.

Example

POST [Link]

{
"AllowSubprojects": "tYES",
"AttachmentEntry": 1,
"BusinessPartner": "Customer_01",
"BusinessPartnerName": "BP Name_01",
"ClosingDate": "2016-12-31",
"ContactPerson": 2,
"DueDate": "2016-11-30",
"FinancialProject": "FinProj_01",
"Industry": 3,
"Owner": 1,
"ProjectName": "ProjectByDI_01",
"ProjectStatus": "pst_Started",
"ProjectType": "pt_External",

[Link] Layer API [Link] 245/334

6/7/24, 15:42 Service Layer API Reference
"Reason": "Test comment",
"RiskLevel": "rlt_High",
"SalesEmployee": 5,
"StartDate": "2016-02-01",
"Territory": 1
}

PATCH ProjectManagements(id)
Update an instance of 'ProjectManagements' with the given payload of type 'PM_ProjectDocumentData' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Reason": "Test comment update"
}

DELETE ProjectManagements(id)
Delete an instance of 'ProjectManagements' with the specified id.

Example

DELETE [Link]

POST ProjectManagements(id)/CancelProject
Invoke the method 'CancelProject' on this EntitySet with the specified id.

Example

POST [Link]

ProjectManagementTimeSheet
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ProjectManagementTimeSheet'.

GET ProjectManagementTimeSheet(id)

Retrieve all or some selected properties from an instance of 'ProjectManagementTimeSheet' with the given id.

Example

GET [Link]

GET [Link]

GET ProjectManagementTimeSheet

Retrieve a collection of 'ProjectManagementTimeSheet' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=Abs

POST ProjectManagementTimeSheet

Create an instance of 'ProjectManagementTimeSheet' with the given payload of type 'PM_TimeSheetData' in JSON format.

Example

[Link] Layer API [Link] 246/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"DateFrom": "2016-08-31",
"DateTo": "2016-08-31",
"PM_TimeSheetLineDataCollection": [
{
"ActivityType": "1",
"Date": "2016-08-31",
"EndTime": "18:00",
"StartTime": "09:00"
}
],
"UserID": "2"
}

PATCH ProjectManagementTimeSheet(id)
Update an instance of 'ProjectManagementTimeSheet' with the given payload of type 'PM_TimeSheetData' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DateFrom": "2016-08-31",
"DateTo": "2016-09-01",
"PM_TimeSheetLineDataCollection": [
{
"ActivityType": "1",
"Date": "2016-09-01",
"LineID": 1
}
]
}

DELETE ProjectManagementTimeSheet(id)
Delete an instance of 'ProjectManagementTimeSheet' with the specified id.

Example

DELETE [Link]

Projects
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Projects'.

GET Projects(id)

Retrieve all or some selected properties from an instance of 'Projects' with the given id.

Example

GET [Link]

GET [Link]

GET Projects

Retrieve a collection of 'Projects' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$skip=1

POST Projects

Create an instance of 'Projects' with the given payload of type 'Project' in JSON format.

[Link] Layer API [Link] 247/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"Code": "PRJ01",
"Name": "Government Construction",
"ValidFrom": "2014-07-01",
"ValidTo": "2014-07-31"
}

PATCH Projects(id)

Update an instance of 'Projects' with the given payload of type 'Project' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Med Constructions"
}

DELETE Projects(id)

Delete an instance of 'Projects' with the specified id.

Example

DELETE [Link]

PurchaseCreditNotes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseCreditNotes'. It represents the clearing document for the A/P invoice. Therefore, if the vendor has delivered goods,
and you have already created an A/P invoice, you can reverse the transaction either partially or completely by creating a purchase credit note.

GET PurchaseCreditNotes(id)
Retrieve all or some selected properties from an instance of 'PurchaseCreditNotes' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseCreditNotes
Retrieve a collection of 'PurchaseCreditNotes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&

POST PurchaseCreditNotes
Create an instance of 'PurchaseCreditNotes' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",

[Link] Layer API [Link] 248/334

6/7/24, 15:42 Service Layer API Reference
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

PATCH PurchaseCreditNotes(id)
Update an instance of 'PurchaseCreditNotes' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE PurchaseCreditNotes(id)
Delete an instance of 'PurchaseCreditNotes' with the specified id.

Example

DELETE [Link]

POST PurchaseCreditNotes(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseCreditNotes(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseCreditNotes(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseCreditNotes(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PurchaseDeliveryNotes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseDeliveryNotes'. It represents a legally binding document indicating that a shipment of goods or a delivery of services
has occurred.

GET PurchaseDeliveryNotes(id)

[Link] Layer API [Link] 249/334

6/7/24, 15:42 Service Layer API Reference
Retrieve all or some selected properties from an instance of 'PurchaseDeliveryNotes' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseDeliveryNotes

Retrieve a collection of 'PurchaseDeliveryNotes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=1

POST PurchaseDeliveryNotes

Create an instance of 'PurchaseDeliveryNotes' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "c001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}

PATCH PurchaseDeliveryNotes(id)

Update an instance of 'PurchaseDeliveryNotes' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE PurchaseDeliveryNotes(id)

Delete an instance of 'PurchaseDeliveryNotes' with the specified id.

Example

DELETE [Link]

POST PurchaseDeliveryNotes(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseDeliveryNotes(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 250/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

POST PurchaseDeliveryNotes(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseDeliveryNotes(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PurchaseDownPayments
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseDownPayments'. It represents a document to ensure that a customer is committed and will follow through with a
placed order.

GET PurchaseDownPayments(id)

Retrieve all or some selected properties from an instance of 'PurchaseDownPayments' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseDownPayments

Retrieve a collection of 'PurchaseDownPayments' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10

POST PurchaseDownPayments

Create an instance of 'PurchaseDownPayments' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
],
"DownPaymentType": "dptInvoice"
}

PATCH PurchaseDownPayments(id)

[Link] Layer API [Link] 251/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'PurchaseDownPayments' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE PurchaseDownPayments(id)

Delete an instance of 'PurchaseDownPayments' with the specified id.

Example

DELETE [Link]

POST PurchaseDownPayments(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseDownPayments(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseDownPayments(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseDownPayments(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PurchaseInvoices
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseInvoices'. It represents a request for payment. It also records the cost in a profit and loss statement.

GET PurchaseInvoices(id)

Retrieve all or some selected properties from an instance of 'PurchaseInvoices' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 252/334

6/7/24, 15:42 Service Layer API Reference
GET PurchaseInvoices

Retrieve a collection of 'PurchaseInvoices' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$sk

POST PurchaseInvoices

Create an instance of 'PurchaseInvoices' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}

PATCH PurchaseInvoices(id)

Update an instance of 'PurchaseInvoices' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseInvoices(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseInvoices(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseInvoices(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseInvoices(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 253/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

PurchaseOrders
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseOrders'. It is a document used to request items or services from a vendor at an agreed upon price.

GET PurchaseOrders(id)
Retrieve all or some selected properties from an instance of 'PurchaseOrders' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseOrders
Retrieve a collection of 'PurchaseOrders' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip

POST PurchaseOrders

Create an instance of 'PurchaseOrders' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}

PATCH PurchaseOrders(id)

Update an instance of 'PurchaseOrders' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseOrders(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseOrders(id)/Cancel

[Link] Layer API [Link] 254/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseOrders(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseOrders(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PurchaseQuotations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseQuotations'. It represents an invitation to a number of vendors to find the best offer for goods or services that you
require.

GET PurchaseQuotations(id)

Retrieve all or some selected properties from an instance of 'PurchaseQuotations' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseQuotations

Retrieve a collection of 'PurchaseQuotations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$

POST PurchaseQuotations

Create an instance of 'PurchaseQuotations' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
],
"RequriedDate": "2014-04-04"

[Link] Layer API [Link] 255/334

6/7/24, 15:42 Service Layer API Reference
}

PATCH PurchaseQuotations(id)
Update an instance of 'PurchaseQuotations' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseQuotations(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseQuotations(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseQuotations(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseQuotations(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PurchaseRequests
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseRequests'. It allows users and employees in an organization to initiate a purchasing process by submitting their needs
for certain goods or services.

GET PurchaseRequests(id)

Retrieve all or some selected properties from an instance of 'PurchaseRequests' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseRequests

Retrieve a collection of 'PurchaseRequests' with all or some selected properties in the given order by specifying the given filter condition.
[Link] Layer API [Link] 256/334
6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$sk

POST PurchaseRequests

Create an instance of 'PurchaseRequests' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"DocumentLines": [
{
"ItemCode": "i001",
"LineVendor": "v001",
"Quantity": "11"
}
],
"RequriedDate": "2014-03-18"
}

PATCH PurchaseRequests(id)

Update an instance of 'PurchaseRequests' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE PurchaseRequests(id)

Delete an instance of 'PurchaseRequests' with the specified id.

Example

DELETE [Link]

POST PurchaseRequests(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseRequests(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseRequests(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseRequests(id)/CreateCancellationDocument
[Link] Layer API [Link] 257/334
6/7/24, 15:42 Service Layer API Reference
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PurchaseReturns
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseReturns'. It is used to return delivered goods to vendors or to reverse completely or partially a purchasing transaction
for an item.

GET PurchaseReturns(id)

Retrieve all or some selected properties from an instance of 'PurchaseReturns' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseReturns

Retrieve a collection of 'PurchaseReturns' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$ski

POST PurchaseReturns

Create an instance of 'PurchaseReturns' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

PATCH PurchaseReturns(id)

Update an instance of 'PurchaseReturns' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseReturns(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 258/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

POST PurchaseReturns(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseReturns(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST PurchaseReturns(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

PurchaseTaxInvoices
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'PurchaseTaxInvoices'. It represents the data of a purchase Tax Invoice document.

GET PurchaseTaxInvoices(id)

Retrieve all or some selected properties from an instance of 'PurchaseTaxInvoices' with the given id.

Example

GET [Link]

GET [Link]

GET PurchaseTaxInvoices

Retrieve a collection of 'PurchaseTaxInvoices' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&

POST PurchaseTaxInvoices

Create an instance of 'PurchaseTaxInvoices' with the given payload of type 'PurchaseTaxInvoice' in JSON format.

Example

POST [Link]

{
"CardCode": "v001",
"Comments": "create purchase tax invoice",
"DocType": "botit_Invoice",
"PurchaseTaxInvoiceLines": [
{

[Link] Layer API [Link] 259/334

6/7/24, 15:42 Service Layer API Reference
"RefEntry1": "11"
}
],
"PurchaseTaxInvoiceOperationCodes": [
{
"OpCode": "2"
}
]
}

PATCH PurchaseTaxInvoices(id)
Update an instance of 'PurchaseTaxInvoices' with the given payload of type 'PurchaseTaxInvoice' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "Update purchase tax invoice"
}

QueryAuthGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'QueryAuthGroups'.

GET QueryAuthGroups(id)
Retrieve all or some selected properties from an instance of 'QueryAuthGroups' with the given id.

Example

GET [Link]

GET [Link]

GET QueryAuthGroups

Retrieve a collection of 'QueryAuthGroups' with all or some selected properties by specifying the given filter condition.

Example

GET [Link]

GET [Link] &$filter=AuthGroupId eq -15

POST QueryAuthGroups

Create an instance of 'QueryAuthGroups' with the given payload of type 'QueryAuthGroup' in JSON [Link] and GroupDes should be
unique,mandatory.

Example

POST [Link]

{
"AuthGroupCode": "Group21",
"AuthGroupDes": "Group21description"
}

PATCH QueryAuthGroups(id)

Update an instance of 'QueryAuthGroups' with the given payload of type 'QueryAuthGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"AuthGroupDes": "Group21descriptionupdate"

[Link] Layer API [Link] 260/334

6/7/24, 15:42 Service Layer API Reference
}

PATCH QueryAuthGroups(id)
assign QueryAuthorizationGroups to query [Link] http header, set B1S-ReplaceCollectionsOnPatch as false.

Example

PATCH [Link]

{
"CategoryGroupCollection": [
{
"CategoryId": -2
},
{
"CategoryId": -1
}
]
}

PATCH QueryAuthGroups(id)
unassign QueryAuthorizationGroups to query category such as Category with CategoryId=-[Link] http header, set B1S-ReplaceCollectionsOnPatch as
true.

Example

PATCH [Link]

{
"CategoryGroupCollection": [
{
"CategoryId": -2
}
]
}

DELETE QueryAuthGroups(id)
Delete an instance of 'QueryAuthGroups' with the specified [Link] is allowed only when no query category is assigned to the query group.

Example

DELETE [Link]

QueryCategories
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'QueryCategories'. It represents the predefined query categories.

GET QueryCategories(id)

Retrieve all or some selected properties from an instance of 'QueryCategories' with the given id.

Example

GET [Link]

GET [Link]

GET QueryCategories

Retrieve a collection of 'QueryCategories' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

[Link] Layer API [Link] 261/334

6/7/24, 15:42 Service Layer API Reference
POST QueryCategories

Create an instance of 'QueryCategories' with the given payload of type 'QueryCategory' in JSON format.

Example

POST [Link]

{
"Name": "Query_Category_12"
}

PATCH QueryCategories(id)

Update an instance of 'QueryCategories' with the given payload of type 'QueryCategory' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Query_Category_01",
"Permissions": "NNNYNNNNNNNNNNN"
}

DELETE QueryCategories(id)

Delete an instance of 'QueryCategories' with the specified id.

Example

DELETE [Link]

Queue
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Queue'. It represents the queues list in the Service module from which you can assign a queue member to a service call.

GET Queue(id)
Retrieve all or some selected properties from an instance of 'Queue' with the given id.

Example

GET [Link]

GET [Link]

GET Queue
Retrieve a collection of 'Queue' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=QueueID&$top=10&$

POST Queue
Create an instance of 'Queue' with the given payload of type 'Queue' in JSON format.

Example

POST [Link]

{
"Description": "PC Issues",
"QueueID": "PCs",

[Link] Layer API [Link] 262/334

6/7/24, 15:42 Service Layer API Reference
"QueueManager": "1"
}

PATCH Queue(id)
Update an instance of 'Queue' with the given payload of type 'Queue' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "Printer Issues"
}

DELETE Queue(id)
Delete an instance of 'Queue' with the specified id.

Example

DELETE [Link]

Quotations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Quotations'. It is an offer or proposal that you send either to a customer or to a lead.

GET Quotations(id)

Retrieve all or some selected properties from an instance of 'Quotations' with the given id.

Example

GET [Link]

GET [Link]

GET Quotations

Retrieve a collection of 'Quotations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=1

POST Quotations

Create an instance of 'Quotations' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "30"
}
]
}

PATCH Quotations(id)

[Link] Layer API [Link] 263/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'Quotations' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST Quotations(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST Quotations(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST Quotations(id)/Reopen

Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST Quotations(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

Relationships
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Relationships'. It represents the relationships list from which a relationship definition can be associated with a partner in a
sales opportunity.

GET Relationships(id)

Retrieve all or some selected properties from an instance of 'Relationships' with the given id.

Example

GET [Link]

GET [Link]

GET Relationships

Retrieve a collection of 'Relationships' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

[Link] Layer API [Link] 264/334

6/7/24, 15:42 Service Layer API Reference

GET [Link] ge 123 &$orderb

POST Relationships
Create an instance of 'Relationships' with the given payload of type 'Relationship' in JSON format.

Example

POST [Link]

{
"RelationshipDescription": "Best Parnter"
}

PATCH Relationships(id)
Update an instance of 'Relationships' with the given payload of type 'Relationship' in JSON format and with the specified id.

Example

PATCH [Link]

{
"RelationshipDescription": "One time"
}

DELETE Relationships(id)
Delete an instance of 'Relationships' with the specified id.

Example

DELETE [Link]

ReportFilter
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ReportFilter'.

GET ReportFilter(id)

Retrieve all or some selected properties from an instance of 'ReportFilter' with the given id.

Example

GET [Link]

GET [Link]

GET ReportFilter

Retrieve a collection of 'ReportFilter' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=Code&$top=10&$skip=1

POST ReportFilter

Create an instance of 'ReportFilter' with the given payload of type 'TaxReportFilter' in JSON format.

Example

[Link] Layer API [Link] 265/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"FilterType": "trft_TaxReport",
"Name": "Myfilter",
"ReportLayout": "trfrlt_RegisterBookLayout"
}

PATCH ReportFilter(id)
Update an instance of 'ReportFilter' with the given payload of type 'TaxReportFilter' in JSON format and with the specified id.

Example

PATCH [Link]

{
"FromDate": "2016-08-01",
"ToDate": "2016-08-31"
}

DELETE ReportFilter(id)
Delete an instance of 'ReportFilter' with the specified id.

Example

DELETE [Link]

ReportTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ReportTypes'.

GET ReportTypes(id)

Retrieve all or some selected properties from an instance of 'ReportTypes' with the given id.

Example

GET [Link]

GET [Link]

GET ReportTypes

Retrieve a collection of 'ReportTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=T

POST ReportTypes

Create an instance of 'ReportTypes' with the given payload of type 'ReportType' in JSON format.

Example

POST [Link]

{
"TypeName": "report type 01"
}

PATCH ReportTypes(id)

Update an instance of 'ReportTypes' with the given payload of type 'ReportType' in JSON format and with the specified id.

[Link] Layer API [Link] 266/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"TypeName": "update report type 01"
}

DELETE ReportTypes(id)

Delete an instance of 'ReportTypes' with the specified id.

Example

DELETE [Link]

ResourceCapacities
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ResourceCapacities'.

GET ResourceCapacities(id)
Retrieve all or some selected properties from an instance of 'ResourceCapacities' with the given id.

Example

GET [Link]

GET [Link]

GET ResourceCapacities
Retrieve a collection of 'ResourceCapacities' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Id&$top=10&$skip=1

POST ResourceCapacities
Create an instance of 'ResourceCapacities' with the given payload of type 'ResourceCapacity' in JSON format.

Example

POST [Link]

{
"Action": "rcaUnknown",
"BaseEntry": null,
"BaseLineNum": null,
"BaseType": "rcbtNone",
"Capacity": 50,
"Code": "R01",
"Date": "2016-10-02",
"Id": 3,
"Memo": null,
"MemoSource": "rcmsUnknown",
"OwningEntry": null,
"OwningLineNum": null,
"OwningType": "rcotNone",
"RevertedEntry": null,
"RevertedLineNum": null,
"RevertedType": "rcrtNone",
"SourceEntry": null,
"SourceLineNum": null,
"SourceType": "rcstNone",
"Type": "rctInternal",
"Warehouse": "01"
}

[Link] Layer API [Link] 267/334

6/7/24, 15:42 Service Layer API Reference
PATCH ResourceCapacities(id)

Update an instance of 'ResourceCapacities' with the given payload of type 'ResourceCapacity' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Capacity": 15
}

DELETE ResourceCapacities(id)

Delete an instance of 'ResourceCapacities' with the specified id.

Example

DELETE [Link]

ResourceGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ResourceGroups'.

GET ResourceGroups(id)
Retrieve all or some selected properties from an instance of 'ResourceGroups' with the given id.

Example

GET [Link]

GET [Link]

GET ResourceGroups
Retrieve a collection of 'ResourceGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST ResourceGroups
Create an instance of 'ResourceGroups' with the given payload of type 'ResourceGroup' in JSON format.

Example

POST [Link]

{
"Code": 2,
"Cost1": 0,
"Cost10": 0,
"Cost2": 0,
"Cost3": 0,
"Cost4": 0,
"Cost5": 0,
"Cost6": 0,
"Cost7": 0,
"Cost8": 0,
"Cost9": 0,
"CostName1": "Ressource Standardkosten 1",
"CostName10": "Ressource Standardkosten 10",
"CostName2": "Ressource Standardkosten 2",
"CostName3": "Ressource Standardkosten 3",
"CostName4": "Ressource Standardkosten 4",
"CostName5": "Ressource Standardkosten 5",
"CostName6": "Ressource Standardkosten 6",
"CostName7": "Ressource Standardkosten 7",
[Link] Layer API [Link] 268/334
6/7/24, 15:42 Service Layer API Reference
"CostName8": "Ressource Standardkosten 8",
"CostName9": "Ressource Standardkosten 9",
"Name": "tRessourcen",
"NumOfUnitsText": null,
"Type": "rtMachine"
}

PATCH ResourceGroups(id)
Update an instance of 'ResourceGroups' with the given payload of type 'ResourceGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "tRessourcen"
}

DELETE ResourceGroups(id)
Delete an instance of 'ResourceGroups' with the specified id.

Example

DELETE [Link]

ResourceProperties
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ResourceProperties'.

GET ResourceProperties(id)

Retrieve all or some selected properties from an instance of 'ResourceProperties' with the given id.

Example

GET [Link]

GET [Link]

GET ResourceProperties

Retrieve a collection of 'ResourceProperties' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

PATCH ResourceProperties(id)

Update an instance of 'ResourceProperties' with the given payload of type 'ResourceProperty' in JSON format and with the specified id.

Example

PATCH [Link]

{}

Resources
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 269/334

6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'Resources'.

GET Resources(id)
Retrieve all or some selected properties from an instance of 'Resources' with the given id.

Example

GET [Link]

GET [Link]

GET Resources
Retrieve a collection of 'Resources' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$skip=1

POST Resources
Create an instance of 'Resources' with the given payload of type 'Resource' in JSON format.

Example

POST [Link]

{
"Active": "tYES",
"ActiveFrom": null,
"ActiveRemarks": null,
"ActiveTo": null,
"Allocation": "raOnStartDate",
"AttachmentEntry": null,
"Code": "R02",
"CodeBar": null,
"Cost1": 0,
"Cost10": 0,
"Cost2": 0,
"Cost3": 0,
"Cost4": 0,
"Cost5": 0,
"Cost6": 0,
"Cost7": 0,
"Cost8": 0,
"Cost9": 0,
"DefaultWarehouse": null,
"ForeignName": null,
"Group": 1,
"Inactive": "tNO",
"InactiveFrom": null,
"InactiveRemarks": null,
"InactiveTo": null,
"IssueMethod": "rimBackflush",
"LinkedItem": null,
"Name": null,
"Number": null,
"Picture": null,
"Property1": "tNO",
"Property10": "tNO",
"Property11": "tNO",
"Property12": "tNO",
"Property13": "tNO",
"Property14": "tNO",
"Property15": "tNO",
"Property16": "tNO",
"Property17": "tNO",
"Property18": "tNO",
"Property19": "tNO",
"Property2": "tNO",
"Property20": "tNO",
"Property21": "tNO",
"Property22": "tNO",
"Property23": "tNO",
"Property24": "tNO",
"Property25": "tNO",
"Property26": "tNO",
"Property27": "tNO",
"Property28": "tNO",
"Property29": "tNO",
"Property3": "tNO",
"Property30": "tNO",

[Link] Layer API [Link] 270/334

6/7/24, 15:42 Service Layer API Reference
"Property31": "tNO",
"Property32": "tNO",
"Property33": "tNO",
"Property34": "tNO",
"Property35": "tNO",
"Property36": "tNO",
"Property37": "tNO",
"Property38": "tNO",
"Property39": "tNO",
"Property4": "tNO",
"Property40": "tNO",
"Property41": "tNO",
"Property42": "tNO",
"Property43": "tNO",
"Property44": "tNO",
"Property45": "tNO",
"Property46": "tNO",
"Property47": "tNO",
"Property48": "tNO",
"Property49": "tNO",
"Property5": "tNO",
"Property50": "tNO",
"Property51": "tNO",
"Property52": "tNO",
"Property53": "tNO",
"Property54": "tNO",
"Property55": "tNO",
"Property56": "tNO",
"Property57": "tNO",
"Property58": "tNO",
"Property59": "tNO",
"Property6": "tNO",
"Property60": "tNO",
"Property61": "tNO",
"Property62": "tNO",
"Property63": "tNO",
"Property64": "tNO",
"Property7": "tNO",
"Property8": "tNO",
"Property9": "tNO",
"Remarks": null,
"ResourceDailyCapacities": [
{
"Code": "R02",
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,
"Remarks": "",
"Total": null,
"Weekday": "rdcwFirst"
},
{
"Code": "R02",
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,
"Remarks": "",
"Total": null,
"Weekday": "rdcwSecond"
},
{
"Code": "R02",
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,
"Remarks": "",
"Total": null,
"Weekday": "rdcwThird"
},
{
"Code": "R02",
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,
"Remarks": "",
"Total": null,
"Weekday": "rdcwFourth"
},
{
"Code": "R02",
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,
"Remarks": "",
"Total": null,
"Weekday": "rdcwFifth"
},
{
"Code": "R02",
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,

[Link] Layer API [Link] 271/334

6/7/24, 15:42 Service Layer API Reference
"Remarks": "",
"Total": null,
"Weekday": "rdcwSixth"
},
{
"Code": "R02",
"Factor1": null,
"Factor2": null,
"Factor3": null,
"Factor4": null,
"Remarks": "",
"Total": null,
"Weekday": "rdcwSeventh"
}
],
"ResourceEmployees": [],
"ResourceFixedAssets": [],
"ResourceWarehouses": [
{
"Code": "R02",
"Locked": "tNO",
"Warehouse": "01"
}
],
"Series": 37,
"TimePerUnits": null,
"Type": "rtMachine",
"UnitOfMeasure": null,
"UnitsPerTime": 1,
"VisCode": "R02"
}

PATCH Resources(id)
Update an instance of 'Resources' with the given payload of type 'Resource' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "test"
}

DELETE Resources(id)
Delete an instance of 'Resources' with the specified id.

Example

DELETE [Link]

POST Resources(id)/CreateLinkedItem
Invoke the method 'CreateLinkedItem' on this EntitySet with the specified id.

Example

POST [Link]

RetornoCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'RetornoCodes'.

GET RetornoCodes(id)

Retrieve all or some selected properties from an instance of 'RetornoCodes' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 272/334

6/7/24, 15:42 Service Layer API Reference
GET RetornoCodes

Retrieve a collection of 'RetornoCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$to

POST RetornoCodes

Create an instance of 'RetornoCodes' with the given payload of type 'RetornoCode' in JSON format.

Example

POST [Link]

{
"AbsEntry": 3,
"BankCode": "000",
"BoeStatus": "boes_Created",
"Color": 4254476,
"Description": "test",
"FileFormat": "5",
"MovementCode": 211,
"OccurenceCode": 211
}

PATCH RetornoCodes(id)

Update an instance of 'RetornoCodes' with the given payload of type 'RetornoCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"BankCode": "1000"
}

DELETE RetornoCodes(id)

Delete an instance of 'RetornoCodes' with the specified id.

Example

DELETE [Link]

ReturnRequest
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ReturnRequest'. A return is the clearing document for a delivery.

GET ReturnRequest(id)
Retrieve all or some selected properties from an instance of 'ReturnRequest' with the given id.

Example

GET [Link]

GET [Link]

GET ReturnRequest
Retrieve a collection of 'ReturnRequest' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 273/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=

POST ReturnRequest
Create an instance of 'ReturnRequest' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}

PATCH ReturnRequest(id)
Update an instance of 'ReturnRequest' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE ReturnRequest(id)
Delete an instance of 'ReturnRequest' with the specified id.

Example

DELETE [Link]

POST ReturnRequest(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST ReturnRequest(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST ReturnRequest(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST ReturnRequest(id)/SaveDraftToDocument

[Link] Layer API [Link] 274/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST [Link]

POST ReturnRequest(id)/CreateCancellationDocument

Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

Returns
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Returns'. A return is the clearing document for a delivery.

GET Returns(id)

Retrieve all or some selected properties from an instance of 'Returns' with the given id.

Example

GET [Link]

GET [Link]

GET Returns

Retrieve a collection of 'Returns' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip=1

POST Returns

Create an instance of 'Returns' with the given payload of type 'Document' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"TaxCode": "T1",
"UnitPrice": "50"
}
]
}

PATCH Returns(id)

Update an instance of 'Returns' with the given payload of type 'Document' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"

[Link] Layer API [Link] 275/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE Returns(id)
Delete an instance of 'Returns' with the specified id.

Example

DELETE [Link]

POST Returns(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

POST Returns(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST Returns(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST [Link]

POST Returns(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST [Link]

RouteStages
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'RouteStages'.

GET RouteStages(id)

Retrieve all or some selected properties from an instance of 'RouteStages' with the given id.

Example

GET [Link]

GET [Link]

GET RouteStages

Retrieve a collection of 'RouteStages' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 276/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 123 &$orderby=InternalNum

POST RouteStages
Create an instance of 'RouteStages' with the given payload of type 'RouteStage' in JSON format.

Example

POST [Link]

{}

PATCH RouteStages(id)
Update an instance of 'RouteStages' with the given payload of type 'RouteStage' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE RouteStages(id)
Delete an instance of 'RouteStages' with the specified id.

Example

DELETE [Link]

SalesForecast
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesForecast'. It represents the sales forecast for a specified period.

GET SalesForecast(id)

Retrieve all or some selected properties from an instance of 'SalesForecast' with the given id.

Example

GET [Link]

GET [Link]

GET SalesForecast

Retrieve a collection of 'SalesForecast' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby

POST SalesForecast

Create an instance of 'SalesForecast' with the given payload of type 'SalesForecast' in JSON format.

Example

POST [Link]

[Link] Layer API [Link] 277/334

6/7/24, 15:42 Service Layer API Reference
"ForecastCode": "D01",
"ForecastName": "For Daily forecast",
"SalesForecastLines": [
{
"ForecastedDay": "2014-11-29",
"ItemNo": "item01",
"Quantity": "100"
}
],
"View": "fvtDaily"
}

PATCH SalesForecast(id)
Update an instance of 'SalesForecast' with the given payload of type 'SalesForecast' in JSON format and with the specified id.

Example

PATCH [Link]

{
"ForecastName": "Daily forecast for item01"
}

DELETE SalesForecast(id)
Delete an instance of 'SalesForecast' with the specified id.

Example

DELETE [Link]

SalesOpportunities
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesOpportunities'. It represents the data of sales opportunities in SAP Business One. Sales opportunities include potential
sale volumes that may arise from business with customers and interested parties.

GET SalesOpportunities(id)

Retrieve all or some selected properties from an instance of 'SalesOpportunities' with the given id.

Example

GET [Link]

GET [Link]

GET SalesOpportunities

Retrieve a collection of 'SalesOpportunities' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Sequ

POST SalesOpportunities

Create an instance of 'SalesOpportunities' with the given payload of type 'SalesOpportunities' in JSON format.

Example

POST [Link]

{
"InventoryCountingLines": [
{
"ItemCode": "I003",
"WarehouseCode": "01"

[Link] Layer API [Link] 278/334

6/7/24, 15:42 Service Layer API Reference
}
]
}

PATCH SalesOpportunities(id)
Update an instance of 'SalesOpportunities' with the given payload of type 'SalesOpportunities' in JSON format and with the specified id.

Example

PATCH [Link]

{
"OpportunityName": "Updated Name"
}

DELETE SalesOpportunities(id)
Delete an instance of 'SalesOpportunities' with the specified id.

Example

DELETE [Link]

POST SalesOpportunities(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

SalesOpportunityCompetitorsSetup
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesOpportunityCompetitorsSetup'.

GET SalesOpportunityCompetitorsSetup(id)

Retrieve all or some selected properties from an instance of 'SalesOpportunityCompetitorsSetup' with the given id.

Example

GET [Link]

GET [Link]

GET SalesOpportunityCompetitorsSetup

Retrieve a collection of 'SalesOpportunityCompetitorsSetup' with all or some selected properties in the given order by specifying the given filter
condition.

Example

GET [Link]

GET [Link] ge 123 &$orderb

POST SalesOpportunityCompetitorsSetup

Create an instance of 'SalesOpportunityCompetitorsSetup' with the given payload of type 'SalesOpportunityCompetitorSetup' in JSON format.

Example

POST [Link]

[Link] Layer API [Link] 279/334

6/7/24, 15:42 Service Layer API Reference
"Details": "1111",
"Name": "Win012",
"SequenceNo": 2,
"ThreatLevel": "tlLow"
}

PATCH SalesOpportunityCompetitorsSetup(id)
Update an instance of 'SalesOpportunityCompetitorsSetup' with the given payload of type 'SalesOpportunityCompetitorSetup' in JSON format and with
the specified id.

Example

PATCH [Link]

{
"Details": "2222"
}

DELETE SalesOpportunityCompetitorsSetup(id)
Delete an instance of 'SalesOpportunityCompetitorsSetup' with the specified id.

Example

DELETE [Link]

SalesOpportunityInterestsSetup
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesOpportunityInterestsSetup'.

GET SalesOpportunityInterestsSetup(id)

Retrieve all or some selected properties from an instance of 'SalesOpportunityInterestsSetup' with the given id.

Example

GET [Link]

GET [Link]

GET SalesOpportunityInterestsSetup

Retrieve a collection of 'SalesOpportunityInterestsSetup' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=

POST SalesOpportunityInterestsSetup

Create an instance of 'SalesOpportunityInterestsSetup' with the given payload of type 'SalesOpportunityInterestSetup' in JSON format.

Example

POST [Link]

{
"Description": "good",
"SequenceNo": 2,
"Sort": 100
}

PATCH SalesOpportunityInterestsSetup(id)

[Link] Layer API [Link] 280/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'SalesOpportunityInterestsSetup' with the given payload of type 'SalesOpportunityInterestSetup' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"Description": "good"
}

DELETE SalesOpportunityInterestsSetup(id)

Delete an instance of 'SalesOpportunityInterestsSetup' with the specified id.

Example

DELETE [Link]

SalesOpportunityReasonsSetup
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesOpportunityReasonsSetup'.

GET SalesOpportunityReasonsSetup(id)

Retrieve all or some selected properties from an instance of 'SalesOpportunityReasonsSetup' with the given id.

Example

GET [Link]

GET [Link]

GET SalesOpportunityReasonsSetup

Retrieve a collection of 'SalesOpportunityReasonsSetup' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Se

POST SalesOpportunityReasonsSetup

Create an instance of 'SalesOpportunityReasonsSetup' with the given payload of type 'SalesOpportunityReasonSetup' in JSON format.

Example

POST [Link]

{
"Description": "2112",
"SequenceNo": 2,
"Sort": 100
}

PATCH SalesOpportunityReasonsSetup(id)

Update an instance of 'SalesOpportunityReasonsSetup' with the given payload of type 'SalesOpportunityReasonSetup' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"Sort": 10

[Link] Layer API [Link] 281/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE SalesOpportunityReasonsSetup(id)
Delete an instance of 'SalesOpportunityReasonsSetup' with the specified id.

Example

DELETE [Link]

SalesOpportunitySourcesSetup
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesOpportunitySourcesSetup'.

GET SalesOpportunitySourcesSetup(id)
Retrieve all or some selected properties from an instance of 'SalesOpportunitySourcesSetup' with the given id.

Example

GET [Link]

GET [Link]

GET SalesOpportunitySourcesSetup

Retrieve a collection of 'SalesOpportunitySourcesSetup' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Se

POST SalesOpportunitySourcesSetup

Create an instance of 'SalesOpportunitySourcesSetup' with the given payload of type 'SalesOpportunitySourceSetup' in JSON format.

Example

POST [Link]

{
"Description": "2111",
"SequenceNo": 2,
"Sort": 11
}

PATCH SalesOpportunitySourcesSetup(id)

Update an instance of 'SalesOpportunitySourcesSetup' with the given payload of type 'SalesOpportunitySourceSetup' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"Sort": 21
}

DELETE SalesOpportunitySourcesSetup(id)

Delete an instance of 'SalesOpportunitySourcesSetup' with the specified id.

Example

[Link] Layer API [Link] 282/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

SalesPersons
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesPersons'. It defines sales employees and their commission rates.

GET SalesPersons(id)
Retrieve all or some selected properties from an instance of 'SalesPersons' with the given id.

Example

GET [Link]

GET [Link]

GET SalesPersons
Retrieve a collection of 'SalesPersons' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$ord

POST SalesPersons

Create an instance of 'SalesPersons' with the given payload of type 'SalesPerson' in JSON format.

Example

POST [Link]

{
"Active": "tYES",
"Remarks": "best sales person",
"SalesEmployeeName": "Lily"
}

PATCH SalesPersons(id)

Update an instance of 'SalesPersons' with the given payload of type 'SalesPerson' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "new star"
}

DELETE SalesPersons(id)

Delete an instance of 'SalesPersons' with the specified id.

Example

DELETE [Link]

SalesStages
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 283/334

6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'SalesStages'. It defines sales stages and the probability of closing a deal indicated by each stage. For example, you enter stage
1 by identifying a customer as a lead (prospective customer); if you define the closing percentage of this stage as 5%, it means that you estimate 5 out of 100 leads
can be converted to customers who will place orders with you.

GET SalesStages(id)
Retrieve all or some selected properties from an instance of 'SalesStages' with the given id.

Example

GET [Link]

GET [Link]

GET SalesStages
Retrieve a collection of 'SalesStages' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=SequenceNo&$top=10&$ski

POST SalesStages
Create an instance of 'SalesStages' with the given payload of type 'SalesStage' in JSON format.

Example

POST [Link]

{
"ClosingPercentage": "10",
"Name": "Lead",
"Stageno": "1"
}

PATCH SalesStages(id)
Update an instance of 'SalesStages' with the given payload of type 'SalesStage' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "1st Meeting"
}

SalesTaxAuthorities
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesTaxAuthorities'. It represents the sales tax jurisdictions data for the US and Canada localizations, or sales tax types for
the Latin America localization.

GET SalesTaxAuthorities(id)

Retrieve all or some selected properties from an instance of 'SalesTaxAuthorities' with the given id.

Example

GET [Link]

GET [Link]

GET SalesTaxAuthorities

[Link] Layer API [Link] 284/334

6/7/24, 15:42 Service Layer API Reference
Retrieve a collection of 'SalesTaxAuthorities' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and Type ge

POST SalesTaxAuthorities

Create an instance of 'SalesTaxAuthorities' with the given payload of type 'SalesTaxAuthority' in JSON format.

Example

POST [Link]

{
"AOrPTaxAccount": "_SYS00000000168",
"AOrRTaxAccount": "_SYS00000000061",
"Code": "WYN",
"Name": "Wyoming new",
"TaxDefinitions": [
{
"Effectivefrom": "2000-01-01",
"Rate": "10"
}
],
"Type": "-3",
"UseTaxAccount": "_SYS00000000066"
}

PATCH SalesTaxAuthorities(id)

Update an instance of 'SalesTaxAuthorities' with the given payload of type 'SalesTaxAuthority' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "new Wyoming",
"TaxDefinitions": [
{
"Effectivefrom": "2002-01-01",
"Rate": "25"
}
]
}

DELETE SalesTaxAuthorities(id)

Delete an instance of 'SalesTaxAuthorities' with the specified id.

Example

DELETE [Link]

SalesTaxAuthoritiesTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesTaxAuthoritiesTypes'. It represents the types of sales tax authorities. It specifies whether the sales tax authority includes
VAT.

GET SalesTaxAuthoritiesTypes(id)

Retrieve all or some selected properties from an instance of 'SalesTaxAuthoritiesTypes' with the given id.

Example

GET [Link]

GET [Link]

[Link] Layer API [Link] 285/334

6/7/24, 15:42 Service Layer API Reference
GET SalesTaxAuthoritiesTypes

Retrieve a collection of 'SalesTaxAuthoritiesTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Numerator&$t

POST SalesTaxAuthoritiesTypes

Create an instance of 'SalesTaxAuthoritiesTypes' with the given payload of type 'SalesTaxAuthoritiesType' in JSON format.

Example

POST [Link]

{
"Name": "Town"
}

PATCH SalesTaxAuthoritiesTypes(id)

Update an instance of 'SalesTaxAuthoritiesTypes' with the given payload of type 'SalesTaxAuthoritiesType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Street"
}

DELETE SalesTaxAuthoritiesTypes(id)

Delete an instance of 'SalesTaxAuthoritiesTypes' with the specified id.

Example

DELETE [Link]

SalesTaxCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesTaxCodes'. It represents the inclusive sales tax codes. Each sales tax code consists of one or more sales taxes.

GET SalesTaxCodes(id)
Retrieve all or some selected properties from an instance of 'SalesTaxCodes' with the given id.

Example

GET [Link]

GET [Link]

GET SalesTaxCodes
Retrieve a collection of 'SalesTaxCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&

[Link] Layer API [Link] 286/334

6/7/24, 15:42 Service Layer API Reference
POST SalesTaxCodes

Create an instance of 'SalesTaxCodes' with the given payload of type 'SalesTaxCode' in JSON format.

Example

POST [Link]

{
"Code": "T1",
"Name": "T1",
"SalesTaxCodes_Lines": [
{
"STACode": "AL",
"STAType": "-3"
}
]
}

PATCH SalesTaxCodes(id)

Update an instance of 'SalesTaxCodes' with the given payload of type 'SalesTaxCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "UpdatedTaxName"
}

DELETE SalesTaxCodes(id)

Delete an instance of 'SalesTaxCodes' with the specified id.

Example

DELETE [Link]

SalesTaxInvoices
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SalesTaxInvoices'. It represents the data of a sales Tax Invoice document.

GET SalesTaxInvoices(id)
Retrieve all or some selected properties from an instance of 'SalesTaxInvoices' with the given id.

Example

GET [Link]

GET [Link]

GET SalesTaxInvoices
Retrieve a collection of 'SalesTaxInvoices' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$sk

POST SalesTaxInvoices
Create an instance of 'SalesTaxInvoices' with the given payload of type 'SalesTaxInvoice' in JSON format.

Example

[Link] Layer API [Link] 287/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"CardCode": "c001",
"Comments": "create purchase tax invoice",
"DocType": "botit_Invoice",
"SalesTaxInvoiceLines": [
{
"RefEntry1": "16"
}
],
"SalesTaxInvoiceOperationCodes": [
{
"OpCode": "2"
}
]
}

PATCH SalesTaxInvoices(id)
Update an instance of 'SalesTaxInvoices' with the given payload of type 'SalesTaxInvoice' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "Update sales tax invoice"
}

DELETE SalesTaxInvoices(id)
Delete an instance of 'SalesTaxInvoices' with the specified id.

Example

DELETE [Link]

Sections
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Sections'.

GET Sections(id)

Retrieve all or some selected properties from an instance of 'Sections' with the given id.

Example

GET [Link]

GET [Link]

GET Sections

Retrieve a collection of 'Sections' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=AbsEntry&$top=10&$skip=1

POST Sections

Create an instance of 'Sections' with the given payload of type 'Section' in JSON format.

Example

POST [Link]

[Link] Layer API [Link] 288/334

6/7/24, 15:42 Service Layer API Reference
{
"Code": "01",
"Description": "section 01",
"ECode": "e01"
}

PATCH Sections(id)
Update an instance of 'Sections' with the given payload of type 'Section' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Code": "001",
"Description": "updated section 01 code"
}

DELETE Sections(id)
Delete an instance of 'Sections' with the specified id.

Example

DELETE [Link]

SerialNumberDetails
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SerialNumberDetails'.

GET SerialNumberDetails(id)

Retrieve all or some selected properties from an instance of 'SerialNumberDetails' with the given id.

Example

GET [Link]

GET [Link]

GET SerialNumberDetails

Retrieve a collection of 'SerialNumberDetails' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntr

PATCH SerialNumberDetails(id)

Update an instance of 'SerialNumberDetails' with the given payload of type 'SerialNumberDetail' in JSON format and with the specified id.

Example

PATCH [Link]

{}

ServiceCallOrigins
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 289/334

6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'ServiceCallOrigins'.

GET ServiceCallOrigins(id)
Retrieve all or some selected properties from an instance of 'ServiceCallOrigins' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceCallOrigins
Retrieve a collection of 'ServiceCallOrigins' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=OriginID&$top=10&$

POST ServiceCallOrigins
Create an instance of 'ServiceCallOrigins' with the given payload of type 'ServiceCallOrigin' in JSON format.

Example

POST [Link]

{
"Description": "E-test",
"Name": "E-test"
}

PATCH ServiceCallOrigins(id)
Update an instance of 'ServiceCallOrigins' with the given payload of type 'ServiceCallOrigin' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "E-123"
}

DELETE ServiceCallOrigins(id)
Delete an instance of 'ServiceCallOrigins' with the specified id.

Example

DELETE [Link]

ServiceCallProblemSubTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceCallProblemSubTypes'.

GET ServiceCallProblemSubTypes(id)

Retrieve all or some selected properties from an instance of 'ServiceCallProblemSubTypes' with the given id.

Example

GET [Link]

[Link] Layer API [Link] 290/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET ServiceCallProblemSubTypes
Retrieve a collection of 'ServiceCallProblemSubTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$or

POST ServiceCallProblemSubTypes
Create an instance of 'ServiceCallProblemSubTypes' with the given payload of type 'ServiceCallProblemSubType' in JSON format.

Example

POST [Link]

{
"Description": "test",
"Name": "test"
}

PATCH ServiceCallProblemSubTypes(id)
Update an instance of 'ServiceCallProblemSubTypes' with the given payload of type 'ServiceCallProblemSubType' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"Description": "123"
}

DELETE ServiceCallProblemSubTypes(id)
Delete an instance of 'ServiceCallProblemSubTypes' with the specified id.

Example

DELETE [Link]

ServiceCallProblemTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceCallProblemTypes'.

GET ServiceCallProblemTypes(id)

Retrieve all or some selected properties from an instance of 'ServiceCallProblemTypes' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceCallProblemTypes

Retrieve a collection of 'ServiceCallProblemTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 291/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 1 &$orderby=Pro

POST ServiceCallProblemTypes
Create an instance of 'ServiceCallProblemTypes' with the given payload of type 'ServiceCallProblemType' in JSON format.

Example

POST [Link]

{
"Description": "test",
"Name": "test"
}

PATCH ServiceCallProblemTypes(id)
Update an instance of 'ServiceCallProblemTypes' with the given payload of type 'ServiceCallProblemType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "123"
}

DELETE ServiceCallProblemTypes(id)
Delete an instance of 'ServiceCallProblemTypes' with the specified id.

Example

DELETE [Link]

ServiceCalls
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceCalls'. It represents the service calls in the Service module. Service calls are used to manage service and support
activities that you provide to your customers.

GET ServiceCalls(id)

Retrieve all or some selected properties from an instance of 'ServiceCalls' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceCalls

Retrieve a collection of 'ServiceCalls' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=ServiceC

POST ServiceCalls

Create an instance of 'ServiceCalls' with the given payload of type 'ServiceCall' in JSON format.

[Link] Layer API [Link] 292/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"CustomerCode": "c001",
"Subject": "Subject"
}

PATCH ServiceCalls(id)

Update an instance of 'ServiceCalls' with the given payload of type 'ServiceCall' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Subject": "new subject - modified by Service Layer"
}

DELETE ServiceCalls(id)

Delete an instance of 'ServiceCalls' with the specified id.

Example

DELETE [Link]

POST ServiceCalls(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

ServiceCallSolutionStatus
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceCallSolutionStatus'.

GET ServiceCallSolutionStatus(id)
Retrieve all or some selected properties from an instance of 'ServiceCallSolutionStatus' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceCallSolutionStatus
Retrieve a collection of 'ServiceCallSolutionStatus' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=StatusId&$t

POST ServiceCallSolutionStatus
Create an instance of 'ServiceCallSolutionStatus' with the given payload of type 'ServiceCallSolutionStatus' in JSON format.

Example
[Link] Layer API [Link] 293/334
6/7/24, 15:42 Service Layer API Reference
POST [Link]

{
"Description": "Publish test",
"Name": "test"
}

PATCH ServiceCallSolutionStatus(id)
Update an instance of 'ServiceCallSolutionStatus' with the given payload of type 'ServiceCallSolutionStatus' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "Publish 123"
}

DELETE ServiceCallSolutionStatus(id)
Delete an instance of 'ServiceCallSolutionStatus' with the specified id.

Example

DELETE [Link]

ServiceCallStatus
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceCallStatus'.

GET ServiceCallStatus(id)

Retrieve all or some selected properties from an instance of 'ServiceCallStatus' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceCallStatus

Retrieve a collection of 'ServiceCallStatus' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=StatusId&$top=10&$s

POST ServiceCallStatus

Create an instance of 'ServiceCallStatus' with the given payload of type 'ServiceCallStatus' in JSON format.

Example

POST [Link]

{
"Description": "test",
"Name": "test"
}

PATCH ServiceCallStatus(id)

Update an instance of 'ServiceCallStatus' with the given payload of type 'ServiceCallStatus' in JSON format and with the specified id.

[Link] Layer API [Link] 294/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"Description": "123"
}

DELETE ServiceCallStatus(id)

Delete an instance of 'ServiceCallStatus' with the specified id.

Example

DELETE [Link]

ServiceCallTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceCallTypes'.

GET ServiceCallTypes(id)
Retrieve all or some selected properties from an instance of 'ServiceCallTypes' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceCallTypes
Retrieve a collection of 'ServiceCallTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=CallTypeID&$top=

POST ServiceCallTypes
Create an instance of 'ServiceCallTypes' with the given payload of type 'ServiceCallType' in JSON format.

Example

POST [Link]

{
"Description": "test",
"Name": "test"
}

PATCH ServiceCallTypes(id)
Update an instance of 'ServiceCallTypes' with the given payload of type 'ServiceCallType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test123"
}

DELETE ServiceCallTypes(id)

[Link] Layer API [Link] 295/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'ServiceCallTypes' with the specified id.

Example

DELETE [Link]

ServiceContracts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceContracts'. It represents the service contracts table in the Service module of the SAP Business One application. This
object enables you to do the following: Add a service contract; retrieve a service contract by its key; update a service contract; remove a service contract.

GET ServiceContracts(id)

Retrieve all or some selected properties from an instance of 'ServiceContracts' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceContracts

Retrieve a collection of 'ServiceContracts' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Contr

POST ServiceContracts

Create an instance of 'ServiceContracts' with the given payload of type 'ServiceContract' in JSON format.

Example

POST [Link]

{
"CustomerCode": "C60000",
"EndDate": "2014-12-09",
"Remarks": "Add service Contract",
"ServiceContract_Lines": [
{
"InternalSerialNum": "A6-000005",
"ItemCode": "S10000",
"ManufacturerSerialNum": "S1-000166"
}
]
}

PATCH ServiceContracts(id)

Update an instance of 'ServiceContracts' with the given payload of type 'ServiceContract' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "Silver Warranty Contract"
}

DELETE ServiceContracts(id)

Delete an instance of 'ServiceContracts' with the specified id.

Example

[Link] Layer API [Link] 296/334

6/7/24, 15:42 Service Layer API Reference
DELETE [Link]

POST ServiceContracts(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST ServiceContracts(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

ServiceGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ServiceGroups'.

GET ServiceGroups(id)

Retrieve all or some selected properties from an instance of 'ServiceGroups' with the given id.

Example

GET [Link]

GET [Link]

GET ServiceGroups

Retrieve a collection of 'ServiceGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=AbsEntry&$t

POST ServiceGroups

Create an instance of 'ServiceGroups' with the given payload of type 'ServiceGroup' in JSON format.

Example

POST [Link]

{
"Description": "001",
"ServiceGroupCode": "99"
}

PATCH ServiceGroups(id)

Update an instance of 'ServiceGroups' with the given payload of type 'ServiceGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test"

[Link] Layer API [Link] 297/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE ServiceGroups(id)
Delete an instance of 'ServiceGroups' with the specified id.

Example

DELETE [Link]

ShippingTypes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ShippingTypes'. It defines transportation methods (for example, air cargo and courier) of goods.

GET ShippingTypes(id)
Retrieve all or some selected properties from an instance of 'ShippingTypes' with the given id.

Example

GET [Link]

GET [Link]

GET ShippingTypes

Retrieve a collection of 'ShippingTypes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST ShippingTypes

Create an instance of 'ShippingTypes' with the given payload of type 'ShippingType' in JSON format.

Example

POST [Link]

{
"Name": "UPS Ground",
"Website": "[Link]
}

PATCH ShippingTypes(id)

Update an instance of 'ShippingTypes' with the given payload of type 'ShippingType' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Website": "[Link]
}

DELETE ShippingTypes(id)

Delete an instance of 'ShippingTypes' with the specified id.

Example

DELETE [Link]

[Link] Layer API [Link] 298/334

6/7/24, 15:42 Service Layer API Reference

SpecialPrices
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'SpecialPrices'. It represents a discount for a specific item in a specific price list. The discount can apply to a specific business
partner or for all business partners. For a specific business partner, the item and business partner must be unique; for all business partners, the item and price list
must be unique.

GET SpecialPrices(id)
Retrieve all or some selected properties from an instance of 'SpecialPrices' with the given id.

Example

GET [Link]

GET [Link]

GET SpecialPrices
Retrieve a collection of 'SpecialPrices' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and startswith(ItemCode

POST SpecialPrices

Create an instance of 'SpecialPrices' with the given payload of type 'SpecialPrice' in JSON format.

Example

POST [Link]

{
"CardCode": "c001",
"DiscountPercent": 10,
"ItemCode": "i001"
}

PATCH SpecialPrices(id)

Update an instance of 'SpecialPrices' with the given payload of type 'SpecialPrice' in JSON format and with the specified id.

Example

PATCH [Link]

{
"DiscountPercent": 20
}

DELETE SpecialPrices(id)

Delete an instance of 'SpecialPrices' with the specified id.

Example

DELETE [Link]

States
Show/Hide
List Operations
Expand Operations

[Link] Layer API [Link] 299/334

6/7/24, 15:42 Service Layer API Reference
This entity enables you to manipulate 'States'.

GET States(id)
Retrieve all or some selected properties from an instance of 'States' with the given id.

Example

GET [Link]

GET [Link]

GET States
Retrieve a collection of 'States' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and startswith(Code, 'a') &$orderby=C

POST States
Create an instance of 'States' with the given payload of type 'State' in JSON format.

Example

POST [Link]

{
"Code": "AK1",
"Country": "US",
"Name": "Alaska1"
}

PATCH States(id)
Update an instance of 'States' with the given payload of type 'State' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "Alaska"
}

DELETE States(id)
Delete an instance of 'States' with the specified id.

Example

DELETE [Link]

StockTakings
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'StockTakings'.

GET StockTakings(id)

Retrieve all or some selected properties from an instance of 'StockTakings' with the given id.

Example

GET [Link]

[Link] Layer API [Link] 300/334

6/7/24, 15:42 Service Layer API Reference

GET [Link]

GET StockTakings
Retrieve a collection of 'StockTakings' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and startswith(Wa

POST StockTakings
Create an instance of 'StockTakings' with the given payload of type 'StockTaking' in JSON format.

Example

POST [Link]

{
"Counted": 0,
"ItemCode": "item001",
"WarehouseCode": "01"
}

PATCH StockTakings(id)
Update an instance of 'StockTakings' with the given payload of type 'StockTaking' in JSON format and with the specified id.

Example

PATCH [Link]

{}

DELETE StockTakings(id)
Delete an instance of 'StockTakings' with the specified id.

Example

DELETE [Link]

StockTransferDrafts
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'StockTransferDrafts'.

GET StockTransferDrafts(id)

Retrieve all or some selected properties from an instance of 'StockTransferDrafts' with the given id.

Example

GET [Link]

GET [Link]

GET StockTransferDrafts

Retrieve a collection of 'StockTransferDrafts' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 301/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&

POST StockTransferDrafts
Create an instance of 'StockTransferDrafts' with the given payload of type 'StockTransfer' in JSON format.

Example

POST [Link]

{
"StockTransferLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"UnitPrice": "30",
"WarehouseCode": "w001"
}
]
}

POST [Link]

{
"Comments": "Test123",
"DocObjectCode": "67",
"StockTransferLines": [
{
"ItemCode": "A00001",
"Quantity": 10,
"StockTransferLinesBinAllocations": [
{
"BaseLineNumber": 0,
"BinAbsEntry": 1,
"BinActionType": "batFromWarehouse",
"Quantity": 10
},
{
"BaseLineNumber": 0,
"BinAbsEntry": 76,
"BinActionType": "batToWarehouse",
"Quantity": 7
},
{
"BaseLineNumber": 0,
"BinAbsEntry": 75,
"BinActionType": "batToWarehouse",
"Quantity": 3
}
]
}
]
}

PATCH StockTransferDrafts(id)
Update an instance of 'StockTransferDrafts' with the given payload of type 'StockTransfer' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

POST StockTransferDrafts(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST StockTransferDrafts(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

[Link] Layer API [Link] 302/334

6/7/24, 15:42 Service Layer API Reference
POST [Link]

POST StockTransferDrafts(id)/SaveDraftToDocument
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST [Link]

StockTransfers
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'StockTransfers'. It represents transfer records of items from one warehouse to another.

GET StockTransfers(id)
Retrieve all or some selected properties from an instance of 'StockTransfers' with the given id.

Example

GET [Link]

GET [Link]

GET StockTransfers

Retrieve a collection of 'StockTransfers' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$skip

POST StockTransfers

Create an instance of 'StockTransfers' with the given payload of type 'StockTransfer' in JSON format.

Example

POST [Link]

{
"StockTransferLines": [
{
"ItemCode": "i001",
"Quantity": "100",
"UnitPrice": "30",
"WarehouseCode": "w001"
}
]
}

PATCH StockTransfers(id)

Update an instance of 'StockTransfers' with the given payload of type 'StockTransfer' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Comments": "new comments - modified by Service Layer"
}

DELETE StockTransfers(id)

[Link] Layer API [Link] 303/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'StockTransfers' with the specified id.

Example

DELETE [Link]

POST StockTransfers(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST StockTransfers(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

TargetGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TargetGroups'.

GET TargetGroups(id)

Retrieve all or some selected properties from an instance of 'TargetGroups' with the given id.

Example

GET [Link]

GET [Link]

GET TargetGroups

Retrieve a collection of 'TargetGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link]

POST TargetGroups

Create an instance of 'TargetGroups' with the given payload of type 'TargetGroup' in JSON format.

Example

POST [Link]

{
"TargetGroupCode": "1",
"TargetGroupName": "1",
"TargetGroupType": "tgtCustomer",
"TargetGroupsDetails": []
}

PATCH TargetGroups(id)

Update an instance of 'TargetGroups' with the given payload of type 'TargetGroup' in JSON format and with the specified id.

[Link] Layer API [Link] 304/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"TargetGroupName": "21"
}

DELETE TargetGroups(id)

Delete an instance of 'TargetGroups' with the specified id.

Example

DELETE [Link]

TaxCodeDeterminations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TaxCodeDeterminations'.

GET TaxCodeDeterminations(id)
Retrieve all or some selected properties from an instance of 'TaxCodeDeterminations' with the given id.

Example

GET [Link]

GET [Link]

GET TaxCodeDeterminations
Retrieve a collection of 'TaxCodeDeterminations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=DocEntry

POST TaxCodeDeterminations
Create an instance of 'TaxCodeDeterminations' with the given payload of type 'TaxCodeDetermination' in JSON format.

Example

POST [Link]

{
"BusinessArea": "baSales",
"Condition1": "tcdcShipToCity",
"Description": "test11",
"DocumentType": "tcddtItem",
"FreightHeaderTax": "A1",
"FreightRowTax": "A10",
"NumberValue1": 0,
"TaxCode": "A10"
}

PATCH TaxCodeDeterminations(id)
Update an instance of 'TaxCodeDeterminations' with the given payload of type 'TaxCodeDetermination' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "123"

[Link] Layer API [Link] 305/334

6/7/24, 15:42 Service Layer API Reference
}

DELETE TaxCodeDeterminations(id)
Delete an instance of 'TaxCodeDeterminations' with the specified id.

Example

DELETE [Link]

TaxCodeDeterminationsTCD
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TaxCodeDeterminationsTCD'.

GET TaxCodeDeterminationsTCD(id)
Retrieve all or some selected properties from an instance of 'TaxCodeDeterminationsTCD' with the given id.

Example

GET [Link]

GET [Link]

GET TaxCodeDeterminationsTCD

Retrieve a collection of 'TaxCodeDeterminationsTCD' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 4 &$orderby=AbsId&$top=10&$sk

PATCH TaxCodeDeterminationsTCD(id)

Update an instance of 'TaxCodeDeterminationsTCD' with the given payload of type 'TaxCodeDeterminationTCD' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"DftApCode": null,
"DftArCode": null,
"TaxCodeDeterminationTCDByUsages": [],
"TaxCodeDeterminationTCDDefaultWTs": [],
"TaxCodeDeterminationTCDKeyFields": [
{
"AbsId": 2,
"Descr": "",
"KeyFld_1": 1,
"KeyFld_2": 0,
"KeyFld_3": 0,
"KeyFld_4": 0,
"Priority": 1,
"TaxCodeDeterminationTCDKeyFieldValues": [],
"UDFAlias_1": null,
"UDFAlias_2": null,
"UDFAlias_3": null,
"UDFAlias_4": null,
"UDFTable_1": null,
"UDFTable_2": null,
"UDFTable_3": null,
"UDFTable_4": null
}
],
"TcdType": "tcdtWithholdingTax"
}

[Link] Layer API [Link] 306/334

6/7/24, 15:42 Service Layer API Reference

TaxInvoiceReport
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TaxInvoiceReport'.

GET TaxInvoiceReport(id)
Retrieve all or some selected properties from an instance of 'TaxInvoiceReport' with the given id.

Example

GET [Link]

GET [Link]

GET TaxInvoiceReport
Retrieve a collection of 'TaxInvoiceReport' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '016

PATCH TaxInvoiceReport(id)
Update an instance of 'TaxInvoiceReport' with the given payload of type 'TaxInvoiceReport' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "test"
}

POST TaxInvoiceReport(id)/CancelTaxInvoiceReport
Invoke the method 'CancelTaxInvoiceReport' on this EntitySet with the specified id.

Example

POST [Link]

TaxWebSites
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TaxWebSites'.

GET TaxWebSites(id)

Retrieve all or some selected properties from an instance of 'TaxWebSites' with the given id.

Example

GET [Link]

GET [Link]

GET TaxWebSites

Retrieve a collection of 'TaxWebSites' with all or some selected properties in the given order by specifying the given filter condition.

[Link] Layer API [Link] 307/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link] ge 1 &$orderby=AbsEntry&$top=10&$s

POST TaxWebSites

Create an instance of 'TaxWebSites' with the given payload of type 'TaxWebSite' in JSON format.

Example

POST [Link]

{
"Description": "test",
"WebSiteName": "test",
"WebSiteURL": "test"
}

PATCH TaxWebSites(id)

Update an instance of 'TaxWebSites' with the given payload of type 'TaxWebSite' in JSON format and with the specified id.

Example

PATCH [Link]

{
"WebSiteName": "test123"
}

DELETE TaxWebSites(id)

Delete an instance of 'TaxWebSites' with the specified id.

Example

DELETE [Link]

POST TaxWebSites(id)/SetAsDefault

Invoke the method 'SetAsDefault' on this EntitySet with the specified id.

Example

POST [Link]

Teams
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Teams'. It represents the list of teams from which team memberships of an employee can be selected. An employee can be a
Member or a Leader of more than one team.

GET Teams(id)
Retrieve all or some selected properties from an instance of 'Teams' with the given id.

Example

GET [Link]

GET [Link]

GET Teams
Retrieve a collection of 'Teams' with all or some selected properties in the given order by specifying the given filter condition.

[Link] Layer API [Link] 308/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link] ge 123 &$orderby=TeamID&$top=10&$skip=1

POST Teams

Create an instance of 'Teams' with the given payload of type 'Team' in JSON format.

Example

POST [Link]

{
"Description": "Testing Team",
"TeamMembers": [
{
"EmployeeID": "20",
"RoleInTeam": "borit_Leader"
}
],
"TeamName": "ACE"
}

PATCH Teams(id)

Update an instance of 'Teams' with the given payload of type 'Team' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "Code Refactor",
"TeamMembers": [
{
"RoleInTeam": "borit_Leader"
}
],
"TeamName": "Refactor"
}

TerminationReason
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TerminationReason'.

GET TerminationReason(id)
Retrieve all or some selected properties from an instance of 'TerminationReason' with the given id.

Example

GET [Link]

GET [Link]

GET TerminationReason
Retrieve a collection of 'TerminationReason' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 1 &$orderby=ReasonID&$top=10&$s

POST TerminationReason
Create an instance of 'TerminationReason' with the given payload of type 'TerminationReason' in JSON format.
[Link] Layer API [Link] 309/334
6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"Name": "reason 01"
}

PATCH TerminationReason(id)

Update an instance of 'TerminationReason' with the given payload of type 'TerminationReason' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "Add description"
}

DELETE TerminationReason(id)

Delete an instance of 'TerminationReason' with the specified id.

Example

DELETE [Link]

Territories
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Territories'. It represents the territory segmentation.

GET Territories(id)
Retrieve all or some selected properties from an instance of 'Territories' with the given id.

Example

GET [Link]

GET [Link]

GET Territories
Retrieve a collection of 'Territories' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Territor

POST Territories
Create an instance of 'Territories' with the given payload of type 'Territory' in JSON format.

Example

POST [Link]

{
"Description": "NorthChina",
"Parent": "-1"
}

PATCH Territories(id)

[Link] Layer API [Link] 310/334

6/7/24, 15:42 Service Layer API Reference
Update an instance of 'Territories' with the given payload of type 'Territory' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "EastChina"
}

DELETE Territories(id)

Delete an instance of 'Territories' with the specified id.

Example

DELETE [Link]

TrackingNotes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TrackingNotes'.

GET TrackingNotes(id)

Retrieve all or some selected properties from an instance of 'TrackingNotes' with the given id.

Example

GET [Link]

GET [Link]

GET TrackingNotes

Retrieve a collection of 'TrackingNotes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 2 &$orderby=Track

POST TrackingNotes

Create an instance of 'TrackingNotes' with the given payload of type 'TrackingNote' in JSON format.

Example

POST [Link]

{
"CCDNumber": "18/2018/18",
"CountryOfOrigin": "XX",
"Date": "2016-08-31",
"TrackingNoteItemCollection": [
{
"ItemCCDNumber": 1,
"ItemCode": "I01",
"Quantity": "100"
}
]
}

PATCH TrackingNotes(id)

Update an instance of 'TrackingNotes' with the given payload of type 'TrackingNote' in JSON format and with the specified id.

Example

[Link] Layer API [Link] 311/334

6/7/24, 15:42 Service Layer API Reference
PATCH [Link]

{
"CountryOfOrigin": "AU",
"TrackingNoteBrokerCollection": [
{
"AgreementNumber": "2",
"BPCode": "C01"
}
]
}

DELETE TrackingNotes(id)
Delete an instance of 'TrackingNotes' with the specified id.

Example

DELETE [Link]

TransactionCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TransactionCodes'.

GET TransactionCodes(id)
Retrieve all or some selected properties from an instance of 'TransactionCodes' with the given id.

Example

GET [Link]

GET [Link]

GET TransactionCodes

Retrieve a collection of 'TransactionCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '') &$orderby=Code&$top=10&$skip=1

POST TransactionCodes

Create an instance of 'TransactionCodes' with the given payload of type 'TransactionCode' in JSON format.

Example

POST [Link]

{
"Code": "01"
}

PATCH TransactionCodes(id)

Update an instance of 'TransactionCodes' with the given payload of type 'TransactionCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "description of 01"
}

DELETE TransactionCodes(id)
[Link] Layer API [Link] 312/334
6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'TransactionCodes' with the specified id.

Example

DELETE [Link]

TransportationDocuments
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'TransportationDocuments'.

GET TransportationDocuments(id)

Retrieve all or some selected properties from an instance of 'TransportationDocuments' with the given id.

Example

GET [Link]

GET [Link]

GET TransportationDocuments

Retrieve a collection of 'TransportationDocuments' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$or

POST TransportationDocuments

Create an instance of 'TransportationDocuments' with the given payload of type 'TransportationDocumentData' in JSON format.

Example

POST [Link]

{
"AttachmentEntry": null,
"Canceled": "tNO",
"CarrierCode": "V01",
"ElDocExportFormat": null,
"ElDocGenType": "edgt_NotRelevant",
"ExpirationDate": null,
"IssueGate": 0,
"PostDate": "2018-01-30",
"TrailerID": null,
"TransportationDocumentLineDataCollection": [
{
"DocLineNumber": 0,
"DocNumber": 4,
"DocOrderNum": null,
"DocType": "dc_Delivery",
"ItemCode": "I01",
"TransportedQuantity": 1.0
}
],
"TransportationNumber": null,
"VehicleID": null,
"WarehouseCode": "01"
}

PATCH TransportationDocuments(id)

Update an instance of 'TransportationDocuments' with the given payload of type 'TransportationDocumentData' in JSON format and with the specified
id.

Example

PATCH [Link]

[Link] Layer API [Link] 313/334

6/7/24, 15:42 Service Layer API Reference
{
"VehicleID": "1234"
}

POST TransportationDocuments(id)/CancelTransportationDocument
Invoke the method 'CancelTransportationDocument' on this EntitySet with the specified id.

Example

POST [Link]

UnitOfMeasurementGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UnitOfMeasurementGroups'.

GET UnitOfMeasurementGroups(id)
Retrieve all or some selected properties from an instance of 'UnitOfMeasurementGroups' with the given id.

Example

GET [Link]

GET [Link]

GET UnitOfMeasurementGroups

Retrieve a collection of 'UnitOfMeasurementGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$

POST UnitOfMeasurementGroups

Create an instance of 'UnitOfMeasurementGroups' with the given payload of type 'UnitOfMeasurementGroup' in JSON format.

Example

POST [Link]

{
"AbsEntry": 2,
"BaseUoM": 1,
"Code": "F1",
"Name": "F1",
"UoMGroupDefinitionCollection": [
{
"AlternateQuantity": 1,
"AlternateUoM": 1,
"BaseQuantity": 1,
"UdfFactor": -1,
"WeightFactor": 0
}
]
}

PATCH UnitOfMeasurementGroups(id)

Update an instance of 'UnitOfMeasurementGroups' with the given payload of type 'UnitOfMeasurementGroup' in JSON format and with the specified
id.

Example

PATCH [Link]

[Link] Layer API [Link] 314/334

6/7/24, 15:42 Service Layer API Reference
"Name": "F1"
}

DELETE UnitOfMeasurementGroups(id)
Delete an instance of 'UnitOfMeasurementGroups' with the specified id.

Example

DELETE [Link]

UnitOfMeasurements
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UnitOfMeasurements'.

GET UnitOfMeasurements(id)
Retrieve all or some selected properties from an instance of 'UnitOfMeasurements' with the given id.

Example

GET [Link]

GET [Link]

GET UnitOfMeasurements

Retrieve a collection of 'UnitOfMeasurements' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=10&$skip=

POST UnitOfMeasurements

Create an instance of 'UnitOfMeasurements' with the given payload of type 'UnitOfMeasurement' in JSON format.

Example

POST [Link]

{
"AbsEntry": 2,
"Code": "Carton",
"Height1": 300,
"Height1Unit": 50,
"Height2": 0,
"Height2Unit": null,
"InternationalSymbol": null,
"Length1": 100,
"Length1Unit": 50,
"Length2": 0,
"Length2Unit": null,
"Name": "Carton",
"Volume": 6000000,
"VolumeUnit": 5,
"Weight1": 0,
"Weight1Unit": null,
"Weight2": 0,
"Weight2Unit": null,
"Width1": 200,
"Width1Unit": 50,
"Width2": 0,
"Width2Unit": null
}

PATCH UnitOfMeasurements(id)

Update an instance of 'UnitOfMeasurements' with the given payload of type 'UnitOfMeasurement' in JSON format and with the specified id.

[Link] Layer API [Link] 315/334

6/7/24, 15:42 Service Layer API Reference
Example

PATCH [Link]

{
"AbsEntry": 2,
"Code": "Carton001",
"Length1": 100,
"Name": "Carton001"
}

DELETE UnitOfMeasurements(id)

Delete an instance of 'UnitOfMeasurements' with the specified id.

Example

DELETE [Link]

UserDefaultGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserDefaultGroups'. It defines default values (such as, default documents, default address in printed documents, windows
color, and so on).

GET UserDefaultGroups(id)
Retrieve all or some selected properties from an instance of 'UserDefaultGroups' with the given id.

Example

GET [Link]

GET [Link]

GET UserDefaultGroups
Retrieve a collection of 'UserDefaultGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$ski

POST UserDefaultGroups
Create an instance of 'UserDefaultGroups' with the given payload of type 'UserDefaultGroup' in JSON format.

Example

POST [Link]

{
"Address": "No. 1001 Chenhui road Shanghai",
"Code": "UD01",
"Name": "User Default",
"PrintReceipt": "boprcAlways",
"UseTax": "tYES"
}

PATCH UserDefaultGroups(id)
Update an instance of 'UserDefaultGroups' with the given payload of type 'UserDefaultGroup' in JSON format and with the specified id.

Example

PATCH [Link]

[Link] Layer API [Link] 316/334

6/7/24, 15:42 Service Layer API Reference
"Name": "Default User"
}

DELETE UserDefaultGroups(id)
Delete an instance of 'UserDefaultGroups' with the specified id.

Example

DELETE [Link]

UserFieldsMD
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserFieldsMD' and manage user-defined fields in user and system tables.

GET UserFieldsMD(id)
Retrieve all or some selected properties from an instance of 'UserFieldsMD' with the given id.

Example

GET [Link]

GET [Link]

GET UserFieldsMD

Retrieve a collection of 'UserFieldsMD' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and FieldID ge 0 &$orderby=Table

POST UserFieldsMD

Create an instance of 'UserFieldsMD' with the given payload of type 'UserFieldMD' in JSON format.

Example

POST [Link]

{
"Description": "UDF01",
"Name": "UDF01",
"SubType": "st_Address",
"TableName": "@UDT01",
"Type": "db_Alpha"
}

PATCH UserFieldsMD(id)

Update an instance of 'UserFieldsMD' with the given payload of type 'UserFieldMD' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "new UDF01",
"FieldID": 0,
"TableName": "@UDT01"
}

DELETE UserFieldsMD(id)

Delete an instance of 'UserFieldsMD' with the specified id.

[Link] Layer API [Link] 317/334

6/7/24, 15:42 Service Layer API Reference
Example

DELETE [Link]

UserKeysMD
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserKeysMD' and manage secondary keys to user tables.

GET UserKeysMD(id)

Retrieve all or some selected properties from an instance of 'UserKeysMD' with the given id.

Example

GET [Link]

GET [Link]

GET UserKeysMD
Retrieve a collection of 'UserKeysMD' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') and KeyIndex ge 0 &$or

POST UserKeysMD
Create an instance of 'UserKeysMD' with the given payload of type 'UserKeysMD' in JSON format.

Example

POST [Link]

{
"KeyName": "uk01",
"TableName": "OHEM",
"Unique": "tNO",
"UserKeysMD_Elements": [
{
"ColumnAlias": "UDF01"
}
]
}

DELETE UserKeysMD(id)
Delete an instance of 'UserKeysMD' with the specified id.

Example

DELETE [Link]

UserLanguages
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserLanguages'. It defines user languages for multi-language support.

GET UserLanguages(id)

Retrieve all or some selected properties from an instance of 'UserLanguages' with the given id.

[Link] Layer API [Link] 318/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET UserLanguages

Retrieve a collection of 'UserLanguages' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=1

POST UserLanguages

Create an instance of 'UserLanguages' with the given payload of type 'UserLanguage' in JSON format.

Example

POST [Link]

{
"LanguageFullName": "Chinese",
"LanguageShortName": "TWC",
"RelatedSystemLanguage": "35"
}

PATCH UserLanguages(id)

Update an instance of 'UserLanguages' with the given payload of type 'UserLanguage' in JSON format and with the specified id.

Example

PATCH [Link]

{
"LanguageFullName": "Traditional Chinese"
}

DELETE UserLanguages(id)

Delete an instance of 'UserLanguages' with the specified id.

Example

DELETE [Link]

UserObjectsMD
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserObjectsMD'. It represents the registration data settings, such as table name and supported services, of a user-defined
object.

GET UserObjectsMD(id)
Retrieve all or some selected properties from an instance of 'UserObjectsMD' with the given id.

Example

GET [Link]

GET [Link]

GET UserObjectsMD
[Link] Layer API [Link] 319/334
6/7/24, 15:42 Service Layer API Reference
Retrieve a collection of 'UserObjectsMD' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&

POST UserObjectsMD

Create an instance of 'UserObjectsMD' with the given payload of type 'UserObjectsMD' in JSON format.

Example

POST [Link]

{
"Code": "UDO5353",
"Name": "UDOTest",
"TableName": "UDT01",
"UserObjectMD_ChildTables": [
{
"ObjectName": "UDO Child",
"SonNumber": "1",
"TableName": "UDT02"
}
]
}

PATCH UserObjectsMD(id)

Update an instance of 'UserObjectsMD' with the given payload of type 'UserObjectsMD' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "NewUDOTest"
}

DELETE UserObjectsMD(id)

Delete an instance of 'UserObjectsMD' with the specified id.

Example

DELETE [Link]

UserPermissionTree
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserPermissionTree'. It represents the User Authorization form. This object enables managing user authorization for various
forms.

GET UserPermissionTree(id)

Retrieve all or some selected properties from an instance of 'UserPermissionTree' with the given id.

Example

GET [Link]

GET [Link]

GET UserPermissionTree

Retrieve a collection of 'UserPermissionTree' with all or some selected properties in the given order by specifying the given filter condition.

Example

[Link] Layer API [Link] 320/334

6/7/24, 15:42 Service Layer API Reference
GET [Link]

GET [Link] 'a'

POST UserPermissionTree
Create an instance of 'UserPermissionTree' with the given payload of type 'UserPermissionTree' in JSON format.

Example

POST [Link]

{
"Name": "newPer",
"PermissionID": "P01"
}

PATCH UserPermissionTree(id)
Update an instance of 'UserPermissionTree' with the given payload of type 'UserPermissionTree' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "newFormPer"
}

DELETE UserPermissionTree(id)
Delete an instance of 'UserPermissionTree' with the specified id.

Example

DELETE [Link]

UserQueries
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserQueries'.

GET UserQueries(id)

Retrieve all or some selected properties from an instance of 'UserQueries' with the given id.

Example

GET [Link]

GET [Link]

GET UserQueries

Retrieve a collection of 'UserQueries' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 and QueryCate

POST UserQueries

Create an instance of 'UserQueries' with the given payload of type 'UserQuery' in JSON format.

[Link] Layer API [Link] 321/334

6/7/24, 15:42 Service Layer API Reference
Example

POST [Link]

{
"Query": "SELECT T0. CardCode FROM OCRD T0",
"QueryCategory": "-1",
"QueryDescription": "QueryOCRD"
}

PATCH UserQueries(id)

Update an instance of 'UserQueries' with the given payload of type 'UserQuery' in JSON format and with the specified id.

Example

PATCH [Link]

{
"QueryDescription": "Select OCRD"
}

DELETE UserQueries(id)

Delete an instance of 'UserQueries' with the specified id.

Example

DELETE [Link]

Users
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Users'. It represents the users table of the SAP Business One application. The users table includes the users list, login details,
and authorizations.

GET Users(id)
Retrieve all or some selected properties from an instance of 'Users' with the given id.

Example

GET [Link]

GET [Link]

GET Users
Retrieve a collection of 'Users' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=InternalKey&$top=1

POST Users
Create an instance of 'Users' with the given payload of type 'User' in JSON format.

Example

POST [Link]

{
"UserCode": "u001",
"UserName": "User1",
"UserPassword": "default"
}

[Link] Layer API [Link] 322/334

6/7/24, 15:42 Service Layer API Reference
PATCH Users(id)

Update an instance of 'Users' with the given payload of type 'User' in JSON format and with the specified id.

Example

PATCH [Link]

{
"UserName": "Updated User Name"
}

DELETE Users(id)

Delete an instance of 'Users' with the specified id.

Example

DELETE [Link]

POST Users(id)/Close

Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST [Link]

UserTablesMD
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'UserTablesMD'.

GET UserTablesMD(id)
Retrieve all or some selected properties from an instance of 'UserTablesMD' with the given id.

Example

GET [Link]

GET [Link]

GET UserTablesMD
Retrieve a collection of 'UserTablesMD' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=

POST UserTablesMD
Create an instance of 'UserTablesMD' with the given payload of type 'UserTablesMD' in JSON format.

Example

POST [Link]

{
"TableDescription": "NewUDT",
"TableName": "UDT01",
"TableType": "bott_NoObject"
}

[Link] Layer API [Link] 323/334

6/7/24, 15:42 Service Layer API Reference
PATCH UserTablesMD(id)

Update an instance of 'UserTablesMD' with the given payload of type 'UserTablesMD' in JSON format and with the specified id.

Example

PATCH [Link]

{
"TableDescription": "UpdateUDT01"
}

DELETE UserTablesMD(id)

Delete an instance of 'UserTablesMD' with the specified id.

Example

DELETE [Link]

ValueMapping
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ValueMapping'.

GET ValueMapping(id)
Retrieve all or some selected properties from an instance of 'ValueMapping' with the given id.

Example

GET [Link]

GET [Link]

GET ValueMapping
Retrieve a collection of 'ValueMapping' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=AbsEntry&$top=1

POST ValueMapping
Create an instance of 'ValueMapping' with the given payload of type 'VM_B1ValuesData' in JSON format.

Example

POST [Link]

{
"ObjectAbsEntry": "USD",
"ObjectId": 37,
"VM_ThirdPartyValuesCollection": [
{
"ThirdPartySystemId": 1,
"ThirdPartyValue": "USD"
}
]
}

PATCH ValueMapping(id)
Update an instance of 'ValueMapping' with the given payload of type 'VM_B1ValuesData' in JSON format and with the specified id.

Example

[Link] Layer API [Link] 324/334

6/7/24, 15:42 Service Layer API Reference
PATCH [Link]

{
"ObjectAbsEntry": "NOK",
"ObjectId": 37,
"VM_ThirdPartyValuesCollection": [
{
"ThirdPartySystemId": 1,
"ThirdPartyValue": "AFN"
}
]
}

DELETE ValueMapping(id)
Delete an instance of 'ValueMapping' with the specified id.

Example

DELETE [Link]

ValueMappingCommunication
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'ValueMappingCommunication'.

GET ValueMappingCommunication(id)
Retrieve all or some selected properties from an instance of 'ValueMappingCommunication' with the given id.

Example

GET [Link]

GET [Link]

GET ValueMappingCommunication

Retrieve a collection of 'ValueMappingCommunication' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderb

POST ValueMappingCommunication

Create an instance of 'ValueMappingCommunication' with the given payload of type 'ValueMappingCommunicationData' in JSON format.

Example

POST [Link]

{
"CommunicationType": "MD",
"ObjectId": 37,
"ThirdPartySystemId": 1
}

PATCH ValueMappingCommunication(id)

Update an instance of 'ValueMappingCommunication' with the given payload of type 'ValueMappingCommunicationData' in JSON format and with the
specified id.

Example

PATCH [Link]

{
"CommunicationType": "vmct_MasterData",

[Link] Layer API [Link] 325/334

6/7/24, 15:42 Service Layer API Reference
"EndTime": 165050,
"ObjectId": 37,
"StartDate": "2017-12-19",
"StartTime": 160244,
"ThirdPartySystemId": 1
}

VatGroups
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'VatGroups'. It defines tax groups that can be assigned to business partners and items in sales and purchase documents.

GET VatGroups(id)
Retrieve all or some selected properties from an instance of 'VatGroups' with the given id.

Example

GET [Link]

GET [Link]

GET VatGroups
Retrieve a collection of 'VatGroups' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=Code&$top=10&$skip=1

POST VatGroups

Create an instance of 'VatGroups' with the given payload of type 'VatGroup' in JSON format.

Example

POST [Link]

{
"Code": "c52",
"Name": "VAT 20",
"TaxAccount": "260000",
"VatGroups_Lines": [
{
"Effectivefrom": "20070101",
"Rate": "20"
}
]
}

PATCH VatGroups(id)

Update an instance of 'VatGroups' with the given payload of type 'VatGroup' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "VAT rate 20"
}

DELETE VatGroups(id)

Delete an instance of 'VatGroups' with the specified id.

Example

DELETE [Link]

[Link] Layer API [Link] 326/334

6/7/24, 15:42 Service Layer API Reference

VendorPayments
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'VendorPayments'. It represents incoming payments to vendors or, for returned goods, to customers. Available payment
methods are cash, credit cards, checks, bank transfers, and in some localizations, bills of exchange.

GET VendorPayments(id)
Retrieve all or some selected properties from an instance of 'VendorPayments' with the given id.

Example

GET [Link]

GET [Link]

GET VendorPayments
Retrieve a collection of 'VendorPayments' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=DocEntry&$top=10&$s

POST VendorPayments

Create an instance of 'VendorPayments' with the given payload of type 'Payment' in JSON format.

Example

POST [Link]

{
"CardCode": "v001",
"CashFlowAssignments": [
{
"AmountLC": "101",
"PaymentMeans": "pmtBankTransfer"
}
],
"TransferAccount": "_SYS00000000004",
"TransferDate": "2014-03-27",
"TransferSum": "101"
}

PATCH VendorPayments(id)

Update an instance of 'VendorPayments' with the given payload of type 'Payment' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Remarks": "new comments - modified by Service Layer"
}

POST VendorPayments(id)/Cancel

Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST [Link]

POST VendorPayments(id)/GetApprovalTemplates

[Link] Layer API [Link] 327/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'GetApprovalTemplates' on this EntitySet with the specified id.

Example

POST [Link]

POST VendorPayments(id)/CancelbyCurrentSystemDate

Invoke the method 'CancelbyCurrentSystemDate' on this EntitySet with the specified id.

Example

POST [Link]

WarehouseLocations
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'WarehouseLocations'. It defines the geographical locations of the warehouses.

GET WarehouseLocations(id)

Retrieve all or some selected properties from an instance of 'WarehouseLocations' with the given id.

Example

GET [Link]

GET [Link]

GET WarehouseLocations

Retrieve a collection of 'WarehouseLocations' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Code&$top=10&$skip=1

POST WarehouseLocations

Create an instance of 'WarehouseLocations' with the given payload of type 'WarehouseLocation' in JSON format.

Example

POST [Link]

{
"City": "SH",
"Country": "China",
"ExemptionNumber": "123456789",
"Name": "ShangHai"
}

PATCH WarehouseLocations(id)

Update an instance of 'WarehouseLocations' with the given payload of type 'WarehouseLocation' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Name": "SH Pudong"
}

DELETE WarehouseLocations(id)

[Link] Layer API [Link] 328/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'WarehouseLocations' with the specified id.

Example

DELETE [Link]

Warehouses
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'Warehouses'. It represents the information of warehouses in the Inventory module.

GET Warehouses(id)

Retrieve all or some selected properties from an instance of 'Warehouses' with the given id.

Example

GET [Link]

GET [Link]

GET Warehouses

Retrieve a collection of 'Warehouses' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$

POST Warehouses

Create an instance of 'Warehouses' with the given payload of type 'Warehouse' in JSON format.

Example

POST [Link]

{
"WarehouseCode": "w001",
"WarehouseName": "w001"
}

PATCH Warehouses(id)

Update an instance of 'Warehouses' with the given payload of type 'Warehouse' in JSON format and with the specified id.

Example

PATCH [Link]

{
"WarehouseName": "UpdatedWHName"
}

DELETE Warehouses(id)

Delete an instance of 'Warehouses' with the specified id.

Example

DELETE [Link]

WarehouseSublevelCodes

[Link] Layer API [Link] 329/334

6/7/24, 15:42 Service Layer API Reference
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'WarehouseSublevelCodes'.

GET WarehouseSublevelCodes(id)
Retrieve all or some selected properties from an instance of 'WarehouseSublevelCodes' with the given id.

Example

GET [Link]

GET [Link]

GET WarehouseSublevelCodes
Retrieve a collection of 'WarehouseSublevelCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=Abs

POST WarehouseSublevelCodes
Create an instance of 'WarehouseSublevelCodes' with the given payload of type 'WarehouseSublevelCode' in JSON format.

Example

POST [Link]

{
"AbsEntry": 4,
"Code": "PIN",
"Description": null,
"WarehouseSublevel": 1
}

PATCH WarehouseSublevelCodes(id)
Update an instance of 'WarehouseSublevelCodes' with the given payload of type 'WarehouseSublevelCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "test"
}

DELETE WarehouseSublevelCodes(id)
Delete an instance of 'WarehouseSublevelCodes' with the specified id.

Example

DELETE [Link]

WeightMeasures
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'WeightMeasures'. It defines the weight measure units that are used for item records.

GET WeightMeasures(id)

Retrieve all or some selected properties from an instance of 'WeightMeasures' with the given id.

[Link] Layer API [Link] 330/334

6/7/24, 15:42 Service Layer API Reference
Example

GET [Link]

GET [Link]

GET WeightMeasures

Retrieve a collection of 'WeightMeasures' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] ge 123 &$orderby=UnitCode&$top=10

POST WeightMeasures

Create an instance of 'WeightMeasures' with the given payload of type 'WeightMeasure' in JSON format.

Example

POST [Link]

{
"UnitDisplay": "T",
"UnitName": "ton"
}

PATCH WeightMeasures(id)

Update an instance of 'WeightMeasures' with the given payload of type 'WeightMeasure' in JSON format and with the specified id.

Example

PATCH [Link]

{
"UnitName": "tonne"
}

DELETE WeightMeasures(id)

Delete an instance of 'WeightMeasures' with the specified id.

Example

DELETE [Link]

WithholdingTaxCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'WithholdingTaxCodes'. It defines withholding tax codes that can be applied to business partners, payments, and documents.

GET WithholdingTaxCodes(id)
Retrieve all or some selected properties from an instance of 'WithholdingTaxCodes' with the given id.

Example

GET [Link]

GET [Link]

GET WithholdingTaxCodes

[Link] Layer API [Link] 331/334

6/7/24, 15:42 Service Layer API Reference
Retrieve a collection of 'WithholdingTaxCodes' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] 'a') &$orderby=WTCode&$to

POST WithholdingTaxCodes

Create an instance of 'WithholdingTaxCodes' with the given payload of type 'WithholdingTaxCode' in JSON format.

Example

POST [Link]

{
"Account": "100000000000000",
"WTCode": "W01",
"WTName": "WT tax",
"WithholdingTaxCodes_Lines": [
{
"Effectivefrom": "2014-11-10"
}
]
}

PATCH WithholdingTaxCodes(id)

Update an instance of 'WithholdingTaxCodes' with the given payload of type 'WithholdingTaxCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"WTName": "withholding Tax code"
}

DELETE WithholdingTaxCodes(id)

Delete an instance of 'WithholdingTaxCodes' with the specified id.

Example

DELETE [Link]

WitholdingTaxDefinition
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'WitholdingTaxDefinition'. It functionally overlaps `WithholdingTaxCodes`.

GET WitholdingTaxDefinition(id)

Retrieve all or some selected properties from an instance of 'WitholdingTaxDefinition' with the given id.

Example

GET [Link]

GET [Link]

GET WitholdingTaxDefinition

Retrieve a collection of 'WitholdingTaxDefinition' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

[Link] Layer API [Link] 332/334

6/7/24, 15:42 Service Layer API Reference

GET [Link] ge 123 &$orderby=AbsEntry&$

POST WitholdingTaxDefinition
Create an instance of 'WitholdingTaxDefinition' with the given payload of type 'WTDCode' in JSON format.

Example

POST [Link]

{}

PATCH WitholdingTaxDefinition(id)
Update an instance of 'WitholdingTaxDefinition' with the given payload of type 'WTDCode' in JSON format and with the specified id.

Example

PATCH [Link]

{
"WTaxName": "newName"
}

DELETE WitholdingTaxDefinition(id)
Delete an instance of 'WitholdingTaxDefinition' with the specified id.

Example

DELETE [Link]

WizardPaymentMethods
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'WizardPaymentMethods'. It defines various payment methods for various payment means (such as check, bank transfer, and
in some localizations, bills of exchange) which can be used in payment wizard runs.

GET WizardPaymentMethods(id)

Retrieve all or some selected properties from an instance of 'WizardPaymentMethods' with the given id.

Example

GET [Link]

GET [Link]

GET WizardPaymentMethods

Retrieve a collection of 'WizardPaymentMethods' with all or some selected properties in the given order by specifying the given filter condition.

Example

GET [Link]

GET [Link] '

POST WizardPaymentMethods

Create an instance of 'WizardPaymentMethods' with the given payload of type 'WizardPaymentMethod' in JSON format.

Example

POST [Link]

[Link] Layer API [Link] 333/334

6/7/24, 15:42 Service Layer API Reference
{
"BankCountry": "US",
"DefaultAccount": "11123456",
"DefaultBank": "USBank",
"Description": "outpayment bank method",
"PaymentMeans": "bopmCheck",
"PaymentMethodCode": "outpay",
"Type": "boptOutgoing"
}

PATCH WizardPaymentMethods(id)
Update an instance of 'WizardPaymentMethods' with the given payload of type 'WizardPaymentMethod' in JSON format and with the specified id.

Example

PATCH [Link]

{
"Description": "outgoing payment method"
}

DELETE WizardPaymentMethods(id)
Delete an instance of 'WizardPaymentMethods' with the specified id.

Example

DELETE [Link]

[Link] Layer API [Link] 334/334