Note: There is a newer version (1.0.2) of this package available. Click here to view docs for the latest version.

Module sap.businessone.businesspartners

ballerinax/sap.businessone.businesspartners Ballerina library

1.0.0

Overview

SAP Business One is an enterprise resource planning (ERP) solution designed for small and midsize businesses by SAP SE. Its Service Layer exposes the Business One business objects through an OData web service interface.

The SAP Business One Business Partners connector provides APIs for the business partner master data of SAP Business One: customers, vendors, leads, contacts, and related setup, exposed through the SAP Business One Service Layer (OData).

Key Features

Create, read, update, and delete business partners
Manage contact persons and business partner groups
Maintain payment terms, priorities, and industries

Setup guide

The connector requires an SAP Business One installation with the Service Layer component enabled (available for SAP Business One, version for SAP HANA, and SAP Business One on Microsoft SQL Server 9.3 PL10+). The Service Layer endpoint is https://<host>:50000/b1s/v1 by default. A Business One user with a license and the relevant object authorizations is needed; sessions are opened against a specific company database (schema).

Quickstart

To use the sap.businessone.businesspartners connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module


import ballerinax/sap.businessone.businesspartners;

Step 2: Instantiate a new connector

The connector authenticates with the Service Layer session protocol: it logs in with the configured company database, user name, and password, tracks the B1SESSION/ROUTEID cookies, and transparently re-logs in once when the session expires. Place the credentials in a Config.toml (never commit credentials to source control):


serviceUrl = "https://<host>:50000/b1s/v1"
companyDb = "<COMPANY_DB>"
username = "<USER>"
password = "<PASSWORD>"


configurable string serviceUrl = ?;
configurable string companyDb = ?;
configurable string username = ?;
configurable string password = ?;

businesspartners:Client b1Client = check new (
    {companyDb, username, password},
    serviceUrl = serviceUrl
);

Step 3: Invoke the connector operation


businesspartners:BusinessPartners_CollectionResponse response = check b1Client->businessPartnersList();

Step 4: Run the Ballerina application


bal run

Examples

The SAP Business One connectors provide practical examples illustrating usage in various scenarios. Explore these examples, covering use cases like listing open sales orders, reporting inventory stock, and logging CRM activities.

Clients

sap.businessone.businesspartners: Client

Isolated

OpenAPI 3.0.3 description generated directly from the SAP Business One Service Layer OData V3 $metadata (namespace 'SAPB1')

Authentication is session based: call POST /Login with company/user/password; the Service Layer returns a B1SESSION cookie (and a ROUTEID cookie when load balanced) that must be sent on every subsequent request. Call POST /Logout to end the session

Collection responses use the OData V3 envelope { "odata.metadata": ..., "value": [ ... ], "odata.nextLink": ... }. Use $inlinecount=allpages to obtain the total count and the Prefer: odata.maxpagesize=N header to control server paging

Constructor

Gets invoked to initialize the connector

init (SessionConfig session, ConnectionConfig config, string serviceUrl)

session SessionConfig - SAP Business One Service Layer session credentials

config ConnectionConfig {} - The configurations to be used when initializing the connector

serviceUrl string "https://localhost:50000/b1s/v1" - URL of the target service

addressServiceGetAddressFormat

Isolated FunctionRemote Function

function addressServiceGetAddressFormat(AddressService_GetAddressFormat_body payload, map<string|string[]> headers) returns AddressFormat|error

Get address format

Parameters

payload AddressService_GetAddressFormat_body - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddressFormat|error - Function result

addressServiceGetFullAddress

Isolated FunctionRemote Function

function addressServiceGetFullAddress(AddressService_GetFullAddress_body payload, map<string|string[]> headers) returns AddressReturnParams|error

Get full address

Parameters

payload AddressService_GetFullAddress_body - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

AddressReturnParams|error - Function result

listBPFiscalRegistryID

Isolated FunctionRemote Function

function listBPFiscalRegistryID(ListBPFiscalRegistryIDHeaders headers, *ListBPFiscalRegistryIDQueries queries) returns BPFiscalRegistryIDCollectionResponse|error

Query the BPFiscalRegistryID collection

Parameters

headers ListBPFiscalRegistryIDHeaders (default {}) - Headers to be sent with the request

queries *ListBPFiscalRegistryIDQueries - Queries to be sent with the request

Return Type

BPFiscalRegistryIDCollectionResponse|error - A page of entities

createBPFiscalRegistryID

Isolated FunctionRemote Function

function createBPFiscalRegistryID(BPFiscalRegistryID payload, map<string|string[]> headers) returns BPFiscalRegistryID|error

Create a new BPFiscalRegistryID

Parameters

payload BPFiscalRegistryID - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BPFiscalRegistryID|error - The created entity

getBPFiscalRegistryID

Isolated FunctionRemote Function

function getBPFiscalRegistryID(Signed32 numerator, map<string|string[]> headers, *GetBPFiscalRegistryIDQueries queries) returns BPFiscalRegistryID|error

Get a single BPFiscalRegistryID by key

Parameters

numerator Signed32 - Key property 'Numerator' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBPFiscalRegistryIDQueries - Queries to be sent with the request

Return Type

BPFiscalRegistryID|error - The requested entity

deleteBPFiscalRegistryID

Isolated FunctionRemote Function

function deleteBPFiscalRegistryID(Signed32 numerator, map<string|string[]> headers) returns error?

Delete a BPFiscalRegistryID

Parameters

numerator Signed32 - Key property 'Numerator' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateBPFiscalRegistryID

Isolated FunctionRemote Function

function updateBPFiscalRegistryID(Signed32 numerator, BPFiscalRegistryID payload, map<string|string[]> headers) returns error?

Partially update a BPFiscalRegistryID (PATCH/MERGE semantics)

Parameters

numerator Signed32 - Key property 'Numerator' (Edm.Int32)

payload BPFiscalRegistryID - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

bPOpeningBalanceServiceCreateOpenBalance

Isolated FunctionRemote Function

function bPOpeningBalanceServiceCreateOpenBalance(BPOpeningBalanceService_CreateOpenBalance_body payload, map<string|string[]> headers) returns error?

Create open balance

Parameters

payload BPOpeningBalanceService_CreateOpenBalance_body - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Success. No content returned

listBPPriorities

Isolated FunctionRemote Function

function listBPPriorities(ListBPPrioritiesHeaders headers, *ListBPPrioritiesQueries queries) returns BPPrioritiesCollectionResponse|error

Query the BPPriorities collection

Parameters

headers ListBPPrioritiesHeaders (default {}) - Headers to be sent with the request

queries *ListBPPrioritiesQueries - Queries to be sent with the request

Return Type

BPPrioritiesCollectionResponse|error - A page of entities

createBPPriorities

Isolated FunctionRemote Function

function createBPPriorities(BPPriority payload, map<string|string[]> headers) returns BPPriority|error

Create a new BPPriority

Parameters

payload BPPriority - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BPPriority|error - The created entity

getBPPriorities

Isolated FunctionRemote Function

function getBPPriorities(Signed32 priority, map<string|string[]> headers, *GetBPPrioritiesQueries queries) returns BPPriority|error

Get a single BPPriority by key

Parameters

priority Signed32 - Key property 'Priority' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBPPrioritiesQueries - Queries to be sent with the request

Return Type

BPPriority|error - The requested entity

deleteBPPriorities

Isolated FunctionRemote Function

function deleteBPPriorities(Signed32 priority, map<string|string[]> headers) returns error?

Delete a BPPriority

Parameters

priority Signed32 - Key property 'Priority' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateBPPriorities

Isolated FunctionRemote Function

function updateBPPriorities(Signed32 priority, BPPriority payload, map<string|string[]> headers) returns error?

Partially update a BPPriority (PATCH/MERGE semantics)

Parameters

priority Signed32 - Key property 'Priority' (Edm.Int32)

payload BPPriority - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listBPVatExemptions

Isolated FunctionRemote Function

function listBPVatExemptions(ListBPVatExemptionsHeaders headers, *ListBPVatExemptionsQueries queries) returns BPVatExemptionsCollectionResponse|error

Query the BPVatExemptions collection

Parameters

headers ListBPVatExemptionsHeaders (default {}) - Headers to be sent with the request

queries *ListBPVatExemptionsQueries - Queries to be sent with the request

Return Type

BPVatExemptionsCollectionResponse|error - A page of entities

createBPVatExemptions

Isolated FunctionRemote Function

function createBPVatExemptions(BPVatExemptions payload, map<string|string[]> headers) returns BPVatExemptions|error

Create a new BPVatExemptions

