Skip to main content

Actions

The ballerinax/sap.successfactors.ecpaymentinformation package exposes the following clients:

Available clients:

ClientPurpose
ClientManages ecpaymentinformation objects: PaymentInformationDetailV3KEN, PaymentInformationDetailV3ISR, PaymentInformationDetailV3, PaymentInformationDetailV3ARG, PaymentMethodV3, Bank, CustomPayTypeAssignment, CustomPayType…, over the SAP SuccessFactors OData v2 API.

Client​

You can use these APIs to maintain the country-dependent fields of payment information details for specific countries.

Configuration​

ConnectionConfig​

Provides a set of configurations for controlling the behaviours when communicating with the SAP SuccessFactors OData endpoint. Passed as the argument to the client initializer.

FieldTypeDefaultDescription
authhttp:CredentialsConfigRequiredConfigurations related to client authentication
httpVersionhttp:HttpVersionSee defaultThe HTTP version understood by the client
http1Settingshttp:ClientHttp1SettingsSee defaultConfigurations related to HTTP/1.x protocol
http2Settingshttp:ClientHttp2SettingsSee defaultConfigurations related to HTTP/2 protocol
timeoutdecimalSee defaultThe maximum time to wait (in seconds) for a response before closing the connection
forwardedstringSee defaultThe choice of setting forwarded/x-forwarded header
followRedirectshttp:FollowRedirectsOptionalConfigurations associated with Redirection
poolConfighttp:PoolConfigurationOptionalConfigurations associated with request pooling
cachehttp:CacheConfigSee defaultHTTP caching related configurations
compressionhttp:CompressionSee defaultSpecifies the way of handling compression (accept-encoding) header
circuitBreakerhttp:CircuitBreakerConfigOptionalConfigurations associated with the behaviour of the Circuit Breaker
retryConfighttp:RetryConfigOptionalConfigurations associated with retrying
cookieConfighttp:CookieConfigOptionalConfigurations associated with cookies
responseLimitshttp:ResponseLimitConfigsSee defaultConfigurations associated with inbound response size limits
secureSockethttp:ClientSecureSocketOptionalSSL/TLS-related options
proxyhttp:ProxyConfigOptionalProxy server related options
socketConfighttp:ClientSocketConfigSee defaultProvides settings related to client socket configuration
validationbooleanSee defaultEnables the inbound payload validation functionality which provided by the constraint package. Enabled by default
laxDataBindingbooleanSee defaultEnables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

The client also accepts a hostname string parameter (the SAP SuccessFactors API server host) and an optional port (defaults to 443).

Initializing the client​

import ballerinax/sap.successfactors.ecpaymentinformation;

configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

ecpaymentinformation:Client client = check new (
{
auth: { username, password }
},
hostname
);

Operations​

PaymentInformationDetailV3KEN​

listPaymentInformationDetailV3KENs

Queries the PaymentInformationDetailV3KEN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3KENsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3KENsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3KENsResponse result = check client->listPaymentInformationDetailV3KENs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3KEN

Creates a new PaymentInformationDetailV3KEN entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3KENYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3KEN&#124;error

Sample code:

CreatedPaymentInformationDetailV3KEN result = check client->createPaymentInformationDetailV3KEN(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3KEN

Retrieves a single PaymentInformationDetailV3KEN entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3KENQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3KEN&#124;error

Sample code:

PaymentInformationDetailV3KEN result = check client->getPaymentInformationDetailV3KEN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3KEN

Updates the PaymentInformationDetailV3KEN identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3KENYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3KEN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3KEN

Deletes the PaymentInformationDetailV3KEN identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3KENHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3KEN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3ISR​

listPaymentInformationDetailV3ISRs

Queries the PaymentInformationDetailV3ISR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3ISRsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3ISRsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3ISRsResponse result = check client->listPaymentInformationDetailV3ISRs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3ISR

Creates a new PaymentInformationDetailV3ISR entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3ISRYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3ISR&#124;error

Sample code:

CreatedPaymentInformationDetailV3ISR result = check client->createPaymentInformationDetailV3ISR(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3ISR

Retrieves a single PaymentInformationDetailV3ISR entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3ISRQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3ISR&#124;error

Sample code:

PaymentInformationDetailV3ISR result = check client->getPaymentInformationDetailV3ISR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3ISR

Updates the PaymentInformationDetailV3ISR identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3ISRYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3ISR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3ISR

Deletes the PaymentInformationDetailV3ISR identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3ISRHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3ISR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3​

listPaymentInformationDetailV3s

Queries the PaymentInformationDetailV3 collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3sQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3sResponse&#124;error

Sample code:

ListPaymentInformationDetailV3sResponse result = check client->listPaymentInformationDetailV3s();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3

Creates a new PaymentInformationDetailV3 entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3YesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3&#124;error

Sample code:

CreatedPaymentInformationDetailV3 result = check client->createPaymentInformationDetailV3(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3

Retrieves a single PaymentInformationDetailV3 entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3QueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3&#124;error

Sample code:

PaymentInformationDetailV3 result = check client->getPaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3

Updates the PaymentInformationDetailV3 identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3YesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3

Deletes the PaymentInformationDetailV3 identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3HeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3(PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3ARG​

listPaymentInformationDetailV3ARGs

Queries the PaymentInformationDetailV3ARG collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3ARGsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3ARGsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3ARGsResponse result = check client->listPaymentInformationDetailV3ARGs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3ARG

Creates a new PaymentInformationDetailV3ARG entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3ARGYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3ARG&#124;error

Sample code:

CreatedPaymentInformationDetailV3ARG result = check client->createPaymentInformationDetailV3ARG(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3ARG

Retrieves a single PaymentInformationDetailV3ARG entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3ARGQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3ARG&#124;error

Sample code:

PaymentInformationDetailV3ARG result = check client->getPaymentInformationDetailV3ARG(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3ARG

Updates the PaymentInformationDetailV3ARG identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3ARGYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3ARG(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3ARG

Deletes the PaymentInformationDetailV3ARG identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3ARGHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3ARG(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentMethodV3​

listPaymentMethodV3s

Queries the PaymentMethodV3 collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentMethodV3sQueriesNoQueries to be sent with the request

Returns: ListPaymentMethodV3sResponse&#124;error

Sample code:

ListPaymentMethodV3sResponse result = check client->listPaymentMethodV3s();

Sample response:

{
"d": {
"results": [
{
"externalCode": "1000",
"toPaymentMethodAssignmentV3": {}
}
]
}
}
createPaymentMethodV3

Creates a new PaymentMethodV3 entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentMethodV3YesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentMethodV3&#124;error

Sample code:

CreatedPaymentMethodV3 result = check client->createPaymentMethodV3(payload);

Sample response:

{
"d": {
"externalCode": "1000",
"toPaymentMethodAssignmentV3": {
"results": []
}
}
}
getPaymentMethodV3

Retrieves a single PaymentMethodV3 entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentMethodV3QueriesNoQueries to be sent with the request

Returns: PaymentMethodV3&#124;error

Sample code:

PaymentMethodV3 result = check client->getPaymentMethodV3(externalCode);

Sample response:

{
"externalCode": "1000",
"toPaymentMethodAssignmentV3": {
"results": [
{
"PaymentMethodV3_externalCode": "1000",
"externalCode": "1000"
}
]
}
}
updatePaymentMethodV3

Updates the PaymentMethodV3 identified by its key property with the supplied payload.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
payloadModifiedPaymentMethodV3YesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentMethodV3(externalCode, payload);
deletePaymentMethodV3

Deletes the PaymentMethodV3 identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeletePaymentMethodV3HeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentMethodV3(externalCode);

Bank​

listBanks

Queries the Bank collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListBanksQueriesNoQueries to be sent with the request

Returns: ListBanksResponse&#124;error

Sample code:

ListBanksResponse result = check client->listBanks();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createBank

Creates a new Bank entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadBankYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedBank&#124;error

Sample code:

CreatedBank result = check client->createBank(payload);

Sample response:

{
"d": {
"d": {}
}
}
getBank

Retrieves a single Bank entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetBankQueriesNoQueries to be sent with the request

Returns: Bank&#124;error

Sample code:

Bank result = check client->getBank(externalCode);

Sample response:

{
"d": {}
}
updateBank

Updates the Bank identified by its key property with the supplied payload.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
payloadModifiedBankYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateBank(externalCode, payload);
deleteBank

Deletes the Bank identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteBankHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteBank(externalCode);

CustomPayTypeAssignment​

listCustomPayTypeAssignments

Queries the CustomPayTypeAssignment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListCustomPayTypeAssignmentsQueriesNoQueries to be sent with the request

Returns: ListCustomPayTypeAssignmentsResponse&#124;error

Sample code:

ListCustomPayTypeAssignmentsResponse result = check client->listCustomPayTypeAssignments();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createCustomPayTypeAssignment

Creates a new CustomPayTypeAssignment entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadCustomPayTypeAssignmentYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedCustomPayTypeAssignment&#124;error

Sample code:

CreatedCustomPayTypeAssignment result = check client->createCustomPayTypeAssignment(payload);

Sample response:

{
"d": {
"d": {}
}
}
getCustomPayTypeAssignment

Retrieves a single CustomPayTypeAssignment entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
CustomPayType_externalCodestringYeskey: CustomPayType_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetCustomPayTypeAssignmentQueriesNoQueries to be sent with the request

Returns: CustomPayTypeAssignment&#124;error

Sample code:

CustomPayTypeAssignment result = check client->getCustomPayTypeAssignment(CustomPayType_externalCode, externalCode);

Sample response:

{
"d": {}
}
updateCustomPayTypeAssignment

Updates the CustomPayTypeAssignment identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
CustomPayType_externalCodestringYeskey: CustomPayType_externalCode
externalCodeintYeskey: externalCode
payloadModifiedCustomPayTypeAssignmentYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateCustomPayTypeAssignment(CustomPayType_externalCode, externalCode, payload);
deleteCustomPayTypeAssignment

Deletes the CustomPayTypeAssignment identified by its key properties.

Parameters:

NameTypeRequiredDescription
CustomPayType_externalCodestringYeskey: CustomPayType_externalCode
externalCodeintYeskey: externalCode
headersDeleteCustomPayTypeAssignmentHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteCustomPayTypeAssignment(CustomPayType_externalCode, externalCode);

CustomPayType​

listCustomPayTypes

Queries the CustomPayType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListCustomPayTypesQueriesNoQueries to be sent with the request

Returns: ListCustomPayTypesResponse&#124;error

Sample code:

ListCustomPayTypesResponse result = check client->listCustomPayTypes();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createCustomPayType

Creates a new CustomPayType entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadCustomPayTypeYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedCustomPayType&#124;error

Sample code:

CreatedCustomPayType result = check client->createCustomPayType(payload);

Sample response:

{
"d": {
"d": {}
}
}
getCustomPayType

Retrieves a single CustomPayType entity identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetCustomPayTypeQueriesNoQueries to be sent with the request

Returns: CustomPayType&#124;error

Sample code:

CustomPayType result = check client->getCustomPayType(externalCode);

Sample response:

{
"d": {}
}
updateCustomPayType

Updates the CustomPayType identified by its key property with the supplied payload.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
payloadModifiedCustomPayTypeYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateCustomPayType(externalCode, payload);
deleteCustomPayType

Deletes the CustomPayType identified by its key property.

Parameters:

NameTypeRequiredDescription
externalCodestringYeskey: externalCode
headersDeleteCustomPayTypeHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteCustomPayType(externalCode);

PaymentInformationDetailV3NGA​

listPaymentInformationDetailV3NGAs

Queries the PaymentInformationDetailV3NGA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3NGAsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3NGAsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3NGAsResponse result = check client->listPaymentInformationDetailV3NGAs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3NGA

Creates a new PaymentInformationDetailV3NGA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3NGAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3NGA&#124;error

Sample code:

CreatedPaymentInformationDetailV3NGA result = check client->createPaymentInformationDetailV3NGA(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3NGA

Retrieves a single PaymentInformationDetailV3NGA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3NGAQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3NGA&#124;error

Sample code:

PaymentInformationDetailV3NGA result = check client->getPaymentInformationDetailV3NGA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3NGA

Updates the PaymentInformationDetailV3NGA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3NGAYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3NGA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3NGA

Deletes the PaymentInformationDetailV3NGA identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3NGAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3NGA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3CZE​

listPaymentInformationDetailV3CZEs

Queries the PaymentInformationDetailV3CZE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3CZEsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3CZEsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3CZEsResponse result = check client->listPaymentInformationDetailV3CZEs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3CZE

Creates a new PaymentInformationDetailV3CZE entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3CZEYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3CZE&#124;error

Sample code:

CreatedPaymentInformationDetailV3CZE result = check client->createPaymentInformationDetailV3CZE(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3CZE

Retrieves a single PaymentInformationDetailV3CZE entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of the entity PaymentInformationV3_
externalCodeintYesthe externalCode of PaymentInformationDetailV3CZE
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3CZEQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3CZE&#124;error

Sample code:

PaymentInformationDetailV3CZE result = check client->getPaymentInformationDetailV3CZE(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3CZE

Updates the PaymentInformationDetailV3CZE identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesThe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesThe worker of entity PaymentInformationV3
externalCodeintYesThe externalCode of entity PaymentInformationDetailV3CZE
payloadModifiedPaymentInformationDetailV3CZEYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3CZE(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3CZE

Deletes the PaymentInformationDetailV3CZE identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of entity PaymentInformationV3
externalCodeintYesthe externalCode of entity PaymentInformationDetailV3CZE
headersDeletePaymentInformationDetailV3CZEHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3CZE(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationV3​

listPaymentInformationV3s

Queries the PaymentInformationV3 collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationV3sQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationV3sResponse&#124;error

Sample code:

ListPaymentInformationV3sResponse result = check client->listPaymentInformationV3s();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationV3

Creates a new PaymentInformationV3 entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationV3YesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationV3&#124;error

Sample code:

CreatedPaymentInformationV3 result = check client->createPaymentInformationV3(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationV3

Retrieves a single PaymentInformationV3 entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
effectiveStartDatestringYeskey: effectiveStartDate
'workerstringYeskey: worker
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationV3QueriesNoQueries to be sent with the request

Returns: PaymentInformationV3&#124;error

Sample code:

PaymentInformationV3 result = check client->getPaymentInformationV3(effectiveStartDate, 'worker);

Sample response:

{
"d": {}
}
updatePaymentInformationV3

Updates the PaymentInformationV3 identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
effectiveStartDatestringYeskey: effectiveStartDate
'workerstringYeskey: worker
payloadModifiedPaymentInformationV3YesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationV3(effectiveStartDate, 'worker, payload);
deletePaymentInformationV3

Deletes the PaymentInformationV3 identified by its key properties.

Parameters:

NameTypeRequiredDescription
effectiveStartDatestringYeskey: effectiveStartDate
'workerstringYeskey: worker
headersDeletePaymentInformationV3HeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationV3(effectiveStartDate, 'worker);

PaymentInformationDetailV3COL​

listPaymentInformationDetailV3COLs

Queries the PaymentInformationDetailV3COL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3COLsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3COLsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3COLsResponse result = check client->listPaymentInformationDetailV3COLs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3COL

Creates a new PaymentInformationDetailV3COL entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3COLYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3COL&#124;error

Sample code:

CreatedPaymentInformationDetailV3COL result = check client->createPaymentInformationDetailV3COL(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3COL

Retrieves a single PaymentInformationDetailV3COL entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3COLQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3COL&#124;error

Sample code:

PaymentInformationDetailV3COL result = check client->getPaymentInformationDetailV3COL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3COL

Updates the PaymentInformationDetailV3COL identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3COLYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3COL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3COL

Deletes the PaymentInformationDetailV3COL identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3COLHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3COL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3VEN​

listPaymentInformationDetailV3VENs

Queries the PaymentInformationDetailV3VEN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3VENsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3VENsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3VENsResponse result = check client->listPaymentInformationDetailV3VENs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3VEN

Creates a new PaymentInformationDetailV3VEN entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3VENYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3VEN&#124;error

Sample code:

CreatedPaymentInformationDetailV3VEN result = check client->createPaymentInformationDetailV3VEN(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3VEN

Retrieves a single PaymentInformationDetailV3VEN entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3VENQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3VEN&#124;error

Sample code:

PaymentInformationDetailV3VEN result = check client->getPaymentInformationDetailV3VEN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3VEN

Updates the PaymentInformationDetailV3VEN identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3VENYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3VEN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3VEN

Deletes the PaymentInformationDetailV3VEN identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3VENHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3VEN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3NZL​

listPaymentInformationDetailV3NZLs

Queries the PaymentInformationDetailV3NZL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3NZLsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3NZLsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3NZLsResponse result = check client->listPaymentInformationDetailV3NZLs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3NZL

Creates a new PaymentInformationDetailV3NZL entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3NZLYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3NZL&#124;error

Sample code:

CreatedPaymentInformationDetailV3NZL result = check client->createPaymentInformationDetailV3NZL(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3NZL

Retrieves a single PaymentInformationDetailV3NZL entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3NZLQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3NZL&#124;error

Sample code:

PaymentInformationDetailV3NZL result = check client->getPaymentInformationDetailV3NZL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3NZL

Updates the PaymentInformationDetailV3NZL identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3NZLYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3NZL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3NZL

Deletes the PaymentInformationDetailV3NZL identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3NZLHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3NZL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3USA​

listPaymentInformationDetailV3USAs

Queries the PaymentInformationDetailV3USA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3USAsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3USAsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3USAsResponse result = check client->listPaymentInformationDetailV3USAs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3USA

Creates a new PaymentInformationDetailV3USA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3USAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3USA&#124;error

Sample code:

CreatedPaymentInformationDetailV3USA result = check client->createPaymentInformationDetailV3USA(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3USA

Retrieves a single PaymentInformationDetailV3USA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3USAQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3USA&#124;error

Sample code:

PaymentInformationDetailV3USA result = check client->getPaymentInformationDetailV3USA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3USA

Updates the PaymentInformationDetailV3USA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3USAYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3USA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3USA

Deletes the PaymentInformationDetailV3USA identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3USAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3USA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3ECU​

listPaymentInformationDetailV3ECUs

Queries the PaymentInformationDetailV3ECU collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3ECUsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3ECUsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3ECUsResponse result = check client->listPaymentInformationDetailV3ECUs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3ECU

Creates a new PaymentInformationDetailV3ECU entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3ECUYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3ECU&#124;error

Sample code:

CreatedPaymentInformationDetailV3ECU result = check client->createPaymentInformationDetailV3ECU(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3ECU

Retrieves a single PaymentInformationDetailV3ECU entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3ECUQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3ECU&#124;error

Sample code:

PaymentInformationDetailV3ECU result = check client->getPaymentInformationDetailV3ECU(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3ECU

Updates the PaymentInformationDetailV3ECU identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3ECUYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3ECU(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3ECU

Deletes the PaymentInformationDetailV3ECU identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3ECUHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3ECU(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3GBR​

listPaymentInformationDetailV3GBRs

Queries the PaymentInformationDetailV3GBR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3GBRsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3GBRsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3GBRsResponse result = check client->listPaymentInformationDetailV3GBRs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3GBR

Creates a new PaymentInformationDetailV3GBR entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3GBRYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3GBR&#124;error

Sample code:

CreatedPaymentInformationDetailV3GBR result = check client->createPaymentInformationDetailV3GBR(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3GBR

Retrieves a single PaymentInformationDetailV3GBR entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3GBRQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3GBR&#124;error

Sample code:

PaymentInformationDetailV3GBR result = check client->getPaymentInformationDetailV3GBR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3GBR

Updates the PaymentInformationDetailV3GBR identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3GBRYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3GBR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3GBR

Deletes the PaymentInformationDetailV3GBR identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3GBRHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3GBR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3FRA​

listPaymentInformationDetailV3FRAs

Queries the PaymentInformationDetailV3FRA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3FRAsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3FRAsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3FRAsResponse result = check client->listPaymentInformationDetailV3FRAs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3FRA

Creates a new PaymentInformationDetailV3FRA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3FRAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3FRA&#124;error

Sample code:

CreatedPaymentInformationDetailV3FRA result = check client->createPaymentInformationDetailV3FRA(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3FRA

Retrieves a single PaymentInformationDetailV3FRA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3FRAQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3FRA&#124;error

Sample code:

PaymentInformationDetailV3FRA result = check client->getPaymentInformationDetailV3FRA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3FRA

Updates the PaymentInformationDetailV3FRA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3FRAYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3FRA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3FRA

Deletes the PaymentInformationDetailV3FRA identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3FRAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3FRA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentMethodAssignmentV3​

listPaymentMethodAssignmentV3s

Queries the PaymentMethodAssignmentV3 collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentMethodAssignmentV3sQueriesNoQueries to be sent with the request

Returns: ListPaymentMethodAssignmentV3sResponse&#124;error

Sample code:

ListPaymentMethodAssignmentV3sResponse result = check client->listPaymentMethodAssignmentV3s();

Sample response:

{
"d": {
"results": [
{
"PaymentMethodV3_externalCode": "1000",
"externalCode": "1000"
}
]
}
}
createPaymentMethodAssignmentV3

Creates a new PaymentMethodAssignmentV3 entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentMethodAssignmentV3YesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentMethodAssignmentV3&#124;error

Sample code:

CreatedPaymentMethodAssignmentV3 result = check client->createPaymentMethodAssignmentV3(payload);

Sample response:

{
"d": {
"PaymentMethodV3_externalCode": "1000",
"externalCode": "1000"
}
}
getPaymentMethodAssignmentV3

Retrieves a single PaymentMethodAssignmentV3 entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentMethodV3_externalCodestringYeskey: PaymentMethodV3_externalCode
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentMethodAssignmentV3QueriesNoQueries to be sent with the request

Returns: PaymentMethodAssignmentV3&#124;error

Sample code:

PaymentMethodAssignmentV3 result = check client->getPaymentMethodAssignmentV3(PaymentMethodV3_externalCode, externalCode);

Sample response:

{
"PaymentMethodV3_externalCode": "1000",
"externalCode": "1000"
}
updatePaymentMethodAssignmentV3

Updates the PaymentMethodAssignmentV3 identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentMethodV3_externalCodestringYeskey: PaymentMethodV3_externalCode
externalCodeintYeskey: externalCode
payloadModifiedPaymentMethodAssignmentV3YesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentMethodAssignmentV3(PaymentMethodV3_externalCode, externalCode, payload);
deletePaymentMethodAssignmentV3

Deletes the PaymentMethodAssignmentV3 identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentMethodV3_externalCodestringYeskey: PaymentMethodV3_externalCode
externalCodeintYeskey: externalCode
headersDeletePaymentMethodAssignmentV3HeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentMethodAssignmentV3(PaymentMethodV3_externalCode, externalCode);

PaymentInformationDetailV3JPN​

listPaymentInformationDetailV3JPNs

Queries the PaymentInformationDetailV3JPN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3JPNsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3JPNsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3JPNsResponse result = check client->listPaymentInformationDetailV3JPNs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3JPN

Creates a new PaymentInformationDetailV3JPN entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3JPNYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3JPN&#124;error

Sample code:

CreatedPaymentInformationDetailV3JPN result = check client->createPaymentInformationDetailV3JPN(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3JPN

Retrieves a single PaymentInformationDetailV3JPN entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3JPNQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3JPN&#124;error

Sample code:

PaymentInformationDetailV3JPN result = check client->getPaymentInformationDetailV3JPN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3JPN

Updates the PaymentInformationDetailV3JPN identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3JPNYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3JPN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3JPN

Deletes the PaymentInformationDetailV3JPN identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3JPNHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3JPN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3ZAF​

listPaymentInformationDetailV3ZAFs

Queries the PaymentInformationDetailV3ZAF collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3ZAFsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3ZAFsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3ZAFsResponse result = check client->listPaymentInformationDetailV3ZAFs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3ZAF

Creates a new PaymentInformationDetailV3ZAF entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3ZAFYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3ZAF&#124;error

Sample code:

CreatedPaymentInformationDetailV3ZAF result = check client->createPaymentInformationDetailV3ZAF(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3ZAF

Retrieves a single PaymentInformationDetailV3ZAF entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3ZAFQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3ZAF&#124;error

Sample code:

PaymentInformationDetailV3ZAF result = check client->getPaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3ZAF

Updates the PaymentInformationDetailV3ZAF identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3ZAFYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3ZAF

Deletes the PaymentInformationDetailV3ZAF identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3ZAFHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3ZAF(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3ITA​

listPaymentInformationDetailV3ITAs

Queries the PaymentInformationDetailV3ITA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3ITAsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3ITAsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3ITAsResponse result = check client->listPaymentInformationDetailV3ITAs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3ITA

Creates a new PaymentInformationDetailV3ITA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3ITAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3ITA&#124;error

Sample code:

CreatedPaymentInformationDetailV3ITA result = check client->createPaymentInformationDetailV3ITA(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3ITA

Retrieves a single PaymentInformationDetailV3ITA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3ITAQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3ITA&#124;error

Sample code:

PaymentInformationDetailV3ITA result = check client->getPaymentInformationDetailV3ITA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3ITA

Updates the PaymentInformationDetailV3ITA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3ITAYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3ITA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3ITA

Deletes the PaymentInformationDetailV3ITA identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3ITAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3ITA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3MEX​

listPaymentInformationDetailV3MEXs

Queries the PaymentInformationDetailV3MEX collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3MEXsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3MEXsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3MEXsResponse result = check client->listPaymentInformationDetailV3MEXs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3MEX

Creates a new PaymentInformationDetailV3MEX entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3MEXYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3MEX&#124;error

Sample code:

CreatedPaymentInformationDetailV3MEX result = check client->createPaymentInformationDetailV3MEX(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3MEX

Retrieves a single PaymentInformationDetailV3MEX entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3MEXQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3MEX&#124;error

Sample code:

PaymentInformationDetailV3MEX result = check client->getPaymentInformationDetailV3MEX(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3MEX

Updates the PaymentInformationDetailV3MEX identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3MEXYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3MEX(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3MEX

Deletes the PaymentInformationDetailV3MEX identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3MEXHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3MEX(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3ESP​

listPaymentInformationDetailV3ESPs

Queries the PaymentInformationDetailV3ESP collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3ESPsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3ESPsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3ESPsResponse result = check client->listPaymentInformationDetailV3ESPs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3ESP

Creates a new PaymentInformationDetailV3ESP entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3ESPYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3ESP&#124;error

Sample code:

CreatedPaymentInformationDetailV3ESP result = check client->createPaymentInformationDetailV3ESP(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3ESP

Retrieves a single PaymentInformationDetailV3ESP entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3ESPQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3ESP&#124;error

Sample code:

PaymentInformationDetailV3ESP result = check client->getPaymentInformationDetailV3ESP(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3ESP

Updates the PaymentInformationDetailV3ESP identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3ESPYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3ESP(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3ESP

Deletes the PaymentInformationDetailV3ESP identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3ESPHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3ESP(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3BRA​

listPaymentInformationDetailV3BRAs

Queries the PaymentInformationDetailV3BRA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3BRAsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3BRAsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3BRAsResponse result = check client->listPaymentInformationDetailV3BRAs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3BRA

Creates a new PaymentInformationDetailV3BRA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3BRAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3BRA&#124;error

Sample code:

CreatedPaymentInformationDetailV3BRA result = check client->createPaymentInformationDetailV3BRA(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3BRA

Retrieves a single PaymentInformationDetailV3BRA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3BRAQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3BRA&#124;error

Sample code:

PaymentInformationDetailV3BRA result = check client->getPaymentInformationDetailV3BRA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3BRA

Updates the PaymentInformationDetailV3BRA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3BRAYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3BRA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3BRA

Deletes the PaymentInformationDetailV3BRA identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3BRAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3BRA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3CHL​

listPaymentInformationDetailV3CHLs

Queries the PaymentInformationDetailV3CHL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3CHLsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3CHLsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3CHLsResponse result = check client->listPaymentInformationDetailV3CHLs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3CHL

Creates a new PaymentInformationDetailV3CHL entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3CHLYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3CHL&#124;error

Sample code:

CreatedPaymentInformationDetailV3CHL result = check client->createPaymentInformationDetailV3CHL(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3CHL

Retrieves a single PaymentInformationDetailV3CHL entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3CHLQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3CHL&#124;error

Sample code:

PaymentInformationDetailV3CHL result = check client->getPaymentInformationDetailV3CHL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3CHL

Updates the PaymentInformationDetailV3CHL identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3CHLYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3CHL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3CHL

Deletes the PaymentInformationDetailV3CHL identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3CHLHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3CHL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3BLR​

listPaymentInformationDetailV3BLRs

Queries the PaymentInformationDetailV3BLR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3BLRsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3BLRsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3BLRsResponse result = check client->listPaymentInformationDetailV3BLRs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3BLR

Creates a new PaymentInformationDetailV3BLR entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3BLRYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3BLR&#124;error

Sample code:

CreatedPaymentInformationDetailV3BLR result = check client->createPaymentInformationDetailV3BLR(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3BLR

Retrieves a single PaymentInformationDetailV3BLR entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3BLRQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3BLR&#124;error

Sample code:

PaymentInformationDetailV3BLR result = check client->getPaymentInformationDetailV3BLR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3BLR

Updates the PaymentInformationDetailV3BLR identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3BLRYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3BLR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3BLR

Deletes the PaymentInformationDetailV3BLR identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3BLRHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3BLR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3IRQ​

listPaymentInformationDetailV3IRQs

Queries the PaymentInformationDetailV3IRQ collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3IRQsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3IRQsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3IRQsResponse result = check client->listPaymentInformationDetailV3IRQs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3IRQ

Creates a new PaymentInformationDetailV3IRQ entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3IRQYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3IRQ&#124;error

Sample code:

CreatedPaymentInformationDetailV3IRQ result = check client->createPaymentInformationDetailV3IRQ(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3IRQ

Retrieves a single PaymentInformationDetailV3IRQ entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3IRQQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3IRQ&#124;error

Sample code:

PaymentInformationDetailV3IRQ result = check client->getPaymentInformationDetailV3IRQ(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3IRQ

Updates the PaymentInformationDetailV3IRQ identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3IRQYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3IRQ(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3IRQ

Deletes the PaymentInformationDetailV3IRQ identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3IRQHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3IRQ(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3MMR​

listPaymentInformationDetailV3MMRs

Queries the PaymentInformationDetailV3MMR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3MMRsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3MMRsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3MMRsResponse result = check client->listPaymentInformationDetailV3MMRs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3MMR

Creates a new PaymentInformationDetailV3MMR entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3MMRYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3MMR&#124;error

Sample code:

CreatedPaymentInformationDetailV3MMR result = check client->createPaymentInformationDetailV3MMR(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3MMR

Retrieves a single PaymentInformationDetailV3MMR entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3MMRQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3MMR&#124;error

Sample code:

PaymentInformationDetailV3MMR result = check client->getPaymentInformationDetailV3MMR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3MMR

Updates the PaymentInformationDetailV3MMR identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3MMRYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3MMR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3MMR

Deletes the PaymentInformationDetailV3MMR identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3MMRHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3MMR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3MWI​

listPaymentInformationDetailV3MWIs

Queries the PaymentInformationDetailV3MWI collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3MWIsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3MWIsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3MWIsResponse result = check client->listPaymentInformationDetailV3MWIs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3MWI

Creates a new PaymentInformationDetailV3MWI entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3MWIYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3MWI&#124;error

Sample code:

CreatedPaymentInformationDetailV3MWI result = check client->createPaymentInformationDetailV3MWI(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3MWI

Retrieves a single PaymentInformationDetailV3MWI entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3MWIQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3MWI&#124;error

Sample code:

PaymentInformationDetailV3MWI result = check client->getPaymentInformationDetailV3MWI(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3MWI

Updates the PaymentInformationDetailV3MWI identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3MWIYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3MWI(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3MWI

Deletes the PaymentInformationDetailV3MWI identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3MWIHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3MWI(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3NAM​

listPaymentInformationDetailV3NAMs

Queries the PaymentInformationDetailV3NAM collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3NAMsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3NAMsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3NAMsResponse result = check client->listPaymentInformationDetailV3NAMs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3NAM

Creates a new PaymentInformationDetailV3NAM entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3NAMYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3NAM&#124;error

Sample code:

CreatedPaymentInformationDetailV3NAM result = check client->createPaymentInformationDetailV3NAM(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3NAM

Retrieves a single PaymentInformationDetailV3NAM entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3NAMQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3NAM&#124;error

Sample code:

PaymentInformationDetailV3NAM result = check client->getPaymentInformationDetailV3NAM(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3NAM

Updates the PaymentInformationDetailV3NAM identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3NAMYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3NAM(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3NAM

Deletes the PaymentInformationDetailV3NAM identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3NAMHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3NAM(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3PER​

listPaymentInformationDetailV3PERs

Queries the PaymentInformationDetailV3PER collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3PERsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3PERsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3PERsResponse result = check client->listPaymentInformationDetailV3PERs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3PER

Creates a new PaymentInformationDetailV3PER entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3PERYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3PER&#124;error

Sample code:

CreatedPaymentInformationDetailV3PER result = check client->createPaymentInformationDetailV3PER(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3PER

Retrieves a single PaymentInformationDetailV3PER entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3PERQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3PER&#124;error

Sample code:

PaymentInformationDetailV3PER result = check client->getPaymentInformationDetailV3PER(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3PER

Updates the PaymentInformationDetailV3PER identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3PERYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3PER(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3PER

Deletes the PaymentInformationDetailV3PER identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3PERHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3PER(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3ZWE​

listPaymentInformationDetailV3ZWEs

Queries the PaymentInformationDetailV3ZWE collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3ZWEsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3ZWEsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3ZWEsResponse result = check client->listPaymentInformationDetailV3ZWEs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3ZWE

Creates a new PaymentInformationDetailV3ZWE entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3ZWEYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3ZWE&#124;error

Sample code:

CreatedPaymentInformationDetailV3ZWE result = check client->createPaymentInformationDetailV3ZWE(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3ZWE

Retrieves a single PaymentInformationDetailV3ZWE entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3ZWEQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3ZWE&#124;error

Sample code:

PaymentInformationDetailV3ZWE result = check client->getPaymentInformationDetailV3ZWE(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3ZWE

Updates the PaymentInformationDetailV3ZWE identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3ZWEYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3ZWE(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3ZWE

Deletes the PaymentInformationDetailV3ZWE identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3ZWEHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3ZWE(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3SVN​

listPaymentInformationDetailV3SVNs

Queries the PaymentInformationDetailV3SVN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3SVNsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3SVNsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3SVNsResponse result = check client->listPaymentInformationDetailV3SVNs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3SVN

Creates a new PaymentInformationDetailV3SVN entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3SVNYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3SVN&#124;error

Sample code:

CreatedPaymentInformationDetailV3SVN result = check client->createPaymentInformationDetailV3SVN(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3SVN

Retrieves a single PaymentInformationDetailV3SVN entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3SVNQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3SVN&#124;error

Sample code:

PaymentInformationDetailV3SVN result = check client->getPaymentInformationDetailV3SVN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3SVN

Updates the PaymentInformationDetailV3SVN identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3SVNYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3SVN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3SVN

Deletes the PaymentInformationDetailV3SVN identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3SVNHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3SVN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3MKD​

listPaymentInformationDetailV3MKDs

Queries the PaymentInformationDetailV3MKD collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3MKDsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3MKDsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3MKDsResponse result = check client->listPaymentInformationDetailV3MKDs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3MKD

Creates a new PaymentInformationDetailV3MKD entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3MKDYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3MKD&#124;error

Sample code:

CreatedPaymentInformationDetailV3MKD result = check client->createPaymentInformationDetailV3MKD(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3MKD

Retrieves a single PaymentInformationDetailV3MKD entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3MKDQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3MKD&#124;error

Sample code:

PaymentInformationDetailV3MKD result = check client->getPaymentInformationDetailV3MKD(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3MKD

Updates the PaymentInformationDetailV3MKD identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3MKDYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3MKD(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3MKD

Deletes the PaymentInformationDetailV3MKD identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3MKDHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3MKD(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3MOZ​

listPaymentInformationDetailV3MOZs

Queries the PaymentInformationDetailV3MOZ collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3MOZsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3MOZsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3MOZsResponse result = check client->listPaymentInformationDetailV3MOZs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3MOZ

Creates a new PaymentInformationDetailV3MOZ entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3MOZYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3MOZ&#124;error

Sample code:

CreatedPaymentInformationDetailV3MOZ result = check client->createPaymentInformationDetailV3MOZ(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3MOZ

Retrieves a single PaymentInformationDetailV3MOZ entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3MOZQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3MOZ&#124;error

Sample code:

PaymentInformationDetailV3MOZ result = check client->getPaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3MOZ

Updates the PaymentInformationDetailV3MOZ identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3MOZYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3MOZ

Deletes the PaymentInformationDetailV3MOZ identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3MOZHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3MOZ(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3GHA​

listPaymentInformationDetailV3GHAs

Queries the PaymentInformationDetailV3GHA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3GHAsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3GHAsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3GHAsResponse result = check client->listPaymentInformationDetailV3GHAs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3GHA

Creates a new PaymentInformationDetailV3GHA entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3GHAYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3GHA&#124;error

Sample code:

CreatedPaymentInformationDetailV3GHA result = check client->createPaymentInformationDetailV3GHA(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3GHA

Retrieves a single PaymentInformationDetailV3GHA entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3GHAQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3GHA&#124;error

Sample code:

PaymentInformationDetailV3GHA result = check client->getPaymentInformationDetailV3GHA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3GHA

Updates the PaymentInformationDetailV3GHA identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3GHAYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3GHA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3GHA

Deletes the PaymentInformationDetailV3GHA identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3GHAHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3GHA(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3SVK​

listPaymentInformationDetailV3SVKs

Queries the PaymentInformationDetailV3SVK collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3SVKsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3SVKsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3SVKsResponse result = check client->listPaymentInformationDetailV3SVKs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3SVK

Creates a new PaymentInformationDetailV3SVK entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3SVKYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3SVK&#124;error

Sample code:

CreatedPaymentInformationDetailV3SVK result = check client->createPaymentInformationDetailV3SVK(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3SVK

Retrieves a single PaymentInformationDetailV3SVK entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of entity PaymentInformationV3
externalCodeintYesthe externalCode of entity PaymentInformationDetailV3SVK
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3SVKQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3SVK&#124;error

Sample code:

PaymentInformationDetailV3SVK result = check client->getPaymentInformationDetailV3SVK(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3SVK

Updates the PaymentInformationDetailV3SVK identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of entity PaymentInformationV3
externalCodeintYesthe externalCode of entity PaymentInformationDetailV3SVK
payloadModifiedPaymentInformationDetailV3SVKYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3SVK(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3SVK

Deletes the PaymentInformationDetailV3SVK identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of entity PaymentInformationV3
externalCodeintYesthe externalCode of entity PaymentInformationDetailV3SVK
headersDeletePaymentInformationDetailV3SVKHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3SVK(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3TUN​

listPaymentInformationDetailV3TUNs

Queries the PaymentInformationDetailV3TUN collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3TUNsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3TUNsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3TUNsResponse result = check client->listPaymentInformationDetailV3TUNs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3TUN

Creates a new PaymentInformationDetailV3TUN entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3TUNYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3TUN&#124;error

Sample code:

CreatedPaymentInformationDetailV3TUN result = check client->createPaymentInformationDetailV3TUN(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3TUN

Retrieves a single PaymentInformationDetailV3TUN entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of entity PaymentInformationV3
externalCodeintYesthe externalCode of PaymentInformationDetailV3TUN
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3TUNQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3TUN&#124;error

Sample code:

PaymentInformationDetailV3TUN result = check client->getPaymentInformationDetailV3TUN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3TUN

Updates the PaymentInformationDetailV3TUN identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of entity PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of entity PaymentInformationV3
externalCodeintYesthe externalCode of entity PaymentInformationDetailV3TUN
payloadModifiedPaymentInformationDetailV3TUNYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3TUN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3TUN

Deletes the PaymentInformationDetailV3TUN identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYesthe externalCode of entity PaymentInformationDetailV3 of the associated entity PaymentInformation
PaymentInformationV3_effectiveStartDatestringYesthe effectiveStartDate of PaymentInformationV3
PaymentInformationV3_workerstringYesthe worker of PaymentInformationV3
externalCodeintYesthe externalCode of PaymentInformationDetailV3TUN
headersDeletePaymentInformationDetailV3TUNHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3TUN(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3SUR​

listPaymentInformationDetailV3SURs

Queries the PaymentInformationDetailV3SUR collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3SURsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3SURsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3SURsResponse result = check client->listPaymentInformationDetailV3SURs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3SUR

Creates a new PaymentInformationDetailV3SUR entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3SURYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3SUR&#124;error

Sample code:

CreatedPaymentInformationDetailV3SUR result = check client->createPaymentInformationDetailV3SUR(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3SUR

Retrieves a single PaymentInformationDetailV3SUR entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3SURQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3SUR&#124;error

Sample code:

PaymentInformationDetailV3SUR result = check client->getPaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3SUR

Updates the PaymentInformationDetailV3SUR identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3SURYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3SUR

Deletes the PaymentInformationDetailV3SUR identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3SURHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3SUR(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3PRY​

listPaymentInformationDetailV3PRYs

Queries the PaymentInformationDetailV3PRY collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3PRYsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3PRYsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3PRYsResponse result = check client->listPaymentInformationDetailV3PRYs();

Sample response:

{
"d": {
"results": [
{
"d": {}
}
]
}
}
createPaymentInformationDetailV3PRY

Creates a new PaymentInformationDetailV3PRY entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3PRYYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3PRY&#124;error

Sample code:

CreatedPaymentInformationDetailV3PRY result = check client->createPaymentInformationDetailV3PRY(payload);

Sample response:

{
"d": {
"d": {}
}
}
getPaymentInformationDetailV3PRY

Retrieves a single PaymentInformationDetailV3PRY entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3PRYQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3PRY&#124;error

Sample code:

PaymentInformationDetailV3PRY result = check client->getPaymentInformationDetailV3PRY(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"d": {}
}
updatePaymentInformationDetailV3PRY

Updates the PaymentInformationDetailV3PRY identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3PRYYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3PRY(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3PRY

Deletes the PaymentInformationDetailV3PRY identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3PRYHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3PRY(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

PaymentInformationDetailV3BOL​

listPaymentInformationDetailV3BOLs

Queries the PaymentInformationDetailV3BOL collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

NameTypeRequiredDescription
headersmap<string|string[]>NoHeaders to be sent with the request
queriesListPaymentInformationDetailV3BOLsQueriesNoQueries to be sent with the request

Returns: ListPaymentInformationDetailV3BOLsResponse&#124;error

Sample code:

ListPaymentInformationDetailV3BOLsResponse result = check client->listPaymentInformationDetailV3BOLs();

Sample response:

{
"d": {
"results": [
{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
]
}
}
createPaymentInformationDetailV3BOL

Creates a new PaymentInformationDetailV3BOL entity from the supplied payload.

Parameters:

NameTypeRequiredDescription
payloadPaymentInformationDetailV3BOLYesNew entity
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: CreatedPaymentInformationDetailV3BOL&#124;error

Sample code:

CreatedPaymentInformationDetailV3BOL result = check client->createPaymentInformationDetailV3BOL(payload);

Sample response:

{
"d": {
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
}
getPaymentInformationDetailV3BOL

Retrieves a single PaymentInformationDetailV3BOL entity identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetPaymentInformationDetailV3BOLQueriesNoQueries to be sent with the request

Returns: PaymentInformationDetailV3BOL&#124;error

Sample code:

PaymentInformationDetailV3BOL result = check client->getPaymentInformationDetailV3BOL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);

Sample response:

{
"PaymentInformationDetailV3_externalCode": "1000",
"PaymentInformationV3_effectiveStartDate": "2026-01-01",
"PaymentInformationV3_worker": "string",
"externalCode": "1000"
}
updatePaymentInformationDetailV3BOL

Updates the PaymentInformationDetailV3BOL identified by its key properties with the supplied payload.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
payloadModifiedPaymentInformationDetailV3BOLYesNew property values
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updatePaymentInformationDetailV3BOL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode, payload);
deletePaymentInformationDetailV3BOL

Deletes the PaymentInformationDetailV3BOL identified by its key properties.

Parameters:

NameTypeRequiredDescription
PaymentInformationDetailV3_externalCodeintYeskey: PaymentInformationDetailV3_externalCode
PaymentInformationV3_effectiveStartDatestringYeskey: PaymentInformationV3_effectiveStartDate
PaymentInformationV3_workerstringYeskey: PaymentInformationV3_worker
externalCodeintYeskey: externalCode
headersDeletePaymentInformationDetailV3BOLHeadersNoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deletePaymentInformationDetailV3BOL(PaymentInformationDetailV3_externalCode, PaymentInformationV3_effectiveStartDate, PaymentInformationV3_worker, externalCode);