Actions

The ballerinax/sap.businessone.banking package exposes the following clients:

Available clients:

Client	Purpose
Client	Manages SAP Business One banking and payment objects — incoming and vendor payments, payment drafts & wizards, deposits, checks for payment, bills of exchange, bank statements & pages, house bank accounts, credit cards, and internal reconciliations — over the session-authenticated Service Layer (OData V3).

---

Client

The Client provides access to the banking and payments objects exposed by the SAP Business One Service Layer — incoming and outgoing payments, payment drafts and payment wizards, deposits, checks, bills of exchange, bank statements, house bank accounts, credit cards and their payment methods, and reconciliation data.

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.banking;

businessone:SessionConfig session = {
    companyDb: "SBODemoUS",
    username: "manager",
    password: "<password>"
};

banking:Client client = check new (session, serviceUrl = "https://<host>:50000/b1s/v1");

Operations

Deposits

listDeposits

Queries the Deposits collection and returns a page of deposit entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListDepositsHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListDepositsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: DepositsCollectionResponse|error

Sample code:

DepositsCollectionResponse response = check client->listDeposits();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Deposits",
  "value": [
    {
      "AbsEntry": 1,
      "DepositNumber": 100,
      "DepositType": "dtChecks",
      "DepositDate": "2026-01-15",
      "DepositCurrency": "USD",
      "DepositAccount": "_SYS00000000343",
      "TotalLC": 1500.0
    }
  ],
  "odata.nextLink": "Deposits?$skip=20"
}

createDeposits

Creates a new Deposit entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	Deposit	Yes	Request payload containing the deposit fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Deposit|error

Sample code:

Deposit deposit = check client->createDeposits({
    DepositType: "dtChecks",
    DepositDate: "2026-01-15",
    DepositAccount: "_SYS00000000343"
});

Sample response:

{
  "AbsEntry": 2,
  "DepositNumber": 101,
  "DepositType": "dtChecks",
  "DepositDate": "2026-01-15",
  "DepositAccount": "_SYS00000000343",
  "TotalLC": 1500.0
}

getDeposits

Retrieves a single Deposit by its AbsEntry key, optionally expanding navigation properties or selecting specific fields.

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	GetDepositsQueries	No	OData query options: $expand, $select

Returns: Deposit|error

Sample code:

Deposit deposit = check client->getDeposits(1);

Sample response:

{
  "AbsEntry": 1,
  "DepositNumber": 100,
  "DepositType": "dtChecks",
  "DepositDate": "2026-01-15",
  "DepositCurrency": "USD",
  "TotalLC": 1500.0
}

deleteDeposits

Deletes the Deposit identified by the given AbsEntry 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->deleteDeposits(1);

updateDeposits

Partially updates a Deposit using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	Deposit	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateDeposits(1, {JournalRemarks: "Updated remarks"});

depositsCancelDeposit

Invokes the bound action 'CancelDeposit' on the Deposit identified by AbsEntry to cancel the deposit.

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->depositsCancelDeposit(1);

depositsCancelDepositbyCurrentSystemDate

Invokes the bound action 'CancelDepositbyCurrentSystemDate' on the Deposit identified by AbsEntry to cancel the deposit using the current system date.

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->depositsCancelDepositbyCurrentSystemDate(1);

depositsServiceCancelCheckRow

Cancels a specific check row of a deposit via the DepositsService_CancelCheckRow service operation.

Parameters:

Name	Type	Required	Description
payload	DepositsService_CancelCheckRow_body	Yes	Request payload containing CancelCheckRowParams (check ID and deposit ID)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->depositsServiceCancelCheckRow({
    cancelCheckRowParams: {checkID: 10, depositID: 1}
});

depositsServiceCancelCheckRowbyCurrentSystemDate

Cancels a specific check row of a deposit using the current system date via the DepositsService_CancelCheckRowbyCurrentSystemDate service operation.

Parameters:

Name	Type	Required	Description
payload	DepositsService_CancelCheckRowbyCurrentSystemDate_body	Yes	Request payload containing CancelCheckRowParams (check ID and deposit ID)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->depositsServiceCancelCheckRowbyCurrentSystemDate({
    cancelCheckRowParams: {checkID: 10, depositID: 1}
});

depositsServiceGetDepositList

Retrieves the list of deposits via the DepositsService_GetDepositList service operation.

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 response = check client->depositsServiceGetDepositList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.DepositParams)",
  "value": [
    {
      "Series": 1,
      "DepositNumber": 100,
      "AbsEntry": 1
    }
  ]
}

InternalReconciliations

listInternalReconciliations

Queries the InternalReconciliations collection and returns a page of internal reconciliation entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListInternalReconciliationsHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListInternalReconciliationsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: InternalReconciliationsCollectionResponse|error

Sample code:

InternalReconciliationsCollectionResponse response = check client->listInternalReconciliations();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#InternalReconciliations",
  "value": [
    {
      "ReconNum": 5,
      "ReconType": "rtManual",
      "ReconDate": "2026-01-15",
      "CardOrAccount": "coaCard",
      "Total": 250.0
    }
  ],
  "odata.nextLink": "InternalReconciliations?$skip=20"
}

createInternalReconciliations

Creates a new InternalReconciliation entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	InternalReconciliation	Yes	Request payload containing the internal reconciliation fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: InternalReconciliation|error

Sample code:

InternalReconciliation reconciliation = check client->createInternalReconciliations({
    reconDate: "2026-01-15",
    cardOrAccount: "coaCard"
});

Sample response:

{
  "ReconNum": 6,
  "ReconType": "rtManual",
  "ReconDate": "2026-01-15",
  "CardOrAccount": "coaCard",
  "Total": 250.0
}

getInternalReconciliations

Retrieves a single InternalReconciliation by its ReconNum key, optionally expanding navigation properties or selecting specific fields.

Parameters:

Name	Type	Required	Description
reconNum	int:Signed32	Yes	Key property 'ReconNum' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetInternalReconciliationsQueries	No	OData query options: $expand, $select

Returns: InternalReconciliation|error

Sample code:

InternalReconciliation reconciliation = check client->getInternalReconciliations(5);

Sample response:

{
  "ReconNum": 5,
  "ReconType": "rtManual",
  "ReconDate": "2026-01-15",
  "CardOrAccount": "coaCard",
  "Total": 250.0
}

deleteInternalReconciliations

Deletes the InternalReconciliation identified by the given ReconNum key; no content is returned on success.

Parameters:

Name	Type	Required	Description
reconNum	int:Signed32	Yes	Key property 'ReconNum' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteInternalReconciliations(5);

updateInternalReconciliations

Partially updates an InternalReconciliation using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
reconNum	int:Signed32	Yes	Key property 'ReconNum' (Edm.Int32)
payload	InternalReconciliation	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateInternalReconciliations(5, {reconDate: "2026-02-01"});

internalReconciliationsCancel

Invokes the bound action 'Cancel' on the InternalReconciliation identified by ReconNum to cancel the reconciliation.

Parameters:

Name	Type	Required	Description
reconNum	int:Signed32	Yes	Key property 'ReconNum' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->internalReconciliationsCancel(5);

internalReconciliationsServiceGetOpenTransactions

Retrieves open transactions available for internal reconciliation via the InternalReconciliationsService_GetOpenTransactions service operation.

Parameters:

Name	Type	Required	Description
payload	InternalReconciliationsService_GetOpenTransactions_body	Yes	Request payload containing InternalReconciliationOpenTransParams (account/business partner selection and date range)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: InternalReconciliationOpenTrans|error

Sample code:

InternalReconciliationOpenTrans openTrans = check client->internalReconciliationsServiceGetOpenTransactions({
    internalReconciliationOpenTransParams: {
        cardOrAccount: "coaAccount",
        accountNo: "_SYS00000000343"
    }
});

Sample response:

{
  "CardOrAccount": "coaAccount",
  "ReconDate": "2026-01-15",
  "BPLId": 1,
  "InternalReconciliationOpenTransRows": [
    {
      "TransRowId": 1,
      "ShortName": "C20000",
      "CashDiscount": 0.0,
      "Selected": "tYES"
    }
  ]
}

internalReconciliationsServiceRequestApproveCancellation

Requests approval for cancelling an internal reconciliation via the InternalReconciliationsService_RequestApproveCancellation service operation.

Parameters:

Name	Type	Required	Description
payload	InternalReconciliationsService_RequestApproveCancellation_body	Yes	Request payload containing the InternalReconciliation to request cancellation approval for
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->internalReconciliationsServiceRequestApproveCancellation({
    internalReconciliation: {reconNum: 5}
});

BankChargesAllocationCodes

listBankChargesAllocationCodes

Queries the BankChargesAllocationCodes collection and returns a page of bank charges allocation code entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListBankChargesAllocationCodesHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListBankChargesAllocationCodesQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: BankChargesAllocationCodesCollectionResponse|error

Sample code:

BankChargesAllocationCodesCollectionResponse response = check client->listBankChargesAllocationCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BankChargesAllocationCodes",
  "value": [
    {
      "Code": "BC01",
      "Description": "Standard bank charges"
    }
  ],
  "odata.nextLink": "BankChargesAllocationCodes?$skip=20"
}

createBankChargesAllocationCodes