Parameters

payload BPVatExemptions - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BPVatExemptions|error - The created entity

getBPVatExemptions

Isolated FunctionRemote Function

function getBPVatExemptions(Signed32 absoluteEntry, map<string|string[]> headers, *GetBPVatExemptionsQueries queries) returns BPVatExemptions|error

Get a single BPVatExemptions by key

Parameters

absoluteEntry Signed32 - Key property 'AbsoluteEntry' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBPVatExemptionsQueries - Queries to be sent with the request

Return Type

BPVatExemptions|error - The requested entity

deleteBPVatExemptions

Isolated FunctionRemote Function

function deleteBPVatExemptions(Signed32 absoluteEntry, map<string|string[]> headers) returns error?

Delete a BPVatExemptions

Parameters

absoluteEntry Signed32 - Key property 'AbsoluteEntry' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateBPVatExemptions

Isolated FunctionRemote Function

function updateBPVatExemptions(Signed32 absoluteEntry, BPVatExemptions payload, map<string|string[]> headers) returns error?

Partially update a BPVatExemptions (PATCH/MERGE semantics)

Parameters

absoluteEntry Signed32 - Key property 'AbsoluteEntry' (Edm.Int32)

payload BPVatExemptions - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

bPVatExemptionsServiceGetList

Isolated FunctionRemote Function

function bPVatExemptionsServiceGetList(map<string|string[]> headers) returns inline_response_200|error

Get list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200|error - Function result

listBusinessPartnerGroups

Isolated FunctionRemote Function

function listBusinessPartnerGroups(ListBusinessPartnerGroupsHeaders headers, *ListBusinessPartnerGroupsQueries queries) returns BusinessPartnerGroupsCollectionResponse|error

Query the BusinessPartnerGroups collection

Parameters

headers ListBusinessPartnerGroupsHeaders (default {}) - Headers to be sent with the request

queries *ListBusinessPartnerGroupsQueries - Queries to be sent with the request

Return Type

BusinessPartnerGroupsCollectionResponse|error - A page of entities

createBusinessPartnerGroups

Isolated FunctionRemote Function

function createBusinessPartnerGroups(BusinessPartnerGroup payload, map<string|string[]> headers) returns BusinessPartnerGroup|error

Create a new BusinessPartnerGroup

Parameters

payload BusinessPartnerGroup - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BusinessPartnerGroup|error - The created entity

getBusinessPartnerGroups

Isolated FunctionRemote Function

function getBusinessPartnerGroups(Signed32 code, map<string|string[]> headers, *GetBusinessPartnerGroupsQueries queries) returns BusinessPartnerGroup|error

Get a single BusinessPartnerGroup by key

Parameters

code Signed32 - Key property 'Code' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBusinessPartnerGroupsQueries - Queries to be sent with the request

Return Type

BusinessPartnerGroup|error - The requested entity

deleteBusinessPartnerGroups

Isolated FunctionRemote Function

function deleteBusinessPartnerGroups(Signed32 code, map<string|string[]> headers) returns error?

Delete a BusinessPartnerGroup

Parameters

code Signed32 - Key property 'Code' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateBusinessPartnerGroups

Isolated FunctionRemote Function

function updateBusinessPartnerGroups(Signed32 code, BusinessPartnerGroup payload, map<string|string[]> headers) returns error?

Partially update a BusinessPartnerGroup (PATCH/MERGE semantics)

Parameters

code Signed32 - Key property 'Code' (Edm.Int32)

payload BusinessPartnerGroup - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listBusinessPartnerProperties

Isolated FunctionRemote Function

function listBusinessPartnerProperties(ListBusinessPartnerPropertiesHeaders headers, *ListBusinessPartnerPropertiesQueries queries) returns BusinessPartnerPropertiesCollectionResponse|error

Query the BusinessPartnerProperties collection

Parameters

headers ListBusinessPartnerPropertiesHeaders (default {}) - Headers to be sent with the request

queries *ListBusinessPartnerPropertiesQueries - Queries to be sent with the request

Return Type

BusinessPartnerPropertiesCollectionResponse|error - A page of entities

createBusinessPartnerProperties

Isolated FunctionRemote Function

function createBusinessPartnerProperties(BusinessPartnerProperty payload, map<string|string[]> headers) returns BusinessPartnerProperty|error

Create a new BusinessPartnerProperty

Parameters

payload BusinessPartnerProperty - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BusinessPartnerProperty|error - The created entity

getBusinessPartnerProperties

Isolated FunctionRemote Function

function getBusinessPartnerProperties(Signed32 propertyCode, map<string|string[]> headers, *GetBusinessPartnerPropertiesQueries queries) returns BusinessPartnerProperty|error

Get a single BusinessPartnerProperty by key

Parameters

propertyCode Signed32 - Key property 'PropertyCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBusinessPartnerPropertiesQueries - Queries to be sent with the request

Return Type

BusinessPartnerProperty|error - The requested entity

deleteBusinessPartnerProperties

Isolated FunctionRemote Function

function deleteBusinessPartnerProperties(Signed32 propertyCode, map<string|string[]> headers) returns error?

Delete a BusinessPartnerProperty

Parameters

propertyCode Signed32 - Key property 'PropertyCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateBusinessPartnerProperties

Isolated FunctionRemote Function

function updateBusinessPartnerProperties(Signed32 propertyCode, BusinessPartnerProperty payload, map<string|string[]> headers) returns error?

Partially update a BusinessPartnerProperty (PATCH/MERGE semantics)

Parameters

propertyCode Signed32 - Key property 'PropertyCode' (Edm.Int32)

payload BusinessPartnerProperty - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

businessPartnerPropertiesServiceGetBusinessPartnerPropertyList

Isolated FunctionRemote Function

function businessPartnerPropertiesServiceGetBusinessPartnerPropertyList(map<string|string[]> headers) returns inline_response_200_1|error

Get business partner property list

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

inline_response_200_1|error - Function result

listBusinessPartners

Isolated FunctionRemote Function

function listBusinessPartners(ListBusinessPartnersHeaders headers, *ListBusinessPartnersQueries queries) returns BusinessPartnersCollectionResponse|error

Query the BusinessPartners collection

Parameters

headers ListBusinessPartnersHeaders (default {}) - Headers to be sent with the request

queries *ListBusinessPartnersQueries - Queries to be sent with the request

Return Type

BusinessPartnersCollectionResponse|error - A page of entities

createBusinessPartners

Isolated FunctionRemote Function

function createBusinessPartners(BusinessPartner payload, map<string|string[]> headers) returns BusinessPartner|error

Create a new BusinessPartner

Parameters

payload BusinessPartner - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BusinessPartner|error - The created entity

getBusinessPartners

Isolated FunctionRemote Function

function getBusinessPartners(string cardCode, map<string|string[]> headers, *GetBusinessPartnersQueries queries) returns BusinessPartner|error

Get a single BusinessPartner by key

Parameters

cardCode string - Key property 'CardCode' (Edm.String)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBusinessPartnersQueries - Queries to be sent with the request

Return Type

BusinessPartner|error - The requested entity

deleteBusinessPartners

Isolated FunctionRemote Function

function deleteBusinessPartners(string cardCode, map<string|string[]> headers) returns error?

Delete a BusinessPartner

Parameters

cardCode string - Key property 'CardCode' (Edm.String)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateBusinessPartners

Isolated FunctionRemote Function

function updateBusinessPartners(string cardCode, BusinessPartner payload, map<string|string[]> headers) returns error?

Partially update a BusinessPartner (PATCH/MERGE semantics)

Parameters

cardCode string - Key property 'CardCode' (Edm.String)

payload BusinessPartner - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

businessPartnersServiceCreateOpenBalance

Isolated FunctionRemote Function

function businessPartnersServiceCreateOpenBalance(BusinessPartnersService_CreateOpenBalance_body payload, map<string|string[]> headers) returns error?

Create open balance

Parameters

payload BusinessPartnersService_CreateOpenBalance_body - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Success. No content returned

businessPartnersServiceInitData

Isolated FunctionRemote Function

function businessPartnersServiceInitData(map<string|string[]> headers) returns BusinessPartner|error

Init data

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BusinessPartner|error - Function result

listContacts

Isolated FunctionRemote Function

function listContacts(ListContactsHeaders headers, *ListContactsQueries queries) returns ContactsCollectionResponse|error

Query the Contacts collection

Parameters

headers ListContactsHeaders (default {}) - Headers to be sent with the request

queries *ListContactsQueries - Queries to be sent with the request

Return Type

ContactsCollectionResponse|error - A page of entities

createContacts

