SAP Business One Service Layer APIs Change Log

10.0 PL02 VS 9.3 PL13

This document provides information about new, changed, and deleted Service Layer APIs between two sequential patches.

Index

ComplexType and Property
EntityType and Property
EntitySet
EnumType and Member
FunctionImport and Parameter
FunctionImport-Bind




ComplexType

A ComplexType element represents a set of related information. Like an EntityType element, a ComplexType element consists of one or more properties of scalar type or complex type.
The following table lists the newly-added, changed, and deleted ComplexType interfaces.
Change Type Name
Change AdminInfo
Change BPAddress
Change ContactEmployeeBlockSendingMarketingContent
Change CustomsGroupParams
Change DocumentAdditionalExpense
Change DocumentLine
Change DocumentLineAdditionalExpense
Change ProductTreeLine
Change ProductionOrderLine
Change TaxExtension
Change UoMGroupDefinition
New ChecksforPaymentDocumentReference
New Currency
New CustomerEquipmentCardBusinessPartner
New EDFEntry
New EDFEntryAddLogInputParams
New EDFEntryInputParams
New EDFEntryListInputParams
New EDFEntryLog
New EDFEntryLogInputParams
New EDFProtocolInputParams
New EDFProtocolParameter
New EDFProtocolWithParameters
New FieldID
New PostingTemplatesLine
New PostingTemplatesParams
New QRCodeData
New RecurringPostingsDocumentReference
New RecurringPostingsLine
New RecurringPostingsParams
New SQLViewParams
New WebClientBookmarkTileParams
New WebClientDashboardCard
New WebClientDashboardParams
New WebClientFormSettingItem
New WebClientFormSettingParams
New WebClientLaunchpadGroup
New WebClientLaunchpadParams
New WebClientLaunchpadTile
New WebClientListviewFilterCondition
New WebClientListviewFilterParams
New WebClientNotificationParams
New WebClientPreferenceParams
New WebClientRecentActivityParams
New WebClientVariantEmbeddedChart
New WebClientVariantEmbeddedChartSize
New WebClientVariantEmbeddedChartValue1
New WebClientVariantEmbeddedChartValue2
New WebClientVariantGroupBy
New WebClientVariantGroupParams
New WebClientVariantMChart
New WebClientVariantMChartSize
New WebClientVariantMChartValue1
New WebClientVariantMChartValue2
New WebClientVariantParams
New WebClientVariantSelectedColumn
New WebClientVariantSortBy
Remove CurrenciesParams

Property

The properties of a ComplexType element are defined by using the Property element.
The following table lists the newly-added, changed, and deleted properties of the changed ComplexType interfaces.
Change Type Name EntityType Description Writable Type DBType DBSize Change Log
New EnableAuthorizerUpdatePendingDraft AdminInfo Enable Authorizer Update Draft true BoYesNoEnum AlphaNumeric 1 -
New NumberOfCharInMonth AdminInfo Number of Characters in Month true Edm.Int32 Integer 11 -
New TaasEnabled BPAddress TaaS Service Enabled on Address true BoYesNoEnum AlphaNumeric 1 -
New CardCode ContactEmployeeBlockSendingMarketingContent BP Code false Edm.String AlphaNumeric 15 -
New ContactPersonName ContactEmployeeBlockSendingMarketingContent Contact Person Name false Edm.String AlphaNumeric 50 -
Remove PortAddress CustomsGroupParams - - - - - -
Remove PortState CustomsGroupParams - - - - - -
New ExternalCalcTaxAmount DocumentAdditionalExpense External Tax Amount true Edm.Double Float 8 -
New ExternalCalcTaxAmountFC DocumentAdditionalExpense External Tax Amount (FC) false Edm.Double Float 8 -
New ExternalCalcTaxAmountSC DocumentAdditionalExpense External Tax Amount (SC) false Edm.Double Float 8 -
New ExternalCalcTaxRate DocumentAdditionalExpense External Tax Rate true Edm.Double Float 8 -
New ExternalCalcTaxAmount DocumentLine External Tax Amount true Edm.Double Float 8 -
New ExternalCalcTaxAmountFC DocumentLine External Tax Amount (FC) false Edm.Double Float 8 -
New ExternalCalcTaxAmountSC DocumentLine External Tax Amount (SC) false Edm.Double Float 8 -
New ExternalCalcTaxRate DocumentLine External Tax Rate true Edm.Double Float 8 -
New GrossProfit DocumentLine Row Gross Profit true Edm.Double Float 20 -
New GrossProfitFC DocumentLine Row Gross Profit (FC) true Edm.Double Float 20 -
New GrossProfitSC DocumentLine Row Gross Profit (SC) true Edm.Double Float 20 -
New PriceSource DocumentLine Price Source Type false DocumentPriceSourceEnum AlphaNumeric 1 -
New ExternalCalcTaxAmount DocumentLineAdditionalExpense External Tax Amount true Edm.Double Float 8 -
New ExternalCalcTaxAmountFC DocumentLineAdditionalExpense External Tax Amount (FC) false Edm.Double Float 8 -
New ExternalCalcTaxAmountSC DocumentLineAdditionalExpense External Tax Amount (SC) false Edm.Double Float 8 -
New ExternalCalcTaxRate DocumentLineAdditionalExpense External Tax Rate true Edm.Double Float 8 -
New ItemName ProductTreeLine Item Description true Edm.String AlphaNumeric 100 -
New ItemName ProductionOrderLine Item Description true Edm.String AlphaNumeric 100 -
Change ClaimRefund TaxExtension - true BoYesNoEnum - - DefaultValue: N => None
Change DifferentialOfTaxRate TaxExtension - true Edm.Int32 - - DefaultValue: 100 => None
New Active UoMGroupDefinition Is Active or Not true BoYesNoEnum AlphaNumeric 1 -