Creates a new BankChargesAllocationCode entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	BankChargesAllocationCode	Yes	Request payload containing the bank charges allocation code fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BankChargesAllocationCode|error

Sample code:

BankChargesAllocationCode allocationCode = check client->createBankChargesAllocationCodes({
    code: "BC01",
    description: "Standard bank charges"
});

Sample response:

{
  "Code": "BC01",
  "Description": "Standard bank charges"
}

getBankChargesAllocationCodes

Retrieves a single BankChargesAllocationCode by its Code key, optionally expanding navigation properties or selecting specific fields.

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	GetBankChargesAllocationCodesQueries	No	OData query options: $expand, $select

Returns: BankChargesAllocationCode|error

Sample code:

BankChargesAllocationCode allocationCode = check client->getBankChargesAllocationCodes("BC01");

Sample response:

{
  "Code": "BC01",
  "Description": "Standard bank charges"
}

deleteBankChargesAllocationCodes

Deletes the BankChargesAllocationCode identified by the given Code 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->deleteBankChargesAllocationCodes("BC01");

updateBankChargesAllocationCodes

Partially updates a BankChargesAllocationCode using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	BankChargesAllocationCode	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBankChargesAllocationCodes("BC01", {description: "Updated description"});

bankChargesAllocationCodesSetDefaultBankChargesAllocationCode

Invokes the bound action 'SetDefaultBankChargesAllocationCode' on the BankChargesAllocationCode identified by Code to set it as the default allocation code.

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->bankChargesAllocationCodesSetDefaultBankChargesAllocationCode("BC01");

bankChargesAllocationCodesServiceGetBankChargesAllocationCodeList

Retrieves the list of bank charges allocation codes via the BankChargesAllocationCodesService_GetBankChargesAllocationCodeList service operation.

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 response = check client->bankChargesAllocationCodesServiceGetBankChargesAllocationCodeList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.BankChargesAllocationCodeParams)",
  "value": [
    {
      "Code": "BC01",
      "Description": "Standard bank charges"
    }
  ]
}

BOEDocumentTypes

listBOEDocumentTypes

Queries the BOEDocumentTypes collection and returns a page of bill of exchange document type entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListBOEDocumentTypesHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListBOEDocumentTypesQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: BOEDocumentTypesCollectionResponse|error

Sample code:

BOEDocumentTypesCollectionResponse response = check client->listBOEDocumentTypes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BOEDocumentTypes",
  "value": [
    {
      "DocEntry": 1,
      "DocType": "BT01",
      "DocDescription": "Standard bill of exchange"
    }
  ],
  "odata.nextLink": "BOEDocumentTypes?$skip=20"
}

createBOEDocumentTypes

Creates a new BOEDocumentType entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	BOEDocumentType	Yes	Request payload containing the BOE document type fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BOEDocumentType|error

Sample code:

BOEDocumentType docType = check client->createBOEDocumentTypes({
    docType: "BT01",
    docDescription: "Standard bill of exchange"
});

Sample response:

{
  "DocEntry": 1,
  "DocType": "BT01",
  "DocDescription": "Standard bill of exchange"
}

getBOEDocumentTypes

Retrieves a single BOEDocumentType by its DocEntry key, optionally expanding navigation properties or selecting specific fields.

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	GetBOEDocumentTypesQueries	No	OData query options: $expand, $select

Returns: BOEDocumentType|error

Sample code:

BOEDocumentType docType = check client->getBOEDocumentTypes(1);

Sample response:

{
  "DocEntry": 1,
  "DocType": "BT01",
  "DocDescription": "Standard bill of exchange"
}

deleteBOEDocumentTypes

Deletes the BOEDocumentType identified by the given DocEntry 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->deleteBOEDocumentTypes(1);

updateBOEDocumentTypes

Partially updates a BOEDocumentType using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
docEntry	int:Signed32	Yes	Key property 'DocEntry' (Edm.Int32)
payload	BOEDocumentType	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBOEDocumentTypes(1, {docDescription: "Updated description"});

bOEDocumentTypesServiceGetBOEDocumentTypeList

Retrieves the list of BOE document types via the BOEDocumentTypesService_GetBOEDocumentTypeList service operation.

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 response = check client->bOEDocumentTypesServiceGetBOEDocumentTypeList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.BOEDocumentTypeParams)",
  "value": [
    {
      "DocEntry": 1,
      "DocType": "BT01"
    }
  ]
}

GovPayCodes

listGovPayCodes

Queries the GovPayCodes collection and returns a page of government payment code entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListGovPayCodesHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListGovPayCodesQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: GovPayCodesCollectionResponse|error

Sample code:

GovPayCodesCollectionResponse response = check client->listGovPayCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#GovPayCodes",
  "value": [
    {
      "AbsId": 1,
      "Code": "GP01",
      "Descr": "Federal tax payment",
      "StateTax": "tNO",
      "Prdcity": "gpcpMonth"
    }
  ],
  "odata.nextLink": "GovPayCodes?$skip=20"
}

createGovPayCodes

Creates a new GovPayCode entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	GovPayCode	Yes	Request payload containing the government payment code fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: GovPayCode|error

Sample code:

GovPayCode govPayCode = check client->createGovPayCodes({
    code: "GP01",
    descr: "Federal tax payment"
});

Sample response:

{
  "AbsId": 1,
  "Code": "GP01",
  "Descr": "Federal tax payment",
  "StateTax": "tNO",
  "Prdcity": "gpcpMonth"
}

getGovPayCodes

Retrieves a single GovPayCode by its AbsId key, optionally expanding navigation properties or selecting specific fields.

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	GetGovPayCodesQueries	No	OData query options: $expand, $select

Returns: GovPayCode|error

Sample code:

GovPayCode govPayCode = check client->getGovPayCodes(1);

Sample response:

{
  "AbsId": 1,
  "Code": "GP01",
  "Descr": "Federal tax payment",
  "StateTax": "tNO",
  "Prdcity": "gpcpMonth"
}

deleteGovPayCodes

Deletes the GovPayCode identified by the given AbsId 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->deleteGovPayCodes(1);

updateGovPayCodes

Partially updates a GovPayCode using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
absId	int:Signed32	Yes	Key property 'AbsId' (Edm.Int32)
payload	GovPayCode	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateGovPayCodes(1, {descr: "Updated description"});

govPayCodesServiceGetList

Retrieves the list of government payment codes via the GovPayCodesService_GetList service operation.

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 response = check client->govPayCodesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.GovPayCodeParams)",
  "value": [
    {
      "Code": "GP01",
      "AbsId": 1
    }
  ]
}

BankPages

listBankPages

Queries the BankPages collection and returns a page of bank page entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListBankPagesHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListBankPagesQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: BankPagesCollectionResponse|error

Sample code:

BankPagesCollectionResponse response = check client->listBankPages();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BankPages",
  "value": [
    {
      "AccountCode": "_SYS00000000343",
      "Sequence": 1,
      "AccountName": "Bank Account - USD",
      "DueDate": "2026-01-15",
      "DebitAmount": 0.0,
      "CreditAmount": 1500.0,
      "PaymentCreated": "tNO"
    }
  ],
  "odata.nextLink": "BankPages?$skip=20"
}

createBankPages

Creates a new BankPage entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	BankPage	Yes	Request payload containing the bank page fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BankPage|error

Sample code:

BankPage bankPage = check client->createBankPages({
    AccountCode: "_SYS00000000343",
    DueDate: "2026-01-15",
    CreditAmount: 1500.0
});

Sample response:

{
  "AccountCode": "_SYS00000000343",
  "Sequence": 2,
  "DueDate": "2026-01-15",
  "DebitAmount": 0.0,
  "CreditAmount": 1500.0,
  "PaymentCreated": "tNO"
}

getBankPages

Retrieves a single BankPage by its composite key of AccountCode and Sequence, optionally expanding navigation properties or selecting specific fields.

Parameters:

Name	Type	Required	Description
accountCode	string	Yes	Composite key part 'AccountCode' (Edm.String)
sequence	int:Signed32	Yes	Composite key part 'Sequence' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBankPagesQueries	No	OData query options: $expand, $select

Returns: BankPage|error

Sample code:

BankPage bankPage = check client->getBankPages("_SYS00000000343", 1);

Sample response:

{
  "AccountCode": "_SYS00000000343",
  "Sequence": 1,
  "AccountName": "Bank Account - USD",
  "DueDate": "2026-01-15",
  "CreditAmount": 1500.0
}

deleteBankPages

Deletes the BankPage identified by the composite key of AccountCode and Sequence; no content is returned on success.

Parameters:

Name	Type	Required	Description
accountCode	string	Yes	Composite key part 'AccountCode' (Edm.String)
sequence	int:Signed32	Yes	Composite key part 'Sequence' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBankPages("_SYS00000000343", 1);

updateBankPages

Partially updates a BankPage identified by the composite key of AccountCode and Sequence using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
accountCode	string	Yes	Composite key part 'AccountCode' (Edm.String)
sequence	int:Signed32	Yes	Composite key part 'Sequence' (Edm.Int32)
payload	BankPage	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBankPages("_SYS00000000343", 1, {Memo: "Updated memo"});

BillOfExchangeTransactions

listBillOfExchangeTransactions