Isolated FunctionRemote Function

function createContacts(Contact payload, map<string|string[]> headers) returns Contact|error

Create a new Contact

Parameters

payload Contact - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Contact|error - The created entity

getContacts

Isolated FunctionRemote Function

function getContacts(Signed32 contactCode, map<string|string[]> headers, *GetContactsQueries queries) returns Contact|error

Get a single Contact by key

Parameters

contactCode Signed32 - Key property 'ContactCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetContactsQueries - Queries to be sent with the request

Return Type

Contact|error - The requested entity

deleteContacts

Isolated FunctionRemote Function

function deleteContacts(Signed32 contactCode, map<string|string[]> headers) returns error?

Delete a Contact

Parameters

contactCode Signed32 - Key property 'ContactCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateContacts

Isolated FunctionRemote Function

function updateContacts(Signed32 contactCode, Contact payload, map<string|string[]> headers) returns error?

Partially update a Contact (PATCH/MERGE semantics)

Parameters

contactCode Signed32 - Key property 'ContactCode' (Edm.Int32)

payload Contact - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listIndustries

Isolated FunctionRemote Function

function listIndustries(ListIndustriesHeaders headers, *ListIndustriesQueries queries) returns IndustriesCollectionResponse|error

Query the Industries collection

Parameters

headers ListIndustriesHeaders (default {}) - Headers to be sent with the request

queries *ListIndustriesQueries - Queries to be sent with the request

Return Type

IndustriesCollectionResponse|error - A page of entities

createIndustries

Isolated FunctionRemote Function

function createIndustries(Industry payload, map<string|string[]> headers) returns Industry|error

Create a new Industry

Parameters

payload Industry - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Industry|error - The created entity

getIndustries

Isolated FunctionRemote Function

function getIndustries(Signed32 industryCode, map<string|string[]> headers, *GetIndustriesQueries queries) returns Industry|error

Get a single Industry by key

Parameters

industryCode Signed32 - Key property 'IndustryCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetIndustriesQueries - Queries to be sent with the request

Return Type

Industry|error - The requested entity

deleteIndustries

Isolated FunctionRemote Function

function deleteIndustries(Signed32 industryCode, map<string|string[]> headers) returns error?

Delete a Industry

Parameters

industryCode Signed32 - Key property 'IndustryCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateIndustries

Isolated FunctionRemote Function

function updateIndustries(Signed32 industryCode, Industry payload, map<string|string[]> headers) returns error?

Partially update a Industry (PATCH/MERGE semantics)

Parameters

industryCode Signed32 - Key property 'IndustryCode' (Edm.Int32)

payload Industry - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listPaymentTermsTypes

Isolated FunctionRemote Function

function listPaymentTermsTypes(ListPaymentTermsTypesHeaders headers, *ListPaymentTermsTypesQueries queries) returns PaymentTermsTypesCollectionResponse|error

Query the PaymentTermsTypes collection

Parameters

headers ListPaymentTermsTypesHeaders (default {}) - Headers to be sent with the request

queries *ListPaymentTermsTypesQueries - Queries to be sent with the request

Return Type

PaymentTermsTypesCollectionResponse|error - A page of entities

createPaymentTermsTypes

Isolated FunctionRemote Function

function createPaymentTermsTypes(PaymentTermsType payload, map<string|string[]> headers) returns PaymentTermsType|error

Create a new PaymentTermsType

Parameters

payload PaymentTermsType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

PaymentTermsType|error - The created entity

getPaymentTermsTypes

Isolated FunctionRemote Function

function getPaymentTermsTypes(Signed32 groupNumber, map<string|string[]> headers, *GetPaymentTermsTypesQueries queries) returns PaymentTermsType|error

Get a single PaymentTermsType by key

Parameters

groupNumber Signed32 - Key property 'GroupNumber' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetPaymentTermsTypesQueries - Queries to be sent with the request

Return Type

PaymentTermsType|error - The requested entity

deletePaymentTermsTypes

Isolated FunctionRemote Function

function deletePaymentTermsTypes(Signed32 groupNumber, map<string|string[]> headers) returns error?

Delete a PaymentTermsType

Parameters

groupNumber Signed32 - Key property 'GroupNumber' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updatePaymentTermsTypes

Isolated FunctionRemote Function

function updatePaymentTermsTypes(Signed32 groupNumber, PaymentTermsType payload, map<string|string[]> headers) returns error?

Partially update a PaymentTermsType (PATCH/MERGE semantics)

Parameters

groupNumber Signed32 - Key property 'GroupNumber' (Edm.Int32)

payload PaymentTermsType - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

paymentTermsTypesClose

Isolated FunctionRemote Function

function paymentTermsTypesClose(Signed32 groupNumber, map<string|string[]> headers) returns error?

Bound action 'Close' on PaymentTermsTypes (binding type PaymentTermsType)

Parameters

groupNumber Signed32 - Key property 'GroupNumber' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Success. No content returned

paymentTermsTypesServiceUpdateWithBPs

Isolated FunctionRemote Function

function paymentTermsTypesServiceUpdateWithBPs(PaymentTermsTypesService_UpdateWithBPs_body payload, map<string|string[]> headers) returns error?

Update with B ps

Parameters

payload PaymentTermsTypesService_UpdateWithBPs_body - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Success. No content returned

listRelationships

Isolated FunctionRemote Function

function listRelationships(ListRelationshipsHeaders headers, *ListRelationshipsQueries queries) returns RelationshipsCollectionResponse|error

Query the Relationships collection

Parameters

headers ListRelationshipsHeaders (default {}) - Headers to be sent with the request

queries *ListRelationshipsQueries - Queries to be sent with the request

Return Type

RelationshipsCollectionResponse|error - A page of entities

createRelationships

Isolated FunctionRemote Function

function createRelationships(Relationship payload, map<string|string[]> headers) returns Relationship|error

Create a new Relationship

Parameters

payload Relationship - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Relationship|error - The created entity

getRelationships

Isolated FunctionRemote Function

function getRelationships(Signed32 relationshipCode, map<string|string[]> headers, *GetRelationshipsQueries queries) returns Relationship|error

Get a single Relationship by key

Parameters

relationshipCode Signed32 - Key property 'RelationshipCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetRelationshipsQueries - Queries to be sent with the request

Return Type

Relationship|error - The requested entity

deleteRelationships

Isolated FunctionRemote Function

function deleteRelationships(Signed32 relationshipCode, map<string|string[]> headers) returns error?

Delete a Relationship

Parameters

relationshipCode Signed32 - Key property 'RelationshipCode' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateRelationships

Isolated FunctionRemote Function

function updateRelationships(Signed32 relationshipCode, Relationship payload, map<string|string[]> headers) returns error?

Partially update a Relationship (PATCH/MERGE semantics)

Parameters

relationshipCode Signed32 - Key property 'RelationshipCode' (Edm.Int32)

payload Relationship - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

listTerritories

Isolated FunctionRemote Function

function listTerritories(ListTerritoriesHeaders headers, *ListTerritoriesQueries queries) returns TerritoriesCollectionResponse|error

Query the Territories collection

Parameters

headers ListTerritoriesHeaders (default {}) - Headers to be sent with the request

queries *ListTerritoriesQueries - Queries to be sent with the request

Return Type

TerritoriesCollectionResponse|error - A page of entities

createTerritories

Isolated FunctionRemote Function

function createTerritories(Territory payload, map<string|string[]> headers) returns Territory|error

Create a new Territory

Parameters

payload Territory - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Territory|error - The created entity

getTerritories

Isolated FunctionRemote Function

function getTerritories(Signed32 territoryID, map<string|string[]> headers, *GetTerritoriesQueries queries) returns Territory|error

Get a single Territory by key

Parameters

territoryID Signed32 - Key property 'TerritoryID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetTerritoriesQueries - Queries to be sent with the request

Return Type

Territory|error - The requested entity

deleteTerritories

Isolated FunctionRemote Function

function deleteTerritories(Signed32 territoryID, map<string|string[]> headers) returns error?

Delete a Territory

Parameters

territoryID Signed32 - Key property 'TerritoryID' (Edm.Int32)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Deleted. No content returned

updateTerritories

Isolated FunctionRemote Function

function updateTerritories(Signed32 territoryID, Territory payload, map<string|string[]> headers) returns error?

Partially update a Territory (PATCH/MERGE semantics)

Parameters

territoryID Signed32 - Key property 'TerritoryID' (Edm.Int32)

payload Territory - Request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated. No content returned

logout

Isolated FunctionRemote Function

function logout() returns error?

Ends the active SAP Business One Service Layer session