EntityType

An entity is an instance of an EntityType element. An EntityType has a unique identity, an independent existence, and forms the operational unit of consistency.
The following table lists the newly-added, changed, and deleted EntityType interfaces.
Change Type Name
Change Attachments2
Change BusinessPartner
Change ChecksforPayment
Change CustomerEquipmentCard
Change Deposit
Change Document
Change FormattedSearch
Change InventoryCounting
Change InventoryOpeningBalance
Change InventoryPosting
Change JournalEntry
Change PM_TimeSheetData
Change Payment
Change ProductionOrder
Change ServiceCallOrigin
Change ServiceCallProblemSubType
Change ServiceCallProblemType
Change ServiceCallSolutionStatus
Change ServiceCallStatus
Change ServiceCallType
Change ServiceContract
Change StockTransfer
New CurrencyParams
New EDFProtocol
New PostingTemplates
New RecurringPostings
New SQLView
New WebClientBookmarkTile
New WebClientDashboard
New WebClientFormSetting
New WebClientLaunchpad
New WebClientListviewFilter
New WebClientNotification
New WebClientPreference
New WebClientRecentActivity
New WebClientVariant
New WebClientVariantGroup
Remove Currency

Property

The properties of an EntityType element are defined by using the Property element.
The following table lists the newly-added, changed, and deleted properties for the changed EntityType interfaces.
Change Type Name EntityType Description Writable Type DBType DBSize Change Log
New ChecksforPayment Attachments2 - - - - - -
New Deposits Attachments2 - - - - - -
New IncomingPayments Attachments2 - - - - - -
New InventoryCountings Attachments2 - - - - - -
New InventoryOpeningBalances Attachments2 - - - - - -
New InventoryPostings Attachments2 - - - - - -
New JournalEntries Attachments2 - - - - - -
New PaymentDrafts Attachments2 - - - - - -
New ProductionOrders Attachments2 - - - - - -
New ProjectManagementTimeSheet Attachments2 - - - - - -
New VendorPayments Attachments2 - - - - - -
New ShipToState BusinessPartner Ship-to State true Edm.String AlphaNumeric 3 -
New AttachmentEntry ChecksforPayment Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 ChecksforPayment - - - - - -
New ChecksforPaymentDocumentReferences ChecksforPayment - - ChecksforPaymentDocumentReference - - -
New ContractCode CustomerEquipmentCard Contract false Edm.Int32 Integer 11 -
New ContractEndDate CustomerEquipmentCard Contract End Date false Edm.DateTime Date 8 -
New ContractStartDate CustomerEquipmentCard Contract Start Date false Edm.DateTime Date 8 -
New CustomerEquipmentCardBusinessPartners CustomerEquipmentCard - - CustomerEquipmentCardBusinessPartner - - -
New RequiredResolutionTime CustomerEquipmentCard Time Required for Response true Edm.Int32 Integer 6 -
New RequiredResolutionUnit CustomerEquipmentCard Time Unit true BoResolutionUnits AlphaNumeric 1 -
New ServiceBPType CustomerEquipmentCard BP Type true BoEquipmentBPType AlphaNumeric 1 -
New ServiceContract CustomerEquipmentCard - - - - - -
New AttachmentEntry Deposit Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 Deposit - - - - - -
Change ShipFrom Document Ship-to Code false Edm.String AlphaNumeric 50 Writable: true => false
New CreateQRCodeFrom Document QR Code Source true Edm.String Text 0 -
New InvoicePayment Document A/R Invoice + Payment false BoYesNoEnum AlphaNumeric 1 -
New FieldIDs FormattedSearch - - FieldID - - -
New AttachmentEntry InventoryCounting Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 InventoryCounting - - - - - -
New AttachmentEntry InventoryOpeningBalance Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 InventoryOpeningBalance - - - - - -
New AttachmentEntry InventoryPosting Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 InventoryPosting - - - - - -
New AttachmentEntry JournalEntry Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 JournalEntry - - - - - -
New AttachmentEntry PM_TimeSheetData Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 PM_TimeSheetData - - - - - -
New AttachmentEntry Payment Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 Payment - - - - - -
New AttachmentEntry ProductionOrder Attachment Entry true Edm.Int32 Integer 11 -
New Attachments2 ProductionOrder - - - - - -
New Active ServiceCallOrigin Active true BoYesNoEnum AlphaNumeric 1 -
New Active ServiceCallProblemSubType Active true BoYesNoEnum AlphaNumeric 1 -
New Active ServiceCallProblemType Active true BoYesNoEnum AlphaNumeric 1 -
New Active ServiceCallSolutionStatus Active true BoYesNoEnum AlphaNumeric 1 -
New Active ServiceCallStatus Active true BoYesNoEnum AlphaNumeric 1 -
New Active ServiceCallType Active true BoYesNoEnum AlphaNumeric 1 -
New CustomerEquipmentCards ServiceContract - - - - - -
New DocumentReferences StockTransfer - - DocumentReference - - -

