Actions
The ballerinax/sap.businessone.financials package exposes the following clients:
Available clients:
| Client | Purpose |
|---|---|
Client | Manages SAP Business One financial accounting objects — chart of accounts & journal entries, budgets & scenarios, cost accounting dimensions, profit centers & distribution rules, currencies, and sales/withholding tax setup — over the session-authenticated Service Layer (OData V3). |
Client
The Client provides access to the financial accounting objects exposed by the SAP Business One Service Layer — the chart of accounts, journal entries, budgets and budget scenarios, cost accounting dimensions, profit centers, distribution rules, currencies, and the full sales tax and withholding tax setup.
Configuration
SessionConfig
SAP Business One Service Layer session credentials, passed as the first argument to the client initializer.
| Field | Type | Default | Description |
|---|---|---|---|
companyDb | string | Required | The SAP Business One company database to log in to |
username | string | Required | The Service Layer user name |
password | string | Required | The Service Layer user password |
ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with the Service Layer HTTP endpoint. Passed as the optional second argument to the client initializer.
| Field | Type | Default | Description |
|---|---|---|---|
httpVersion | http:HttpVersion | http:HTTP_2_0 | The HTTP version understood by the client |
http1Settings | http:ClientHttp1Settings | | Configurations related to HTTP/1.x protocol |
http2Settings | http:ClientHttp2Settings | | Configurations related to HTTP/2 protocol |
timeout | decimal | 30 | The maximum time to wait (in seconds) for a response before closing the connection |
forwarded | string | "disable" | The choice of setting forwarded/x-forwarded header |
followRedirects | http:FollowRedirects | Optional | Configurations associated with redirection |
poolConfig | http:PoolConfiguration | Optional | Configurations associated with request pooling |
cache | http:CacheConfig | | HTTP caching related configurations |
compression | http:Compression | http:COMPRESSION_AUTO | Specifies the way of handling compression (accept-encoding) header |
circuitBreaker | http:CircuitBreakerConfig | Optional | Configurations associated with the behaviour of the Circuit Breaker |
retryConfig | http:RetryConfig | Optional | Configurations associated with retrying |
cookieConfig | http:CookieConfig | Optional | Configurations associated with cookies |
responseLimits | http:ResponseLimitConfigs | | Configurations associated with inbound response size limits |
secureSocket | http:ClientSecureSocket | Optional | SSL/TLS-related options |
proxy | http:ProxyConfig | Optional | Proxy server related options |
socketConfig | http:ClientSocketConfig | | Provides settings related to client socket configuration |
validation | boolean | true | Enables the inbound payload validation functionality provided by the constraint package |
laxDataBinding | boolean | true | Enables relaxed data binding on the client side, treating nil values and absent fields as optional |
The client also accepts a serviceUrl string parameter — the base URL of the target Service Layer instance — which defaults to https://localhost:50000/b1s/v1.
Initializing the client
import ballerinax/sap.businessone;
import ballerinax/sap.businessone.financials;
businessone:SessionConfig session = {
companyDb: "SBODemoUS",
username: "manager",
password: "<password>"
};
financials:Client client = check new (session, serviceUrl = "https://<host>:50000/b1s/v1");
Operations
AccrualTypes
listAccrualTypes
Queries the AccrualTypes collection and returns a page of accrual type entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListAccrualTypesHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListAccrualTypesQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: AccrualTypesCollectionResponse|error
Sample code:
AccrualTypesCollectionResponse result = check client->listAccrualTypes();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#AccrualTypes",
"value": [
{
"Code": "ACR01",
"Name": "Monthly Accrual",
"PostingAccount": "_SYS00000000001",
"CalculationAccount": "_SYS00000000002",
"InterimAccount": "_SYS00000000003"
}
],
"odata.nextLink": "AccrualTypes?$skip=20"
}
createAccrualTypes
Creates a new AccrualType entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | AccrualType | Yes | The accrual type entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: AccrualType|error
Sample code:
AccrualType result = check client->createAccrualTypes({Code: "ACR01", Name: "Monthly Accrual"});
Sample response:
{
"Code": "ACR01",
"Name": "Monthly Accrual",
"PostingAccount": "_SYS00000000001",
"CalculationAccount": "_SYS00000000002",
"InterimAccount": "_SYS00000000003"
}
getAccrualTypes
Retrieves a single AccrualType entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAccrualTypesQueries | No | OData query options $expand and $select |
Returns: AccrualType|error
Sample code:
AccrualType result = check client->getAccrualTypes("ACR01");
Sample response:
{
"Code": "ACR01",
"Name": "Monthly Accrual",
"PostingAccount": "_SYS00000000001",
"CalculationAccount": "_SYS00000000002",
"InterimAccount": "_SYS00000000003"
}
deleteAccrualTypes
Deletes an AccrualType entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteAccrualTypes("ACR01");
updateAccrualTypes
Partially updates an AccrualType entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | AccrualType | Yes | The accrual type fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateAccrualTypes("ACR01", {Name: "Updated Accrual"});
accrualTypesServiceGetAccrualTypeList
Invokes the AccrualTypesService_GetAccrualTypeList service action to retrieve the accrual type list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_1|error
Sample code:
inline_response_200_1 result = check client->accrualTypesServiceGetAccrualTypeList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.AccrualTypeParams)",
"value": [
{
"Code": "ACR01"
}
]
}
Budgets
listBudgets
Queries the Budgets collection and returns a page of budget entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListBudgetsHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListBudgetsQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: BudgetsCollectionResponse|error
Sample code:
BudgetsCollectionResponse result = check client->listBudgets();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Budgets",
"value": [
{
"Numerator": 1,
"AccountCode": "_SYS00000000001",
"BudgetScenario": 1,
"StartofFiscalYear": "2026-01-01",
"TotalAnnualBudgetDebitLoc": 120000.0
}
],
"odata.nextLink": "Budgets?$skip=20"
}
createBudgets
Creates a new Budget entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | Budget | Yes | The budget entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: Budget|error
Sample code:
Budget result = check client->createBudgets({AccountCode: "_SYS00000000001", BudgetScenario: 1});
Sample response:
{
"Numerator": 1,
"AccountCode": "_SYS00000000001",
"BudgetScenario": 1,
"StartofFiscalYear": "2026-01-01",
"TotalAnnualBudgetDebitLoc": 120000.0,
"BudgetLines": []
}
getBudgets
Retrieves a single Budget entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetBudgetsQueries | No | OData query options $expand and $select |
Returns: Budget|error
Sample code:
Budget result = check client->getBudgets(1);
Sample response:
{
"Numerator": 1,
"AccountCode": "_SYS00000000001",
"BudgetScenario": 1,
"StartofFiscalYear": "2026-01-01",
"TotalAnnualBudgetDebitLoc": 120000.0
}
deleteBudgets
Deletes a Budget entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteBudgets(1);
updateBudgets
Partially updates a Budget entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
payload | Budget | Yes | The budget fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateBudgets(1, {TotalAnnualBudgetDebitLoc: 150000.0});
DeductibleTaxes
deductibleTaxServiceGetList
Invokes the DeductibleTaxService_GetList service action to retrieve the deductible tax list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_6|error
Sample code:
inline_response_200_6 result = check client->deductibleTaxServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.DeductibleTaxParams)",
"value": [
{
"Code": "DT01",
"Name": "Deductible Input Tax"
}
]
}
listDeductibleTaxes
Queries the DeductibleTaxes collection and returns a page of deductible tax entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListDeductibleTaxesHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListDeductibleTaxesQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: DeductibleTaxesCollectionResponse|error
Sample code:
DeductibleTaxesCollectionResponse result = check client->listDeductibleTaxes();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#DeductibleTaxes",
"value": [
{
"Code": "DT01",
"Name": "Deductible Input Tax",
"Category": "bovcInputTax",
"Inactive": "tNO",
"DeductibleTaxRate": 50.0
}
],
"odata.nextLink": "DeductibleTaxes?$skip=20"
}
createDeductibleTaxes
Creates a new DeductibleTax entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | DeductibleTax | Yes | The deductible tax entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: DeductibleTax|error
Sample code:
DeductibleTax result = check client->createDeductibleTaxes({code: "DT01", name: "Deductible Input Tax", deductibleTaxRate: 50.0});
Sample response:
{
"Code": "DT01",
"Name": "Deductible Input Tax",
"Category": "bovcInputTax",
"Inactive": "tNO",
"DeductibleTaxRate": 50.0
}
getDeductibleTaxes
Retrieves a single DeductibleTax entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetDeductibleTaxesQueries | No | OData query options $expand and $select |
Returns: DeductibleTax|error
Sample code:
DeductibleTax result = check client->getDeductibleTaxes("DT01");
Sample response:
{
"Code": "DT01",
"Name": "Deductible Input Tax",
"Category": "bovcInputTax",
"Inactive": "tNO",
"DeductibleTaxRate": 50.0
}
deleteDeductibleTaxes
Deletes a DeductibleTax entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteDeductibleTaxes("DT01");
updateDeductibleTaxes
Partially updates a DeductibleTax entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | DeductibleTax | Yes | The deductible tax fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateDeductibleTaxes("DT01", {deductibleTaxRate: 60.0});
DeductionTaxSubGroups
listDeductionTaxSubGroups
Queries the DeductionTaxSubGroups collection and returns a page of deduction tax sub group entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListDeductionTaxSubGroupsHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListDeductionTaxSubGroupsQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: DeductionTaxSubGroupsCollectionResponse|error
Sample code:
DeductionTaxSubGroupsCollectionResponse result = check client->listDeductionTaxSubGroups();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#DeductionTaxSubGroups",
"value": [
{
"GroupCode": "SG01",
"GroupName": "Professional Services",
"DeductionTaxGroups": []
}
],
"odata.nextLink": "DeductionTaxSubGroups?$skip=20"
}
createDeductionTaxSubGroups
Creates a new DeductionTaxSubGroup entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | DeductionTaxSubGroup | Yes | The deduction tax sub group entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: DeductionTaxSubGroup|error
Sample code:
DeductionTaxSubGroup result = check client->createDeductionTaxSubGroups({groupCode: "SG01", groupName: "Professional Services"});
Sample response:
{
"GroupCode": "SG01",
"GroupName": "Professional Services",
"DeductionTaxGroups": []
}
getDeductionTaxSubGroups
Retrieves a single DeductionTaxSubGroup entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
groupCode | string | Yes | Key property 'GroupCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetDeductionTaxSubGroupsQueries | No | OData query options $expand and $select |
Returns: DeductionTaxSubGroup|error
Sample code:
DeductionTaxSubGroup result = check client->getDeductionTaxSubGroups("SG01");
Sample response:
{
"GroupCode": "SG01",
"GroupName": "Professional Services",
"DeductionTaxGroups": []
}
deleteDeductionTaxSubGroups
Deletes a DeductionTaxSubGroup entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
groupCode | string | Yes | Key property 'GroupCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteDeductionTaxSubGroups("SG01");
updateDeductionTaxSubGroups
Partially updates a DeductionTaxSubGroup entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
groupCode | string | Yes | Key property 'GroupCode' (Edm.String) |
payload | DeductionTaxSubGroup | Yes | The deduction tax sub group fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateDeductionTaxSubGroups("SG01", {groupName: "Updated Sub Group"});
deductionTaxSubGroupsServiceGetDeductionTaxSubGroupList
Invokes the DeductionTaxSubGroupsService_GetDeductionTaxSubGroupList service action to retrieve the deduction tax sub group list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_7|error
Sample code:
inline_response_200_7 result = check client->deductionTaxSubGroupsServiceGetDeductionTaxSubGroupList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.DeductionTaxSubGroupParams)",
"value": [
{
"GroupCode": "SG01",
"GroupName": "Professional Services"
}
]
}
FinancialYears
listFinancialYears
Queries the FinancialYears collection and returns a page of financial year entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListFinancialYearsHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListFinancialYearsQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: FinancialYearsCollectionResponse|error
Sample code:
FinancialYearsCollectionResponse result = check client->listFinancialYears();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#FinancialYears",
"value": [
{
"AbsEntry": 1,
"Code": "FY2026",
"Description": "Financial Year 2026-27",
"StartDate": "2026-04-01",
"EndDate": "2027-03-31",
"AssessYear": "2027"
}
],
"odata.nextLink": "FinancialYears?$skip=20"
}
createFinancialYears
Creates a new FinancialYear entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | FinancialYear | Yes | The financial year entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: FinancialYear|error
Sample code:
FinancialYear result = check client->createFinancialYears({code: "FY2026", startDate: "2026-04-01", endDate: "2027-03-31"});
Sample response:
{
"AbsEntry": 1,
"Code": "FY2026",
"Description": "Financial Year 2026-27",
"StartDate": "2026-04-01",
"EndDate": "2027-03-31",
"AssessYear": "2027"
}
getFinancialYears
Retrieves a single FinancialYear entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetFinancialYearsQueries | No | OData query options $expand and $select |
Returns: FinancialYear|error
Sample code:
FinancialYear result = check client->getFinancialYears(1);
Sample response:
{
"AbsEntry": 1,
"Code": "FY2026",
"Description": "Financial Year 2026-27",
"StartDate": "2026-04-01",
"EndDate": "2027-03-31",
"AssessYear": "2027"
}
deleteFinancialYears
Deletes a FinancialYear entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteFinancialYears(1);
updateFinancialYears
Partially updates a FinancialYear entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
payload | FinancialYear | Yes | The financial year fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateFinancialYears(1, {description: "Updated Financial Year"});
financialYearsServiceGetFinancialYearList
Invokes the FinancialYearsService_GetFinancialYearList service action to retrieve the financial year list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_11|error
Sample code:
inline_response_200_11 result = check client->financialYearsServiceGetFinancialYearList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.FinancialYearParams)",
"value": [
{
"AbsEntry": 1,
"Code": "FY2026",
"Description": "Financial Year 2026-27"
}
]
}
PostingTemplates
listPostingTemplates
Queries the PostingTemplates collection and returns a page of posting template entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListPostingTemplatesHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListPostingTemplatesQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: PostingTemplatesCollectionResponse|error
Sample code:
PostingTemplatesCollectionResponse result = check client->listPostingTemplates();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#PostingTemplates",
"value": [
{
"Code": "PT01",
"Description": "Monthly rent allocation",
"AutomaticVAT": "tNO",
"StampTax": "tNO",
"ManageWTax": "tNO",
"DeferredTax": "tNO",
"PostingTemplatesLineCollection": []
}
],
"odata.nextLink": "PostingTemplates?$skip=20"
}
createPostingTemplates
Creates a new PostingTemplates entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | PostingTemplates | Yes | The posting template entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: PostingTemplates|error
Sample code:
PostingTemplates result = check client->createPostingTemplates({code: "PT01", description: "Monthly rent allocation"});
Sample response:
{
"Code": "PT01",
"Description": "Monthly rent allocation",
"AutomaticVAT": "tNO",
"StampTax": "tNO",
"ManageWTax": "tNO",
"DeferredTax": "tNO",
"PostingTemplatesLineCollection": []
}
getPostingTemplates
Retrieves a single PostingTemplates entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetPostingTemplatesQueries | No | OData query options $expand and $select |
Returns: PostingTemplates|error
Sample code:
PostingTemplates result = check client->getPostingTemplates("PT01");
Sample response:
{
"Code": "PT01",
"Description": "Monthly rent allocation",
"AutomaticVAT": "tNO",
"StampTax": "tNO",
"ManageWTax": "tNO",
"DeferredTax": "tNO",
"PostingTemplatesLineCollection": []
}
deletePostingTemplates
Deletes a PostingTemplates entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deletePostingTemplates("PT01");
updatePostingTemplates
Partially updates a PostingTemplates entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | PostingTemplates | Yes | The posting template fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updatePostingTemplates("PT01", {description: "Updated template"});
postingTemplatesServiceGetList
Invokes the PostingTemplatesService_GetList service action to retrieve the posting template list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_15|error
Sample code:
inline_response_200_15 result = check client->postingTemplatesServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.PostingTemplatesParams)",
"value": [
{
"Code": "PT01",
"Description": "Monthly rent allocation"
}
]
}
RecurringPostings
listRecurringPostings
Queries the RecurringPostings collection and returns a page of recurring posting entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListRecurringPostingsHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListRecurringPostingsQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: RecurringPostingsCollectionResponse|error
Sample code:
RecurringPostingsCollectionResponse result = check client->listRecurringPostings();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#RecurringPostings",
"value": [
{
"Code": "RP01",
"Instance": 1,
"Description": "Monthly rent posting",
"Frequency": "ftMonthly",
"NextExecution": "2026-08-01",
"RecurringPostingsLineCollection": []
}
],
"odata.nextLink": "RecurringPostings?$skip=20"
}
createRecurringPostings
Creates a new RecurringPostings entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | RecurringPostings | Yes | The recurring posting entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: RecurringPostings|error
Sample code:
RecurringPostings result = check client->createRecurringPostings({code: "RP01", description: "Monthly rent posting", frequency: "ftMonthly"});
Sample response:
{
"Code": "RP01",
"Instance": 1,
"Description": "Monthly rent posting",
"Frequency": "ftMonthly",
"NextExecution": "2026-08-01",
"RecurringPostingsLineCollection": []
}
getRecurringPostings
Retrieves a single RecurringPostings entity by its composite key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Composite key part 'Code' (Edm.String) |
instance | int:Signed32 | Yes | Composite key part 'Instance' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetRecurringPostingsQueries | No | OData query options $expand and $select |
Returns: RecurringPostings|error
Sample code:
RecurringPostings result = check client->getRecurringPostings("RP01", 1);
Sample response:
{
"Code": "RP01",
"Instance": 1,
"Description": "Monthly rent posting",
"Frequency": "ftMonthly",
"NextExecution": "2026-08-01",
"RecurringPostingsLineCollection": []
}
deleteRecurringPostings
Deletes a RecurringPostings entity identified by its composite key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Composite key part 'Code' (Edm.String) |
instance | int:Signed32 | Yes | Composite key part 'Instance' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteRecurringPostings("RP01", 1);
updateRecurringPostings
Partially updates a RecurringPostings entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Composite key part 'Code' (Edm.String) |
instance | int:Signed32 | Yes | Composite key part 'Instance' (Edm.Int32) |
payload | RecurringPostings | Yes | The recurring posting fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateRecurringPostings("RP01", 1, {description: "Updated recurring posting"});
recurringPostingsServiceGetList
Invokes the RecurringPostingsService_GetList service action to retrieve the recurring posting list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_17|error
Sample code:
inline_response_200_17 result = check client->recurringPostingsServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.RecurringPostingsParams)",
"value": [
{
"Code": "RP01",
"Instance": 1,
"Description": "Monthly rent posting"
}
]
}
SalesTaxAuthorities
listSalesTaxAuthorities
Queries the SalesTaxAuthorities collection and returns a page of sales tax authority entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListSalesTaxAuthoritiesHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListSalesTaxAuthoritiesQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: SalesTaxAuthoritiesCollectionResponse|error
Sample code:
SalesTaxAuthoritiesCollectionResponse result = check client->listSalesTaxAuthorities();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#SalesTaxAuthorities",
"value": [
{
"Type": 1,
"Code": "NY",
"Name": "New York State Tax",
"Rate": 8.875,
"AOrRTaxAccount": "_SYS00000000001",
"AOrPTaxAccount": "_SYS00000000002"
}
],
"odata.nextLink": "SalesTaxAuthorities?$skip=20"
}
createSalesTaxAuthorities
Creates a new SalesTaxAuthority entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | SalesTaxAuthority | Yes | The sales tax authority entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: SalesTaxAuthority|error
Sample code:
SalesTaxAuthority result = check client->createSalesTaxAuthorities({Type: 1, Code: "NY", Name: "New York State Tax", Rate: 8.875});
Sample response:
{
"Type": 1,
"Code": "NY",
"Name": "New York State Tax",
"Rate": 8.875,
"AOrRTaxAccount": "_SYS00000000001",
"AOrPTaxAccount": "_SYS00000000002"
}
getSalesTaxAuthorities
Retrieves a single SalesTaxAuthority entity by its composite key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
'type | int:Signed32 | Yes | Composite key part 'Type' (Edm.Int32) |
code | string | Yes | Composite key part 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetSalesTaxAuthoritiesQueries | No | OData query options $expand and $select |
Returns: SalesTaxAuthority|error
Sample code:
SalesTaxAuthority result = check client->getSalesTaxAuthorities(1, "NY");
Sample response:
{
"Type": 1,
"Code": "NY",
"Name": "New York State Tax",
"Rate": 8.875,
"AOrRTaxAccount": "_SYS00000000001",
"AOrPTaxAccount": "_SYS00000000002"
}
deleteSalesTaxAuthorities
Deletes a SalesTaxAuthority entity identified by its composite key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
'type | int:Signed32 | Yes | Composite key part 'Type' (Edm.Int32) |
code | string | Yes | Composite key part 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteSalesTaxAuthorities(1, "NY");
updateSalesTaxAuthorities
Partially updates a SalesTaxAuthority entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
'type | int:Signed32 | Yes | Composite key part 'Type' (Edm.Int32) |
code | string | Yes | Composite key part 'Code' (Edm.String) |
payload | SalesTaxAuthority | Yes | The sales tax authority fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateSalesTaxAuthorities(1, "NY", {Rate: 9.0});
TaxCodeDeterminations
listTaxCodeDeterminations
Queries the TaxCodeDeterminations collection and returns a page of tax code determination entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListTaxCodeDeterminationsHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListTaxCodeDeterminationsQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: TaxCodeDeterminationsCollectionResponse|error
Sample code:
TaxCodeDeterminationsCollectionResponse result = check client->listTaxCodeDeterminations();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#TaxCodeDeterminations",
"value": [
{
"DocEntry": 1,
"Description": "NY sales determination",
"Condition1": "tcdcShipToState",
"TaxCode": "NY",
"LineNumber": 1
}
],
"odata.nextLink": "TaxCodeDeterminations?$skip=20"
}
createTaxCodeDeterminations
Creates a new TaxCodeDetermination entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TaxCodeDetermination | Yes | The tax code determination entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TaxCodeDetermination|error
Sample code:
TaxCodeDetermination result = check client->createTaxCodeDeterminations({description: "NY sales determination", taxCode: "NY", condition1: "tcdcShipToState"});
Sample response:
{
"DocEntry": 1,
"Description": "NY sales determination",
"Condition1": "tcdcShipToState",
"TaxCode": "NY",
"LineNumber": 1
}
getTaxCodeDeterminations
Retrieves a single TaxCodeDetermination entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
docEntry | int:Signed32 | Yes | Key property 'DocEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTaxCodeDeterminationsQueries | No | OData query options $expand and $select |
Returns: TaxCodeDetermination|error
Sample code:
TaxCodeDetermination result = check client->getTaxCodeDeterminations(1);
Sample response:
{
"DocEntry": 1,
"Description": "NY sales determination",
"Condition1": "tcdcShipToState",
"TaxCode": "NY",
"LineNumber": 1
}
deleteTaxCodeDeterminations
Deletes a TaxCodeDetermination entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
docEntry | int:Signed32 | Yes | Key property 'DocEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTaxCodeDeterminations(1);
updateTaxCodeDeterminations
Partially updates a TaxCodeDetermination entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
docEntry | int:Signed32 | Yes | Key property 'DocEntry' (Edm.Int32) |
payload | TaxCodeDetermination | Yes | The tax code determination fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTaxCodeDeterminations(1, {description: "Updated determination"});
taxCodeDeterminationsServiceGetTaxCodeDeterminationList
Invokes the TaxCodeDeterminationsService_GetTaxCodeDeterminationList service action to retrieve the tax code determination list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_22|error
Sample code:
inline_response_200_22 result = check client->taxCodeDeterminationsServiceGetTaxCodeDeterminationList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.TaxCodeDeterminationParams)",
"value": [
{
"DocEntry": 1
}
]
}
TaxReplStateSubs
listTaxReplStateSubs
Queries the TaxReplStateSubs collection and returns a page of tax replication state substitution entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListTaxReplStateSubsHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListTaxReplStateSubsQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: TaxReplStateSubsCollectionResponse|error
Sample code:
TaxReplStateSubsCollectionResponse result = check client->listTaxReplStateSubs();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#TaxReplStateSubs",
"value": [
{
"State": "SP",
"IEST": "123456789"
}
],
"odata.nextLink": "TaxReplStateSubs?$skip=20"
}
createTaxReplStateSubs
Creates a new TaxReplStateSubData entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TaxReplStateSubData | Yes | The tax replication state substitution entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TaxReplStateSubData|error
Sample code:
TaxReplStateSubData result = check client->createTaxReplStateSubs({state: "SP", iEST: "123456789"});
Sample response:
{
"State": "SP",
"IEST": "123456789"
}
getTaxReplStateSubs
Retrieves a single TaxReplStateSubData entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
state | string | Yes | Key property 'State' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTaxReplStateSubsQueries | No | OData query options $expand and $select |
Returns: TaxReplStateSubData|error
Sample code:
TaxReplStateSubData result = check client->getTaxReplStateSubs("SP");
Sample response:
{
"State": "SP",
"IEST": "123456789"
}
deleteTaxReplStateSubs
Deletes a TaxReplStateSubData entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
state | string | Yes | Key property 'State' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTaxReplStateSubs("SP");
updateTaxReplStateSubs
Partially updates a TaxReplStateSubData entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
state | string | Yes | Key property 'State' (Edm.String) |
payload | TaxReplStateSubData | Yes | The tax replication state substitution fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTaxReplStateSubs("SP", {iEST: "987654321"});
WitholdingTaxDefinition
listWitholdingTaxDefinition
Queries the WitholdingTaxDefinition collection and returns a page of withholding tax definition (WTDCode) entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListWitholdingTaxDefinitionHeaders | No | Headers to be sent with the request (e.g. Prefer for Service Layer paging control) |
queries | ListWitholdingTaxDefinitionQueries | No | OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select |
Returns: WitholdingTaxDefinitionCollectionResponse|error
Sample code:
WitholdingTaxDefinitionCollectionResponse result = check client->listWitholdingTaxDefinition();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#WitholdingTaxDefinition",
"value": [
{
"AbsEntry": 1,
"WTaxCode": "WT01",
"WTaxName": "Withholding 5%",
"OfficialCode": "194C",
"Category": "wtcc_Payment",
"BaseType": "wtcbt_Net",
"Inactive": "tNO",
"BaseAmountPrct": 100.0
}
],
"odata.nextLink": "WitholdingTaxDefinition?$skip=20"
}
createWitholdingTaxDefinition
Creates a new WTDCode (withholding tax definition) entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WTDCode | Yes | The withholding tax definition entity to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: WTDCode|error
Sample code:
WTDCode result = check client->createWitholdingTaxDefinition({WTaxCode: "WT01", WTaxName: "Withholding 5%", OfficialCode: "194C"});
Sample response:
{
"AbsEntry": 1,
"WTaxCode": "WT01",
"WTaxName": "Withholding 5%",
"OfficialCode": "194C",
"Category": "wtcc_Payment",
"BaseType": "wtcbt_Net",
"Inactive": "tNO",
"BaseAmountPrct": 100.0
}
getWitholdingTaxDefinition
Retrieves a single WTDCode (withholding tax definition) entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWitholdingTaxDefinitionQueries | No | OData query options $expand and $select |
Returns: WTDCode|error
Sample code:
WTDCode result = check client->getWitholdingTaxDefinition(1);
Sample response:
{
"AbsEntry": 1,
"WTaxCode": "WT01",
"WTaxName": "Withholding 5%",
"OfficialCode": "194C",
"Category": "wtcc_Payment",
"BaseType": "wtcbt_Net",
"Inactive": "tNO",
"BaseAmountPrct": 100.0
}
deleteWitholdingTaxDefinition
Deletes a WTDCode (withholding tax definition) entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWitholdingTaxDefinition(1);
updateWitholdingTaxDefinition
Partially updates a WTDCode (withholding tax definition) entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
payload | WTDCode | Yes | The withholding tax definition fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWitholdingTaxDefinition(1, {WTaxName: "Updated Withholding"});
JournalEntries
listJournalEntries
Queries the JournalEntries collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListJournalEntriesHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListJournalEntriesQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: JournalEntriesCollectionResponse|error
Sample code:
JournalEntriesCollectionResponse response = check client->listJournalEntries();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#JournalEntries",
"value": [
{
"JdtNum": 1234,
"ReferenceDate": "2026-01-15",
"Memo": "Monthly accrual",
"DueDate": "2026-01-31"
}
],
"odata.nextLink": "JournalEntries?$skip=20"
}
createJournalEntries
Creates a new JournalEntry and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | JournalEntry | Yes | Request payload representing the journal entry to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: JournalEntry|error
Sample code:
JournalEntry result = check client->createJournalEntries({ReferenceDate: "2026-01-15", Memo: "Monthly accrual"});
Sample response:
{
"JdtNum": 1234,
"ReferenceDate": "2026-01-15",
"Memo": "Monthly accrual",
"DueDate": "2026-01-31",
"TaxDate": "2026-01-15"
}
getJournalEntries
Retrieves a single JournalEntry by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
jdtNum | int:Signed32 | Yes | Key property 'JdtNum' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetJournalEntriesQueries | No | OData query options such as $select and $expand |
Returns: JournalEntry|error
Sample code:
JournalEntry entry = check client->getJournalEntries(1234);
Sample response:
{
"JdtNum": 1234,
"ReferenceDate": "2026-01-15",
"Memo": "Monthly accrual",
"Number": 1234
}
deleteJournalEntries
Deletes the JournalEntry identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
jdtNum | int:Signed32 | Yes | Key property 'JdtNum' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteJournalEntries(1234);
updateJournalEntries
Partially updates a JournalEntry using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
jdtNum | int:Signed32 | Yes | Key property 'JdtNum' (Edm.Int32) |
payload | JournalEntry | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateJournalEntries(1234, {Memo: "Corrected memo"});
journalEntriesCancel
Invokes the bound action 'Cancel' on a JournalEntries entity (binding type JournalEntry) to cancel the journal entry; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
jdtNum | int:Signed32 | Yes | Key property 'JdtNum' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->journalEntriesCancel(1234);
journalEntriesServiceClose
Closes a journal entry via the JournalEntriesService_Close service action; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | JournalEntriesService_Close_body | Yes | Request payload wrapping the journal entry to close (field: journalEntry) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->journalEntriesServiceClose({journalEntry: {JdtNum: 1234}});
AccountCategory
listAccountCategory
Queries the AccountCategory collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListAccountCategoryHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListAccountCategoryQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: AccountCategoryCollectionResponse|error
Sample code:
AccountCategoryCollectionResponse response = check client->listAccountCategory();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#AccountCategory",
"value": [
{
"CategoryCode": 100,
"CategoryName": "Assets",
"CategorySource": "acsBalanceSheet"
}
]
}
createAccountCategory
Creates a new AccountCategory and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | AccountCategory | Yes | Request payload representing the account category to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: AccountCategory|error
Sample code:
AccountCategory result = check client->createAccountCategory({categoryName: "Assets"});
Sample response:
{
"CategoryCode": 100,
"CategoryName": "Assets",
"CategorySource": "acsBalanceSheet"
}
getAccountCategory
Retrieves a single AccountCategory by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
categoryCode | int:Signed32 | Yes | Key property 'CategoryCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAccountCategoryQueries | No | OData query options such as $select and $expand |
Returns: AccountCategory|error
Sample code:
AccountCategory category = check client->getAccountCategory(100);
Sample response:
{
"CategoryCode": 100,
"CategoryName": "Assets",
"CategorySource": "acsBalanceSheet"
}
deleteAccountCategory
Deletes the AccountCategory identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
categoryCode | int:Signed32 | Yes | Key property 'CategoryCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteAccountCategory(100);
updateAccountCategory
Partially updates an AccountCategory using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
categoryCode | int:Signed32 | Yes | Key property 'CategoryCode' (Edm.Int32) |
payload | AccountCategory | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateAccountCategory(100, {categoryName: "Fixed Assets"});
accountCategoryServiceGetCategoryList
Invokes the AccountCategoryService_GetCategoryList service action and returns the category list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200|error
Sample code:
inline_response_200 result = check client->accountCategoryServiceGetCategoryList();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.AccountCategoryParams)",
"value": [
{
"CategoryCode": 100,
"CategoryName": "Assets"
}
]
}
CashDiscounts
listCashDiscounts
Queries the CashDiscounts collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListCashDiscountsHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListCashDiscountsQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: CashDiscountsCollectionResponse|error
Sample code:
CashDiscountsCollectionResponse response = check client->listCashDiscounts();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CashDiscounts",
"value": [
{
"Code": "CD01",
"Name": "2% 10 Net 30",
"Tax": "tYES",
"Freight": "tNO"
}
]
}
createCashDiscounts
Creates a new CashDiscount and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | CashDiscount | Yes | Request payload representing the cash discount to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CashDiscount|error
Sample code:
CashDiscount result = check client->createCashDiscounts({code: "CD01", name: "2% 10 Net 30"});
Sample response:
{
"Code": "CD01",
"Name": "2% 10 Net 30",
"Tax": "tYES",
"ByDate": "tNO",
"Freight": "tNO"
}
getCashDiscounts
Retrieves a single CashDiscount by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetCashDiscountsQueries | No | OData query options such as $select and $expand |
Returns: CashDiscount|error
Sample code:
CashDiscount discount = check client->getCashDiscounts("CD01");
Sample response:
{
"Code": "CD01",
"Name": "2% 10 Net 30",
"Tax": "tYES"
}
deleteCashDiscounts
Deletes the CashDiscount identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteCashDiscounts("CD01");
updateCashDiscounts
Partially updates a CashDiscount using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | CashDiscount | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateCashDiscounts("CD01", {name: "2% 15 Net 30"});
cashDiscountsServiceGetCashDiscountList
Invokes the CashDiscountsService_GetCashDiscountList service action and returns the cash discount list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_2|error
Sample code:
inline_response_200_2 result = check client->cashDiscountsServiceGetCashDiscountList();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.CashDiscountParams)",
"value": [
{
"Code": "CD01",
"Name": "2% 10 Net 30"
}
]
}
DeterminationCriterias
listDeterminationCriterias
Queries the DeterminationCriterias collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListDeterminationCriteriasHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListDeterminationCriteriasQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: DeterminationCriteriasCollectionResponse|error
Sample code:
DeterminationCriteriasCollectionResponse response = check client->listDeterminationCriterias();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#DeterminationCriterias",
"value": [
{
"DmcId": 1,
"IsActive": "tYES",
"Priority": 1,
"DeterminationCriteria": "BusinessPartner"
}
]
}
createDeterminationCriterias
Creates a new DeterminationCriteria and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | DeterminationCriteria | Yes | Request payload representing the determination criteria to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: DeterminationCriteria|error
Sample code:
DeterminationCriteria result = check client->createDeterminationCriterias({determinationCriteria: "BusinessPartner", priority: 1});
Sample response:
{
"DmcId": 1,
"IsActive": "tYES",
"Priority": 1,
"DeterminationCriteria": "BusinessPartner"
}
getDeterminationCriterias
Retrieves a single DeterminationCriteria by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
dmcId | int:Signed32 | Yes | Key property 'DmcId' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetDeterminationCriteriasQueries | No | OData query options such as $select and $expand |
Returns: DeterminationCriteria|error
Sample code:
DeterminationCriteria criteria = check client->getDeterminationCriterias(1);
Sample response:
{
"DmcId": 1,
"IsActive": "tYES",
"Priority": 1
}
deleteDeterminationCriterias
Deletes the DeterminationCriteria identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
dmcId | int:Signed32 | Yes | Key property 'DmcId' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteDeterminationCriterias(1);
updateDeterminationCriterias
Partially updates a DeterminationCriteria using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
dmcId | int:Signed32 | Yes | Key property 'DmcId' (Edm.Int32) |
payload | DeterminationCriteria | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateDeterminationCriterias(1, {priority: 2});
determinationCriteriasServiceGetList
Invokes the DeterminationCriteriasService_GetList service action and returns the determination criteria list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_8|error
Sample code:
inline_response_200_8 result = check client->determinationCriteriasServiceGetList();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.DeterminationCriteriaParams)",
"value": [
{
"DmcId": 1
}
]
}
GLAccountAdvancedRules
listGLAccountAdvancedRules
Queries the GLAccountAdvancedRules collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListGLAccountAdvancedRulesHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListGLAccountAdvancedRulesQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: GLAccountAdvancedRulesCollectionResponse|error
Sample code:
GLAccountAdvancedRulesCollectionResponse response = check client->listGLAccountAdvancedRules();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#GLAccountAdvancedRules",
"value": [
{
"AbsoluteEntry": 1,
"PurchaseAcct": "510000",
"CostAccount": "520000",
"ReturningAccount": "410001"
}
]
}
createGLAccountAdvancedRules
Creates a new GLAccountAdvancedRule and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | GLAccountAdvancedRule | Yes | Request payload representing the G/L account advanced rule to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: GLAccountAdvancedRule|error
Sample code:
GLAccountAdvancedRule result = check client->createGLAccountAdvancedRules({purchaseAcct: "510000", costAccount: "520000"});
Sample response:
{
"AbsoluteEntry": 1,
"PurchaseAcct": "510000",
"CostAccount": "520000"
}
getGLAccountAdvancedRules
Retrieves a single GLAccountAdvancedRule by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absoluteEntry | int:Signed32 | Yes | Key property 'AbsoluteEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetGLAccountAdvancedRulesQueries | No | OData query options such as $select and $expand |
Returns: GLAccountAdvancedRule|error
Sample code:
GLAccountAdvancedRule rule = check client->getGLAccountAdvancedRules(1);
Sample response:
{
"AbsoluteEntry": 1,
"PurchaseAcct": "510000",
"ReturningAccount": "410001"
}
deleteGLAccountAdvancedRules
Deletes the GLAccountAdvancedRule identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absoluteEntry | int:Signed32 | Yes | Key property 'AbsoluteEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteGLAccountAdvancedRules(1);
updateGLAccountAdvancedRules
Partially updates a GLAccountAdvancedRule using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absoluteEntry | int:Signed32 | Yes | Key property 'AbsoluteEntry' (Edm.Int32) |
payload | GLAccountAdvancedRule | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateGLAccountAdvancedRules(1, {costAccount: "520100"});
gLAccountAdvancedRulesServiceGetList
Invokes the GLAccountAdvancedRulesService_GetList service action and returns the G/L account advanced rule list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_12|error
Sample code:
inline_response_200_12 result = check client->gLAccountAdvancedRulesServiceGetList();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.GLAccountAdvancedRuleParams)",
"value": [
{
"FederalTaxID": "123456789",
"ItemCode": "A00001",
"Warehouse": "01"
}
]
}
ProfitCenters
listProfitCenters
Queries the ProfitCenters collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListProfitCentersHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListProfitCentersQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: ProfitCentersCollectionResponse|error
Sample code:
ProfitCentersCollectionResponse response = check client->listProfitCenters();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ProfitCenters",
"value": [
{
"CenterCode": "PC001",
"CenterName": "Sales Department",
"InWhichDimension": 1,
"Active": "tYES"
}
]
}
createProfitCenters
Creates a new ProfitCenter and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | ProfitCenter | Yes | Request payload representing the profit center to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: ProfitCenter|error
Sample code:
ProfitCenter result = check client->createProfitCenters({CenterCode: "PC001", CenterName: "Sales Department"});
Sample response:
{
"CenterCode": "PC001",
"CenterName": "Sales Department",
"InWhichDimension": 1,
"Active": "tYES",
"EffectiveFrom": "2026-01-01"
}
getProfitCenters
Retrieves a single ProfitCenter by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
centerCode | string | Yes | Key property 'CenterCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetProfitCentersQueries | No | OData query options such as $select and $expand |
Returns: ProfitCenter|error
Sample code:
ProfitCenter center = check client->getProfitCenters("PC001");
Sample response:
{
"CenterCode": "PC001",
"CenterName": "Sales Department",
"Active": "tYES"
}
deleteProfitCenters
Deletes the ProfitCenter identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
centerCode | string | Yes | Key property 'CenterCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteProfitCenters("PC001");
updateProfitCenters
Partially updates a ProfitCenter using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
centerCode | string | Yes | Key property 'CenterCode' (Edm.String) |
payload | ProfitCenter | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateProfitCenters("PC001", {CenterName: "Sales and Marketing"});
profitCentersServiceGetProfitCenterList
Invokes the ProfitCentersService_GetProfitCenterList service action and returns the profit center list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_16|error
Sample code:
inline_response_200_16 result = check client->profitCentersServiceGetProfitCenterList();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.ProfitCenterParams)",
"value": [
{
"CenterCode": "PC001",
"CenterName": "Sales Department"
}
]
}
TaxInvoiceReport
listTaxInvoiceReport
Queries the TaxInvoiceReport collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListTaxInvoiceReportHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListTaxInvoiceReportQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: TaxInvoiceReportCollectionResponse|error
Sample code:
TaxInvoiceReportCollectionResponse response = check client->listTaxInvoiceReport();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#TaxInvoiceReport",
"value": [
{
"TaxInvoiceReportNumber": "TIR-001",
"Date": "2026-01-31",
"NTSApproval": "Approved",
"BaseAmount": 10000.00
}
]
}
createTaxInvoiceReport
Creates a new TaxInvoiceReport and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TaxInvoiceReport | Yes | Request payload representing the tax invoice report to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TaxInvoiceReport|error
Sample code:
TaxInvoiceReport result = check client->createTaxInvoiceReport({date: "2026-01-31", businessPlace: 1});
Sample response:
{
"TaxInvoiceReportNumber": "TIR-001",
"Date": "2026-01-31",
"BusinessPlace": 1,
"BaseAmount": 10000.00
}
getTaxInvoiceReport
Retrieves a single TaxInvoiceReport by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
taxInvoiceReportNumber | string | Yes | Key property 'TaxInvoiceReportNumber' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTaxInvoiceReportQueries | No | OData query options such as $select and $expand |
Returns: TaxInvoiceReport|error
Sample code:
TaxInvoiceReport report = check client->getTaxInvoiceReport("TIR-001");
Sample response:
{
"TaxInvoiceReportNumber": "TIR-001",
"Date": "2026-01-31",
"NTSApproval": "Approved"
}
deleteTaxInvoiceReport
Deletes the TaxInvoiceReport identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
taxInvoiceReportNumber | string | Yes | Key property 'TaxInvoiceReportNumber' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTaxInvoiceReport("TIR-001");
updateTaxInvoiceReport
Partially updates a TaxInvoiceReport using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
taxInvoiceReportNumber | string | Yes | Key property 'TaxInvoiceReportNumber' (Edm.String) |
payload | TaxInvoiceReport | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTaxInvoiceReport("TIR-001", {nTSApprovalNo: "APPR-2026-01"});
taxInvoiceReportCancelTaxInvoiceReport
Invokes the bound action 'CancelTaxInvoiceReport' on a TaxInvoiceReport entity (binding type TaxInvoiceReport) to cancel the tax invoice report; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
taxInvoiceReportNumber | string | Yes | Key property 'TaxInvoiceReportNumber' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->taxInvoiceReportCancelTaxInvoiceReport("TIR-001");
AccountSegmentationCategories
listAccountSegmentationCategories
Queries the AccountSegmentationCategories collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListAccountSegmentationCategoriesHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListAccountSegmentationCategoriesQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: AccountSegmentationCategoriesCollectionResponse|error
Sample code:
AccountSegmentationCategoriesCollectionResponse response = check client->listAccountSegmentationCategories();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#AccountSegmentationCategories",
"value": [
{
"SegmentID": 1,
"Code": "100",
"Name": "Head Office",
"ShortName": "HO"
}
]
}
createAccountSegmentationCategories
Creates a new AccountSegmentationCategory and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | AccountSegmentationCategory | Yes | Request payload representing the account segmentation category to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: AccountSegmentationCategory|error
Sample code:
AccountSegmentationCategory result = check client->createAccountSegmentationCategories({SegmentID: 1, Code: "100", Name: "Head Office"});
Sample response:
{
"SegmentID": 1,
"Code": "100",
"Name": "Head Office",
"ShortName": "HO"
}
getAccountSegmentationCategories
Retrieves a single AccountSegmentationCategory by its composite key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
segmentID | int:Signed32 | Yes | Composite key part 'SegmentID' (Edm.Int32) |
code | string | Yes | Composite key part 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAccountSegmentationCategoriesQueries | No | OData query options such as $select and $expand |
Returns: AccountSegmentationCategory|error
Sample code:
AccountSegmentationCategory category = check client->getAccountSegmentationCategories(1, "100");
Sample response:
{
"SegmentID": 1,
"Code": "100",
"Name": "Head Office"
}
deleteAccountSegmentationCategories
Deletes the AccountSegmentationCategory identified by the given composite key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
segmentID | int:Signed32 | Yes | Composite key part 'SegmentID' (Edm.Int32) |
code | string | Yes | Composite key part 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteAccountSegmentationCategories(1, "100");
updateAccountSegmentationCategories
Partially updates an AccountSegmentationCategory using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
segmentID | int:Signed32 | Yes | Composite key part 'SegmentID' (Edm.Int32) |
code | string | Yes | Composite key part 'Code' (Edm.String) |
payload | AccountSegmentationCategory | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateAccountSegmentationCategories(1, "100", {Name: "Headquarters"});
ChartOfAccounts
listChartOfAccounts
Queries the ChartOfAccounts collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListChartOfAccountsHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListChartOfAccountsQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: ChartOfAccountsCollectionResponse|error
Sample code:
ChartOfAccountsCollectionResponse response = check client->listChartOfAccounts();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ChartOfAccounts",
"value": [
{
"Code": "100000",
"Name": "Cash on Hand",
"Balance": 15000.00,
"ActiveAccount": "tYES",
"AccountLevel": 3
}
]
}
createChartOfAccounts
Creates a new ChartOfAccount and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | ChartOfAccount | Yes | Request payload representing the G/L account to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: ChartOfAccount|error
Sample code:
ChartOfAccount result = check client->createChartOfAccounts({Code: "100000", Name: "Cash on Hand"});
Sample response:
{
"Code": "100000",
"Name": "Cash on Hand",
"ActiveAccount": "tYES",
"AccountLevel": 3
}
getChartOfAccounts
Retrieves a single ChartOfAccount by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetChartOfAccountsQueries | No | OData query options such as $select and $expand |
Returns: ChartOfAccount|error
Sample code:
ChartOfAccount account = check client->getChartOfAccounts("100000");
Sample response:
{
"Code": "100000",
"Name": "Cash on Hand",
"Balance": 15000.00
}
deleteChartOfAccounts
Deletes the ChartOfAccount identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteChartOfAccounts("100000");
updateChartOfAccounts
Partially updates a ChartOfAccount using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | ChartOfAccount | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateChartOfAccounts("100000", {Name: "Petty Cash"});
DeductionTaxGroups
listDeductionTaxGroups
Queries the DeductionTaxGroups collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListDeductionTaxGroupsHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListDeductionTaxGroupsQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: DeductionTaxGroupsCollectionResponse|error
Sample code:
DeductionTaxGroupsCollectionResponse response = check client->listDeductionTaxGroups();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#DeductionTaxGroups",
"value": [
{
"GroupKey": 1,
"GroupCode": "dtgcPaidServices",
"GroupName": "Paid Services",
"MaxRedin": 0.0
}
]
}
createDeductionTaxGroups
Creates a new DeductionTaxGroup and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | DeductionTaxGroup | Yes | Request payload representing the deduction tax group to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: DeductionTaxGroup|error
Sample code:
DeductionTaxGroup result = check client->createDeductionTaxGroups({GroupName: "Paid Services", GroupCode: "dtgcPaidServices"});
Sample response:
{
"GroupKey": 1,
"GroupCode": "dtgcPaidServices",
"GroupName": "Paid Services"
}
getDeductionTaxGroups
Retrieves a single DeductionTaxGroup by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
groupKey | int:Signed32 | Yes | Key property 'GroupKey' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetDeductionTaxGroupsQueries | No | OData query options such as $select and $expand |
Returns: DeductionTaxGroup|error
Sample code:
DeductionTaxGroup group = check client->getDeductionTaxGroups(1);
Sample response:
{
"GroupKey": 1,
"GroupCode": "dtgcPaidServices",
"GroupName": "Paid Services"
}
deleteDeductionTaxGroups
Deletes the DeductionTaxGroup identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
groupKey | int:Signed32 | Yes | Key property 'GroupKey' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteDeductionTaxGroups(1);
updateDeductionTaxGroups
Partially updates a DeductionTaxGroup using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
groupKey | int:Signed32 | Yes | Key property 'GroupKey' (Edm.Int32) |
payload | DeductionTaxGroup | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateDeductionTaxGroups(1, {GroupName: "Professional Services"});
SalesTaxAuthoritiesTypes
listSalesTaxAuthoritiesTypes
Queries the SalesTaxAuthoritiesTypes collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListSalesTaxAuthoritiesTypesHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListSalesTaxAuthoritiesTypesQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: SalesTaxAuthoritiesTypesCollectionResponse|error
Sample code:
SalesTaxAuthoritiesTypesCollectionResponse response = check client->listSalesTaxAuthoritiesTypes();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#SalesTaxAuthoritiesTypes",
"value": [
{
"Numerator": 1,
"Name": "State",
"VAT": "tNO",
"TaxCreditControl": "tYES"
}
]
}
createSalesTaxAuthoritiesTypes
Creates a new SalesTaxAuthoritiesType and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | SalesTaxAuthoritiesType | Yes | Request payload representing the sales tax authorities type to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: SalesTaxAuthoritiesType|error
Sample code:
SalesTaxAuthoritiesType result = check client->createSalesTaxAuthoritiesTypes({Name: "State"});
Sample response:
{
"Numerator": 1,
"Name": "State",
"VAT": "tNO"
}
getSalesTaxAuthoritiesTypes
Retrieves a single SalesTaxAuthoritiesType by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetSalesTaxAuthoritiesTypesQueries | No | OData query options such as $select and $expand |
Returns: SalesTaxAuthoritiesType|error
Sample code:
SalesTaxAuthoritiesType taxType = check client->getSalesTaxAuthoritiesTypes(1);
Sample response:
{
"Numerator": 1,
"Name": "State",
"TaxCreditControl": "tYES"
}
deleteSalesTaxAuthoritiesTypes
Deletes the SalesTaxAuthoritiesType identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteSalesTaxAuthoritiesTypes(1);
updateSalesTaxAuthoritiesTypes
Partially updates a SalesTaxAuthoritiesType using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
payload | SalesTaxAuthoritiesType | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateSalesTaxAuthoritiesTypes(1, {Name: "County"});
WTaxTypeCodes
wTaxTypeCodeServiceGetWTaxTypeCodeList
Invokes the WTaxTypeCodeService_GetWTaxTypeCodeList service action and returns the withholding tax type code list.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_27|error
Sample code:
inline_response_200_27 result = check client->wTaxTypeCodeServiceGetWTaxTypeCodeList();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.WTaxTypeCodeParams)",
"value": [
{
"Code": 1
}
]
}
listWTaxTypeCodes
Queries the WTaxTypeCodes collection and returns a page of entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListWTaxTypeCodesHeaders | No | Headers to be sent with the request (e.g. Prefer: odata.maxpagesize=100) |
queries | ListWTaxTypeCodesQueries | No | OData query options such as $filter, $select, $top, $skip, $orderby, $expand, $inlinecount |
Returns: WTaxTypeCodesCollectionResponse|error
Sample code:
WTaxTypeCodesCollectionResponse response = check client->listWTaxTypeCodes();
Sample response:
{
"odata.metadata": "https://localhost:50000/b1s/v1/$metadata#WTaxTypeCodes",
"value": [
{
"Code": 1,
"Description": "Withholding tax type 1"
}
]
}
createWTaxTypeCodes
Creates a new WTaxTypeCode and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WTaxTypeCode | Yes | Request payload representing the withholding tax type code to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: WTaxTypeCode|error
Sample code:
WTaxTypeCode result = check client->createWTaxTypeCodes({code: 1, description: "Withholding tax type 1"});
Sample response:
{
"Code": 1,
"Description": "Withholding tax type 1"
}
getWTaxTypeCodes
Retrieves a single WTaxTypeCode by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | int:Signed32 | Yes | Key property 'Code' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWTaxTypeCodesQueries | No | OData query options such as $select and $expand |
Returns: WTaxTypeCode|error
Sample code:
WTaxTypeCode taxTypeCode = check client->getWTaxTypeCodes(1);
Sample response:
{
"Code": 1,
"Description": "Withholding tax type 1"
}
deleteWTaxTypeCodes
Deletes the WTaxTypeCode identified by the given key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | int:Signed32 | Yes | Key property 'Code' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWTaxTypeCodes(1);
updateWTaxTypeCodes
Partially updates a WTaxTypeCode using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | int:Signed32 | Yes | Key property 'Code' (Edm.Int32) |
payload | WTaxTypeCode | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWTaxTypeCodes(1, {description: "Updated withholding tax type"});
AccountSegmentations
listAccountSegmentations
Queries the AccountSegmentations collection and returns a page of account segmentation entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListAccountSegmentationsHeaders | No | Headers to be sent with the request |
queries | ListAccountSegmentationsQueries | No | Queries to be sent with the request |
Returns: AccountSegmentationsCollectionResponse|error
Sample code:
AccountSegmentationsCollectionResponse response = check client->listAccountSegmentations();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#AccountSegmentations",
"value": [
{
"Numerator": 1,
"Name": "Natural Account",
"Size": 4,
"Type": "ast_Numeric"
}
],
"odata.nextLink": "AccountSegmentations?$skip=20"
}
createAccountSegmentations
Creates a new AccountSegmentation entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | AccountSegmentation | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: AccountSegmentation|error
Sample code:
AccountSegmentation result = check client->createAccountSegmentations({Name: "Region", Size: 3, Type: "ast_Alphanumeric"});
Sample response:
{
"Numerator": 2,
"Name": "Region",
"Size": 3,
"Type": "ast_Alphanumeric"
}
getAccountSegmentations
Retrieves a single AccountSegmentation entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetAccountSegmentationsQueries | No | Queries to be sent with the request |
Returns: AccountSegmentation|error
Sample code:
AccountSegmentation result = check client->getAccountSegmentations(1);
Sample response:
{
"Numerator": 1,
"Name": "Natural Account",
"Size": 4,
"Type": "ast_Numeric"
}
deleteAccountSegmentations
Deletes an AccountSegmentation entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteAccountSegmentations(2);
updateAccountSegmentations
Partially updates an AccountSegmentation entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
payload | AccountSegmentation | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateAccountSegmentations(1, {Name: "Natural Account - Updated"});
BudgetDistributions
listBudgetDistributions
Queries the BudgetDistributions collection and returns a page of budget distribution entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListBudgetDistributionsHeaders | No | Headers to be sent with the request |
queries | ListBudgetDistributionsQueries | No | Queries to be sent with the request |
Returns: BudgetDistributionsCollectionResponse|error
Sample code:
BudgetDistributionsCollectionResponse response = check client->listBudgetDistributions();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#BudgetDistributions",
"value": [
{
"DivisionCode": 1,
"Description": "Equal Distribution",
"BudgetAmount": 120000.0,
"January": 10000.0,
"February": 10000.0,
"March": 10000.0
}
],
"odata.nextLink": "BudgetDistributions?$skip=20"
}
createBudgetDistributions
Creates a new BudgetDistribution entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | BudgetDistribution | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: BudgetDistribution|error
Sample code:
BudgetDistribution result = check client->createBudgetDistributions({Description: "Ascending Order", BudgetAmount: 120000.0});
Sample response:
{
"DivisionCode": 3,
"Description": "Ascending Order",
"BudgetAmount": 120000.0,
"January": 5000.0,
"February": 7000.0,
"March": 9000.0
}
getBudgetDistributions
Retrieves a single BudgetDistribution entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
divisionCode | int:Signed32 | Yes | Key property 'DivisionCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetBudgetDistributionsQueries | No | Queries to be sent with the request |
Returns: BudgetDistribution|error
Sample code:
BudgetDistribution result = check client->getBudgetDistributions(1);
Sample response:
{
"DivisionCode": 1,
"Description": "Equal Distribution",
"BudgetAmount": 120000.0,
"January": 10000.0,
"February": 10000.0,
"March": 10000.0
}
deleteBudgetDistributions
Deletes a BudgetDistribution entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
divisionCode | int:Signed32 | Yes | Key property 'DivisionCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteBudgetDistributions(3);
updateBudgetDistributions
Partially updates a BudgetDistribution entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
divisionCode | int:Signed32 | Yes | Key property 'DivisionCode' (Edm.Int32) |
payload | BudgetDistribution | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateBudgetDistributions(1, {Description: "Updated Distribution"});
CashFlowLineItems
listCashFlowLineItems
Queries the CashFlowLineItems collection and returns a page of cash flow line item entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListCashFlowLineItemsHeaders | No | Headers to be sent with the request |
queries | ListCashFlowLineItemsQueries | No | Queries to be sent with the request |
Returns: CashFlowLineItemsCollectionResponse|error
Sample code:
CashFlowLineItemsCollectionResponse response = check client->listCashFlowLineItems();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#CashFlowLineItems",
"value": [
{
"LineItemID": 1,
"LineItemName": "Operating Activities",
"Level": 1,
"ParentArticle": 0,
"Drawer": 1,
"ActiveLineItem": "tYES"
}
],
"odata.nextLink": "CashFlowLineItems?$skip=20"
}
createCashFlowLineItems
Creates a new CashFlowLineItem entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | CashFlowLineItem | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CashFlowLineItem|error
Sample code:
CashFlowLineItem result = check client->createCashFlowLineItems({lineItemName: "Financing Activities", level: 1});
Sample response:
{
"LineItemID": 5,
"LineItemName": "Financing Activities",
"Level": 1,
"ParentArticle": 0,
"Drawer": 1,
"ActiveLineItem": "tYES"
}
getCashFlowLineItems
Retrieves a single CashFlowLineItem entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
lineItemID | int:Signed32 | Yes | Key property 'LineItemID' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetCashFlowLineItemsQueries | No | Queries to be sent with the request |
Returns: CashFlowLineItem|error
Sample code:
CashFlowLineItem result = check client->getCashFlowLineItems(1);
Sample response:
{
"LineItemID": 1,
"LineItemName": "Operating Activities",
"Level": 1,
"ParentArticle": 0,
"Drawer": 1,
"ActiveLineItem": "tYES"
}
deleteCashFlowLineItems
Deletes a CashFlowLineItem entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
lineItemID | int:Signed32 | Yes | Key property 'LineItemID' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteCashFlowLineItems(5);
updateCashFlowLineItems
Partially updates a CashFlowLineItem entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
lineItemID | int:Signed32 | Yes | Key property 'LineItemID' (Edm.Int32) |
payload | CashFlowLineItem | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateCashFlowLineItems(1, {lineItemName: "Operating Activities - Updated"});
cashFlowLineItemsServiceGetCashFlowLineItemList
Invokes the CashFlowLineItemsService_GetCashFlowLineItemList operation and returns the list of cash flow line items.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_3|error
Sample code:
inline_response_200_3 result = check client->cashFlowLineItemsServiceGetCashFlowLineItemList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.CashFlowLineItemParams)",
"value": [
{
"LineItemID": 1,
"LineItemName": "Operating Activities"
}
]
}
ClosingDateProcedure
listClosingDateProcedure
Queries the ClosingDateProcedure collection and returns a page of closing date procedure entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListClosingDateProcedureHeaders | No | Headers to be sent with the request |
queries | ListClosingDateProcedureQueries | No | Queries to be sent with the request |
Returns: ClosingDateProcedureCollectionResponse|error
Sample code:
ClosingDateProcedureCollectionResponse response = check client->listClosingDateProcedure();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#ClosingDateProcedure",
"value": [
{
"ClosingDateNum": 1,
"ClosingDateCode": "CD01",
"BaselineDate": "bocpdbld_PostingDate",
"DueMonth": "bocpddm_MonthEnd",
"ExtraMonth": 1,
"ExtraDay": 15
}
],
"odata.nextLink": "ClosingDateProcedure?$skip=20"
}
createClosingDateProcedure
Creates a new ClosingDateProcedure entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | ClosingDateProcedure | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: ClosingDateProcedure|error
Sample code:
ClosingDateProcedure result = check client->createClosingDateProcedure({ClosingDateCode: "CD02", BaselineDate: "bocpdbld_PostingDate", DueMonth: "bocpddm_MonthEnd"});
Sample response:
{
"ClosingDateNum": 2,
"ClosingDateCode": "CD02",
"BaselineDate": "bocpdbld_PostingDate",
"DueMonth": "bocpddm_MonthEnd",
"ExtraMonth": 0,
"ExtraDay": 0
}
getClosingDateProcedure
Retrieves a single ClosingDateProcedure entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
closingDateNum | int:Signed32 | Yes | Key property 'ClosingDateNum' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetClosingDateProcedureQueries | No | Queries to be sent with the request |
Returns: ClosingDateProcedure|error
Sample code:
ClosingDateProcedure result = check client->getClosingDateProcedure(1);
Sample response:
{
"ClosingDateNum": 1,
"ClosingDateCode": "CD01",
"BaselineDate": "bocpdbld_PostingDate",
"DueMonth": "bocpddm_MonthEnd",
"ExtraMonth": 1,
"ExtraDay": 15
}
deleteClosingDateProcedure
Deletes a ClosingDateProcedure entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
closingDateNum | int:Signed32 | Yes | Key property 'ClosingDateNum' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteClosingDateProcedure(2);
updateClosingDateProcedure
Partially updates a ClosingDateProcedure entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
closingDateNum | int:Signed32 | Yes | Key property 'ClosingDateNum' (Edm.Int32) |
payload | ClosingDateProcedure | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateClosingDateProcedure(1, {ExtraDay: 20});
DeductionTaxHierarchies
listDeductionTaxHierarchies
Queries the DeductionTaxHierarchies collection and returns a page of deduction tax hierarchy entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListDeductionTaxHierarchiesHeaders | No | Headers to be sent with the request |
queries | ListDeductionTaxHierarchiesQueries | No | Queries to be sent with the request |
Returns: DeductionTaxHierarchiesCollectionResponse|error
Sample code:
DeductionTaxHierarchiesCollectionResponse response = check client->listDeductionTaxHierarchies();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#DeductionTaxHierarchies",
"value": [
{
"AbsEntry": 1,
"BPCode": "C20000",
"HierarchyCode": "H01",
"HierarchyName": "Standard Hierarchy",
"ValidFrom": "2026-01-01",
"ValidUntil": "2026-12-31",
"DeductionPercent": 5.0,
"MaximumTotal": 10000.0
}
],
"odata.nextLink": "DeductionTaxHierarchies?$skip=20"
}
createDeductionTaxHierarchies
Creates a new DeductionTaxHierarchy entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | DeductionTaxHierarchy | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: DeductionTaxHierarchy|error
Sample code:
DeductionTaxHierarchy result = check client->createDeductionTaxHierarchies({BPCode: "C20000", HierarchyCode: "H02", HierarchyName: "Reduced Rate", DeductionPercent: 2.5});
Sample response:
{
"AbsEntry": 2,
"BPCode": "C20000",
"HierarchyCode": "H02",
"HierarchyName": "Reduced Rate",
"DeductionPercent": 2.5,
"MaximumTotal": 0.0
}
getDeductionTaxHierarchies
Retrieves a single DeductionTaxHierarchy entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetDeductionTaxHierarchiesQueries | No | Queries to be sent with the request |
Returns: DeductionTaxHierarchy|error
Sample code:
DeductionTaxHierarchy result = check client->getDeductionTaxHierarchies(1);
Sample response:
{
"AbsEntry": 1,
"BPCode": "C20000",
"HierarchyCode": "H01",
"HierarchyName": "Standard Hierarchy",
"ValidFrom": "2026-01-01",
"ValidUntil": "2026-12-31",
"DeductionPercent": 5.0,
"MaximumTotal": 10000.0
}
deleteDeductionTaxHierarchies
Deletes a DeductionTaxHierarchy entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteDeductionTaxHierarchies(2);
updateDeductionTaxHierarchies
Partially updates a DeductionTaxHierarchy entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
payload | DeductionTaxHierarchy | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateDeductionTaxHierarchies(1, {DeductionPercent: 7.5});
Dimensions
listDimensions
Queries the Dimensions collection and returns a page of cost accounting dimension entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListDimensionsHeaders | No | Headers to be sent with the request |
queries | ListDimensionsQueries | No | Queries to be sent with the request |
Returns: DimensionsCollectionResponse|error
Sample code:
DimensionsCollectionResponse response = check client->listDimensions();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Dimensions",
"value": [
{
"DimensionCode": 1,
"DimensionName": "Department",
"IsActive": "tYES",
"DimensionDescription": "Departmental cost dimension"
}
],
"odata.nextLink": "Dimensions?$skip=20"
}
createDimensions
Creates a new Dimension entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | Dimension | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: Dimension|error
Sample code:
Dimension result = check client->createDimensions({DimensionName: "Project", IsActive: "tYES"});
Sample response:
{
"DimensionCode": 2,
"DimensionName": "Project",
"IsActive": "tYES",
"DimensionDescription": ""
}
getDimensions
Retrieves a single Dimension entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
dimensionCode | int:Signed32 | Yes | Key property 'DimensionCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetDimensionsQueries | No | Queries to be sent with the request |
Returns: Dimension|error
Sample code:
Dimension result = check client->getDimensions(1);
Sample response:
{
"DimensionCode": 1,
"DimensionName": "Department",
"IsActive": "tYES",
"DimensionDescription": "Departmental cost dimension"
}
deleteDimensions
Deletes a Dimension entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
dimensionCode | int:Signed32 | Yes | Key property 'DimensionCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteDimensions(2);
updateDimensions
Partially updates a Dimension entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
dimensionCode | int:Signed32 | Yes | Key property 'DimensionCode' (Edm.Int32) |
payload | Dimension | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateDimensions(1, {DimensionDescription: "Updated description"});
dimensionsServiceGetDimensionList
Invokes the DimensionsService_GetDimensionList operation and returns the list of dimensions.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_9|error
Sample code:
inline_response_200_9 result = check client->dimensionsServiceGetDimensionList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.DimensionParams)",
"value": [
{
"DimensionCode": 1,
"DimensionName": "Department"
}
]
}
JournalEntryDocumentTypes
journalEntryDocumentTypeServiceGetList
Invokes the JournalEntryDocumentTypeService_GetList operation and returns the list of journal entry document types.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_13|error
Sample code:
inline_response_200_13 result = check client->journalEntryDocumentTypeServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.JournalEntryDocumentTypeParams)",
"value": [
{
"JournalEntryType": "30",
"ShortName": "JE",
"DocTypeDescription": "Journal Entry"
}
]
}
listJournalEntryDocumentTypes
Queries the JournalEntryDocumentTypes collection and returns a page of journal entry document type entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListJournalEntryDocumentTypesHeaders | No | Headers to be sent with the request |
queries | ListJournalEntryDocumentTypesQueries | No | Queries to be sent with the request |
Returns: JournalEntryDocumentTypesCollectionResponse|error
Sample code:
JournalEntryDocumentTypesCollectionResponse response = check client->listJournalEntryDocumentTypes();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#JournalEntryDocumentTypes",
"value": [
{
"JournalEntryType": "30",
"ShortName": "JE",
"DocTypeDescription": "Journal Entry"
}
],
"odata.nextLink": "JournalEntryDocumentTypes?$skip=20"
}
createJournalEntryDocumentTypes
Creates a new JournalEntryDocumentType entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | JournalEntryDocumentType | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: JournalEntryDocumentType|error
Sample code:
JournalEntryDocumentType result = check client->createJournalEntryDocumentTypes({journalEntryType: "40", shortName: "AP", docTypeDescription: "AP Invoice"});
Sample response:
{
"JournalEntryType": "40",
"ShortName": "AP",
"DocTypeDescription": "AP Invoice"
}
getJournalEntryDocumentTypes
Retrieves a single JournalEntryDocumentType entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
journalEntryType | string | Yes | Key property 'JournalEntryType' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetJournalEntryDocumentTypesQueries | No | Queries to be sent with the request |
Returns: JournalEntryDocumentType|error
Sample code:
JournalEntryDocumentType result = check client->getJournalEntryDocumentTypes("30");
Sample response:
{
"JournalEntryType": "30",
"ShortName": "JE",
"DocTypeDescription": "Journal Entry"
}
deleteJournalEntryDocumentTypes
Deletes a JournalEntryDocumentType entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
journalEntryType | string | Yes | Key property 'JournalEntryType' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteJournalEntryDocumentTypes("40");
updateJournalEntryDocumentTypes
Partially updates a JournalEntryDocumentType entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
journalEntryType | string | Yes | Key property 'JournalEntryType' (Edm.String) |
payload | JournalEntryDocumentType | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateJournalEntryDocumentTypes("30", {docTypeDescription: "Manual Journal Entry"});
RecurringTransactionTemplates
listRecurringTransactionTemplates
Queries the RecurringTransactionTemplates collection and returns a page of recurring transaction template entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListRecurringTransactionTemplatesHeaders | No | Headers to be sent with the request |
queries | ListRecurringTransactionTemplatesQueries | No | Queries to be sent with the request |
Returns: RecurringTransactionTemplatesCollectionResponse|error
Sample code:
RecurringTransactionTemplatesCollectionResponse response = check client->listRecurringTransactionTemplates();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#RecurringTransactionTemplates",
"value": [
{
"AbsoluteEntry": 1,
"TemplateCode": "RT01",
"TemplateDescription": "Monthly rent posting",
"DocumentObjectType": "dc_ArInvoice",
"Frequency": "rttf_Monthly",
"Remind": "rttr_On1",
"CardCode": "C20000",
"StartDate": "2026-01-01",
"EndDate": "2026-12-31",
"DraftEntry": 12,
"PriceUpdate": "tNO"
}
],
"odata.nextLink": "RecurringTransactionTemplates?$skip=20"
}
createRecurringTransactionTemplates
Creates a new RecurringTransactionTemplate entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | RecurringTransactionTemplate | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: RecurringTransactionTemplate|error
Sample code:
RecurringTransactionTemplate result = check client->createRecurringTransactionTemplates({templateCode: "RT02", templateDescription: "Quarterly service invoice", frequency: "rttf_Quarterly", cardCode: "C20000"});
Sample response:
{
"AbsoluteEntry": 2,
"TemplateCode": "RT02",
"TemplateDescription": "Quarterly service invoice",
"Frequency": "rttf_Quarterly",
"CardCode": "C20000",
"PriceUpdate": "tNO"
}
getRecurringTransactionTemplates
Retrieves a single RecurringTransactionTemplate entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absoluteEntry | int:Signed32 | Yes | Key property 'AbsoluteEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetRecurringTransactionTemplatesQueries | No | Queries to be sent with the request |
Returns: RecurringTransactionTemplate|error
Sample code:
RecurringTransactionTemplate result = check client->getRecurringTransactionTemplates(1);
Sample response:
{
"AbsoluteEntry": 1,
"TemplateCode": "RT01",
"TemplateDescription": "Monthly rent posting",
"Frequency": "rttf_Monthly",
"CardCode": "C20000",
"StartDate": "2026-01-01",
"EndDate": "2026-12-31",
"PriceUpdate": "tNO"
}
deleteRecurringTransactionTemplates
Deletes a RecurringTransactionTemplate entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absoluteEntry | int:Signed32 | Yes | Key property 'AbsoluteEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteRecurringTransactionTemplates(2);
updateRecurringTransactionTemplates
Partially updates a RecurringTransactionTemplate entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absoluteEntry | int:Signed32 | Yes | Key property 'AbsoluteEntry' (Edm.Int32) |
payload | RecurringTransactionTemplate | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateRecurringTransactionTemplates(1, {templateDescription: "Monthly rent posting - updated"});
recurringTransactionTemplatesServiceGetList
Invokes the RecurringTransactionTemplatesService_GetList operation and returns the list of recurring transaction templates.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_20|error
Sample code:
inline_response_200_20 result = check client->recurringTransactionTemplatesServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.RecurringTransactionTemplateParams)",
"value": [
{
"AbsoluteEntry": 1
}
]
}
SalesTaxCodes
listSalesTaxCodes
Queries the SalesTaxCodes collection and returns a page of sales tax code entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListSalesTaxCodesHeaders | No | Headers to be sent with the request |
queries | ListSalesTaxCodesQueries | No | Queries to be sent with the request |
Returns: SalesTaxCodesCollectionResponse|error
Sample code:
SalesTaxCodesCollectionResponse response = check client->listSalesTaxCodes();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#SalesTaxCodes",
"value": [
{
"Code": "NY",
"Name": "New York Tax",
"Rate": 8.875,
"ValidForAR": "tYES",
"ValidForAP": "tYES",
"Freight": "tNO",
"Inactive": "tNO"
}
],
"odata.nextLink": "SalesTaxCodes?$skip=20"
}
createSalesTaxCodes
Creates a new SalesTaxCode entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | SalesTaxCode | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: SalesTaxCode|error
Sample code:
SalesTaxCode result = check client->createSalesTaxCodes({Code: "CA", Name: "California Tax", Rate: 7.25});
Sample response:
{
"Code": "CA",
"Name": "California Tax",
"Rate": 7.25,
"ValidForAR": "tYES",
"ValidForAP": "tYES",
"Inactive": "tNO"
}
getSalesTaxCodes
Retrieves a single SalesTaxCode entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetSalesTaxCodesQueries | No | Queries to be sent with the request |
Returns: SalesTaxCode|error
Sample code:
SalesTaxCode result = check client->getSalesTaxCodes("NY");
Sample response:
{
"Code": "NY",
"Name": "New York Tax",
"Rate": 8.875,
"ValidForAR": "tYES",
"ValidForAP": "tYES",
"Freight": "tNO",
"Inactive": "tNO"
}
deleteSalesTaxCodes
Deletes a SalesTaxCode entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteSalesTaxCodes("CA");
updateSalesTaxCodes
Partially updates a SalesTaxCode entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | SalesTaxCode | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateSalesTaxCodes("NY", {Rate: 9.0});
TaxWebSites
listTaxWebSites
Queries the TaxWebSites collection and returns a page of tax web site entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListTaxWebSitesHeaders | No | Headers to be sent with the request |
queries | ListTaxWebSitesQueries | No | Queries to be sent with the request |
Returns: TaxWebSitesCollectionResponse|error
Sample code:
TaxWebSitesCollectionResponse response = check client->listTaxWebSites();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#TaxWebSites",
"value": [
{
"AbsEntry": 1,
"WebSiteName": "National Tax Portal",
"WebSiteURL": "https://tax.example.gov",
"Description": "Primary tax reporting site"
}
],
"odata.nextLink": "TaxWebSites?$skip=20"
}
createTaxWebSites
Creates a new TaxWebSite entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TaxWebSite | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TaxWebSite|error
Sample code:
TaxWebSite result = check client->createTaxWebSites({webSiteName: "Regional Tax Portal", webSiteURL: "https://regional.tax.example.gov"});
Sample response:
{
"AbsEntry": 2,
"WebSiteName": "Regional Tax Portal",
"WebSiteURL": "https://regional.tax.example.gov",
"Description": ""
}
getTaxWebSites
Retrieves a single TaxWebSite entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTaxWebSitesQueries | No | Queries to be sent with the request |
Returns: TaxWebSite|error
Sample code:
TaxWebSite result = check client->getTaxWebSites(1);
Sample response:
{
"AbsEntry": 1,
"WebSiteName": "National Tax Portal",
"WebSiteURL": "https://tax.example.gov",
"Description": "Primary tax reporting site"
}
deleteTaxWebSites
Deletes a TaxWebSite entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTaxWebSites(2);
updateTaxWebSites
Partially updates a TaxWebSite entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
payload | TaxWebSite | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTaxWebSites(1, {description: "Updated description"});
taxWebSitesSetAsDefault
Invokes the bound action 'SetAsDefault' on a TaxWebSite entity to mark it as the default web site; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->taxWebSitesSetAsDefault(1);
taxWebSitesServiceGetDefaultWebSite
Invokes the TaxWebSitesService_GetDefaultWebSite operation and returns the default tax web site.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TaxWebSiteParams|error
Sample code:
TaxWebSiteParams result = check client->taxWebSitesServiceGetDefaultWebSite();
Sample response:
{
"AbsEntry": 1,
"WebSiteName": "National Tax Portal"
}
taxWebSitesServiceGetTaxWebSiteList
Invokes the TaxWebSitesService_GetTaxWebSiteList operation and returns the list of tax web sites.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_25|error
Sample code:
inline_response_200_25 result = check client->taxWebSitesServiceGetTaxWebSiteList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.TaxWebSiteParams)",
"value": [
{
"AbsEntry": 1,
"WebSiteName": "National Tax Portal"
}
]
}
TransactionCodes
listTransactionCodes
Queries the TransactionCodes collection and returns a page of transaction code entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListTransactionCodesHeaders | No | Headers to be sent with the request |
queries | ListTransactionCodesQueries | No | Queries to be sent with the request |
Returns: TransactionCodesCollectionResponse|error
Sample code:
TransactionCodesCollectionResponse response = check client->listTransactionCodes();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#TransactionCodes",
"value": [
{
"Code": "TC01",
"Description": "Month-end adjustment"
}
],
"odata.nextLink": "TransactionCodes?$skip=20"
}
createTransactionCodes
Creates a new TransactionCode entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TransactionCode | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TransactionCode|error
Sample code:
TransactionCode result = check client->createTransactionCodes({code: "TC02", description: "Accrual posting"});
Sample response:
{
"Code": "TC02",
"Description": "Accrual posting"
}
getTransactionCodes
Retrieves a single TransactionCode entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTransactionCodesQueries | No | Queries to be sent with the request |
Returns: TransactionCode|error
Sample code:
TransactionCode result = check client->getTransactionCodes("TC01");
Sample response:
{
"Code": "TC01",
"Description": "Month-end adjustment"
}
deleteTransactionCodes
Deletes a TransactionCode entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTransactionCodes("TC02");
updateTransactionCodes
Partially updates a TransactionCode entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | TransactionCode | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTransactionCodes("TC01", {description: "Month-end adjustment - updated"});
transactionCodesServiceGetList
Invokes the TransactionCodesService_GetList operation and returns the list of transaction codes.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_26|error
Sample code:
inline_response_200_26 result = check client->transactionCodesServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.TransactionCodeParams)",
"value": [
{
"Code": "TC01",
"Description": "Month-end adjustment"
}
]
}
WithholdingTaxCodes
listWithholdingTaxCodes
Queries the WithholdingTaxCodes collection and returns a page of withholding tax code entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListWithholdingTaxCodesHeaders | No | Headers to be sent with the request |
queries | ListWithholdingTaxCodesQueries | No | Queries to be sent with the request |
Returns: WithholdingTaxCodesCollectionResponse|error
Sample code:
WithholdingTaxCodesCollectionResponse response = check client->listWithholdingTaxCodes();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#WithholdingTaxCodes",
"value": [
{
"WTCode": "W01",
"WTName": "Standard Withholding",
"Category": "wtcc_Payment",
"BaseType": "wtcbt_Net",
"BaseAmount": 100.0,
"Account": "_SYS00000000101",
"WithholdingType": "wt_IncomeTaxWithholding",
"RoundingType": "rt_NoRounding"
}
],
"odata.nextLink": "WithholdingTaxCodes?$skip=20"
}
createWithholdingTaxCodes
Creates a new WithholdingTaxCode entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | WithholdingTaxCode | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: WithholdingTaxCode|error
Sample code:
WithholdingTaxCode result = check client->createWithholdingTaxCodes({WTCode: "W02", WTName: "Invoice Withholding", Category: "wtcc_Invoice", BaseType: "wtcbt_Gross"});
Sample response:
{
"WTCode": "W02",
"WTName": "Invoice Withholding",
"Category": "wtcc_Invoice",
"BaseType": "wtcbt_Gross",
"BaseAmount": 100.0
}
getWithholdingTaxCodes
Retrieves a single WithholdingTaxCode entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
wTCode | string | Yes | Key property 'WTCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetWithholdingTaxCodesQueries | No | Queries to be sent with the request |
Returns: WithholdingTaxCode|error
Sample code:
WithholdingTaxCode result = check client->getWithholdingTaxCodes("W01");
Sample response:
{
"WTCode": "W01",
"WTName": "Standard Withholding",
"Category": "wtcc_Payment",
"BaseType": "wtcbt_Net",
"BaseAmount": 100.0,
"Account": "_SYS00000000101",
"WithholdingType": "wt_IncomeTaxWithholding",
"RoundingType": "rt_NoRounding"
}
deleteWithholdingTaxCodes
Deletes a WithholdingTaxCode entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
wTCode | string | Yes | Key property 'WTCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteWithholdingTaxCodes("W02");
updateWithholdingTaxCodes
Partially updates a WithholdingTaxCode entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
wTCode | string | Yes | Key property 'WTCode' (Edm.String) |
payload | WithholdingTaxCode | Yes | Request payload |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateWithholdingTaxCodes("W01", {WTName: "Standard Withholding - Updated"});
BudgetScenarios
listBudgetScenarios
Queries the BudgetScenarios collection and returns a page of budget scenario entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListBudgetScenariosHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListBudgetScenariosQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: BudgetScenariosCollectionResponse|error
Sample code:
BudgetScenariosCollectionResponse result = check client->listBudgetScenarios();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#BudgetScenarios",
"value": [
{
"Numerator": 1,
"Name": "Main Budget",
"InitialRatioPercentage": 100.0,
"StartofFiscalYear": "2026-01-01",
"BasicBudget": 1
}
]
}
createBudgetScenarios
Creates a new BudgetScenario entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | BudgetScenario | Yes | Request payload describing the budget scenario to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: BudgetScenario|error
Sample code:
BudgetScenario result = check client->createBudgetScenarios({Name: "Optimistic Budget", InitialRatioPercentage: 110.0});
Sample response:
{
"Numerator": 2,
"Name": "Optimistic Budget",
"InitialRatioPercentage": 110.0,
"StartofFiscalYear": "2026-01-01"
}
getBudgetScenarios
Retrieves a single BudgetScenario by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetBudgetScenariosQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: BudgetScenario|error
Sample code:
BudgetScenario result = check client->getBudgetScenarios(1);
Sample response:
{
"Numerator": 1,
"Name": "Main Budget",
"InitialRatioPercentage": 100.0,
"StartofFiscalYear": "2026-01-01",
"BasicBudget": 1
}
deleteBudgetScenarios
Deletes a BudgetScenario identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteBudgetScenarios(2);
updateBudgetScenarios
Partially updates a BudgetScenario using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
numerator | int:Signed32 | Yes | Key property 'Numerator' (Edm.Int32) |
payload | BudgetScenario | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateBudgetScenarios(1, {Name: "Revised Budget"});
CostCenterTypes
listCostCenterTypes
Queries the CostCenterTypes collection and returns a page of cost center type entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListCostCenterTypesHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListCostCenterTypesQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: CostCenterTypesCollectionResponse|error
Sample code:
CostCenterTypesCollectionResponse result = check client->listCostCenterTypes();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#CostCenterTypes",
"value": [
{
"CostCenterTypeCode": "T1",
"CostCenterTypeName": "Production"
}
]
}
createCostCenterTypes
Creates a new CostCenterType entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | CostCenterType | Yes | Request payload describing the cost center type to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CostCenterType|error
Sample code:
CostCenterType result = check client->createCostCenterTypes({CostCenterTypeCode: "T2", CostCenterTypeName: "Sales"});
Sample response:
{
"CostCenterTypeCode": "T2",
"CostCenterTypeName": "Sales"
}
getCostCenterTypes
Retrieves a single CostCenterType by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
costCenterTypeCode | string | Yes | Key property 'CostCenterTypeCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetCostCenterTypesQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: CostCenterType|error
Sample code:
CostCenterType result = check client->getCostCenterTypes("T1");
Sample response:
{
"CostCenterTypeCode": "T1",
"CostCenterTypeName": "Production"
}
deleteCostCenterTypes
Deletes a CostCenterType identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
costCenterTypeCode | string | Yes | Key property 'CostCenterTypeCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteCostCenterTypes("T2");
updateCostCenterTypes
Partially updates a CostCenterType using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
costCenterTypeCode | string | Yes | Key property 'CostCenterTypeCode' (Edm.String) |
payload | CostCenterType | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateCostCenterTypes("T1", {CostCenterTypeName: "Manufacturing"});
costCenterTypesServiceGetCostCenterTypeList
Invokes the CostCenterTypesService_GetCostCenterTypeList service operation to retrieve the list of cost center types.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_4|error
Sample code:
inline_response_200_4 result = check client->costCenterTypesServiceGetCostCenterTypeList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.CostCenterTypeParams)",
"value": [
{
"CostCenterTypeCode": "T1",
"CostCenterTypeName": "Production"
}
]
}
CostElements
costElementServiceGetCostElementList
Invokes the CostElementService_GetCostElementList service operation to retrieve the list of cost elements.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_5|error
Sample code:
inline_response_200_5 result = check client->costElementServiceGetCostElementList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.CostElementParams)",
"value": [
{
"Code": "CE001",
"Description": "Labor Costs"
}
]
}
listCostElements
Queries the CostElements collection and returns a page of cost element entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListCostElementsHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListCostElementsQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: CostElementsCollectionResponse|error
Sample code:
CostElementsCollectionResponse result = check client->listCostElements();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#CostElements",
"value": [
{
"Code": "CE001",
"Description": "Labor Costs",
"IsActive": "tYES"
}
]
}
createCostElements
Creates a new CostElement entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | CostElement | Yes | Request payload describing the cost element to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: CostElement|error
Sample code:
CostElement result = check client->createCostElements({code: "CE002", description: "Material Costs", isActive: "tYES"});
Sample response:
{
"Code": "CE002",
"Description": "Material Costs",
"IsActive": "tYES"
}
getCostElements
Retrieves a single CostElement by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetCostElementsQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: CostElement|error
Sample code:
CostElement result = check client->getCostElements("CE001");
Sample response:
{
"Code": "CE001",
"Description": "Labor Costs",
"IsActive": "tYES"
}
deleteCostElements
Deletes a CostElement identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteCostElements("CE002");
updateCostElements
Partially updates a CostElement using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | CostElement | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateCostElements("CE001", {description: "Direct Labor Costs"});
Currencies
listCurrencies
Queries the Currencies collection and returns a page of currency entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListCurrenciesHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListCurrenciesQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: CurrenciesCollectionResponse|error
Sample code:
CurrenciesCollectionResponse result = check client->listCurrencies();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Currencies",
"value": [
{
"Code": "USD",
"Name": "US Dollar",
"DocumentsCode": "$",
"InternationalDescription": "US Dollar",
"Rounding": "rsNoRounding"
}
]
}
createCurrencies
Creates a new Currency entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | Currency | Yes | Request payload describing the currency to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: Currency|error
Sample code:
Currency result = check client->createCurrencies({Code: "EUR", Name: "Euro", DocumentsCode: "EUR"});
Sample response:
{
"Code": "EUR",
"Name": "Euro",
"DocumentsCode": "EUR",
"InternationalDescription": "Euro"
}
getCurrencies
Retrieves a single Currency by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetCurrenciesQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: Currency|error
Sample code:
Currency result = check client->getCurrencies("USD");
Sample response:
{
"Code": "USD",
"Name": "US Dollar",
"DocumentsCode": "$",
"Rounding": "rsNoRounding",
"RoundingInPayment": "tNO"
}
deleteCurrencies
Deletes a Currency identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteCurrencies("EUR");
updateCurrencies
Partially updates a Currency using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | Currency | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateCurrencies("USD", {Name: "United States Dollar"});
DistributionRules
listDistributionRules
Queries the DistributionRules collection and returns a page of distribution rule entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListDistributionRulesHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListDistributionRulesQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: DistributionRulesCollectionResponse|error
Sample code:
DistributionRulesCollectionResponse result = check client->listDistributionRules();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#DistributionRules",
"value": [
{
"FactorCode": "DR001",
"FactorDescription": "Head Office Split",
"TotalFactor": 100.0,
"InWhichDimension": 1,
"Active": "tYES"
}
]
}
createDistributionRules
Creates a new DistributionRule entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | DistributionRule | Yes | Request payload describing the distribution rule to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: DistributionRule|error
Sample code:
DistributionRule result = check client->createDistributionRules({FactorCode: "DR002", FactorDescription: "Regional Split", InWhichDimension: 1});
Sample response:
{
"FactorCode": "DR002",
"FactorDescription": "Regional Split",
"TotalFactor": 100.0,
"InWhichDimension": 1,
"Active": "tYES"
}
getDistributionRules
Retrieves a single DistributionRule by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
factorCode | string | Yes | Key property 'FactorCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetDistributionRulesQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: DistributionRule|error
Sample code:
DistributionRule result = check client->getDistributionRules("DR001");
Sample response:
{
"FactorCode": "DR001",
"FactorDescription": "Head Office Split",
"TotalFactor": 100.0,
"InWhichDimension": 1,
"Active": "tYES",
"IsFixedAmount": "tNO"
}
deleteDistributionRules
Deletes a DistributionRule identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
factorCode | string | Yes | Key property 'FactorCode' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteDistributionRules("DR002");
updateDistributionRules
Partially updates a DistributionRule using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
factorCode | string | Yes | Key property 'FactorCode' (Edm.String) |
payload | DistributionRule | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateDistributionRules("DR001", {FactorDescription: "Updated Head Office Split"});
distributionRulesServiceGetDistributionRuleList
Invokes the DistributionRulesService_GetDistributionRuleList service operation to retrieve the list of distribution rules.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_10|error
Sample code:
inline_response_200_10 result = check client->distributionRulesServiceGetDistributionRuleList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.DistributionRuleParams)",
"value": [
{
"FactorCode": "DR001",
"FactorDescription": "Head Office Split"
}
]
}
Forms1099
listForms1099
Queries the Forms1099 collection and returns a page of 1099 form entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListForms1099Headers | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListForms1099Queries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: Forms1099CollectionResponse|error
Sample code:
Forms1099CollectionResponse result = check client->listForms1099();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Forms1099",
"value": [
{
"FormCode": 1,
"Form1099": "1099 MISC"
}
]
}
createForms1099
Creates a new Forms1099 entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | Forms1099 | Yes | Request payload describing the 1099 form to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: Forms1099|error
Sample code:
Forms1099 result = check client->createForms1099({Form1099: "1099 INT"});
Sample response:
{
"FormCode": 2,
"Form1099": "1099 INT"
}
getForms1099
Retrieves a single Forms1099 entity by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
formCode | int:Signed32 | Yes | Key property 'FormCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetForms1099Queries | No | OData query options: dollarExpand, dollarSelect |
Returns: Forms1099|error
Sample code:
Forms1099 result = check client->getForms1099(1);
Sample response:
{
"FormCode": 1,
"Form1099": "1099 MISC",
"Boxes1099": [
{
"BoxCode": 1,
"Description": "Rents"
}
]
}
deleteForms1099
Deletes a Forms1099 entity identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
formCode | int:Signed32 | Yes | Key property 'FormCode' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteForms1099(2);
updateForms1099
Partially updates a Forms1099 entity using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
formCode | int:Signed32 | Yes | Key property 'FormCode' (Edm.Int32) |
payload | Forms1099 | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateForms1099(1, {Form1099: "1099 MISC Updated"});
NatureOfAssessees
listNatureOfAssessees
Queries the NatureOfAssessees collection and returns a page of nature of assessee entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListNatureOfAssesseesHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListNatureOfAssesseesQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: NatureOfAssesseesCollectionResponse|error
Sample code:
NatureOfAssesseesCollectionResponse result = check client->listNatureOfAssessees();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#NatureOfAssessees",
"value": [
{
"AbsEntry": 1,
"Code": "COM",
"Description": "Company",
"AssesseeType": "atCompany"
}
]
}
createNatureOfAssessees
Creates a new NatureOfAssessee entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | NatureOfAssessee | Yes | Request payload describing the nature of assessee to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: NatureOfAssessee|error
Sample code:
NatureOfAssessee result = check client->createNatureOfAssessees({code: "IND", description: "Individual"});
Sample response:
{
"AbsEntry": 2,
"Code": "IND",
"Description": "Individual"
}
getNatureOfAssessees
Retrieves a single NatureOfAssessee by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetNatureOfAssesseesQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: NatureOfAssessee|error
Sample code:
NatureOfAssessee result = check client->getNatureOfAssessees(1);
Sample response:
{
"AbsEntry": 1,
"Code": "COM",
"Description": "Company",
"AssesseeType": "atCompany"
}
deleteNatureOfAssessees
Deletes a NatureOfAssessee identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteNatureOfAssessees(2);
updateNatureOfAssessees
Partially updates a NatureOfAssessee using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absEntry | int:Signed32 | Yes | Key property 'AbsEntry' (Edm.Int32) |
payload | NatureOfAssessee | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateNatureOfAssessees(1, {description: "Domestic Company"});
natureOfAssesseesServiceGetNatureOfAssesseeList
Invokes the NatureOfAssesseesService_GetNatureOfAssesseeList service operation to retrieve the list of nature of assessees.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_14|error
Sample code:
inline_response_200_14 result = check client->natureOfAssesseesServiceGetNatureOfAssesseeList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.NatureOfAssesseeParams)",
"value": [
{
"AbsEntry": 1,
"Code": "COM",
"Description": "Company"
}
]
}
SpecificWTHAmountsService
listSpecificWTHAmountsService
Queries the SpecificWTHAmountsService collection and returns a page of specific withholding tax amount entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListSpecificWTHAmountsServiceHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListSpecificWTHAmountsServiceQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: SpecificWTHAmountsServiceCollectionResponse|error
Sample code:
SpecificWTHAmountsServiceCollectionResponse result = check client->listSpecificWTHAmountsService();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#SpecificWTHAmountsService",
"value": [
{
"PaymentReasonCode": "A",
"CardCode": "V10000",
"CUSplit": "tNO",
"TaxableAmount": 1000.0,
"TaxAmount": 200.0
}
]
}
createSpecificWTHAmountsService
Creates a new SpecificWTHAmounts entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | SpecificWTHAmounts | Yes | Request payload describing the specific withholding tax amounts to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: SpecificWTHAmounts|error
Sample code:
SpecificWTHAmounts result = check client->createSpecificWTHAmountsService({PaymentReasonCode: "A", CardCode: "V10000", CUSplit: "tNO", TaxableAmount: 1000.0});
Sample response:
{
"PaymentReasonCode": "A",
"CardCode": "V10000",
"CUSplit": "tNO",
"TaxableAmount": 1000.0,
"EarningYear": 2026
}
getSpecificWTHAmountsService
Retrieves a single SpecificWTHAmounts entity by its composite key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
paymentReasonCode | string | Yes | Composite key part 'PaymentReasonCode' (Edm.String) |
cardCode | string | Yes | Composite key part 'CardCode' (Edm.String) |
cUSplit | BoYesNoEnum | Yes | Composite key part 'CUSplit' (SAPB1.BoYesNoEnum) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetSpecificWTHAmountsServiceQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: SpecificWTHAmounts|error
Sample code:
SpecificWTHAmounts result = check client->getSpecificWTHAmountsService("A", "V10000", "tNO");
Sample response:
{
"PaymentReasonCode": "A",
"CardCode": "V10000",
"CUSplit": "tNO",
"TaxableAmount": 1000.0,
"TaxAmount": 200.0,
"EarningYear": 2026
}
deleteSpecificWTHAmountsService
Deletes a SpecificWTHAmounts entity identified by its composite key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
paymentReasonCode | string | Yes | Composite key part 'PaymentReasonCode' (Edm.String) |
cardCode | string | Yes | Composite key part 'CardCode' (Edm.String) |
cUSplit | BoYesNoEnum | Yes | Composite key part 'CUSplit' (SAPB1.BoYesNoEnum) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteSpecificWTHAmountsService("A", "V10000", "tNO");
updateSpecificWTHAmountsService
Partially updates a SpecificWTHAmounts entity identified by its composite key using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
paymentReasonCode | string | Yes | Composite key part 'PaymentReasonCode' (Edm.String) |
cardCode | string | Yes | Composite key part 'CardCode' (Edm.String) |
cUSplit | BoYesNoEnum | Yes | Composite key part 'CUSplit' (SAPB1.BoYesNoEnum) |
payload | SpecificWTHAmounts | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateSpecificWTHAmountsService("A", "V10000", "tNO", {TaxableAmount: 1500.0});
specificWTHAmountsServiceGetList
Invokes the SpecificWTHAmountsService_GetList service operation to retrieve the list of specific withholding tax amounts.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_21|error
Sample code:
inline_response_200_21 result = check client->specificWTHAmountsServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.SpecificWTHAmountsParams)",
"value": [
{
"PaymentReasonCode": "A",
"CardCode": "V10000",
"CUSplit": "tNO",
"TaxableAmount": 1000.0
}
]
}
TaxCodeDeterminationsTCD
listTaxCodeDeterminationsTCD
Queries the TaxCodeDeterminationsTCD collection and returns a page of tax code determination (TCD) entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListTaxCodeDeterminationsTCDHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListTaxCodeDeterminationsTCDQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: TaxCodeDeterminationsTCDCollectionResponse|error
Sample code:
TaxCodeDeterminationsTCDCollectionResponse result = check client->listTaxCodeDeterminationsTCD();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#TaxCodeDeterminationsTCD",
"value": [
{
"AbsId": 1,
"DftApCode": "IN1",
"DftArCode": "OUT1",
"TcdType": "tcdtDeterminationByItems"
}
]
}
createTaxCodeDeterminationsTCD
Creates a new TaxCodeDeterminationTCD entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TaxCodeDeterminationTCD | Yes | Request payload describing the tax code determination to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TaxCodeDeterminationTCD|error
Sample code:
TaxCodeDeterminationTCD result = check client->createTaxCodeDeterminationsTCD({dftApCode: "IN1", dftArCode: "OUT1"});
Sample response:
{
"AbsId": 2,
"DftApCode": "IN1",
"DftArCode": "OUT1"
}
getTaxCodeDeterminationsTCD
Retrieves a single TaxCodeDeterminationTCD by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absId | int:Signed32 | Yes | Key property 'AbsId' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTaxCodeDeterminationsTCDQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: TaxCodeDeterminationTCD|error
Sample code:
TaxCodeDeterminationTCD result = check client->getTaxCodeDeterminationsTCD(1);
Sample response:
{
"AbsId": 1,
"DftApCode": "IN1",
"DftArCode": "OUT1",
"TcdType": "tcdtDeterminationByItems"
}
deleteTaxCodeDeterminationsTCD
Deletes a TaxCodeDeterminationTCD identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absId | int:Signed32 | Yes | Key property 'AbsId' (Edm.Int32) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTaxCodeDeterminationsTCD(2);
updateTaxCodeDeterminationsTCD
Partially updates a TaxCodeDeterminationTCD using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
absId | int:Signed32 | Yes | Key property 'AbsId' (Edm.Int32) |
payload | TaxCodeDeterminationTCD | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTaxCodeDeterminationsTCD(1, {dftApCode: "IN2"});
taxCodeDeterminationsTCDServiceGetTaxCodeDeterminationTCDList
Invokes the TaxCodeDeterminationsTCDService_GetTaxCodeDeterminationTCDList service operation to retrieve the list of tax code determinations (TCD).
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_23|error
Sample code:
inline_response_200_23 result = check client->taxCodeDeterminationsTCDServiceGetTaxCodeDeterminationTCDList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.TaxCodeDeterminationTCDParams)",
"value": [
{
"AbsId": 1,
"DftApCode": "IN1",
"DftArCode": "OUT1"
}
]
}
TaxExemptReasons
taxExemptReasonServiceGetList
Invokes the TaxExemptReasonService_GetList service operation to retrieve the list of tax exempt reasons.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: inline_response_200_24|error
Sample code:
inline_response_200_24 result = check client->taxExemptReasonServiceGetList();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.TaxExemptReasonParams)",
"value": [
{
"Code": "EX1",
"Description": "Export Exemption"
}
]
}
listTaxExemptReasons
Queries the TaxExemptReasons collection and returns a page of tax exempt reason entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListTaxExemptReasonsHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListTaxExemptReasonsQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: TaxExemptReasonsCollectionResponse|error
Sample code:
TaxExemptReasonsCollectionResponse result = check client->listTaxExemptReasons();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#TaxExemptReasons",
"value": [
{
"Code": "EX1",
"Description": "Export Exemption"
}
]
}
createTaxExemptReasons
Creates a new TaxExemptReason entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | TaxExemptReason | Yes | Request payload describing the tax exempt reason to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: TaxExemptReason|error
Sample code:
TaxExemptReason result = check client->createTaxExemptReasons({code: "EX2", description: "Diplomatic Exemption"});
Sample response:
{
"Code": "EX2",
"Description": "Diplomatic Exemption"
}
getTaxExemptReasons
Retrieves a single TaxExemptReason by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetTaxExemptReasonsQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: TaxExemptReason|error
Sample code:
TaxExemptReason result = check client->getTaxExemptReasons("EX1");
Sample response:
{
"Code": "EX1",
"Description": "Export Exemption"
}
deleteTaxExemptReasons
Deletes a TaxExemptReason identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteTaxExemptReasons("EX2");
updateTaxExemptReasons
Partially updates a TaxExemptReason using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | TaxExemptReason | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateTaxExemptReasons("EX1", {description: "Export Tax Exemption"});
VatGroups
listVatGroups
Queries the VatGroups collection and returns a page of VAT group entities.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
headers | ListVatGroupsHeaders | No | Headers to be sent with the request; supports prefer for Service Layer paging control (e.g. 'odata.maxpagesize=100') |
queries | ListVatGroupsQueries | No | OData query options: dollarSkip, dollarTop, dollarFilter, dollarOrderby, dollarExpand, dollarInlinecount, dollarSelect |
Returns: VatGroupsCollectionResponse|error
Sample code:
VatGroupsCollectionResponse result = check client->listVatGroups();
Sample response:
{
"odata.metadata": "https://server:50000/b1s/v2/$metadata#VatGroups",
"value": [
{
"Code": "A1",
"Name": "Output VAT 19%",
"Category": "bovcOutputTax",
"TaxAccount": "_SYS00000000082",
"Inactive": "tNO"
}
]
}
createVatGroups
Creates a new VatGroup entity and returns the created entity.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
payload | VatGroup | Yes | Request payload describing the VAT group to create |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: VatGroup|error
Sample code:
VatGroup result = check client->createVatGroups({Code: "A2", Name: "Input VAT 19%", Category: "bovcInputTax"});
Sample response:
{
"Code": "A2",
"Name": "Input VAT 19%",
"Category": "bovcInputTax",
"Inactive": "tNO"
}
getVatGroups
Retrieves a single VatGroup by its key.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
queries | GetVatGroupsQueries | No | OData query options: dollarExpand, dollarSelect |
Returns: VatGroup|error
Sample code:
VatGroup result = check client->getVatGroups("A1");
Sample response:
{
"Code": "A1",
"Name": "Output VAT 19%",
"Category": "bovcOutputTax",
"TaxAccount": "_SYS00000000082",
"EU": "tNO",
"Inactive": "tNO"
}
deleteVatGroups
Deletes a VatGroup identified by its key; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->deleteVatGroups("A2");
updateVatGroups
Partially updates a VatGroup using PATCH/MERGE semantics; no content is returned on success.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
code | string | Yes | Key property 'Code' (Edm.String) |
payload | VatGroup | Yes | Request payload containing the fields to update |
headers | map<string|string[]> | No | Headers to be sent with the request |
Returns: error?
Sample code:
check client->updateVatGroups("A1", {Name: "Output VAT 20%"});