Return Type

error? - An error if the logout failed

Records

sap.businessone.businesspartners: AddressFormat

Closed record

The AddressFormat complex type of the SAP Business One Service Layer

Fields

format? string -

code? Signed32 -

name? string -

sap.businessone.businesspartners: AddressFormatParams

Closed record

The AddressFormatParams complex type of the SAP Business One Service Layer

Fields

code? Signed32 -

name? string -

sap.businessone.businesspartners: AddressParams

The AddressParams complex type of the SAP Business One Service Layer

Fields

Country? string -

State? string -

County? string -

ZipCode? string -

City? string -

Building? string -

Block? string -

Street? string -

StreetNo? string -

Address2? string -

Address3? string -

AddressType? string -

GlobalLocationNumber? string -

sap.businessone.businesspartners: AddressReturnParams

Closed record

The AddressReturnParams complex type of the SAP Business One Service Layer

Fields

fullAddress? string -

sap.businessone.businesspartners: AddressService_GetAddressFormat_body

Represents the request payload for the AddressService_GetAddressFormat operation of the SAP Business One Service Layer

Fields

addressFormatParams? AddressFormatParams -

sap.businessone.businesspartners: AddressService_GetFullAddress_body

Represents the request payload for the AddressService_GetFullAddress operation of the SAP Business One Service Layer

Fields

addressParams? AddressParams -

sap.businessone.businesspartners: BPAccountReceivablePayble

The BPAccountReceivablePayble complex type of the SAP Business One Service Layer

Fields

AccountType? BoBpAccountTypes - OData EnumType 'BoBpAccountTypes'. Serialised by the Service Layer as the member name

AccountCode? string -

BPCode? string -

sap.businessone.businesspartners: BPAddress

The BPAddress complex type of the SAP Business One Service Layer

Fields

AddressName? string -

Street? string -

Block? string -

ZipCode? string -

City? string -

County? string -

Country? string -

State? string -

FederalTaxID? string -

TaxCode? string -

BuildingFloorRoom? string -

AddressType? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name

AddressName2? string -

AddressName3? string -

TypeOfAddress? string -

StreetNo? string -

BPCode? string -

RowNum? Signed32 -

GlobalLocationNumber? string -

Nationality? string -

TaxOffice? string -

GSTIN? string -

GstType? BoGSTRegnTypeEnum - OData EnumType 'BoGSTRegnTypeEnum'. Serialised by the Service Layer as the member name

CreateDate? string -

CreateTime? string -

MYFType? BoMYFTypeEnum - OData EnumType 'BoMYFTypeEnum'. Serialised by the Service Layer as the member name

TaasEnabled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BPBankAccount

The BPBankAccount complex type of the SAP Business One Service Layer

Fields

LogInstance? Signed32 -

UserNo4? string -

BPCode? string -

County? string -

State? string -

UserNo2? string -

IBAN? string -

ZipCode? string -

City? string -

Block? string -

Branch? string -

Country? string -

Street? string -

ControlKey? string -

UserNo3? string -

BankCode? string -

AccountNo? string -

UserNo1? string -

InternalKey? Signed32 -

BuildingFloorRoom? string -

BIK? string -

AccountName? string -

CorrespondentAccount? string -

Phone? string -

Fax? string -

CustomerIdNumber? string -

ISRBillerID? string -

ISRType? Signed32 -

BICSwiftCode? string -

ABARoutingNumber? string -

MandateID? string -

SignatureDate? string -

MandateExpDate? string -

SEPASeqType? SEPASequenceTypeEnum - OData EnumType 'SEPASequenceTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BPBlockSendingMarketingContent

Closed record

The BPBlockSendingMarketingContent complex type of the SAP Business One Service Layer

Fields

communicationMediaId? Signed32 -

choose? BoYesNoEnum -

cardCode? string -

sap.businessone.businesspartners: BPBranchAssignmentItem

The BPBranchAssignmentItem complex type of the SAP Business One Service Layer

Fields

BPCode? string -

BPLID? Signed32 -

DisabledForBP? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BPCode

Closed record

The BPCode complex type of the SAP Business One Service Layer

Fields

debit? decimal -

systemCredit? decimal -

credit? decimal -

foreignCredit? decimal -

foreignCurrency? string -

bpCtrlAcct? string -

systemDebit? decimal -

foreignDebit? decimal -

dueDate? string -

code? string -

sap.businessone.businesspartners: BPCurrencies

The BPCurrencies complex type of the SAP Business One Service Layer

Fields

CurrencyCode? string -

Include? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BPFiscalRegistryID

The BPFiscalRegistryID entity of the SAP Business One Service Layer

Fields

Numerator? Signed32 -

CNAECode? string -

Description? string -

sap.businessone.businesspartners: BPFiscalRegistryIDCollectionResponse

A paged collection of BPFiscalRegistryID entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BPFiscalRegistryID[] -

odataNextLink? string -

sap.businessone.businesspartners: BPFiscalTaxID

The BPFiscalTaxID complex type of the SAP Business One Service Layer

Fields

Address? string -

CNAECode? Signed32 -

TaxId0? string -

TaxId1? string -

TaxId2? string -

TaxId3? string -

TaxId4? string -

TaxId5? string -

TaxId6? string -

TaxId7? string -

TaxId8? string -

TaxId9? string -

TaxId10? string -

TaxId11? string -

BPCode? string -

AddrType? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name

TaxId12? string -

TaxId13? string -

AToRetrNFe? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

TaxId14? string -

sap.businessone.businesspartners: BPIntrastatExtension

Closed record

The BPIntrastatExtension complex type of the SAP Business One Service Layer

Fields

intrastatRelevant? BoYesNoEnum -

domesticOrForeignID? string -

customsProcedure? Signed32 -

statisticalProcedure? Signed32 -

natureOfTransactions? Signed32 -

portOfEntryOrExit? Signed32 -

cardCode? string -

transportMode? Signed32 -

incoterms? Signed32 -

sap.businessone.businesspartners: BPOpeningBalanceService_CreateOpenBalance_body

Represents the request payload for the BPOpeningBalanceService_CreateOpenBalance operation of the SAP Business One Service Layer

Fields

openningBalanceAccount? OpenningBalanceAccount -

bPCodes? BPCode[] -

sap.businessone.businesspartners: BPPaymentDate

The BPPaymentDate complex type of the SAP Business One Service Layer

Fields

PaymentDate? string -

BPCode? string -

sap.businessone.businesspartners: BPPaymentMethod

The BPPaymentMethod complex type of the SAP Business One Service Layer

Fields

PaymentMethodCode? string -

RowNumber? Signed32 -

BPCode? string -

sap.businessone.businesspartners: BPPrioritiesCollectionResponse

A paged collection of BPPriorities entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BPPriority[] -

odataNextLink? string -

sap.businessone.businesspartners: BPPriority

The BPPriority entity of the SAP Business One Service Layer

Fields

Priority? Signed32 -

PriorityDescription? string -

BusinessPartners? BusinessPartner[] -

sap.businessone.businesspartners: BPVatExemptions

Closed record

The BPVatExemptions entity of the SAP Business One Service Layer

Fields

absoluteEntry? Signed32 -

remarks? string -

businessPartner? BusinessPartner -

bPVatExemptionsLines? BPVatExemptionsLine[] -

bPCode? string -

sap.businessone.businesspartners: BPVatExemptionsCollectionResponse

A paged collection of BPVatExemptions entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BPVatExemptions[] -

odataNextLink? string -

sap.businessone.businesspartners: BPVatExemptionsLine

Closed record

The BPVatExemptionsLine complex type of the SAP Business One Service Layer

Fields

vATRate? decimal -

itemCode? string -

issueDate? string -

itemDescription? string -

lineNumber? Signed32 -

exemptionDocNum? string -

issueTime? string -

absoluteEntry? Signed32 -

taxCode? string -

validTo? string -

validFrom? string -

authoritiesName? string -

exemptionType? Signed32 -

applyAllItems? BoYesNoEnum -

visualOrder? Signed32 -

sap.businessone.businesspartners: BPVatExemptionsParams

Closed record

The BPVatExemptionsParams complex type of the SAP Business One Service Layer

Fields

absoluteEntry? Signed32 -

bPCode? string -

sap.businessone.businesspartners: BPWithholdingTax

The BPWithholdingTax complex type of the SAP Business One Service Layer

Fields

WTCode? string -

BPCode? string -

sap.businessone.businesspartners: BusinessPartner

The BusinessPartner entity of the SAP Business One Service Layer

Fields

CardCode? string -

CardName? string -