EntitySet

An EntitySet element is a named set that can contain instances of a specified EntityType element and any of the specified EntityType subtypes.
The following table lists the newly-added, changed, and deleted EntitySet interfaces.
Change Type Name EntityType Description
Change Currencies CurrencyParams Currency Codes
New ElectronicDocuments EDFProtocol -
New PostingTemplates PostingTemplates Posting Templates
New RecurringPostings RecurringPostings Recurring Postings
New SQLViews SQLView User-Defined Views for Service Layer
New WebClientBookmarkTiles WebClientBookmarkTile Fiori Launchpad Bookmark Tiles
New WebClientDashboards WebClientDashboard Dashboard Overview
New WebClientFormSettings WebClientFormSetting Web Client Form Settings
New WebClientLaunchpads WebClientLaunchpad Launchpad
New WebClientListviewFilters WebClientListviewFilter List View Filters
New WebClientNotifications WebClientNotification Notifications
New WebClientPreferences WebClientPreference User Preference
New WebClientRecentActivities WebClientRecentActivity Recent user activities
New WebClientVariantGroups WebClientVariantGroup Variant Groups
New WebClientVariants WebClientVariant List View Variants

EnumType

An EnumType element is used to declare an enumeration type.
The following table lists the newly-added, changed, and deleted EnumType interfaces.
Change Type Name
Change BoCardCompanyTypes
Change ElectronicDocProtocolCodeEnum
Change ReferencedObjectTypeEnum
New BoEquipmentBPType
New BoFrequencyTypeEnum
New BoSubFrequencyTypeEnum
New BoTaxPostingAccountTypeEnum
New DocumentPriceSourceEnum
New ElectronicDocProtocolCodeStrEnum
New ElectronicDocumentEntryCancellationStatusEnum
New ElectronicDocumentEntryLogTypeEnum
New ElectronicDocumentEntryPeriodTypeEnum
New ElectronicDocumentEntryStatusEnum
New ElectronicDocumentEntryTypeEnum

Member

A Member element is used inside an EnumType element to declare a member of an enumeration type.(...)
The following table lists the newly-added, changed, and deleted members for the changed EnumType interfaces.
Change Type Name EnumType Value Change Log
New cEmployee BoCardCompanyTypes E -
New edpc_DIGIPOORT ElectronicDocProtocolCodeEnum 13 -
New edpc_EIS ElectronicDocProtocolCodeEnum 10 -
New edpc_HOI ElectronicDocProtocolCodeEnum 8 -
New edpc_IIS ElectronicDocProtocolCodeEnum 11 -
New edpc_IIS_Annual ElectronicDocProtocolCodeEnum 12 -
New edpc_MYF ElectronicDocProtocolCodeEnum 9 -
New edpc_PEPPOL ElectronicDocProtocolCodeEnum 7 -
New rot_ChecksforPayment ReferencedObjectTypeEnum 57 -
New rot_GoodsIssue ReferencedObjectTypeEnum 60 -
New rot_GoodsReceipt ReferencedObjectTypeEnum 59 -
New rot_InventoryTransfer ReferencedObjectTypeEnum 67 -
New rot_InventoryTransferRequest ReferencedObjectTypeEnum 1250000001 -
New rot_PurchaseRequest ReferencedObjectTypeEnum 1470000113 -

