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 https://localhost:50000/b1s/v1/AccountCategoryService_GetCategoryList

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 https://localhost:50000/b1s/v1/AccountsService_CreateOpenBalance

{
"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 https://localhost:50000/b1s/v1/AccrualTypesService_GetAccrualTypeList

ActivitiesService

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ActivitiesService_GetActivityList

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

Example

POST https://localhost:50000/b1s/v1/ActivitiesService_GetSingleInstanceFromSeries

{
"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 https://localhost:50000/b1s/v1/ActivitiesService_UpdateSingleInstanceInSeries

{
"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 https://localhost:50000/b1s/v1/ActivitiesService_DeleteSingleInstanceFromSeries

{
"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 https://localhost:50000/b1s/v1/ActivitiesService_GetTopNActivityInstances

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ActivityRecipientListsService_GetList

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 https://localhost:50000/b1s/v1/AlternativeItemsService_AddItem

{
"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 https://localhost:50000/b1s/v1/AlternativeItemsService_UpdateItem

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AlternativeItemsService_DeleteItem

{
"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 https://localhost:50000/b1s/v1/AlternativeItemsService_GetItem

{
"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 https://localhost:50000/b1s/v1/ApprovalRequestsService_GetApprovalRequestList

POST ApprovalRequestsService_GetOpenApprovalRequestList

Invoke the method 'GetOpenApprovalRequestList' on this service.

Example

POST https://localhost:50000/b1s/v1/ApprovalRequestsService_GetOpenApprovalRequestList

POST ApprovalRequestsService_GetAllApprovalRequestsList

Invoke the method 'GetAllApprovalRequestsList' on this service.

Example

POST https://localhost:50000/b1s/v1/ApprovalRequestsService_GetAllApprovalRequestsList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ApprovalStagesService_GetApprovalStageList

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 https://localhost:50000/b1s/v1/ApprovalTemplatesService_GetApprovalTemplateList

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 https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemoService_Cancel

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

POST AssetCapitalizationCreditMemoService_GetList

Invoke the method 'GetList' on this service.

Example

POST https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemoService_GetList

AssetCapitalizationService
Show/Hide
List Operations
Expand Operations

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

POST AssetCapitalizationService_Cancel
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetCapitalizationService_Cancel

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

POST AssetCapitalizationService_GetList

Invoke the method 'GetList' on this service.

Example

POST https://localhost:50000/b1s/v1/AssetCapitalizationService_GetList

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 https://localhost:50000/b1s/v1/AssetClassesService_GetList

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 https://localhost:50000/b1s/v1/AssetDepreciationGroupsService_GetList

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 https://localhost:50000/b1s/v1/AssetGroupsService_GetList

AssetManualDepreciationService
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetManualDepreciationService_Cancel

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

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

Example

POST https://localhost:50000/b1s/v1/AssetManualDepreciationService_GetList

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 https://localhost:50000/b1s/v1/AssetRetirementService_Cancel

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

POST AssetRetirementService_GetList

Invoke the method 'GetList' on this service.

Example

POST https://localhost:50000/b1s/v1/AssetRetirementService_GetList

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

https://186.74.156.69:50000/Service Layer API Reference.html 7/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/AssetTransferService_Cancel

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

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

Example

POST https://localhost:50000/b1s/v1/AssetTransferService_GetList

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 https://localhost:50000/b1s/v1/AttributeGroupsService_GetList

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 https://localhost:50000/b1s/v1/BankChargesAllocationCodesService_GetBankChargesAllocationCodeList

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 https://localhost:50000/b1s/v1/BankStatementsService_GetBankStatementList

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BarCodesService_GetList

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 https://localhost:50000/b1s/v1/BinLocationAttributesService_GetList

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 https://localhost:50000/b1s/v1/BinLocationFieldsService_GetList

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 https://localhost:50000/b1s/v1/BinLocationsService_GetList

BlanketAgreementsService
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BlanketAgreementsService_GetBlanketAgreementList

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 https://localhost:50000/b1s/v1/BOEDocumentTypesService_GetBOEDocumentTypeList

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 https://localhost:50000/b1s/v1/BOEInstructionsService_GetBOEInstructionList

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 https://localhost:50000/b1s/v1/BOELinesService_GetBOELine

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

BOEPortfoliosService
Show/Hide
List Operations
Expand Operations

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

https://186.74.156.69:50000/Service Layer API Reference.html 10/334

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

Invoke the method 'GetBOEPortfolioList' on this service.

Example

POST https://localhost:50000/b1s/v1/BOEPortfoliosService_GetBOEPortfolioList

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 https://localhost:50000/b1s/v1/BPOpeningBalanceService_CreateOpenBalance

{
"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 https://localhost:50000/b1s/v1/BranchesService_GetBranchList

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 https://localhost:50000/b1s/v1/BrazilBeverageIndexersService_GetList

BrazilFuelIndexersService
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BrazilFuelIndexersService_GetList

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 https://localhost:50000/b1s/v1/BusinessPartnerPropertiesService_GetBusinessPartnerPropertyList

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 https://localhost:50000/b1s/v1/BusinessPartnersService_CreateOpenBalance

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 12/334

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

POST https://localhost:50000/b1s/v1/CampaignResponseTypeService_GetResponseTypeList

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 https://localhost:50000/b1s/v1/CampaignsService_GetList

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 https://localhost:50000/b1s/v1/CashDiscountsService_GetCashDiscountList

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 https://localhost:50000/b1s/v1/CashFlowLineItemsService_GetCashFlowLineItemList

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 https://localhost:50000/b1s/v1/CertificateSeriesService_GetCertificateSeriesList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ChangeLogsService_GetChangeLog

{
"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 https://localhost:50000/b1s/v1/ChangeLogsService_GetChangeLogDifferences

{
"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 https://localhost:50000/b1s/v1/CheckLinesService_GetCheckLine

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

POST CheckLinesService_GetValidCheckLineList

Invoke the method 'GetValidCheckLineList' on this service.

Example

POST https://localhost:50000/b1s/v1/CheckLinesService_GetValidCheckLineList

CockpitsService
Show/Hide
List Operations
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CockpitsService_GetCockpitList

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

Example

POST https://localhost:50000/b1s/v1/CockpitsService_PublishCockpit

{
"Cockpit": {}
}

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

Example

POST https://localhost:50000/b1s/v1/CockpitsService_GetUserCockpitList

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

Example

POST https://localhost:50000/b1s/v1/CockpitsService_GetTemplateCockpitList

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 https://localhost:50000/b1s/v1/CompanyService_GetCompanyInfo

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 https://localhost:50000/b1s/v1/CompanyService_UpdateCompanyInfo

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CompanyService_GetAdminInfo

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

Example

POST https://localhost:50000/b1s/v1/CompanyService_UpdateAdminInfo

{
"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: 1.Properties that access
existing Accounts and function as foreign keys to the ChartOfAccounts object. 2.Properties that define new accounts by using Posting and Sub-Period
definitions.

Example

POST https://localhost:50000/b1s/v1/CompanyService_CreatePeriod

{
"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 https://localhost:50000/b1s/v1/CompanyService_GetPeriods

POST CompanyService_GetPeriod

https://186.74.156.69:50000/Service Layer API Reference.html 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: 1.Properties that
access existing Accounts and function as foreign keys to the ChartOfAccounts object. 2.Properties that define new accounts by using Posting and Sub-
Period definitions.

Example

POST https://localhost:50000/b1s/v1/CompanyService_GetPeriod

{
"PeriodCategoryParams": {}
}

POST CompanyService_UpdatePeriod

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

Example

POST https://localhost:50000/b1s/v1/CompanyService_UpdatePeriod

{
"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 https://localhost:50000/b1s/v1/CompanyService_GetFinancePeriods

{
"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 https://localhost:50000/b1s/v1/CompanyService_GetFinancePeriod

{
"FinancePeriodParams": {}
}

POST CompanyService_UpdateFinancePeriod

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

Example

POST https://localhost:50000/b1s/v1/CompanyService_UpdateFinancePeriod

{
"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"
}
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CompanyService_RemoveFinancePeriod

{
"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: 1.Properties that access existing Accounts and function as foreign keys
to the 'ChartOfAccounts' object. 2.Properties 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 https://localhost:50000/b1s/v1/CompanyService_CreatePeriodWithFinanceParams

{
"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 https://localhost:50000/b1s/v1/CompanyService_GetFeaturesStatus

POST CompanyService_GetPathAdmin

Invoke the method 'GetPathAdmin' on this service.

Example

POST https://localhost:50000/b1s/v1/CompanyService_GetPathAdmin

POST CompanyService_UpdatePathAdmin

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

Example

POST https://localhost:50000/b1s/v1/CompanyService_UpdatePathAdmin

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

POST CompanyService_RoundDecimal
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CompanyService_RoundDecimal

{
"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 https://localhost:50000/b1s/v1/CompanyService_GetItemPrice

{
"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 https://localhost:50000/b1s/v1/CompanyService_GetAdvancedGLAccount

{
"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 https://localhost:50000/b1s/v1/CorrectionInvoiceReversalService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/CorrectionInvoiceReversalService_HandleApprovalRequest

CorrectionInvoiceService
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CorrectionInvoiceService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/CorrectionInvoiceService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversalService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversalService_HandleApprovalRequest

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/CostCenterTypesService_GetCostCenterTypeList

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

https://186.74.156.69:50000/Service Layer API Reference.html 21/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/CostElementService_GetCostElementList

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 https://localhost:50000/b1s/v1/CountriesService_GetCountryList

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 https://localhost:50000/b1s/v1/CreditLinesService_GetCreditLine

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

POST CreditLinesService_GetValidCreditLineList

Invoke the method 'GetValidCreditLineList' on this service.

Example

POST https://localhost:50000/b1s/v1/CreditLinesService_GetValidCreditLineList

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 https://localhost:50000/b1s/v1/CreditNotesService_GetApprovalTemplates

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

https://186.74.156.69:50000/Service Layer API Reference.html 22/334

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

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

Example

POST https://localhost:50000/b1s/v1/CreditNotesService_HandleApprovalRequest

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

Example

POST https://localhost:50000/b1s/v1/CreditNotesService_RequestApproveCancellation

{
"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 https://localhost:50000/b1s/v1/CycleCountDeterminationsService_GetList

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 https://localhost:50000/b1s/v1/DashboardPackagesService_ImportDashboardPackage

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 23/334
6/7/24, 15:42 Service Layer API Reference
Example

POST https://localhost:50000/b1s/v1/DeductionTaxSubGroupsService_GetDeductionTaxSubGroupList

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 https://localhost:50000/b1s/v1/DeliveryNotesService_GetApprovalTemplates

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

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

Example

POST https://localhost:50000/b1s/v1/DeliveryNotesService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/DepartmentsService_GetDepartmentList

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 https://localhost:50000/b1s/v1/DepositsService_GetDepositList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DepositsService_CancelCheckRow

{
"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 https://localhost:50000/b1s/v1/DepositsService_CancelCheckRowbyCurrentSystemDate

{
"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 https://localhost:50000/b1s/v1/DepreciationAreasService_GetList

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 https://localhost:50000/b1s/v1/DepreciationTypePoolsService_GetList

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.

https://186.74.156.69:50000/Service Layer API Reference.html 25/334
6/7/24, 15:42 Service Layer API Reference
Example

POST https://localhost:50000/b1s/v1/DepreciationTypesService_GetList

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 https://localhost:50000/b1s/v1/DeterminationCriteriasService_GetList

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 https://localhost:50000/b1s/v1/DimensionsService_GetDimensionList

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 https://localhost:50000/b1s/v1/DistributionRulesService_GetDistributionRuleList

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 https://localhost:50000/b1s/v1/DNFCodeSetupService_GetDNFCodeSetupList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DownPaymentsService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/DownPaymentsService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/DraftsService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/DraftsService_HandleApprovalRequest

POST DraftsService_SaveDraftToDocument

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DraftsService_SaveDraftToDocument

{
"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 https://localhost:50000/b1s/v1/DunningTermsService_GetDunningTermList

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 https://localhost:50000/b1s/v1/ElectronicCommunicationActionService_GetAction

{
"ECMCodeParams": {}
}

POST ElectronicCommunicationActionService_UpdateAction

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionService_UpdateAction

{
"ECMActionStatusData": {}
}

POST ElectronicCommunicationActionService_ConfirmSuccessOfCommunication

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionService_ConfirmSuccessOfCommunication

{
"ECMCodeParams": {}
}

POST ElectronicCommunicationActionService_ReportErrorAndContinue

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ElectronicCommunicationActionService_ReportErrorAndContinue

{
"ECMCodeParams": {}
}

POST ElectronicCommunicationActionService_ReportErrorAndStop

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionService_ReportErrorAndStop

{
"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 https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_GetEcmAction

{
"EcmActionParams": {}
}

POST ElectronicCommunicationActionsService_AddEcmAction

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_AddEcmAction

{
"EcmAction": {}
}

POST ElectronicCommunicationActionsService_UpdateEcmAction

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_UpdateEcmAction

{
"EcmAction": {}
}

POST ElectronicCommunicationActionsService_DeleteEcmAction

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_DeleteEcmAction

{
"EcmAction": {}
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_GetEcmActionByDoc

{
"EcmActionDocParams": {}
}

POST ElectronicCommunicationActionsService_GetEcmActionLogList

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_GetEcmActionLogList

{
"EcmAction": {}
}

POST ElectronicCommunicationActionsService_GetEcmActionLog

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_GetEcmActionLog

{
"EcmActionLogParams": {}
}

POST ElectronicCommunicationActionsService_AddEcmActionLog

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

Example

POST https://localhost:50000/b1s/v1/ElectronicCommunicationActionsService_AddEcmActionLog

{
"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 https://localhost:50000/b1s/v1/ElectronicFileFormatsService_GetElectronicFileFormatList

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.

https://186.74.156.69:50000/Service Layer API Reference.html 30/334

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

POST https://localhost:50000/b1s/v1/EmailGroupsService_GetList

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 https://localhost:50000/b1s/v1/EmployeeIDTypeService_GetList

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 https://localhost:50000/b1s/v1/EmployeePositionService_GetList

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 https://localhost:50000/b1s/v1/EmployeeRolesSetupService_GetEmployeeRoleSetupList

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 https://localhost:50000/b1s/v1/EmployeeStatusService_GetList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/EmployeeTransfersService_GetEmployeeTransferList

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 https://localhost:50000/b1s/v1/EnhancedDiscountGroupsService_GetList

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 https://localhost:50000/b1s/v1/ExtendedTranslationsService_GetExtendedTranslationList

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 https://localhost:50000/b1s/v1/ExternalCallsService_SendCall

{
"ExternalCall": {}
}

POST ExternalCallsService_UpdateCall

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

https://186.74.156.69:50000/Service Layer API Reference.html 32/334

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

POST https://localhost:50000/b1s/v1/ExternalCallsService_UpdateCall

{
"ExternalCall": {}
}

POST ExternalCallsService_GetCall

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

Example

POST https://localhost:50000/b1s/v1/ExternalCallsService_GetCall

{
"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 https://localhost:50000/b1s/v1/ExternalReconciliationsService_Reconcile

{
"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 https://localhost:50000/b1s/v1/ExternalReconciliationsService_GetReconciliation

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

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

https://186.74.156.69:50000/Service Layer API Reference.html 33/334

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

POST https://localhost:50000/b1s/v1/ExternalReconciliationsService_CancelReconciliation

{
"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 https://localhost:50000/b1s/v1/ExternalReconciliationsService_GetReconciliationList

POST https://localhost:50000/b1s/v1/ExternalReconciliationsService_GetReconciliationList

{
"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 https://localhost:50000/b1s/v1/FAAccountDeterminationsService_GetList

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 https://localhost:50000/b1s/v1/FinancialYearsService_GetFinancialYearList

FiscalPrinterService
Show/Hide
List Operations
Expand Operations

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

POST FiscalPrinterService_GetFiscalPrinterList

https://186.74.156.69:50000/Service Layer API Reference.html 34/334

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

Example

POST https://localhost:50000/b1s/v1/FiscalPrinterService_GetFiscalPrinterList

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 https://localhost:50000/b1s/v1/FixedAssetItemsService_GetAssetValuesList

{
"FixedAssetValuesParams": {}
}

POST FixedAssetItemsService_GetAssetEndBalance

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

Example

POST https://localhost:50000/b1s/v1/FixedAssetItemsService_GetAssetEndBalance

{
"FixedAssetValuesParams": {}
}

POST FixedAssetItemsService_UpdateAssetEndBalance

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

Example

POST https://localhost:50000/b1s/v1/FixedAssetItemsService_UpdateAssetEndBalance

{
"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 https://localhost:50000/b1s/v1/GLAccountAdvancedRulesService_GetList

GoodsReturnRequestService
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/GoodsReturnRequestService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/GoodsReturnRequestService_Preview

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

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

Example

POST https://localhost:50000/b1s/v1/GoodsReturnRequestService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/GovPayCodesService_GetList

GTIsService
Show/Hide
List Operations
Expand Operations

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/GTIsService_Import

{
"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 https://localhost:50000/b1s/v1/IntegrationPackagesConfigureService_GetList

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 https://localhost:50000/b1s/v1/InternalReconciliationsService_GetOpenTransactions

{
"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 https://localhost:50000/b1s/v1/InternalReconciliationsService_Cancel

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

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 37/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/InternalReconciliationsService_RequestApproveCancellation

{
"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 https://localhost:50000/b1s/v1/IntrastatConfigurationService_GetList

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 https://localhost:50000/b1s/v1/InventoryCountingsService_GetList

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 https://localhost:50000/b1s/v1/InventoryGenEntryService_GetApprovalTemplates

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

POST InventoryGenEntryService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST https://localhost:50000/b1s/v1/InventoryGenEntryService_HandleApprovalRequest

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/InventoryGenExitService_GetApprovalTemplates

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

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

Example

POST https://localhost:50000/b1s/v1/InventoryGenExitService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/InventoryOpeningBalancesService_GetList

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 https://localhost:50000/b1s/v1/InventoryPostingsService_GetList

POST InventoryPostingsService_SetCopyOption

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

https://186.74.156.69:50000/Service Layer API Reference.html 39/334

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

POST https://localhost:50000/b1s/v1/InventoryPostingsService_SetCopyOption

{
"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 https://localhost:50000/b1s/v1/InventoryTransferRequestsService_GetApprovalTemplates

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

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

Example

POST https://localhost:50000/b1s/v1/InventoryTransferRequestsService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/InvoicesService_GetApprovalTemplates

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

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

https://186.74.156.69:50000/Service Layer API Reference.html 40/334

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

POST https://localhost:50000/b1s/v1/InvoicesService_HandleApprovalRequest

POST InvoicesService_RequestApproveCancellation

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

Example

POST https://localhost:50000/b1s/v1/InvoicesService_RequestApproveCancellation

{
"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 https://localhost:50000/b1s/v1/JournalEntryDocumentTypeService_GetList

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 https://localhost:50000/b1s/v1/JournalVouchersService_Add

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/KPIsService_GetList

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 https://localhost:50000/b1s/v1/LandedCostsService_GetLandedCostList

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 https://localhost:50000/b1s/v1/LicenseService_GetInstallationNumber

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 https://localhost:50000/b1s/v1/Login

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

Logout
Show/Hide
List Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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/b1s.conf". Here, "{USER_INSTALL_DIR}"
stands for the installation folder.

POST Logout
Logout.

Example

POST https://localhost:50000/b1s/v1/Logout

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 https://localhost:50000/b1s/v1/MaterialGroupsService_GetMaterialGroupList

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 https://localhost:50000/b1s/v1/MaterialRevaluationFIFOService_GetMaterialRevaluationFIFO

{
"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 https://localhost:50000/b1s/v1/MaterialRevaluationSNBService_GetList

{
"MaterialRevaluationSNBParam": {}
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/MessagesService_GetInbox

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

Example

POST https://localhost:50000/b1s/v1/MessagesService_GetOutbox

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

Example

POST https://localhost:50000/b1s/v1/MessagesService_GetSentMessages

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 https://localhost:50000/b1s/v1/MobileAddOnSettingService_GetMobileAddOnSettingList

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 https://localhost:50000/b1s/v1/MobileAppService_GetCurrentServerDateTime

POST MobileAppService_GetDppChangeParams

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

https://186.74.156.69:50000/Service Layer API Reference.html 44/334

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

POST https://localhost:50000/b1s/v1/MobileAppService_GetDppChangeParams

{
"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 https://localhost:50000/b1s/v1/MobileAppService_GetTechnicianSchedulings

{
"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 https://localhost:50000/b1s/v1/MobileAppService_GetEmployeeFullNames

{
"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 https://localhost:50000/b1s/v1/MobileAppService_GetTechnicianSettings

{
"TechnicianSettingsParams": {}
}

POST MobileAppService_UpdateTechnicianSettings

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

Example

POST https://localhost:50000/b1s/v1/MobileAppService_UpdateTechnicianSettings

{
"TechnicianSettings": {}
}

POST MobileAppService_GetTechnicianSettingsGroup

Invoke the method 'GetTechnicianSettingsGroup' on this service.

Example

POST https://localhost:50000/b1s/v1/MobileAppService_GetTechnicianSettingsGroup

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/MobileAppService_UpdateTechnicianSettingsGroup

{
"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 https://localhost:50000/b1s/v1/MobileAppService_GetSalesAppSetting

{
"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 https://localhost:50000/b1s/v1/MobileAppService_UpdateSalesAppSetting

{
"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 https://localhost:50000/b1s/v1/MobileAppService_GetServiceAppReportContent

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 46/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/MobileAppService_UpdateServiceAppReportContent

{
"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 https://localhost:50000/b1s/v1/MobileAppService_GetServiceAppReport

{
"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 https://localhost:50000/b1s/v1/MobileAppService_UpdateServiceAppReport

{
"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 https://localhost:50000/b1s/v1/NatureOfAssesseesService_GetNatureOfAssesseeList

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 https://localhost:50000/b1s/v1/NCMCodesSetupService_GetNCMCodeSetupList

NFModelsService

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/NFModelsService_GetList

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 https://localhost:50000/b1s/v1/NFTaxCategoriesService_GetList

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 https://localhost:50000/b1s/v1/OccurrenceCodesService_GetList

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 https://localhost:50000/b1s/v1/OrdersService_GetApprovalTemplates

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/OrdersService_Preview

{
"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 https://localhost:50000/b1s/v1/OrdersService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PartnersSetupsService_GetList

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 https://localhost:50000/b1s/v1/PaymentBlocksService_GetPaymentBlockList

PaymentCalculationService
Show/Hide
List Operations
Expand Operations

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PaymentCalculationService_GetPaymentAmount

{
"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 https://localhost:50000/b1s/v1/PaymentTermsTypesService_UpdateWithBPs

{
"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 https://localhost:50000/b1s/v1/PickListsService_Close

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

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

Example

POST https://localhost:50000/b1s/v1/PickListsService_UpdateReleasedAllocation

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PredefinedTextsService_GetPredefinedTextList

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 https://localhost:50000/b1s/v1/ProfitCentersService_GetProfitCenterList

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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_GetSubprojectTypes

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_AddSubprojectTypes

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_UpdateSubprojectTypes

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_DeleteSubprojectTypes

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

POST ProjectManagementConfigurationService_GetStageTypes

Invoke the method 'GetStageTypes' on this service.

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_GetStageTypes

POST ProjectManagementConfigurationService_AddStageTypes

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_AddStageTypes

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_UpdateStageTypes

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_DeleteStageTypes

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

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_GetAreas

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_AddAreas

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_UpdateAreas

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_DeleteAreas

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

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_GetPriorities

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_AddPriorities

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_UpdatePriorities

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_DeletePriorities

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

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_GetActivities

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_AddActivities

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_UpdateActivities

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_DeleteActivities

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

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_GetTasks

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

Example

POST https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_AddTasks

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_UpdateTasks

{
"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 https://localhost:50000/b1s/v1/ProjectManagementConfigurationService_DeleteTasks

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

ProjectManagementService
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProjectManagementService_GetSubprojectsList

{
"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 https://localhost:50000/b1s/v1/ProjectManagementService_GetSubproject

{
"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 https://localhost:50000/b1s/v1/ProjectManagementService_AddSubproject

{
"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 https://localhost:50000/b1s/v1/ProjectManagementService_UpdateSubproject

{
"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 https://localhost:50000/b1s/v1/ProjectManagementService_DeleteSubproject

{
"PM_SubprojectDocumentParams": {

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProjectsService_GetProjectList

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 https://localhost:50000/b1s/v1/PurchaseCreditNotesService_GetApprovalTemplates

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

POST PurchaseCreditNotesService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST https://localhost:50000/b1s/v1/PurchaseCreditNotesService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PurchaseDeliveryNotesService_GetApprovalTemplates

{
"Document": {

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseDeliveryNotesService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PurchaseDownPaymentsService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/PurchaseDownPaymentsService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PurchaseInvoicesService_GetApprovalTemplates

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseInvoicesService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PurchaseOrdersService_GetApprovalTemplates

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

POST PurchaseOrdersService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST https://localhost:50000/b1s/v1/PurchaseOrdersService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PurchaseQuotationsService_GetApprovalTemplates

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseQuotationsService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PurchaseRequestService_GetApprovalTemplates

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

POST PurchaseRequestService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST https://localhost:50000/b1s/v1/PurchaseRequestService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/PurchaseReturnsService_GetApprovalTemplates

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseReturnsService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/QueryService_PostQuery

{
"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 https://localhost:50000/b1s/v1/QuotationsService_GetApprovalTemplates

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

POST QuotationsService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST https://localhost:50000/b1s/v1/QuotationsService_HandleApprovalRequest

RecurringTransactionService
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/RecurringTransactionService_GetAvailableRecurringTransactions

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

Example

POST https://localhost:50000/b1s/v1/RecurringTransactionService_DeleteRecurringTransactions

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

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

Example

POST https://localhost:50000/b1s/v1/RecurringTransactionService_GetRecurringTransaction

{
"RclRecurringTransactionParams": {}
}

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

Example

POST https://localhost:50000/b1s/v1/RecurringTransactionService_ExecuteRecurringTransactions

{
"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 https://localhost:50000/b1s/v1/ReportFilterService_GetTaxReportFilterList

{
"TaxReportFilterParams": {
"Code": 1

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ReportLayoutsService_SetDefaultReport

{
"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 https://localhost:50000/b1s/v1/ReportLayoutsService_GetDefaultReport

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

POST ReportLayoutsService_AddReportLayout

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

Example

POST https://localhost:50000/b1s/v1/ReportLayoutsService_AddReportLayout

{
"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 https://localhost:50000/b1s/v1/ReportLayoutsService_UpdatePrinterSettings

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 63/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/ReportLayoutsService_DeleteReportLayout

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

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

Example

POST https://localhost:50000/b1s/v1/ReportLayoutsService_GetReportLayout

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

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

Example

POST https://localhost:50000/b1s/v1/ReportLayoutsService_GetDefaultReportLayout

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

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

Example

POST https://localhost:50000/b1s/v1/ReportLayoutsService_GetReportLayoutList

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

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

Example

POST https://localhost:50000/b1s/v1/ReportLayoutsService_UpdateLanguageReport

{
"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 https://localhost:50000/b1s/v1/ReportLayoutsService_AddReportLayoutToMenu

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ReportLayoutsService_DeleteReportLayoutAndMenu

{
"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 https://localhost:50000/b1s/v1/ReportTypesService_GetReportTypeList

ResourceCapacitiesService
Show/Hide
List Operations
Expand Operations

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

https://186.74.156.69:50000/Service Layer API Reference.html 65/334

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

Invoke the method 'GetList' on this service.

Example

POST https://localhost:50000/b1s/v1/ResourceCapacitiesService_GetList

POST ResourceCapacitiesService_GetListWithFilter

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

Example

POST https://localhost:50000/b1s/v1/ResourceCapacitiesService_GetListWithFilter

{
"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 https://localhost:50000/b1s/v1/ResourceGroupsService_GetList

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 https://localhost:50000/b1s/v1/ResourcePropertiesService_GetList

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 https://localhost:50000/b1s/v1/ResourcesService_GetList

RetornoCodesService
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/RetornoCodesService_GetList

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 https://localhost:50000/b1s/v1/ReturnRequestService_GetApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/ReturnRequestService_Preview

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

POST ReturnRequestService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST https://localhost:50000/b1s/v1/ReturnRequestService_HandleApprovalRequest

ReturnsService
Show/Hide
List Operations
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ReturnsService_GetApprovalTemplates

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

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

Example

POST https://localhost:50000/b1s/v1/ReturnsService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/RouteStagesService_GetList

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 https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetupService_GetSalesOpportunityCompetitorSetupList

SalesOpportunityInterestsSetupService
Show/Hide
List Operations
Expand Operations

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

https://186.74.156.69:50000/Service Layer API Reference.html 68/334

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

Invoke the method 'GetSalesOpportunityInterestSetupList' on this service.

Example

POST https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetupService_GetSalesOpportunityInterestSetupList

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 https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetupService_GetSalesOpportunityReasonSetupList

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 https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetupService_GetSalesOpportunitySourceSetupList

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 https://localhost:50000/b1s/v1/SBOBobService_GetSystemPermission

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

POST SBOBobService_GetSystemCurrency

Invoke the method 'GetSystemCurrency' on this service.

Example

POST https://localhost:50000/b1s/v1/SBOBobService_GetSystemCurrency

POST SBOBobService_GetDueDate

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SBOBobService_GetDueDate

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

POST SBOBobService_GetLocalCurrency

Invoke the method 'GetLocalCurrency' on this service.

Example

POST https://localhost:50000/b1s/v1/SBOBobService_GetLocalCurrency

POST SBOBobService_GetCurrencyRate

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

Example

POST https://localhost:50000/b1s/v1/SBOBobService_GetCurrencyRate

{
"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 https://localhost:50000/b1s/v1/SBOBobService_GetIndexRate

{
"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 https://localhost:50000/b1s/v1/SBOBobService_Format_MoneyToString

{
"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 https://localhost:50000/b1s/v1/SBOBobService_SetCurrencyRate

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

SectionsService
Show/Hide
List Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SectionsService_GetSectionList

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 https://localhost:50000/b1s/v1/SeriesService_AddSeries

{
"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 https://localhost:50000/b1s/v1/SeriesService_RemoveSeries

{
"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"
}
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SeriesService_AttachSeriesToDocument

{
"DocumentSeriesParams": {}
}

POST SeriesService_UnattachSeriesFromDocument

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_UnattachSeriesFromDocument

{
"DocumentSeriesParams": {}
}

POST SeriesService_SetDefaultSeriesForAllUsers

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_SetDefaultSeriesForAllUsers

{
"DocumentSeriesParams": {}
}

POST SeriesService_SetDefaultSeriesForCurrentUser

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_SetDefaultSeriesForCurrentUser

{
"DocumentSeriesParams": {}
}

POST SeriesService_SetDefaultSeriesForUser

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_SetDefaultSeriesForUser

{
"DocumentSeriesUserParams": {}
}

POST SeriesService_UpdateSeries

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_UpdateSeries

{
"Series": {}
}

POST SeriesService_GetDefaultSeries

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

Example
https://186.74.156.69:50000/Service Layer API Reference.html 72/334
6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/SeriesService_GetDefaultSeries

{
"DocumentTypeParams": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_GetDocumentSeries

{
"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 https://localhost:50000/b1s/v1/SeriesService_GetSeries

{
"SeriesParams": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_GetDocumentChangedMenuName

{
"DocumentTypeParams": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_ChangeDocumentMenuName

{
"DocumentChangeMenuName": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_GetElectronicSeries

{
"ElectronicSeriesParams": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_AddElectronicSeries

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SeriesService_RemoveElectronicSeries

{
"ElectronicSeriesParams": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_UpdateElectronicSeries

{
"ElectronicSeries": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_GetDefaultElectronicSeries

{
"SeriesParams": {}
}

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

Example

POST https://localhost:50000/b1s/v1/SeriesService_SetDefaultElectronicSeries

{
"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 https://localhost:50000/b1s/v1/ServiceCallOriginsService_GetServiceCallOriginList

ServiceCallProblemSubTypesService
Show/Hide
List Operations
Expand Operations

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

https://186.74.156.69:50000/Service Layer API Reference.html 74/334

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

Invoke the method 'GetServiceCallProblemSubTypeList' on this service.

Example

POST https://localhost:50000/b1s/v1/ServiceCallProblemSubTypesService_GetServiceCallProblemSubTypeList

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 https://localhost:50000/b1s/v1/ServiceCallProblemTypesService_GetServiceCallProblemTypeList

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 https://localhost:50000/b1s/v1/ServiceCallSolutionStatusService_GetServiceCallSolutionStatusList

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 https://localhost:50000/b1s/v1/ServiceCallStatusService_GetServiceCallStatusList

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

https://186.74.156.69:50000/Service Layer API Reference.html 75/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/ServiceCallTypesService_GetServiceCallTypeList

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 https://localhost:50000/b1s/v1/ServiceGroupsService_GetServiceGroupList

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 https://localhost:50000/b1s/v1/ServiceTaxPostingService_PostServiceTax

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

POST ServiceTaxPostingService_GetTaxableDeliveries

Invoke the method 'GetTaxableDeliveries' on this service.

Example

POST https://localhost:50000/b1s/v1/ServiceTaxPostingService_GetTaxableDeliveries

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 https://localhost:50000/b1s/v1/StatesService_GetStateList

StockTransferDraftService
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/StockTransferDraftService_GetApprovalTemplates

{
"StockTransfer": {}
}

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

Example

POST https://localhost:50000/b1s/v1/StockTransferDraftService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/StockTransferService_GetApprovalTemplates

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

POST StockTransferService_HandleApprovalRequest

Invoke the method 'HandleApprovalRequest' on this service.

Example

POST https://localhost:50000/b1s/v1/StockTransferService_HandleApprovalRequest

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 https://localhost:50000/b1s/v1/TargetGroupsService_GetList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/TaxCodeDeterminationsService_GetTaxCodeDeterminationList

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 https://localhost:50000/b1s/v1/TaxCodeDeterminationsTCDService_GetTaxCodeDeterminationTCDList

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 https://localhost:50000/b1s/v1/TaxWebSitesService_GetTaxWebSiteList

POST TaxWebSitesService_GetDefaultWebSite

Invoke the method 'GetDefaultWebSite' on this service.

Example

POST https://localhost:50000/b1s/v1/TaxWebSitesService_GetDefaultWebSite

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

https://186.74.156.69:50000/Service Layer API Reference.html 78/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/TerminationReasonService_GetList

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 https://localhost:50000/b1s/v1/TrackingNotesService_GetList

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 https://localhost:50000/b1s/v1/TransactionCodesService_GetList

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 https://localhost:50000/b1s/v1/UnitOfMeasurementGroupsService_GetList

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 https://localhost:50000/b1s/v1/UnitOfMeasurementsService_GetList

UserMenuService

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/UserMenuService_GetCurrentUserMenu

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

Example

POST https://localhost:50000/b1s/v1/UserMenuService_UpdateCurrentUserMenu

{
"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 https://localhost:50000/b1s/v1/UserMenuService_GetUserMenu

{
"UserMenuParams": {}
}

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 80/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/UserMenuService_UpdateUserMenu

{
"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 https://localhost:50000/b1s/v1/ValueMappingService_GetMappedB1Value

{
"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 https://localhost:50000/b1s/v1/ValueMappingService_GetThirdPartyValuesForB1Value

{
"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 https://localhost:50000/b1s/v1/ValueMappingService_RemoveMappedValue

{
"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 https://localhost:50000/b1s/v1/WarehouseSublevelCodesService_GetList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/WorkflowTaskService_Complete

{
"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 https://localhost:50000/b1s/v1/WorkflowTaskService_GetApprovalTaskList

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 82/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/AccountCategory(1)

GET https://localhost:50000/b1s/v1/AccountCategory(1)?$select=CategoryCode,CategoryName,CategorySource

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 https://localhost:50000/b1s/v1/AccountCategory

GET https://localhost:50000/b1s/v1/AccountCategory?$select=CategoryCode,CategoryName,CategorySource&$filter=CategoryCode ge 123 &$orderby=

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

Example

POST https://localhost:50000/b1s/v1/AccountCategory

{
"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 https://localhost:50000/b1s/v1/AccountCategory(1)

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

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

Example

DELETE https://localhost:50000/b1s/v1/AccountCategory(1)

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 https://localhost:50000/b1s/v1/AccountSegmentationCategories(SegmentID=123,Code='abc')

GET https://localhost:50000/b1s/v1/AccountSegmentationCategories(SegmentID=123,Code='abc')?$select=SegmentID,Code,Name

GET AccountSegmentationCategories

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

https://186.74.156.69:50000/Service Layer API Reference.html 83/334

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

GET https://localhost:50000/b1s/v1/AccountSegmentationCategories

GET https://localhost:50000/b1s/v1/AccountSegmentationCategories?$select=SegmentID,Code,Name&$filter=SegmentID ge 123 and startswith(Code,

POST AccountSegmentationCategories

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

Example

POST https://localhost:50000/b1s/v1/AccountSegmentationCategories

{
"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 https://localhost:50000/b1s/v1/AccountSegmentationCategories(SegmentID=3,Code='50')

{
"Name": "General Administration"
}

DELETE AccountSegmentationCategories(id)

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

Example

DELETE https://localhost:50000/b1s/v1/AccountSegmentationCategories(SegmentID=3,Code='50')

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 https://localhost:50000/b1s/v1/AccountSegmentations(123)

GET https://localhost:50000/b1s/v1/AccountSegmentations(123)?$select=Numerator,Name,Size

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 https://localhost:50000/b1s/v1/AccountSegmentations

GET https://localhost:50000/b1s/v1/AccountSegmentations?$select=Numerator,Name,Size&$filter=Numerator ge 123 &$orderby=Numerator&$top=10&$

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AccountSegmentations

{
"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 https://localhost:50000/b1s/v1/AccountSegmentations(123)

{
"Name": "Division3"
}

DELETE AccountSegmentations(id)

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

Example

DELETE https://localhost:50000/b1s/v1/AccountSegmentations(123)

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 https://localhost:50000/b1s/v1/AccrualTypes('Accrual1')

GET https://localhost:50000/b1s/v1/AccrualTypes('Accrual1')?$select=Code,Name,PostingAccount

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 https://localhost:50000/b1s/v1/AccrualTypes

GET https://localhost:50000/b1s/v1/AccrualTypes?$select=Code,Name,PostingAccount&$filter=startswith(Code, 'a') &$orderby=Code&$top=10&$ski

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

https://186.74.156.69:50000/Service Layer API Reference.html 85/334

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

POST https://localhost:50000/b1s/v1/AccrualTypes

{
"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 https://localhost:50000/b1s/v1/AccrualTypes('Accrual1')

{
"PostingAccount": "2140"
}

DELETE AccrualTypes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/AccrualTypes('Accrual1')

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 https://localhost:50000/b1s/v1/Activities(2)

GET https://localhost:50000/b1s/v1/Activities(2)?$select=ActivityCode,CardCode,Notes

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 https://localhost:50000/b1s/v1/Activities

GET https://localhost:50000/b1s/v1/Activities?$select=ActivityCode,CardCode,Notes&$filter=ActivityCode 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 https://localhost:50000/b1s/v1/Activities

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Activities(2)

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

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

Example

DELETE https://localhost:50000/b1s/v1/Activities(2)

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 https://localhost:50000/b1s/v1/ActivityLocations(1)

GET https://localhost:50000/b1s/v1/ActivityLocations(1)?$select=Code,Name

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 https://localhost:50000/b1s/v1/ActivityLocations

GET https://localhost:50000/b1s/v1/ActivityLocations?$select=Code,Name&$filter=Code 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 https://localhost:50000/b1s/v1/ActivityLocations

{
"Name": "SH Room1"
}

PATCH ActivityLocations(id)
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ActivityLocations(1)

{
"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 https://localhost:50000/b1s/v1/ActivityRecipientLists(123)

GET https://localhost:50000/b1s/v1/ActivityRecipientLists(123)?$select=Code,Name,Active

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 https://localhost:50000/b1s/v1/ActivityRecipientLists

GET https://localhost:50000/b1s/v1/ActivityRecipientLists?$select=Code,Name,Active&$filter=Code 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 https://localhost:50000/b1s/v1/ActivityRecipientLists

{
"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 https://localhost:50000/b1s/v1/ActivityRecipientLists(123)

{}

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

Example

DELETE https://localhost:50000/b1s/v1/ActivityRecipientLists(123)

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 https://localhost:50000/b1s/v1/ActivityStatuses(1)

GET https://localhost:50000/b1s/v1/ActivityStatuses(1)?$select=StatusDescription,StatusId,StatusName

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 https://localhost:50000/b1s/v1/ActivityStatuses

GET https://localhost:50000/b1s/v1/ActivityStatuses?$select=StatusDescription,StatusId,StatusName&$filter=StatusId ge 1 &$orderby=StatusId

POST ActivityStatuses

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

Example

POST https://localhost:50000/b1s/v1/ActivityStatuses

{
"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 https://localhost:50000/b1s/v1/ActivityStatuses(1)

{
"StatusDescription": "Finished"
}

DELETE ActivityStatuses(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ActivityStatuses(1)

ActivityTypes
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ActivityTypes(123)

GET https://localhost:50000/b1s/v1/ActivityTypes(123)?$select=Code,Name

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 https://localhost:50000/b1s/v1/ActivityTypes

GET https://localhost:50000/b1s/v1/ActivityTypes?$select=Code,Name&$filter=Code 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 https://localhost:50000/b1s/v1/ActivityTypes

{
"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 https://localhost:50000/b1s/v1/ActivityTypes(123)

{
"Name": "Others"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ActivityTypes(123)

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.

https://186.74.156.69:50000/Service Layer API Reference.html 90/334

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

GET https://localhost:50000/b1s/v1/AdditionalExpenses(123)

GET https://localhost:50000/b1s/v1/AdditionalExpenses(123)?$select=Name,RevenuesAccount,ExpenseAccount

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 https://localhost:50000/b1s/v1/AdditionalExpenses

GET https://localhost:50000/b1s/v1/AdditionalExpenses?$select=Name,RevenuesAccount,ExpenseAccount&$filter=ExpensCode ge 123 &$orderby=Expe

POST AdditionalExpenses

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

Example

POST https://localhost:50000/b1s/v1/AdditionalExpenses

{
"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 https://localhost:50000/b1s/v1/AdditionalExpenses(123)

{
"DistributionMethod": "aed_Equally"
}

DELETE AdditionalExpenses(id)

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

Example

DELETE https://localhost:50000/b1s/v1/AdditionalExpenses(123)

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 https://localhost:50000/b1s/v1/AlertManagements(123)

GET https://localhost:50000/b1s/v1/AlertManagements(123)?$select=Code,Name,Type

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AlertManagements

GET https://localhost:50000/b1s/v1/AlertManagements?$select=Code,Name,Type&$filter=Code 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 https://localhost:50000/b1s/v1/AlertManagements

{
"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 https://localhost:50000/b1s/v1/AlertManagements(123)

{
"FrequencyType": "atfi_Weeks"
}

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

Example

DELETE https://localhost:50000/b1s/v1/AlertManagements(123)

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

Example

POST https://localhost:50000/b1s/v1/AlertManagements(123)/GetAlertManagement

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

Example

POST https://localhost:50000/b1s/v1/AlertManagements(123)/GetAlertManagementList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AlternateCatNum(ItemCode='item01',CardCode='c001',Substitute='BP01')

GET https://localhost:50000/b1s/v1/AlternateCatNum(ItemCode='item01',CardCode='c001',Substitute='BP01')?$select=ItemCode,CardCode,Substitu

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 https://localhost:50000/b1s/v1/AlternateCatNum

GET https://localhost:50000/b1s/v1/AlternateCatNum?$select=ItemCode,CardCode,Substitute&$filter=startswith(ItemCode, 'i') and startswith(C

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

Example

POST https://localhost:50000/b1s/v1/AlternateCatNum

{
"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 https://localhost:50000/b1s/v1/AlternateCatNum(ItemCode='item01',CardCode='c001',Substitute='BP01')

{
"DisplayBPCatalogNumber": "tYES"
}

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

Example

DELETE https://localhost:50000/b1s/v1/AlternateCatNum(ItemCode='item01',CardCode='c001',Substitute='BP01')

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)
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ApprovalRequests(123)

GET https://localhost:50000/b1s/v1/ApprovalRequests(123)?$select=Code,ObjectType,IsDraft

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 https://localhost:50000/b1s/v1/ApprovalRequests

GET https://localhost:50000/b1s/v1/ApprovalRequests?$select=Code,ObjectType,IsDraft&$filter=Code 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 https://localhost:50000/b1s/v1/ApprovalRequests(123)

{
"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 https://localhost:50000/b1s/v1/ApprovalStages(123)

GET https://localhost:50000/b1s/v1/ApprovalStages(123)?$select=Code,Name,NoOfApproversRequired

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 https://localhost:50000/b1s/v1/ApprovalStages

GET https://localhost:50000/b1s/v1/ApprovalStages?$select=Code,Name,NoOfApproversRequired&$filter=Code ge 123 &$orderby=Code&$top=10&$skip

POST ApprovalStages
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ApprovalStages

{
"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 https://localhost:50000/b1s/v1/ApprovalStages(123)

{
"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 https://localhost:50000/b1s/v1/ApprovalStages(123)

POST ApprovalStages(id)/GetApprovalStage

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

Example

POST https://localhost:50000/b1s/v1/ApprovalStages(123)/GetApprovalStage

POST ApprovalStages(id)/RemoveApprovalStage

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

Example

POST https://localhost:50000/b1s/v1/ApprovalStages(123)/RemoveApprovalStage

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 https://localhost:50000/b1s/v1/ApprovalTemplates(123)

GET https://localhost:50000/b1s/v1/ApprovalTemplates(123)?$select=Code,Name,Remarks

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ApprovalTemplates

GET https://localhost:50000/b1s/v1/ApprovalTemplates?$select=Code,Name,Remarks&$filter=Code 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 https://localhost:50000/b1s/v1/ApprovalTemplates

{
"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 https://localhost:50000/b1s/v1/ApprovalTemplates(123)

{
"Remarks": "Shipping"
}

DELETE ApprovalTemplates(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ApprovalTemplates(123)

POST ApprovalTemplates(id)/GetApprovalTemplate

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

Example

POST https://localhost:50000/b1s/v1/ApprovalTemplates(123)/GetApprovalTemplate

POST ApprovalTemplates(id)/RemoveApprovalTemplate

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

Example

POST https://localhost:50000/b1s/v1/ApprovalTemplates(123)/RemoveApprovalTemplate

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetCapitalization(2)

GET https://localhost:50000/b1s/v1/AssetCapitalization(2)?$select=DocEntry,DocNum,Series

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 https://localhost:50000/b1s/v1/AssetCapitalization

GET https://localhost:50000/b1s/v1/AssetCapitalization?$select=DocEntry,DocNum,Series&$filter=DocEntry 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 https://localhost:50000/b1s/v1/AssetCapitalization

{
"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 https://localhost:50000/b1s/v1/AssetCapitalization(2)

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

AssetCapitalizationCreditMemo
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'AssetCapitalizationCreditMemo'.

GET AssetCapitalizationCreditMemo(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemo(1)

GET https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemo(1)?$select=DocEntry,DocNum,Series

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 https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemo

GET https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemo?$select=DocEntry,DocNum,Series&$filter=DocEntry ge 1 &$orderby=DocEntry&$

POST AssetCapitalizationCreditMemo

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

Example

POST https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemo

{
"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 https://localhost:50000/b1s/v1/AssetCapitalizationCreditMemo(1)

{
"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 https://localhost:50000/b1s/v1/AssetClasses('TEST')

GET https://localhost:50000/b1s/v1/AssetClasses('TEST')?$select=Code,Description,AssetType

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetClasses

GET https://localhost:50000/b1s/v1/AssetClasses?$select=Code,Description,AssetType&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/AssetClasses

{
"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 https://localhost:50000/b1s/v1/AssetClasses('TEST')

{
"AssetType": "atAssetTypeLowValueAsset",
"Description": "test AssetClasses",
"ValueLimitFrom": "600",
"ValueLimitTo": "2000"
}

DELETE AssetClasses(id)

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

Example

DELETE https://localhost:50000/b1s/v1/AssetClasses('TEST')

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.

https://186.74.156.69:50000/Service Layer API Reference.html 99/334

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

GET https://localhost:50000/b1s/v1/AssetDepreciationGroups('ADG')

GET https://localhost:50000/b1s/v1/AssetDepreciationGroups('ADG')?$select=Code,Description,Group

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 https://localhost:50000/b1s/v1/AssetDepreciationGroups

GET https://localhost:50000/b1s/v1/AssetDepreciationGroups?$select=Code,Description,Group&$filter=startswith(Code, 'ADG') &$orderby=Code&$

POST AssetDepreciationGroups

Create an instance of 'AssetDepreciationGroups' with the given payload of type 'AssetDepreciationGroup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/AssetDepreciationGroups

{
"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 https://localhost:50000/b1s/v1/AssetDepreciationGroups('ADG')

{
"Description": "test",
"Group": "Group123"
}

DELETE AssetDepreciationGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/AssetDepreciationGroups('ADG')

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 https://localhost:50000/b1s/v1/AssetGroups('AG')

GET https://localhost:50000/b1s/v1/AssetGroups('AG')?$select=Code,Description

GET AssetGroups
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetGroups

GET https://localhost:50000/b1s/v1/AssetGroups?$select=Code,Description&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/AssetGroups

{
"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 https://localhost:50000/b1s/v1/AssetGroups('AG')

{
"Description": "test1"
}

DELETE AssetGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/AssetGroups('AG')

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 https://localhost:50000/b1s/v1/AssetManualDepreciation(2)

GET https://localhost:50000/b1s/v1/AssetManualDepreciation(2)select=DocEntry,DocNum,Series

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 https://localhost:50000/b1s/v1/AssetManualDepreciation

GET https://localhost:50000/b1s/v1/AssetManualDepreciation?$select=DocEntry,DocNum,Series&$filter=DocEntry ge 2 &$orderby=DocEntry&$top=10

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetManualDepreciation

{
"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 https://localhost:50000/b1s/v1/AssetManualDepreciation(2)

{
"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 https://localhost:50000/b1s/v1/AssetRetirement(9)

GET https://localhost:50000/b1s/v1/AssetRetirement(9)?$select=DocEntry,DocNum,Series

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 https://localhost:50000/b1s/v1/AssetRetirement

GET https://localhost:50000/b1s/v1/AssetRetirement?$select=DocEntry,DocNum,Series&$filter=DocEntry 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.
https://186.74.156.69:50000/Service Layer API Reference.html 102/334
6/7/24, 15:42 Service Layer API Reference
Example

POST https://localhost:50000/b1s/v1/AssetRetirement

{
"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 https://localhost:50000/b1s/v1/AssetRetirement(9)

{
"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 https://localhost:50000/b1s/v1/AssetTransfer(2)

GET https://localhost:50000/b1s/v1/AssetTransfer(2)?$select=DocEntry,DocNum,Series

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 https://localhost:50000/b1s/v1/AssetTransfer

GET https://localhost:50000/b1s/v1/AssetTransfer?$select=DocEntry,DocNum,Series&$filter=DocEntry 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 https://localhost:50000/b1s/v1/AssetTransfer

{
"AssetDocumentLineCollection": [
{
"AssetNumber": "FA4",
"NewAssetNumber": "FA3"
}
],
"AssetValueDate": "2017-01-01",

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AssetTransfer(2)

{
"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 https://localhost:50000/b1s/v1/Attachments2(123)

GET https://localhost:50000/b1s/v1/Attachments2(123)?$select=AbsoluteEntry,Attachments2_Lines

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 https://localhost:50000/b1s/v1/Attachments2

GET https://localhost:50000/b1s/v1/Attachments2?$select=AbsoluteEntry,Attachments2_Lines&$filter=AbsoluteEntry ge 123 &$orderby=AbsoluteEn

POST Attachments2

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

Example

POST https://localhost:50000/b1s/v1/Attachments2

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 104/334

6/7/24, 15:42 Service Layer API Reference
PATCH https://localhost:50000/b1s/v1/Attachments2(123)

{
"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 https://localhost:50000/b1s/v1/Attachments2(123)

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 https://localhost:50000/b1s/v1/AttributeGroups(1)

GET https://localhost:50000/b1s/v1/AttributeGroups(1)?$select=Code,Name,Locked

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 https://localhost:50000/b1s/v1/AttributeGroups

GET https://localhost:50000/b1s/v1/AttributeGroups?$select=Code,Name,Locked&$filter=Code 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 https://localhost:50000/b1s/v1/AttributeGroups

{
"AttributeGroupCollection": [
{
"AttributeID": 1,
"AttributeName": "test 1",
"DefaultValue": "5"
},
{
"AttributeID": 2,
"AttributeName": "test 2",
"DefaultValue": "6"
}
],
"Code": 1,

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/AttributeGroups(1)

{
"AttributeGroupCollection": [
{
"AttributeID": 1,
"AttributeName": "test 123",
"DefaultValue": "123",
"SortNumber": 1
}
]
}

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

Example

DELETE https://localhost:50000/b1s/v1/AttributeGroups(1)

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 https://localhost:50000/b1s/v1/BankChargesAllocationCodes('001')

GET https://localhost:50000/b1s/v1/BankChargesAllocationCodes('001')?$select=Code,Description

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 https://localhost:50000/b1s/v1/BankChargesAllocationCodes

GET https://localhost:50000/b1s/v1/BankChargesAllocationCodes?$select=Code,Description&$filter=startswith(Code, 'a') &$orderby=Code&$top=1

POST BankChargesAllocationCodes

Create an instance of 'BankChargesAllocationCodes' with the given payload of type 'BankChargesAllocationCode' in JSON format.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 106/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/BankChargesAllocationCodes

{
"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 https://localhost:50000/b1s/v1/BankChargesAllocationCodes('001')

{
"Description": "updated by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/BankChargesAllocationCodes('001')

POST BankChargesAllocationCodes(id)/SetDefaultBankChargesAllocationCode
Invoke the method 'SetDefaultBankChargesAllocationCode' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/BankChargesAllocationCodes('001')/SetDefaultBankChargesAllocationCode

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 https://localhost:50000/b1s/v1/BankPages(AccountCode='abc',Sequence=123)

GET https://localhost:50000/b1s/v1/BankPages(AccountCode='abc',Sequence=123)?$select=AccountCode,Sequence,AccountName

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 https://localhost:50000/b1s/v1/BankPages

GET https://localhost:50000/b1s/v1/BankPages?$select=AccountCode,Sequence,AccountName&$filter=startswith(AccountCode, 'a') and Sequence ge

POST BankPages

Create an instance of 'BankPages' with the given payload of type 'BankPage' in JSON format.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 107/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/BankPages

{
"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 https://localhost:50000/b1s/v1/BankPages(AccountCode='abc',Sequence=123)

{
"PaymentReference": "Pay reference 01"
}

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

Example

DELETE https://localhost:50000/b1s/v1/BankPages(AccountCode='abc',Sequence=123)

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 https://localhost:50000/b1s/v1/Banks(123)

GET https://localhost:50000/b1s/v1/Banks(123)?$select=BankCode,BankName,AccountforOutgoingChecks

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 https://localhost:50000/b1s/v1/Banks

GET https://localhost:50000/b1s/v1/Banks?$select=BankCode,BankName,AccountforOutgoingChecks&$filter=AbsoluteEntry ge 123 &$orderby=Absolut

POST Banks

Create an instance of 'Banks' with the given payload of type 'Bank' in JSON format.

Example

POST https://localhost:50000/b1s/v1/Banks

{
"BankCode": "b001",
"BankName": "US National Bank",
"CountryCode": "US",
"SwiftNo": "123456789"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Banks(123)

{
"BankName": "US Bank"
}

DELETE Banks(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Banks(123)

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 https://localhost:50000/b1s/v1/BankStatements(2)

GET https://localhost:50000/b1s/v1/BankStatements(2)?$select=InternalNumber,BankAccountKey,StatementNumber

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 https://localhost:50000/b1s/v1/BankStatements

GET https://localhost:50000/b1s/v1/BankStatements?$select=InternalNumber,BankAccountKey,StatementNumber&$filter=InternalNumber ge 2 &$orde

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

Example

POST https://localhost:50000/b1s/v1/BankStatements

{
"BankAccountKey ": 1,
"BankStatementRows": [
{
"ExternalCode": "E1"
}
],
"MultiplePayments": [
{
"AmountFC": 20,
"IsDebit": "tYES"
}
]
}

PATCH BankStatements(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BankStatements(2)

{
"Currency": "USD"
}

DELETE BankStatements(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BankStatements(2)

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 https://localhost:50000/b1s/v1/BarCodes(123)

GET https://localhost:50000/b1s/v1/BarCodes(123)?$select=AbsEntry,ItemNo,UoMEntry

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 https://localhost:50000/b1s/v1/BarCodes

GET https://localhost:50000/b1s/v1/BarCodes?$select=AbsEntry,ItemNo,UoMEntry&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/BarCodes

{
"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 https://localhost:50000/b1s/v1/BarCodes(123)

{
"Barcode": "500001"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BarCodes(123)

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 https://localhost:50000/b1s/v1/BatchNumberDetails(123)

GET https://localhost:50000/b1s/v1/BatchNumberDetails(123)?$select=DocEntry,ItemCode,ItemDescription

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 https://localhost:50000/b1s/v1/BatchNumberDetails

GET https://localhost:50000/b1s/v1/BatchNumberDetails?$select=DocEntry,ItemCode,ItemDescription&$filter=DocEntry 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 https://localhost:50000/b1s/v1/BatchNumberDetails(123)

{
"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 https://localhost:50000/b1s/v1/BillOfExchangeTransactions(123)

GET https://localhost:50000/b1s/v1/BillOfExchangeTransactions(123)?$select=StatusFrom,StatusTo,TransactionDate

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BillOfExchangeTransactions

GET https://localhost:50000/b1s/v1/BillOfExchangeTransactions?$select=StatusFrom,StatusTo,TransactionDate&$filter=BOETransactionkey ge 123

POST BillOfExchangeTransactions

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

Example

POST https://localhost:50000/b1s/v1/BillOfExchangeTransactions

{
"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 https://localhost:50000/b1s/v1/BinLocationAttributes(123)

GET https://localhost:50000/b1s/v1/BinLocationAttributes(123)?$select=Attribute,Code,AbsEntry

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 https://localhost:50000/b1s/v1/BinLocationAttributes

GET https://localhost:50000/b1s/v1/BinLocationAttributes?$select=Attribute,Code,AbsEntry&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/BinLocationAttributes

{
"AbsEntry": 3,
"Attribute": 5,
"Code": "BinAttr03"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BinLocationAttributes(123)

{
"Code": "BinAttr0212"
}

DELETE BinLocationAttributes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BinLocationAttributes(123)

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 https://localhost:50000/b1s/v1/BinLocationFields(123)

GET https://localhost:50000/b1s/v1/BinLocationFields(123)?$select=AbsEntry,FieldType,FieldNumber

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 https://localhost:50000/b1s/v1/BinLocationFields

GET https://localhost:50000/b1s/v1/BinLocationFields?$select=AbsEntry,FieldType,FieldNumber&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/BinLocationFields(123)

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 113/334

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

GET https://localhost:50000/b1s/v1/BinLocations(123)

GET https://localhost:50000/b1s/v1/BinLocations(123)?$select=AbsEntry,Warehouse,Sublevel1

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 https://localhost:50000/b1s/v1/BinLocations

GET https://localhost:50000/b1s/v1/BinLocations?$select=AbsEntry,Warehouse,Sublevel1&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/BinLocations

{
"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 https://localhost:50000/b1s/v1/BinLocations(123)

{
"Description": "updated from sl"
}

DELETE BinLocations(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BinLocations(123)

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 https://localhost:50000/b1s/v1/BlanketAgreements(123)

GET https://localhost:50000/b1s/v1/BlanketAgreements(123)?$select=AgreementNo,BPCode,BPName

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BlanketAgreements

GET https://localhost:50000/b1s/v1/BlanketAgreements?$select=AgreementNo,BPCode,BPName&$filter=AgreementNo ge 123 &$orderby=AgreementNo&$t

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

Example

POST https://localhost:50000/b1s/v1/BlanketAgreements

{
"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 https://localhost:50000/b1s/v1/BlanketAgreements(123)

{
"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 https://localhost:50000/b1s/v1/BlanketAgreements(123)/CancelBlanketAgreement

POST BlanketAgreements(id)/GetRelatedDocuments
Invoke the method 'GetRelatedDocuments' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/BlanketAgreements(123)/GetRelatedDocuments

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BOEDocumentTypes(1)

GET https://localhost:50000/b1s/v1/BOEDocumentTypes(1)?$select=DocEntry,DocType,DocDescription

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 https://localhost:50000/b1s/v1/BOEDocumentTypes

GET https://localhost:50000/b1s/v1/BOEDocumentTypes?$select=DocEntry,DocType,DocDescription&$filter=DocEntry ge 123 &$orderby=DocEntry&$to

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

Example

POST https://localhost:50000/b1s/v1/BOEDocumentTypes

{
"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 https://localhost:50000/b1s/v1/BOEDocumentTypes(1)

{
"DocDescription": "testing",
"DocType": "11"
}

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

Example

DELETE https://localhost:50000/b1s/v1/BOEDocumentTypes(1)

BOEInstructions
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'BOEInstructions'.

GET BOEInstructions(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BOEInstructions(1)

GET https://localhost:50000/b1s/v1/BOEInstructions(1)?$select=InstructionEntry,InstructionCode,InstructionDesc

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 https://localhost:50000/b1s/v1/BOEInstructions

GET https://localhost:50000/b1s/v1/BOEInstructions?$select=InstructionEntry,InstructionCode,InstructionDesc&$filter=InstructionEntry ge 12

POST BOEInstructions

Create an instance of 'BOEInstructions' with the given payload of type 'BOEInstruction' in JSON format.

Example

POST https://localhost:50000/b1s/v1/BOEInstructions

{
"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 https://localhost:50000/b1s/v1/BOEInstructions(1)

{
"InstructionCode": "02",
"InstructionDesc": "02",
"IsCancelInstruction": "tNO"
}

DELETE BOEInstructions(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BOEInstructions(1)

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 https://localhost:50000/b1s/v1/BOEPortfolios(123)

GET https://localhost:50000/b1s/v1/BOEPortfolios(123)?$select=PortfolioEntry,PortfolioID,PortfolioCode

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BOEPortfolios

GET https://localhost:50000/b1s/v1/BOEPortfolios?$select=PortfolioEntry,PortfolioID,PortfolioCode&$filter=PortfolioEntry ge 123 &$orderby=

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

Example

POST https://localhost:50000/b1s/v1/BOEPortfolios

{
"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 https://localhost:50000/b1s/v1/BOEPortfolios(123)

{
"PortfolioCode": "02",
"PortfolioDescription": "02",
"PortfolioID": "02",
"PortfolioNum": "02"
}

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

Example

DELETE https://localhost:50000/b1s/v1/BOEPortfolios(123)

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 https://localhost:50000/b1s/v1/BPPriorities(123)

GET https://localhost:50000/b1s/v1/BPPriorities(123)?$select=Priority,PriorityDescription

GET BPPriorities

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

https://186.74.156.69:50000/Service Layer API Reference.html 118/334

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

GET https://localhost:50000/b1s/v1/BPPriorities

GET https://localhost:50000/b1s/v1/BPPriorities?$select=Priority,PriorityDescription&$filter=Priority 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 https://localhost:50000/b1s/v1/BPPriorities

{
"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 https://localhost:50000/b1s/v1/BPPriorities(123)

{
"PriorityDescription": "HighPri"
}

DELETE BPPriorities(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BPPriorities(123)

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 https://localhost:50000/b1s/v1/Branches(123)

GET https://localhost:50000/b1s/v1/Branches(123)?$select=Code,Name,Description

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 https://localhost:50000/b1s/v1/Branches

GET https://localhost:50000/b1s/v1/Branches?$select=Code,Name,Description&$filter=Code ge 123 &$orderby=Code&$top=10&$skip=1

POST Branches

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Branches

{
"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 https://localhost:50000/b1s/v1/Branches(123)

{
"Description": "Main Branch updated"
}

DELETE Branches(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Branches(123)

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 https://localhost:50000/b1s/v1/BrazilBeverageIndexers(847)

GET https://localhost:50000/b1s/v1/BrazilBeverageIndexers(847)?$select=BeverageGroupCode,BeverageTableCode,BeverageCommercialBrandCode

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 https://localhost:50000/b1s/v1/BrazilBeverageIndexers

GET https://localhost:50000/b1s/v1/BrazilBeverageIndexers?$select=BeverageGroupCode,BeverageTableCode,BeverageCommercialBrandCode&$filter=

POST BrazilBeverageIndexers

Create an instance of 'BrazilBeverageIndexers' with the given payload of type 'BrazilBeverageIndexer' in JSON format.

Example

POST https://localhost:50000/b1s/v1/BrazilBeverageIndexers

{
"BeverageCommercialBrandCode": 52,
"BeverageGroupCode": "13",
"BeverageTableCode": "07"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BrazilBeverageIndexers(847)

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 https://localhost:50000/b1s/v1/BrazilFuelIndexers(797)

GET https://localhost:50000/b1s/v1/BrazilFuelIndexers(797)?$select=FuelID,FuelGroupCode,FuelCode

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 https://localhost:50000/b1s/v1/BrazilFuelIndexers

GET https://localhost:50000/b1s/v1/BrazilFuelIndexers?$select=FuelID,FuelGroupCode,FuelCode&$filter=FuelID 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 https://localhost:50000/b1s/v1/BrazilFuelIndexers

{
"Description": "999999999-Description",
"FuelCode": "999999999",
"FuelGroupCode": "1"
}

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

Example

DELETE https://localhost:50000/b1s/v1/BrazilFuelIndexers(797)

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.

https://186.74.156.69:50000/Service Layer API Reference.html 121/334

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

GET https://localhost:50000/b1s/v1/BrazilMultiIndexers(670)

GET https://localhost:50000/b1s/v1/BrazilMultiIndexers(670)?$select=ID,IndexerType,Code

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 https://localhost:50000/b1s/v1/BrazilMultiIndexers

GET https://localhost:50000/b1s/v1/BrazilMultiIndexers?$select=ID,IndexerType,Code&$filter=ID 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 https://localhost:50000/b1s/v1/BrazilMultiIndexers

{
"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 https://localhost:50000/b1s/v1/BrazilMultiIndexers(670)

POST BrazilMultiIndexers(id)/GetIndexerTypeList

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

Example

POST https://localhost:50000/b1s/v1/BrazilMultiIndexers(670)/GetIndexerTypeList

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 https://localhost:50000/b1s/v1/BrazilNumericIndexers(1119)

GET https://localhost:50000/b1s/v1/BrazilNumericIndexers(1119)?$select=IndexerType,Code,Description

GET BrazilNumericIndexers

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BrazilNumericIndexers

GET https://localhost:50000/b1s/v1/BrazilNumericIndexers?$select=IndexerType,Code,Description&$filter=ID 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 https://localhost:50000/b1s/v1/BrazilNumericIndexers

{
"Code": "15",
"Description": "Sociedade empres\u00e1ria em geral",
"IndexerType": "bnitNatureOfCompany"
}

DELETE BrazilNumericIndexers(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BrazilNumericIndexers(1119)

POST BrazilNumericIndexers(id)/GetIndexerTypeList

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

Example

POST https://localhost:50000/b1s/v1/BrazilNumericIndexers(1119)/GetIndexerTypeList

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 https://localhost:50000/b1s/v1/BrazilStringIndexers(849)

GET https://localhost:50000/b1s/v1/BrazilStringIndexers(849)?$select=IndexerType,Code,Description

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 https://localhost:50000/b1s/v1/BrazilStringIndexers

GET https://localhost:50000/b1s/v1/BrazilStringIndexers?$select=IndexerType,Code,Description&$filter=ID ge 849 &$orderby=ID&$top=10&$skip=

POST BrazilStringIndexers

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BrazilStringIndexers

{
"Code": "3",
"Description": "aaaaaaaa",
"IndexerType": "bsitIPIPeriod"
}

DELETE BrazilStringIndexers(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BrazilStringIndexers(849)

POST BrazilStringIndexers(id)/GetIndexerTypeList

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

Example

POST https://localhost:50000/b1s/v1/BrazilStringIndexers(849)/GetIndexerTypeList

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 https://localhost:50000/b1s/v1/BudgetDistributions(123)

GET https://localhost:50000/b1s/v1/BudgetDistributions(123)?$select=September,August,July

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 https://localhost:50000/b1s/v1/BudgetDistributions

GET https://localhost:50000/b1s/v1/BudgetDistributions?$select=September,August,July&$filter=DivisionCode ge 123 &$orderby=DivisionCode&$t

POST BudgetDistributions

Create an instance of 'BudgetDistributions' with the given payload of type 'BudgetDistribution' in JSON format.

Example

POST https://localhost:50000/b1s/v1/BudgetDistributions

{
"BudgetAmount": 1.0,
"Description": "DisRule",
"September": 1.0
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BudgetDistributions(123)

{
"Description": "Budget Distribution"
}

DELETE BudgetDistributions(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BudgetDistributions(123)

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 https://localhost:50000/b1s/v1/Budgets(123)

GET https://localhost:50000/b1s/v1/Budgets(123)?$select=FutureAnnualExpensesCreditSys,FutureAnnualExpensesCreditLoc,FutureAnnualExpensesDe

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 https://localhost:50000/b1s/v1/Budgets

GET https://localhost:50000/b1s/v1/Budgets?$select=FutureAnnualExpensesCreditSys,FutureAnnualExpensesCreditLoc,FutureAnnualExpensesDebitSy

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

Example

POST https://localhost:50000/b1s/v1/Budgets

{
"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 https://localhost:50000/b1s/v1/Budgets(123)

{
"TotalAnnualBudgetDebitLoc": "12.345"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Budgets(123)

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 https://localhost:50000/b1s/v1/BudgetScenarios(123)

GET https://localhost:50000/b1s/v1/BudgetScenarios(123)?$select=Name,InitialRatioPercentage,StartofFiscalYear

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 https://localhost:50000/b1s/v1/BudgetScenarios

GET https://localhost:50000/b1s/v1/BudgetScenarios?$select=Name,InitialRatioPercentage,StartofFiscalYear&$filter=Numerator ge 123 &$orderb

POST BudgetScenarios

Create an instance of 'BudgetScenarios' with the given payload of type 'BudgetScenario' in JSON format.

Example

POST https://localhost:50000/b1s/v1/BudgetScenarios

{
"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 https://localhost:50000/b1s/v1/BudgetScenarios(123)

{
"Name": "new2014"
}

DELETE BudgetScenarios(id)

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 126/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/BudgetScenarios(123)

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 https://localhost:50000/b1s/v1/BusinessPartnerGroups(123)

GET https://localhost:50000/b1s/v1/BusinessPartnerGroups(123)?$select=Code,Name,Type

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 https://localhost:50000/b1s/v1/BusinessPartnerGroups

GET https://localhost:50000/b1s/v1/BusinessPartnerGroups?$select=Code,Name,Type&$filter=Code 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 https://localhost:50000/b1s/v1/BusinessPartnerGroups

{
"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 https://localhost:50000/b1s/v1/BusinessPartnerGroups(123)

{
"Name": "bigCustomer"
}

DELETE BusinessPartnerGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BusinessPartnerGroups(123)

BusinessPartnerProperties
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BusinessPartnerProperties(1)

GET https://localhost:50000/b1s/v1/BusinessPartnerProperties(1)?$select=PropertyCode,PropertyName

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 https://localhost:50000/b1s/v1/BusinessPartnerProperties

GET https://localhost:50000/b1s/v1/BusinessPartnerProperties?$select=PropertyCode,PropertyName&$filter=PropertyCode 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 https://localhost:50000/b1s/v1/BusinessPartnerProperties(1)

{
"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 https://localhost:50000/b1s/v1/BusinessPartners('c001')

GET https://localhost:50000/b1s/v1/BusinessPartners('c001')?$select=CardCode,CardName,CardType

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 https://localhost:50000/b1s/v1/BusinessPartners

GET https://localhost:50000/b1s/v1/BusinessPartners?$select=CardCode,CardName,CardType&$filter=startswith(CardCode, 'a') &$orderby=CardCod

POST BusinessPartners

Create an instance of 'BusinessPartners' with the given payload of type 'BusinessPartner' in JSON format.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 128/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/BusinessPartners

{
"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 https://localhost:50000/b1s/v1/BusinessPartners('c001')

{
"CardName": "Updated customer name"
}

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

Example

DELETE https://localhost:50000/b1s/v1/BusinessPartners('c001')

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 https://localhost:50000/b1s/v1/BusinessPlaces(123)

GET https://localhost:50000/b1s/v1/BusinessPlaces(123)?$select=BPLID,BPLName,BPLNameForeign

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 https://localhost:50000/b1s/v1/BusinessPlaces

GET https://localhost:50000/b1s/v1/BusinessPlaces?$select=BPLID,BPLName,BPLNameForeign&$filter=BPLID 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 https://localhost:50000/b1s/v1/BusinessPlaces

{
"Address": "No. 1001 Chenghui road",
"BPLName": "LG",
"BPLNameForeign": "LG",
"Industry": "manufacture",
"RepName": "new LG",
"VATRegNum": "222-33-47528"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/BusinessPlaces(123)

{
"Address": "No. 101 Huaxia Road"
}

DELETE BusinessPlaces(id)

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

Example

DELETE https://localhost:50000/b1s/v1/BusinessPlaces(123)

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 https://localhost:50000/b1s/v1/CampaignResponseType('01')

GET https://localhost:50000/b1s/v1/CampaignResponseType('01')?$select=ResponseTypeDescription,ResponseType,IsActive

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 https://localhost:50000/b1s/v1/CampaignResponseType

GET https://localhost:50000/b1s/v1/CampaignResponseType?$select=ResponseTypeDescription,ResponseType,IsActive&$filter=startswith(ResponseT

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

Example

POST https://localhost:50000/b1s/v1/CampaignResponseType

{
"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 https://localhost:50000/b1s/v1/CampaignResponseType('01')

{
"IsActive": "tNO"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CampaignResponseType('01')

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 https://localhost:50000/b1s/v1/Campaigns(1)

GET https://localhost:50000/b1s/v1/Campaigns(1)?$select=CampaignNumber,CampaignName,CampaignType

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 https://localhost:50000/b1s/v1/Campaigns

GET https://localhost:50000/b1s/v1/Campaigns?$select=CampaignNumber,CampaignName,CampaignType&$filter=CampaignNumber ge 1 &$orderby=Campai

POST Campaigns

Create an instance of 'Campaigns' with the given payload of type 'Campaign' in JSON format.

Example

POST https://localhost:50000/b1s/v1/Campaigns

{
"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 https://localhost:50000/b1s/v1/Campaigns(1)

{
"StartDate": "2016-10-30"
}

DELETE Campaigns(id)
https://186.74.156.69:50000/Service Layer API Reference.html 131/334
6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'Campaigns' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/Campaigns(1)

POST Campaigns(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/Campaigns(1)/Cancel

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 https://localhost:50000/b1s/v1/CashDiscounts('EPDiscount')

GET https://localhost:50000/b1s/v1/CashDiscounts('EPDiscount')?$select=Code,Name,ByDate

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 https://localhost:50000/b1s/v1/CashDiscounts

GET https://localhost:50000/b1s/v1/CashDiscounts?$select=Code,Name,ByDate&$filter=startswith(Code, '') &$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 https://localhost:50000/b1s/v1/CashDiscounts

{
"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)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CashDiscounts('EPDiscount')

{
"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 https://localhost:50000/b1s/v1/CashDiscounts('EPDiscount')

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 https://localhost:50000/b1s/v1/CashFlowLineItems(2)

GET https://localhost:50000/b1s/v1/CashFlowLineItems(2)?$select=LineItemID,LineItemName,ActiveLineItem

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 https://localhost:50000/b1s/v1/CashFlowLineItems

GET https://localhost:50000/b1s/v1/CashFlowLineItems?$select=LineItemID,LineItemName,ActiveLineItem&$filter=LineItemID 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.

https://186.74.156.69:50000/Service Layer API Reference.html 133/334

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

GET https://localhost:50000/b1s/v1/CertificateSeries(123)

GET https://localhost:50000/b1s/v1/CertificateSeries(123)?$select=AbsEntry,Code,Section

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 https://localhost:50000/b1s/v1/CertificateSeries

GET https://localhost:50000/b1s/v1/CertificateSeries?$select=AbsEntry,Code,Section&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/CertificateSeries

{
"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 https://localhost:50000/b1s/v1/CertificateSeries(123)

{
"Code": "C123"
}

DELETE CertificateSeries(id)

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

Example

DELETE https://localhost:50000/b1s/v1/CertificateSeries(123)

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.

https://186.74.156.69:50000/Service Layer API Reference.html 134/334

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

GET https://localhost:50000/b1s/v1/ChartOfAccounts('abc')

GET https://localhost:50000/b1s/v1/ChartOfAccounts('abc')?$select=Code,Name,Balance

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 https://localhost:50000/b1s/v1/ChartOfAccounts

GET https://localhost:50000/b1s/v1/ChartOfAccounts?$select=Code,Name,Balance&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/ChartOfAccounts

{
"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 https://localhost:50000/b1s/v1/ChartOfAccounts('abc')

{
"Name": "Updated Account"
}

DELETE ChartOfAccounts(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ChartOfAccounts('abc')

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 https://localhost:50000/b1s/v1/ChecksforPayment(123)

GET https://localhost:50000/b1s/v1/ChecksforPayment(123)?$select=CheckKey,CheckNumber,BankCode

GET ChecksforPayment

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ChecksforPayment

GET https://localhost:50000/b1s/v1/ChecksforPayment?$select=CheckKey,CheckNumber,BankCode&$filter=CheckKey ge 123 &$orderby=CheckKey&$top=

POST ChecksforPayment

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

Example

POST https://localhost:50000/b1s/v1/ChecksforPayment

{
"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 https://localhost:50000/b1s/v1/ChecksforPayment(123)

{
"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 https://localhost:50000/b1s/v1/ChooseFromList('ITM1')

GET https://localhost:50000/b1s/v1/ChooseFromList('ITM1')?$select=ObjectName,ChooseFromList_Lines

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 https://localhost:50000/b1s/v1/ChooseFromList

GET https://localhost:50000/b1s/v1/ChooseFromList?$select=ObjectName,ChooseFromList_Lines&$filter=startswith(ObjectName, 'a') &$orderby=Ob

POST ChooseFromList

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ChooseFromList

{
"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 https://localhost:50000/b1s/v1/ChooseFromList('ITM1')

{
"ChooseFromList_Lines": [
{
"FieldNo": "1",
"Visible": "tYES"
}
]
}

DELETE ChooseFromList(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ChooseFromList('ITM1')

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 https://localhost:50000/b1s/v1/Cockpits(123)

GET https://localhost:50000/b1s/v1/Cockpits(123)?$select=AbsEntry,Code,Name

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 https://localhost:50000/b1s/v1/Cockpits

GET https://localhost:50000/b1s/v1/Cockpits?$select=AbsEntry,Code,Name&$filter=AbsEntry ge 123 &$orderby=AbsEntry&$top=10&$skip=1

POST Cockpits

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Cockpits

{
"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 https://localhost:50000/b1s/v1/Cockpits(123)

{
"Description": "test"
}

DELETE Cockpits(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Cockpits(123)

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 https://localhost:50000/b1s/v1/CommissionGroups(123)

GET https://localhost:50000/b1s/v1/CommissionGroups(123)?$select=CommissionGroupCode,CommissionGroupName,CommissionPercentage

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 https://localhost:50000/b1s/v1/CommissionGroups

GET https://localhost:50000/b1s/v1/CommissionGroups?$select=CommissionGroupCode,CommissionGroupName,CommissionPercentage&$filter=Commissio

POST CommissionGroups

Create an instance of 'CommissionGroups' with the given payload of type 'CommissionGroup' in JSON format.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 138/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/CommissionGroups

{
"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 https://localhost:50000/b1s/v1/CommissionGroups(123)

{
"CommissionPercentage": "28"
}

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

Example

DELETE https://localhost:50000/b1s/v1/CommissionGroups(123)

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 https://localhost:50000/b1s/v1/Contacts(123)

GET https://localhost:50000/b1s/v1/Contacts(123)?$select=CardCode,Notes,ContactDate

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 https://localhost:50000/b1s/v1/Contacts

GET https://localhost:50000/b1s/v1/Contacts?$select=CardCode,Notes,ContactDate&$filter=ContactCode 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 https://localhost:50000/b1s/v1/Contacts

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 139/334

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

PATCH https://localhost:50000/b1s/v1/Contacts(123)

{
"Details": "follow up meeting"
}

DELETE Contacts(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Contacts(123)

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 https://localhost:50000/b1s/v1/ContractTemplates('newTemplate')

GET https://localhost:50000/b1s/v1/ContractTemplates('newTemplate')?$select=TemplateName,TemplateIsDeleted,TemplateIsRenewal

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 https://localhost:50000/b1s/v1/ContractTemplates

GET https://localhost:50000/b1s/v1/ContractTemplates?$select=TemplateName,TemplateIsDeleted,TemplateIsRenewal&$filter=startswith(TemplateN

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

Example

POST https://localhost:50000/b1s/v1/ContractTemplates

{
"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 https://localhost:50000/b1s/v1/ContractTemplates('newTemplate')

{
"Details": "new service contract template"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ContractTemplates('newTemplate')

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 https://localhost:50000/b1s/v1/CorrectionInvoice(123)

GET https://localhost:50000/b1s/v1/CorrectionInvoice(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/CorrectionInvoice

GET https://localhost:50000/b1s/v1/CorrectionInvoice?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/CorrectionInvoice

{
"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 https://localhost:50000/b1s/v1/CorrectionInvoice(123)

{
"Comments": "new comments - modified by Service Layer"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CorrectionInvoice(123)/Close

POST CorrectionInvoice(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CorrectionInvoice(123)/Cancel

POST CorrectionInvoice(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CorrectionInvoice(123)/Reopen

POST CorrectionInvoice(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CorrectionInvoice(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/CorrectionInvoiceReversal(123)

GET https://localhost:50000/b1s/v1/CorrectionInvoiceReversal(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/CorrectionInvoiceReversal

GET https://localhost:50000/b1s/v1/CorrectionInvoiceReversal?$select=DocEntry,DocNum,DocType&$filter=DocEntry ge 123 &$orderby=DocEntry&$t

POST CorrectionInvoiceReversal

Create an instance of 'CorrectionInvoiceReversal' with the given payload of type 'Document' in JSON format.

https://186.74.156.69:50000/Service Layer API Reference.html 142/334

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

POST https://localhost:50000/b1s/v1/CorrectionInvoiceReversal

{
"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 https://localhost:50000/b1s/v1/CorrectionInvoiceReversal(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST CorrectionInvoiceReversal(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/CorrectionInvoiceReversal(123)/Close

POST CorrectionInvoiceReversal(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/CorrectionInvoiceReversal(123)/Cancel

POST CorrectionInvoiceReversal(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/CorrectionInvoiceReversal(123)/Reopen

POST CorrectionInvoiceReversal(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/CorrectionInvoiceReversal(123)/CreateCancellationDocument

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

https://186.74.156.69:50000/Service Layer API Reference.html 143/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice(123)

GET https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice

GET https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice?$select=DocEntry,DocNum,DocType&$filter=DocEntry ge 123 &$orderby=DocEntry&$t

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

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice

{
"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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST CorrectionPurchaseInvoice(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice(123)/Close

POST CorrectionPurchaseInvoice(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice(123)/Cancel

POST CorrectionPurchaseInvoice(id)/Reopen

https://186.74.156.69:50000/Service Layer API Reference.html 144/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice(123)/Reopen

POST CorrectionPurchaseInvoice(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoice(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal(123)

GET https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal

GET https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal?$select=DocEntry,DocNum,DocType&$filter=DocEntry ge 123 &$orderby=Doc

POST CorrectionPurchaseInvoiceReversal

Create an instance of 'CorrectionPurchaseInvoiceReversal' with the given payload of type 'Document' in JSON format.

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal

{
"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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal(123)

{
"Comments": "new comments - modified by Service Layer"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal(123)/Close

POST CorrectionPurchaseInvoiceReversal(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal(123)/Cancel

POST CorrectionPurchaseInvoiceReversal(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal(123)/Reopen

POST CorrectionPurchaseInvoiceReversal(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/CorrectionPurchaseInvoiceReversal(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/CostCenterTypes('test')

GET https://localhost:50000/b1s/v1/CostCenterTypes('test')?$select=CostCenterTypeCode,CostCenterTypeName

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 https://localhost:50000/b1s/v1/CostCenterTypes

GET https://localhost:50000/b1s/v1/CostCenterTypes?$select=CostCenterTypeCode,CostCenterTypeName&$filter=startswith(CostCenterTypeCode, 't

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 146/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/CostCenterTypes

{
"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 https://localhost:50000/b1s/v1/CostCenterTypes('test')

{
"CostCenterTypeName": "123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/CostCenterTypes('test')

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 https://localhost:50000/b1s/v1/CostElements('abc')

GET https://localhost:50000/b1s/v1/CostElements('abc')?$select=Code,Description,IsActive

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 https://localhost:50000/b1s/v1/CostElements

GET https://localhost:50000/b1s/v1/CostElements?$select=Code,Description,IsActive&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/CostElements

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 147/334

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

PATCH https://localhost:50000/b1s/v1/CostElements('CE 01')

{
"Description": "Cost Element 000001",
"IsActive": "tNO"
}

DELETE CostElements(id)

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

Example

DELETE https://localhost:50000/b1s/v1/CostElements('abc')

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 https://localhost:50000/b1s/v1/Countries('NC')

GET https://localhost:50000/b1s/v1/Countries('NC')?$select=Code,Name,CodeForReports

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 https://localhost:50000/b1s/v1/Countries

GET https://localhost:50000/b1s/v1/Countries?$select=Code,Name,CodeForReports&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/Countries

{
"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 https://localhost:50000/b1s/v1/Countries('NC')

{
"Details": "created new country"
}

DELETE Countries(id)

https://186.74.156.69:50000/Service Layer API Reference.html 148/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'Countries' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/Countries('NC')

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 https://localhost:50000/b1s/v1/CreditCardPayments('code01')

GET https://localhost:50000/b1s/v1/CreditCardPayments('code01')?$select=DueDateCode,DueDateName,DueDatesType

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 https://localhost:50000/b1s/v1/CreditCardPayments

GET https://localhost:50000/b1s/v1/CreditCardPayments?$select=DueDateCode,DueDateName,DueDatesType&$filter=startswith(DueDateCode, 'a') &$

POST CreditCardPayments

Create an instance of 'CreditCardPayments' with the given payload of type 'CreditCardPayment' in JSON format.

Example

POST https://localhost:50000/b1s/v1/CreditCardPayments

{
"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 https://localhost:50000/b1s/v1/CreditCardPayments('code01')

{
"DueDateName": "15 days"
}

DELETE CreditCardPayments(id)

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

Example

DELETE https://localhost:50000/b1s/v1/CreditCardPayments('code01')

CreditCards

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CreditCards(123)

GET https://localhost:50000/b1s/v1/CreditCards(123)?$select=CreditCardCode,CreditCardName,GLAccount

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 https://localhost:50000/b1s/v1/CreditCards

GET https://localhost:50000/b1s/v1/CreditCards?$select=CreditCardCode,CreditCardName,GLAccount&$filter=CreditCardCode ge 123 &$orderby=Cre

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

Example

POST https://localhost:50000/b1s/v1/CreditCards

{
"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 https://localhost:50000/b1s/v1/CreditCards(123)

{
"CreditCardName": "Updated Name"
}

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

Example

DELETE https://localhost:50000/b1s/v1/CreditCards(123)

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)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CreditNotes(123)

GET https://localhost:50000/b1s/v1/CreditNotes(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/CreditNotes

GET https://localhost:50000/b1s/v1/CreditNotes?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/CreditNotes

{
"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 https://localhost:50000/b1s/v1/CreditNotes(123)

{
"Comments": "new comments - modified by Service Layer"
}

DELETE CreditNotes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/CreditNotes(123)

POST CreditNotes(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/CreditNotes(123)/Close

POST CreditNotes(id)/Cancel

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 151/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/CreditNotes(123)/Cancel

POST CreditNotes(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CreditNotes(123)/Reopen

POST CreditNotes(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/CreditNotes(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/CreditPaymentMethods(123)

GET https://localhost:50000/b1s/v1/CreditPaymentMethods(123)?$select=PaymentMethodCode,Name,AssignedtoCreditCard

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 https://localhost:50000/b1s/v1/CreditPaymentMethods

GET https://localhost:50000/b1s/v1/CreditPaymentMethods?$select=PaymentMethodCode,Name,AssignedtoCreditCard&$filter=PaymentMethodCode ge 1

POST CreditPaymentMethods

Create an instance of 'CreditPaymentMethods' with the given payload of type 'CreditPaymentMethod' in JSON format.

Example

POST https://localhost:50000/b1s/v1/CreditPaymentMethods

{
"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 https://localhost:50000/b1s/v1/CreditPaymentMethods(123)

{
"MinimumPaymentAmount": "100.11"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CreditPaymentMethods(123)

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 https://localhost:50000/b1s/v1/Currencies('CNY')

GET https://localhost:50000/b1s/v1/Currencies('CNY')?$select=Code,Name,DocumentsCode

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 https://localhost:50000/b1s/v1/Currencies

GET https://localhost:50000/b1s/v1/Currencies?$select=Code,Name,DocumentsCode&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/Currencies

{
"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 https://localhost:50000/b1s/v1/Currencies('CNY')

{
"Name": "UpdatedCurrencyName"
}

DELETE Currencies(id)

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 153/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/Currencies('CNY')

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 https://localhost:50000/b1s/v1/CustomerEquipmentCards(123)

GET https://localhost:50000/b1s/v1/CustomerEquipmentCards(123)?$select=EquipmentCardNum,CustomerCode,CustomerName

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 https://localhost:50000/b1s/v1/CustomerEquipmentCards

GET https://localhost:50000/b1s/v1/CustomerEquipmentCards?$select=EquipmentCardNum,CustomerCode,CustomerName&$filter=EquipmentCardNum ge 1

POST CustomerEquipmentCards

Create an instance of 'CustomerEquipmentCards' with the given payload of type 'CustomerEquipmentCard' in JSON format.

Example

POST https://localhost:50000/b1s/v1/CustomerEquipmentCards

{
"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 https://localhost:50000/b1s/v1/CustomerEquipmentCards(123)

{
"InstallLocation": "new US Location"
}

DELETE CustomerEquipmentCards(id)

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

Example

DELETE https://localhost:50000/b1s/v1/CustomerEquipmentCards(123)

CustomsDeclaration
Show/Hide

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/CustomsDeclaration('2')

GET https://localhost:50000/b1s/v1/CustomsDeclaration('2')?$select=CCDNum,Date,CustomsBroker

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 https://localhost:50000/b1s/v1/CustomsDeclaration

GET https://localhost:50000/b1s/v1/CustomsDeclaration?$select=CCDNum,Date,CustomsBroker&$filter=startswith(CCDNum, '2') &$orderby=CCDNum&$

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

Example

POST https://localhost:50000/b1s/v1/CustomsDeclaration

{
"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 https://localhost:50000/b1s/v1/CustomsDeclaration('2')

{
"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 https://localhost:50000/b1s/v1/CustomsGroups(123)

https://186.74.156.69:50000/Service Layer API Reference.html 155/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/CustomsGroups(123)?$select=Code,Name,Number

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 https://localhost:50000/b1s/v1/CustomsGroups

GET https://localhost:50000/b1s/v1/CustomsGroups?$select=Code,Name,Number&$filter=Code 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 https://localhost:50000/b1s/v1/CustomsGroups

{
"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 https://localhost:50000/b1s/v1/CustomsGroups(123)

{
"Name": "Custom exempt"
}

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

Example

DELETE https://localhost:50000/b1s/v1/CustomsGroups(123)

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 https://localhost:50000/b1s/v1/CycleCountDeterminations('abc')

GET https://localhost:50000/b1s/v1/CycleCountDeterminations('abc')?$select=WarehouseCode,CycleBy,CycleCountDeterminationSetupCollection

GET CycleCountDeterminations

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

https://186.74.156.69:50000/Service Layer API Reference.html 156/334

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

GET https://localhost:50000/b1s/v1/CycleCountDeterminations

GET https://localhost:50000/b1s/v1/CycleCountDeterminations?$select=WarehouseCode,CycleBy,CycleCountDeterminationSetupCollection&$filter=s

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 https://localhost:50000/b1s/v1/CycleCountDeterminations('abc')

{
"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 https://localhost:50000/b1s/v1/DeductionTaxGroups(123)

GET https://localhost:50000/b1s/v1/DeductionTaxGroups(123)?$select=GroupKey,GroupCode,GroupName

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 https://localhost:50000/b1s/v1/DeductionTaxGroups

GET https://localhost:50000/b1s/v1/DeductionTaxGroups?$select=GroupKey,GroupCode,GroupName&$filter=GroupKey ge 123 &$orderby=GroupKey&$top

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

Example

POST https://localhost:50000/b1s/v1/DeductionTaxGroups

{
"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 https://localhost:50000/b1s/v1/DeductionTaxGroups(123)

{
"GroupName": "Group 02"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DeductionTaxGroups(123)

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 https://localhost:50000/b1s/v1/DeductionTaxHierarchies(123)

GET https://localhost:50000/b1s/v1/DeductionTaxHierarchies(123)?$select=AbsEntry,BPCode,HierarchyCode

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 https://localhost:50000/b1s/v1/DeductionTaxHierarchies

GET https://localhost:50000/b1s/v1/DeductionTaxHierarchies?$select=AbsEntry,BPCode,HierarchyCode&$filter=AbsEntry ge 123 &$orderby=AbsEntr

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

Example

POST https://localhost:50000/b1s/v1/DeductionTaxHierarchies

{
"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 https://localhost:50000/b1s/v1/DeductionTaxHierarchies(123)

{
"HierarchyName": "vendor hierarchy group"
}

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

https://186.74.156.69:50000/Service Layer API Reference.html 158/334

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

DELETE https://localhost:50000/b1s/v1/DeductionTaxHierarchies(123)

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 https://localhost:50000/b1s/v1/DeductionTaxSubGroups('99')

GET https://localhost:50000/b1s/v1/DeductionTaxSubGroups('99')?$select=GroupCode,GroupName

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 https://localhost:50000/b1s/v1/DeductionTaxSubGroups

GET https://localhost:50000/b1s/v1/DeductionTaxSubGroups?$select=GroupCode,GroupName&$filter=startswith(GroupCode, '99') &$orderby=GroupCo

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

Example

POST https://localhost:50000/b1s/v1/DeductionTaxSubGroups

{
"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 https://localhost:50000/b1s/v1/DeductionTaxSubGroups('99')

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 159/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/DeliveryNotes(123)

GET https://localhost:50000/b1s/v1/DeliveryNotes(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/DeliveryNotes

GET https://localhost:50000/b1s/v1/DeliveryNotes?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/DeliveryNotes

{
"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 https://localhost:50000/b1s/v1/DeliveryNotes(123)

{
"Comments": "new comments - modified by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/DeliveryNotes(123)

POST DeliveryNotes(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/DeliveryNotes(123)/Close

POST DeliveryNotes(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/DeliveryNotes(123)/Cancel

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DeliveryNotes(123)/Reopen

POST DeliveryNotes(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/DeliveryNotes(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/Departments(123)

GET https://localhost:50000/b1s/v1/Departments(123)?$select=Code,Name,Description

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 https://localhost:50000/b1s/v1/Departments

GET https://localhost:50000/b1s/v1/Departments?$select=Code,Name,Description&$filter=Code 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 https://localhost:50000/b1s/v1/Departments

{
"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 https://localhost:50000/b1s/v1/Departments(123)

{
"Description": "General Department001"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Departments(123)

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 https://localhost:50000/b1s/v1/Deposits(123)

GET https://localhost:50000/b1s/v1/Deposits(123)?$select=DepositNumber,AbsEntry,DepositType

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 https://localhost:50000/b1s/v1/Deposits

GET https://localhost:50000/b1s/v1/Deposits?$select=DepositNumber,AbsEntry,DepositType&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/Deposits

{
"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 https://localhost:50000/b1s/v1/Deposits(123)

{
"JournalRemarks": "Updating existing deposit"
}

POST Deposits(id)/CancelDeposit
Invoke the method 'CancelDeposit' on this EntitySet with the specified id.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 162/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/Deposits(123)/CancelDeposit

POST Deposits(id)/CancelDepositbyCurrentSystemDate
Invoke the method 'CancelDepositbyCurrentSystemDate' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Deposits(123)/CancelDepositbyCurrentSystemDate

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 https://localhost:50000/b1s/v1/DepreciationAreas('test')

GET https://localhost:50000/b1s/v1/DepreciationAreas('test')?$select=Code,Description,PostingOfDepreciation

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 https://localhost:50000/b1s/v1/DepreciationAreas

GET https://localhost:50000/b1s/v1/DepreciationAreas?$select=Code,Description,PostingOfDepreciation&$filter=startswith(Code, 'test') &$ord

POST DepreciationAreas

Create an instance of 'DepreciationAreas' with the given payload of type 'DepreciationArea' in JSON format.

Example

POST https://localhost:50000/b1s/v1/DepreciationAreas

{
"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 https://localhost:50000/b1s/v1/DepreciationAreas('test')

{
"Description": "123"
}

DELETE DepreciationAreas(id)

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

https://186.74.156.69:50000/Service Layer API Reference.html 163/334

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

DELETE https://localhost:50000/b1s/v1/DepreciationAreas('test')

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 https://localhost:50000/b1s/v1/DepreciationTypePools('1')

GET https://localhost:50000/b1s/v1/DepreciationTypePools('1')?$select=Code,Description

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 https://localhost:50000/b1s/v1/DepreciationTypePools

GET https://localhost:50000/b1s/v1/DepreciationTypePools?$select=Code,Description&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/DepreciationTypePools

{
"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 https://localhost:50000/b1s/v1/DepreciationTypePools('1')

{
"Description": "test123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/DepreciationTypePools('1')

DepreciationTypes
Show/Hide
List Operations
Expand Operations
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DepreciationTypes('test')

GET https://localhost:50000/b1s/v1/DepreciationTypes('test')?$select=Code,Description,DepreciationMethod

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 https://localhost:50000/b1s/v1/DepreciationTypes

GET https://localhost:50000/b1s/v1/DepreciationTypes?$select=Code,Description,DepreciationMethod&$filter=startswith(Code, 'test') &$orderb

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

Example

POST https://localhost:50000/b1s/v1/DepreciationTypes

{
"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 https://localhost:50000/b1s/v1/DepreciationTypes('test')

{
"Description": "DepreciationTypes 123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/DepreciationTypes('test')

DeterminationCriterias
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DeterminationCriterias(2)

GET https://localhost:50000/b1s/v1/DeterminationCriterias(2)?$select=DmcId,DeterminationCriteria,IsActive

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 https://localhost:50000/b1s/v1/DeterminationCriterias

GET https://localhost:50000/b1s/v1/DeterminationCriterias?$select=DmcId,DeterminationCriteria,IsActive&$filter=DmcId 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 https://localhost:50000/b1s/v1/DeterminationCriterias(2)

{
"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 https://localhost:50000/b1s/v1/Dimensions(1)

GET https://localhost:50000/b1s/v1/Dimensions(1)?$select=DimensionCode,DimensionName,IsActive

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 https://localhost:50000/b1s/v1/Dimensions

GET https://localhost:50000/b1s/v1/Dimensions?$select=DimensionCode,DimensionName,IsActive&$filter=DimensionCode 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.

https://186.74.156.69:50000/Service Layer API Reference.html 166/334

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

PATCH https://localhost:50000/b1s/v1/Dimensions(1)

{
"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 https://localhost:50000/b1s/v1/DistributionRules('DR1')

GET https://localhost:50000/b1s/v1/DistributionRules('DR1')?$select=FactorCode,FactorDescription,TotalFactor

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 https://localhost:50000/b1s/v1/DistributionRules

GET https://localhost:50000/b1s/v1/DistributionRules?$select=FactorCode,FactorDescription,TotalFactor&$filter=startswith(FactorCode, 'DR1'

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

Example

POST https://localhost:50000/b1s/v1/DistributionRules

{
"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 https://localhost:50000/b1s/v1/DistributionRules

{
"Active": "tYES",
"Direct": "N",
"DistributionRuleLines": [
{
"CenterCode": "1",
"EffectiveFrom": "2016-09-01",
"EffectiveTo": "2016-12-01",
"TotalInCenter": 400
},

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DistributionRules('DR1')

{
"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 https://localhost:50000/b1s/v1/DistributionRules('DR1')

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 https://localhost:50000/b1s/v1/DNFCodeSetup(123)

GET https://localhost:50000/b1s/v1/DNFCodeSetup(123)?$select=AbsEntry,NCMCode,DNFCode

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 https://localhost:50000/b1s/v1/DNFCodeSetup

GET https://localhost:50000/b1s/v1/DNFCodeSetup?$select=AbsEntry,NCMCode,DNFCode&$filter=AbsEntry ge 123 &$orderby=AbsEntry&$top=10&$skip=

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DNFCodeSetup

{
"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 https://localhost:50000/b1s/v1/DNFCodeSetup(123)

{
"DNFCode": "11131",
"Factor": 75,
"UoM": "112"
}

DELETE DNFCodeSetup(id)

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

Example

DELETE https://localhost:50000/b1s/v1/DNFCodeSetup(123)

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 https://localhost:50000/b1s/v1/DownPayments(123)

GET https://localhost:50000/b1s/v1/DownPayments(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/DownPayments

GET https://localhost:50000/b1s/v1/DownPayments?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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

https://186.74.156.69:50000/Service Layer API Reference.html 169/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/DownPayments

{
"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 https://localhost:50000/b1s/v1/DownPayments(123)

{
"Comments": "new comments - modified by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/DownPayments(123)

POST DownPayments(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/DownPayments(123)/Close

POST DownPayments(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/DownPayments(123)/Cancel

POST DownPayments(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/DownPayments(123)/Reopen

POST DownPayments(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/DownPayments(123)/CreateCancellationDocument

Drafts
Show/Hide
List Operations
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Drafts(123)

GET https://localhost:50000/b1s/v1/Drafts(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/Drafts

GET https://localhost:50000/b1s/v1/Drafts?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/Drafts

{
"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 https://localhost:50000/b1s/v1/Drafts(123)

{
"Comments": "new comments - modified by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/Drafts(123)

POST Drafts(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Drafts(123)/Close

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Drafts(123)/Cancel

POST Drafts(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/Drafts(123)/Reopen

POST Drafts(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/Drafts(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/DunningLetters(123)

GET https://localhost:50000/b1s/v1/DunningLetters(123)?$select=FeeCurrency,RowNumber,LetterFormat

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 https://localhost:50000/b1s/v1/DunningLetters

GET https://localhost:50000/b1s/v1/DunningLetters?$select=FeeCurrency,RowNumber,LetterFormat&$filter=RowNumber ge 123 &$orderby=RowNumber&

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

Example

POST https://localhost:50000/b1s/v1/DunningLetters

{
"Effectiveafter": "10",
"FeeCurrency": "RMB",
"Feeperletter": "20",
"LetterFormat": "DUN0",
"MinimumBalance": "2000",
"MinimumBalanceCurrency": "RMB",
"RowNumber": "1"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DunningLetters(123)

{
"MinimumBalance": "220"
}

DELETE DunningLetters(id)

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

Example

DELETE https://localhost:50000/b1s/v1/DunningLetters(123)

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 https://localhost:50000/b1s/v1/DunningTerms('DT01')

GET https://localhost:50000/b1s/v1/DunningTerms('DT01')?$select=Code,Name,GroupingMethod

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 https://localhost:50000/b1s/v1/DunningTerms

GET https://localhost:50000/b1s/v1/DunningTerms?$select=Code,Name,GroupingMethod&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/DunningTerms

{
"Code": "DT01",
"DaysInMonth": "10",
"DaysInYear": "2016",
"DunningTermLines": [
{
"Effectiveafter": "30",
"LetterFormat": "dltDunningLetter1",
"LevelNum": "001"
}
],
"GroupingMethod": "gmPerBP",
"Name": "DT01"
}

PATCH DunningTerms(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/DunningTerms('DT01')

{
"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 https://localhost:50000/b1s/v1/DunningTerms('DT01')

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 https://localhost:50000/b1s/v1/DynamicSystemStrings(FormID='139',ItemID='230',ColumnID='-1')

GET https://localhost:50000/b1s/v1/DynamicSystemStrings(FormID='139',ItemID='230',ColumnID='-1')?$select=FormID,ItemID,ColumnID

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 https://localhost:50000/b1s/v1/DynamicSystemStrings

GET https://localhost:50000/b1s/v1/DynamicSystemStrings?$select=FormID,ItemID,ColumnID&$filter=startswith(FormID, 'a') and startswith(Item

POST DynamicSystemStrings

Create an instance of 'DynamicSystemStrings' with the given payload of type 'DynamicSystemString' in JSON format.

Example

POST https://localhost:50000/b1s/v1/DynamicSystemStrings

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 174/334

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

PATCH https://localhost:50000/b1s/v1/DynamicSystemStrings(FormID='139',ItemID='230',ColumnID='-1')

{
"ItemString": "Order Owner"
}

DELETE DynamicSystemStrings(id)

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

Example

DELETE https://localhost:50000/b1s/v1/DynamicSystemStrings(FormID='139',ItemID='230',ColumnID='-1')

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 https://localhost:50000/b1s/v1/ElectronicFileFormats(123)

GET https://localhost:50000/b1s/v1/ElectronicFileFormats(123)?$select=FormatID,Name,Description

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 https://localhost:50000/b1s/v1/ElectronicFileFormats

GET https://localhost:50000/b1s/v1/ElectronicFileFormats?$select=FormatID,Name,Description&$filter=FormatID ge 123 &$orderby=FormatID&$top

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

Example

POST https://localhost:50000/b1s/v1/ElectronicFileFormats

{}

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 https://localhost:50000/b1s/v1/ElectronicFileFormats(123)

{}

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 175/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/ElectronicFileFormats(123)

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 https://localhost:50000/b1s/v1/EmailGroups('abc')

GET https://localhost:50000/b1s/v1/EmailGroups('abc')?$select=EmailGroupCode,EmailGroupName

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 https://localhost:50000/b1s/v1/EmailGroups

GET https://localhost:50000/b1s/v1/EmailGroups?$select=EmailGroupCode,EmailGroupName&$filter=startswith(EmailGroupCode, 'a') &$orderby=Ema

POST EmailGroups

Create an instance of 'EmailGroups' with the given payload of type 'EmailGroup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/EmailGroups

{
"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 https://localhost:50000/b1s/v1/EmailGroups('abc')

{
"EmailGroupName": "cnlin0121"
}

DELETE EmailGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/EmailGroups('abc')

EmployeeIDType
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'EmployeeIDType'.

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/EmployeeIDType('test')

GET https://localhost:50000/b1s/v1/EmployeeIDType('test')?$select=IDType

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 https://localhost:50000/b1s/v1/EmployeeIDType

GET https://localhost:50000/b1s/v1/EmployeeIDType?$select=IDType&$filter=startswith(IDType, '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 https://localhost:50000/b1s/v1/EmployeeIDType

{
"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 https://localhost:50000/b1s/v1/EmployeeIDType('test')

{
"IDType": "123"
}

DELETE EmployeeIDType(id)

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

Example

DELETE https://localhost:50000/b1s/v1/EmployeeIDType('test')

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 https://localhost:50000/b1s/v1/EmployeePosition(2)

GET https://localhost:50000/b1s/v1/EmployeePosition(2)?$select=PositionID,Name,Description

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/EmployeePosition

GET https://localhost:50000/b1s/v1/EmployeePosition?$select=PositionID,Name,Description&$filter=PositionID ge 2 &$orderby=PositionID&$top=

POST EmployeePosition

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

Example

POST https://localhost:50000/b1s/v1/EmployeePosition

{
"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 https://localhost:50000/b1s/v1/EmployeePosition(2)

{
"Description": "123"
}

DELETE EmployeePosition(id)

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

Example

DELETE https://localhost:50000/b1s/v1/EmployeePosition(2)

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 https://localhost:50000/b1s/v1/EmployeeRolesSetup(1)

GET https://localhost:50000/b1s/v1/EmployeeRolesSetup(1)?$select=TypeID,Name,Description

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 https://localhost:50000/b1s/v1/EmployeeRolesSetup

GET https://localhost:50000/b1s/v1/EmployeeRolesSetup?$select=TypeID,Name,Description&$filter=TypeID ge 1 &$orderby=TypeID&$top=10&$skip=1

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/EmployeeRolesSetup

{
"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 https://localhost:50000/b1s/v1/EmployeeRolesSetup(1)

{
"Name": "test123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/EmployeeRolesSetup(1)

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 https://localhost:50000/b1s/v1/EmployeesInfo(123)

GET https://localhost:50000/b1s/v1/EmployeesInfo(123)?$select=EmployeeID,LastName,FirstName

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 https://localhost:50000/b1s/v1/EmployeesInfo

GET https://localhost:50000/b1s/v1/EmployeesInfo?$select=EmployeeID,LastName,FirstName&$filter=EmployeeID ge 123 &$orderby=EmployeeID&$top

POST EmployeesInfo

Create an instance of 'EmployeesInfo' with the given payload of type 'EmployeeInfo' in JSON format.

Example

POST https://localhost:50000/b1s/v1/EmployeesInfo

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/EmployeesInfo(123)

{
"Remarks": "new manager"
}

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

Example

DELETE https://localhost:50000/b1s/v1/EmployeesInfo(123)

POST EmployeesInfo(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/EmployeesInfo(123)/Cancel

POST EmployeesInfo(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/EmployeesInfo(123)/Close

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 https://localhost:50000/b1s/v1/EmployeeStatus(1)

GET https://localhost:50000/b1s/v1/EmployeeStatus(1)?$select=StatusId,Name,Description

GET EmployeeStatus

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 180/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/EmployeeStatus

GET https://localhost:50000/b1s/v1/EmployeeStatus?$select=StatusId,Name,Description&$filter=StatusId 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 https://localhost:50000/b1s/v1/EmployeeStatus

{
"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 https://localhost:50000/b1s/v1/EmployeeStatus(1)

{
"Description": "closed"
}

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

Example

DELETE https://localhost:50000/b1s/v1/EmployeeStatus(1)

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 https://localhost:50000/b1s/v1/EmployeeTransfers(1)

GET https://localhost:50000/b1s/v1/EmployeeTransfers(1)?$select=TransferID,TransStartDate,TransStartTime

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 https://localhost:50000/b1s/v1/EmployeeTransfers

GET https://localhost:50000/b1s/v1/EmployeeTransfers?$select=TransferID,TransStartDate,TransStartTime&$filter=TransferID ge 1 &$orderby=Tr

POST EmployeeTransfers

Create an instance of 'EmployeeTransfers' with the given payload of type 'EmployeeTransfer' in JSON format.

https://186.74.156.69:50000/Service Layer API Reference.html 181/334

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

POST https://localhost:50000/b1s/v1/EmployeeTransfers

{
"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 https://localhost:50000/b1s/v1/EmployeeTransfers(1)

{
"Comment": "123"
}

DELETE EmployeeTransfers(id)

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

Example

DELETE https://localhost:50000/b1s/v1/EmployeeTransfers(1)

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 https://localhost:50000/b1s/v1/EnhancedDiscountGroups(123)

GET https://localhost:50000/b1s/v1/EnhancedDiscountGroups(123)?$select=AbsEntry,Type,ObjectCode

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 https://localhost:50000/b1s/v1/EnhancedDiscountGroups

GET https://localhost:50000/b1s/v1/EnhancedDiscountGroups?$select=AbsEntry,Type,ObjectCode&$filter=AbsEntry ge 123 &$orderby=AbsEntry&$top

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

Example

POST https://localhost:50000/b1s/v1/EnhancedDiscountGroups

{
"Active": "tYES",
"DiscountRelations": "dgrLowestDiscount",
"ObjectCode": "101",

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/EnhancedDiscountGroups(123)

{
"Active": "tNO"
}

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

Example

DELETE https://localhost:50000/b1s/v1/EnhancedDiscountGroups(123)

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 https://localhost:50000/b1s/v1/ExtendedTranslations(1)

GET https://localhost:50000/b1s/v1/ExtendedTranslations(1)?$select=DocEntry,Category,ID

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 https://localhost:50000/b1s/v1/ExtendedTranslations

GET https://localhost:50000/b1s/v1/ExtendedTranslations?$select=DocEntry,Category,ID&$filter=DocEntry 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 https://localhost:50000/b1s/v1/ExtendedTranslations

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 183/334

6/7/24, 15:42 Service Layer API Reference
PATCH https://localhost:50000/b1s/v1/ExtendedTranslations(1)

{
"ID": "123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ExtendedTranslations(1)

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 https://localhost:50000/b1s/v1/FAAccountDeterminations('test')

GET https://localhost:50000/b1s/v1/FAAccountDeterminations('test')?$select=Code,Description,AssetBalanceSheetAccount

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 https://localhost:50000/b1s/v1/FAAccountDeterminations

GET https://localhost:50000/b1s/v1/FAAccountDeterminations?$select=Code,Description,AssetBalanceSheetAccount&$filter=startswith(Code, 'tes

POST FAAccountDeterminations

Create an instance of 'FAAccountDeterminations' with the given payload of type 'FAAccountDetermination' in JSON format.

Example

POST https://localhost:50000/b1s/v1/FAAccountDeterminations

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 184/334

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

PATCH https://localhost:50000/b1s/v1/FAAccountDeterminations('test')

{
"RevenueClearingAccount": "2310"
}

DELETE FAAccountDeterminations(id)

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

Example

DELETE https://localhost:50000/b1s/v1/FAAccountDeterminations('test')

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 https://localhost:50000/b1s/v1/FactoringIndicators('abc')

GET https://localhost:50000/b1s/v1/FactoringIndicators('abc')?$select=IndicatorCode,IndicatorName

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 https://localhost:50000/b1s/v1/FactoringIndicators

GET https://localhost:50000/b1s/v1/FactoringIndicators?$select=IndicatorCode,IndicatorName&$filter=startswith(IndicatorCode, 'a') &$orderb

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

Example

POST https://localhost:50000/b1s/v1/FactoringIndicators

{
"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 https://localhost:50000/b1s/v1/FactoringIndicators('abc')

{
"IndicatorName": "customer indicator"
}

DELETE FactoringIndicators(id)

https://186.74.156.69:50000/Service Layer API Reference.html 185/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'FactoringIndicators' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/FactoringIndicators('abc')

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 https://localhost:50000/b1s/v1/FinancialYears(1)

GET https://localhost:50000/b1s/v1/FinancialYears(1)?$select=AbsEntry,Code,Description

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 https://localhost:50000/b1s/v1/FinancialYears

GET https://localhost:50000/b1s/v1/FinancialYears?$select=AbsEntry,Code,Description&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/FinancialYears

{
"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 https://localhost:50000/b1s/v1/FinancialYears(1)

{
"Description": "TEST"
}

DELETE FinancialYears(id)

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

Example

DELETE https://localhost:50000/b1s/v1/FinancialYears(1)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/FiscalPrinter('1')

GET https://localhost:50000/b1s/v1/FiscalPrinter('1')?$select=EquipmentNo,Model,ManufacturerSerialN

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 https://localhost:50000/b1s/v1/FiscalPrinter

GET https://localhost:50000/b1s/v1/FiscalPrinter?$select=EquipmentNo,Model,ManufacturerSerialN&$filter=startswith(EquipmentNo, '1') &$orde

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

Example

POST https://localhost:50000/b1s/v1/FiscalPrinter

{
"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 https://localhost:50000/b1s/v1/FiscalPrinter('1')

{
"EquipmentNo": "1",
"FiscalDocumentModel": "FM",
"ManufacturerSerialN": "ManufacturerSerialN",
"Model": "Model",
"RegisterNo": "0123456789"
}

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

Example

DELETE https://localhost:50000/b1s/v1/FiscalPrinter('1')

FormattedSearches
Show/Hide
List Operations
Expand Operations
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/FormattedSearches(24488)

GET https://localhost:50000/b1s/v1/FormattedSearches(24488)?$select=FormID,ItemID,ColumnID

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 https://localhost:50000/b1s/v1/FormattedSearches

GET https://localhost:50000/b1s/v1/FormattedSearches?$select=FormID,ItemID,ColumnID&$filter=Index 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 https://localhost:50000/b1s/v1/FormattedSearches

{
"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 https://localhost:50000/b1s/v1/FormattedSearches(24488)

{
"ItemID": "29"
}

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

Example

DELETE https://localhost:50000/b1s/v1/FormattedSearches(24488)

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.

https://186.74.156.69:50000/Service Layer API Reference.html 188/334

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

GET https://localhost:50000/b1s/v1/FormPreferences(User=123,FormID='abc',ItemNumber='abc',Column='abc')

GET https://localhost:50000/b1s/v1/FormPreferences(User=123,FormID='abc',ItemNumber='abc',Column='abc')?$select=User,FormID,ItemNumber

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 https://localhost:50000/b1s/v1/FormPreferences

GET https://localhost:50000/b1s/v1/FormPreferences?$select=User,FormID,ItemNumber&$filter=User 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 https://localhost:50000/b1s/v1/FormPreferences(User=123,FormID='abc',ItemNumber='abc',Column='abc')

{
"VisibleInExpanded": "tNO"
}

DELETE FormPreferences(id)

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

Example

DELETE https://localhost:50000/b1s/v1/FormPreferences(User=123,FormID='abc',ItemNumber='abc',Column='abc')

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 https://localhost:50000/b1s/v1/Forms1099(123)

GET https://localhost:50000/b1s/v1/Forms1099(123)?$select=FormCode,Form1099,Boxes1099

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 https://localhost:50000/b1s/v1/Forms1099

GET https://localhost:50000/b1s/v1/Forms1099?$select=FormCode,Form1099,Boxes1099&$filter=FormCode ge 123 &$orderby=FormCode&$top=10&$skip=

POST Forms1099

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Forms1099

{
"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 https://localhost:50000/b1s/v1/Forms1099(123)

{
"Boxes1099": [
{
"Minimum1099Amount": "30"
}
]
}

DELETE Forms1099(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Forms1099(123)

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 https://localhost:50000/b1s/v1/GLAccountAdvancedRules(8)

GET https://localhost:50000/b1s/v1/GLAccountAdvancedRules(8)?$select=AbsoluteEntry,Period,BeginningofFinancialYear

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 https://localhost:50000/b1s/v1/GLAccountAdvancedRules

GET https://localhost:50000/b1s/v1/GLAccountAdvancedRules?$select=AbsoluteEntry,Period,BeginningofFinancialYear&$filter=AbsoluteEntry ge 1

POST GLAccountAdvancedRules

Create an instance of 'GLAccountAdvancedRules' with the given payload of type 'GLAccountAdvancedRule' in JSON format.

https://186.74.156.69:50000/Service Layer API Reference.html 190/334

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

POST https://localhost:50000/b1s/v1/GLAccountAdvancedRules

{
"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 https://localhost:50000/b1s/v1/GLAccountAdvancedRules(8)

{
"AbsoluteEntry": 1,
"Description": "Test Determination Rules123",
"IsActive": "tYES"
}

DELETE GLAccountAdvancedRules(id)

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

Example

DELETE https://localhost:50000/b1s/v1/GLAccountAdvancedRules(8)

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 https://localhost:50000/b1s/v1/GoodsReturnRequest(123)

GET https://localhost:50000/b1s/v1/GoodsReturnRequest(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/GoodsReturnRequest

GET https://localhost:50000/b1s/v1/GoodsReturnRequest?$select=DocEntry,DocNum,DocType&$filter=DocEntry ge 123 &$orderby=DocEntry&$top=10&$

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/GoodsReturnRequest

{
"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 https://localhost:50000/b1s/v1/GoodsReturnRequest(123)

{
"Comments": "new comments - modified by Service Layer"
}

DELETE GoodsReturnRequest(id)

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

Example

DELETE https://localhost:50000/b1s/v1/GoodsReturnRequest(123)

POST GoodsReturnRequest(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/GoodsReturnRequest(123)/Close

POST GoodsReturnRequest(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/GoodsReturnRequest(123)/Cancel

POST GoodsReturnRequest(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/GoodsReturnRequest(123)/Reopen

POST GoodsReturnRequest(id)/SaveDraftToDocument

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

Example

POST https://localhost:50000/b1s/v1/GoodsReturnRequest(123)/SaveDraftToDocument

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/GoodsReturnRequest(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/GovPayCodes(123)

GET https://localhost:50000/b1s/v1/GovPayCodes(123)?$select=AbsId,Code,Descr

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 https://localhost:50000/b1s/v1/GovPayCodes

GET https://localhost:50000/b1s/v1/GovPayCodes?$select=AbsId,Code,Descr&$filter=AbsId 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 https://localhost:50000/b1s/v1/GovPayCodes

{
"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 https://localhost:50000/b1s/v1/GovPayCodes(123)

{
"Descr": "c1211"
}

DELETE GovPayCodes(id)

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 193/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/GovPayCodes(123)

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 https://localhost:50000/b1s/v1/HouseBankAccounts(123)

GET https://localhost:50000/b1s/v1/HouseBankAccounts(123)?$select=BankCode,AccNo,Branch

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 https://localhost:50000/b1s/v1/HouseBankAccounts

GET https://localhost:50000/b1s/v1/HouseBankAccounts?$select=BankCode,AccNo,Branch&$filter=AbsoluteEntry ge 123 &$orderby=AbsoluteEntry&$t

POST HouseBankAccounts

Create an instance of 'HouseBankAccounts' with the given payload of type 'HouseBankAccount' in JSON format.

Example

POST https://localhost:50000/b1s/v1/HouseBankAccounts

{
"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 https://localhost:50000/b1s/v1/HouseBankAccounts(123)

{
"ZipCode": "200-10"
}

DELETE HouseBankAccounts(id)

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

Example

DELETE https://localhost:50000/b1s/v1/HouseBankAccounts(123)

IncomingPayments

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/IncomingPayments(123)

GET https://localhost:50000/b1s/v1/IncomingPayments(123)?$select=DocNum,DocType,HandWritten

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 https://localhost:50000/b1s/v1/IncomingPayments

GET https://localhost:50000/b1s/v1/IncomingPayments?$select=DocNum,DocType,HandWritten&$filter=DocEntry 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 https://localhost:50000/b1s/v1/IncomingPayments

{
"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 https://localhost:50000/b1s/v1/IncomingPayments(123)

{
"Remarks": "new comments - modified by Service Layer"
}

POST IncomingPayments(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/IncomingPayments(123)/Cancel

POST IncomingPayments(id)/GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this EntitySet with the specified id.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 195/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/IncomingPayments(123)/GetApprovalTemplates

POST IncomingPayments(id)/CancelbyCurrentSystemDate
Invoke the method 'CancelbyCurrentSystemDate' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/IncomingPayments(123)/CancelbyCurrentSystemDate

POST IncomingPayments(id)/RequestApproveCancellation
Invoke the method 'RequestApproveCancellation' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/IncomingPayments(123)/RequestApproveCancellation

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 https://localhost:50000/b1s/v1/Industries(123)

GET https://localhost:50000/b1s/v1/Industries(123)?$select=IndustryDescription,IndustryName,IndustryCode

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 https://localhost:50000/b1s/v1/Industries

GET https://localhost:50000/b1s/v1/Industries?$select=IndustryDescription,IndustryName,IndustryCode&$filter=IndustryCode ge 123 &$orderby=

POST Industries

Create an instance of 'Industries' with the given payload of type 'Industry' in JSON format.

Example

POST https://localhost:50000/b1s/v1/Industries

{
"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 https://localhost:50000/b1s/v1/Industries(123)

{
"IndustryDescription": "oil"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Industries(123)

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 https://localhost:50000/b1s/v1/IntegrationPackagesConfigure(123)

GET https://localhost:50000/b1s/v1/IntegrationPackagesConfigure(123)?$select=AbsEntry,Code,Name

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 https://localhost:50000/b1s/v1/IntegrationPackagesConfigure

GET https://localhost:50000/b1s/v1/IntegrationPackagesConfigure?$select=AbsEntry,Code,Name&$filter=AbsEntry ge 123 &$orderby=AbsEntry&$top

POST IntegrationPackagesConfigure

Create an instance of 'IntegrationPackagesConfigure' with the given payload of type 'IntegrationPackageConfigure' in JSON format.

Example

POST https://localhost:50000/b1s/v1/IntegrationPackagesConfigure

{}

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 https://localhost:50000/b1s/v1/IntegrationPackagesConfigure(123)

{
"IsEnable": "tYES"
}

DELETE IntegrationPackagesConfigure(id)

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

Example

DELETE https://localhost:50000/b1s/v1/IntegrationPackagesConfigure(123)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/InternalReconciliations(123)

GET https://localhost:50000/b1s/v1/InternalReconciliations(123)?$select=ReconNum,ReconDate,CardOrAccount

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

Example

POST https://localhost:50000/b1s/v1/InternalReconciliations

{
"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 https://localhost:50000/b1s/v1/IntrastatConfiguration(123)

GET https://localhost:50000/b1s/v1/IntrastatConfiguration(123)?$select=AbsEntry,ConfType,Code

GET IntrastatConfiguration

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 198/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/IntrastatConfiguration

GET https://localhost:50000/b1s/v1/IntrastatConfiguration?$select=AbsEntry,ConfType,Code&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/IntrastatConfiguration

{
"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 https://localhost:50000/b1s/v1/IntrastatConfiguration(123)

{}

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

Example

DELETE https://localhost:50000/b1s/v1/IntrastatConfiguration(123)

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 https://localhost:50000/b1s/v1/InventoryCountings(123)

GET https://localhost:50000/b1s/v1/InventoryCountings(123)?$select=DocumentEntry,DocumentNumber,Series

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 https://localhost:50000/b1s/v1/InventoryCountings

GET https://localhost:50000/b1s/v1/InventoryCountings?$select=DocumentEntry,DocumentNumber,Series&$filter=DocumentEntry ge 123 &$orderby=D

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/InventoryCountings

{
"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 https://localhost:50000/b1s/v1/InventoryCountings(123)

{
"Remarks": "updated by ServiceLayer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/InventoryCountings(123)

POST InventoryCountings(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/InventoryCountings(123)/Close

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 https://localhost:50000/b1s/v1/InventoryCycles(123)

GET https://localhost:50000/b1s/v1/InventoryCycles(123)?$select=CycleCode,CycleName,Frequency

GET InventoryCycles

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 200/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/InventoryCycles

GET https://localhost:50000/b1s/v1/InventoryCycles?$select=CycleCode,CycleName,Frequency&$filter=CycleCode ge 123 &$orderby=CycleCode&$top

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

Example

POST https://localhost:50000/b1s/v1/InventoryCycles

{
"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 https://localhost:50000/b1s/v1/InventoryCycles(123)

{
"Frequency": "bof_OneTime"
}

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

Example

DELETE https://localhost:50000/b1s/v1/InventoryCycles(123)

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 https://localhost:50000/b1s/v1/InventoryGenEntries(123)

GET https://localhost:50000/b1s/v1/InventoryGenEntries(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/InventoryGenEntries

GET https://localhost:50000/b1s/v1/InventoryGenEntries?$select=DocEntry,DocNum,DocType&$filter=DocEntry ge 123 &$orderby=DocEntry&$top=10&

POST InventoryGenEntries

Create an instance of 'InventoryGenEntries' with the given payload of type 'Document' in JSON format.

https://186.74.156.69:50000/Service Layer API Reference.html 201/334

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

POST https://localhost:50000/b1s/v1/InventoryGenEntries

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

POST https://localhost:50000/b1s/v1/InventoryGenEntries

{
"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 https://localhost:50000/b1s/v1/InventoryGenEntries(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST InventoryGenEntries(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/InventoryGenEntries(123)/Close

POST InventoryGenEntries(id)/Cancel

https://186.74.156.69:50000/Service Layer API Reference.html 202/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/InventoryGenEntries(123)/Cancel

POST InventoryGenEntries(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/InventoryGenEntries(123)/Reopen

POST InventoryGenEntries(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/InventoryGenEntries(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/InventoryGenExits(123)

GET https://localhost:50000/b1s/v1/InventoryGenExits(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/InventoryGenExits

GET https://localhost:50000/b1s/v1/InventoryGenExits?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/InventoryGenExits

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

POST https://localhost:50000/b1s/v1/InventoryGenExits

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/InventoryGenExits

{
"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 https://localhost:50000/b1s/v1/InventoryGenExits(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST InventoryGenExits(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/InventoryGenExits(123)/Close

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/InventoryGenExits(123)/Cancel

POST InventoryGenExits(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/InventoryGenExits(123)/Reopen

POST InventoryGenExits(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/InventoryGenExits(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/InventoryOpeningBalances(123)

GET https://localhost:50000/b1s/v1/InventoryOpeningBalances(123)?$select=DocumentEntry,PostingDate,DocumentDate

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 https://localhost:50000/b1s/v1/InventoryOpeningBalances

GET https://localhost:50000/b1s/v1/InventoryOpeningBalances?$select=DocumentEntry,PostingDate,DocumentDate&$filter=DocumentEntry ge 123 &$

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

Example

POST https://localhost:50000/b1s/v1/InventoryOpeningBalances

{
"BranchID": null,
"DocObjectCodeEx": "310000001",
"DocumentDate": "2016-01-01",
"DocumentEntry": 4,
"DocumentNumber": 1,
"FinancialPeriod": 1,
"InventoryOpeningBalanceLines": [
{
"ActualPrice": 1,

https://186.74.156.69:50000/Service Layer API Reference.html 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": "1.01.01.01.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 https://localhost:50000/b1s/v1/InventoryOpeningBalances(123)

{
"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 https://localhost:50000/b1s/v1/InventoryPostings(123)

GET https://localhost:50000/b1s/v1/InventoryPostings(123)?$select=DocumentEntry,DocumentNumber,Series

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 https://localhost:50000/b1s/v1/InventoryPostings

GET https://localhost:50000/b1s/v1/InventoryPostings?$select=DocumentEntry,DocumentNumber,Series&$filter=DocumentEntry ge 123 &$orderby=Do

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/InventoryPostings

{}

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 https://localhost:50000/b1s/v1/InventoryPostings(123)

{}

DELETE InventoryPostings(id)

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

Example

DELETE https://localhost:50000/b1s/v1/InventoryPostings(123)

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 https://localhost:50000/b1s/v1/InventoryTransferRequests(123)

GET https://localhost:50000/b1s/v1/InventoryTransferRequests(123)?$select=DocEntry,Series,Printed

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 https://localhost:50000/b1s/v1/InventoryTransferRequests

GET https://localhost:50000/b1s/v1/InventoryTransferRequests?$select=DocEntry,Series,Printed&$filter=DocEntry ge 123 &$orderby=DocEntry&$t

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

Example

POST https://localhost:50000/b1s/v1/InventoryTransferRequests

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/InventoryTransferRequests(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST InventoryTransferRequests(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/InventoryTransferRequests(123)/Cancel

POST InventoryTransferRequests(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/InventoryTransferRequests(123)/Close

POST InventoryTransferRequests(id)/SaveDraftToDocument
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/InventoryTransferRequests(123)/SaveDraftToDocument

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 https://localhost:50000/b1s/v1/Invoices(123)

GET https://localhost:50000/b1s/v1/Invoices(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/Invoices

GET https://localhost:50000/b1s/v1/Invoices?$select=DocEntry,DocNum,DocType&$filter=DocEntry ge 123 &$orderby=DocEntry&$top=10&$skip=1

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Invoices

{
"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 https://localhost:50000/b1s/v1/Invoices(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST Invoices(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/Invoices(123)/Close

POST Invoices(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/Invoices(123)/Cancel

POST Invoices(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/Invoices(123)/Reopen

POST Invoices(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/Invoices(123)/CreateCancellationDocument

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.

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ItemGroups(123)

GET https://localhost:50000/b1s/v1/ItemGroups(123)?$select=PriceDifferencesAccount,StockInflationAdjustAccount,MinimumOrderQuantity

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 https://localhost:50000/b1s/v1/ItemGroups

GET https://localhost:50000/b1s/v1/ItemGroups?$select=PriceDifferencesAccount,StockInflationAdjustAccount,MinimumOrderQuantity&$filter=Num

POST ItemGroups

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

Example

POST https://localhost:50000/b1s/v1/ItemGroups

{
"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 https://localhost:50000/b1s/v1/ItemGroups(123)

{
"Alert": "tYES"
}

DELETE ItemGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ItemGroups(123)

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 https://localhost:50000/b1s/v1/ItemImages('i001')

GET https://localhost:50000/b1s/v1/ItemImages('i001')/$value

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ItemImages('i001')

DELETE ItemImages(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ItemImages('i001')

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 https://localhost:50000/b1s/v1/ItemProperties(9124)

GET https://localhost:50000/b1s/v1/ItemProperties(9124)?$select=Number,PropertyName

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 https://localhost:50000/b1s/v1/ItemProperties

GET https://localhost:50000/b1s/v1/ItemProperties?$select=Number,PropertyName&$filter=Number 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 https://localhost:50000/b1s/v1/ItemProperties

{
"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 https://localhost:50000/b1s/v1/ItemProperties(9124)

{
"PropertyName": "new Item Property 9124"
}

DELETE ItemProperties(id)
https://186.74.156.69:50000/Service Layer API Reference.html 211/334
6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'ItemProperties' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/ItemProperties(9124)

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 https://localhost:50000/b1s/v1/Items('i001')

GET https://localhost:50000/b1s/v1/Items('i001')?$select=ItemCode,ItemName,ForeignName

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 https://localhost:50000/b1s/v1/Items

GET https://localhost:50000/b1s/v1/Items?$select=ItemCode,ItemName,ForeignName&$filter=startswith(ItemCode, 'a') &$orderby=ItemCode&$top=1

POST Items

Create an instance of 'Items' with the given payload of type 'Item' in JSON format.

Example

POST https://localhost:50000/b1s/v1/Items

{
"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 https://localhost:50000/b1s/v1/Items('i001')

{
"ItemName": "Updated Item Name"
}

DELETE Items(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Items('i001')

POST Items(id)/Cancel

https://186.74.156.69:50000/Service Layer API Reference.html 212/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Items('i001')/Cancel

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 https://localhost:50000/b1s/v1/JournalEntries(123)

GET https://localhost:50000/b1s/v1/JournalEntries(123)?$select=ReferenceDate,Memo,Reference

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 https://localhost:50000/b1s/v1/JournalEntries

GET https://localhost:50000/b1s/v1/JournalEntries?$select=ReferenceDate,Memo,Reference&$filter=JdtNum 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 https://localhost:50000/b1s/v1/JournalEntries

{
"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 https://localhost:50000/b1s/v1/JournalEntries(123)

{
"Memo": "new memo - modified by Service Layer"
}

POST JournalEntries(id)/Cancel

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

https://186.74.156.69:50000/Service Layer API Reference.html 213/334

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

POST https://localhost:50000/b1s/v1/JournalEntries(123)/Cancel

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 https://localhost:50000/b1s/v1/JournalEntryDocumentTypes('type1')

GET https://localhost:50000/b1s/v1/JournalEntryDocumentTypes('type1')?$select=JournalEntryType,DocTypeDescription,ShortName

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 https://localhost:50000/b1s/v1/JournalEntryDocumentTypes

GET https://localhost:50000/b1s/v1/JournalEntryDocumentTypes?$select=JournalEntryType,DocTypeDescription,ShortName&$filter=startswith(Jour

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

Example

POST https://localhost:50000/b1s/v1/JournalEntryDocumentTypes

{
"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 https://localhost:50000/b1s/v1/JournalEntryDocumentTypes('type1')

{
"DocTypeDescription": "my desc - updated by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/JournalEntryDocumentTypes('type1')

KnowledgeBaseSolutions
Show/Hide
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/KnowledgeBaseSolutions(123)

GET https://localhost:50000/b1s/v1/KnowledgeBaseSolutions(123)?$select=ItemCode,Status,Owner

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 https://localhost:50000/b1s/v1/KnowledgeBaseSolutions

GET https://localhost:50000/b1s/v1/KnowledgeBaseSolutions?$select=ItemCode,Status,Owner&$filter=SolutionCode ge 123 &$orderby=SolutionCode

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

Example

POST https://localhost:50000/b1s/v1/KnowledgeBaseSolutions

{
"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 https://localhost:50000/b1s/v1/KnowledgeBaseSolutions(123)

{
"Solution": "Application issue"
}

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

Example

DELETE https://localhost:50000/b1s/v1/KnowledgeBaseSolutions(123)

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.

https://186.74.156.69:50000/Service Layer API Reference.html 215/334

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

GET https://localhost:50000/b1s/v1/KPIs('abc')

GET https://localhost:50000/b1s/v1/KPIs('abc')?$select=KPICode,KPIName,KPIType

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 https://localhost:50000/b1s/v1/KPIs

GET https://localhost:50000/b1s/v1/KPIs?$select=KPICode,KPIName,KPIType&$filter=startswith(KPICode, '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 https://localhost:50000/b1s/v1/KPIs

{
"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 https://localhost:50000/b1s/v1/KPIs('abc')

{
"KPIName": "Cash Flow Config0012"
}

DELETE KPIs(id)

https://186.74.156.69:50000/Service Layer API Reference.html 216/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'KPIs' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/KPIs('abc')

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 https://localhost:50000/b1s/v1/LandedCosts(123)

GET https://localhost:50000/b1s/v1/LandedCosts(123)?$select=DocEntry,LandedCostNumber,PostingDate

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 https://localhost:50000/b1s/v1/LandedCosts

GET https://localhost:50000/b1s/v1/LandedCosts?$select=DocEntry,LandedCostNumber,PostingDate&$filter=DocEntry ge 123 &$orderby=DocEntry&$t

POST LandedCosts

Create an instance of 'LandedCosts' with the given payload of type 'LandedCost' in JSON format.

Example

POST https://localhost:50000/b1s/v1/LandedCosts

{}

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 https://localhost:50000/b1s/v1/LandedCosts(123)

{
"JournalRemarks": "update from sl"
}

DELETE LandedCosts(id)

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

Example

DELETE https://localhost:50000/b1s/v1/LandedCosts(123)

POST LandedCosts(id)/CloseLandedCost

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 217/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/LandedCosts(123)/CloseLandedCost

POST LandedCosts(id)/CancelLandedCost
Invoke the method 'CancelLandedCost' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/LandedCosts(123)/CancelLandedCost

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 https://localhost:50000/b1s/v1/LandedCostsCodes('01')

GET https://localhost:50000/b1s/v1/LandedCostsCodes('01')?$select=Code,Name,AllocationBy

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 https://localhost:50000/b1s/v1/LandedCostsCodes

GET https://localhost:50000/b1s/v1/LandedCostsCodes?$select=Code,Name,AllocationBy&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/LandedCostsCodes

{
"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 https://localhost:50000/b1s/v1/LandedCostsCodes('01')

{
"Name": "Shipping"
}

DELETE LandedCostsCodes(id)

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 218/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/LandedCostsCodes('01')

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 https://localhost:50000/b1s/v1/LegalData(123)

GET https://localhost:50000/b1s/v1/LegalData(123)?$select=DocEntry,SourceObjectType,SourceObjectEntry

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 https://localhost:50000/b1s/v1/LegalData

GET https://localhost:50000/b1s/v1/LegalData?$select=DocEntry,SourceObjectType,SourceObjectEntry&$filter=DocEntry ge 123 &$orderby=DocEntr

POST LegalData

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

Example

POST https://localhost:50000/b1s/v1/LegalData

{
"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 https://localhost:50000/b1s/v1/LegalData(123)

{
"PrinterType": "12"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/LengthMeasures(123)

GET https://localhost:50000/b1s/v1/LengthMeasures(123)?$select=UnitCode,UnitDisplay,UnitName

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 https://localhost:50000/b1s/v1/LengthMeasures

GET https://localhost:50000/b1s/v1/LengthMeasures?$select=UnitCode,UnitDisplay,UnitName&$filter=UnitCode 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 https://localhost:50000/b1s/v1/LengthMeasures

{
"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 https://localhost:50000/b1s/v1/LengthMeasures(123)

{
"UnitLengthinmm": "240"
}

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

Example

DELETE https://localhost:50000/b1s/v1/LengthMeasures(123)

LocalEra
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'LocalEra'.

GET LocalEra(id)
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/LocalEra('D')

GET https://localhost:50000/b1s/v1/LocalEra('D')?$select=EraName,StartDate,Code

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 https://localhost:50000/b1s/v1/LocalEra

GET https://localhost:50000/b1s/v1/LocalEra?$select=EraName,StartDate,Code&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/LocalEra

{
"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 https://localhost:50000/b1s/v1/LocalEra('D')

{
"EraName": "Maruzen"
}

DELETE LocalEra(id)

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

Example

DELETE https://localhost:50000/b1s/v1/LocalEra('D')

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 https://localhost:50000/b1s/v1/Manufacturers(123)

GET https://localhost:50000/b1s/v1/Manufacturers(123)?$select=Code,ManufacturerName

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Manufacturers

GET https://localhost:50000/b1s/v1/Manufacturers?$select=Code,ManufacturerName&$filter=Code 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 https://localhost:50000/b1s/v1/Manufacturers

{
"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 https://localhost:50000/b1s/v1/Manufacturers(123)

{
"ManufacturerName": "Rainbow"
}

DELETE Manufacturers(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Manufacturers(123)

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 https://localhost:50000/b1s/v1/MaterialGroups(123)

GET https://localhost:50000/b1s/v1/MaterialGroups(123)?$select=AbsEntry,MaterialGroupCode,Description

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 https://localhost:50000/b1s/v1/MaterialGroups

GET https://localhost:50000/b1s/v1/MaterialGroups?$select=AbsEntry,MaterialGroupCode,Description&$filter=AbsEntry ge 123 &$orderby=AbsEntr

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/MaterialGroups

{
"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 https://localhost:50000/b1s/v1/MaterialGroups(123)

{
"Description": "test"
}

DELETE MaterialGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/MaterialGroups(123)

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 https://localhost:50000/b1s/v1/MaterialRevaluation(123)

GET https://localhost:50000/b1s/v1/MaterialRevaluation(123)?$select=DocNum,DocDate,Reference1

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 https://localhost:50000/b1s/v1/MaterialRevaluation

GET https://localhost:50000/b1s/v1/MaterialRevaluation?$select=DocNum,DocDate,Reference1&$filter=DocEntry 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 https://localhost:50000/b1s/v1/MaterialRevaluation

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/MaterialRevaluation(123)

{
"Comments": "new comments - modified by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/MaterialRevaluation(123)

POST MaterialRevaluation(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/MaterialRevaluation(123)/Cancel

POST MaterialRevaluation(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/MaterialRevaluation(123)/Close

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 https://localhost:50000/b1s/v1/Messages(4)

GET https://localhost:50000/b1s/v1/Messages(4)?$select=Code,User,Priority

GET Messages

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 224/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/Messages

GET https://localhost:50000/b1s/v1/Messages?$select=Code,User,Priority&$filter=Code 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 https://localhost:50000/b1s/v1/Messages

{
"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 https://localhost:50000/b1s/v1/Messages(1)/GetMessage

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 https://localhost:50000/b1s/v1/MobileAddOnSetting('abc')

GET https://localhost:50000/b1s/v1/MobileAddOnSetting('abc')?$select=Code,Description,Url

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 https://localhost:50000/b1s/v1/MobileAddOnSetting

GET https://localhost:50000/b1s/v1/MobileAddOnSetting?$select=Code,Description,Url&$filter=startswith(Code, 'a') &$orderby=Code&$top=10&$s

POST MobileAddOnSetting
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/MobileAddOnSetting

{}

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 https://localhost:50000/b1s/v1/MobileAddOnSetting('abc')

{}

DELETE MobileAddOnSetting(id)

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

Example

DELETE https://localhost:50000/b1s/v1/MobileAddOnSetting('abc')

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 https://localhost:50000/b1s/v1/MultiLanguageTranslations(123)

GET https://localhost:50000/b1s/v1/MultiLanguageTranslations(123)?$select=Numerator,TableName,FieldAlias

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 https://localhost:50000/b1s/v1/MultiLanguageTranslations

GET https://localhost:50000/b1s/v1/MultiLanguageTranslations?$select=Numerator,TableName,FieldAlias&$filter=Numerator ge 123 &$orderby=Num

POST MultiLanguageTranslations

Create an instance of 'MultiLanguageTranslations' with the given payload of type 'MultiLanguageTranslation' in JSON format.

Example

POST https://localhost:50000/b1s/v1/MultiLanguageTranslations

{
"FieldAlias": "Free_Text",
"PrimaryKeyofobject": "v001",
"TableName": "OCRD",
"TranslationsInUserLanguages": [
{
"LanguageCodeOfUserLanguage": "8",
"Translationscontent": "Remarks"
}
]

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/MultiLanguageTranslations(123)

{
"TranslationsInUserLanguages": [
{
"Translationscontent": "Description"
}
]
}

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

Example

DELETE https://localhost:50000/b1s/v1/MultiLanguageTranslations(123)

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 https://localhost:50000/b1s/v1/NatureOfAssessees(123)

GET https://localhost:50000/b1s/v1/NatureOfAssessees(123)?$select=AbsEntry,Code,Description

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 https://localhost:50000/b1s/v1/NatureOfAssessees

GET https://localhost:50000/b1s/v1/NatureOfAssessees?$select=AbsEntry,Code,Description&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/NatureOfAssessees

{
"AbsEntry": 4,
"AssesseeType": "atOthers",
"Code": "2HUF",
"Description": "11HUF"
}

PATCH NatureOfAssessees(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/NatureOfAssessees(123)

{
"Description": "11HUF"
}

DELETE NatureOfAssessees(id)

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

Example

DELETE https://localhost:50000/b1s/v1/NatureOfAssessees(123)

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 https://localhost:50000/b1s/v1/NCMCodesSetup(123)

GET https://localhost:50000/b1s/v1/NCMCodesSetup(123)?$select=AbsEntry,NCMCode,Description

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 https://localhost:50000/b1s/v1/NCMCodesSetup

GET https://localhost:50000/b1s/v1/NCMCodesSetup?$select=AbsEntry,NCMCode,Description&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/NCMCodesSetup

{
"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 https://localhost:50000/b1s/v1/NCMCodesSetup(123)

{
"Description": "111Outros"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/NCMCodesSetup(123)

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 https://localhost:50000/b1s/v1/NFModels('abc')

GET https://localhost:50000/b1s/v1/NFModels('abc')?$select=AbsEntry,NFMName,NFMDescription

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 https://localhost:50000/b1s/v1/NFModels

GET https://localhost:50000/b1s/v1/NFModels?$select=AbsEntry,NFMName,NFMDescription&$filter=startswith(AbsEntry, 'a') &$orderby=AbsEntry&$

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

Example

POST https://localhost:50000/b1s/v1/NFModels

{
"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 https://localhost:50000/b1s/v1/NFModels('abc')

{
"NFMDescription": "02 Nota Fiscal de Venda a Consumidor"
}

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

Example

DELETE https://localhost:50000/b1s/v1/NFModels('abc')

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/NFTaxCategories(123)

GET https://localhost:50000/b1s/v1/NFTaxCategories(123)?$select=AbsId,Code,Locked

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 https://localhost:50000/b1s/v1/NFTaxCategories

GET https://localhost:50000/b1s/v1/NFTaxCategories?$select=AbsId,Code,Locked&$filter=AbsId 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 https://localhost:50000/b1s/v1/NFTaxCategories

{
"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 https://localhost:50000/b1s/v1/NFTaxCategories(123)

{}

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

Example

DELETE https://localhost:50000/b1s/v1/NFTaxCategories(123)

OccurrenceCodes
Show/Hide
List Operations
Expand Operations

This entity enables you to manipulate 'OccurrenceCodes'.

GET OccurrenceCodes(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/OccurrenceCodes(123)

GET https://localhost:50000/b1s/v1/OccurrenceCodes(123)?$select=AbsEntry,Code,Description

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 https://localhost:50000/b1s/v1/OccurrenceCodes

GET https://localhost:50000/b1s/v1/OccurrenceCodes?$select=AbsEntry,Code,Description&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/OccurrenceCodes

{
"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 https://localhost:50000/b1s/v1/OccurrenceCodes(123)

{
"Description": "updating",
"RequestedBoeStatus": "boes_Deposited"
}

DELETE OccurrenceCodes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/OccurrenceCodes(123)

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 https://localhost:50000/b1s/v1/Orders(123)

GET https://localhost:50000/b1s/v1/Orders(123)?$select=DocEntry,DocNum,DocType

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Orders

GET https://localhost:50000/b1s/v1/Orders?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 Layer.pdf.

Example

POST https://localhost:50000/b1s/v1/Orders

{
"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 https://localhost:50000/b1s/v1/Orders(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST Orders(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/Orders(123)/Close

POST Orders(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/Orders(123)/Cancel

POST Orders(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/Orders(123)/Reopen

POST Orders(id)/CreateCancellationDocument

https://186.74.156.69:50000/Service Layer API Reference.html 232/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Orders(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PackagesTypes(123)

GET https://localhost:50000/b1s/v1/PackagesTypes(123)?$select=Type,Code,Length1

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 https://localhost:50000/b1s/v1/PackagesTypes

GET https://localhost:50000/b1s/v1/PackagesTypes?$select=Type,Code,Length1&$filter=Code 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 https://localhost:50000/b1s/v1/PackagesTypes

{
"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 https://localhost:50000/b1s/v1/PackagesTypes(123)

{
"Length1": "20"
}

DELETE PackagesTypes(id)

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 233/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/PackagesTypes(123)

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 https://localhost:50000/b1s/v1/PartnersSetups(1)

GET https://localhost:50000/b1s/v1/PartnersSetups(1)?$select=PartnerID,Name,DefaultRelationship

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 https://localhost:50000/b1s/v1/PartnersSetups

GET https://localhost:50000/b1s/v1/PartnersSetups?$select=PartnerID,Name,DefaultRelationship&$filter=PartnerID ge 1 &$orderby=PartnerID&$t

POST PartnersSetups

Create an instance of 'PartnersSetups' with the given payload of type 'PartnersSetupParams' in JSON format.

Example

POST https://localhost:50000/b1s/v1/PartnersSetups

{
"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 https://localhost:50000/b1s/v1/PartnersSetups(1)

{
"Details": "Updated related BP",
"RelatedBP": "V01"
}

DELETE PartnersSetups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/PartnersSetups(1)

PaymentBlocks
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PaymentBlocks(5)

GET https://localhost:50000/b1s/v1/PaymentBlocks(5)?$select=AbsEntry,PaymentBlockCode

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 https://localhost:50000/b1s/v1/PaymentBlocks

GET https://localhost:50000/b1s/v1/PaymentBlocks?$select=AbsEntry,PaymentBlockCode&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/PaymentBlocks

{
"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 https://localhost:50000/b1s/v1/PaymentBlocks(5)

{
"PaymentBlockCode": "bbbbbbb"
}

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

Example

DELETE https://localhost:50000/b1s/v1/PaymentBlocks(5)

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 https://localhost:50000/b1s/v1/PaymentDrafts(123)

GET https://localhost:50000/b1s/v1/PaymentDrafts(123)?$select=DocNum,DocType,HandWritten

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PaymentDrafts

GET https://localhost:50000/b1s/v1/PaymentDrafts?$select=DocNum,DocType,HandWritten&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PaymentDrafts

{}

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 https://localhost:50000/b1s/v1/PaymentDrafts(123)

{}

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

Example

DELETE https://localhost:50000/b1s/v1/PaymentDrafts(123)

POST PaymentDrafts(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PaymentDrafts(123)/Cancel

POST PaymentDrafts(id)/SaveDraftToDocument
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PaymentDrafts(123)/SaveDraftToDocument

POST PaymentDrafts(id)/GetApprovalTemplates
Invoke the method 'GetApprovalTemplates' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PaymentDrafts(123)/GetApprovalTemplates

POST PaymentDrafts(id)/CancelbyCurrentSystemDate
Invoke the method 'CancelbyCurrentSystemDate' on this EntitySet with the specified id.

https://186.74.156.69:50000/Service Layer API Reference.html 236/334

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

POST https://localhost:50000/b1s/v1/PaymentDrafts(123)/CancelbyCurrentSystemDate

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 https://localhost:50000/b1s/v1/PaymentRunExport(123)

GET https://localhost:50000/b1s/v1/PaymentRunExport(123)?$select=AbsoluteEntry,RunDate,VendorNum

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 https://localhost:50000/b1s/v1/PaymentRunExport

GET https://localhost:50000/b1s/v1/PaymentRunExport?$select=AbsoluteEntry,RunDate,VendorNum&$filter=AbsoluteEntry 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 https://localhost:50000/b1s/v1/PaymentTermsTypes(123)

GET https://localhost:50000/b1s/v1/PaymentTermsTypes(123)?$select=GroupNumber,PaymentTermsGroupName,StartFrom

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 https://localhost:50000/b1s/v1/PaymentTermsTypes

GET https://localhost:50000/b1s/v1/PaymentTermsTypes?$select=GroupNumber,PaymentTermsGroupName,StartFrom&$filter=GroupNumber ge 123 &$orde

POST PaymentTermsTypes

Create an instance of 'PaymentTermsTypes' with the given payload of type 'PaymentTermsType' in JSON format.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 237/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/PaymentTermsTypes

{
"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 https://localhost:50000/b1s/v1/PaymentTermsTypes(123)

{
"GeneralDiscount": "10"
}

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

Example

DELETE https://localhost:50000/b1s/v1/PaymentTermsTypes(123)

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 https://localhost:50000/b1s/v1/PickLists(3)

GET https://localhost:50000/b1s/v1/PickLists(3)?$select=Absoluteentry,Name,OwnerCode

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 https://localhost:50000/b1s/v1/PickLists

GET https://localhost:50000/b1s/v1/PickLists?$select=Absoluteentry,Name,OwnerCode&$filter=Absoluteentry ge 2 &$orderby=Absoluteentry&$top=

POST PickLists

Create an instance of 'PickLists' with the given payload of type 'PickList' in JSON format.

Example

POST https://localhost:50000/b1s/v1/PickLists

{
"ObjectType": "156",
"PickDate": "2016-08-25",
"PickListsLines": [
{
"BaseObjectType": 17,
"OrderEntry": 9,
"OrderRowID": 0,

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PickLists(3)

{
"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 https://localhost:50000/b1s/v1/PickLists(19)

{
"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 https://localhost:50000/b1s/v1/PickLists(3)/GetReleasedAllocation

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.

https://186.74.156.69:50000/Service Layer API Reference.html 239/334

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

GET https://localhost:50000/b1s/v1/POSDailySummary(123)

GET https://localhost:50000/b1s/v1/POSDailySummary(123)?$select=AbsEntry,Date,EquipmentNo

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 https://localhost:50000/b1s/v1/POSDailySummary

GET https://localhost:50000/b1s/v1/POSDailySummary?$select=AbsEntry,Date,EquipmentNo&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/POSDailySummary

{
"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 https://localhost:50000/b1s/v1/POSDailySummary(123)

{
"Date": "2016-08-31",
"POSTotalizerCollection": [
{
"Code": "001",
"Description": "",
"Number": "2"
}
]
}

DELETE POSDailySummary(id)

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

Example

DELETE https://localhost:50000/b1s/v1/POSDailySummary(123)

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

https://186.74.156.69:50000/Service Layer API Reference.html 240/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/PredefinedTexts(1)

GET https://localhost:50000/b1s/v1/PredefinedTexts(1)?$select=Numerator,TextCode,Text

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 https://localhost:50000/b1s/v1/PredefinedTexts

GET https://localhost:50000/b1s/v1/PredefinedTexts?$select=Numerator,TextCode,Text&$filter=Numerator 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 https://localhost:50000/b1s/v1/PredefinedTexts

{
"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 https://localhost:50000/b1s/v1/PredefinedTexts(1)

{
"Text": "updating V5's text",
"TextCode": "V5"
}

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

Example

DELETE https://localhost:50000/b1s/v1/PredefinedTexts(1)

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 https://localhost:50000/b1s/v1/PriceLists(123)

GET https://localhost:50000/b1s/v1/PriceLists(123)?$select=RoundingMethod,GroupNum,BasePriceList

GET PriceLists

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

https://186.74.156.69:50000/Service Layer API Reference.html 241/334

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

GET https://localhost:50000/b1s/v1/PriceLists

GET https://localhost:50000/b1s/v1/PriceLists?$select=RoundingMethod,GroupNum,BasePriceList&$filter=PriceListNo ge 123 &$orderby=PriceList

POST PriceLists

Create an instance of 'PriceLists' with the given payload of type 'PriceList' in JSON format.

Example

POST https://localhost:50000/b1s/v1/PriceLists

{
"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 https://localhost:50000/b1s/v1/PriceLists(123)

{
"PriceListName": "Price List 40"
}

DELETE PriceLists(id)

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

Example

DELETE https://localhost:50000/b1s/v1/PriceLists(123)

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 https://localhost:50000/b1s/v1/ProductionOrders(123)

GET https://localhost:50000/b1s/v1/ProductionOrders(123)?$select=AbsoluteEntry,DocumentNumber,Series

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 https://localhost:50000/b1s/v1/ProductionOrders

GET https://localhost:50000/b1s/v1/ProductionOrders?$select=AbsoluteEntry,DocumentNumber,Series&$filter=AbsoluteEntry ge 123 &$orderby=Abs

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

https://186.74.156.69:50000/Service Layer API Reference.html 242/334

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

POST https://localhost:50000/b1s/v1/ProductionOrders

{
"DueDate": "2014-04-05",
"ItemNo": "bom1",
"PlannedQuantity": 100
}

POST https://localhost:50000/b1s/v1/ProductionOrders

{
"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 https://localhost:50000/b1s/v1/ProductionOrders(123)

{
"ProductionOrderStatus": "R",
"Remarks": "Updated Remarks"
}

POST ProductionOrders(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/ProductionOrders(123)/Cancel

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 https://localhost:50000/b1s/v1/ProductTrees('pt001')

GET https://localhost:50000/b1s/v1/ProductTrees('pt001')?$select=TreeCode,TreeType,Quantity

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 https://localhost:50000/b1s/v1/ProductTrees

GET https://localhost:50000/b1s/v1/ProductTrees?$select=TreeCode,TreeType,Quantity&$filter=startswith(TreeCode, 'a') &$orderby=TreeCode&$t

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

https://186.74.156.69:50000/Service Layer API Reference.html 243/334

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

POST https://localhost:50000/b1s/v1/ProductTrees

{
"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 https://localhost:50000/b1s/v1/ProductTrees('pt001')

{
"Quantity": 20
}

DELETE ProductTrees(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ProductTrees('pt001')

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 https://localhost:50000/b1s/v1/ProfitCenters('NY_B')

GET https://localhost:50000/b1s/v1/ProfitCenters('NY_B')?$select=CenterCode,CenterName,GroupCode

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 https://localhost:50000/b1s/v1/ProfitCenters

GET https://localhost:50000/b1s/v1/ProfitCenters?$select=CenterCode,CenterName,GroupCode&$filter=startswith(CenterCode, 'a') &$orderby=Cen

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

Example

POST https://localhost:50000/b1s/v1/ProfitCenters

{
"CenterCode": "NY_B",
"CenterName": "New York Branch",

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProfitCenters('NY_B')

{
"CenterName": "General Center"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ProfitCenters('NY_B')

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 https://localhost:50000/b1s/v1/ProjectManagements(123)

GET https://localhost:50000/b1s/v1/ProjectManagements(123)?$select=AbsEntry,Owner,ProjectName

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 https://localhost:50000/b1s/v1/ProjectManagements

GET https://localhost:50000/b1s/v1/ProjectManagements?$select=AbsEntry,Owner,ProjectName&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/ProjectManagements

{
"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",

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ProjectManagements(123)

{
"Reason": "Test comment update"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ProjectManagements(123)

POST ProjectManagements(id)/CancelProject
Invoke the method 'CancelProject' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/ProjectManagements(123)/CancelProject

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 https://localhost:50000/b1s/v1/ProjectManagementTimeSheet(2)

GET https://localhost:50000/b1s/v1/ProjectManagementTimeSheet(2)?$select=AbsEntry,DocNumber,TimeSheetType

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 https://localhost:50000/b1s/v1/ProjectManagementTimeSheet

GET https://localhost:50000/b1s/v1/ProjectManagementTimeSheet?$select=AbsEntry,DocNumber,TimeSheetType&$filter=AbsEntry ge 2 &$orderby=Abs

POST ProjectManagementTimeSheet

Create an instance of 'ProjectManagementTimeSheet' with the given payload of type 'PM_TimeSheetData' in JSON format.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 246/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/ProjectManagementTimeSheet

{
"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 https://localhost:50000/b1s/v1/ProjectManagementTimeSheet(2)

{
"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 https://localhost:50000/b1s/v1/ProjectManagementTimeSheet(2)

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 https://localhost:50000/b1s/v1/Projects('PRJ01')

GET https://localhost:50000/b1s/v1/Projects('PRJ01')?$select=Code,Name,ValidFrom

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 https://localhost:50000/b1s/v1/Projects

GET https://localhost:50000/b1s/v1/Projects?$select=Code,Name,ValidFrom&$filter=startswith(Code, 'a') &$orderby=Code&$top=10&$skip=1

POST Projects

Create an instance of 'Projects' with the given payload of type 'Project' in JSON format.

https://186.74.156.69:50000/Service Layer API Reference.html 247/334

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

POST https://localhost:50000/b1s/v1/Projects

{
"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 https://localhost:50000/b1s/v1/Projects('PRJ01')

{
"Name": "Med Constructions"
}

DELETE Projects(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Projects('PRJ01')

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 https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)

GET https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/PurchaseCreditNotes

GET https://localhost:50000/b1s/v1/PurchaseCreditNotes?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseCreditNotes

{
"CardCode": "c001",
"DocumentLines": [
{
"ItemCode": "i001",

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)

{
"Comments": "new comments - modified by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)

POST PurchaseCreditNotes(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)/Close

POST PurchaseCreditNotes(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)/Cancel

POST PurchaseCreditNotes(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)/Reopen

POST PurchaseCreditNotes(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseCreditNotes(123)/CreateCancellationDocument

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)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)

GET https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/PurchaseDeliveryNotes

GET https://localhost:50000/b1s/v1/PurchaseDeliveryNotes?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseDeliveryNotes

{
"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 https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)

{
"Comments": "new comments - modified by Service Layer"
}

DELETE PurchaseDeliveryNotes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)

POST PurchaseDeliveryNotes(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)/Close

POST PurchaseDeliveryNotes(id)/Cancel

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 250/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)/Cancel

POST PurchaseDeliveryNotes(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)/Reopen

POST PurchaseDeliveryNotes(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseDeliveryNotes(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PurchaseDownPayments(123)

GET https://localhost:50000/b1s/v1/PurchaseDownPayments(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/PurchaseDownPayments

GET https://localhost:50000/b1s/v1/PurchaseDownPayments?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseDownPayments

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

PATCH PurchaseDownPayments(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseDownPayments(123)

{
"Comments": "new comments - modified by Service Layer"
}

DELETE PurchaseDownPayments(id)

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

Example

DELETE https://localhost:50000/b1s/v1/PurchaseDownPayments(123)

POST PurchaseDownPayments(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/PurchaseDownPayments(123)/Close

POST PurchaseDownPayments(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/PurchaseDownPayments(123)/Cancel

POST PurchaseDownPayments(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/PurchaseDownPayments(123)/Reopen

POST PurchaseDownPayments(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/PurchaseDownPayments(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PurchaseInvoices(123)

GET https://localhost:50000/b1s/v1/PurchaseInvoices(123)?$select=DocEntry,DocNum,DocType

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseInvoices

GET https://localhost:50000/b1s/v1/PurchaseInvoices?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseInvoices

{
"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 https://localhost:50000/b1s/v1/PurchaseInvoices(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseInvoices(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/PurchaseInvoices(123)/Close

POST PurchaseInvoices(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/PurchaseInvoices(123)/Cancel

POST PurchaseInvoices(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/PurchaseInvoices(123)/Reopen

POST PurchaseInvoices(id)/CreateCancellationDocument

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 253/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/PurchaseInvoices(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PurchaseOrders(123)

GET https://localhost:50000/b1s/v1/PurchaseOrders(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/PurchaseOrders

GET https://localhost:50000/b1s/v1/PurchaseOrders?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseOrders

{
"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 https://localhost:50000/b1s/v1/PurchaseOrders(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseOrders(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/PurchaseOrders(123)/Close

POST PurchaseOrders(id)/Cancel

https://186.74.156.69:50000/Service Layer API Reference.html 254/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseOrders(123)/Cancel

POST PurchaseOrders(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/PurchaseOrders(123)/Reopen

POST PurchaseOrders(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/PurchaseOrders(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PurchaseQuotations(123)

GET https://localhost:50000/b1s/v1/PurchaseQuotations(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/PurchaseQuotations

GET https://localhost:50000/b1s/v1/PurchaseQuotations?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseQuotations

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

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseQuotations(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseQuotations(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseQuotations(123)/Close

POST PurchaseQuotations(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseQuotations(123)/Cancel

POST PurchaseQuotations(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseQuotations(123)/Reopen

POST PurchaseQuotations(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseQuotations(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PurchaseRequests(123)

GET https://localhost:50000/b1s/v1/PurchaseRequests(123)?$select=DocEntry,DocNum,DocType

GET PurchaseRequests

Retrieve a collection of 'PurchaseRequests' with all or some selected properties in the given order by specifying the given filter condition.
https://186.74.156.69:50000/Service Layer API Reference.html 256/334
6/7/24, 15:42 Service Layer API Reference
Example

GET https://localhost:50000/b1s/v1/PurchaseRequests

GET https://localhost:50000/b1s/v1/PurchaseRequests?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseRequests

{
"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 https://localhost:50000/b1s/v1/PurchaseRequests(123)

{
"Comments": "new comments - modified by Service Layer"
}

DELETE PurchaseRequests(id)

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

Example

DELETE https://localhost:50000/b1s/v1/PurchaseRequests(123)

POST PurchaseRequests(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/PurchaseRequests(123)/Close

POST PurchaseRequests(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/PurchaseRequests(123)/Cancel

POST PurchaseRequests(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/PurchaseRequests(123)/Reopen

POST PurchaseRequests(id)/CreateCancellationDocument
https://186.74.156.69:50000/Service Layer API Reference.html 257/334
6/7/24, 15:42 Service Layer API Reference
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseRequests(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PurchaseReturns(123)

GET https://localhost:50000/b1s/v1/PurchaseReturns(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/PurchaseReturns

GET https://localhost:50000/b1s/v1/PurchaseReturns?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseReturns

{
"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 https://localhost:50000/b1s/v1/PurchaseReturns(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST PurchaseReturns(id)/Close

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 258/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/PurchaseReturns(123)/Close

POST PurchaseReturns(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseReturns(123)/Cancel

POST PurchaseReturns(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseReturns(123)/Reopen

POST PurchaseReturns(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/PurchaseReturns(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/PurchaseTaxInvoices(123)

GET https://localhost:50000/b1s/v1/PurchaseTaxInvoices(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/PurchaseTaxInvoices

GET https://localhost:50000/b1s/v1/PurchaseTaxInvoices?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/PurchaseTaxInvoices

{
"CardCode": "v001",
"Comments": "create purchase tax invoice",
"DocType": "botit_Invoice",
"PurchaseTaxInvoiceLines": [
{

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/PurchaseTaxInvoices(123)

{
"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 https://localhost:50000/b1s/v1/QueryAuthGroups(-15)

GET https://localhost:50000/b1s/v1/QueryAuthGroups(-15)?$select=AuthGroupCode,AuthGroupDes,AuthGroupId

GET QueryAuthGroups

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

Example

GET https://localhost:50000/b1s/v1/QueryAuthGroups

GET https://localhost:50000/b1s/v1/QueryAuthGroups?$select=AuthGroupCode,AuthGroupDes,AuthGroupId &$filter=AuthGroupId eq -15

POST QueryAuthGroups

Create an instance of 'QueryAuthGroups' with the given payload of type 'QueryAuthGroup' in JSON format.GroupCode and GroupDes should be
unique,mandatory.

Example

POST https://localhost:50000/b1s/v1/QueryAuthGroups

{
"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 https://localhost:50000/b1s/v1/QueryAuthGroups(1)

{
"AuthGroupDes": "Group21descriptionupdate"

https://186.74.156.69:50000/Service Layer API Reference.html 260/334

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

PATCH QueryAuthGroups(id)
assign QueryAuthorizationGroups to query category.In http header, set B1S-ReplaceCollectionsOnPatch as false.

Example

PATCH https://localhost:50000/b1s/v1/QueryAuthGroups(1)

{
"CategoryGroupCollection": [
{
"CategoryId": -2
},
{
"CategoryId": -1
}
]
}

PATCH QueryAuthGroups(id)
unassign QueryAuthorizationGroups to query category such as Category with CategoryId=-1.In http header, set B1S-ReplaceCollectionsOnPatch as
true.

Example

PATCH https://localhost:50000/b1s/v1/QueryAuthGroups(1)

{
"CategoryGroupCollection": [
{
"CategoryId": -2
}
]
}

DELETE QueryAuthGroups(id)
Delete an instance of 'QueryAuthGroups' with the specified id.It is allowed only when no query category is assigned to the query group.

Example

DELETE https://localhost:50000/b1s/v1/QueryAuthGroups(1)

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 https://localhost:50000/b1s/v1/QueryCategories(123)

GET https://localhost:50000/b1s/v1/QueryCategories(123)?$select=Code,Name,Permissions

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 https://localhost:50000/b1s/v1/QueryCategories

GET https://localhost:50000/b1s/v1/QueryCategories?$select=Code,Name,Permissions&$filter=Code ge 123 &$orderby=Code&$top=10&$skip=1

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/QueryCategories

{
"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 https://localhost:50000/b1s/v1/QueryCategories(123)

{
"Name": "Query_Category_01",
"Permissions": "NNNYNNNNNNNNNNN"
}

DELETE QueryCategories(id)

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

Example

DELETE https://localhost:50000/b1s/v1/QueryCategories(123)

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 https://localhost:50000/b1s/v1/Queue('PCs')

GET https://localhost:50000/b1s/v1/Queue('PCs')?$select=QueueID,Description,Inactive

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 https://localhost:50000/b1s/v1/Queue

GET https://localhost:50000/b1s/v1/Queue?$select=QueueID,Description,Inactive&$filter=startswith(QueueID, 'a') &$orderby=QueueID&$top=10&$

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

Example

POST https://localhost:50000/b1s/v1/Queue

{
"Description": "PC Issues",
"QueueID": "PCs",

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Queue('PCs')

{
"Description": "Printer Issues"
}

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

Example

DELETE https://localhost:50000/b1s/v1/Queue('PCs')

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 https://localhost:50000/b1s/v1/Quotations(123)

GET https://localhost:50000/b1s/v1/Quotations(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/Quotations

GET https://localhost:50000/b1s/v1/Quotations?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/Quotations

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

PATCH Quotations(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Quotations(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST Quotations(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/Quotations(123)/Close

POST Quotations(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/Quotations(123)/Cancel

POST Quotations(id)/Reopen

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

Example

POST https://localhost:50000/b1s/v1/Quotations(123)/Reopen

POST Quotations(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/Quotations(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/Relationships(123)

GET https://localhost:50000/b1s/v1/Relationships(123)?$select=RelationshipDescription,RelationshipCode

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 https://localhost:50000/b1s/v1/Relationships

https://186.74.156.69:50000/Service Layer API Reference.html 264/334

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

GET https://localhost:50000/b1s/v1/Relationships?$select=RelationshipDescription,RelationshipCode&$filter=RelationshipCode ge 123 &$orderb

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

Example

POST https://localhost:50000/b1s/v1/Relationships

{
"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 https://localhost:50000/b1s/v1/Relationships(123)

{
"RelationshipDescription": "One time"
}

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

Example

DELETE https://localhost:50000/b1s/v1/Relationships(123)

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 https://localhost:50000/b1s/v1/ReportFilter(1)

GET https://localhost:50000/b1s/v1/ReportFilter(1)?$select=Code,Name,ReportLayout

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 https://localhost:50000/b1s/v1/ReportFilter

GET https://localhost:50000/b1s/v1/ReportFilter?$select=Code,Name,ReportLayout&$filter=Code 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

https://186.74.156.69:50000/Service Layer API Reference.html 265/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/ReportFilter

{
"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 https://localhost:50000/b1s/v1/ReportFilter(1)

{
"FromDate": "2016-08-01",
"ToDate": "2016-08-31"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ReportFilter(1)

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 https://localhost:50000/b1s/v1/ReportTypes('A001')

GET https://localhost:50000/b1s/v1/ReportTypes('A001')?$select=TypeCode,TypeName,DefaultReportLayout

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 https://localhost:50000/b1s/v1/ReportTypes

GET https://localhost:50000/b1s/v1/ReportTypes?$select=TypeCode,TypeName,DefaultReportLayout&$filter=startswith(TypeCode, 'a') &$orderby=T

POST ReportTypes

Create an instance of 'ReportTypes' with the given payload of type 'ReportType' in JSON format.

Example

POST https://localhost:50000/b1s/v1/ReportTypes

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 266/334

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

PATCH https://localhost:50000/b1s/v1/ReportTypes('A001')

{
"TypeName": "update report type 01"
}

DELETE ReportTypes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ReportTypes('A001')

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 https://localhost:50000/b1s/v1/ResourceCapacities(123)

GET https://localhost:50000/b1s/v1/ResourceCapacities(123)?$select=Id,Code,Warehouse

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 https://localhost:50000/b1s/v1/ResourceCapacities

GET https://localhost:50000/b1s/v1/ResourceCapacities?$select=Id,Code,Warehouse&$filter=Id 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 https://localhost:50000/b1s/v1/ResourceCapacities

{
"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"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ResourceCapacities(123)

{
"Capacity": 15
}

DELETE ResourceCapacities(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ResourceCapacities(123)

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 https://localhost:50000/b1s/v1/ResourceGroups(123)

GET https://localhost:50000/b1s/v1/ResourceGroups(123)?$select=Code,Name,Type

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 https://localhost:50000/b1s/v1/ResourceGroups

GET https://localhost:50000/b1s/v1/ResourceGroups?$select=Code,Name,Type&$filter=Code 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 https://localhost:50000/b1s/v1/ResourceGroups

{
"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",
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ResourceGroups(123)

{
"Name": "tRessourcen"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ResourceGroups(123)

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 https://localhost:50000/b1s/v1/ResourceProperties(123)

GET https://localhost:50000/b1s/v1/ResourceProperties(123)?$select=Code,Name

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 https://localhost:50000/b1s/v1/ResourceProperties

GET https://localhost:50000/b1s/v1/ResourceProperties?$select=Code,Name&$filter=Code 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 https://localhost:50000/b1s/v1/ResourceProperties(123)

{}

Resources
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Resources('abc')

GET https://localhost:50000/b1s/v1/Resources('abc')?$select=Code,VisCode,Series

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 https://localhost:50000/b1s/v1/Resources

GET https://localhost:50000/b1s/v1/Resources?$select=Code,VisCode,Series&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/Resources

{
"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",

https://186.74.156.69:50000/Service Layer API Reference.html 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,

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Resources('abc')

{
"Name": "test"
}

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

Example

DELETE https://localhost:50000/b1s/v1/Resources('abc')

POST Resources(id)/CreateLinkedItem
Invoke the method 'CreateLinkedItem' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Resources('abc')/CreateLinkedItem

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 https://localhost:50000/b1s/v1/RetornoCodes(123)

GET https://localhost:50000/b1s/v1/RetornoCodes(123)?$select=AbsEntry,OccurenceCode,MovementCode

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/RetornoCodes

GET https://localhost:50000/b1s/v1/RetornoCodes?$select=AbsEntry,OccurenceCode,MovementCode&$filter=AbsEntry ge 123 &$orderby=AbsEntry&$to

POST RetornoCodes

Create an instance of 'RetornoCodes' with the given payload of type 'RetornoCode' in JSON format.

Example

POST https://localhost:50000/b1s/v1/RetornoCodes

{
"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 https://localhost:50000/b1s/v1/RetornoCodes(123)

{
"BankCode": "1000"
}

DELETE RetornoCodes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/RetornoCodes(123)

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 https://localhost:50000/b1s/v1/ReturnRequest(123)

GET https://localhost:50000/b1s/v1/ReturnRequest(123)?$select=DocEntry,DocNum,DocType

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 273/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/ReturnRequest

GET https://localhost:50000/b1s/v1/ReturnRequest?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/ReturnRequest

{
"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 https://localhost:50000/b1s/v1/ReturnRequest(123)

{
"Comments": "new comments - modified by Service Layer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ReturnRequest(123)

POST ReturnRequest(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/ReturnRequest(123)/Close

POST ReturnRequest(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/ReturnRequest(123)/Cancel

POST ReturnRequest(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/ReturnRequest(123)/Reopen

POST ReturnRequest(id)/SaveDraftToDocument

https://186.74.156.69:50000/Service Layer API Reference.html 274/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/ReturnRequest(123)/SaveDraftToDocument

POST ReturnRequest(id)/CreateCancellationDocument

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

Example

POST https://localhost:50000/b1s/v1/ReturnRequest(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/Returns(123)

GET https://localhost:50000/b1s/v1/Returns(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/Returns

GET https://localhost:50000/b1s/v1/Returns?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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 https://localhost:50000/b1s/v1/Returns

{
"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 https://localhost:50000/b1s/v1/Returns(123)

{
"Comments": "new comments - modified by Service Layer"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Returns(123)

POST Returns(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Returns(123)/Close

POST Returns(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Returns(123)/Cancel

POST Returns(id)/Reopen
Invoke the method 'Reopen' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Returns(123)/Reopen

POST Returns(id)/CreateCancellationDocument
Invoke the method 'CreateCancellationDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/Returns(123)/CreateCancellationDocument

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 https://localhost:50000/b1s/v1/RouteStages(123)

GET https://localhost:50000/b1s/v1/RouteStages(123)?$select=InternalNumber,Code,Description

GET RouteStages

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 276/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/RouteStages

GET https://localhost:50000/b1s/v1/RouteStages?$select=InternalNumber,Code,Description&$filter=InternalNumber ge 123 &$orderby=InternalNum

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

Example

POST https://localhost:50000/b1s/v1/RouteStages

{}

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 https://localhost:50000/b1s/v1/RouteStages(123)

{}

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

Example

DELETE https://localhost:50000/b1s/v1/RouteStages(123)

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 https://localhost:50000/b1s/v1/SalesForecast(123)

GET https://localhost:50000/b1s/v1/SalesForecast(123)?$select=ForecastStartDate,ForecastEndDate,ForecastCode

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 https://localhost:50000/b1s/v1/SalesForecast

GET https://localhost:50000/b1s/v1/SalesForecast?$select=ForecastStartDate,ForecastEndDate,ForecastCode&$filter=Numerator ge 123 &$orderby

POST SalesForecast

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

Example

POST https://localhost:50000/b1s/v1/SalesForecast

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesForecast(123)

{
"ForecastName": "Daily forecast for item01"
}

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

Example

DELETE https://localhost:50000/b1s/v1/SalesForecast(123)

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 https://localhost:50000/b1s/v1/SalesOpportunities(123)

GET https://localhost:50000/b1s/v1/SalesOpportunities(123)?$select=SequentialNo,CardCode,SalesPerson

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 https://localhost:50000/b1s/v1/SalesOpportunities

GET https://localhost:50000/b1s/v1/SalesOpportunities?$select=SequentialNo,CardCode,SalesPerson&$filter=SequentialNo ge 123 &$orderby=Sequ

POST SalesOpportunities

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

Example

POST https://localhost:50000/b1s/v1/SalesOpportunities

{
"InventoryCountingLines": [
{
"ItemCode": "I003",
"WarehouseCode": "01"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesOpportunities(123)

{
"OpportunityName": "Updated Name"
}

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

Example

DELETE https://localhost:50000/b1s/v1/SalesOpportunities(123)

POST SalesOpportunities(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/SalesOpportunities(123)/Close

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 https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetup(123)

GET https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetup(123)?$select=SequenceNo,Name,ThreatLevel

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 https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetup

GET https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetup?$select=SequenceNo,Name,ThreatLevel&$filter=SequenceNo ge 123 &$orderb

POST SalesOpportunityCompetitorsSetup

Create an instance of 'SalesOpportunityCompetitorsSetup' with the given payload of type 'SalesOpportunityCompetitorSetup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetup

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetup(123)

{
"Details": "2222"
}

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

Example

DELETE https://localhost:50000/b1s/v1/SalesOpportunityCompetitorsSetup(123)

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 https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetup(123)

GET https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetup(123)?$select=SequenceNo,Description,Sort

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 https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetup

GET https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetup?$select=SequenceNo,Description,Sort&$filter=SequenceNo ge 123 &$orderby=

POST SalesOpportunityInterestsSetup

Create an instance of 'SalesOpportunityInterestsSetup' with the given payload of type 'SalesOpportunityInterestSetup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetup

{
"Description": "good",
"SequenceNo": 2,
"Sort": 100
}

PATCH SalesOpportunityInterestsSetup(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetup(123)

{
"Description": "good"
}

DELETE SalesOpportunityInterestsSetup(id)

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

Example

DELETE https://localhost:50000/b1s/v1/SalesOpportunityInterestsSetup(123)

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 https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetup(123)

GET https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetup(123)?$select=SequenceNo,Description,Sort

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 https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetup

GET https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetup?$select=SequenceNo,Description,Sort&$filter=SequenceNo ge 123 &$orderby=Se

POST SalesOpportunityReasonsSetup

Create an instance of 'SalesOpportunityReasonsSetup' with the given payload of type 'SalesOpportunityReasonSetup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetup

{
"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 https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetup(123)

{
"Sort": 10

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesOpportunityReasonsSetup(123)

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 https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetup(123)

GET https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetup(123)?$select=SequenceNo,Description,Sort

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 https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetup

GET https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetup?$select=SequenceNo,Description,Sort&$filter=SequenceNo ge 123 &$orderby=Se

POST SalesOpportunitySourcesSetup

Create an instance of 'SalesOpportunitySourcesSetup' with the given payload of type 'SalesOpportunitySourceSetup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetup

{
"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 https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetup(123)

{
"Sort": 21
}

DELETE SalesOpportunitySourcesSetup(id)

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 282/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/SalesOpportunitySourcesSetup(123)

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 https://localhost:50000/b1s/v1/SalesPersons(123)

GET https://localhost:50000/b1s/v1/SalesPersons(123)?$select=SalesEmployeeCode,SalesEmployeeName,Remarks

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 https://localhost:50000/b1s/v1/SalesPersons

GET https://localhost:50000/b1s/v1/SalesPersons?$select=SalesEmployeeCode,SalesEmployeeName,Remarks&$filter=SalesEmployeeCode ge 123 &$ord

POST SalesPersons

Create an instance of 'SalesPersons' with the given payload of type 'SalesPerson' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SalesPersons

{
"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 https://localhost:50000/b1s/v1/SalesPersons(123)

{
"Remarks": "new star"
}

DELETE SalesPersons(id)

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

Example

DELETE https://localhost:50000/b1s/v1/SalesPersons(123)

SalesStages
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesStages(123)

GET https://localhost:50000/b1s/v1/SalesStages(123)?$select=SequenceNo,Name,Stageno

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 https://localhost:50000/b1s/v1/SalesStages

GET https://localhost:50000/b1s/v1/SalesStages?$select=SequenceNo,Name,Stageno&$filter=SequenceNo 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 https://localhost:50000/b1s/v1/SalesStages

{
"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 https://localhost:50000/b1s/v1/SalesStages(123)

{
"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 https://localhost:50000/b1s/v1/SalesTaxAuthorities(Code='WYN',Type=-3)

GET https://localhost:50000/b1s/v1/SalesTaxAuthorities(Code='WYN',Type=-3)?$select=UseTaxAccount,UserSignature,Type

GET SalesTaxAuthorities

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesTaxAuthorities

GET https://localhost:50000/b1s/v1/SalesTaxAuthorities?$select=UseTaxAccount,UserSignature,Type&$filter=startswith(Code, 'a') and Type ge

POST SalesTaxAuthorities

Create an instance of 'SalesTaxAuthorities' with the given payload of type 'SalesTaxAuthority' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SalesTaxAuthorities

{
"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 https://localhost:50000/b1s/v1/SalesTaxAuthorities(Code='WYN',Type=-3)

{
"Name": "new Wyoming",
"TaxDefinitions": [
{
"Effectivefrom": "2002-01-01",
"Rate": "25"
}
]
}

DELETE SalesTaxAuthorities(id)

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

Example

DELETE https://localhost:50000/b1s/v1/SalesTaxAuthorities(Code='WYN',Type=-3)

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 https://localhost:50000/b1s/v1/SalesTaxAuthoritiesTypes(123)

GET https://localhost:50000/b1s/v1/SalesTaxAuthoritiesTypes(123)?$select=UserSignature,Name,VAT

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesTaxAuthoritiesTypes

GET https://localhost:50000/b1s/v1/SalesTaxAuthoritiesTypes?$select=UserSignature,Name,VAT&$filter=Numerator ge 123 &$orderby=Numerator&$t

POST SalesTaxAuthoritiesTypes

Create an instance of 'SalesTaxAuthoritiesTypes' with the given payload of type 'SalesTaxAuthoritiesType' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SalesTaxAuthoritiesTypes

{
"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 https://localhost:50000/b1s/v1/SalesTaxAuthoritiesTypes(123)

{
"Name": "Street"
}

DELETE SalesTaxAuthoritiesTypes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/SalesTaxAuthoritiesTypes(123)

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 https://localhost:50000/b1s/v1/SalesTaxCodes('T1')

GET https://localhost:50000/b1s/v1/SalesTaxCodes('T1')?$select=ValidForAR,ValidForAP,UserSignature

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 https://localhost:50000/b1s/v1/SalesTaxCodes

GET https://localhost:50000/b1s/v1/SalesTaxCodes?$select=ValidForAR,ValidForAP,UserSignature&$filter=startswith(Code, 'a') &$orderby=Code&

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SalesTaxCodes

{
"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 https://localhost:50000/b1s/v1/SalesTaxCodes('T1')

{
"Name": "UpdatedTaxName"
}

DELETE SalesTaxCodes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/SalesTaxCodes('T1')

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 https://localhost:50000/b1s/v1/SalesTaxInvoices(123)

GET https://localhost:50000/b1s/v1/SalesTaxInvoices(123)?$select=DocEntry,DocNum,DocType

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 https://localhost:50000/b1s/v1/SalesTaxInvoices

GET https://localhost:50000/b1s/v1/SalesTaxInvoices?$select=DocEntry,DocNum,DocType&$filter=DocEntry 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

https://186.74.156.69:50000/Service Layer API Reference.html 287/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/SalesTaxInvoices

{
"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 https://localhost:50000/b1s/v1/SalesTaxInvoices(123)

{
"Comments": "Update sales tax invoice"
}

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

Example

DELETE https://localhost:50000/b1s/v1/SalesTaxInvoices(123)

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 https://localhost:50000/b1s/v1/Sections(1)

GET https://localhost:50000/b1s/v1/Sections(1)?$select=AbsEntry,Code,Description

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 https://localhost:50000/b1s/v1/Sections

GET https://localhost:50000/b1s/v1/Sections?$select=AbsEntry,Code,Description&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/Sections

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Sections(1)

{
"Code": "001",
"Description": "updated section 01 code"
}

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

Example

DELETE https://localhost:50000/b1s/v1/Sections(1)

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 https://localhost:50000/b1s/v1/SerialNumberDetails(123)

GET https://localhost:50000/b1s/v1/SerialNumberDetails(123)?$select=DocEntry,ItemCode,ItemDescription

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 https://localhost:50000/b1s/v1/SerialNumberDetails

GET https://localhost:50000/b1s/v1/SerialNumberDetails?$select=DocEntry,ItemCode,ItemDescription&$filter=DocEntry 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 https://localhost:50000/b1s/v1/SerialNumberDetails(123)

{}

ServiceCallOrigins
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ServiceCallOrigins(1)

GET https://localhost:50000/b1s/v1/ServiceCallOrigins(1)?$select=OriginID,Name,Description

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 https://localhost:50000/b1s/v1/ServiceCallOrigins

GET https://localhost:50000/b1s/v1/ServiceCallOrigins?$select=OriginID,Name,Description&$filter=OriginID 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 https://localhost:50000/b1s/v1/ServiceCallOrigins

{
"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 https://localhost:50000/b1s/v1/ServiceCallOrigins(1)

{
"Description": "E-123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ServiceCallOrigins(1)

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 https://localhost:50000/b1s/v1/ServiceCallProblemSubTypes(1)

https://186.74.156.69:50000/Service Layer API Reference.html 290/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/ServiceCallProblemSubTypes(1)?$select=ProblemSubTypeID,Name,Description

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 https://localhost:50000/b1s/v1/ServiceCallProblemSubTypes

GET https://localhost:50000/b1s/v1/ServiceCallProblemSubTypes?$select=ProblemSubTypeID,Name,Description&$filter=ProblemSubTypeID ge 1 &$or

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

Example

POST https://localhost:50000/b1s/v1/ServiceCallProblemSubTypes

{
"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 https://localhost:50000/b1s/v1/ServiceCallProblemSubTypes(1)

{
"Description": "123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ServiceCallProblemSubTypes(1)

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 https://localhost:50000/b1s/v1/ServiceCallProblemTypes(1)

GET https://localhost:50000/b1s/v1/ServiceCallProblemTypes(1)?$select=ProblemTypeID,Name,Description

GET ServiceCallProblemTypes

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 291/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/ServiceCallProblemTypes

GET https://localhost:50000/b1s/v1/ServiceCallProblemTypes?$select=ProblemTypeID,Name,Description&$filter=ProblemTypeID ge 1 &$orderby=Pro

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

Example

POST https://localhost:50000/b1s/v1/ServiceCallProblemTypes

{
"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 https://localhost:50000/b1s/v1/ServiceCallProblemTypes(1)

{
"Description": "123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ServiceCallProblemTypes(1)

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 https://localhost:50000/b1s/v1/ServiceCalls(123)

GET https://localhost:50000/b1s/v1/ServiceCalls(123)?$select=ServiceCallID,Subject,CustomerCode

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 https://localhost:50000/b1s/v1/ServiceCalls

GET https://localhost:50000/b1s/v1/ServiceCalls?$select=ServiceCallID,Subject,CustomerCode&$filter=ServiceCallID ge 123 &$orderby=ServiceC

POST ServiceCalls

Create an instance of 'ServiceCalls' with the given payload of type 'ServiceCall' in JSON format.

https://186.74.156.69:50000/Service Layer API Reference.html 292/334

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

POST https://localhost:50000/b1s/v1/ServiceCalls

{
"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 https://localhost:50000/b1s/v1/ServiceCalls(123)

{
"Subject": "new subject - modified by Service Layer"
}

DELETE ServiceCalls(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ServiceCalls(123)

POST ServiceCalls(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/ServiceCalls(123)/Close

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 https://localhost:50000/b1s/v1/ServiceCallSolutionStatus(1)

GET https://localhost:50000/b1s/v1/ServiceCallSolutionStatus(1)?$select=StatusId,Name,Description

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 https://localhost:50000/b1s/v1/ServiceCallSolutionStatus

GET https://localhost:50000/b1s/v1/ServiceCallSolutionStatus?$select=StatusId,Name,Description&$filter=StatusId ge 1 &$orderby=StatusId&$t

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

Example
https://186.74.156.69:50000/Service Layer API Reference.html 293/334
6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/ServiceCallSolutionStatus

{
"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 https://localhost:50000/b1s/v1/ServiceCallSolutionStatus(1)

{
"Description": "Publish 123"
}

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

Example

DELETE https://localhost:50000/b1s/v1/ServiceCallSolutionStatus(1)

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 https://localhost:50000/b1s/v1/ServiceCallStatus(1)

GET https://localhost:50000/b1s/v1/ServiceCallStatus(1)?$select=StatusId,Name,Description

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 https://localhost:50000/b1s/v1/ServiceCallStatus

GET https://localhost:50000/b1s/v1/ServiceCallStatus?$select=StatusId,Name,Description&$filter=StatusId 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 https://localhost:50000/b1s/v1/ServiceCallStatus

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 294/334

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

PATCH https://localhost:50000/b1s/v1/ServiceCallStatus(1)

{
"Description": "123"
}

DELETE ServiceCallStatus(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ServiceCallStatus(1)

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 https://localhost:50000/b1s/v1/ServiceCallTypes(1)

GET https://localhost:50000/b1s/v1/ServiceCallTypes(1)?$select=CallTypeID,Name,Description

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 https://localhost:50000/b1s/v1/ServiceCallTypes

GET https://localhost:50000/b1s/v1/ServiceCallTypes?$select=CallTypeID,Name,Description&$filter=CallTypeID ge 1 &$orderby=CallTypeID&$top=

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

Example

POST https://localhost:50000/b1s/v1/ServiceCallTypes

{
"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 https://localhost:50000/b1s/v1/ServiceCallTypes(1)

{
"Description": "test123"
}

DELETE ServiceCallTypes(id)

https://186.74.156.69:50000/Service Layer API Reference.html 295/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'ServiceCallTypes' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/ServiceCallTypes(1)

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 https://localhost:50000/b1s/v1/ServiceContracts(123)

GET https://localhost:50000/b1s/v1/ServiceContracts(123)?$select=ContractID,CustomerCode,CustomerName

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 https://localhost:50000/b1s/v1/ServiceContracts

GET https://localhost:50000/b1s/v1/ServiceContracts?$select=ContractID,CustomerCode,CustomerName&$filter=ContractID ge 123 &$orderby=Contr

POST ServiceContracts

Create an instance of 'ServiceContracts' with the given payload of type 'ServiceContract' in JSON format.

Example

POST https://localhost:50000/b1s/v1/ServiceContracts

{
"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 https://localhost:50000/b1s/v1/ServiceContracts(123)

{
"Remarks": "Silver Warranty Contract"
}

DELETE ServiceContracts(id)

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 296/334

6/7/24, 15:42 Service Layer API Reference
DELETE https://localhost:50000/b1s/v1/ServiceContracts(123)

POST ServiceContracts(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/ServiceContracts(123)/Cancel

POST ServiceContracts(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/ServiceContracts(123)/Close

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 https://localhost:50000/b1s/v1/ServiceGroups(2)

GET https://localhost:50000/b1s/v1/ServiceGroups(2)?$select=AbsEntry,ServiceGroupCode,Description

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 https://localhost:50000/b1s/v1/ServiceGroups

GET https://localhost:50000/b1s/v1/ServiceGroups?$select=AbsEntry,ServiceGroupCode,Description&$filter=AbsEntry ge 2 &$orderby=AbsEntry&$t

POST ServiceGroups

Create an instance of 'ServiceGroups' with the given payload of type 'ServiceGroup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/ServiceGroups

{
"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 https://localhost:50000/b1s/v1/ServiceGroups(2)

{
"Description": "test"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/ServiceGroups(2)

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 https://localhost:50000/b1s/v1/ShippingTypes(123)

GET https://localhost:50000/b1s/v1/ShippingTypes(123)?$select=Code,Name,Website

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 https://localhost:50000/b1s/v1/ShippingTypes

GET https://localhost:50000/b1s/v1/ShippingTypes?$select=Code,Name,Website&$filter=Code 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 https://localhost:50000/b1s/v1/ShippingTypes

{
"Name": "UPS Ground",
"Website": "http://www.ups.com/"
}

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 https://localhost:50000/b1s/v1/ShippingTypes(123)

{
"Website": "http://www.ups.com/cn"
}

DELETE ShippingTypes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/ShippingTypes(123)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/SpecialPrices(CardCode='c001',ItemCode='i001')

GET https://localhost:50000/b1s/v1/SpecialPrices(CardCode='c001',ItemCode='i001')?$select=ItemCode,CardCode,Price

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 https://localhost:50000/b1s/v1/SpecialPrices

GET https://localhost:50000/b1s/v1/SpecialPrices?$select=ItemCode,CardCode,Price&$filter=startswith(CardCode, 'a') and startswith(ItemCode

POST SpecialPrices

Create an instance of 'SpecialPrices' with the given payload of type 'SpecialPrice' in JSON format.

Example

POST https://localhost:50000/b1s/v1/SpecialPrices

{
"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 https://localhost:50000/b1s/v1/SpecialPrices(CardCode='c001',ItemCode='i001')

{
"DiscountPercent": 20
}

DELETE SpecialPrices(id)

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

Example

DELETE https://localhost:50000/b1s/v1/SpecialPrices(CardCode='c001',ItemCode='i001')

States
Show/Hide
List Operations
Expand Operations

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/States(Country='abc',Code='abc')

GET https://localhost:50000/b1s/v1/States(Country='abc',Code='abc')?$select=Code,Country,Name

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 https://localhost:50000/b1s/v1/States

GET https://localhost:50000/b1s/v1/States?$select=Code,Country,Name&$filter=startswith(Country, '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 https://localhost:50000/b1s/v1/States

{
"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 https://localhost:50000/b1s/v1/States(Country='abc',Code='abc')

{
"Name": "Alaska"
}

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

Example

DELETE https://localhost:50000/b1s/v1/States(Country='abc',Code='abc')

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 https://localhost:50000/b1s/v1/StockTakings(ItemCode='abc',WarehouseCode='abc')

https://186.74.156.69:50000/Service Layer API Reference.html 300/334

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

GET https://localhost:50000/b1s/v1/StockTakings(ItemCode='abc',WarehouseCode='abc')?$select=ItemCode,WarehouseCode,Counted

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 https://localhost:50000/b1s/v1/StockTakings

GET https://localhost:50000/b1s/v1/StockTakings?$select=ItemCode,WarehouseCode,Counted&$filter=startswith(ItemCode, 'a') and startswith(Wa

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

Example

POST https://localhost:50000/b1s/v1/StockTakings

{
"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 https://localhost:50000/b1s/v1/StockTakings(ItemCode='abc',WarehouseCode='abc')

{}

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

Example

DELETE https://localhost:50000/b1s/v1/StockTakings(ItemCode='abc',WarehouseCode='abc')

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 https://localhost:50000/b1s/v1/StockTransferDrafts(123)

GET https://localhost:50000/b1s/v1/StockTransferDrafts(123)?$select=DocEntry,Series,Printed

GET StockTransferDrafts

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 301/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/StockTransferDrafts

GET https://localhost:50000/b1s/v1/StockTransferDrafts?$select=DocEntry,Series,Printed&$filter=DocEntry 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 https://localhost:50000/b1s/v1/StockTransferDrafts

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

POST https://localhost:50000/b1s/v1/StockTransferDrafts

{
"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 https://localhost:50000/b1s/v1/StockTransferDrafts(123)

{
"Comments": "new comments - modified by Service Layer"
}

POST StockTransferDrafts(id)/Cancel
Invoke the method 'Cancel' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/StockTransferDrafts(123)/Cancel

POST StockTransferDrafts(id)/Close
Invoke the method 'Close' on this EntitySet with the specified id.

Example

https://186.74.156.69:50000/Service Layer API Reference.html 302/334

6/7/24, 15:42 Service Layer API Reference
POST https://localhost:50000/b1s/v1/StockTransferDrafts(123)/Close

POST StockTransferDrafts(id)/SaveDraftToDocument
Invoke the method 'SaveDraftToDocument' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/StockTransferDrafts(123)/SaveDraftToDocument

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 https://localhost:50000/b1s/v1/StockTransfers(123)

GET https://localhost:50000/b1s/v1/StockTransfers(123)?$select=DocEntry,Series,Printed

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 https://localhost:50000/b1s/v1/StockTransfers

GET https://localhost:50000/b1s/v1/StockTransfers?$select=DocEntry,Series,Printed&$filter=DocEntry 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 https://localhost:50000/b1s/v1/StockTransfers

{
"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 https://localhost:50000/b1s/v1/StockTransfers(123)

{
"Comments": "new comments - modified by Service Layer"
}

DELETE StockTransfers(id)

https://186.74.156.69:50000/Service Layer API Reference.html 303/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'StockTransfers' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/StockTransfers(123)

POST StockTransfers(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/StockTransfers(123)/Cancel

POST StockTransfers(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/StockTransfers(123)/Close

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 https://localhost:50000/b1s/v1/TargetGroups('abc')

GET https://localhost:50000/b1s/v1/TargetGroups('abc')?$select=TargetGroupCode,TargetGroupName,TargetGroupType

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 https://localhost:50000/b1s/v1/TargetGroups

GET https://localhost:50000/b1s/v1/TargetGroups?$select=TargetGroupCode,TargetGroupName,TargetGroupType&$filter=startswith(TargetGroupCode

POST TargetGroups

Create an instance of 'TargetGroups' with the given payload of type 'TargetGroup' in JSON format.

Example

POST https://localhost:50000/b1s/v1/TargetGroups

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 304/334

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

PATCH https://localhost:50000/b1s/v1/TargetGroups('abc')

{
"TargetGroupName": "21"
}

DELETE TargetGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/TargetGroups('abc')

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 https://localhost:50000/b1s/v1/TaxCodeDeterminations(1)

GET https://localhost:50000/b1s/v1/TaxCodeDeterminations(1)?$select=DocEntry,LineNumber,DocumentType

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 https://localhost:50000/b1s/v1/TaxCodeDeterminations

GET https://localhost:50000/b1s/v1/TaxCodeDeterminations?$select=DocEntry,LineNumber,DocumentType&$filter=DocEntry ge 1 &$orderby=DocEntry

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

Example

POST https://localhost:50000/b1s/v1/TaxCodeDeterminations

{
"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 https://localhost:50000/b1s/v1/TaxCodeDeterminations(1)

{
"Description": "123"

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/TaxCodeDeterminations(1)

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 https://localhost:50000/b1s/v1/TaxCodeDeterminationsTCD(4)

GET https://localhost:50000/b1s/v1/TaxCodeDeterminationsTCD(4)?$select=AbsId,TcdType,DftArCode

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 https://localhost:50000/b1s/v1/TaxCodeDeterminationsTCD

GET https://localhost:50000/b1s/v1/TaxCodeDeterminationsTCD?$select=AbsId,TcdType,DftArCode&$filter=AbsId 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 https://localhost:50000/b1s/v1/TaxCodeDeterminationsTCD(4)

{
"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"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/TaxInvoiceReport('0160000001')

GET https://localhost:50000/b1s/v1/TaxInvoiceReport('0160000001')?$select=NTSApproval,ETaxWebSite,ETaxNo

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 https://localhost:50000/b1s/v1/TaxInvoiceReport

GET https://localhost:50000/b1s/v1/TaxInvoiceReport?$select=NTSApproval,ETaxWebSite,ETaxNo&$filter=startswith(TaxInvoiceReportNumber, '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 https://localhost:50000/b1s/v1/TaxInvoiceReport('0160000001')

{
"Remarks": "test"
}

POST TaxInvoiceReport(id)/CancelTaxInvoiceReport
Invoke the method 'CancelTaxInvoiceReport' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/TaxInvoiceReport('0160000001')/CancelTaxInvoiceReport

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 https://localhost:50000/b1s/v1/TaxWebSites(1)

GET https://localhost:50000/b1s/v1/TaxWebSites(1)?$select=AbsEntry,WebSiteName,WebSiteURL

GET TaxWebSites

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

https://186.74.156.69:50000/Service Layer API Reference.html 307/334

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

GET https://localhost:50000/b1s/v1/TaxWebSites

GET https://localhost:50000/b1s/v1/TaxWebSites?$select=AbsEntry,WebSiteName,WebSiteURL&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/TaxWebSites

{
"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 https://localhost:50000/b1s/v1/TaxWebSites(1)

{
"WebSiteName": "test123"
}

DELETE TaxWebSites(id)

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

Example

DELETE https://localhost:50000/b1s/v1/TaxWebSites(1)

POST TaxWebSites(id)/SetAsDefault

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

Example

POST https://localhost:50000/b1s/v1/TaxWebSites(1)/SetAsDefault

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 https://localhost:50000/b1s/v1/Teams(123)

GET https://localhost:50000/b1s/v1/Teams(123)?$select=TeamID,TeamName,Description

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

https://186.74.156.69:50000/Service Layer API Reference.html 308/334

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

GET https://localhost:50000/b1s/v1/Teams

GET https://localhost:50000/b1s/v1/Teams?$select=TeamID,TeamName,Description&$filter=TeamID 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 https://localhost:50000/b1s/v1/Teams

{
"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 https://localhost:50000/b1s/v1/Teams(123)

{
"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 https://localhost:50000/b1s/v1/TerminationReason(1)

GET https://localhost:50000/b1s/v1/TerminationReason(1)?$select=ReasonID,Name,Description

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 https://localhost:50000/b1s/v1/TerminationReason

GET https://localhost:50000/b1s/v1/TerminationReason?$select=ReasonID,Name,Description&$filter=ReasonID ge 1 &$orderby=ReasonID&$top=10&$s

POST TerminationReason
Create an instance of 'TerminationReason' with the given payload of type 'TerminationReason' in JSON format.
https://186.74.156.69:50000/Service Layer API Reference.html 309/334
6/7/24, 15:42 Service Layer API Reference
Example

POST https://localhost:50000/b1s/v1/TerminationReason

{
"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 https://localhost:50000/b1s/v1/TerminationReason(1)

{
"Description": "Add description"
}

DELETE TerminationReason(id)

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

Example

DELETE https://localhost:50000/b1s/v1/TerminationReason(1)

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 https://localhost:50000/b1s/v1/Territories(123)

GET https://localhost:50000/b1s/v1/Territories(123)?$select=TerritoryID,Description,LocationIndex

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 https://localhost:50000/b1s/v1/Territories

GET https://localhost:50000/b1s/v1/Territories?$select=TerritoryID,Description,LocationIndex&$filter=TerritoryID ge 123 &$orderby=Territor

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

Example

POST https://localhost:50000/b1s/v1/Territories

{
"Description": "NorthChina",
"Parent": "-1"
}

PATCH Territories(id)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Territories(123)

{
"Description": "EastChina"
}

DELETE Territories(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Territories(123)

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 https://localhost:50000/b1s/v1/TrackingNotes(2)

GET https://localhost:50000/b1s/v1/TrackingNotes(2)?$select=TrackingNoteNumber,CCDNumber,Date

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 https://localhost:50000/b1s/v1/TrackingNotes

GET https://localhost:50000/b1s/v1/TrackingNotes?$select=TrackingNoteNumber,CCDNumber,Date&$filter=TrackingNoteNumber ge 2 &$orderby=Track

POST TrackingNotes

Create an instance of 'TrackingNotes' with the given payload of type 'TrackingNote' in JSON format.

Example

POST https://localhost:50000/b1s/v1/TrackingNotes

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 311/334

6/7/24, 15:42 Service Layer API Reference
PATCH https://localhost:50000/b1s/v1/TrackingNotes(2)

{
"CountryOfOrigin": "AU",
"TrackingNoteBrokerCollection": [
{
"AgreementNumber": "2",
"BPCode": "C01"
}
]
}

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

Example

DELETE https://localhost:50000/b1s/v1/TrackingNotes(2)

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 https://localhost:50000/b1s/v1/TransactionCodes('01')

GET https://localhost:50000/b1s/v1/TransactionCodes('01')?$select=Code,Description

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 https://localhost:50000/b1s/v1/TransactionCodes

GET https://localhost:50000/b1s/v1/TransactionCodes?$select=Code,Description&$filter=startswith(Code, '') &$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 https://localhost:50000/b1s/v1/TransactionCodes

{
"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 https://localhost:50000/b1s/v1/TransactionCodes('01')

{
"Description": "description of 01"
}

DELETE TransactionCodes(id)
https://186.74.156.69:50000/Service Layer API Reference.html 312/334
6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'TransactionCodes' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/TransactionCodes('01')

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 https://localhost:50000/b1s/v1/TransportationDocuments(123)

GET https://localhost:50000/b1s/v1/TransportationDocuments(123)?$select=TranspDocNumber,NextNumber,PostDate

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 https://localhost:50000/b1s/v1/TransportationDocuments

GET https://localhost:50000/b1s/v1/TransportationDocuments?$select=TranspDocNumber,NextNumber,PostDate&$filter=TranspDocNumber ge 123 &$or

POST TransportationDocuments

Create an instance of 'TransportationDocuments' with the given payload of type 'TransportationDocumentData' in JSON format.

Example

POST https://localhost:50000/b1s/v1/TransportationDocuments

{
"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 https://localhost:50000/b1s/v1/TransportationDocuments(123)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/TransportationDocuments(123)/CancelTransportationDocument

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 https://localhost:50000/b1s/v1/UnitOfMeasurementGroups(123)

GET https://localhost:50000/b1s/v1/UnitOfMeasurementGroups(123)?$select=AbsEntry,Code,Name

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 https://localhost:50000/b1s/v1/UnitOfMeasurementGroups

GET https://localhost:50000/b1s/v1/UnitOfMeasurementGroups?$select=AbsEntry,Code,Name&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/UnitOfMeasurementGroups

{
"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 https://localhost:50000/b1s/v1/UnitOfMeasurementGroups(123)

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/UnitOfMeasurementGroups(123)

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 https://localhost:50000/b1s/v1/UnitOfMeasurements(123)

GET https://localhost:50000/b1s/v1/UnitOfMeasurements(123)?$select=AbsEntry,Code,Name

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 https://localhost:50000/b1s/v1/UnitOfMeasurements

GET https://localhost:50000/b1s/v1/UnitOfMeasurements?$select=AbsEntry,Code,Name&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/UnitOfMeasurements

{
"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.

https://186.74.156.69:50000/Service Layer API Reference.html 315/334

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

PATCH https://localhost:50000/b1s/v1/UnitOfMeasurements(123)

{
"AbsEntry": 2,
"Code": "Carton001",
"Length1": 100,
"Name": "Carton001"
}

DELETE UnitOfMeasurements(id)

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

Example

DELETE https://localhost:50000/b1s/v1/UnitOfMeasurements(123)

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 https://localhost:50000/b1s/v1/UserDefaultGroups('UD01')

GET https://localhost:50000/b1s/v1/UserDefaultGroups('UD01')?$select=Code,Name,Warehouse

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 https://localhost:50000/b1s/v1/UserDefaultGroups

GET https://localhost:50000/b1s/v1/UserDefaultGroups?$select=Code,Name,Warehouse&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/UserDefaultGroups

{
"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 https://localhost:50000/b1s/v1/UserDefaultGroups('UD01')

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/UserDefaultGroups('UD01')

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 https://localhost:50000/b1s/v1/UserFieldsMD(TableName='@UDT01',FieldID=0)

GET https://localhost:50000/b1s/v1/UserFieldsMD(TableName='@UDT01',FieldID=0)?$select=Name,Type,Size

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 https://localhost:50000/b1s/v1/UserFieldsMD

GET https://localhost:50000/b1s/v1/UserFieldsMD?$select=Name,Type,Size&$filter=startswith(TableName, '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 https://localhost:50000/b1s/v1/UserFieldsMD

{
"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 https://localhost:50000/b1s/v1/UserFieldsMD(TableName='@UDT01',FieldID=0)

{
"Description": "new UDF01",
"FieldID": 0,
"TableName": "@UDT01"
}

DELETE UserFieldsMD(id)

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

https://186.74.156.69:50000/Service Layer API Reference.html 317/334

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

DELETE https://localhost:50000/b1s/v1/UserFieldsMD(TableName='@UDT01',FieldID=0)

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 https://localhost:50000/b1s/v1/UserKeysMD(TableName='OHEM',KeyIndex=0)

GET https://localhost:50000/b1s/v1/UserKeysMD(TableName='OHEM',KeyIndex=0)?$select=TableName,KeyIndex,KeyName

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 https://localhost:50000/b1s/v1/UserKeysMD

GET https://localhost:50000/b1s/v1/UserKeysMD?$select=TableName,KeyIndex,KeyName&$filter=startswith(TableName, '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 https://localhost:50000/b1s/v1/UserKeysMD

{
"KeyName": "uk01",
"TableName": "OHEM",
"Unique": "tNO",
"UserKeysMD_Elements": [
{
"ColumnAlias": "UDF01"
}
]
}

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

Example

DELETE https://localhost:50000/b1s/v1/UserKeysMD(TableName='OHEM',KeyIndex=0)

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.

https://186.74.156.69:50000/Service Layer API Reference.html 318/334

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

GET https://localhost:50000/b1s/v1/UserLanguages(123)

GET https://localhost:50000/b1s/v1/UserLanguages(123)?$select=Code,LanguageShortName,LanguageFullName

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 https://localhost:50000/b1s/v1/UserLanguages

GET https://localhost:50000/b1s/v1/UserLanguages?$select=Code,LanguageShortName,LanguageFullName&$filter=Code 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 https://localhost:50000/b1s/v1/UserLanguages

{
"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 https://localhost:50000/b1s/v1/UserLanguages(123)

{
"LanguageFullName": "Traditional Chinese"
}

DELETE UserLanguages(id)

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

Example

DELETE https://localhost:50000/b1s/v1/UserLanguages(123)

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 https://localhost:50000/b1s/v1/UserObjectsMD('UDO5353')

GET https://localhost:50000/b1s/v1/UserObjectsMD('UDO5353')?$select=TableName,Code,LogTableName

GET UserObjectsMD
https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/UserObjectsMD

GET https://localhost:50000/b1s/v1/UserObjectsMD?$select=TableName,Code,LogTableName&$filter=startswith(Code, 'a') &$orderby=Code&$top=10&

POST UserObjectsMD

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

Example

POST https://localhost:50000/b1s/v1/UserObjectsMD

{
"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 https://localhost:50000/b1s/v1/UserObjectsMD('UDO5353')

{
"Name": "NewUDOTest"
}

DELETE UserObjectsMD(id)

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

Example

DELETE https://localhost:50000/b1s/v1/UserObjectsMD('UDO5353')

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 https://localhost:50000/b1s/v1/UserPermissionTree('P01')

GET https://localhost:50000/b1s/v1/UserPermissionTree('P01')?$select=UserSignature,DisplayOrder,PermissionID

GET UserPermissionTree

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

Example

https://186.74.156.69:50000/Service Layer API Reference.html 320/334

6/7/24, 15:42 Service Layer API Reference
GET https://localhost:50000/b1s/v1/UserPermissionTree

GET https://localhost:50000/b1s/v1/UserPermissionTree?$select=UserSignature,DisplayOrder,PermissionID&$filter=startswith(PermissionID, 'a'

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

Example

POST https://localhost:50000/b1s/v1/UserPermissionTree

{
"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 https://localhost:50000/b1s/v1/UserPermissionTree('P01')

{
"Name": "newFormPer"
}

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

Example

DELETE https://localhost:50000/b1s/v1/UserPermissionTree('P01')

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 https://localhost:50000/b1s/v1/UserQueries(InternalKey=123,QueryCategory=-1)

GET https://localhost:50000/b1s/v1/UserQueries(InternalKey=123,QueryCategory=-1)?$select=InternalKey,QueryCategory,QueryDescription

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 https://localhost:50000/b1s/v1/UserQueries

GET https://localhost:50000/b1s/v1/UserQueries?$select=InternalKey,QueryCategory,QueryDescription&$filter=InternalKey ge 123 and QueryCate

POST UserQueries

Create an instance of 'UserQueries' with the given payload of type 'UserQuery' in JSON format.

https://186.74.156.69:50000/Service Layer API Reference.html 321/334

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

POST https://localhost:50000/b1s/v1/UserQueries

{
"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 https://localhost:50000/b1s/v1/UserQueries(InternalKey=123,QueryCategory=-1)

{
"QueryDescription": "Select OCRD"
}

DELETE UserQueries(id)

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

Example

DELETE https://localhost:50000/b1s/v1/UserQueries(InternalKey=123,QueryCategory=-1)

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 https://localhost:50000/b1s/v1/Users(123)

GET https://localhost:50000/b1s/v1/Users(123)?$select=InternalKey,UserPassword,UserCode

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 https://localhost:50000/b1s/v1/Users

GET https://localhost:50000/b1s/v1/Users?$select=InternalKey,UserPassword,UserCode&$filter=InternalKey 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 https://localhost:50000/b1s/v1/Users

{
"UserCode": "u001",
"UserName": "User1",
"UserPassword": "default"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/Users(123)

{
"UserName": "Updated User Name"
}

DELETE Users(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Users(123)

POST Users(id)/Close

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

Example

POST https://localhost:50000/b1s/v1/Users(123)/Close

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 https://localhost:50000/b1s/v1/UserTablesMD('UDT01')

GET https://localhost:50000/b1s/v1/UserTablesMD('UDT01')?$select=TableName,TableDescription,TableType

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 https://localhost:50000/b1s/v1/UserTablesMD

GET https://localhost:50000/b1s/v1/UserTablesMD?$select=TableName,TableDescription,TableType&$filter=startswith(TableName, 'a') &$orderby=

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

Example

POST https://localhost:50000/b1s/v1/UserTablesMD

{
"TableDescription": "NewUDT",
"TableName": "UDT01",
"TableType": "bott_NoObject"
}

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/UserTablesMD('UDT01')

{
"TableDescription": "UpdateUDT01"
}

DELETE UserTablesMD(id)

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

Example

DELETE https://localhost:50000/b1s/v1/UserTablesMD('UDT01')

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 https://localhost:50000/b1s/v1/ValueMapping(123)

GET https://localhost:50000/b1s/v1/ValueMapping(123)?$select=AbsEntry,ObjectId,ObjectAbsEntry

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 https://localhost:50000/b1s/v1/ValueMapping

GET https://localhost:50000/b1s/v1/ValueMapping?$select=AbsEntry,ObjectId,ObjectAbsEntry&$filter=AbsEntry 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 https://localhost:50000/b1s/v1/ValueMapping

{
"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

https://186.74.156.69:50000/Service Layer API Reference.html 324/334

6/7/24, 15:42 Service Layer API Reference
PATCH https://localhost:50000/b1s/v1/ValueMapping(123)

{
"ObjectAbsEntry": "NOK",
"ObjectId": 37,
"VM_ThirdPartyValuesCollection": [
{
"ThirdPartySystemId": 1,
"ThirdPartyValue": "AFN"
}
]
}

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

Example

DELETE https://localhost:50000/b1s/v1/ValueMapping(123)

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 https://localhost:50000/b1s/v1/ValueMappingCommunication(123)

GET https://localhost:50000/b1s/v1/ValueMappingCommunication(123)?$select=AbsEntry,ThirdPartySystemId,ObjectId

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 https://localhost:50000/b1s/v1/ValueMappingCommunication

GET https://localhost:50000/b1s/v1/ValueMappingCommunication?$select=AbsEntry,ThirdPartySystemId,ObjectId&$filter=AbsEntry ge 123 &$orderb

POST ValueMappingCommunication

Create an instance of 'ValueMappingCommunication' with the given payload of type 'ValueMappingCommunicationData' in JSON format.

Example

POST https://localhost:50000/b1s/v1/ValueMappingCommunication

{
"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 https://localhost:50000/b1s/v1/ValueMappingCommunication(123)

{
"CommunicationType": "vmct_MasterData",

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/VatGroups('c52')

GET https://localhost:50000/b1s/v1/VatGroups('c52')?$select=Code,Name,Category

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 https://localhost:50000/b1s/v1/VatGroups

GET https://localhost:50000/b1s/v1/VatGroups?$select=Code,Name,Category&$filter=startswith(Code, '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 https://localhost:50000/b1s/v1/VatGroups

{
"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 https://localhost:50000/b1s/v1/VatGroups('c52')

{
"Name": "VAT rate 20"
}

DELETE VatGroups(id)

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

Example

DELETE https://localhost:50000/b1s/v1/VatGroups('c52')

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/VendorPayments(123)

GET https://localhost:50000/b1s/v1/VendorPayments(123)?$select=DocNum,DocType,HandWritten

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 https://localhost:50000/b1s/v1/VendorPayments

GET https://localhost:50000/b1s/v1/VendorPayments?$select=DocNum,DocType,HandWritten&$filter=DocEntry 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 https://localhost:50000/b1s/v1/VendorPayments

{
"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 https://localhost:50000/b1s/v1/VendorPayments(123)

{
"Remarks": "new comments - modified by Service Layer"
}

POST VendorPayments(id)/Cancel

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

Example

POST https://localhost:50000/b1s/v1/VendorPayments(123)/Cancel

POST VendorPayments(id)/GetApprovalTemplates

https://186.74.156.69:50000/Service Layer API Reference.html 327/334

6/7/24, 15:42 Service Layer API Reference
Invoke the method 'GetApprovalTemplates' on this EntitySet with the specified id.

Example

POST https://localhost:50000/b1s/v1/VendorPayments(123)/GetApprovalTemplates

POST VendorPayments(id)/CancelbyCurrentSystemDate

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

Example

POST https://localhost:50000/b1s/v1/VendorPayments(123)/CancelbyCurrentSystemDate

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 https://localhost:50000/b1s/v1/WarehouseLocations(123)

GET https://localhost:50000/b1s/v1/WarehouseLocations(123)?$select=Code,Name,LSTVATNumber

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 https://localhost:50000/b1s/v1/WarehouseLocations

GET https://localhost:50000/b1s/v1/WarehouseLocations?$select=Code,Name,LSTVATNumber&$filter=Code 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 https://localhost:50000/b1s/v1/WarehouseLocations

{
"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 https://localhost:50000/b1s/v1/WarehouseLocations(123)

{
"Name": "SH Pudong"
}

DELETE WarehouseLocations(id)

https://186.74.156.69:50000/Service Layer API Reference.html 328/334

6/7/24, 15:42 Service Layer API Reference
Delete an instance of 'WarehouseLocations' with the specified id.

Example

DELETE https://localhost:50000/b1s/v1/WarehouseLocations(123)

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 https://localhost:50000/b1s/v1/Warehouses('w001')

GET https://localhost:50000/b1s/v1/Warehouses('w001')?$select=Street,StockInflationOffsetAccount,ZipCode

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 https://localhost:50000/b1s/v1/Warehouses

GET https://localhost:50000/b1s/v1/Warehouses?$select=Street,StockInflationOffsetAccount,ZipCode&$filter=startswith(WarehouseCode, 'a') &$

POST Warehouses

Create an instance of 'Warehouses' with the given payload of type 'Warehouse' in JSON format.

Example

POST https://localhost:50000/b1s/v1/Warehouses

{
"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 https://localhost:50000/b1s/v1/Warehouses('w001')

{
"WarehouseName": "UpdatedWHName"
}

DELETE Warehouses(id)

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

Example

DELETE https://localhost:50000/b1s/v1/Warehouses('w001')

WarehouseSublevelCodes

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/WarehouseSublevelCodes(123)

GET https://localhost:50000/b1s/v1/WarehouseSublevelCodes(123)?$select=WarehouseSublevel,Code,Description

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 https://localhost:50000/b1s/v1/WarehouseSublevelCodes

GET https://localhost:50000/b1s/v1/WarehouseSublevelCodes?$select=WarehouseSublevel,Code,Description&$filter=AbsEntry ge 123 &$orderby=Abs

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

Example

POST https://localhost:50000/b1s/v1/WarehouseSublevelCodes

{
"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 https://localhost:50000/b1s/v1/WarehouseSublevelCodes(123)

{
"Description": "test"
}

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

Example

DELETE https://localhost:50000/b1s/v1/WarehouseSublevelCodes(123)

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.

https://186.74.156.69:50000/Service Layer API Reference.html 330/334

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

GET https://localhost:50000/b1s/v1/WeightMeasures(123)

GET https://localhost:50000/b1s/v1/WeightMeasures(123)?$select=UnitCode,UnitDisplay,UnitName

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 https://localhost:50000/b1s/v1/WeightMeasures

GET https://localhost:50000/b1s/v1/WeightMeasures?$select=UnitCode,UnitDisplay,UnitName&$filter=UnitCode 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 https://localhost:50000/b1s/v1/WeightMeasures

{
"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 https://localhost:50000/b1s/v1/WeightMeasures(123)

{
"UnitName": "tonne"
}

DELETE WeightMeasures(id)

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

Example

DELETE https://localhost:50000/b1s/v1/WeightMeasures(123)

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 https://localhost:50000/b1s/v1/WithholdingTaxCodes('W01')

GET https://localhost:50000/b1s/v1/WithholdingTaxCodes('W01')?$select=WTCode,WTName,Category

GET WithholdingTaxCodes

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/WithholdingTaxCodes

GET https://localhost:50000/b1s/v1/WithholdingTaxCodes?$select=WTCode,WTName,Category&$filter=startswith(WTCode, 'a') &$orderby=WTCode&$to

POST WithholdingTaxCodes

Create an instance of 'WithholdingTaxCodes' with the given payload of type 'WithholdingTaxCode' in JSON format.

Example

POST https://localhost:50000/b1s/v1/WithholdingTaxCodes

{
"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 https://localhost:50000/b1s/v1/WithholdingTaxCodes('W01')

{
"WTName": "withholding Tax code"
}

DELETE WithholdingTaxCodes(id)

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

Example

DELETE https://localhost:50000/b1s/v1/WithholdingTaxCodes('W01')

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 https://localhost:50000/b1s/v1/WitholdingTaxDefinition(123)

GET https://localhost:50000/b1s/v1/WitholdingTaxDefinition(123)?$select=AbsEntry,WTaxCode,WTaxName

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 https://localhost:50000/b1s/v1/WitholdingTaxDefinition

https://186.74.156.69:50000/Service Layer API Reference.html 332/334

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

GET https://localhost:50000/b1s/v1/WitholdingTaxDefinition?$select=AbsEntry,WTaxCode,WTaxName&$filter=AbsEntry ge 123 &$orderby=AbsEntry&$

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

Example

POST https://localhost:50000/b1s/v1/WitholdingTaxDefinition

{}

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 https://localhost:50000/b1s/v1/WitholdingTaxDefinition(123)

{
"WTaxName": "newName"
}

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

Example

DELETE https://localhost:50000/b1s/v1/WitholdingTaxDefinition(123)

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 https://localhost:50000/b1s/v1/WizardPaymentMethods('outpay')

GET https://localhost:50000/b1s/v1/WizardPaymentMethods('outpay')?$select=PaymentMethodCode,Description,Type

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 https://localhost:50000/b1s/v1/WizardPaymentMethods

GET https://localhost:50000/b1s/v1/WizardPaymentMethods?$select=PaymentMethodCode,Description,Type&$filter=startswith(PaymentMethodCode, '

POST WizardPaymentMethods

Create an instance of 'WizardPaymentMethods' with the given payload of type 'WizardPaymentMethod' in JSON format.

Example

POST https://localhost:50000/b1s/v1/WizardPaymentMethods

https://186.74.156.69:50000/Service Layer API Reference.html 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 https://localhost:50000/b1s/v1/WizardPaymentMethods('outpay')

{
"Description": "outgoing payment method"
}

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

Example

DELETE https://localhost:50000/b1s/v1/WizardPaymentMethods('outpay')

https://186.74.156.69:50000/Service Layer API Reference.html 334/334