CardType? BoCardTypes - OData EnumType 'BoCardTypes'. Serialised by the Service Layer as the member name

GroupCode? Signed32 -

Address? string -

ZipCode? string -

MailAddress? string -

MailZipCode? string -

Phone1? string -

Phone2? string -

Fax? string -

ContactPerson? string -

Notes? string -

PayTermsGrpCode? Signed32 -

CreditLimit? decimal -

MaxCommitment? decimal -

DiscountPercent? decimal -

VatLiable? BoVatStatus - OData EnumType 'BoVatStatus'. Serialised by the Service Layer as the member name

FederalTaxID? string -

DeductibleAtSource? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

DeductionPercent? decimal -

DeductionValidUntil? string -

PriceListNum? Signed32 -

IntrestRatePercent? decimal -

CommissionPercent? decimal -

CommissionGroupCode? Signed32 -

FreeText? string -

SalesPersonCode? Signed32 -

Currency? string -

RateDiffAccount? string -

Cellular? string -

AvarageLate? Signed32 -

City? string -

County? string -

Country? string -

MailCity? string -

MailCounty? string -

MailCountry? string -

EmailAddress? string -

Picture? string -

DefaultAccount? string -

DefaultBranch? string -

DefaultBankCode? string -

AdditionalID? string -

FatherCard? string -

CardForeignName? string -

FatherType? BoFatherCardTypes - OData EnumType 'BoFatherCardTypes'. Serialised by the Service Layer as the member name

DeductionOffice? string -

ExportCode? string -

MinIntrest? decimal -

CurrentAccountBalance? decimal -

OpenDeliveryNotesBalance? decimal -

OpenOrdersBalance? decimal -

OpenChecksBalance? decimal -

VatGroup? string -

ShippingType? Signed32 -

Password? string -

Indicator? string -

IBAN? string -

CreditCardCode? Signed32 -

CreditCardNum? string -

CreditCardExpiration? string -

DebitorAccount? string -

OpenOpportunities? Signed32 -

Valid? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ValidFrom? string -

ValidTo? string -

ValidRemarks? string -

Frozen? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

FrozenFrom? string -

FrozenTo? string -

FrozenRemarks? string -

Block? string -

BillToState? string -

ShipToState? string -

ExemptNum? string -

Priority? Signed32 -

FormCode1099? Signed32 -

Box1099? string -

PeymentMethodCode? string -

BackOrder? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

PartialDelivery? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

BlockDunning? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

BankCountry? string -

HouseBank? string -

HouseBankCountry? string -

HouseBankAccount? string -

ShipToDefault? string -

DunningLevel? Signed32 -

DunningDate? string -

CollectionAuthorization? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

DME? string -

InstructionKey? string -

SinglePayment? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ISRBillerID? string -

PaymentBlock? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ReferenceDetails? string -

HouseBankBranch? string -

OwnerIDNumber? string -

PaymentBlockDescription? Signed32 -

TaxExemptionLetterNum? string -

MaxAmountOfExemption? decimal -

ExemptionValidityDateFrom? string -

ExemptionValidityDateTo? string -

LinkedBusinessPartner? string -

LastMultiReconciliationNum? Signed32 -

DeferredTax? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Equalization? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

SubjectToWithholdingTax? BoYesNoNoneEnum - OData EnumType 'BoYesNoNoneEnum'. Serialised by the Service Layer as the member name

CertificateNumber? string -

ExpirationDate? string -

NationalInsuranceNum? string -

AccrualCriteria? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

WTCode? string -

BillToBuildingFloorRoom? string -

DownPaymentClearAct? string -

ChannelBP? string -

DefaultTechnician? Signed32 -

BilltoDefault? string -

CustomerBillofExchangDisc? string -

Territory? Signed32 -

ShipToBuildingFloorRoom? string -

CustomerBillofExchangPres? string -

ProjectCode? string -

VatGroupLatinAmerica? string -

DunningTerm? string -

Website? string -

OtherReceivablePayable? string -

BillofExchangeonCollection? string -

CompanyPrivate? BoCardCompanyTypes - OData EnumType 'BoCardCompanyTypes'. Serialised by the Service Layer as the member name

LanguageCode? Signed32 -

UnpaidBillofExchange? string -

WithholdingTaxDeductionGroup? Signed32 -

ClosingDateProcedureNumber? Signed32 -

Profession? string -

BankChargesAllocationCode? string -

TaxRoundingRule? BoTaxRoundingRuleTypes - OData EnumType 'BoTaxRoundingRuleTypes'. Serialised by the Service Layer as the member name

Properties1? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties2? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties3? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties4? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties5? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties6? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties7? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties8? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties9? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties10? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties11? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties12? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties13? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties14? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties15? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties16? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties17? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties18? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties19? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties20? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties21? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties22? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties23? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties24? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties25? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties26? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties27? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties28? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties29? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties30? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties31? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties32? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties33? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties34? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties35? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties36? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties37? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties38? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties39? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties40? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties41? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties42? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties43? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties44? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties45? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties46? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties47? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties48? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties49? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties50? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties51? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties52? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties53? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties54? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties55? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties56? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties57? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties58? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties59? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties60? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties61? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties62? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties63? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Properties64? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

CompanyRegistrationNumber? string -

VerificationNumber? string -

DiscountBaseObject? DiscountGroupBaseObjectEnum - OData EnumType 'DiscountGroupBaseObjectEnum'. Serialised by the Service Layer as the member name

DiscountRelations? DiscountGroupRelationsEnum - OData EnumType 'DiscountGroupRelationsEnum'. Serialised by the Service Layer as the member name

TypeReport? AssesseeTypeEnum - OData EnumType 'AssesseeTypeEnum'. Serialised by the Service Layer as the member name

ThresholdOverlook? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

SurchargeOverlook? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Remark1? Signed32 -

ConCerti? string -

DownPaymentInterimAccount? string -

OperationCode347? OperationCode347Enum - OData EnumType 'OperationCode347Enum'. Serialised by the Service Layer as the member name

InsuranceOperation347? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

HierarchicalDeduction? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ShaamGroup? ShaamGroupEnum - OData EnumType 'ShaamGroupEnum'. Serialised by the Service Layer as the member name

WithholdingTaxCertified? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

BookkeepingCertified? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

PlanningGroup? string -

Affiliate? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Industry? Signed32 -

VatIDNum? string -

DatevAccount? string -

DatevFirstDataEntry? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

UseShippedGoodsAccount? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

GTSRegNo? string -

GTSBankAccountNo? string -

GTSBillingAddrTel? string -

ETaxWebSite? Signed32 -

HouseBankIBAN? string -

VATRegistrationNumber? string -

RepresentativeName? string -

IndustryType? string -

BusinessType? string -

Series? Signed32 -

AutomaticPosting? AutomaticPostingEnum - OData EnumType 'AutomaticPostingEnum'. Serialised by the Service Layer as the member name

InterestAccount? string -

FeeAccount? string -

CampaignNumber? Signed32 -

AliasName? string -

DefaultBlanketAgreementNumber? Signed32 -

EffectiveDiscount? DiscountGroupRelationsEnum - OData EnumType 'DiscountGroupRelationsEnum'. Serialised by the Service Layer as the member name

NoDiscounts? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

EffectivePrice? EffectivePriceEnum - OData EnumType 'EffectivePriceEnum'. Serialised by the Service Layer as the member name

EffectivePriceConsidersPriceBeforeDiscount? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

GlobalLocationNumber? string -

EDISenderID? string -

EDIRecipientID? string -

ResidenNumber? ResidenceNumberTypeEnum - OData EnumType 'ResidenceNumberTypeEnum'. Serialised by the Service Layer as the member name

RelationshipCode? string -

RelationshipDateFrom? string -

RelationshipDateTill? string -

UnifiedFederalTaxID? string -

AttachmentEntry? Signed32 -

TypeOfOperation? TypeOfOperationEnum - OData EnumType 'TypeOfOperationEnum'. Serialised by the Service Layer as the member name

EndorsableChecksFromBP? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

AcceptsEndorsedChecks? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

OwnerCode? Signed32 -

BlockSendingMarketingContent? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

AgentCode? string -

PriceMode? PriceModeEnum - OData EnumType 'PriceModeEnum'. Serialised by the Service Layer as the member name

EDocGenerationType? EDocGenerationTypeEnum - OData EnumType 'EDocGenerationTypeEnum'. Serialised by the Service Layer as the member name

EDocStreet? string -