Queries the BillOfExchangeTransactions collection and returns a page of bill of exchange transaction entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListBillOfExchangeTransactionsHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListBillOfExchangeTransactionsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: BillOfExchangeTransactionsCollectionResponse|error

Sample code:

BillOfExchangeTransactionsCollectionResponse response = check client->listBillOfExchangeTransactions();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BillOfExchangeTransactions",
  "value": [
    {
      "BOETransactionkey": 1,
      "TransactionNumber": 100,
      "StatusFrom": "btfs_Generated",
      "StatusTo": "btts_Deposit",
      "TransactionDate": "2026-01-15",
      "PostingDate": "2026-01-15",
      "IsBoeReconciled": "tNO"
    }
  ],
  "odata.nextLink": "BillOfExchangeTransactions?$skip=20"
}

createBillOfExchangeTransactions

Creates a new BillOfExchangeTransaction entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	BillOfExchangeTransaction	Yes	Request payload containing the bill of exchange transaction fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BillOfExchangeTransaction|error

Sample code:

BillOfExchangeTransaction transaction = check client->createBillOfExchangeTransactions({
    StatusFrom: "btfs_Generated",
    StatusTo: "btts_Deposit",
    PostingDate: "2026-01-15"
});

Sample response:

{
  "BOETransactionkey": 2,
  "TransactionNumber": 101,
  "StatusFrom": "btfs_Generated",
  "StatusTo": "btts_Deposit",
  "PostingDate": "2026-01-15"
}

getBillOfExchangeTransactions

Retrieves a single BillOfExchangeTransaction by its BOETransactionkey key, optionally expanding navigation properties or selecting specific fields.

Parameters:

Name	Type	Required	Description
bOETransactionkey	int:Signed32	Yes	Key property 'BOETransactionkey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBillOfExchangeTransactionsQueries	No	OData query options: $expand, $select

Returns: BillOfExchangeTransaction|error

Sample code:

BillOfExchangeTransaction transaction = check client->getBillOfExchangeTransactions(1);

Sample response:

{
  "BOETransactionkey": 1,
  "TransactionNumber": 100,
  "StatusFrom": "btfs_Generated",
  "StatusTo": "btts_Deposit",
  "TransactionDate": "2026-01-15",
  "IsBoeReconciled": "tNO"
}

deleteBillOfExchangeTransactions

Deletes the BillOfExchangeTransaction identified by the given BOETransactionkey key; no content is returned on success.

Parameters:

Name	Type	Required	Description
bOETransactionkey	int:Signed32	Yes	Key property 'BOETransactionkey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBillOfExchangeTransactions(1);

updateBillOfExchangeTransactions

Partially updates a BillOfExchangeTransaction using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
bOETransactionkey	int:Signed32	Yes	Key property 'BOETransactionkey' (Edm.Int32)
payload	BillOfExchangeTransaction	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBillOfExchangeTransactions(1, {TaxDate: "2026-01-20"});

CreditPaymentMethods

listCreditPaymentMethods

Queries the CreditPaymentMethods collection and returns a page of credit payment method entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListCreditPaymentMethodsHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListCreditPaymentMethodsQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: CreditPaymentMethodsCollectionResponse|error

Sample code:

CreditPaymentMethodsCollectionResponse response = check client->listCreditPaymentMethods();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CreditPaymentMethods",
  "value": [
    {
      "PaymentMethodCode": 1,
      "Name": "Visa monthly settlement",
      "AssignedtoCreditCard": 1,
      "MinimumCreditAmount": 100.0,
      "MinimumPaymentAmount": 10.0,
      "InstallmentPaymentsPossible": "ippNo"
    }
  ],
  "odata.nextLink": "CreditPaymentMethods?$skip=20"
}

createCreditPaymentMethods

Creates a new CreditPaymentMethod entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	CreditPaymentMethod	Yes	Request payload containing the credit payment method fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreditPaymentMethod|error

Sample code:

CreditPaymentMethod paymentMethod = check client->createCreditPaymentMethods({
    Name: "Visa monthly settlement",
    AssignedtoCreditCard: 1
});

Sample response:

{
  "PaymentMethodCode": 2,
  "Name": "Visa monthly settlement",
  "AssignedtoCreditCard": 1,
  "InstallmentPaymentsPossible": "ippNo"
}

getCreditPaymentMethods

Retrieves a single CreditPaymentMethod by its PaymentMethodCode key, optionally expanding navigation properties or selecting specific fields.

Parameters:

Name	Type	Required	Description
paymentMethodCode	int:Signed32	Yes	Key property 'PaymentMethodCode' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetCreditPaymentMethodsQueries	No	OData query options: $expand, $select

Returns: CreditPaymentMethod|error

Sample code:

CreditPaymentMethod paymentMethod = check client->getCreditPaymentMethods(1);

Sample response:

{
  "PaymentMethodCode": 1,
  "Name": "Visa monthly settlement",
  "AssignedtoCreditCard": 1,
  "MinimumCreditAmount": 100.0,
  "InstallmentPaymentsPossible": "ippNo"
}

deleteCreditPaymentMethods

Deletes the CreditPaymentMethod identified by the given PaymentMethodCode key; no content is returned on success.

Parameters:

Name	Type	Required	Description
paymentMethodCode	int:Signed32	Yes	Key property 'PaymentMethodCode' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteCreditPaymentMethods(1);

updateCreditPaymentMethods

Partially updates a CreditPaymentMethod using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
paymentMethodCode	int:Signed32	Yes	Key property 'PaymentMethodCode' (Edm.Int32)
payload	CreditPaymentMethod	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateCreditPaymentMethods(1, {Name: "Updated method name"});

PaymentReasonCodes

paymentReasonCodeServiceGetPaymentReasonCodeList

Retrieves the list of payment reason codes via the PaymentReasonCodeService_GetPaymentReasonCodeList service operation.

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 response = check client->paymentReasonCodeServiceGetPaymentReasonCodeList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#Collection(SAPB1.PaymentReasonCodeParams)",
  "value": [
    {
      "Code": "PR01"
    }
  ]
}

listPaymentReasonCodes

Queries the PaymentReasonCodes collection and returns a page of payment reason code entities, with OData query options for filtering, paging, sorting, and field selection.

Parameters:

Name	Type	Required	Description
headers	ListPaymentReasonCodesHeaders	No	Headers to be sent with the request; supports the Prefer header for Service Layer paging control (e.g. odata.maxpagesize=100)
queries	ListPaymentReasonCodesQueries	No	OData query options: $skip, $top, $filter, $orderby, $expand, $inlinecount, $select

Returns: PaymentReasonCodesCollectionResponse|error

Sample code:

PaymentReasonCodesCollectionResponse response = check client->listPaymentReasonCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#PaymentReasonCodes",
  "value": [
    {
      "Code": "PR01"
    }
  ],
  "odata.nextLink": "PaymentReasonCodes?$skip=20"
}

createPaymentReasonCodes

Creates a new PaymentReasonCode entity in the SAP Business One Service Layer and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	PaymentReasonCode	Yes	Request payload containing the payment reason code fields to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: PaymentReasonCode|error

Sample code:

PaymentReasonCode reasonCode = check client->createPaymentReasonCodes({code: "PR01"});

Sample response:

{
  "Code": "PR01"
}

getPaymentReasonCodes

Retrieves a single PaymentReasonCode by its Code key, optionally expanding navigation properties or selecting specific fields.

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	GetPaymentReasonCodesQueries	No	OData query options: $expand, $select

Returns: PaymentReasonCode|error

Sample code:

PaymentReasonCode reasonCode = check client->getPaymentReasonCodes("PR01");

Sample response:

{
  "Code": "PR01"
}

deletePaymentReasonCodes

Deletes the PaymentReasonCode identified by the given Code 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->deletePaymentReasonCodes("PR01");

updatePaymentReasonCodes

Partially updates a PaymentReasonCode using PATCH/MERGE semantics; only the fields present in the payload are modified.

Parameters:

Name	Type	Required	Description
code	string	Yes	Key property 'Code' (Edm.String)
payload	PaymentReasonCode	Yes	Request payload with the fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentReasonCodes("PR01", {code: "PR01"});

PaymentDrafts

listPaymentDrafts

Queries the PaymentDrafts collection and returns a page of payment draft entities.

Parameters:

Name	Type	Required	Description
headers	ListPaymentDraftsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListPaymentDraftsQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: PaymentDraftsCollectionResponse|error

Sample code:

PaymentDraftsCollectionResponse result = check client->listPaymentDrafts();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#PaymentDrafts",
  "value": [
    {
      "DocEntry": 5,
      "DocNum": 100,
      "DocType": "rCustomer",
      "DocDate": "2026-07-01",
      "CardCode": "C20000",
      "CardName": "Norm Thompson",
      "DocCurrency": "USD",
      "CashSum": 1500.0
    }
  ],
  "odata.nextLink": "PaymentDrafts?$skip=20"
}

createPaymentDrafts

Creates a new payment draft (Payment entity) in the PaymentDrafts collection and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	Payment	Yes	The payment draft to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Payment|error

Sample code:

Payment result = check client->createPaymentDrafts({CardCode: "C20000", DocDate: "2026-07-01", CashSum: 1500.0});

Sample response:

{
  "DocEntry": 5,
  "DocNum": 100,
  "DocType": "rCustomer",
  "DocDate": "2026-07-01",
  "CardCode": "C20000",
  "CardName": "Norm Thompson",
  "DocCurrency": "USD",
  "CashSum": 1500.0
}

getPaymentDrafts

Retrieves a single payment draft (Payment entity) by its DocEntry 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	GetPaymentDraftsQueries	No	OData query options $expand and $select

Returns: Payment|error

Sample code:

Payment result = check client->getPaymentDrafts(5);

Sample response:

{
  "DocEntry": 5,
  "DocNum": 100,
  "DocType": "rCustomer",
  "DocDate": "2026-07-01",
  "CardCode": "C20000",
  "DocCurrency": "USD",
  "CashSum": 1500.0
}

deletePaymentDrafts

Deletes a payment draft identified by its DocEntry 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->deletePaymentDrafts(5);

updatePaymentDrafts

Partially updates a payment draft (PATCH/MERGE semantics) identified by its DocEntry key; no content is returned on success.

Parameters:

Name	Type	Required	Description
docEntry	int:Signed32	Yes	Key property 'DocEntry' (Edm.Int32)
payload	Payment	Yes	The payment draft fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentDrafts(5, {Remarks: "Updated draft"});

paymentDraftsCancel

Invokes the bound action 'Cancel' on a payment draft (binding type Payment) identified by its DocEntry 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->paymentDraftsCancel(5);

paymentDraftsCancelbyCurrentSystemDate

Invokes the bound action 'CancelbyCurrentSystemDate' on a payment draft (binding type Payment) to cancel it using the current system date; 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->paymentDraftsCancelbyCurrentSystemDate(5);

paymentDraftsGetApprovalTemplates

Invokes the bound action 'GetApprovalTemplates' on a payment draft (binding type Payment) and returns the resulting Payment entity.

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: Payment|error

Sample code:

Payment result = check client->paymentDraftsGetApprovalTemplates(5);

Sample response:

{
  "DocEntry": 5,
  "DocNum": 100,
  "CardCode": "C20000",
  "DocDate": "2026-07-01"
}

paymentDraftsRequestApproveCancellation

Invokes the bound action 'RequestApproveCancellation' on a payment draft (binding type Payment) to request approval for cancellation; 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->paymentDraftsRequestApproveCancellation(5);

paymentDraftsSaveDraftToDocument

Invokes the bound action 'SaveDraftToDocument' on a payment draft (binding type Payment) to convert the draft into a posted document; 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->paymentDraftsSaveDraftToDocument(5);

paymentDraftsServiceHandleApprovalRequest

Handles an approval request via the PaymentDraftsService; no content is returned on success.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->paymentDraftsServiceHandleApprovalRequest();

CentralBankIndicator

listCentralBankIndicator

Queries the CentralBankIndicator collection and returns a page of central bank indicator entities.

Parameters:

Name	Type	Required	Description
headers	ListCentralBankIndicatorHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListCentralBankIndicatorQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: CentralBankIndicatorCollectionResponse|error

Sample code:

CentralBankIndicatorCollectionResponse result = check client->listCentralBankIndicator();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#CentralBankIndicator",
  "value": [
    {
      "Indicator": "CBI01",
      "Description": "Goods import"
    }
  ],
  "odata.nextLink": "CentralBankIndicator?$skip=20"
}

createCentralBankIndicator

Creates a new CentralBankIndicator entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	CentralBankIndicator	Yes	The central bank indicator to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CentralBankIndicator|error

Sample code:

CentralBankIndicator result = check client->createCentralBankIndicator({indicator: "CBI01", description: "Goods import"});

Sample response:

{
  "Indicator": "CBI01",
  "Description": "Goods import"
}

getCentralBankIndicator

Retrieves a single CentralBankIndicator entity by its Indicator key.

Parameters:

Name	Type	Required	Description
indicator	string	Yes	Key property 'Indicator' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetCentralBankIndicatorQueries	No	OData query options $expand and $select

Returns: CentralBankIndicator|error

Sample code:

CentralBankIndicator result = check client->getCentralBankIndicator("CBI01");

Sample response:

{
  "Indicator": "CBI01",
  "Description": "Goods import"
}

deleteCentralBankIndicator

Deletes a CentralBankIndicator entity identified by its Indicator key; no content is returned on success.

Parameters:

Name	Type	Required	Description
indicator	string	Yes	Key property 'Indicator' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteCentralBankIndicator("CBI01");

updateCentralBankIndicator

Partially updates a CentralBankIndicator entity (PATCH/MERGE semantics) identified by its Indicator key; no content is returned on success.

Parameters:

Name	Type	Required	Description
indicator	string	Yes	Key property 'Indicator' (Edm.String)
payload	CentralBankIndicator	Yes	The central bank indicator fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateCentralBankIndicator("CBI01", {description: "Updated description"});

centralBankIndicatorServiceGetList

Retrieves the central bank indicator list via the CentralBankIndicatorService.

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->centralBankIndicatorServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#SAPB1.CentralBankIndicatorParams",
  "value": [
    {
      "Indicator": "CBI01"
    }
  ]
}

BOEInstructions

listBOEInstructions

Queries the BOEInstructions collection and returns a page of bill of exchange instruction entities.

Parameters:

Name	Type	Required	Description
headers	ListBOEInstructionsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListBOEInstructionsQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: BOEInstructionsCollectionResponse|error

Sample code:

BOEInstructionsCollectionResponse result = check client->listBOEInstructions();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#BOEInstructions",
  "value": [
    {
      "InstructionEntry": 1,
      "InstructionCode": "INST01",
      "InstructionDesc": "Standard collection",
      "IsCancelInstruction": "tNO"
    }
  ],
  "odata.nextLink": "BOEInstructions?$skip=20"
}

createBOEInstructions

Creates a new BOEInstruction entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	BOEInstruction	Yes	The BOE instruction to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BOEInstruction|error

Sample code:

BOEInstruction result = check client->createBOEInstructions({instructionCode: "INST01", instructionDesc: "Standard collection"});

Sample response:

{
  "InstructionEntry": 1,
  "InstructionCode": "INST01",
  "InstructionDesc": "Standard collection",
  "IsCancelInstruction": "tNO"
}

getBOEInstructions

Retrieves a single BOEInstruction entity by its InstructionEntry key.

Parameters:

Name	Type	Required	Description
instructionEntry	int:Signed32	Yes	Key property 'InstructionEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBOEInstructionsQueries	No	OData query options $expand and $select

Returns: BOEInstruction|error

Sample code:

BOEInstruction result = check client->getBOEInstructions(1);

Sample response:

{
  "InstructionEntry": 1,
  "InstructionCode": "INST01",
  "InstructionDesc": "Standard collection",
  "IsCancelInstruction": "tNO"
}

deleteBOEInstructions

Deletes a BOEInstruction entity identified by its InstructionEntry key; no content is returned on success.

Parameters:

Name	Type	Required	Description
instructionEntry	int:Signed32	Yes	Key property 'InstructionEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBOEInstructions(1);

updateBOEInstructions

Partially updates a BOEInstruction entity (PATCH/MERGE semantics) identified by its InstructionEntry key; no content is returned on success.

Parameters:

Name	Type	Required	Description
instructionEntry	int:Signed32	Yes	Key property 'InstructionEntry' (Edm.Int32)
payload	BOEInstruction	Yes	The BOE instruction fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBOEInstructions(1, {instructionDesc: "Updated description"});

bOEInstructionsServiceGetBOEInstructionList

Retrieves the BOE instruction list via the BOEInstructionsService.

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->bOEInstructionsServiceGetBOEInstructionList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#SAPB1.BOEInstructionParams",
  "value": [
    {
      "InstructionEntry": 1,
      "InstructionCode": "INST01"
    }
  ]
}

PaymentBlocks

listPaymentBlocks

Queries the PaymentBlocks collection and returns a page of payment block entities.

Parameters:

Name	Type	Required	Description
headers	ListPaymentBlocksHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListPaymentBlocksQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: PaymentBlocksCollectionResponse|error

Sample code:

PaymentBlocksCollectionResponse result = check client->listPaymentBlocks();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#PaymentBlocks",
  "value": [
    {
      "AbsEntry": 1,
      "PaymentBlockCode": "BLOCK01"
    }
  ],
  "odata.nextLink": "PaymentBlocks?$skip=20"
}

createPaymentBlocks

Creates a new PaymentBlock entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	PaymentBlock	Yes	The payment block to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: PaymentBlock|error

Sample code:

PaymentBlock result = check client->createPaymentBlocks({paymentBlockCode: "BLOCK01"});

Sample response:

{
  "AbsEntry": 1,
  "PaymentBlockCode": "BLOCK01"
}

getPaymentBlocks

Retrieves a single PaymentBlock entity by its AbsEntry 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	GetPaymentBlocksQueries	No	OData query options $expand and $select

Returns: PaymentBlock|error

Sample code:

PaymentBlock result = check client->getPaymentBlocks(1);

Sample response:

{
  "AbsEntry": 1,
  "PaymentBlockCode": "BLOCK01"
}

deletePaymentBlocks

Deletes a PaymentBlock entity identified by its AbsEntry 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->deletePaymentBlocks(1);

updatePaymentBlocks