FunctionImport

FunctionImport element is used to import stored procedures or functions that are defined in the Store Schema Model into Entity Data Model (EDM).
The following table lists the newly-added, changed, and deleted FunctionImport interfaces.
Change Type Name Parameter ReturnType Change Log Notes
New ActivitiesService_InitData - Activity - -
New BusinessPartnersService_InitData - BusinessPartner - -
New CorrectionInvoiceReversalService_InitData - Document - -
New CorrectionInvoiceService_InitData - Document - -
New CorrectionPurchaseInvoiceReversalService_InitData - Document - -
New CorrectionPurchaseInvoiceService_InitData - Document - -
New CreditNotesService_InitData - Document - -
New DeliveryNotesService_InitData - Document - -
New DownPaymentsService_InitData - Document - -
New DraftsService_InitData - Document - -
New GoodsReturnRequestService_InitData - Document - -
New InventoryGenEntryService_InitData - Document - -
New InventoryGenExitService_InitData - Document - -
New InvoicesService_InitData - Document - -
New ItemsService_InitData - Item - -
New OrdersService_InitData - Document - -
New PostingTemplatesService_GetList - PostingTemplatesParams - -
New PurchaseCreditNotesService_InitData - Document - -
New PurchaseDeliveryNotesService_InitData - Document - -
New PurchaseDownPaymentsService_InitData - Document - -
New PurchaseInvoicesService_InitData - Document - -
New PurchaseOrdersService_InitData - Document - -
New PurchaseQuotationsService_InitData - Document - -
New PurchaseRequestService_InitData - Document - -
New PurchaseReturnsService_InitData - Document - -
New QRCodeService_AddOrUpdateQRCode ( Name:QRCodeData, Type:QRCodeData )
- - -
New QuotationsService_InitData - Document - -
New RecurringPostingsService_GetList - RecurringPostingsParams - -
New ReturnRequestService_InitData - Document - -
New ReturnsService_InitData - Document - -
New SensitiveDataAccessService_Access ( Name:SensitiveDataAccess, Type:SensitiveDataAccess )
SensitiveDataAccess - -
New SensitiveDataAccessService_IsDataSensitive ( Name:SensitiveDataAccess, Type:SensitiveDataAccess )
DataSensitiveStatus - -
New WebClientBookmarkTileService_GetList - WebClientBookmarkTileParams - -
New WebClientDashboardService_GetList - WebClientDashboardParams - -
New WebClientFormSettingService_GetList - WebClientFormSettingParams - -
New WebClientLaunchpadService_GetList - WebClientLaunchpadParams - -
New WebClientListviewFilterService_GetList - WebClientListviewFilterParams - -
New WebClientNotificationService_GetList - WebClientNotificationParams - -
New WebClientPreferenceService_GetList - WebClientPreferenceParams - -
New WebClientRecentActivityService_GetList - WebClientRecentActivityParams - -
New WebClientVariantGroupService_GetList - WebClientVariantGroupParams - -
New WebClientVariantService_GetList - WebClientVariantParams - -
Remove GetCompanyList - - - -

Parameter

The following table lists the newly-added, changed, and deleted parameters for the changed FunctionImport interfaces.
Change Type Name FunctionImport Type Change Log

FunctionImport-Bind

FunctionImport-Bind is defined when IsBindable attribute of FunctionImport is set to "true". FunctionImport-Bind must have at least one Parameter element defined.
The following table lists the newly-added, changed, and deleted FunctionImport-Bind interfaces.
Change Type Name Parameter ReturnType Change Log
New CancelApprovalRequest ( Name:ApprovalRequestParams, Type:ApprovalRequest ) - -
New Expose ( Name:SQLViewParams, Type:SQLView ) - -
New GetProtocolParameters ( Name:EDFProtocolInputParams, Type:EDFProtocol ) EDFProtocolWithParameters -
New RestoreApprovalRequest ( Name:ApprovalRequestParams, Type:ApprovalRequest ) - -
New Unexpose ( Name:SQLViewParams, Type:SQLView ) - -