EDocStreetNumber? string -

EDocBuildingNumber? Signed32 -

EDocZipCode? string -

EDocCity? string -

EDocCountry? string -

EDocDistrict? string -

EDocRepresentativeFirstName? string -

EDocRepresentativeSurname? string -

EDocRepresentativeCompany? string -

EDocRepresentativeFiscalCode? string -

EDocRepresentativeAdditionalId? string -

EDocPECAddress? string -

IPACodeForPA? string -

UpdateDate? string -

UpdateTime? string -

ExemptionMaxAmountValidationType? ExemptionMaxAmountValidationTypeEnum - OData EnumType 'ExemptionMaxAmountValidationTypeEnum'. Serialised by the Service Layer as the member name

ECommerceMerchantID? string -

UseBillToAddrToDetermineTax? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

CreateDate? string -

CreateTime? string -

DefaultTransporterEntry? Signed32 -

DefaultTransporterLineNumber? Signed32 -

FCERelevant? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

FCEValidateBaseDelivery? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

MainUsage? Signed32 -

EBooksVATExemptionCause? Signed32 -

LegalText? string -

DataVersion? Signed32 -

ExchangeRateForIncomingPayment? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ExchangeRateForOutgoingPayment? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

CertificateDetails? string -

DefaultCurrency? string -

EORINumber? string -

FCEAsPaymentMeans? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

NotRelevantForMonthlyInvoice? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

NaturalPer? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

SirenNumber? string -

SiretNumber? string -

VATExemptionReason? string -

RoutingCode? string -

PublicDirectoryStatus? BoPublicDirectoryStatusTypes - OData EnumType 'BoPublicDirectoryStatusTypes'. Serialised by the Service Layer as the member name

ElectronicProtocols? ElectronicProtocol[] -

BPAddresses? BPAddress[] -

ContactEmployees? ContactEmployee[] -

BPAccountReceivablePaybleCollection? BPAccountReceivablePayble[] -

BPPaymentMethods? BPPaymentMethod[] -

BPWithholdingTaxCollection? BPWithholdingTax[] -

BPPaymentDates? BPPaymentDate[] -

BPBranchAssignment? BPBranchAssignmentItem[] -

BPBankAccounts? BPBankAccount[] -

BPFiscalTaxIDCollection? BPFiscalTaxID[] -

DiscountGroups? DiscountGroup[] -

BPIntrastatExtension? BPIntrastatExtension - The BPIntrastatExtension complex type of the SAP Business One Service Layer

BPBlockSendingMarketingContents? BPBlockSendingMarketingContent[] -

BPCurrenciesCollection? BPCurrencies[] -

BPVatExemptions? BPVatExemptions[] -

Contacts? Contact[] -

BusinessPartnerGroup? BusinessPartnerGroup - The BusinessPartnerGroup entity of the SAP Business One Service Layer

PaymentTermsType? PaymentTermsType - The PaymentTermsType entity of the SAP Business One Service Layer

BPPriority? BPPriority - The BPPriority entity of the SAP Business One Service Layer

Territory2? Territory - The Territory entity of the SAP Business One Service Layer

Industry2? Industry - The Industry entity of the SAP Business One Service Layer

sap.businessone.businesspartners: BusinessPartnerGroup

The BusinessPartnerGroup entity of the SAP Business One Service Layer

Fields

Code? Signed32 -

Name? string -

Type? BoBusinessPartnerGroupTypes - OData EnumType 'BoBusinessPartnerGroupTypes'. Serialised by the Service Layer as the member name

BusinessPartners? BusinessPartner[] -

sap.businessone.businesspartners: BusinessPartnerGroupsCollectionResponse

A paged collection of BusinessPartnerGroups entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BusinessPartnerGroup[] -

odataNextLink? string -

sap.businessone.businesspartners: BusinessPartnerPropertiesCollectionResponse

A paged collection of BusinessPartnerProperties entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BusinessPartnerProperty[] -

odataNextLink? string -

sap.businessone.businesspartners: BusinessPartnerProperty

The BusinessPartnerProperty entity of the SAP Business One Service Layer

Fields

PropertyCode? Signed32 -

PropertyName? string -

sap.businessone.businesspartners: BusinessPartnerPropertyParams

Closed record

The BusinessPartnerPropertyParams complex type of the SAP Business One Service Layer

Fields

propertyName? string -

propertyCode? Signed32 -

sap.businessone.businesspartners: BusinessPartnersCollectionResponse

A paged collection of BusinessPartners entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BusinessPartner[] -

odataNextLink? string -

sap.businessone.businesspartners: BusinessPartnersService_CreateOpenBalance_body

Represents the request payload for the BusinessPartnersService_CreateOpenBalance operation of the SAP Business One Service Layer

Fields

openningBalanceAccount? OpenningBalanceAccount -

bPCodes? BPCode[] -

sap.businessone.businesspartners: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default

sap.businessone.businesspartners: Contact

The Contact entity of the SAP Business One Service Layer

Fields

CardCode? string -

Notes? string -

ContactDate? string -

ContactTime? string -

Recontact? string -

Closed? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

CloseDate? string -

Phone? string -

Fax? string -

Subject? Signed32 -

DocType? string -

DocNum? string -

DocEntry? string -

ContactCode? Signed32 -

Priority? BoMsgPriorities - OData EnumType 'BoMsgPriorities'. Serialised by the Service Layer as the member name

Details? string -

Activity? BoActivities - OData EnumType 'BoActivities'. Serialised by the Service Layer as the member name

ActivityType? Signed32 -

Location? Signed32 -

StartTime? string -

EndTime? string -

Duration? decimal -

DurationType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

SalesEmployee? Signed32 -

ContactPersonCode? Signed32 -

HandledBy? Signed32 -

Reminder? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ReminderPeriod? decimal -

ReminderType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

City? string -

Personalflag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Street? string -

ParentobjectId? Signed32 -

Parentobjecttype? string -

Room? string -

Inactiveflag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

State? string -

PreviousActivity? Signed32 -

Country? string -

Status? Signed32 -

Tentativeflag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

EndDuedate? string -

DocTypeEx? string -

AttachmentEntry? Signed32 -

StartDate? string -

UserSignature? Signed32 -

UserSignature2? Signed32 -

Emailedflag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

BusinessPartner? BusinessPartner - The BusinessPartner entity of the SAP Business One Service Layer

sap.businessone.businesspartners: ContactEmployee

The ContactEmployee complex type of the SAP Business One Service Layer

Fields

CardCode? string -

Name? string -

Position? string -

Address? string -

Phone1? string -

Phone2? string -

MobilePhone? string -

Fax? string -

E_Mail? string -

Remarks1? string -

Remarks2? string -

Password? string -

InternalCode? Signed32 -

PlaceOfBirth? string -

DateOfBirth? string -

Gender? BoGenderTypes - OData EnumType 'BoGenderTypes'. Serialised by the Service Layer as the member name

Profession? string -

Title? string -

CityOfBirth? string -

Active? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

FirstName? string -

MiddleName? string -

LastName? string -

EmailGroupCode? string -

BlockSendingMarketingContent? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

CreateDate? string -

CreateTime? string -

UpdateDate? string -

UpdateTime? string -

ConnectedAddressName? string -

ConnectedAddressType? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name

ForeignCountry? string -

GenderEx? string -

NaturalPer? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

ContactEmployeeBlockSendingMarketingContents? ContactEmployeeBlockSendingMarketingContent[] -

sap.businessone.businesspartners: ContactEmployeeBlockSendingMarketingContent

Closed record

The ContactEmployeeBlockSendingMarketingContent complex type of the SAP Business One Service Layer

Fields

communicationMediaId? Signed32 -

choose? BoYesNoEnum -

contactEmployeeAbsEntry? Signed32 -

contactPersonName? string -

cardCode? string -

sap.businessone.businesspartners: ContactsCollectionResponse

A paged collection of Contacts entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? Contact[] -

odataNextLink? string -

sap.businessone.businesspartners: DiscountGroup

Closed record

The DiscountGroup complex type of the SAP Business One Service Layer

Fields

discountPercentage? decimal -

objectEntry? string -

bPCode? string -

baseObjectType? DiscountGroupBaseObjectEnum -

sap.businessone.businesspartners: ElectronicProtocol

The ElectronicProtocol complex type of the SAP Business One Service Layer

Fields

ProtocolCode? ElectronicDocProtocolCodeEnum - OData EnumType 'ElectronicDocProtocolCodeEnum'. Serialised by the Service Layer as the member name