Partially updates a PaymentBlock entity (PATCH/MERGE semantics) identified by its AbsEntry key; no content is returned on success.

Parameters:

Name	Type	Required	Description
absEntry	int:Signed32	Yes	Key property 'AbsEntry' (Edm.Int32)
payload	PaymentBlock	Yes	The payment block fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentBlocks(1, {paymentBlockCode: "BLOCK02"});

paymentBlocksServiceGetPaymentBlockList

Retrieves the payment block list via the PaymentBlocksService.

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->paymentBlocksServiceGetPaymentBlockList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#SAPB1.PaymentBlockParams",
  "value": [
    {
      "AbsEntry": 1,
      "PaymentBlockCode": "BLOCK01"
    }
  ]
}

BankStatements

listBankStatements

Queries the BankStatements collection and returns a page of bank statement entities.

Parameters:

Name	Type	Required	Description
headers	ListBankStatementsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListBankStatementsQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: BankStatementsCollectionResponse|error

Sample code:

BankStatementsCollectionResponse result = check client->listBankStatements();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#BankStatements",
  "value": [
    {
      "InternalNumber": 1,
      "BankAccountKey": 3,
      "StatementNumber": "ST-2026-001",
      "StatementDate": "2026-07-01",
      "Status": "bssDraft",
      "Currency": "USD",
      "StartingBalanceL": 10000.0,
      "EndingBalanceL": 12500.0,
      "Imported": "tNO"
    }
  ],
  "odata.nextLink": "BankStatements?$skip=20"
}

createBankStatements

Creates a new BankStatement entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	BankStatement	Yes	The bank statement to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BankStatement|error

Sample code:

BankStatement result = check client->createBankStatements({bankAccountKey: 3, statementNumber: "ST-2026-001", statementDate: "2026-07-01"});

Sample response:

{
  "InternalNumber": 1,
  "BankAccountKey": 3,
  "StatementNumber": "ST-2026-001",
  "StatementDate": "2026-07-01",
  "Status": "bssDraft",
  "Currency": "USD"
}

getBankStatements

Retrieves a single BankStatement entity by its InternalNumber key.

Parameters:

Name	Type	Required	Description
internalNumber	int:Signed32	Yes	Key property 'InternalNumber' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBankStatementsQueries	No	OData query options $expand and $select

Returns: BankStatement|error

Sample code:

BankStatement result = check client->getBankStatements(1);

Sample response:

{
  "InternalNumber": 1,
  "BankAccountKey": 3,
  "StatementNumber": "ST-2026-001",
  "StatementDate": "2026-07-01",
  "Status": "bssDraft",
  "Currency": "USD",
  "StartingBalanceL": 10000.0,
  "EndingBalanceL": 12500.0
}

deleteBankStatements

Deletes a BankStatement entity identified by its InternalNumber key; no content is returned on success.

Parameters:

Name	Type	Required	Description
internalNumber	int:Signed32	Yes	Key property 'InternalNumber' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBankStatements(1);

updateBankStatements

Partially updates a BankStatement entity (PATCH/MERGE semantics) identified by its InternalNumber key; no content is returned on success.

Parameters:

Name	Type	Required	Description
internalNumber	int:Signed32	Yes	Key property 'InternalNumber' (Edm.Int32)
payload	BankStatement	Yes	The bank statement fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBankStatements(1, {statementNumber: "ST-2026-002"});

bankStatementsServiceGetBankStatementList

Retrieves a filtered bank statement list via the BankStatementsService using a bank statements filter payload.

Parameters:

Name	Type	Required	Description
payload	BankStatementsService_GetBankStatementList_body	Yes	Request payload containing the BankStatementsFilter criteria
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->bankStatementsServiceGetBankStatementList({bankStatementsFilter: {}});

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#SAPB1.BankStatementParams",
  "value": [
    {
      "InternalNumber": 1,
      "BankAccountKey": 3,
      "StatementNumber": "ST-2026-001",
      "StatementDate": "2026-07-01",
      "Status": "bssDraft",
      "Currency": "USD"
    }
  ]
}

WizardPaymentMethods

listWizardPaymentMethods

Queries the WizardPaymentMethods collection and returns a page of wizard payment method entities.

Parameters:

Name	Type	Required	Description
headers	ListWizardPaymentMethodsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListWizardPaymentMethodsQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: WizardPaymentMethodsCollectionResponse|error

Sample code:

WizardPaymentMethodsCollectionResponse result = check client->listWizardPaymentMethods();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#WizardPaymentMethods",
  "value": [
    {
      "PaymentMethodCode": "OutgoingBT",
      "Description": "Outgoing bank transfer",
      "Type": "boptOutgoing",
      "PaymentMeans": "bopmBankTransfer",
      "MinimumAmount": 0.0,
      "MaximumAmount": 100000.0
    }
  ],
  "odata.nextLink": "WizardPaymentMethods?$skip=20"
}

createWizardPaymentMethods

Creates a new WizardPaymentMethod entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	WizardPaymentMethod	Yes	The wizard payment method to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: WizardPaymentMethod|error

Sample code:

WizardPaymentMethod result = check client->createWizardPaymentMethods({PaymentMethodCode: "OutgoingBT", Description: "Outgoing bank transfer", Type: "boptOutgoing"});

Sample response:

{
  "PaymentMethodCode": "OutgoingBT",
  "Description": "Outgoing bank transfer",
  "Type": "boptOutgoing",
  "PaymentMeans": "bopmBankTransfer"
}

getWizardPaymentMethods

Retrieves a single WizardPaymentMethod entity by its PaymentMethodCode key.

Parameters:

Name	Type	Required	Description
paymentMethodCode	string	Yes	Key property 'PaymentMethodCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetWizardPaymentMethodsQueries	No	OData query options $expand and $select

Returns: WizardPaymentMethod|error

Sample code:

WizardPaymentMethod result = check client->getWizardPaymentMethods("OutgoingBT");

Sample response:

{
  "PaymentMethodCode": "OutgoingBT",
  "Description": "Outgoing bank transfer",
  "Type": "boptOutgoing",
  "PaymentMeans": "bopmBankTransfer",
  "MinimumAmount": 0.0,
  "MaximumAmount": 100000.0
}

deleteWizardPaymentMethods

Deletes a WizardPaymentMethod entity identified by its PaymentMethodCode key; no content is returned on success.

Parameters:

Name	Type	Required	Description
paymentMethodCode	string	Yes	Key property 'PaymentMethodCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteWizardPaymentMethods("OutgoingBT");

updateWizardPaymentMethods

Partially updates a WizardPaymentMethod entity (PATCH/MERGE semantics) identified by its PaymentMethodCode key; no content is returned on success.

Parameters:

Name	Type	Required	Description
paymentMethodCode	string	Yes	Key property 'PaymentMethodCode' (Edm.String)
payload	WizardPaymentMethod	Yes	The wizard payment method fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateWizardPaymentMethods("OutgoingBT", {Description: "Updated description"});

ChecksforPayment

listChecksforPayment

Queries the ChecksforPayment collection and returns a page of checks for payment entities.

Parameters:

Name	Type	Required	Description
headers	ListChecksforPaymentHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListChecksforPaymentQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: ChecksforPaymentCollectionResponse|error

Sample code:

ChecksforPaymentCollectionResponse result = check client->listChecksforPayment();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#ChecksforPayment",
  "value": [
    {
      "CheckKey": 1,
      "CheckNumber": 1001,
      "BankCode": "BANK01",
      "BankName": "First National Bank",
      "CheckDate": "2026-07-01",
      "CheckAmount": 1500.0,
      "CheckCurrency": "USD",
      "VendorCode": "V10000",
      "Printed": "tNO",
      "Canceled": "tNO"
    }
  ],
  "odata.nextLink": "ChecksforPayment?$skip=20"
}

createChecksforPayment

Creates a new ChecksforPayment entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	ChecksforPayment	Yes	The check for payment to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: ChecksforPayment|error

Sample code:

ChecksforPayment result = check client->createChecksforPayment({CheckNumber: 1001, BankCode: "BANK01", CheckDate: "2026-07-01", CheckAmount: 1500.0});

Sample response:

{
  "CheckKey": 1,
  "CheckNumber": 1001,
  "BankCode": "BANK01",
  "CheckDate": "2026-07-01",
  "CheckAmount": 1500.0,
  "CheckCurrency": "USD"
}

getChecksforPayment

Retrieves a single ChecksforPayment entity by its CheckKey key.

Parameters:

Name	Type	Required	Description
checkKey	int:Signed32	Yes	Key property 'CheckKey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetChecksforPaymentQueries	No	OData query options $expand and $select

Returns: ChecksforPayment|error

Sample code:

ChecksforPayment result = check client->getChecksforPayment(1);

Sample response:

{
  "CheckKey": 1,
  "CheckNumber": 1001,
  "BankCode": "BANK01",
  "BankName": "First National Bank",
  "CheckDate": "2026-07-01",
  "CheckAmount": 1500.0,
  "CheckCurrency": "USD",
  "VendorCode": "V10000"
}

deleteChecksforPayment

Deletes a ChecksforPayment entity identified by its CheckKey key; no content is returned on success.

Parameters:

Name	Type	Required	Description
checkKey	int:Signed32	Yes	Key property 'CheckKey' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteChecksforPayment(1);

