sap.businessone.crm
Module sap.businessone.crm
API
Definitions
ballerinax/sap.businessone.crm Ballerina library
Overview
SAP Business One is an enterprise resource planning (ERP) solution designed for small and midsize businesses by SAP SE.
The SAP Business One CRM connector provides APIs for the CRM objects of SAP Business One: activities, campaigns, target groups, and sales opportunities, exposed through the SAP Business One Service Layer (OData).
Key Features
- Log and query activities (calls, meetings, tasks, notes)
- Manage campaigns and target groups
- Track sales opportunities, stages, and competitors
Setup guide
The connector requires an SAP Business One installation with the Service Layer component enabled.
To connect, you need three values from the SAP Business One desktop client's login screen: the company database, your user name, and your password.
Click the company name at the top of the SAP Business One desktop application, or contact your administrator.

The Service Layer endpoint follows the pattern https://<host>:50000/b1s/v1.
Quickstart
To use the sap.businessone.crm connector in your Ballerina application, modify the .bal file as follows:
Step 1: Import the module
import ballerinax/sap.businessone.crm;
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 = ?; crm:Client b1Client = check new ( {companyDb, username, password}, serviceUrl = serviceUrl );
Step 3: Invoke the connector operation
crm:SalesOpportunities_CollectionResponse response = check b1Client->salesOpportunitiesList();
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.crm: Client
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
listActivities
function listActivities(ListActivitiesHeaders headers, *ListActivitiesQueries queries) returns ActivitiesCollectionResponse|errorQuery the Activities collection
Parameters
- headers ListActivitiesHeaders (default {}) - Headers to be sent with the request
- queries *ListActivitiesQueries - Queries to be sent with the request
Return Type
- ActivitiesCollectionResponse|error - A page of entities
createActivities
Create a new Activity
Parameters
- payload Activity - Request payload
getActivities
function getActivities(Signed32 activityCode, map<string|string[]> headers, *GetActivitiesQueries queries) returns Activity|errorGet a single Activity by key
Parameters
- activityCode Signed32 - Key property 'ActivityCode' (Edm.Int32)
- queries *GetActivitiesQueries - Queries to be sent with the request
deleteActivities
Delete a Activity
Parameters
- activityCode Signed32 - Key property 'ActivityCode' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateActivities
function updateActivities(Signed32 activityCode, Activity payload, map<string|string[]> headers) returns error?Partially update a Activity (PATCH/MERGE semantics)
Parameters
- activityCode Signed32 - Key property 'ActivityCode' (Edm.Int32)
- payload Activity - Request payload
Return Type
- error? - Updated. No content returned
activitiesServiceDeleteSingleInstanceFromSeries
function activitiesServiceDeleteSingleInstanceFromSeries(ActivitiesService_DeleteSingleInstanceFromSeries_body payload, map<string|string[]> headers) returns error?Delete single instance from series
Parameters
- payload ActivitiesService_DeleteSingleInstanceFromSeries_body - Request payload
Return Type
- error? - Success. No content returned
activitiesServiceGetActivityList
function activitiesServiceGetActivityList(map<string|string[]> headers) returns inline_response_200|errorGet activity list
Return Type
- inline_response_200|error - Function result
activitiesServiceGetListByAttendUser
function activitiesServiceGetListByAttendUser(ActivitiesService_GetListByAttendUser_body payload, map<string|string[]> headers) returns inline_response_200_1|errorGet list by attend user
Parameters
- payload ActivitiesService_GetListByAttendUser_body - Request payload
Return Type
- inline_response_200_1|error - Function result
activitiesServiceGetSingleInstanceFromSeries
function activitiesServiceGetSingleInstanceFromSeries(ActivitiesService_GetSingleInstanceFromSeries_body payload, map<string|string[]> headers) returns Activity|errorGet single instance from series
Parameters
- payload ActivitiesService_GetSingleInstanceFromSeries_body - Request payload
activitiesServiceGetTopNActivityInstances
function activitiesServiceGetTopNActivityInstances(ActivitiesService_GetTopNActivityInstances_body payload, map<string|string[]> headers) returns inline_response_200_2|errorGet top N activity instances
Parameters
- payload ActivitiesService_GetTopNActivityInstances_body - Request payload
Return Type
- inline_response_200_2|error - Function result
activitiesServiceInitData
Init data
activitiesServiceUpdateSingleInstanceInSeries
function activitiesServiceUpdateSingleInstanceInSeries(ActivitiesService_UpdateSingleInstanceInSeries_body payload, map<string|string[]> headers) returns ActivityParams|errorUpdate single instance in series
Parameters
- payload ActivitiesService_UpdateSingleInstanceInSeries_body - Request payload
Return Type
- ActivityParams|error - Function result
listActivityLocations
function listActivityLocations(ListActivityLocationsHeaders headers, *ListActivityLocationsQueries queries) returns ActivityLocationsCollectionResponse|errorQuery the ActivityLocations collection
Parameters
- headers ListActivityLocationsHeaders (default {}) - Headers to be sent with the request
- queries *ListActivityLocationsQueries - Queries to be sent with the request
Return Type
- ActivityLocationsCollectionResponse|error - A page of entities
createActivityLocations
function createActivityLocations(ActivityLocation payload, map<string|string[]> headers) returns ActivityLocation|errorCreate a new ActivityLocation
Parameters
- payload ActivityLocation - Request payload
Return Type
- ActivityLocation|error - The created entity
getActivityLocations
function getActivityLocations(Signed32 code, map<string|string[]> headers, *GetActivityLocationsQueries queries) returns ActivityLocation|errorGet a single ActivityLocation by key
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
- queries *GetActivityLocationsQueries - Queries to be sent with the request
Return Type
- ActivityLocation|error - The requested entity
deleteActivityLocations
Delete a ActivityLocation
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateActivityLocations
function updateActivityLocations(Signed32 code, ActivityLocation payload, map<string|string[]> headers) returns error?Partially update a ActivityLocation (PATCH/MERGE semantics)
Return Type
- error? - Updated. No content returned
listActivityRecipientLists
function listActivityRecipientLists(ListActivityRecipientListsHeaders headers, *ListActivityRecipientListsQueries queries) returns ActivityRecipientListsCollectionResponse|errorQuery the ActivityRecipientLists collection
Parameters
- headers ListActivityRecipientListsHeaders (default {}) - Headers to be sent with the request
- queries *ListActivityRecipientListsQueries - Queries to be sent with the request
Return Type
- ActivityRecipientListsCollectionResponse|error - A page of entities
createActivityRecipientLists
function createActivityRecipientLists(ActivityRecipientList payload, map<string|string[]> headers) returns ActivityRecipientList|errorCreate a new ActivityRecipientList
Parameters
- payload ActivityRecipientList - Request payload
Return Type
- ActivityRecipientList|error - The created entity
getActivityRecipientLists
function getActivityRecipientLists(Signed32 code, map<string|string[]> headers, *GetActivityRecipientListsQueries queries) returns ActivityRecipientList|errorGet a single ActivityRecipientList by key
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
- queries *GetActivityRecipientListsQueries - Queries to be sent with the request
Return Type
- ActivityRecipientList|error - The requested entity
deleteActivityRecipientLists
Delete a ActivityRecipientList
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateActivityRecipientLists
function updateActivityRecipientLists(Signed32 code, ActivityRecipientList payload, map<string|string[]> headers) returns error?Partially update a ActivityRecipientList (PATCH/MERGE semantics)
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
- payload ActivityRecipientList - Request payload
Return Type
- error? - Updated. No content returned
activityRecipientListsServiceGetList
function activityRecipientListsServiceGetList(map<string|string[]> headers) returns inline_response_200_3|errorGet list
Return Type
- inline_response_200_3|error - Function result
listActivityStatuses
function listActivityStatuses(ListActivityStatusesHeaders headers, *ListActivityStatusesQueries queries) returns ActivityStatusesCollectionResponse|errorQuery the ActivityStatuses collection
Parameters
- headers ListActivityStatusesHeaders (default {}) - Headers to be sent with the request
- queries *ListActivityStatusesQueries - Queries to be sent with the request
Return Type
- ActivityStatusesCollectionResponse|error - A page of entities
createActivityStatuses
function createActivityStatuses(ActivityStatus payload, map<string|string[]> headers) returns ActivityStatus|errorCreate a new ActivityStatus
Parameters
- payload ActivityStatus - Request payload
Return Type
- ActivityStatus|error - The created entity
getActivityStatuses
function getActivityStatuses(Signed32 statusId, map<string|string[]> headers, *GetActivityStatusesQueries queries) returns ActivityStatus|errorGet a single ActivityStatus by key
Parameters
- statusId Signed32 - Key property 'StatusId' (Edm.Int32)
- queries *GetActivityStatusesQueries - Queries to be sent with the request
Return Type
- ActivityStatus|error - The requested entity
deleteActivityStatuses
Delete a ActivityStatus
Parameters
- statusId Signed32 - Key property 'StatusId' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateActivityStatuses
function updateActivityStatuses(Signed32 statusId, ActivityStatus payload, map<string|string[]> headers) returns error?Partially update a ActivityStatus (PATCH/MERGE semantics)
Parameters
- statusId Signed32 - Key property 'StatusId' (Edm.Int32)
- payload ActivityStatus - Request payload
Return Type
- error? - Updated. No content returned
activitySubjectServiceGetActivitySubjectList
function activitySubjectServiceGetActivitySubjectList(map<string|string[]> headers) returns inline_response_200_4|errorGet activity subject list
Return Type
- inline_response_200_4|error - Function result
activitySubjectServiceGetListByTypeCode
function activitySubjectServiceGetListByTypeCode(ActivitySubjectService_GetListByTypeCode_body payload, map<string|string[]> headers) returns inline_response_200_5|errorGet list by type code
Parameters
- payload ActivitySubjectService_GetListByTypeCode_body - Request payload
Return Type
- inline_response_200_5|error - Function result
listActivitySubjects
function listActivitySubjects(ListActivitySubjectsHeaders headers, *ListActivitySubjectsQueries queries) returns ActivitySubjectsCollectionResponse|errorQuery the ActivitySubjects collection
Parameters
- headers ListActivitySubjectsHeaders (default {}) - Headers to be sent with the request
- queries *ListActivitySubjectsQueries - Queries to be sent with the request
Return Type
- ActivitySubjectsCollectionResponse|error - A page of entities
createActivitySubjects
function createActivitySubjects(ActivitySubject payload, map<string|string[]> headers) returns ActivitySubject|errorCreate a new ActivitySubject
Parameters
- payload ActivitySubject - Request payload
Return Type
- ActivitySubject|error - The created entity
getActivitySubjects
function getActivitySubjects(Signed32 code, map<string|string[]> headers, *GetActivitySubjectsQueries queries) returns ActivitySubject|errorGet a single ActivitySubject by key
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
- queries *GetActivitySubjectsQueries - Queries to be sent with the request
Return Type
- ActivitySubject|error - The requested entity
deleteActivitySubjects
Delete a ActivitySubject
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateActivitySubjects
function updateActivitySubjects(Signed32 code, ActivitySubject payload, map<string|string[]> headers) returns error?Partially update a ActivitySubject (PATCH/MERGE semantics)
Return Type
- error? - Updated. No content returned
listActivityTypes
function listActivityTypes(ListActivityTypesHeaders headers, *ListActivityTypesQueries queries) returns ActivityTypesCollectionResponse|errorQuery the ActivityTypes collection
Parameters
- headers ListActivityTypesHeaders (default {}) - Headers to be sent with the request
- queries *ListActivityTypesQueries - Queries to be sent with the request
Return Type
- ActivityTypesCollectionResponse|error - A page of entities
createActivityTypes
function createActivityTypes(ActivityType payload, map<string|string[]> headers) returns ActivityType|errorCreate a new ActivityType
Parameters
- payload ActivityType - Request payload
Return Type
- ActivityType|error - The created entity
getActivityTypes
function getActivityTypes(Signed32 code, map<string|string[]> headers, *GetActivityTypesQueries queries) returns ActivityType|errorGet a single ActivityType by key
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
- queries *GetActivityTypesQueries - Queries to be sent with the request
Return Type
- ActivityType|error - The requested entity
deleteActivityTypes
Delete a ActivityType
Parameters
- code Signed32 - Key property 'Code' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateActivityTypes
function updateActivityTypes(Signed32 code, ActivityType payload, map<string|string[]> headers) returns error?Partially update a ActivityType (PATCH/MERGE semantics)
Return Type
- error? - Updated. No content returned
listCampaignResponseType
function listCampaignResponseType(ListCampaignResponseTypeHeaders headers, *ListCampaignResponseTypeQueries queries) returns CampaignResponseTypeCollectionResponse|errorQuery the CampaignResponseType collection
Parameters
- headers ListCampaignResponseTypeHeaders (default {}) - Headers to be sent with the request
- queries *ListCampaignResponseTypeQueries - Queries to be sent with the request
Return Type
- CampaignResponseTypeCollectionResponse|error - A page of entities
createCampaignResponseType
function createCampaignResponseType(CampaignResponseType payload, map<string|string[]> headers) returns CampaignResponseType|errorCreate a new CampaignResponseType
Parameters
- payload CampaignResponseType - Request payload
Return Type
- CampaignResponseType|error - The created entity
getCampaignResponseType
function getCampaignResponseType(string responseType, map<string|string[]> headers, *GetCampaignResponseTypeQueries queries) returns CampaignResponseType|errorGet a single CampaignResponseType by key
Parameters
- responseType string - Key property 'ResponseType' (Edm.String)
- queries *GetCampaignResponseTypeQueries - Queries to be sent with the request
Return Type
- CampaignResponseType|error - The requested entity
deleteCampaignResponseType
function deleteCampaignResponseType(string responseType, map<string|string[]> headers) returns error?Delete a CampaignResponseType
Parameters
- responseType string - Key property 'ResponseType' (Edm.String)
Return Type
- error? - Deleted. No content returned
updateCampaignResponseType
function updateCampaignResponseType(string responseType, CampaignResponseType payload, map<string|string[]> headers) returns error?Partially update a CampaignResponseType (PATCH/MERGE semantics)
Parameters
- responseType string - Key property 'ResponseType' (Edm.String)
- payload CampaignResponseType - Request payload
Return Type
- error? - Updated. No content returned
campaignResponseTypeServiceGetResponseTypeList
function campaignResponseTypeServiceGetResponseTypeList(map<string|string[]> headers) returns inline_response_200_6|errorGet response type list
Return Type
- inline_response_200_6|error - Function result
listCampaigns
function listCampaigns(ListCampaignsHeaders headers, *ListCampaignsQueries queries) returns CampaignsCollectionResponse|errorQuery the Campaigns collection
Parameters
- headers ListCampaignsHeaders (default {}) - Headers to be sent with the request
- queries *ListCampaignsQueries - Queries to be sent with the request
Return Type
- CampaignsCollectionResponse|error - A page of entities
createCampaigns
Create a new Campaign
Parameters
- payload Campaign - Request payload
getCampaigns
function getCampaigns(Signed32 campaignNumber, map<string|string[]> headers, *GetCampaignsQueries queries) returns Campaign|errorGet a single Campaign by key
Parameters
- campaignNumber Signed32 - Key property 'CampaignNumber' (Edm.Int32)
- queries *GetCampaignsQueries - Queries to be sent with the request
deleteCampaigns
Delete a Campaign
Parameters
- campaignNumber Signed32 - Key property 'CampaignNumber' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateCampaigns
function updateCampaigns(Signed32 campaignNumber, Campaign payload, map<string|string[]> headers) returns error?Partially update a Campaign (PATCH/MERGE semantics)
Parameters
- campaignNumber Signed32 - Key property 'CampaignNumber' (Edm.Int32)
- payload Campaign - Request payload
Return Type
- error? - Updated. No content returned
campaignsCancel
Bound action 'Cancel' on Campaigns (binding type Campaign)
Parameters
- campaignNumber Signed32 - Key property 'CampaignNumber' (Edm.Int32)
Return Type
- error? - Success. No content returned
campaignsServiceGetList
function campaignsServiceGetList(map<string|string[]> headers) returns inline_response_200_7|errorGet list
Return Type
- inline_response_200_7|error - Function result
listPartnersSetups
function listPartnersSetups(ListPartnersSetupsHeaders headers, *ListPartnersSetupsQueries queries) returns PartnersSetupsCollectionResponse|errorQuery the PartnersSetups collection
Parameters
- headers ListPartnersSetupsHeaders (default {}) - Headers to be sent with the request
- queries *ListPartnersSetupsQueries - Queries to be sent with the request
Return Type
- PartnersSetupsCollectionResponse|error - A page of entities
createPartnersSetups
function createPartnersSetups(PartnersSetup payload, map<string|string[]> headers) returns PartnersSetup|errorCreate a new PartnersSetup
Parameters
- payload PartnersSetup - Request payload
Return Type
- PartnersSetup|error - The created entity
getPartnersSetups
function getPartnersSetups(Signed32 partnerID, map<string|string[]> headers, *GetPartnersSetupsQueries queries) returns PartnersSetup|errorGet a single PartnersSetup by key
Parameters
- partnerID Signed32 - Key property 'PartnerID' (Edm.Int32)
- queries *GetPartnersSetupsQueries - Queries to be sent with the request
Return Type
- PartnersSetup|error - The requested entity
deletePartnersSetups
Delete a PartnersSetup
Parameters
- partnerID Signed32 - Key property 'PartnerID' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updatePartnersSetups
function updatePartnersSetups(Signed32 partnerID, PartnersSetup payload, map<string|string[]> headers) returns error?Partially update a PartnersSetup (PATCH/MERGE semantics)
Parameters
- partnerID Signed32 - Key property 'PartnerID' (Edm.Int32)
- payload PartnersSetup - Request payload
Return Type
- error? - Updated. No content returned
partnersSetupsServiceGetList
function partnersSetupsServiceGetList(map<string|string[]> headers) returns inline_response_200_8|errorGet list
Return Type
- inline_response_200_8|error - Function result
listSalesOpportunities
function listSalesOpportunities(ListSalesOpportunitiesHeaders headers, *ListSalesOpportunitiesQueries queries) returns SalesOpportunitiesCollectionResponse|errorQuery the SalesOpportunities collection
Parameters
- headers ListSalesOpportunitiesHeaders (default {}) - Headers to be sent with the request
- queries *ListSalesOpportunitiesQueries - Queries to be sent with the request
Return Type
- SalesOpportunitiesCollectionResponse|error - A page of entities
createSalesOpportunities
function createSalesOpportunities(SalesOpportunities payload, map<string|string[]> headers) returns SalesOpportunities|errorCreate a new SalesOpportunities
Parameters
- payload SalesOpportunities - Request payload
Return Type
- SalesOpportunities|error - The created entity
getSalesOpportunities
function getSalesOpportunities(Signed32 sequentialNo, map<string|string[]> headers, *GetSalesOpportunitiesQueries queries) returns SalesOpportunities|errorGet a single SalesOpportunities by key
Parameters
- sequentialNo Signed32 - Key property 'SequentialNo' (Edm.Int32)
- queries *GetSalesOpportunitiesQueries - Queries to be sent with the request
Return Type
- SalesOpportunities|error - The requested entity
deleteSalesOpportunities
function deleteSalesOpportunities(Signed32 sequentialNo, map<string|string[]> headers) returns error?Delete a SalesOpportunities
Parameters
- sequentialNo Signed32 - Key property 'SequentialNo' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateSalesOpportunities
function updateSalesOpportunities(Signed32 sequentialNo, SalesOpportunities payload, map<string|string[]> headers) returns error?Partially update a SalesOpportunities (PATCH/MERGE semantics)
Parameters
- sequentialNo Signed32 - Key property 'SequentialNo' (Edm.Int32)
- payload SalesOpportunities - Request payload
Return Type
- error? - Updated. No content returned
salesOpportunitiesClose
function salesOpportunitiesClose(Signed32 sequentialNo, map<string|string[]> headers) returns error?Bound action 'Close' on SalesOpportunities (binding type SalesOpportunities)
Parameters
- sequentialNo Signed32 - Key property 'SequentialNo' (Edm.Int32)
Return Type
- error? - Success. No content returned
listSalesOpportunityCompetitorsSetup
function listSalesOpportunityCompetitorsSetup(ListSalesOpportunityCompetitorsSetupHeaders headers, *ListSalesOpportunityCompetitorsSetupQueries queries) returns SalesOpportunityCompetitorsSetupCollectionResponse|errorQuery the SalesOpportunityCompetitorsSetup collection
Parameters
- headers ListSalesOpportunityCompetitorsSetupHeaders (default {}) - Headers to be sent with the request
- queries *ListSalesOpportunityCompetitorsSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunityCompetitorsSetupCollectionResponse|error - A page of entities
createSalesOpportunityCompetitorsSetup
function createSalesOpportunityCompetitorsSetup(SalesOpportunityCompetitorSetup payload, map<string|string[]> headers) returns SalesOpportunityCompetitorSetup|errorCreate a new SalesOpportunityCompetitorSetup
Parameters
- payload SalesOpportunityCompetitorSetup - Request payload
Return Type
- SalesOpportunityCompetitorSetup|error - The created entity
getSalesOpportunityCompetitorsSetup
function getSalesOpportunityCompetitorsSetup(Signed32 sequenceNo, map<string|string[]> headers, *GetSalesOpportunityCompetitorsSetupQueries queries) returns SalesOpportunityCompetitorSetup|errorGet a single SalesOpportunityCompetitorSetup by key
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- queries *GetSalesOpportunityCompetitorsSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunityCompetitorSetup|error - The requested entity
deleteSalesOpportunityCompetitorsSetup
function deleteSalesOpportunityCompetitorsSetup(Signed32 sequenceNo, map<string|string[]> headers) returns error?Delete a SalesOpportunityCompetitorSetup
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateSalesOpportunityCompetitorsSetup
function updateSalesOpportunityCompetitorsSetup(Signed32 sequenceNo, SalesOpportunityCompetitorSetup payload, map<string|string[]> headers) returns error?Partially update a SalesOpportunityCompetitorSetup (PATCH/MERGE semantics)
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- payload SalesOpportunityCompetitorSetup - Request payload
Return Type
- error? - Updated. No content returned
salesOpportunityCompetitorsSetupServiceGetSalesOpportunityCompetitorSetupList
function salesOpportunityCompetitorsSetupServiceGetSalesOpportunityCompetitorSetupList(map<string|string[]> headers) returns inline_response_200_9|errorGet sales opportunity competitor setup list
Return Type
- inline_response_200_9|error - Function result
listSalesOpportunityInterestsSetup
function listSalesOpportunityInterestsSetup(ListSalesOpportunityInterestsSetupHeaders headers, *ListSalesOpportunityInterestsSetupQueries queries) returns SalesOpportunityInterestsSetupCollectionResponse|errorQuery the SalesOpportunityInterestsSetup collection
Parameters
- headers ListSalesOpportunityInterestsSetupHeaders (default {}) - Headers to be sent with the request
- queries *ListSalesOpportunityInterestsSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunityInterestsSetupCollectionResponse|error - A page of entities
createSalesOpportunityInterestsSetup
function createSalesOpportunityInterestsSetup(SalesOpportunityInterestSetup payload, map<string|string[]> headers) returns SalesOpportunityInterestSetup|errorCreate a new SalesOpportunityInterestSetup
Parameters
- payload SalesOpportunityInterestSetup - Request payload
Return Type
- SalesOpportunityInterestSetup|error - The created entity
getSalesOpportunityInterestsSetup
function getSalesOpportunityInterestsSetup(Signed32 sequenceNo, map<string|string[]> headers, *GetSalesOpportunityInterestsSetupQueries queries) returns SalesOpportunityInterestSetup|errorGet a single SalesOpportunityInterestSetup by key
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- queries *GetSalesOpportunityInterestsSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunityInterestSetup|error - The requested entity
deleteSalesOpportunityInterestsSetup
function deleteSalesOpportunityInterestsSetup(Signed32 sequenceNo, map<string|string[]> headers) returns error?Delete a SalesOpportunityInterestSetup
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateSalesOpportunityInterestsSetup
function updateSalesOpportunityInterestsSetup(Signed32 sequenceNo, SalesOpportunityInterestSetup payload, map<string|string[]> headers) returns error?Partially update a SalesOpportunityInterestSetup (PATCH/MERGE semantics)
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- payload SalesOpportunityInterestSetup - Request payload
Return Type
- error? - Updated. No content returned
salesOpportunityInterestsSetupServiceGetSalesOpportunityInterestSetupList
function salesOpportunityInterestsSetupServiceGetSalesOpportunityInterestSetupList(map<string|string[]> headers) returns inline_response_200_10|errorGet sales opportunity interest setup list
Return Type
- inline_response_200_10|error - Function result
listSalesOpportunityReasonsSetup
function listSalesOpportunityReasonsSetup(ListSalesOpportunityReasonsSetupHeaders headers, *ListSalesOpportunityReasonsSetupQueries queries) returns SalesOpportunityReasonsSetupCollectionResponse|errorQuery the SalesOpportunityReasonsSetup collection
Parameters
- headers ListSalesOpportunityReasonsSetupHeaders (default {}) - Headers to be sent with the request
- queries *ListSalesOpportunityReasonsSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunityReasonsSetupCollectionResponse|error - A page of entities
createSalesOpportunityReasonsSetup
function createSalesOpportunityReasonsSetup(SalesOpportunityReasonSetup payload, map<string|string[]> headers) returns SalesOpportunityReasonSetup|errorCreate a new SalesOpportunityReasonSetup
Parameters
- payload SalesOpportunityReasonSetup - Request payload
Return Type
- SalesOpportunityReasonSetup|error - The created entity
getSalesOpportunityReasonsSetup
function getSalesOpportunityReasonsSetup(Signed32 sequenceNo, map<string|string[]> headers, *GetSalesOpportunityReasonsSetupQueries queries) returns SalesOpportunityReasonSetup|errorGet a single SalesOpportunityReasonSetup by key
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- queries *GetSalesOpportunityReasonsSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunityReasonSetup|error - The requested entity
deleteSalesOpportunityReasonsSetup
function deleteSalesOpportunityReasonsSetup(Signed32 sequenceNo, map<string|string[]> headers) returns error?Delete a SalesOpportunityReasonSetup
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateSalesOpportunityReasonsSetup
function updateSalesOpportunityReasonsSetup(Signed32 sequenceNo, SalesOpportunityReasonSetup payload, map<string|string[]> headers) returns error?Partially update a SalesOpportunityReasonSetup (PATCH/MERGE semantics)
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- payload SalesOpportunityReasonSetup - Request payload
Return Type
- error? - Updated. No content returned
salesOpportunityReasonsSetupServiceGetSalesOpportunityReasonSetupList
function salesOpportunityReasonsSetupServiceGetSalesOpportunityReasonSetupList(map<string|string[]> headers) returns inline_response_200_11|errorGet sales opportunity reason setup list
Return Type
- inline_response_200_11|error - Function result
listSalesOpportunitySourcesSetup
function listSalesOpportunitySourcesSetup(ListSalesOpportunitySourcesSetupHeaders headers, *ListSalesOpportunitySourcesSetupQueries queries) returns SalesOpportunitySourcesSetupCollectionResponse|errorQuery the SalesOpportunitySourcesSetup collection
Parameters
- headers ListSalesOpportunitySourcesSetupHeaders (default {}) - Headers to be sent with the request
- queries *ListSalesOpportunitySourcesSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunitySourcesSetupCollectionResponse|error - A page of entities
createSalesOpportunitySourcesSetup
function createSalesOpportunitySourcesSetup(SalesOpportunitySourceSetup payload, map<string|string[]> headers) returns SalesOpportunitySourceSetup|errorCreate a new SalesOpportunitySourceSetup
Parameters
- payload SalesOpportunitySourceSetup - Request payload
Return Type
- SalesOpportunitySourceSetup|error - The created entity
getSalesOpportunitySourcesSetup
function getSalesOpportunitySourcesSetup(Signed32 sequenceNo, map<string|string[]> headers, *GetSalesOpportunitySourcesSetupQueries queries) returns SalesOpportunitySourceSetup|errorGet a single SalesOpportunitySourceSetup by key
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- queries *GetSalesOpportunitySourcesSetupQueries - Queries to be sent with the request
Return Type
- SalesOpportunitySourceSetup|error - The requested entity
deleteSalesOpportunitySourcesSetup
function deleteSalesOpportunitySourcesSetup(Signed32 sequenceNo, map<string|string[]> headers) returns error?Delete a SalesOpportunitySourceSetup
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateSalesOpportunitySourcesSetup
function updateSalesOpportunitySourcesSetup(Signed32 sequenceNo, SalesOpportunitySourceSetup payload, map<string|string[]> headers) returns error?Partially update a SalesOpportunitySourceSetup (PATCH/MERGE semantics)
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- payload SalesOpportunitySourceSetup - Request payload
Return Type
- error? - Updated. No content returned
salesOpportunitySourcesSetupServiceGetSalesOpportunitySourceSetupList
function salesOpportunitySourcesSetupServiceGetSalesOpportunitySourceSetupList(map<string|string[]> headers) returns inline_response_200_12|errorGet sales opportunity source setup list
Return Type
- inline_response_200_12|error - Function result
listSalesStages
function listSalesStages(ListSalesStagesHeaders headers, *ListSalesStagesQueries queries) returns SalesStagesCollectionResponse|errorQuery the SalesStages collection
Parameters
- headers ListSalesStagesHeaders (default {}) - Headers to be sent with the request
- queries *ListSalesStagesQueries - Queries to be sent with the request
Return Type
- SalesStagesCollectionResponse|error - A page of entities
createSalesStages
function createSalesStages(SalesStage payload, map<string|string[]> headers) returns SalesStage|errorCreate a new SalesStage
Parameters
- payload SalesStage - Request payload
Return Type
- SalesStage|error - The created entity
getSalesStages
function getSalesStages(Signed32 sequenceNo, map<string|string[]> headers, *GetSalesStagesQueries queries) returns SalesStage|errorGet a single SalesStage by key
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- queries *GetSalesStagesQueries - Queries to be sent with the request
Return Type
- SalesStage|error - The requested entity
deleteSalesStages
Delete a SalesStage
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
Return Type
- error? - Deleted. No content returned
updateSalesStages
function updateSalesStages(Signed32 sequenceNo, SalesStage payload, map<string|string[]> headers) returns error?Partially update a SalesStage (PATCH/MERGE semantics)
Parameters
- sequenceNo Signed32 - Key property 'SequenceNo' (Edm.Int32)
- payload SalesStage - Request payload
Return Type
- error? - Updated. No content returned
listTargetGroups
function listTargetGroups(ListTargetGroupsHeaders headers, *ListTargetGroupsQueries queries) returns TargetGroupsCollectionResponse|errorQuery the TargetGroups collection
Parameters
- headers ListTargetGroupsHeaders (default {}) - Headers to be sent with the request
- queries *ListTargetGroupsQueries - Queries to be sent with the request
Return Type
- TargetGroupsCollectionResponse|error - A page of entities
createTargetGroups
function createTargetGroups(TargetGroup payload, map<string|string[]> headers) returns TargetGroup|errorCreate a new TargetGroup
Parameters
- payload TargetGroup - Request payload
Return Type
- TargetGroup|error - The created entity
getTargetGroups
function getTargetGroups(string targetGroupCode, map<string|string[]> headers, *GetTargetGroupsQueries queries) returns TargetGroup|errorGet a single TargetGroup by key
Parameters
- targetGroupCode string - Key property 'TargetGroupCode' (Edm.String)
- queries *GetTargetGroupsQueries - Queries to be sent with the request
Return Type
- TargetGroup|error - The requested entity
deleteTargetGroups
Delete a TargetGroup
Parameters
- targetGroupCode string - Key property 'TargetGroupCode' (Edm.String)
Return Type
- error? - Deleted. No content returned
updateTargetGroups
function updateTargetGroups(string targetGroupCode, TargetGroup payload, map<string|string[]> headers) returns error?Partially update a TargetGroup (PATCH/MERGE semantics)
Parameters
- targetGroupCode string - Key property 'TargetGroupCode' (Edm.String)
- payload TargetGroup - Request payload
Return Type
- error? - Updated. No content returned
targetGroupsServiceGetList
function targetGroupsServiceGetList(map<string|string[]> headers) returns inline_response_200_13|errorGet list
Return Type
- inline_response_200_13|error - Function result
logout
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.crm: ActivitiesCollectionResponse
A paged collection of Activities entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? Activity[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: ActivitiesService_DeleteSingleInstanceFromSeries_body
Represents the request payload for the ActivitiesService_DeleteSingleInstanceFromSeries operation of the SAP Business One Service Layer
Fields
- activityInstanceParams? ActivityInstanceParams - Activity instance params field
sap.businessone.crm: ActivitiesService_GetListByAttendUser_body
Represents the request payload for the ActivitiesService_GetListByAttendUser operation of the SAP Business One Service Layer
Fields
- activity? Activity - Activity field
sap.businessone.crm: ActivitiesService_GetSingleInstanceFromSeries_body
Represents the request payload for the ActivitiesService_GetSingleInstanceFromSeries operation of the SAP Business One Service Layer
Fields
- activityInstanceParams? ActivityInstanceParams - Activity instance params field
sap.businessone.crm: ActivitiesService_GetTopNActivityInstances_body
Represents the request payload for the ActivitiesService_GetTopNActivityInstances operation of the SAP Business One Service Layer
Fields
- activityInstancesListParams? ActivityInstancesListParams - Activity instances list params field
sap.businessone.crm: ActivitiesService_UpdateSingleInstanceInSeries_body
Represents the request payload for the ActivitiesService_UpdateSingleInstanceInSeries operation of the SAP Business One Service Layer
Fields
- activity? Activity - Activity field
sap.businessone.crm: Activity
The Activity entity of the SAP Business One Service Layer
Fields
- ActivityCode? Signed32 - Activity code field
- CardCode? string - Card code field
- Notes? string - Notes field
- ActivityDate? string - Activity date field
- ActivityTime? string - Activity time field
- StartDate? string - Start date field
- Closed? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- CloseDate? string - Close date field
- Phone? string - Phone field
- Fax? string - Fax field
- Subject? Signed32 - Subject field
- DocType? string - Document type field
- DocNum? string - Document number field
- DocEntry? string - Document entry field
- Priority? BoMsgPriorities - OData EnumType 'BoMsgPriorities'. Serialised by the Service Layer as the member name
- Details? string - Details field
- Activity? BoActivities - OData EnumType 'BoActivities'. Serialised by the Service Layer as the member name
- ActivityType? Signed32 - Activity type field
- Location? Signed32 - Location field
- StartTime? string - Start time field
- EndTime? string - End time field
- Duration? decimal - Duration field
- DurationType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name
- SalesEmployee? Signed32 - Sales employee field
- ContactPersonCode? Signed32 - Contact person code field
- HandledBy? Signed32 - Handled by field
- Reminder? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- ReminderPeriod? decimal - Reminder period field
- ReminderType? BoDurations - OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name
- City? string - City field
- PersonalFlag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Street? string - Street field
- ParentObjectId? Signed32 - Parent object ID field
- ParentObjectType? string - Parent object type field
- Room? string - Room field
- InactiveFlag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- State? string - State field
- PreviousActivity? Signed32 - Previous activity field
- Country? string - Country field
- Status? Signed32 - Status field
- TentativeFlag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- EndDueDate? string - End due date field
- DocTypeEx? string - Document type ex field
- AttachmentEntry? Signed32 - Attachment entry field
- RecurrencePattern? RecurrencePatternEnum - OData EnumType 'RecurrencePatternEnum'. Serialised by the Service Layer as the member name
- EndType? EndTypeEnum - OData EnumType 'EndTypeEnum'. Serialised by the Service Layer as the member name
- SeriesStartDate? string - Series start date field
- SeriesEndDate? string - Series end date field
- MaxOccurrence? Signed32 - Max occurrence field
- Interval? Signed32 - Interval field
- Sunday? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Monday? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Tuesday? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Wednesday? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Thursday? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Friday? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Saturday? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- RepeatOption? RepeatOptionEnum - OData EnumType 'RepeatOptionEnum'. Serialised by the Service Layer as the member name
- BelongedSeriesNum? Signed32 - Belonged series number field
- IsRemoved? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- AddressName? string - Address name field
- AddressType? BoAddressType - OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name
- HandledByEmployee? Signed32 - Handled by employee field
- RecurrenceSequenceSpecifier? RecurrenceSequenceEnum - OData EnumType 'RecurrenceSequenceEnum'. Serialised by the Service Layer as the member name
- RecurrenceDayInMonth? Signed32 - Recurrence day in month field
- RecurrenceMonth? Signed32 - Recurrence month field
- RecurrenceDayOfWeek? RecurrenceDayOfWeekEnum - OData EnumType 'RecurrenceDayOfWeekEnum'. Serialised by the Service Layer as the member name
- SalesOpportunityId? Signed32 - Sales opportunity ID field
- SalesOpportunityLine? Signed32 - Sales opportunity line field
- HandledByRecipientList? Signed32 - Handled by recipient list field
- Office365EventId? string - Office365 event ID field
- DataVersion? Signed32 - Data version field
- UserSignature? Signed32 - User signature field
- UserSignature2? Signed32 - User signature2 field
- EmailedFlag? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- CheckInListParams? CheckInParams[] - Check in list params field
- ActivityMultipleRecipients? ActivityMultipleRecipient[] - Activity multiple recipients field
- ActivitySubject? ActivitySubject - The
ActivitySubjectentity of the SAP Business One Service Layer
- ActivityType2? ActivityType - The
ActivityTypeentity of the SAP Business One Service Layer
- ActivityLocation? ActivityLocation - The
ActivityLocationentity of the SAP Business One Service Layer
- ActivityStatus? ActivityStatus - The
ActivityStatusentity of the SAP Business One Service Layer
- ActivityRecipientList? ActivityRecipientList - The
ActivityRecipientListentity of the SAP Business One Service Layer
sap.businessone.crm: ActivityInstanceParams
The ActivityInstanceParams complex type of the SAP Business One Service Layer
Fields
- activityCode? Signed32 - Activity code field
- instanceDate? string - Instance date field
sap.businessone.crm: ActivityInstancesListParams
The ActivityInstancesListParams complex type of the SAP Business One Service Layer
Fields
- startDate? string - Start date field
- instanceCount? Signed32 - Instance count field
sap.businessone.crm: ActivityLocation
The ActivityLocation entity of the SAP Business One Service Layer
Fields
- Code? Signed32 - Code field
- Name? string - Name field
- Activities? Activity[] - Activities field
sap.businessone.crm: ActivityLocationsCollectionResponse
A paged collection of ActivityLocations entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityLocation[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: ActivityMultipleRecipient
The ActivityMultipleRecipient complex type of the SAP Business One Service Layer
Fields
- LineNumer? Signed32 - Line numer field
- RecipientType? ActivityRecipientObjTypeEnum - OData EnumType 'ActivityRecipientObjTypeEnum'. Serialised by the Service Layer as the member name
- RecipientCode? string - Recipient code field
sap.businessone.crm: ActivityParams
The ActivityParams complex type of the SAP Business One Service Layer
Fields
- endTime? string - End time field
- activity? BoActivities - Activity field
- tentativeFlag? BoYesNoEnum - Tentative flag field
- startDate? string - Start date field
- salesOpportunityLine? Signed32 - Sales opportunity line field
- handledBy? Signed32 - Handled by field
- street? string - Street field
- docNum? string - Document number field
- room? string - Room field
- notes? string - Notes field
- docType? string - Document type field
- endDueDate? string - End due date field
- salesOpportunityId? Signed32 - Sales opportunity ID field
- activityCode? Signed32 - Activity code field
- priority? BoMsgPriorities - Priority field
- startTime? string - Start time field
- emailedFlag? BoYesNoEnum - Emailed flag field
- cardCode? string - Card code field
- docEntry? string - Document entry field
- city? string - City field
- inactiveFlag? BoYesNoEnum - Inactive flag field
- details? string - Details field
- closed? BoYesNoEnum - Closed field
- state? string - State field
- country? string - Country field
sap.businessone.crm: ActivityRecipient
The ActivityRecipient complex type of the SAP Business One Service Layer
Fields
- recipientType? RecipientTypeEnum - Recipient type field
- lineNumber? Signed32 - Line number field
- recipientCode? string - Recipient code field
sap.businessone.crm: ActivityRecipientList
The ActivityRecipientList entity of the SAP Business One Service Layer
Fields
- activities? Activity[] - Activities field
- active? BoYesNoEnum - Active field
- isMultiple? BoYesNoEnum - Is multiple field
- code? Signed32 - Code field
- activityRecipientCollection? ActivityRecipient[] - Activity recipient collection field
- name? string - Name field
sap.businessone.crm: ActivityRecipientListParams
The ActivityRecipientListParams complex type of the SAP Business One Service Layer
Fields
- active? BoYesNoEnum - Active field
- isMultiple? BoYesNoEnum - Is multiple field
- code? Signed32 - Code field
- name? string - Name field
sap.businessone.crm: ActivityRecipientListsCollectionResponse
A paged collection of ActivityRecipientLists entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityRecipientList[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: ActivityStatus
The ActivityStatus entity of the SAP Business One Service Layer
Fields
- StatusDescription? string - Status description field
- StatusId? Signed32 - Status ID field
- StatusName? string - Status name field
- Activities? Activity[] - Activities field
sap.businessone.crm: ActivityStatusesCollectionResponse
A paged collection of ActivityStatuses entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityStatus[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: ActivitySubject
The ActivitySubject entity of the SAP Business One Service Layer
Fields
- activities? Activity[] - Activities field
- description? string - Description field
- isActive? BoYesNoEnum - Is active field
- activityType? Signed32 - Activity type field
- code? Signed32 - Code field
- activityType2? ActivityType - Activity type2 field
sap.businessone.crm: ActivitySubjectParams
The ActivitySubjectParams complex type of the SAP Business One Service Layer
Fields
- description? string - Description field
- code? Signed32 - Code field
sap.businessone.crm: ActivitySubjectsCollectionResponse
A paged collection of ActivitySubjects entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivitySubject[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: ActivitySubjectService_GetListByTypeCode_body
Represents the request payload for the ActivitySubjectService_GetListByTypeCode operation of the SAP Business One Service Layer
Fields
- activitySubject? ActivitySubject - Activity subject field
sap.businessone.crm: ActivityType
The ActivityType entity of the SAP Business One Service Layer
Fields
- Code? Signed32 - Code field
- Name? string - Name field
- ActivitySubjects? ActivitySubject[] - Activity subjects field
- Activities? Activity[] - Activities field
sap.businessone.crm: ActivityTypesCollectionResponse
A paged collection of ActivityTypes entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityType[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: Campaign
The Campaign entity of the SAP Business One Service Layer
Fields
- CampaignNumber? Signed32 - Campaign number field
- CampaignName? string - Campaign name field
- CampaignType? CampaignTypeEnum - OData EnumType 'CampaignTypeEnum'. Serialised by the Service Layer as the member name
- TargetGroup? string - Target group field
- Owner? Signed32 - Owner field
- Status? CampaignStatusEnum - OData EnumType 'CampaignStatusEnum'. Serialised by the Service Layer as the member name
- StartDate? string - Start date field
- FinishDate? string - Finish date field
- Remarks? string - Remarks field
- GeneratedByWizard? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- AttachementsEntry? Signed32 - Attachements entry field
- TargetGroupType? TargetGroupTypeEnum - OData EnumType 'TargetGroupTypeEnum'. Serialised by the Service Layer as the member name
- CampaignBusinessPartners? CampaignBusinessPartner[] - Campaign business partners field
- CampaignItems? CampaignItem[] - Campaign items field
- CampaignPartners? CampaignPartner[] - Campaign partners field
- TargetGroup2? TargetGroup - The
TargetGroupentity of the SAP Business One Service Layer
sap.businessone.crm: CampaignBusinessPartner
The CampaignBusinessPartner complex type of the SAP Business One Service Layer
Fields
- CampaignNumber? Signed32 - Campaign number field
- CampaignLineNumber? Signed32 - Campaign line number field
- BPCode? string - Business partner code field
- BPName? string - Business partner name field
- BPGroupName? string - Business partner group name field
- BPIndustryName? string - Business partner industry name field
- BPStatus? string - Business partner status field
- ContactCode? string - Contact code field
- ContactTitle? string - Contact title field
- ContactPosition? string - Contact position field
- ContactEmail? string - Contact email field
- ContactTelephone? string - Contact telephone field
- ContactMobile? string - Contact mobile field
- ContactFax? string - Contact fax field
- ContactAddress? string - Contact address field
- Response? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- RelatedSalesOpportunity? Signed32 - Related sales opportunity field
- Street? string - Street field
- Block? string - Block field
- City? string - City field
- ZipCode? string - Zip code field
- County? string - County field
- State? string - State field
- Country? string - Country field
- Building? string - Building field
- DocType? LinkedDocTypeEnum - OData EnumType 'LinkedDocTypeEnum'. Serialised by the Service Layer as the member name
- IsShowLinkedDoc? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- DocNumber? Signed32 - Document number field
- DocEntry? Signed32 - Document entry field
- FirstName? string - First name field
- MiddleName? string - Middle name field
- LastName? string - Last name field
- AddressID? string - Address ID field
- AddressType? string - Address type field
- AddressName2? string - Address name2 field
- AddressName3? string - Address name3 field
- FederalTaxID? string - Federal tax ID field
- StreetNo? string - Street number field
- CreateActivity? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- AssignTo? CampaignAssignToEnum - OData EnumType 'CampaignAssignToEnum'. Serialised by the Service Layer as the member name
- AssignName? Signed32 - Assign name field
- ResponseType? string - Response type field
sap.businessone.crm: CampaignItem
The CampaignItem complex type of the SAP Business One Service Layer
Fields
- CampaignNumber? Signed32 - Campaign number field
- CampaignLineNumber? Signed32 - Campaign line number field
- ItemCode? string - Item code field
- ItemName? string - Item name field
- ItemType? CampaignItemTypeEnum - OData EnumType 'CampaignItemTypeEnum'. Serialised by the Service Layer as the member name
- ItemGroup? string - Item group field
sap.businessone.crm: CampaignParams
The CampaignParams complex type of the SAP Business One Service Layer
Fields
- campaignNumber? Signed32 - Campaign number field
- campaignName? string - Campaign name field
sap.businessone.crm: CampaignPartner
The CampaignPartner complex type of the SAP Business One Service Layer
Fields
- CampaignNumber? Signed32 - Campaign number field
- CampaignLineNumber? Signed32 - Campaign line number field
- PartnerID? Signed32 - Partner ID field
- RelationshipCode? Signed32 - Relationship code field
- RelatedBP? string - Related business partner field
- Details? string - Details field
sap.businessone.crm: CampaignResponseType
The CampaignResponseType entity of the SAP Business One Service Layer
Fields
- responseTypeDescription? string - Response type description field
- isActive? BoYesNoEnum - Is active field
- responseType? string - Response type field
sap.businessone.crm: CampaignResponseTypeCollectionResponse
A paged collection of CampaignResponseType entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? CampaignResponseType[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: CampaignResponseTypeParams
The CampaignResponseTypeParams complex type of the SAP Business One Service Layer
Fields
- responseTypeDescription? string - Response type description field
- isActive? BoYesNoEnum - Is active field
- responseType? string - Response type field
sap.businessone.crm: CampaignsCollectionResponse
A paged collection of Campaigns entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? Campaign[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: CheckInParams
The CheckInParams complex type of the SAP Business One Service Layer
Fields
- handledBy? Signed32 - Handled by field
- recipientName? string - Recipient name field
- time? string - Time field
- latitude? string - Latitude field
- handledByEmployee? Signed32 - Handled by employee field
- recipientType? string - Recipient type field
- longitude? string - Longitude field
- lineNumber? Signed32 - Line number field
- date? string - Date field
- emailAddress? string - Email address field
- location? string - Location field
sap.businessone.crm: ConnectionConfig
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-forwardedheader
- 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,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default
sap.businessone.crm: GetActivitiesQueries
Represents the Queries record for the operation: getActivities
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetActivityLocationsQueries
Represents the Queries record for the operation: getActivityLocations
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetActivityRecipientListsQueries
Represents the Queries record for the operation: getActivityRecipientLists
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetActivityStatusesQueries
Represents the Queries record for the operation: getActivityStatuses
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetActivitySubjectsQueries
Represents the Queries record for the operation: getActivitySubjects
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetActivityTypesQueries
Represents the Queries record for the operation: getActivityTypes
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetCampaignResponseTypeQueries
Represents the Queries record for the operation: getCampaignResponseType
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetCampaignsQueries
Represents the Queries record for the operation: getCampaigns
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetPartnersSetupsQueries
Represents the Queries record for the operation: getPartnersSetups
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetSalesOpportunitiesQueries
Represents the Queries record for the operation: getSalesOpportunities
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetSalesOpportunityCompetitorsSetupQueries
Represents the Queries record for the operation: getSalesOpportunityCompetitorsSetup
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetSalesOpportunityInterestsSetupQueries
Represents the Queries record for the operation: getSalesOpportunityInterestsSetup
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetSalesOpportunityReasonsSetupQueries
Represents the Queries record for the operation: getSalesOpportunityReasonsSetup
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetSalesOpportunitySourcesSetupQueries
Represents the Queries record for the operation: getSalesOpportunitySourcesSetup
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetSalesStagesQueries
Represents the Queries record for the operation: getSalesStages
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: GetTargetGroupsQueries
Represents the Queries record for the operation: getTargetGroups
Fields
- dollarExpand? string - Comma-separated navigation properties to expand
- dollarSelect? string - Comma-separated list of properties to return
sap.businessone.crm: inline_response_200
Represents the response payload for the ActivitiesService_GetActivityList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityParams[] - Value field
sap.businessone.crm: inline_response_200_1
Represents the response payload for the ActivitiesService_GetListByAttendUser operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityParams[] - Value field
sap.businessone.crm: inline_response_200_10
Represents the response payload for the SalesOpportunityInterestsSetupService_GetSalesOpportunityInterestSetupList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunityInterestSetupParams[] - Value field
sap.businessone.crm: inline_response_200_11
Represents the response payload for the SalesOpportunityReasonsSetupService_GetSalesOpportunityReasonSetupList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunityReasonSetupParams[] - Value field
sap.businessone.crm: inline_response_200_12
Represents the response payload for the SalesOpportunitySourcesSetupService_GetSalesOpportunitySourceSetupList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunitySourceSetupParams[] - Value field
sap.businessone.crm: inline_response_200_13
Represents the response payload for the TargetGroupsService_GetList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? TargetGroupParams[] - Value field
sap.businessone.crm: inline_response_200_2
Represents the response payload for the ActivitiesService_GetTopNActivityInstances operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityInstanceParams[] - Value field
sap.businessone.crm: inline_response_200_3
Represents the response payload for the ActivityRecipientListsService_GetList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivityRecipientListParams[] - Value field
sap.businessone.crm: inline_response_200_4
Represents the response payload for the ActivitySubjectService_GetActivitySubjectList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivitySubjectParams[] - Value field
sap.businessone.crm: inline_response_200_5
Represents the response payload for the ActivitySubjectService_GetListByTypeCode operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? ActivitySubjectParams[] - Value field
sap.businessone.crm: inline_response_200_6
Represents the response payload for the CampaignResponseTypeService_GetResponseTypeList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? CampaignResponseTypeParams[] - Value field
sap.businessone.crm: inline_response_200_7
Represents the response payload for the CampaignsService_GetList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? CampaignParams[] - Value field
sap.businessone.crm: inline_response_200_8
Represents the response payload for the PartnersSetupsService_GetList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? PartnersSetupParams[] - Value field
sap.businessone.crm: inline_response_200_9
Represents the response payload for the SalesOpportunityCompetitorsSetupService_GetSalesOpportunityCompetitorSetupList operation of the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunityCompetitorSetupParams[] - Value field
sap.businessone.crm: ListActivitiesHeaders
Represents the Headers record for the operation: listActivities
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListActivitiesQueries
Represents the Queries record for the operation: listActivities
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.crm: ListActivityLocationsHeaders
Represents the Headers record for the operation: listActivityLocations
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListActivityLocationsQueries
Represents the Queries record for the operation: listActivityLocations
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.crm: ListActivityRecipientListsHeaders
Represents the Headers record for the operation: listActivityRecipientLists
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListActivityRecipientListsQueries
Represents the Queries record for the operation: listActivityRecipientLists
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.crm: ListActivityStatusesHeaders
Represents the Headers record for the operation: listActivityStatuses
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListActivityStatusesQueries
Represents the Queries record for the operation: listActivityStatuses
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.crm: ListActivitySubjectsHeaders
Represents the Headers record for the operation: listActivitySubjects
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListActivitySubjectsQueries
Represents the Queries record for the operation: listActivitySubjects
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.crm: ListActivityTypesHeaders
Represents the Headers record for the operation: listActivityTypes
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListActivityTypesQueries
Represents the Queries record for the operation: listActivityTypes
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.crm: ListCampaignResponseTypeHeaders
Represents the Headers record for the operation: listCampaignResponseType
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListCampaignResponseTypeQueries
Represents the Queries record for the operation: listCampaignResponseType
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.crm: ListCampaignsHeaders
Represents the Headers record for the operation: listCampaigns
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListCampaignsQueries
Represents the Queries record for the operation: listCampaigns
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.crm: ListPartnersSetupsHeaders
Represents the Headers record for the operation: listPartnersSetups
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListPartnersSetupsQueries
Represents the Queries record for the operation: listPartnersSetups
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.crm: ListSalesOpportunitiesHeaders
Represents the Headers record for the operation: listSalesOpportunities
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListSalesOpportunitiesQueries
Represents the Queries record for the operation: listSalesOpportunities
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.crm: ListSalesOpportunityCompetitorsSetupHeaders
Represents the Headers record for the operation: listSalesOpportunityCompetitorsSetup
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListSalesOpportunityCompetitorsSetupQueries
Represents the Queries record for the operation: listSalesOpportunityCompetitorsSetup
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.crm: ListSalesOpportunityInterestsSetupHeaders
Represents the Headers record for the operation: listSalesOpportunityInterestsSetup
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListSalesOpportunityInterestsSetupQueries
Represents the Queries record for the operation: listSalesOpportunityInterestsSetup
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.crm: ListSalesOpportunityReasonsSetupHeaders
Represents the Headers record for the operation: listSalesOpportunityReasonsSetup
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListSalesOpportunityReasonsSetupQueries
Represents the Queries record for the operation: listSalesOpportunityReasonsSetup
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.crm: ListSalesOpportunitySourcesSetupHeaders
Represents the Headers record for the operation: listSalesOpportunitySourcesSetup
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListSalesOpportunitySourcesSetupQueries
Represents the Queries record for the operation: listSalesOpportunitySourcesSetup
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.crm: ListSalesStagesHeaders
Represents the Headers record for the operation: listSalesStages
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListSalesStagesQueries
Represents the Queries record for the operation: listSalesStages
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.crm: ListTargetGroupsHeaders
Represents the Headers record for the operation: listTargetGroups
Fields
- prefer? string - Service Layer paging control, e.g. 'odata.maxpagesize=100'. Use 'odata.maxpagesize=0' to disable server paging
sap.businessone.crm: ListTargetGroupsQueries
Represents the Queries record for the operation: listTargetGroups
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.crm: PartnersSetup
The PartnersSetup entity of the SAP Business One Service Layer
Fields
- defaultRelationship? Signed32 - Default relationship field
- relatedBP? string - Related business partner field
- details? string - Details field
- partnerID? Signed32 - Partner ID field
- name? string - Name field
sap.businessone.crm: PartnersSetupParams
The PartnersSetupParams complex type of the SAP Business One Service Layer
Fields
- defaultRelationship? Signed32 - Default relationship field
- relatedBP? string - Related business partner field
- details? string - Details field
- partnerID? Signed32 - Partner ID field
- name? string - Name field
sap.businessone.crm: PartnersSetupsCollectionResponse
A paged collection of PartnersSetups entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? PartnersSetup[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: SalesOpportunities
The SalesOpportunities entity of the SAP Business One Service Layer
Fields
- SequentialNo? Signed32 - Sequential number field
- CardCode? string - Card code field
- SalesPerson? Signed32 - Sales person field
- ContactPerson? Signed32 - Contact person field
- Source? Signed32 - Source field
- InterestField1? Signed32 - Interest field1 field
- InterestField2? Signed32 - Interest field2 field
- InterestField3? Signed32 - Interest field3 field
- InterestLevel? Signed32 - Interest level field
- StartDate? string - Start date field
- PredictedClosingDate? string - Predicted closing date field
- MaxLocalTotal? decimal - Max local total field
- MaxSystemTotal? decimal - Max system total field
- WeightedSumLC? decimal - Weighted sum local currency field
- WeightedSumSC? decimal - Weighted sum system currency field
- GrossProfit? decimal - Gross profit field
- GrossProfitTotalLocal? decimal - Gross profit total local field
- GrossProfitTotalSystem? decimal - Gross profit total system field
- Remarks? string - Remarks field
- Status? BoSoOsStatus - OData EnumType 'BoSoOsStatus'. Serialised by the Service Layer as the member name
- ReasonForClosing? Signed32 - Reason for closing field
- TotalAmountLocal? decimal - Total amount local field
- TotalAmounSystem? decimal - Total amoun system field
- ClosingGrossProfitLocal? decimal - Closing gross profit local field
- ClosingGrossProfitSystem? decimal - Closing gross profit system field
- ClosingPercentage? decimal - Closing percentage field
- CurrentStageNo? Signed32 - Current stage number field
- CurrentStageNumber? Signed32 - Current stage number field
- OpportunityName? string - Opportunity name field
- Industry? Signed32 - Industry field
- LinkedDocumentType? string - Linked document type field
- DataOwnershipfield? Signed32 - Data ownershipfield field
- StatusRemarks? string - Status remarks field
- ProjectCode? string - Project code field
- BPChanelName? string - Business partner chanel name field
- UserSignature? Signed32 - User signature field
- CustomerName? string - Customer name field
- DocumentCheckbox? string - Document checkbox field
- LinkedDocumentNumber? Signed32 - Linked document number field
- Territory? Signed32 - Territory field
- ClosingDate? string - Closing date field
- BPChannelContact? Signed32 - Business partner channel contact field
- BPChanelCode? string - Business partner chanel code field
- ClosingType? BoSoClosedInTypes - OData EnumType 'BoSoClosedInTypes'. Serialised by the Service Layer as the member name
- AttachmentEntry? Signed32 - Attachment entry field
- OpportunityType? OpportunityTypeEnum - OData EnumType 'OpportunityTypeEnum'. Serialised by the Service Layer as the member name
- UpdateDate? string - Update date field
- UpdateTime? string - Update time field
- SalesOpportunitiesLines? SalesOpportunitiesLine[] - Sales opportunities lines field
- SalesOpportunitiesCompetition? SalesOpportunitiesCompetitionItem[] - Sales opportunities competition field
- SalesOpportunitiesPartners? SalesOpportunitiesPartner[] - Sales opportunities partners field
- SalesOpportunitiesInterests? SalesOpportunitiesInterest[] - Sales opportunities interests field
- SalesOpportunitiesReasons? SalesOpportunitiesReason[] - Sales opportunities reasons field
- SalesOpportunitySourceSetup? SalesOpportunitySourceSetup - The
SalesOpportunitySourceSetupentity of the SAP Business One Service Layer
- SalesOpportunityInterestSetup? SalesOpportunityInterestSetup - The
SalesOpportunityInterestSetupentity of the SAP Business One Service Layer
- SalesOpportunityReasonSetup? SalesOpportunityReasonSetup - The
SalesOpportunityReasonSetupentity of the SAP Business One Service Layer
- SalesStage? SalesStage - The
SalesStageentity of the SAP Business One Service Layer
sap.businessone.crm: SalesOpportunitiesCollectionResponse
A paged collection of SalesOpportunities entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunities[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: SalesOpportunitiesCompetitionItem
The SalesOpportunitiesCompetitionItem complex type of the SAP Business One Service Layer
Fields
- RowNo? Signed32 - Row number field
- Competition? Signed32 - Competition field
- Details? string - Details field
- SequenceNo? Signed32 - Sequence number field
- WonOrLost? string - Won or lost field
- ThreatLevel? ThreatLevelEnum - OData EnumType 'ThreatLevelEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: SalesOpportunitiesInterest
The SalesOpportunitiesInterest complex type of the SAP Business One Service Layer
Fields
- RowNo? Signed32 - Row number field
- SequenceNo? Signed32 - Sequence number field
- PrimaryInterest? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- InterestId? Signed32 - Interest ID field
sap.businessone.crm: SalesOpportunitiesLine
The SalesOpportunitiesLine complex type of the SAP Business One Service Layer
Fields
- LineNum? Signed32 - Line number field
- SalesPerson? Signed32 - Sales person field
- StartDate? string - Start date field
- ClosingDate? string - Closing date field
- StageKey? Signed32 - Stage key field
- PercentageRate? decimal - Percentage rate field
- MaxLocalTotal? decimal - Max local total field
- MaxSystemTotal? decimal - Max system total field
- Remarks? string - Remarks field
- Contact? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- Status? BoSoStatus - OData EnumType 'BoSoStatus'. Serialised by the Service Layer as the member name
- WeightedAmountLocal? decimal - Weighted amount local field
- WeightedAmountSystem? decimal - Weighted amount system field
- DocumentNumber? Signed32 - Document number field
- DocumentType? BoAPARDocumentTypes - OData EnumType 'BoAPARDocumentTypes'. Serialised by the Service Layer as the member name
- DocumentCheckbox? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- ContactPerson? Signed32 - Contact person field
- BPChanelName? string - Business partner chanel name field
- BPChanelCode? string - Business partner chanel code field
- SequenceNo? Signed32 - Sequence number field
- DataOwnershipfield? Signed32 - Data ownershipfield field
- BPChannelContact? Signed32 - Business partner channel contact field
sap.businessone.crm: SalesOpportunitiesPartner
The SalesOpportunitiesPartner complex type of the SAP Business One Service Layer
Fields
- RowNo? Signed32 - Row number field
- Partners? Signed32 - Partners field
- Details? string - Details field
- RelationshipCode? Signed32 - Relationship code field
- SequenceNo? Signed32 - Sequence number field
sap.businessone.crm: SalesOpportunitiesReason
The SalesOpportunitiesReason complex type of the SAP Business One Service Layer
Fields
- RowNo? Signed32 - Row number field
- SequenceNo? Signed32 - Sequence number field
- Reason? Signed32 - Reason field
sap.businessone.crm: SalesOpportunityCompetitorSetup
The SalesOpportunityCompetitorSetup entity of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- details? string - Details field
- threatLevel? ThreatLevelEnum - Threat level field
- name? string - Name field
sap.businessone.crm: SalesOpportunityCompetitorSetupParams
The SalesOpportunityCompetitorSetupParams complex type of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- threatLevel? ThreatLevelEnum - Threat level field
- name? string - Name field
sap.businessone.crm: SalesOpportunityCompetitorsSetupCollectionResponse
A paged collection of SalesOpportunityCompetitorsSetup entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunityCompetitorSetup[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: SalesOpportunityInterestSetup
The SalesOpportunityInterestSetup entity of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- description? string - Description field
- salesOpportunities? SalesOpportunities[] - Sales opportunities field
- sort? Signed32 - Sort field
sap.businessone.crm: SalesOpportunityInterestSetupParams
The SalesOpportunityInterestSetupParams complex type of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- description? string - Description field
sap.businessone.crm: SalesOpportunityInterestsSetupCollectionResponse
A paged collection of SalesOpportunityInterestsSetup entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunityInterestSetup[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: SalesOpportunityReasonSetup
The SalesOpportunityReasonSetup entity of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- description? string - Description field
- salesOpportunities? SalesOpportunities[] - Sales opportunities field
- sort? Signed32 - Sort field
sap.businessone.crm: SalesOpportunityReasonSetupParams
The SalesOpportunityReasonSetupParams complex type of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- description? string - Description field
sap.businessone.crm: SalesOpportunityReasonsSetupCollectionResponse
A paged collection of SalesOpportunityReasonsSetup entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunityReasonSetup[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: SalesOpportunitySourceSetup
The SalesOpportunitySourceSetup entity of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- description? string - Description field
- salesOpportunities? SalesOpportunities[] - Sales opportunities field
- sort? Signed32 - Sort field
sap.businessone.crm: SalesOpportunitySourceSetupParams
The SalesOpportunitySourceSetupParams complex type of the SAP Business One Service Layer
Fields
- sequenceNo? Signed32 - Sequence number field
- description? string - Description field
sap.businessone.crm: SalesOpportunitySourcesSetupCollectionResponse
A paged collection of SalesOpportunitySourcesSetup entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesOpportunitySourceSetup[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: SalesStage
The SalesStage entity of the SAP Business One Service Layer
Fields
- SequenceNo? Signed32 - Sequence number field
- Name? string - Name field
- Stageno? Signed32 - Stageno field
- ClosingPercentage? decimal - Closing percentage field
- Cancelled? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- IsSales? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- IsPurchasing? BoYesNoEnum - OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
- SalesOpportunities? SalesOpportunities[] - Sales opportunities field
sap.businessone.crm: SalesStagesCollectionResponse
A paged collection of SalesStages entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? SalesStage[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: TargetGroup
The TargetGroup entity of the SAP Business One Service Layer
Fields
- targetGroupType? TargetGroupTypeEnum - Target group type field
- targetGroupsDetails? TargetGroupsDetail[] - Target groups details field
- targetGroupCode? string - Target group code field
- campaigns? Campaign[] - Campaigns field
- targetGroupName? string - Target group name field
sap.businessone.crm: TargetGroupParams
The TargetGroupParams complex type of the SAP Business One Service Layer
Fields
- targetGroupCode? string - Target group code field
- targetGroupName? string - Target group name field
sap.businessone.crm: TargetGroupsCollectionResponse
A paged collection of TargetGroups entities returned by the SAP Business One Service Layer
Fields
- odataMetadata? string - Odata metadata field
- value? TargetGroup[] - Value field
- odataNextLink? string - Odata next link field
sap.businessone.crm: TargetGroupsDetail
The TargetGroupsDetail complex type of the SAP Business One Service Layer
Fields
- building? string - Building field
- telephone? string - Telephone field
- address? string - Address field
- position? string - Position field
- zipCode? string - Zip code field
- groupCode? string - Group code field
- title? string - Title field
- city? string - City field
- eMail? string - E mail field
- county? string - County field
- contactPerson? string - Contact person field
- mobilePhone? string - Mobile phone field
- activeStatus? TargetGroupsDetailStatusEnum - Active status field
- industry? string - Industry field
- state? string - State field
- targetGroupCode? string - Target group code field
- street? string - Street field
- block? string - Block field
- country? string - Country field
- fax? string - Fax field
- businessPartnerCode? string - Business partner code field
- businessPartnerName? string - Business partner name field
Union types
sap.businessone.crm: CampaignTypeEnum
CampaignTypeEnum
OData EnumType 'CampaignTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoYesNoEnum
BoYesNoEnum
OData EnumType 'BoYesNoEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: TargetGroupsDetailStatusEnum
TargetGroupsDetailStatusEnum
OData EnumType 'TargetGroupsDetailStatusEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: ActivityRecipientObjTypeEnum
ActivityRecipientObjTypeEnum
OData EnumType 'ActivityRecipientObjTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: CampaignAssignToEnum
CampaignAssignToEnum
OData EnumType 'CampaignAssignToEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoMsgPriorities
BoMsgPriorities
OData EnumType 'BoMsgPriorities'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoSoOsStatus
BoSoOsStatus
OData EnumType 'BoSoOsStatus'. Serialised by the Service Layer as the member name
sap.businessone.crm: RecipientTypeEnum
RecipientTypeEnum
OData EnumType 'RecipientTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: EndTypeEnum
EndTypeEnum
OData EnumType 'EndTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoSoStatus
BoSoStatus
OData EnumType 'BoSoStatus'. Serialised by the Service Layer as the member name
sap.businessone.crm: LinkedDocTypeEnum
LinkedDocTypeEnum
OData EnumType 'LinkedDocTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: OpportunityTypeEnum
OpportunityTypeEnum
OData EnumType 'OpportunityTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoAddressType
BoAddressType
OData EnumType 'BoAddressType'. Serialised by the Service Layer as the member name
sap.businessone.crm: RecurrenceSequenceEnum
RecurrenceSequenceEnum
OData EnumType 'RecurrenceSequenceEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: ThreatLevelEnum
ThreatLevelEnum
OData EnumType 'ThreatLevelEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: RepeatOptionEnum
RepeatOptionEnum
OData EnumType 'RepeatOptionEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoAPARDocumentTypes
BoAPARDocumentTypes
OData EnumType 'BoAPARDocumentTypes'. Serialised by the Service Layer as the member name
sap.businessone.crm: RecurrencePatternEnum
RecurrencePatternEnum
OData EnumType 'RecurrencePatternEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: CampaignItemTypeEnum
CampaignItemTypeEnum
OData EnumType 'CampaignItemTypeEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoActivities
BoActivities
OData EnumType 'BoActivities'. Serialised by the Service Layer as the member name
sap.businessone.crm: RecurrenceDayOfWeekEnum
RecurrenceDayOfWeekEnum
OData EnumType 'RecurrenceDayOfWeekEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: CampaignStatusEnum
CampaignStatusEnum
OData EnumType 'CampaignStatusEnum'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoDurations
BoDurations
OData EnumType 'BoDurations'. Serialised by the Service Layer as the member name
sap.businessone.crm: BoSoClosedInTypes
BoSoClosedInTypes
OData EnumType 'BoSoClosedInTypes'. Serialised by the Service Layer as the member name
sap.businessone.crm: TargetGroupTypeEnum
TargetGroupTypeEnum
OData EnumType 'TargetGroupTypeEnum'. Serialised by the Service Layer as the member name
Import
import ballerinax/sap.businessone.crm;Metadata
Released date: 6 days ago
Version: 1.0.2
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.13.0
GraalVM compatible: Yes
Pull count
Total: 2
Current verison: 2
Weekly downloads
Keywords
Name/SAP Business One CRM
Area/ERP & Business Operations
Vendor/SAP
Cost/Paid
Type/Connector
SAP Business One
CRM
ERP
Contributors