GenerationType? ElectronicDocGenTypeEnum - OData EnumType 'ElectronicDocGenTypeEnum'. Serialised by the Service Layer as the member name

MappingID? Signed32 -

TestingMode? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Confirmation? string -

EDocType? Signed32 -

CFDiCancellationReason? string -

CFDiCancellationResponse? string -

RelatedDocuments? RelatedDocument[] -

EBooksRelevant? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

EBooksMARK? string -

EBooksMARKofNegative? string -

EBooksInvoiceType? string -

EBooksInvoiceTypeofNegative? string -

EBillingIRN? string -

EETPKP? string -

EETBKP? string -

SignatureInputMessage? string -

SignatureDigest? string -

FechaTimbrado? string -

SelloSAT? string -

PaymentMethod? string -

RfcProvCertif? string -

NoCertificadoSAT? string -

FPASequenceNumber? Signed32 -

FPASendDateSDI? string -

FPAProgressivo? string -

ProtocolDescription? string -

CFDiExport? string -

EBillingAckNo? string -

EBillingAckDt? string -

EBillingSignedInvoice? string -

EBillingSignedQRCode? string -

EBillingResponseStatus? string -

CFDiCancellationReference? string -

EBooksQRCodePath? string -

EBooksQRCodePathofNegative? string -

CartaPorteID? string -

EBooksDispatchDate? string -

EBooksDispatchTime? string -

sap.businessone.businesspartners: GetBPFiscalRegistryIDQueries

Represents the Queries record for the operation: getBPFiscalRegistryID

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetBPPrioritiesQueries

Represents the Queries record for the operation: getBPPriorities

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetBPVatExemptionsQueries

Represents the Queries record for the operation: getBPVatExemptions

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetBusinessPartnerGroupsQueries

Represents the Queries record for the operation: getBusinessPartnerGroups

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetBusinessPartnerPropertiesQueries

Represents the Queries record for the operation: getBusinessPartnerProperties

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetBusinessPartnersQueries

Represents the Queries record for the operation: getBusinessPartners

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetContactsQueries

Represents the Queries record for the operation: getContacts

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetIndustriesQueries

Represents the Queries record for the operation: getIndustries

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetPaymentTermsTypesQueries

Represents the Queries record for the operation: getPaymentTermsTypes

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetRelationshipsQueries

Represents the Queries record for the operation: getRelationships

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: GetTerritoriesQueries

Represents the Queries record for the operation: getTerritories

Fields

dollarExpand? string - Comma-separated navigation properties to expand

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: IndustriesCollectionResponse

A paged collection of Industries entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? Industry[] -

odataNextLink? string -

sap.businessone.businesspartners: Industry

The Industry entity of the SAP Business One Service Layer

Fields

IndustryDescription? string -

IndustryName? string -

IndustryCode? Signed32 -

BusinessPartners? BusinessPartner[] -

sap.businessone.businesspartners: inline_response_200

Represents the response payload for the BPVatExemptionsService_GetList operation of the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BPVatExemptionsParams[] -

sap.businessone.businesspartners: inline_response_200_1

Represents the response payload for the BusinessPartnerPropertiesService_GetBusinessPartnerPropertyList operation of the SAP Business One Service Layer

Fields

odataMetadata? string -

value? BusinessPartnerPropertyParams[] -

sap.businessone.businesspartners: ListBPFiscalRegistryIDHeaders

Represents the Headers record for the operation: listBPFiscalRegistryID

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListBPFiscalRegistryIDQueries

Represents the Queries record for the operation: listBPFiscalRegistryID

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListBPPrioritiesHeaders

Represents the Headers record for the operation: listBPPriorities

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListBPPrioritiesQueries

Represents the Queries record for the operation: listBPPriorities

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListBPVatExemptionsHeaders

Represents the Headers record for the operation: listBPVatExemptions

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListBPVatExemptionsQueries

Represents the Queries record for the operation: listBPVatExemptions

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListBusinessPartnerGroupsHeaders

Represents the Headers record for the operation: listBusinessPartnerGroups

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListBusinessPartnerGroupsQueries

Represents the Queries record for the operation: listBusinessPartnerGroups

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListBusinessPartnerPropertiesHeaders

Represents the Headers record for the operation: listBusinessPartnerProperties

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListBusinessPartnerPropertiesQueries

Represents the Queries record for the operation: listBusinessPartnerProperties

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListBusinessPartnersHeaders

Represents the Headers record for the operation: listBusinessPartners

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListBusinessPartnersQueries

Represents the Queries record for the operation: listBusinessPartners

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListContactsHeaders

Represents the Headers record for the operation: listContacts

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListContactsQueries

Represents the Queries record for the operation: listContacts

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListIndustriesHeaders

Represents the Headers record for the operation: listIndustries

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListIndustriesQueries

Represents the Queries record for the operation: listIndustries

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListPaymentTermsTypesHeaders

Represents the Headers record for the operation: listPaymentTermsTypes

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListPaymentTermsTypesQueries

Represents the Queries record for the operation: listPaymentTermsTypes

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListRelationshipsHeaders

Represents the Headers record for the operation: listRelationships

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListRelationshipsQueries

Represents the Queries record for the operation: listRelationships

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: ListTerritoriesHeaders

Represents the Headers record for the operation: listTerritories

Fields

prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging

sap.businessone.businesspartners: ListTerritoriesQueries

Represents the Queries record for the operation: listTerritories

Fields

dollarSkip? Signed32 - Number of records to skip (paging)

dollarTop? Signed32 - Maximum number of records to return

dollarFilter? string - OData filter expression

dollarOrderby? string - OData orderby expression

dollarExpand? string - Comma-separated navigation properties to expand

dollarInlinecount? "allpages"|"none" - Set to 'allpages' to include the total count (odata.count)

dollarSelect? string - Comma-separated list of properties to return

sap.businessone.businesspartners: OpenningBalanceAccount

Closed record

The OpenningBalanceAccount complex type of the SAP Business One Service Layer

Fields

details? string -

openBalanceAccount? string -

ref1? string -

ref2? string -

date? string -

bPLID? Signed32 -

sap.businessone.businesspartners: PaymentTermsType

The PaymentTermsType entity of the SAP Business One Service Layer

Fields

GroupNumber? Signed32 -

PaymentTermsGroupName? string -

StartFrom? BoPayTermDueTypes - OData EnumType 'BoPayTermDueTypes'. Serialised by the Service Layer as the member name

NumberOfAdditionalMonths? Signed32 -

NumberOfAdditionalDays? Signed32 -

CreditLimit? decimal -

GeneralDiscount? decimal -

InterestOnArrears? decimal -

PriceListNo? Signed32 -

LoadLimit? decimal -

OpenReceipt? BoOpenIncPayment - OData EnumType 'BoOpenIncPayment'. Serialised by the Service Layer as the member name

DiscountCode? string -

DunningCode? string -

BaselineDate? BoBaselineDate - OData EnumType 'BoBaselineDate'. Serialised by the Service Layer as the member name

NumberOfInstallments? Signed32 -

NumberOfToleranceDays? Signed32 -

EndAt? BoPayTermDueTypes - OData EnumType 'BoPayTermDueTypes'. Serialised by the Service Layer as the member name

BusinessPartners? BusinessPartner[] -

sap.businessone.businesspartners: PaymentTermsTypesCollectionResponse

A paged collection of PaymentTermsTypes entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? PaymentTermsType[] -

odataNextLink? string -

sap.businessone.businesspartners: PaymentTermsTypesService_UpdateWithBPs_body

Represents the request payload for the PaymentTermsTypesService_UpdateWithBPs operation of the SAP Business One Service Layer

Fields

paymentTermsType? PaymentTermsType -

sap.businessone.businesspartners: RelatedDocument

Closed record

The RelatedDocument complex type of the SAP Business One Service Layer

Fields

absEnry? Signed32 -

absEntry? Signed32 -

uUID? string -

docTye? RelatedDocumentTypeEnum -

docType? RelatedDocumentTypeEnum -

sap.businessone.businesspartners: Relationship

The Relationship entity of the SAP Business One Service Layer

Fields

RelationshipDescription? string -

RelationshipCode? Signed32 -

sap.businessone.businesspartners: RelationshipsCollectionResponse

A paged collection of Relationships entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? Relationship[] -

odataNextLink? string -

sap.businessone.businesspartners: TerritoriesCollectionResponse

A paged collection of Territories entities returned by the SAP Business One Service Layer

Fields

odataMetadata? string -

value? Territory[] -

odataNextLink? string -

sap.businessone.businesspartners: Territory

The Territory entity of the SAP Business One Service Layer