updateChecksforPayment

Partially updates a ChecksforPayment entity (PATCH/MERGE semantics) identified by its CheckKey key; no content is returned on success.

Parameters:

Name	Type	Required	Description
checkKey	int:Signed32	Yes	Key property 'CheckKey' (Edm.Int32)
payload	ChecksforPayment	Yes	The check for payment fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateChecksforPayment(1, {Details: "Updated details"});

FactoringIndicators

listFactoringIndicators

Queries the FactoringIndicators collection and returns a page of factoring indicator entities.

Parameters:

Name	Type	Required	Description
headers	ListFactoringIndicatorsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListFactoringIndicatorsQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: FactoringIndicatorsCollectionResponse|error

Sample code:

FactoringIndicatorsCollectionResponse result = check client->listFactoringIndicators();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#FactoringIndicators",
  "value": [
    {
      "IndicatorCode": "F01",
      "IndicatorName": "Standard factoring"
    }
  ],
  "odata.nextLink": "FactoringIndicators?$skip=20"
}

createFactoringIndicators

Creates a new FactoringIndicator entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	FactoringIndicator	Yes	The factoring indicator to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: FactoringIndicator|error

Sample code:

FactoringIndicator result = check client->createFactoringIndicators({IndicatorCode: "F01", IndicatorName: "Standard factoring"});

Sample response:

{
  "IndicatorCode": "F01",
  "IndicatorName": "Standard factoring"
}

getFactoringIndicators

Retrieves a single FactoringIndicator entity by its IndicatorCode key.

Parameters:

Name	Type	Required	Description
indicatorCode	string	Yes	Key property 'IndicatorCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetFactoringIndicatorsQueries	No	OData query options $expand and $select

Returns: FactoringIndicator|error

Sample code:

FactoringIndicator result = check client->getFactoringIndicators("F01");

Sample response:

{
  "IndicatorCode": "F01",
  "IndicatorName": "Standard factoring"
}

deleteFactoringIndicators

Deletes a FactoringIndicator entity identified by its IndicatorCode key; no content is returned on success.

Parameters:

Name	Type	Required	Description
indicatorCode	string	Yes	Key property 'IndicatorCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFactoringIndicators("F01");

updateFactoringIndicators

Partially updates a FactoringIndicator entity (PATCH/MERGE semantics) identified by its IndicatorCode key; no content is returned on success.

Parameters:

Name	Type	Required	Description
indicatorCode	string	Yes	Key property 'IndicatorCode' (Edm.String)
payload	FactoringIndicator	Yes	The factoring indicator fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateFactoringIndicators("F01", {IndicatorName: "Updated name"});

PaymentWizards

paymentWizardServiceGetList

Retrieves the payment wizard list via the PaymentWizardService.

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->paymentWizardServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#SAPB1.PaymentWizardParams",
  "value": [
    {
      "IdNumber": 1,
      "WizardName": "July payment run"
    }
  ]
}

listPaymentWizards

Queries the PaymentWizards collection and returns a page of payment wizard entities.

Parameters:

Name	Type	Required	Description
headers	ListPaymentWizardsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100 for paging control
queries	ListPaymentWizardsQueries	No	OData query options such as $skip, $top, $filter, $orderby, $expand, $inlinecount, and $select

Returns: PaymentWizardsCollectionResponse|error

Sample code:

PaymentWizardsCollectionResponse result = check client->listPaymentWizards();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v2/$metadata#PaymentWizards",
  "value": [
    {
      "IdNumber": 1,
      "WizardName": "July payment run",
      "OutgoingType": "pwt_Outgoing",
      "PmntDate": "2026-07-15",
      "CheckPaymentMethod": "pm_Check",
      "BankTransferPaymentMethod": "pm_BankTransfer"
    }
  ],
  "odata.nextLink": "PaymentWizards?$skip=20"
}

createPaymentWizards

Creates a new PaymentWizard entity and returns the created entity.

Parameters:

Name	Type	Required	Description
payload	PaymentWizard	Yes	The payment wizard to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: PaymentWizard|error

Sample code:

PaymentWizard result = check client->createPaymentWizards({wizardName: "July payment run", pmntDate: "2026-07-15"});

Sample response:

{
  "IdNumber": 1,
  "WizardName": "July payment run",
  "OutgoingType": "pwt_Outgoing",
  "PmntDate": "2026-07-15"
}

getPaymentWizards

Retrieves a single PaymentWizard entity by its IdNumber key.

Parameters:

Name	Type	Required	Description
idNumber	int:Signed32	Yes	Key property 'IdNumber' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetPaymentWizardsQueries	No	OData query options $expand and $select

Returns: PaymentWizard|error

Sample code:

PaymentWizard result = check client->getPaymentWizards(1);

Sample response:

{
  "IdNumber": 1,
  "WizardName": "July payment run",
  "OutgoingType": "pwt_Outgoing",
  "IncomingType": "pwt_Incoming",
  "PmntDate": "2026-07-15",
  "CheckPaymentMethod": "pm_Check"
}

deletePaymentWizards

Deletes a PaymentWizard entity identified by its IdNumber key; no content is returned on success.

Parameters:

Name	Type	Required	Description
idNumber	int:Signed32	Yes	Key property 'IdNumber' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentWizards(1);

updatePaymentWizards

Partially updates a PaymentWizard entity (PATCH/MERGE semantics) identified by its IdNumber key; no content is returned on success.

Parameters:

Name	Type	Required	Description
idNumber	int:Signed32	Yes	Key property 'IdNumber' (Edm.Int32)
payload	PaymentWizard	Yes	The payment wizard fields to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentWizards(1, {wizardName: "Updated wizard name"});

BOEPortfolios

listBOEPortfolios

Queries the BOEPortfolios collection and returns a page of bill of exchange portfolio entities.

Parameters:

Name	Type	Required	Description
headers	ListBOEPortfoliosHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListBOEPortfoliosQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: BOEPortfoliosCollectionResponse|error

Sample code:

BOEPortfoliosCollectionResponse response = check client->listBOEPortfolios();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#BOEPortfolios",
  "value": [
    {
      "PortfolioEntry": 1,
      "PortfolioNum": "P001",
      "PortfolioID": "PF-01",
      "PortfolioDescription": "Main BOE portfolio",
      "PortfolioCode": "MAIN"
    }
  ],
  "odata.nextLink": "BOEPortfolios?$skip=20"
}

createBOEPortfolios

Creates a new bill of exchange portfolio entity.

Parameters:

Name	Type	Required	Description
payload	BOEPortfolio	Yes	The BOEPortfolio entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: BOEPortfolio|error

Sample code:

BOEPortfolio created = check client->createBOEPortfolios({portfolioNum: "P002", portfolioDescription: "Discount portfolio"});

Sample response:

{
  "PortfolioEntry": 2,
  "PortfolioNum": "P002",
  "PortfolioID": "PF-02",
  "PortfolioDescription": "Discount portfolio",
  "PortfolioCode": "DISC"
}

getBOEPortfolios

Retrieves a single BOEPortfolio entity by its key.

Parameters:

Name	Type	Required	Description
portfolioEntry	int:Signed32	Yes	Key property 'PortfolioEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetBOEPortfoliosQueries	No	OData query options such as $expand and $select

Returns: BOEPortfolio|error

Sample code:

BOEPortfolio portfolio = check client->getBOEPortfolios(1);

Sample response:

{
  "PortfolioEntry": 1,
  "PortfolioNum": "P001",
  "PortfolioID": "PF-01",
  "PortfolioDescription": "Main BOE portfolio",
  "PortfolioCode": "MAIN"
}

deleteBOEPortfolios

Deletes a BOEPortfolio entity identified by its key; no content is returned on success.

Parameters:

Name	Type	Required	Description
portfolioEntry	int:Signed32	Yes	Key property 'PortfolioEntry' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBOEPortfolios(1);

updateBOEPortfolios

Partially updates a BOEPortfolio entity using PATCH/MERGE semantics; no content is returned on success.

Parameters:

Name	Type	Required	Description
portfolioEntry	int:Signed32	Yes	Key property 'PortfolioEntry' (Edm.Int32)
payload	BOEPortfolio	Yes	The fields of the BOEPortfolio to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBOEPortfolios(1, {portfolioDescription: "Updated description"});

bOEPortfoliosServiceGetBOEPortfolioList

Invokes the BOEPortfoliosService_GetBOEPortfolioList service operation to retrieve the list of BOE portfolios.

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->bOEPortfoliosServiceGetBOEPortfolioList();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#Collection(SAPB1.BOEPortfolioParams)",
  "value": [
    {
      "PortfolioID": "PF-01",
      "PortfolioEntry": 1,
      "PortfolioCode": "MAIN"
    }
  ]
}

Banks

listBanks

Queries the Banks collection and returns a page of bank entities.

Parameters:

Name	Type	Required	Description
headers	ListBanksHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListBanksQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: BanksCollectionResponse|error

Sample code:

BanksCollectionResponse response = check client->listBanks();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#Banks",
  "value": [
    {
      "BankCode": "BNK01",
      "BankName": "First National Bank",
      "NextCheckNumber": 1001,
      "SwiftNo": "FNBKUS33",
      "IBAN": "US12345678901234567890",
      "CountryCode": "US",
      "PostOffice": "tNO",
      "AbsoluteEntry": 1,
      "DigitalPayments": "tNO"
    }
  ],
  "odata.nextLink": "Banks?$skip=20"
}

createBanks

Creates a new Bank entity.

Parameters:

Name	Type	Required	Description
payload	Bank	Yes	The Bank entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Bank|error

Sample code:

Bank created = check client->createBanks({BankCode: "BNK02", BankName: "Community Bank", CountryCode: "US"});

Sample response:

{
  "BankCode": "BNK02",
  "BankName": "Community Bank",
  "NextCheckNumber": 1,
  "CountryCode": "US",
  "PostOffice": "tNO",
  "AbsoluteEntry": 2,
  "DigitalPayments": "tNO"
}

getBanks

Retrieves a single Bank 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	GetBanksQueries	No	OData query options such as $expand and $select

Returns: Bank|error

Sample code:

Bank bank = check client->getBanks(1);

Sample response:

{
  "BankCode": "BNK01",
  "BankName": "First National Bank",
  "SwiftNo": "FNBKUS33",
  "IBAN": "US12345678901234567890",
  "CountryCode": "US",
  "AbsoluteEntry": 1
}

deleteBanks

Deletes a Bank 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->deleteBanks(2);

updateBanks

Partially updates a Bank 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	Bank	Yes	The fields of the Bank to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBanks(1, {BankName: "First National Bank Ltd."});

CreditCardPayments

listCreditCardPayments

Queries the CreditCardPayments collection and returns a page of credit card payment (due date) entities.

Parameters:

Name	Type	Required	Description
headers	ListCreditCardPaymentsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListCreditCardPaymentsQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: CreditCardPaymentsCollectionResponse|error

Sample code:

CreditCardPaymentsCollectionResponse response = check client->listCreditCardPayments();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#CreditCardPayments",
  "value": [
    {
      "DueDateCode": "MONTHLY",
      "DueDateName": "Monthly settlement",
      "DueDatesType": "ddtInDays",
      "PaymentAfterDays": 30,
      "PaymentAfterMonths": 0
    }
  ],
  "odata.nextLink": "CreditCardPayments?$skip=20"
}

createCreditCardPayments

Creates a new CreditCardPayment entity.

Parameters:

Name	Type	Required	Description
payload	CreditCardPayment	Yes	The CreditCardPayment entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreditCardPayment|error

Sample code:

CreditCardPayment created = check client->createCreditCardPayments({DueDateCode: "WEEKLY", DueDateName: "Weekly settlement"});

Sample response:

{
  "DueDateCode": "WEEKLY",
  "DueDateName": "Weekly settlement",
  "PaymentAfterDays": 7,
  "PaymentAfterMonths": 0
}

getCreditCardPayments

Retrieves a single CreditCardPayment entity by its key.

Parameters:

Name	Type	Required	Description
dueDateCode	string	Yes	Key property 'DueDateCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetCreditCardPaymentsQueries	No	OData query options such as $expand and $select

Returns: CreditCardPayment|error

Sample code:

CreditCardPayment payment = check client->getCreditCardPayments("MONTHLY");

Sample response:

{
  "DueDateCode": "MONTHLY",
  "DueDateName": "Monthly settlement",
  "DueDatesType": "ddtInDays",
  "PaymentAfterDays": 30
}

deleteCreditCardPayments

Deletes a CreditCardPayment entity identified by its key; no content is returned on success.

Parameters:

Name	Type	Required	Description
dueDateCode	string	Yes	Key property 'DueDateCode' (Edm.String)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteCreditCardPayments("WEEKLY");

updateCreditCardPayments

Partially updates a CreditCardPayment entity using PATCH/MERGE semantics; no content is returned on success.

Parameters:

Name	Type	Required	Description
dueDateCode	string	Yes	Key property 'DueDateCode' (Edm.String)
payload	CreditCardPayment	Yes	The fields of the CreditCardPayment to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateCreditCardPayments("MONTHLY", {PaymentAfterDays: 45});

CreditCards

listCreditCards

Queries the CreditCards collection and returns a page of credit card entities.

Parameters:

Name	Type	Required	Description
headers	ListCreditCardsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListCreditCardsQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: CreditCardsCollectionResponse|error

Sample code:

CreditCardsCollectionResponse response = check client->listCreditCards();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#CreditCards",
  "value": [
    {
      "CreditCardCode": 1,
      "CreditCardName": "Visa",
      "GLAccount": "_SYS00000000123",
      "Telephone": "555-0100",
      "CompanyID": "VISA-US",
      "CountryCode": "US"
    }
  ],
  "odata.nextLink": "CreditCards?$skip=20"
}

createCreditCards

Creates a new CreditCard entity.

Parameters:

Name	Type	Required	Description
payload	CreditCard	Yes	The CreditCard entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: CreditCard|error

Sample code:

CreditCard created = check client->createCreditCards({CreditCardName: "MasterCard", GLAccount: "_SYS00000000124"});

Sample response:

{
  "CreditCardCode": 2,
  "CreditCardName": "MasterCard",
  "GLAccount": "_SYS00000000124",
  "CountryCode": "US"
}

getCreditCards

Retrieves a single CreditCard entity by its key.

Parameters:

Name	Type	Required	Description
creditCardCode	int:Signed32	Yes	Key property 'CreditCardCode' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetCreditCardsQueries	No	OData query options such as $expand and $select

Returns: CreditCard|error

Sample code:

CreditCard card = check client->getCreditCards(1);

Sample response:

{
  "CreditCardCode": 1,
  "CreditCardName": "Visa",
  "GLAccount": "_SYS00000000123",
  "CompanyID": "VISA-US",
  "CountryCode": "US"
}

deleteCreditCards

Deletes a CreditCard entity identified by its key; no content is returned on success.

Parameters:

Name	Type	Required	Description
creditCardCode	int:Signed32	Yes	Key property 'CreditCardCode' (Edm.Int32)
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteCreditCards(2);

updateCreditCards

Partially updates a CreditCard entity using PATCH/MERGE semantics; no content is returned on success.

Parameters:

Name	Type	Required	Description
creditCardCode	int:Signed32	Yes	Key property 'CreditCardCode' (Edm.Int32)
payload	CreditCard	Yes	The fields of the CreditCard to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateCreditCards(1, {Telephone: "555-0199"});

HouseBankAccounts

listHouseBankAccounts

Queries the HouseBankAccounts collection and returns a page of house bank account entities.

Parameters:

Name	Type	Required	Description
headers	ListHouseBankAccountsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListHouseBankAccountsQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: HouseBankAccountsCollectionResponse|error

Sample code:

HouseBankAccountsCollectionResponse response = check client->listHouseBankAccounts();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#HouseBankAccounts",
  "value": [
    {
      "BankCode": "BNK01",
      "AccNo": "1234567890",
      "Branch": "Main",
      "NextCheckNo": 1001,
      "GLAccount": "_SYS00000000101",
      "Country": "US",
      "IBAN": "US12345678901234567890",
      "AbsoluteEntry": 1,
      "BankKey": 1
    }
  ],
  "odata.nextLink": "HouseBankAccounts?$skip=20"
}

createHouseBankAccounts

Creates a new HouseBankAccount entity.

Parameters:

Name	Type	Required	Description
payload	HouseBankAccount	Yes	The HouseBankAccount entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: HouseBankAccount|error

Sample code:

HouseBankAccount created = check client->createHouseBankAccounts({BankCode: "BNK01", AccNo: "9876543210", Branch: "Downtown", GLAccount: "_SYS00000000102"});

Sample response:

{
  "BankCode": "BNK01",
  "AccNo": "9876543210",
  "Branch": "Downtown",
  "GLAccount": "_SYS00000000102",
  "AbsoluteEntry": 2,
  "BankKey": 1
}

getHouseBankAccounts

Retrieves a single HouseBankAccount 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	GetHouseBankAccountsQueries	No	OData query options such as $expand and $select

Returns: HouseBankAccount|error

Sample code:

HouseBankAccount account = check client->getHouseBankAccounts(1);

Sample response:

{
  "BankCode": "BNK01",
  "AccNo": "1234567890",
  "Branch": "Main",
  "GLAccount": "_SYS00000000101",
  "IBAN": "US12345678901234567890",
  "AbsoluteEntry": 1,
  "BankKey": 1
}

deleteHouseBankAccounts

Deletes a HouseBankAccount 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->deleteHouseBankAccounts(2);

updateHouseBankAccounts

Partially updates a HouseBankAccount 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	HouseBankAccount	Yes	The fields of the HouseBankAccount to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateHouseBankAccounts(1, {Branch: "Head Office"});

IncomingPayments

listIncomingPayments

Queries the IncomingPayments collection and returns a page of incoming payment entities.

Parameters:

Name	Type	Required	Description
headers	ListIncomingPaymentsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListIncomingPaymentsQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: IncomingPaymentsCollectionResponse|error

Sample code:

IncomingPaymentsCollectionResponse response = check client->listIncomingPayments();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#IncomingPayments",
  "value": [
    {
      "DocNum": 100,
      "DocType": "rCustomer",
      "DocDate": "2026-07-01",
      "CardCode": "C20000",
      "CardName": "Maxi-Teq",
      "DocCurrency": "USD",
      "CashSum": 1500.0
    }
  ],
  "odata.nextLink": "IncomingPayments?$skip=20"
}