Fields

TerritoryID? Signed32 -

Description? string -

LocationIndex? Signed32 -

Inactive? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

Parent? Signed32 -

BusinessPartners? BusinessPartner[] -

Union types

sap.businessone.businesspartners: ElectronicDocGenTypeEnum

"edgt_NotRelevant"|"edgt_Generate"|"edgt_GenerateLater"|"edgt_GenerateOffline"

ElectronicDocGenTypeEnum

OData EnumType 'ElectronicDocGenTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoYesNoEnum

"tNO"|"tYES"

BoYesNoEnum

OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: SEPASequenceTypeEnum

"sstOOFF"|"sstFRST"|"sstRCUR"|"sstFNAL"

SEPASequenceTypeEnum

OData EnumType 'SEPASequenceTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: ResidenceNumberTypeEnum

ResidenceNumberTypeEnum

OData EnumType 'ResidenceNumberTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoPayTermDueTypes

"pdt_MonthEnd"|"pdt_HalfMonth"|"pdt_MonthStart"|"pdt_None"

BoPayTermDueTypes

OData EnumType 'BoPayTermDueTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoVatStatus

"vExempted"|"vLiable"|"vEC"

BoVatStatus

OData EnumType 'BoVatStatus'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: ShaamGroupEnum

ShaamGroupEnum

OData EnumType 'ShaamGroupEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: ExemptionMaxAmountValidationTypeEnum

"emaIndividual"|"emaAccumulated"

ExemptionMaxAmountValidationTypeEnum

OData EnumType 'ExemptionMaxAmountValidationTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoMsgPriorities

"pr_Low"|"pr_Normal"|"pr_High"

BoMsgPriorities

OData EnumType 'BoMsgPriorities'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoPublicDirectoryStatusTypes

"pds_ActivePrivateEntry"|"pds_ActivePublicEntry"|"pds_InactivePrivateEntry"|"pds_InactivePublicEntry"|"pds_NotRegistered"

BoPublicDirectoryStatusTypes

OData EnumType 'BoPublicDirectoryStatusTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: OperationCode347Enum

OperationCode347Enum

OData EnumType 'OperationCode347Enum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoGenderTypes

"gt_Female"|"gt_Male"|"gt_Undefined"|"gt_Masked"|"gt_Invalid"

BoGenderTypes

OData EnumType 'BoGenderTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: EDocGenerationTypeEnum

"edocGenerate"|"edocGenerateLater"|"edocNotRelevant"|"edocGenerateOffline"

EDocGenerationTypeEnum

OData EnumType 'EDocGenerationTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoCardCompanyTypes

"cCompany"|"cPrivate"|"cGovernment"|"cEmployee"|"cSoleTaxableSubject"

BoCardCompanyTypes

OData EnumType 'BoCardCompanyTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoCardTypes

"cCustomer"|"cSupplier"|"cLid"

BoCardTypes

OData EnumType 'BoCardTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoTaxRoundingRuleTypes

"trr_RoundDown"|"trr_RoundUp"|"trr_RoundOff"|"trr_CompanyDefault"

BoTaxRoundingRuleTypes

OData EnumType 'BoTaxRoundingRuleTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoMYFTypeEnum

"myft_WholesaleSales"|"myft_RetailSales"|"myft_WholesalePurchases"|"myft_OtherExpenseTransactions"

BoMYFTypeEnum

OData EnumType 'BoMYFTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: TypeOfOperationEnum

TypeOfOperationEnum

OData EnumType 'TypeOfOperationEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoOpenIncPayment

"oip_No"|"oip_Cash"|"oip_Checks"|"oip_Credit"|"oip_BankTransfer"

BoOpenIncPayment

OData EnumType 'BoOpenIncPayment'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: AssesseeTypeEnum

"atCompany"|"atOthers"

AssesseeTypeEnum

OData EnumType 'AssesseeTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoAddressType

"bo_ShipTo"|"bo_BillTo"

BoAddressType

OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: ElectronicDocProtocolCodeEnum

ElectronicDocProtocolCodeEnum

OData EnumType 'ElectronicDocProtocolCodeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: DiscountGroupBaseObjectEnum

"dgboNone"|"dgboItemGroups"|"dgboItemProperties"|"dgboManufacturer"|"dgboItems"

DiscountGroupBaseObjectEnum

OData EnumType 'DiscountGroupBaseObjectEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: PriceModeEnum

"pmNet"|"pmGross"

PriceModeEnum

OData EnumType 'PriceModeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: AutomaticPostingEnum

"apNo"|"apInterestAndFee"|"apInterestOnly"|"apFeeOnly"

AutomaticPostingEnum

OData EnumType 'AutomaticPostingEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoGSTRegnTypeEnum

BoGSTRegnTypeEnum

OData EnumType 'BoGSTRegnTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoBusinessPartnerGroupTypes

"bbpgt_CustomerGroup"|"bbpgt_VendorGroup"

BoBusinessPartnerGroupTypes

OData EnumType 'BoBusinessPartnerGroupTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: RelatedDocumentTypeEnum

"rdt_Payment"|"rdt_Reconciliation"

RelatedDocumentTypeEnum

OData EnumType 'RelatedDocumentTypeEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoActivities

BoActivities

OData EnumType 'BoActivities'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoBaselineDate

"bld_PostingDate"|"bld_SystemDate"|"bld_TaxDate"|"bld_ClosingDate"

BoBaselineDate

OData EnumType 'BoBaselineDate'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoYesNoNoneEnum

"boNO"|"boYES"|"boNONE"

BoYesNoNoneEnum

OData EnumType 'BoYesNoNoneEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: EffectivePriceEnum

"epDefaultPriority"|"epLowestPrice"|"epHighestPrice"

EffectivePriceEnum

OData EnumType 'EffectivePriceEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoFatherCardTypes

"cPayments_sum"|"cDelivery_sum"

BoFatherCardTypes

OData EnumType 'BoFatherCardTypes'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: DiscountGroupRelationsEnum

"dgrLowestDiscount"|"dgrHighestDiscount"|"dgrAverageDiscount"|"dgrDiscountTotals"|"dgrMultipliedDiscount"

DiscountGroupRelationsEnum

OData EnumType 'DiscountGroupRelationsEnum'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoDurations

"du_Seconds"|"du_Minuts"|"du_Hours"|"du_Days"

BoDurations

OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name

sap.businessone.businesspartners: BoBpAccountTypes

BoBpAccountTypes

OData EnumType 'BoBpAccountTypes'. Serialised by the Service Layer as the member name

Import

import ballerinax/sap.businessone.businesspartners;

Other versions

1.0.2 1.0.1

1.0.0

Metadata

Released date: 12 days ago

Version: 1.0.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.13.0

GraalVM compatible: Yes

Pull count

Total: 2

Current verison: 0

Weekly downloads

Source repository

Keywords

Name/SAP Business One Business Partners

Area/ERP & Business Operations

Vendor/SAP

Cost/Paid

Type/Connector

SAP Business One

Business Partners

ERP

Contributors

Dependencies

ballerina/os/1.10.1 ballerina/log/2.14.0 ballerina/data.jsondata/1.1.3

Cookie policy

Delete policy

clients

records

unionTypes

ballerinax/sap.businessone.businesspartners Ballerina library

Overview

Key Features

Setup guide

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Step 4: Run the Ballerina application

Examples

Clients

sap.businessone.businesspartners: Client

Constructor

addressServiceGetAddressFormat

Parameters

Return Type

addressServiceGetFullAddress

Parameters

Return Type

listBPFiscalRegistryID

Parameters

Return Type

createBPFiscalRegistryID

Parameters

Return Type

getBPFiscalRegistryID

Parameters

Return Type

deleteBPFiscalRegistryID

Parameters

Return Type

updateBPFiscalRegistryID

Parameters

Return Type

bPOpeningBalanceServiceCreateOpenBalance

Parameters

Return Type

listBPPriorities

Parameters

Return Type

createBPPriorities

Parameters

Return Type

getBPPriorities

Parameters

Return Type

deleteBPPriorities

Parameters

Return Type

updateBPPriorities

Parameters

Return Type

listBPVatExemptions

Parameters

Return Type

createBPVatExemptions

Parameters

Return Type

getBPVatExemptions

Parameters

Return Type

deleteBPVatExemptions

Parameters

Return Type

updateBPVatExemptions

Parameters

Return Type

bPVatExemptionsServiceGetList

Parameters

Return Type

listBusinessPartnerGroups

Parameters

Return Type

createBusinessPartnerGroups

Parameters

Return Type

getBusinessPartnerGroups