createIncomingPayments

Creates a new incoming Payment entity.

Parameters:

Name	Type	Required	Description
payload	Payment	Yes	The Payment entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Payment|error

Sample code:

Payment created = check client->createIncomingPayments({CardCode: "C20000", DocDate: "2026-07-10", CashSum: 1500.0d, CashAccount: "_SYS00000000301"});

Sample response:

{
  "DocNum": 101,
  "DocType": "rCustomer",
  "DocDate": "2026-07-10",
  "CardCode": "C20000",
  "CardName": "Maxi-Teq",
  "CashAccount": "_SYS00000000301",
  "DocCurrency": "USD",
  "CashSum": 1500.0
}

getIncomingPayments

Retrieves a single incoming Payment 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	GetIncomingPaymentsQueries	No	OData query options such as $expand and $select

Returns: Payment|error

Sample code:

Payment payment = check client->getIncomingPayments(101);

Sample response:

{
  "DocNum": 101,
  "DocType": "rCustomer",
  "DocDate": "2026-07-10",
  "CardCode": "C20000",
  "CardName": "Maxi-Teq",
  "DocCurrency": "USD",
  "CashSum": 1500.0
}

deleteIncomingPayments

Deletes an incoming Payment 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->deleteIncomingPayments(101);

updateIncomingPayments

Partially updates an incoming Payment 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	Payment	Yes	The fields of the Payment to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateIncomingPayments(101, {Remarks: "Adjusted payment"});

incomingPaymentsCancel

Invokes the bound action 'Cancel' on an incoming payment (binding type Payment); 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->incomingPaymentsCancel(101);

incomingPaymentsCancelbyCurrentSystemDate

Invokes the bound action 'CancelbyCurrentSystemDate' on an incoming payment (binding type Payment), cancelling it using the current system date; 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->incomingPaymentsCancelbyCurrentSystemDate(101);

incomingPaymentsGetApprovalTemplates

Invokes the bound action 'GetApprovalTemplates' on an incoming payment (binding type Payment) and returns the function result.

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: Payment|error

Sample code:

Payment result = check client->incomingPaymentsGetApprovalTemplates(101);

Sample response:

{
  "DocNum": 101,
  "DocType": "rCustomer",
  "CardCode": "C20000",
  "DocDate": "2026-07-10"
}

incomingPaymentsRequestApproveCancellation

Invokes the bound action 'RequestApproveCancellation' on an incoming payment (binding type Payment); 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->incomingPaymentsRequestApproveCancellation(101);

incomingPaymentsSaveDraftToDocument

Invokes the bound action 'SaveDraftToDocument' on an incoming payment (binding type Payment), saving a draft as a document; 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->incomingPaymentsSaveDraftToDocument(101);

incomingPaymentsServiceHandleApprovalRequest

Invokes the IncomingPaymentsService_HandleApprovalRequest service operation to handle an approval request; no content is returned on success.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->incomingPaymentsServiceHandleApprovalRequest();

PaymentRunExport

listPaymentRunExport

Queries the PaymentRunExport collection and returns a page of payment run export entities.

Parameters:

Name	Type	Required	Description
headers	ListPaymentRunExportHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListPaymentRunExportQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: PaymentRunExportCollectionResponse|error

Sample code:

PaymentRunExportCollectionResponse response = check client->listPaymentRunExport();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#PaymentRunExport",
  "value": [
    {
      "AbsoluteEntry": 1,
      "RunDate": "2026-07-01",
      "VendorNum": "V10000",
      "PaymentMethod": "OutWire",
      "DocNum": 500,
      "PayeeName": "Acme Supplies",
      "Currency": "USD",
      "DocAmountLocal": 2500.0
    }
  ],
  "odata.nextLink": "PaymentRunExport?$skip=20"
}

createPaymentRunExport

Creates a new PaymentRunExport entity.

Parameters:

Name	Type	Required	Description
payload	PaymentRunExport	Yes	The PaymentRunExport entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: PaymentRunExport|error

Sample code:

PaymentRunExport created = check client->createPaymentRunExport({RunDate: "2026-07-10", VendorNum: "V10000", PaymentMethod: "OutWire"});

Sample response:

{
  "AbsoluteEntry": 2,
  "RunDate": "2026-07-10",
  "VendorNum": "V10000",
  "PaymentMethod": "OutWire",
  "Currency": "USD"
}

getPaymentRunExport

Retrieves a single PaymentRunExport 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	GetPaymentRunExportQueries	No	OData query options such as $expand and $select

Returns: PaymentRunExport|error

Sample code:

PaymentRunExport export = check client->getPaymentRunExport(1);

Sample response:

{
  "AbsoluteEntry": 1,
  "RunDate": "2026-07-01",
  "VendorNum": "V10000",
  "PaymentMethod": "OutWire",
  "PayeeName": "Acme Supplies",
  "Currency": "USD",
  "DocAmountLocal": 2500.0
}

deletePaymentRunExport

Deletes a PaymentRunExport 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->deletePaymentRunExport(2);

updatePaymentRunExport

Partially updates a PaymentRunExport 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	PaymentRunExport	Yes	The fields of the PaymentRunExport to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentRunExport(1, {PayeeName: "Acme Supplies Inc."});

VendorPayments

listVendorPayments

Queries the VendorPayments collection and returns a page of outgoing (vendor) payment entities.

Parameters:

Name	Type	Required	Description
headers	ListVendorPaymentsHeaders	No	Headers to be sent with the request, e.g. Prefer: odata.maxpagesize=100
queries	ListVendorPaymentsQueries	No	OData query options such as $top, $skip, $filter, $orderby, $expand, $inlinecount, and $select

Returns: VendorPaymentsCollectionResponse|error

Sample code:

VendorPaymentsCollectionResponse response = check client->listVendorPayments();

Sample response:

{
  "odata.metadata": "https://server:50000/b1s/v2/$metadata#VendorPayments",
  "value": [
    {
      "DocNum": 200,
      "DocType": "rSupplier",
      "DocDate": "2026-07-01",
      "CardCode": "V10000",
      "CardName": "Acme Supplies",
      "DocCurrency": "USD",
      "CashSum": 2500.0
    }
  ],
  "odata.nextLink": "VendorPayments?$skip=20"
}

createVendorPayments

Creates a new vendor Payment entity.

Parameters:

Name	Type	Required	Description
payload	Payment	Yes	The Payment entity to create
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: Payment|error

Sample code:

Payment created = check client->createVendorPayments({CardCode: "V10000", DocDate: "2026-07-10", CashSum: 2500.0d, CashAccount: "_SYS00000000301"});

Sample response:

{
  "DocNum": 201,
  "DocType": "rSupplier",
  "DocDate": "2026-07-10",
  "CardCode": "V10000",
  "CardName": "Acme Supplies",
  "CashAccount": "_SYS00000000301",
  "DocCurrency": "USD",
  "CashSum": 2500.0
}

getVendorPayments

Retrieves a single vendor Payment 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	GetVendorPaymentsQueries	No	OData query options such as $expand and $select

Returns: Payment|error

Sample code:

Payment payment = check client->getVendorPayments(201);

Sample response:

{
  "DocNum": 201,
  "DocType": "rSupplier",
  "DocDate": "2026-07-10",
  "CardCode": "V10000",
  "CardName": "Acme Supplies",
  "DocCurrency": "USD",
  "CashSum": 2500.0
}

deleteVendorPayments

Deletes a vendor Payment 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->deleteVendorPayments(201);

updateVendorPayments

Partially updates a vendor Payment 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	Payment	Yes	The fields of the Payment to update
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateVendorPayments(201, {Remarks: "Corrected amount"});

vendorPaymentsCancel

Invokes the bound action 'Cancel' on a vendor payment (binding type Payment); 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->vendorPaymentsCancel(201);

vendorPaymentsCancelbyCurrentSystemDate

Invokes the bound action 'CancelbyCurrentSystemDate' on a vendor payment (binding type Payment), cancelling it using the current system date; 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->vendorPaymentsCancelbyCurrentSystemDate(201);

vendorPaymentsGetApprovalTemplates

Invokes the bound action 'GetApprovalTemplates' on a vendor payment (binding type Payment) and returns the function result.

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: Payment|error

Sample code:

Payment result = check client->vendorPaymentsGetApprovalTemplates(201);

Sample response:

{
  "DocNum": 201,
  "DocType": "rSupplier",
  "CardCode": "V10000",
  "DocDate": "2026-07-10"
}

vendorPaymentsRequestApproveCancellation

Invokes the bound action 'RequestApproveCancellation' on a vendor payment (binding type Payment); 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->vendorPaymentsRequestApproveCancellation(201);

vendorPaymentsSaveDraftToDocument

Invokes the bound action 'SaveDraftToDocument' on a vendor payment (binding type Payment), saving a draft as a document; 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->vendorPaymentsSaveDraftToDocument(201);

vendorPaymentsServiceHandleApprovalRequest

Invokes the VendorPaymentsService_HandleApprovalRequest service operation to handle an approval request; no content is returned on success.

Parameters:

Name	Type	Required	Description
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->vendorPaymentsServiceHandleApprovalRequest();