Skip to main content

Actions

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

Available clients:

ClientPurpose
ClientManages SAP Business One country-specific and electronic document objects — electronic documents, file formats & communication; Brazil Nota Fiscal codes & indexers; India HSN/SAC codes & EWB transporters; Israel deduction documents; customs declarations & import/export determinations; DATEV runs, e-books & certificate series; self invoices & self credit memos; fiscal printer & local era settings — over the session-authenticated Service Layer (OData V3).

Client​

The Client provides access to the localization and electronic document objects exposed by the SAP Business One Service Layer — electronic documents, electronic file formats, and occurrence codes; Brazil Nota Fiscal CFOP/CST/usage codes, CEST/NCM code setup, and beverage/fuel/string/multi/numeric indexers; India HSN and SAC codes, and EWB transporters; Israel deduction (ISD) invoices, credit memos, and recipient invoices/credit memos; customs declarations, import and export determinations, and transportation documents; DATEV runs, e-books, certificate series, and BEM replication periods; self invoices and self credit memos; and fiscal printer, intrastat configuration, material/service groups, legal data, and local era settings.

Configuration​

SessionConfig​

SAP Business One Service Layer session credentials, passed as the first argument to the client initializer.

FieldTypeDefaultDescription
companyDbstringRequiredThe SAP Business One company database to log in to
usernamestringRequiredThe Service Layer user name
passwordstringRequiredThe Service Layer user password

ConnectionConfig​

Provides a set of configurations for controlling the behaviours when communicating with the Service Layer HTTP endpoint. Passed as the optional second argument to the client initializer.

FieldTypeDefaultDescription
httpVersionhttp:HttpVersionhttp:HTTP_2_0The HTTP version understood by the client
http1Settingshttp:ClientHttp1SettingsConfigurations related to HTTP/1.x protocol
http2Settingshttp:ClientHttp2SettingsConfigurations related to HTTP/2 protocol
timeoutdecimal30The maximum time to wait (in seconds) for a response before closing the connection
forwardedstring"disable"The choice of setting forwarded/x-forwarded header
followRedirectshttp:FollowRedirectsOptionalConfigurations associated with redirection
poolConfighttp:PoolConfigurationOptionalConfigurations associated with request pooling
cachehttp:CacheConfigHTTP caching related configurations
compressionhttp:Compressionhttp:COMPRESSION_AUTOSpecifies 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:ResponseLimitConfigsConfigurations associated with inbound response size limits
secureSockethttp:ClientSecureSocketOptionalSSL/TLS-related options
proxyhttp:ProxyConfigOptionalProxy server related options
socketConfighttp:ClientSocketConfigProvides settings related to client socket configuration
validationbooleantrueEnables the inbound payload validation functionality provided by the constraint package
laxDataBindingbooleantrueEnables relaxed data binding on the client side, treating nil values and absent fields as optional

The client also accepts a serviceUrl string parameter — the base URL of the target Service Layer instance — which defaults to https://localhost:50000/b1s/v1.

Initializing the client​

import ballerinax/sap.businessone;
import ballerinax/sap.businessone.localization;

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

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

Operations​

EWBTransporters​

eWBTransporterServiceGetEWBTransporterList

Invokes the EWBTransporterService_GetEWBTransporterList function import to retrieve the full list of e-way bill transporter master records.

Parameters:

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

Returns: inline_response_200_11|error

Sample code:

inline_response_200_11 result = check client->eWBTransporterServiceGetEWBTransporterList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#EWBTransporterService_GetEWBTransporterList",
  "value": [
    {
      "TransporterID": "T0001",
      "TransporterName": "ABC Transporters",
      "AbsEntry": 1,
      "TransporterCode": "TR01"
    }
  ]
}
listEWBTransporters

Queries the EWBTransporters collection and returns a paged list of e-way bill transporter records.

Parameters:

NameTypeRequiredDescription
headersListEWBTransportersHeadersNoHeaders to be sent with the request.
queriesListEWBTransportersQueriesNoQueries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select).

Returns: EWBTransportersCollectionResponse|error

Sample code:

EWBTransportersCollectionResponse result = check client->listEWBTransporters();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#EWBTransporters",
  "value": [
    {
      "TransporterID": "T0001",
      "TransporterName": "ABC Transporters",
      "AbsEntry": 1,
      "TransporterCode": "TR01",
      "EWBTransporter_Lines": [
        {
          "VehicleNo": "KA01AB1234",
          "Mode": 1,
          "VehicleType": "Regular",
          "AbsEntry": 1,
          "LineNumber": 0
        }
      ]
    }
  ],
  "odata.nextLink": "EWBTransporters?$skip=20"
}
createEWBTransporters

Creates a new EWBTransporter master record in the Service Layer.

Parameters:

NameTypeRequiredDescription
payloadEWBTransporterYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: EWBTransporter|error

Sample code:

EWBTransporter result = check client->createEWBTransporters(payload);

Sample response:

{
  "TransporterID": "T0001",
  "TransporterName": "ABC Transporters",
  "AbsEntry": 1,
  "TransporterCode": "TR01",
  "EWBTransporter_Lines": [
    {
      "VehicleNo": "KA01AB1234",
      "Mode": 1,
      "VehicleType": "Regular",
      "AbsEntry": 1,
      "LineNumber": 0
    }
  ]
}
getEWBTransporters

Retrieves a single EWBTransporter by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.
queriesGetEWBTransportersQueriesNoQueries to be sent with the request ($expand, $select).

Returns: EWBTransporter|error

Sample code:

EWBTransporter result = check client->getEWBTransporters(1);

Sample response:

{
  "TransporterID": "T0001",
  "TransporterName": "ABC Transporters",
  "AbsEntry": 1,
  "TransporterCode": "TR01"
}
deleteEWBTransporters

Deletes the EWBTransporter identified by AbsEntry.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->deleteEWBTransporters(1);
updateEWBTransporters

Partially updates an EWBTransporter using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
payloadEWBTransporterYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->updateEWBTransporters(1, payload);

IntrastatConfiguration​

listIntrastatConfiguration

Queries the IntrastatConfiguration collection and returns a paged list of Intrastat configuration records.

Parameters:

NameTypeRequiredDescription
headersListIntrastatConfigurationHeadersNoHeaders to be sent with the request.
queriesListIntrastatConfigurationQueriesNoQueries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select).

Returns: IntrastatConfigurationCollectionResponse|error

Sample code:

IntrastatConfigurationCollectionResponse result = check client->listIntrastatConfiguration();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#IntrastatConfiguration",
  "value": [
    {
      "PrcstVal": 100,
      "ConfType": "enCommodityCodes",
      "Import": "tYES",
      "AbsEntry": 1,
      "Descr": "Commodity Code Setup",
      "Code": "CC01",
      "SuppUnit": 0,
      "TriangDeal": "enNone",
      "DateFrom": "2026-01-01",
      "Export": "tYES",
      "Country": "DE",
      "ConfID": "CFG01",
      "StatCode": "ST01",
      "DateTo": "2026-12-31"
    }
  ],
  "odata.nextLink": "IntrastatConfiguration?$skip=20"
}
createIntrastatConfiguration

Creates a new IntrastatConfiguration record.

Parameters:

NameTypeRequiredDescription
payloadIntrastatConfigurationYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: IntrastatConfiguration|error

Sample code:

IntrastatConfiguration result = check client->createIntrastatConfiguration(payload);

Sample response:

{
  "PrcstVal": 100,
  "ConfType": "enCommodityCodes",
  "Import": "tYES",
  "AbsEntry": 1,
  "Descr": "Commodity Code Setup",
  "Code": "CC01",
  "SuppUnit": 0,
  "TriangDeal": "enNone",
  "DateFrom": "2026-01-01",
  "Export": "tYES",
  "Country": "DE",
  "ConfID": "CFG01",
  "StatCode": "ST01",
  "DateTo": "2026-12-31"
}
getIntrastatConfiguration

Retrieves a single IntrastatConfiguration record by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.
queriesGetIntrastatConfigurationQueriesNoQueries to be sent with the request ($expand, $select).

Returns: IntrastatConfiguration|error

Sample code:

IntrastatConfiguration result = check client->getIntrastatConfiguration(1);

Sample response:

{
  "PrcstVal": 100,
  "ConfType": "enCommodityCodes",
  "Import": "tYES",
  "AbsEntry": 1,
  "Descr": "Commodity Code Setup",
  "Code": "CC01",
  "SuppUnit": 0,
  "TriangDeal": "enNone",
  "DateFrom": "2026-01-01",
  "Export": "tYES",
  "Country": "DE",
  "ConfID": "CFG01",
  "StatCode": "ST01",
  "DateTo": "2026-12-31"
}
deleteIntrastatConfiguration

Deletes the IntrastatConfiguration record identified by AbsEntry.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->deleteIntrastatConfiguration(1);
updateIntrastatConfiguration

Partially updates an IntrastatConfiguration record using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
payloadIntrastatConfigurationYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->updateIntrastatConfiguration(1, payload);
intrastatConfigurationServiceGetList

Invokes the IntrastatConfigurationService_GetList function import to retrieve the list of Intrastat configuration parameter sets.

Parameters:

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

Returns: inline_response_200_36|error

Sample code:

inline_response_200_36 result = check client->intrastatConfigurationServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#IntrastatConfigurationService_GetList",
  "value": [
    {
      "ConfType": "enCommodityCodes",
      "DateFrom": "2026-01-01",
      "Country": "DE",
      "AbsEntry": 1,
      "StatCode": "ST01",
      "Code": "CC01",
      "DateTo": "2026-12-31"
    }
  ]
}

OccurrenceCodes​

listOccurrenceCodes

Queries the OccurrenceCodes collection and returns a paged list of bank collection occurrence codes.

Parameters:

NameTypeRequiredDescription
headersListOccurrenceCodesHeadersNoHeaders to be sent with the request.
queriesListOccurrenceCodesQueriesNoQueries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select).

Returns: OccurrenceCodesCollectionResponse|error

Sample code:

OccurrenceCodesCollectionResponse result = check client->listOccurrenceCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#OccurrenceCodes",
  "value": [
    {
      "RequestedBoeStatus": "boeSt_Open",
      "IsMovement": "tYES",
      "Description": "Payment confirmed",
      "Note": "Bank slip paid",
      "AbsEntry": 1,
      "Code": "OC01"
    }
  ],
  "odata.nextLink": "OccurrenceCodes?$skip=20"
}
createOccurrenceCodes

Creates a new OccurenceCode record.

Parameters:

NameTypeRequiredDescription
payloadOccurenceCodeYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: OccurenceCode|error

Sample code:

OccurenceCode result = check client->createOccurrenceCodes(payload);

Sample response:

{
  "RequestedBoeStatus": "boeSt_Open",
  "IsMovement": "tYES",
  "Description": "Payment confirmed",
  "Note": "Bank slip paid",
  "AbsEntry": 1,
  "Code": "OC01"
}
getOccurrenceCodes

Retrieves a single OccurenceCode by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.
queriesGetOccurrenceCodesQueriesNoQueries to be sent with the request ($expand, $select).

Returns: OccurenceCode|error

Sample code:

OccurenceCode result = check client->getOccurrenceCodes(1);

Sample response:

{
  "RequestedBoeStatus": "boeSt_Open",
  "IsMovement": "tYES",
  "Description": "Payment confirmed",
  "Note": "Bank slip paid",
  "AbsEntry": 1,
  "Code": "OC01"
}
deleteOccurrenceCodes

Deletes the OccurenceCode identified by AbsEntry.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->deleteOccurrenceCodes(1);
updateOccurrenceCodes

Partially updates an OccurenceCode using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32).
payloadOccurenceCodeYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->updateOccurrenceCodes(1, payload);
occurrenceCodesServiceGetList

Invokes the OccurrenceCodesService_GetList function import to retrieve the list of occurrence codes.

Parameters:

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

Returns: inline_response_200_41|error

Sample code:

inline_response_200_41 result = check client->occurrenceCodesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#OccurrenceCodesService_GetList",
  "value": [
    {
      "RequestedBoeStatus": "boeSt_Open",
      "IsMovement": "tYES",
      "Description": "Payment confirmed",
      "Note": "Bank slip paid",
      "AbsEntry": 1
    }
  ]
}

ElectronicDocuments​

electronicDocumentServiceAddEmergencyNumber

Adds an emergency number entry used for contingency electronic-document issuance.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_AddEmergencyNumber_bodyYesRequest payload wrapping an EmergencyNumber.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceAddEmergencyNumber(payload);
electronicDocumentServiceAddImportEntry

Adds an import entry to the electronic document framework for a contingency or imported document.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_AddImportEntry_bodyYesRequest payload wrapping an EDFImportEntry.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceAddImportEntry(payload);
electronicDocumentServiceAddLog

Adds a log entry to an electronic document entry's processing history.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_AddLog_bodyYesRequest payload wrapping an EDFEntryAddLogInputParams.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceAddLog(payload);
electronicDocumentServiceCreateEntry

Creates a new electronic document framework (EDF) entry.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_CreateEntry_bodyYesRequest payload wrapping an EDFEntry.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceCreateEntry(payload);
electronicDocumentServiceExportEntryLog

Exports the log data of an electronic document entry to a file.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_ExportEntryLog_bodyYesRequest payload wrapping an EDFEntryLogInputParams.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceExportEntryLog(payload);
electronicDocumentServiceGetDocMappingList

Retrieves the list of document type mappings configured for an electronic document protocol.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_GetDocMappingList_bodyYesRequest payload wrapping an EDFDocMappingInputParams (protocol Code and DocType).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: inline_response_200_18|error

Sample code:

inline_response_200_18 result = check client->electronicDocumentServiceGetDocMappingList(payload);

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicDocumentService_GetDocMappingList",
  "value": [
    {
      "Description": "AR Invoice",
      "ID": 1,
      "Name": "ARInvoice"
    }
  ]
}
electronicDocumentServiceGetEmergencyNumbers

Retrieves the list of configured emergency numbers for contingency issuance.

Parameters:

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

Returns: inline_response_200_19|error

Sample code:

inline_response_200_19 result = check client->electronicDocumentServiceGetEmergencyNumbers();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicDocumentService_GetEmergencyNumbers",
  "value": [
    {
      "Status": "Active",
      "Number": "0001",
      "AbsEntry": 1,
      "Code": "edpcs_GEN"
    }
  ]
}
electronicDocumentServiceGetEntry

Retrieves a single electronic document framework entry by GUID and protocol code.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_GetEntry_bodyYesRequest payload wrapping an EDFEntryInputParams (GUID, Code).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: EDFEntry|error

Sample code:

EDFEntry result = check client->electronicDocumentServiceGetEntry(payload);

Sample response:

{
  "AbsEntry": 1,
  "Code": "edpcs_GEN",
  "ParentAbsEntry": 0,
  "Type": "edetARInvoice",
  "Status": "edesSent",
  "BranchID": 1,
  "Description": "AR Invoice electronic document",
  "Submits": 1,
  "AssignedID": "DOC-0001",
  "IsRemoved": "tNO",
  "IsCancelation": "tNO",
  "CreateDate": "2026-07-01"
}
electronicDocumentServiceGetEntryList

Retrieves a filtered list of electronic document framework entries.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_GetEntryList_bodyYesRequest payload wrapping an EDFEntryListInputParams (MaxLines, FromEntryID, BranchID, etc).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: inline_response_200_20|error

Sample code:

inline_response_200_20 result = check client->electronicDocumentServiceGetEntryList(payload);

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicDocumentService_GetEntryList",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "edpcs_GEN",
      "Type": "edetARInvoice",
      "Status": "edesSent"
    }
  ]
}
electronicDocumentServiceGetLastLog

Retrieves the most recent log entry recorded for an electronic document entry.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_GetLastLog_bodyYesRequest payload wrapping an EDFEntryLogInputParams.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: EDFEntryLog|error

Sample code:

EDFEntryLog result = check client->electronicDocumentServiceGetLastLog(payload);

Sample response:

{
  "AbsEntry": 1,
  "LogNumber": 3,
  "LogType": "edeltSend",
  "LogMessage": "Document sent successfully",
  "LogOperationDate": "2026-07-10",
  "LogOperationTime": 930,
  "IsSensitive": "tNO"
}
electronicDocumentServiceGetLogs

Retrieves the full list of log entries recorded for an electronic document entry.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_GetLogs_bodyYesRequest payload wrapping an EDFEntryLogInputParams.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: inline_response_200_21|error

Sample code:

inline_response_200_21 result = check client->electronicDocumentServiceGetLogs(payload);

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicDocumentService_GetLogs",
  "value": [
    {
      "AbsEntry": 1,
      "LogNumber": 1,
      "LogType": "edeltSend",
      "LogMessage": "Document sent successfully"
    }
  ]
}
electronicDocumentServiceGetMappingByHash

Retrieves an electronic document format mapping by its hash value.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_GetMappingByHash_bodyYesRequest payload wrapping an EDFMappingInputParams (Hash).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: EDFMapping|error

Sample code:

EDFMapping result = check client->electronicDocumentServiceGetMappingByHash(payload);

Sample response:

{
  "Mapping": "<mapping/>",
  "Hash": "a1b2c3d4",
  "FormatID": 1,
  "Name": "ARInvoiceMapping"
}
electronicDocumentServiceGetProtocolParameter

Retrieves a single configuration parameter of an electronic document protocol.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_GetProtocolParameter_bodyYesRequest payload wrapping an EDFProtocolParameterInputParams (LineNum, Branch, Code).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: EDFProtocolParameter|error

Sample code:

EDFProtocolParameter result = check client->electronicDocumentServiceGetProtocolParameter(payload);

Sample response:

{
  "UserSignature": 1,
  "ParameterType": "String",
  "UIOrder": 1,
  "ParamValue": "https://endpoint.example.com",
  "BranchID": 1,
  "Code": "edpcs_GEN",
  "ParameterID": 1,
  "Visible": "tYES",
  "ParamName": "EndpointURL"
}
electronicDocumentServiceGetProtocols

Retrieves the list of all electronic document protocols configured in the system.

Parameters:

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

Returns: inline_response_200_22|error

Sample code:

inline_response_200_22 result = check client->electronicDocumentServiceGetProtocols();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicDocumentService_GetProtocols",
  "value": [
    {
      "Description": "Generic protocol",
      "IsActive": "tYES",
      "Code": "edpcs_GEN"
    }
  ]
}
electronicDocumentServiceUpdateEntry

Updates an existing electronic document framework entry.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_UpdateEntry_bodyYesRequest payload wrapping an EDFEntry.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceUpdateEntry(payload);
electronicDocumentServiceUpdateExtendedProperties

Updates the extended properties and parameter collection of an electronic document protocol.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_UpdateExtendedProperties_bodyYesRequest payload wrapping an EDFProtocolWithParameters.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceUpdateExtendedProperties(payload);
electronicDocumentServiceUpdateProtocolParameter

Updates a single configuration parameter of an electronic document protocol.

Parameters:

NameTypeRequiredDescription
payloadElectronicDocumentService_UpdateProtocolParameter_bodyYesRequest payload wrapping an EDFProtocolParameter.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->electronicDocumentServiceUpdateProtocolParameter(payload);
listElectronicDocuments

Queries the ElectronicDocuments collection and returns a paged list of electronic document protocols.

Parameters:

NameTypeRequiredDescription
headersListElectronicDocumentsHeadersNoHeaders to be sent with the request.
queriesListElectronicDocumentsQueriesNoQueries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select).

Returns: ElectronicDocumentsCollectionResponse|error

Sample code:

ElectronicDocumentsCollectionResponse result = check client->listElectronicDocuments();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicDocuments",
  "value": [
    {
      "Description": "Generic protocol",
      "IsActive": "tYES",
      "Code": "edpcs_GEN"
    }
  ],
  "odata.nextLink": "ElectronicDocuments?$skip=20"
}
createElectronicDocuments

Creates a new EDFProtocol record.

Parameters:

NameTypeRequiredDescription
payloadEDFProtocolYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: EDFProtocol|error

Sample code:

EDFProtocol result = check client->createElectronicDocuments(payload);

Sample response:

{
  "Description": "Generic protocol",
  "IsActive": "tYES",
  "Code": "edpcs_GEN"
}
getElectronicDocuments

Retrieves a single EDFProtocol by its Code key.

Parameters:

NameTypeRequiredDescription
codeElectronicDocProtocolCodeStrEnumYesKey property 'Code' (SAPB1.ElectronicDocProtocolCodeStrEnum).
headersmap<string|string[]>NoHeaders to be sent with the request.
queriesGetElectronicDocumentsQueriesNoQueries to be sent with the request ($expand, $select).

Returns: EDFProtocol|error

Sample code:

EDFProtocol result = check client->getElectronicDocuments("edpcs_GEN");

Sample response:

{
  "Description": "Generic protocol",
  "IsActive": "tYES",
  "Code": "edpcs_GEN"
}
deleteElectronicDocuments

Deletes the EDFProtocol identified by Code.

Parameters:

NameTypeRequiredDescription
codeElectronicDocProtocolCodeStrEnumYesKey property 'Code' (SAPB1.ElectronicDocProtocolCodeStrEnum).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->deleteElectronicDocuments("edpcs_GEN");
updateElectronicDocuments

Partially updates an EDFProtocol using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
codeElectronicDocProtocolCodeStrEnumYesKey property 'Code' (SAPB1.ElectronicDocProtocolCodeStrEnum).
payloadEDFProtocolYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->updateElectronicDocuments("edpcs_GEN", payload);

NotaFiscalCFOP​

listNotaFiscalCFOP

Queries the NotaFiscalCFOP collection and returns a paged list of Brazilian Nota Fiscal CFOP codes.

Parameters:

NameTypeRequiredDescription
headersListNotaFiscalCFOPHeadersNoHeaders to be sent with the request.
queriesListNotaFiscalCFOPQueriesNoQueries to be sent with the request ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select).

Returns: NotaFiscalCFOPCollectionResponse|error

Sample code:

NotaFiscalCFOPCollectionResponse result = check client->listNotaFiscalCFOP();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#NotaFiscalCFOP",
  "value": [
    {
      "ID": 1,
      "Description": "Sale of production",
      "Code": "5101",
      "Application": "Internal"
    }
  ],
  "odata.nextLink": "NotaFiscalCFOP?$skip=20"
}
createNotaFiscalCFOP

Creates a new NotaFiscalCFOP record.

Parameters:

NameTypeRequiredDescription
payloadNotaFiscalCFOPYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: NotaFiscalCFOP|error

Sample code:

NotaFiscalCFOP result = check client->createNotaFiscalCFOP(payload);

Sample response:

{
  "ID": 1,
  "Description": "Sale of production",
  "Code": "5101",
  "Application": "Internal"
}
getNotaFiscalCFOP

Retrieves a single NotaFiscalCFOP by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.
queriesGetNotaFiscalCFOPQueriesNoQueries to be sent with the request ($expand, $select).

Returns: NotaFiscalCFOP|error

Sample code:

NotaFiscalCFOP result = check client->getNotaFiscalCFOP(1);

Sample response:

{
  "ID": 1,
  "Description": "Sale of production",
  "Code": "5101",
  "Application": "Internal"
}
deleteNotaFiscalCFOP

Deletes the NotaFiscalCFOP identified by ID.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32).
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->deleteNotaFiscalCFOP(1);
updateNotaFiscalCFOP

Partially updates a NotaFiscalCFOP using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32).
payloadNotaFiscalCFOPYesRequest payload.
headersmap<string|string[]>NoHeaders to be sent with the request.

Returns: error?

Sample code:

check client->updateNotaFiscalCFOP(1, payload);

SelfCreditMemos​

selfCreditMemoServiceApproveAndAdd

Approves and adds a Self Credit Memo document supplied in the request payload.

Parameters:

NameTypeRequiredDescription
payloadSelfCreditMemoService_ApproveAndAdd_bodyYesWraps the Document to approve and add
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->selfCreditMemoServiceApproveAndAdd({document: {CardCode: "C0001", DocDate: "2026-07-10"}});
selfCreditMemoServiceApproveAndUpdate

Approves and updates an existing Self Credit Memo document supplied in the request payload.

Parameters:

NameTypeRequiredDescription
payloadSelfCreditMemoService_ApproveAndUpdate_bodyYesWraps the Document to approve and update
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->selfCreditMemoServiceApproveAndUpdate({document: {DocEntry: 123, Comments: "Approved"}});
selfCreditMemoServiceCloseByDate

Closes Self Credit Memo document lines up to a specified date.

Parameters:

NameTypeRequiredDescription
payloadSelfCreditMemoService_CloseByDate_bodyYesWraps the DocumentCloseParams (document key, closing date and closing option)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->selfCreditMemoServiceCloseByDate({documentCloseParams: {docEntry: 123, specifiedClosingDate: "2026-07-10", closingOption: "coBySpecifiedDate"}});
selfCreditMemoServiceExportEWayBill

Exports the E-Way Bill for the Self Credit Memo document supplied in the request payload.

Parameters:

NameTypeRequiredDescription
payloadSelfCreditMemoService_ExportEWayBill_bodyYesWraps the Document to export the E-Way Bill for
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->selfCreditMemoServiceExportEWayBill({document: {DocEntry: 123}});
selfCreditMemoServiceGetApprovalTemplates

Retrieves the applicable approval templates for the Self Credit Memo document supplied in the request payload.

Parameters:

NameTypeRequiredDescription
payloadSelfCreditMemoService_GetApprovalTemplates_bodyYesWraps the Document to get approval templates for
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: Document|error

Sample code:

Document result = check client->selfCreditMemoServiceGetApprovalTemplates({document: {CardCode: "C0001"}});

Sample response:

{
  "DocEntry": 123,
  "DocNum": 456,
  "CardCode": "C0001",
  "CardName": "Example Customer",
  "DocTotal": 1500.00
}
selfCreditMemoServiceHandleApprovalRequest

Handles an incoming approval request event for Self Credit Memos.

Parameters:

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

Returns: error?

Sample code:

check client->selfCreditMemoServiceHandleApprovalRequest();
selfCreditMemoServiceInitData

Initializes and returns default data for a new Self Credit Memo document.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->selfCreditMemoServiceInitData();

Sample response:

{
  "DocEntry": 0,
  "DocType": "dDocument_Items",
  "DocDate": "2026-07-10",
  "DocCurrency": "USD"
}
listSelfCreditMemos

Queries the SelfCreditMemos collection and returns a page of Document entities.

Parameters:

NameTypeRequiredDescription
headersListSelfCreditMemosHeadersNoHeaders to be sent with the request
queriesListSelfCreditMemosQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: SelfCreditMemosCollectionResponse|error

Sample code:

SelfCreditMemosCollectionResponse result = check client->listSelfCreditMemos();

Sample response:

{
  "odata.metadata": "$metadata#SelfCreditMemos",
  "value": [
    {"DocEntry": 123, "DocNum": 456, "CardCode": "C0001", "DocTotal": 1500.00}
  ]
}
createSelfCreditMemos

Creates a new SelfCreditMemos Document.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->createSelfCreditMemos({CardCode: "C0001", DocDate: "2026-07-10"});

Sample response:

{
  "DocEntry": 123,
  "DocNum": 456,
  "CardCode": "C0001",
  "DocDate": "2026-07-10",
  "DocTotal": 1500.00
}
getSelfCreditMemos

Retrieves a single SelfCreditMemos Document by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetSelfCreditMemosQueriesNoOData query options ($expand, $select)

Returns: Document|error

Sample code:

Document result = check client->getSelfCreditMemos(123);

Sample response:

{
  "DocEntry": 123,
  "DocNum": 456,
  "CardCode": "C0001",
  "DocTotal": 1500.00
}
deleteSelfCreditMemos

Deletes a SelfCreditMemos Document by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteSelfCreditMemos(123);
updateSelfCreditMemos

Partially updates a SelfCreditMemos Document (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
payloadDocumentYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateSelfCreditMemos(123, {Comments: "Updated comments"});
selfCreditMemosCancel

Bound action 'Cancel' on SelfCreditMemos that cancels the Document identified by DocEntry.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->selfCreditMemosCancel(123);
selfCreditMemosClose

Bound action 'Close' on SelfCreditMemos that closes the Document identified by DocEntry.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->selfCreditMemosClose(123);
selfCreditMemosCreateCancellationDocument

Bound action 'CreateCancellationDocument' on SelfCreditMemos that creates a cancellation Document for the entity identified by DocEntry.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: Document|error

Sample code:

Document result = check client->selfCreditMemosCreateCancellationDocument(123);

Sample response:

{
  "DocEntry": 789,
  "DocNum": 999,
  "CardCode": "C0001",
  "DocTotal": -1500.00
}
selfCreditMemosReopen

Bound action 'Reopen' on SelfCreditMemos that reopens the Document identified by DocEntry.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->selfCreditMemosReopen(123);

FiscalPrinter​

listFiscalPrinter

Queries the FiscalPrinter collection and returns a page of FiscalPrinter entities.

Parameters:

NameTypeRequiredDescription
headersListFiscalPrinterHeadersNoHeaders to be sent with the request
queriesListFiscalPrinterQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: FiscalPrinterCollectionResponse|error

Sample code:

FiscalPrinterCollectionResponse result = check client->listFiscalPrinter();

Sample response:

{
  "odata.metadata": "$metadata#FiscalPrinter",
  "value": [
    {"EquipmentNo": "FP001", "Model": "Epson TM-T88", "RegisterNo": 1}
  ]
}
createFiscalPrinter

Creates a new FiscalPrinter entity.

Parameters:

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

Returns: FiscalPrinter|error

Sample code:

FiscalPrinter result = check client->createFiscalPrinter({equipmentNo: "FP001", model: "Epson TM-T88", registerNo: 1});

Sample response:

{
  "EquipmentNo": "FP001",
  "Model": "Epson TM-T88",
  "RegisterNo": 1,
  "FiscalDocumentModel": "2D"
}
getFiscalPrinter

Retrieves a single FiscalPrinter entity by its EquipmentNo key.

Parameters:

NameTypeRequiredDescription
equipmentNostringYesKey property 'EquipmentNo' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetFiscalPrinterQueriesNoOData query options ($expand, $select)

Returns: FiscalPrinter|error

Sample code:

FiscalPrinter result = check client->getFiscalPrinter("FP001");

Sample response:

{
  "EquipmentNo": "FP001",
  "Model": "Epson TM-T88",
  "RegisterNo": 1
}
deleteFiscalPrinter

Deletes a FiscalPrinter entity by its EquipmentNo key.

Parameters:

NameTypeRequiredDescription
equipmentNostringYesKey property 'EquipmentNo' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteFiscalPrinter("FP001");
updateFiscalPrinter

Partially updates a FiscalPrinter entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
equipmentNostringYesKey property 'EquipmentNo' (Edm.String)
payloadFiscalPrinterYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateFiscalPrinter("FP001", {model: "Epson TM-T88 v2"});
fiscalPrinterServiceGetFiscalPrinterList

Retrieves the fiscal printer list.

Parameters:

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

Returns: inline_response_200_25|error

Sample code:

inline_response_200_25 result = check client->fiscalPrinterServiceGetFiscalPrinterList();

Sample response:

{
  "odata.metadata": "$metadata#FiscalPrinterService_GetFiscalPrinterList",
  "value": [
    {"EquipmentNo": "FP001"}
  ]
}

ISDRecipientCreditMemos​

listISDRecipientCreditMemos

Queries the ISDRecipientCreditMemos collection and returns a page of ISDRecipientCreditMemo entities.

Parameters:

NameTypeRequiredDescription
headersListISDRecipientCreditMemosHeadersNoHeaders to be sent with the request
queriesListISDRecipientCreditMemosQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ISDRecipientCreditMemosCollectionResponse|error

Sample code:

ISDRecipientCreditMemosCollectionResponse result = check client->listISDRecipientCreditMemos();

Sample response:

{
  "odata.metadata": "$metadata#ISDRecipientCreditMemos",
  "value": [
    {"DocumentEntry": 123, "DocumentNumber": 456, "DocumentStatus": "isd_Open"}
  ]
}
createISDRecipientCreditMemos

Creates a new ISDRecipientCreditMemo entity.

Parameters:

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

Returns: ISDRecipientCreditMemo|error

Sample code:

ISDRecipientCreditMemo result = check client->createISDRecipientCreditMemos({ReferenceEntry: 100, SourceLocationCode: 1, TargetLocationCode: 2});

Sample response:

{
  "DocumentEntry": 123,
  "DocumentNumber": 456,
  "DocumentStatus": "isd_Open"
}
getISDRecipientCreditMemos

Retrieves a single ISDRecipientCreditMemo entity by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetISDRecipientCreditMemosQueriesNoOData query options ($expand, $select)

Returns: ISDRecipientCreditMemo|error

Sample code:

ISDRecipientCreditMemo result = check client->getISDRecipientCreditMemos(123);

Sample response:

{
  "DocumentEntry": 123,
  "DocumentNumber": 456,
  "DocumentStatus": "isd_Open"
}
deleteISDRecipientCreditMemos

Deletes an ISDRecipientCreditMemo entity by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteISDRecipientCreditMemos(123);
updateISDRecipientCreditMemos

Partially updates an ISDRecipientCreditMemo entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
payloadISDRecipientCreditMemoYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateISDRecipientCreditMemos(123, {Remarks: "Updated"});
iSDRecipientCreditMemosCancel

Bound action 'Cancel' on ISDRecipientCreditMemos that cancels the entity identified by DocumentEntry.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->iSDRecipientCreditMemosCancel(123);
iSDRecipientCreditMemosServiceGetList

Retrieves the ISDRecipientCreditMemos service list.

Parameters:

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

Returns: inline_response_200_30|error

Sample code:

inline_response_200_30 result = check client->iSDRecipientCreditMemosServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#ISDRecipientCreditMemosService_GetList",
  "value": [
    {"DocumentEntry": 123, "DocumentNumber": 456}
  ]
}

BrazilFuelIndexers​

listBrazilFuelIndexers

Queries the BrazilFuelIndexers collection and returns a page of BrazilFuelIndexer entities.

Parameters:

NameTypeRequiredDescription
headersListBrazilFuelIndexersHeadersNoHeaders to be sent with the request
queriesListBrazilFuelIndexersQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: BrazilFuelIndexersCollectionResponse|error

Sample code:

BrazilFuelIndexersCollectionResponse result = check client->listBrazilFuelIndexers();

Sample response:

{
  "odata.metadata": "$metadata#BrazilFuelIndexers",
  "value": [
    {"FuelID": 1, "Description": "Gasoline", "FuelCode": "GAS", "FuelGroupCode": 1}
  ]
}
createBrazilFuelIndexers

Creates a new BrazilFuelIndexer entity.

Parameters:

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

Returns: BrazilFuelIndexer|error

Sample code:

BrazilFuelIndexer result = check client->createBrazilFuelIndexers({description: "Gasoline", fuelCode: "GAS", fuelGroupCode: 1});

Sample response:

{
  "FuelID": 1,
  "Description": "Gasoline",
  "FuelCode": "GAS",
  "FuelGroupCode": 1
}
getBrazilFuelIndexers

Retrieves a single BrazilFuelIndexer entity by its FuelID key.

Parameters:

NameTypeRequiredDescription
fuelIDint:Signed32YesKey property 'FuelID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetBrazilFuelIndexersQueriesNoOData query options ($expand, $select)

Returns: BrazilFuelIndexer|error

Sample code:

BrazilFuelIndexer result = check client->getBrazilFuelIndexers(1);

Sample response:

{
  "FuelID": 1,
  "Description": "Gasoline",
  "FuelCode": "GAS",
  "FuelGroupCode": 1
}
deleteBrazilFuelIndexers

Deletes a BrazilFuelIndexer entity by its FuelID key.

Parameters:

NameTypeRequiredDescription
fuelIDint:Signed32YesKey property 'FuelID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteBrazilFuelIndexers(1);
updateBrazilFuelIndexers

Partially updates a BrazilFuelIndexer entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
fuelIDint:Signed32YesKey property 'FuelID' (Edm.Int32)
payloadBrazilFuelIndexerYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateBrazilFuelIndexers(1, {description: "Gasoline Common"});
brazilFuelIndexersServiceGetList

Retrieves the BrazilFuelIndexers service list.

Parameters:

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

Returns: inline_response_200_2|error

Sample code:

inline_response_200_2 result = check client->brazilFuelIndexersServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#BrazilFuelIndexersService_GetList",
  "value": [
    {"FuelID": 1, "Description": "Gasoline"}
  ]
}

CESTCodes​

listCESTCodes

Queries the CESTCodes collection and returns a page of CESTCodeData entities.

Parameters:

NameTypeRequiredDescription
headersListCESTCodesHeadersNoHeaders to be sent with the request
queriesListCESTCodesQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: CESTCodesCollectionResponse|error

Sample code:

CESTCodesCollectionResponse result = check client->listCESTCodes();

Sample response:

{
  "odata.metadata": "$metadata#CESTCodes",
  "value": [
    {"AbsEntry": 1, "Code": "1300100", "Description": "Gasolina"}
  ]
}
createCESTCodes

Creates a new CESTCodeData entity.

Parameters:

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

Returns: CESTCodeData|error

Sample code:

CESTCodeData result = check client->createCESTCodes({code: "1300100", description: "Gasolina"});

Sample response:

{
  "AbsEntry": 1,
  "Code": "1300100",
  "Description": "Gasolina"
}
getCESTCodes

Retrieves a single CESTCodeData entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetCESTCodesQueriesNoOData query options ($expand, $select)

Returns: CESTCodeData|error

Sample code:

CESTCodeData result = check client->getCESTCodes(1);

Sample response:

{
  "AbsEntry": 1,
  "Code": "1300100",
  "Description": "Gasolina"
}
deleteCESTCodes

Deletes a CESTCodeData entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteCESTCodes(1);
updateCESTCodes

Partially updates a CESTCodeData entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadCESTCodeDataYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateCESTCodes(1, {description: "Gasolina Comum"});

IdentificationCodes​

identificationCodeServiceGetList

Retrieves the IdentificationCode service list.

Parameters:

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

Returns: inline_response_200_32|error

Sample code:

inline_response_200_32 result = check client->identificationCodeServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#IdentificationCodeService_GetList",
  "value": [
    {"AbsEntry": 1, "Code": "01", "Description": "Order Identification"}
  ]
}
listIdentificationCodes

Queries the IdentificationCodes collection and returns a page of IdentificationCode entities.

Parameters:

NameTypeRequiredDescription
headersListIdentificationCodesHeadersNoHeaders to be sent with the request
queriesListIdentificationCodesQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: IdentificationCodesCollectionResponse|error

Sample code:

IdentificationCodesCollectionResponse result = check client->listIdentificationCodes();

Sample response:

{
  "odata.metadata": "$metadata#IdentificationCodes",
  "value": [
    {"AbsEntry": 1, "Codelist": "idctOrder", "Code": "01", "Description": "Order Identification"}
  ]
}
createIdentificationCodes

Creates a new IdentificationCode entity.

Parameters:

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

Returns: IdentificationCode|error

Sample code:

IdentificationCode result = check client->createIdentificationCodes({codelist: "idctOrder", code: "01", description: "Order Identification"});

Sample response:

{
  "AbsEntry": 1,
  "Codelist": "idctOrder",
  "Code": "01",
  "Description": "Order Identification"
}
getIdentificationCodes

Retrieves a single IdentificationCode entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetIdentificationCodesQueriesNoOData query options ($expand, $select)

Returns: IdentificationCode|error

Sample code:

IdentificationCode result = check client->getIdentificationCodes(1);

Sample response:

{
  "AbsEntry": 1,
  "Codelist": "idctOrder",
  "Code": "01",
  "Description": "Order Identification"
}
deleteIdentificationCodes

Deletes an IdentificationCode entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteIdentificationCodes(1);
updateIdentificationCodes

Partially updates an IdentificationCode entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadIdentificationCodeYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateIdentificationCodes(1, {description: "Order Identification Updated"});

NCMCodesSetup​

listNCMCodesSetup

Queries the NCMCodesSetup collection and returns a page of NCMCodeSetup entities.

Parameters:

NameTypeRequiredDescription
headersListNCMCodesSetupHeadersNoHeaders to be sent with the request
queriesListNCMCodesSetupQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: NCMCodesSetupCollectionResponse|error

Sample code:

NCMCodesSetupCollectionResponse result = check client->listNCMCodesSetup();

Sample response:

{
  "odata.metadata": "$metadata#NCMCodesSetup",
  "value": [
    {"AbsEntry": 1, "NCMCode": "12345678", "Description": "Vehicle parts", "GroupCode": "01"}
  ]
}
createNCMCodesSetup

Creates a new NCMCodeSetup entity.

Parameters:

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

Returns: NCMCodeSetup|error

Sample code:

NCMCodeSetup result = check client->createNCMCodesSetup({nCMCode: "12345678", description: "Vehicle parts", groupCode: "01"});

Sample response:

{
  "AbsEntry": 1,
  "NCMCode": "12345678",
  "Description": "Vehicle parts",
  "GroupCode": "01"
}
getNCMCodesSetup

Retrieves a single NCMCodeSetup entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetNCMCodesSetupQueriesNoOData query options ($expand, $select)

Returns: NCMCodeSetup|error

Sample code:

NCMCodeSetup result = check client->getNCMCodesSetup(1);

Sample response:

{
  "AbsEntry": 1,
  "NCMCode": "12345678",
  "Description": "Vehicle parts",
  "GroupCode": "01"
}
deleteNCMCodesSetup

Deletes an NCMCodeSetup entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteNCMCodesSetup(1);
updateNCMCodesSetup

Partially updates an NCMCodeSetup entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadNCMCodeSetupYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateNCMCodesSetup(1, {description: "Vehicle parts updated"});
nCMCodesSetupServiceGetNCMCodeSetupList

Retrieves the NCM code setup list.

Parameters:

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

Returns: inline_response_200_38|error

Sample code:

inline_response_200_38 result = check client->nCMCodesSetupServiceGetNCMCodeSetupList();

Sample response:

{
  "odata.metadata": "$metadata#NCMCodesSetupService_GetNCMCodeSetupList",
  "value": [
    {"NCMCode": "12345678", "Description": "Vehicle parts", "AbsEntry": 1}
  ]
}

CustomsDeclaration​

listCustomsDeclaration

Queries the CustomsDeclaration collection and returns a page of CustomsDeclaration entities.

Parameters:

NameTypeRequiredDescription
headersListCustomsDeclarationHeadersNoHeaders to be sent with the request
queriesListCustomsDeclarationQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: CustomsDeclarationCollectionResponse|error

Sample code:

CustomsDeclarationCollectionResponse result = check client->listCustomsDeclaration();

Sample response:

{
  "odata.metadata": "$metadata#CustomsDeclaration",
  "value": [
    {"CCDNum": "CCD0001", "Date": "2026-07-10", "CustomsBroker": "Broker Co", "DocNum": "1001"}
  ]
}
createCustomsDeclaration

Creates a new CustomsDeclaration entity.

Parameters:

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

Returns: CustomsDeclaration|error

Sample code:

CustomsDeclaration result = check client->createCustomsDeclaration({CCDNum: "CCD0001", Date: "2026-07-10", CustomsBroker: "Broker Co"});

Sample response:

{
  "CCDNum": "CCD0001",
  "Date": "2026-07-10",
  "CustomsBroker": "Broker Co",
  "DocNum": "1001"
}
getCustomsDeclaration

Retrieves a single CustomsDeclaration entity by its CCDNum key.

Parameters:

NameTypeRequiredDescription
cCDNumstringYesKey property 'CCDNum' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetCustomsDeclarationQueriesNoOData query options ($expand, $select)

Returns: CustomsDeclaration|error

Sample code:

CustomsDeclaration result = check client->getCustomsDeclaration("CCD0001");

Sample response:

{
  "CCDNum": "CCD0001",
  "Date": "2026-07-10",
  "CustomsBroker": "Broker Co",
  "DocNum": "1001"
}
deleteCustomsDeclaration

Deletes a CustomsDeclaration entity by its CCDNum key.

Parameters:

NameTypeRequiredDescription
cCDNumstringYesKey property 'CCDNum' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteCustomsDeclaration("CCD0001");
updateCustomsDeclaration

Partially updates a CustomsDeclaration entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
cCDNumstringYesKey property 'CCDNum' (Edm.String)
payloadCustomsDeclarationYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateCustomsDeclaration("CCD0001", {CustomsBroker: "New Broker Co"});

ImportDeterminations​

importDeterminationServiceGetDeterminations

Retrieves the applicable import determinations for the protocol code supplied in the request payload.

Parameters:

NameTypeRequiredDescription
payloadImportDeterminationService_GetDeterminations_bodyYesWraps the ImportDeterminationsParams (electronic document protocol code) to get determinations for
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: inline_response_200_33|error

Sample code:

inline_response_200_33 result = check client->importDeterminationServiceGetDeterminations({importDeterminationsParams: {Code: "edpcs_NFe"}});

Sample response:

{
  "odata.metadata": "$metadata#ImportDeterminationService_GetDeterminations",
  "value": [
    {"AbsEntry": 1, "Code": "edpcs_NFe", "LineNumber": 1, "FieldType": "iftCNPJ"}
  ]
}
listImportDeterminations

Queries the ImportDeterminations collection and returns a page of ImportDetermination entities.

Parameters:

NameTypeRequiredDescription
headersListImportDeterminationsHeadersNoHeaders to be sent with the request
queriesListImportDeterminationsQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: ImportDeterminationsCollectionResponse|error

Sample code:

ImportDeterminationsCollectionResponse result = check client->listImportDeterminations();

Sample response:

{
  "odata.metadata": "$metadata#ImportDeterminations",
  "value": [
    {"AbsEntry": 1, "Code": "edpcs_NFe", "LineNumber": 1, "FieldType": "iftCNPJ"}
  ]
}
createImportDeterminations

Creates a new ImportDetermination entity.

Parameters:

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

Returns: ImportDetermination|error

Sample code:

ImportDetermination result = check client->createImportDeterminations({Code: "edpcs_NFe", LineNumber: 1, FieldType: "iftCNPJ"});

Sample response:

{
  "AbsEntry": 1,
  "Code": "edpcs_NFe",
  "LineNumber": 1,
  "FieldType": "iftCNPJ"
}
getImportDeterminations

Retrieves a single ImportDetermination entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetImportDeterminationsQueriesNoOData query options ($expand, $select)

Returns: ImportDetermination|error

Sample code:

ImportDetermination result = check client->getImportDeterminations(1);

Sample response:

{
  "AbsEntry": 1,
  "Code": "edpcs_NFe",
  "LineNumber": 1,
  "FieldType": "iftCNPJ"
}
deleteImportDeterminations

Deletes an ImportDetermination entity by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteImportDeterminations(1);
updateImportDeterminations

Partially updates an ImportDetermination entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadImportDeterminationYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateImportDeterminations(1, {LineNumber: 2});

NotaFiscalUsage​

listNotaFiscalUsage

Queries the NotaFiscalUsage collection and returns a page of NotaFiscalUsage entities.

Parameters:

NameTypeRequiredDescription
headersListNotaFiscalUsageHeadersNoHeaders to be sent with the request
queriesListNotaFiscalUsageQueriesNoOData query options ($skip, $top, $filter, $orderby, $expand, $inlinecount, $select)

Returns: NotaFiscalUsageCollectionResponse|error

Sample code:

NotaFiscalUsageCollectionResponse result = check client->listNotaFiscalUsage();

Sample response:

{
  "odata.metadata": "$metadata#NotaFiscalUsage",
  "value": [
    {"ID": 1, "Usage": "Venda", "Description": "Sale usage"}
  ]
}
createNotaFiscalUsage

Creates a new NotaFiscalUsage entity.

Parameters:

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

Returns: NotaFiscalUsage|error

Sample code:

NotaFiscalUsage result = check client->createNotaFiscalUsage({Usage: "Venda", Description: "Sale usage"});

Sample response:

{
  "ID": 1,
  "Usage": "Venda",
  "Description": "Sale usage"
}
getNotaFiscalUsage

Retrieves a single NotaFiscalUsage entity by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetNotaFiscalUsageQueriesNoOData query options ($expand, $select)

Returns: NotaFiscalUsage|error

Sample code:

NotaFiscalUsage result = check client->getNotaFiscalUsage(1);

Sample response:

{
  "ID": 1,
  "Usage": "Venda",
  "Description": "Sale usage"
}
deleteNotaFiscalUsage

Deletes a NotaFiscalUsage entity by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->deleteNotaFiscalUsage(1);
updateNotaFiscalUsage

Partially updates a NotaFiscalUsage entity (PATCH/MERGE semantics).

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
payloadNotaFiscalUsageYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

check client->updateNotaFiscalUsage(1, {Description: "Sale usage updated"});

RetornoCodes​

listRetornoCodes

Queries the RetornoCodes collection, returning a page of Brazilian boleto return-code entities.

Parameters:

NameTypeRequiredDescription
headersListRetornoCodesHeadersNoHeaders to be sent with the request
queriesListRetornoCodesQueriesNoQueries to be sent with the request

Returns: RetornoCodesCollectionResponse|error

Sample code:

RetornoCodesCollectionResponse result = check client->listRetornoCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#RetornoCodes",
  "value": [
    {
      "AbsEntry": 1,
      "MovementCode": 2,
      "Description": "Cheque devolvido",
      "OccurenceCode": 12,
      "BoeStatus": "boes_Created",
      "Color": 1,
      "BankCode": "001",
      "FileFormat": "240"
    }
  ],
  "odata.nextLink": "RetornoCodes?$skip=20"
}
createRetornoCodes

Creates a new RetornoCode entity.

Parameters:

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

Returns: RetornoCode|error

Sample code:

RetornoCode result = check client->createRetornoCodes(payload);

Sample response:

{
  "AbsEntry": 1,
  "MovementCode": 2,
  "Description": "Cheque devolvido",
  "OccurenceCode": 12,
  "BoeStatus": "boes_Created",
  "Color": 1,
  "BankCode": "001",
  "FileFormat": "240"
}
getRetornoCodes

Retrieves a single RetornoCode entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetRetornoCodesQueriesNoQueries to be sent with the request

Returns: RetornoCode|error

Sample code:

RetornoCode result = check client->getRetornoCodes(1);

Sample response:

{
  "AbsEntry": 1,
  "MovementCode": 2,
  "Description": "Cheque devolvido",
  "OccurenceCode": 12,
  "BoeStatus": "boes_Created",
  "Color": 1,
  "BankCode": "001",
  "FileFormat": "240"
}
deleteRetornoCodes

Deletes the RetornoCode entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteRetornoCodes(1);
updateRetornoCodes

Partially updates a RetornoCode entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadRetornoCodeYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateRetornoCodes(1, payload);
retornoCodesServiceGetList

Invokes the RetornoCodesService_GetList unbound function to retrieve a compact list of retorno codes.

Parameters:

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

Returns: inline_response_200_42|error

Sample code:

inline_response_200_42 result = check client->retornoCodesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#RetornoCodesService_GetList",
  "value": [
    {
      "MovementCode": 2,
      "Description": "Cheque devolvido",
      "OccurenceCode": 12,
      "BoeStatus": "boes_Created",
      "Color": 1,
      "BankCode": "001",
      "AbsEntry": 1,
      "FileFormat": "240"
    }
  ]
}

ElectronicFileFormats​

listElectronicFileFormats

Queries the ElectronicFileFormats collection, returning a page of electronic file format entities.

Parameters:

NameTypeRequiredDescription
headersListElectronicFileFormatsHeadersNoHeaders to be sent with the request
queriesListElectronicFileFormatsQueriesNoQueries to be sent with the request

Returns: ElectronicFileFormatsCollectionResponse|error

Sample code:

ElectronicFileFormatsCollectionResponse result = check client->listElectronicFileFormats();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicFileFormats",
  "value": [
    {
      "FormatID": 1,
      "Name": "NFe 4.0",
      "Description": "Nota Fiscal Eletronica",
      "SchemaVersion": "4.00",
      "Version": "1",
      "OutputFilePath": "C:\\NFe\\Output",
      "MenuPath": "Administration"
    }
  ],
  "odata.nextLink": "ElectronicFileFormats?$skip=20"
}
createElectronicFileFormats

Creates a new ElectronicFileFormat entity.

Parameters:

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

Returns: ElectronicFileFormat|error

Sample code:

ElectronicFileFormat result = check client->createElectronicFileFormats(payload);

Sample response:

{
  "FormatID": 1,
  "Name": "NFe 4.0",
  "Description": "Nota Fiscal Eletronica",
  "SchemaVersion": "4.00",
  "Version": "1",
  "OutputFilePath": "C:\\NFe\\Output",
  "MenuPath": "Administration"
}
getElectronicFileFormats

Retrieves a single ElectronicFileFormat entity identified by its FormatID key.

Parameters:

NameTypeRequiredDescription
formatIDint:Signed32YesKey property 'FormatID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetElectronicFileFormatsQueriesNoQueries to be sent with the request

Returns: ElectronicFileFormat|error

Sample code:

ElectronicFileFormat result = check client->getElectronicFileFormats(1);

Sample response:

{
  "FormatID": 1,
  "Name": "NFe 4.0",
  "Description": "Nota Fiscal Eletronica",
  "SchemaVersion": "4.00",
  "Version": "1",
  "OutputFilePath": "C:\\NFe\\Output",
  "MenuPath": "Administration"
}
deleteElectronicFileFormats

Deletes the ElectronicFileFormat entity identified by its FormatID key.

Parameters:

NameTypeRequiredDescription
formatIDint:Signed32YesKey property 'FormatID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteElectronicFileFormats(1);
updateElectronicFileFormats

Partially updates an ElectronicFileFormat entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
formatIDint:Signed32YesKey property 'FormatID' (Edm.Int32)
payloadElectronicFileFormatYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateElectronicFileFormats(1, payload);
electronicFileFormatsServiceGetElectronicFileFormatList

Invokes the ElectronicFileFormatsService_GetElectronicFileFormatList unbound function to retrieve a compact list of electronic file formats.

Parameters:

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

Returns: inline_response_200_23|error

Sample code:

inline_response_200_23 result = check client->electronicFileFormatsServiceGetElectronicFileFormatList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ElectronicFileFormatsService_GetElectronicFileFormatList",
  "value": [
    {
      "FormatID": 1,
      "Name": "NFe 4.0"
    }
  ]
}

ISDInvoices​

listISDInvoices

Queries the ISDInvoices collection, returning a page of Indian ISD invoice entities.

Parameters:

NameTypeRequiredDescription
headersListISDInvoicesHeadersNoHeaders to be sent with the request
queriesListISDInvoicesQueriesNoQueries to be sent with the request

Returns: ISDInvoicesCollectionResponse|error

Sample code:

ISDInvoicesCollectionResponse result = check client->listISDInvoices();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ISDInvoices",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 1001,
      "Series": 1,
      "PostingDate": "2026-07-01",
      "DocDate": "2026-07-01",
      "SourceLocationCode": 10,
      "TargetLocationCode": 20,
      "ISDEntry": 5,
      "BPLId": 1,
      "VATRegNum": "27AAAAA0000A1Z5"
    }
  ],
  "odata.nextLink": "ISDInvoices?$skip=20"
}
createISDInvoices

Creates a new ISDInvoice entity.

Parameters:

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

Returns: ISDInvoice|error

Sample code:

ISDInvoice result = check client->createISDInvoices(payload);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1001,
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "SourceLocationCode": 10,
  "TargetLocationCode": 20,
  "ISDEntry": 5,
  "BPLId": 1,
  "VATRegNum": "27AAAAA0000A1Z5"
}
getISDInvoices

Retrieves a single ISDInvoice entity identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetISDInvoicesQueriesNoQueries to be sent with the request

Returns: ISDInvoice|error

Sample code:

ISDInvoice result = check client->getISDInvoices(1);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 1001,
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "SourceLocationCode": 10,
  "TargetLocationCode": 20,
  "ISDEntry": 5,
  "BPLId": 1,
  "VATRegNum": "27AAAAA0000A1Z5"
}
deleteISDInvoices

Deletes the ISDInvoice entity identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteISDInvoices(1);
updateISDInvoices

Partially updates an ISDInvoice entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
payloadISDInvoiceYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateISDInvoices(1, payload);
iSDInvoicesCancel

Invokes the bound action 'Cancel' on an ISDInvoice to cancel it.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->iSDInvoicesCancel(1);
iSDInvoicesServiceGetList

Invokes the ISDInvoicesService_GetList unbound function to retrieve a compact list of ISD invoices.

Parameters:

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

Returns: inline_response_200_29|error

Sample code:

inline_response_200_29 result = check client->iSDInvoicesServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ISDInvoicesService_GetList",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 1001
    }
  ]
}

BrazilBeverageIndexers​

listBrazilBeverageIndexers

Queries the BrazilBeverageIndexers collection, returning a page of beverage indexer entities used for Brazilian tax localization.

Parameters:

NameTypeRequiredDescription
headersListBrazilBeverageIndexersHeadersNoHeaders to be sent with the request
queriesListBrazilBeverageIndexersQueriesNoQueries to be sent with the request

Returns: BrazilBeverageIndexersCollectionResponse|error

Sample code:

BrazilBeverageIndexersCollectionResponse result = check client->listBrazilBeverageIndexers();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BrazilBeverageIndexers",
  "value": [
    {
      "BeverageID": 1,
      "BeverageTableCode": "01",
      "BeverageGroupCode": "02",
      "BeverageCommercialBrandCode": 100
    }
  ],
  "odata.nextLink": "BrazilBeverageIndexers?$skip=20"
}
createBrazilBeverageIndexers

Creates a new BrazilBeverageIndexer entity.

Parameters:

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

Returns: BrazilBeverageIndexer|error

Sample code:

BrazilBeverageIndexer result = check client->createBrazilBeverageIndexers(payload);

Sample response:

{
  "BeverageID": 1,
  "BeverageTableCode": "01",
  "BeverageGroupCode": "02",
  "BeverageCommercialBrandCode": 100
}
getBrazilBeverageIndexers

Retrieves a single BrazilBeverageIndexer entity identified by its BeverageID key.

Parameters:

NameTypeRequiredDescription
beverageIDint:Signed32YesKey property 'BeverageID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetBrazilBeverageIndexersQueriesNoQueries to be sent with the request

Returns: BrazilBeverageIndexer|error

Sample code:

BrazilBeverageIndexer result = check client->getBrazilBeverageIndexers(1);

Sample response:

{
  "BeverageID": 1,
  "BeverageTableCode": "01",
  "BeverageGroupCode": "02",
  "BeverageCommercialBrandCode": 100
}
deleteBrazilBeverageIndexers

Deletes the BrazilBeverageIndexer entity identified by its BeverageID key.

Parameters:

NameTypeRequiredDescription
beverageIDint:Signed32YesKey property 'BeverageID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteBrazilBeverageIndexers(1);
updateBrazilBeverageIndexers

Partially updates a BrazilBeverageIndexer entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
beverageIDint:Signed32YesKey property 'BeverageID' (Edm.Int32)
payloadBrazilBeverageIndexerYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateBrazilBeverageIndexers(1, payload);
brazilBeverageIndexersServiceGetList

Invokes the BrazilBeverageIndexersService_GetList unbound function to retrieve a compact list of beverage indexers.

Parameters:

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

Returns: inline_response_200_1|error

Sample code:

inline_response_200_1 result = check client->brazilBeverageIndexersServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BrazilBeverageIndexersService_GetList",
  "value": [
    {
      "BeverageID": 1
    }
  ]
}

BrazilStringIndexers​

listBrazilStringIndexers

Queries the BrazilStringIndexers collection, returning a page of string indexer entities used for Brazilian tax localization.

Parameters:

NameTypeRequiredDescription
headersListBrazilStringIndexersHeadersNoHeaders to be sent with the request
queriesListBrazilStringIndexersQueriesNoQueries to be sent with the request

Returns: BrazilStringIndexersCollectionResponse|error

Sample code:

BrazilStringIndexersCollectionResponse result = check client->listBrazilStringIndexers();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BrazilStringIndexers",
  "value": [
    {
      "IndexerType": "bsitBeverageTable",
      "Description": "Beverage table indexer",
      "ID": 1,
      "Code": "01"
    }
  ],
  "odata.nextLink": "BrazilStringIndexers?$skip=20"
}
createBrazilStringIndexers

Creates a new BrazilStringIndexer entity.

Parameters:

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

Returns: BrazilStringIndexer|error

Sample code:

BrazilStringIndexer result = check client->createBrazilStringIndexers(payload);

Sample response:

{
  "IndexerType": "bsitBeverageTable",
  "Description": "Beverage table indexer",
  "ID": 1,
  "Code": "01"
}
getBrazilStringIndexers

Retrieves a single BrazilStringIndexer entity identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetBrazilStringIndexersQueriesNoQueries to be sent with the request

Returns: BrazilStringIndexer|error

Sample code:

BrazilStringIndexer result = check client->getBrazilStringIndexers(1);

Sample response:

{
  "IndexerType": "bsitBeverageTable",
  "Description": "Beverage table indexer",
  "ID": 1,
  "Code": "01"
}
deleteBrazilStringIndexers

Deletes the BrazilStringIndexer entity identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteBrazilStringIndexers(1);
updateBrazilStringIndexers

Partially updates a BrazilStringIndexer entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
payloadBrazilStringIndexerYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateBrazilStringIndexers(1, payload);
brazilStringIndexersGetIndexerTypeList

Invokes the bound action 'GetIndexerTypeList' on a BrazilStringIndexer to retrieve its list of valid indexer type values.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: inline_response_200_5|error

Sample code:

inline_response_200_5 result = check client->brazilStringIndexersGetIndexerTypeList(1);

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#BrazilStringIndexers/GetIndexerTypeList",
  "value": [
    {
      "ID": 1
    }
  ]
}

DNFCodeSetup​

listDNFCodeSetup

Queries the DNFCodeSetup collection, returning a page of Brazilian DNF (Documento de Natureza Fiscal) code setup entities.

Parameters:

NameTypeRequiredDescription
headersListDNFCodeSetupHeadersNoHeaders to be sent with the request
queriesListDNFCodeSetupQueriesNoQueries to be sent with the request

Returns: DNFCodeSetupCollectionResponse|error

Sample code:

DNFCodeSetupCollectionResponse result = check client->listDNFCodeSetup();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#DNFCodeSetup",
  "value": [
    {
      "NCMCode": 1001,
      "UoM": "KG",
      "DNFCode": "01",
      "Factor": 1.0,
      "AbsEntry": 1
    }
  ],
  "odata.nextLink": "DNFCodeSetup?$skip=20"
}
createDNFCodeSetup

Creates a new DNFCodeSetup entity.

Parameters:

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

Returns: DNFCodeSetup|error

Sample code:

DNFCodeSetup result = check client->createDNFCodeSetup(payload);

Sample response:

{
  "NCMCode": 1001,
  "UoM": "KG",
  "DNFCode": "01",
  "Factor": 1.0,
  "AbsEntry": 1
}
getDNFCodeSetup

Retrieves a single DNFCodeSetup entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetDNFCodeSetupQueriesNoQueries to be sent with the request

Returns: DNFCodeSetup|error

Sample code:

DNFCodeSetup result = check client->getDNFCodeSetup(1);

Sample response:

{
  "NCMCode": 1001,
  "UoM": "KG",
  "DNFCode": "01",
  "Factor": 1.0,
  "AbsEntry": 1
}
deleteDNFCodeSetup

Deletes the DNFCodeSetup entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteDNFCodeSetup(1);
updateDNFCodeSetup

Partially updates a DNFCodeSetup entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadDNFCodeSetupYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateDNFCodeSetup(1, payload);
dNFCodeSetupServiceGetDNFCodeSetupList

Invokes the DNFCodeSetupService_GetDNFCodeSetupList unbound function to retrieve a compact list of DNF code setups.

Parameters:

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

Returns: inline_response_200_9|error

Sample code:

inline_response_200_9 result = check client->dNFCodeSetupServiceGetDNFCodeSetupList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#DNFCodeSetupService_GetDNFCodeSetupList",
  "value": [
    {
      "NCMCode": 1001,
      "DNFCode": "01",
      "AbsEntry": 1
    }
  ]
}

MaterialGroups​

listMaterialGroups

Queries the MaterialGroups collection, returning a page of material group entities.

Parameters:

NameTypeRequiredDescription
headersListMaterialGroupsHeadersNoHeaders to be sent with the request
queriesListMaterialGroupsQueriesNoQueries to be sent with the request

Returns: MaterialGroupsCollectionResponse|error

Sample code:

MaterialGroupsCollectionResponse result = check client->listMaterialGroups();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#MaterialGroups",
  "value": [
    {
      "Description": "Raw materials",
      "AbsEntry": 1,
      "MaterialGroupCode": "RM01"
    }
  ],
  "odata.nextLink": "MaterialGroups?$skip=20"
}
createMaterialGroups

Creates a new MaterialGroup entity.

Parameters:

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

Returns: MaterialGroup|error

Sample code:

MaterialGroup result = check client->createMaterialGroups(payload);

Sample response:

{
  "Description": "Raw materials",
  "AbsEntry": 1,
  "MaterialGroupCode": "RM01"
}
getMaterialGroups

Retrieves a single MaterialGroup entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetMaterialGroupsQueriesNoQueries to be sent with the request

Returns: MaterialGroup|error

Sample code:

MaterialGroup result = check client->getMaterialGroups(1);

Sample response:

{
  "Description": "Raw materials",
  "AbsEntry": 1,
  "MaterialGroupCode": "RM01"
}
deleteMaterialGroups

Deletes the MaterialGroup entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteMaterialGroups(1);
updateMaterialGroups

Partially updates a MaterialGroup entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadMaterialGroupYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateMaterialGroups(1, payload);
materialGroupsServiceGetMaterialGroupList

Invokes the MaterialGroupsService_GetMaterialGroupList unbound function to retrieve a compact list of material groups.

Parameters:

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

Returns: inline_response_200_37|error

Sample code:

inline_response_200_37 result = check client->materialGroupsServiceGetMaterialGroupList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#MaterialGroupsService_GetMaterialGroupList",
  "value": [
    {
      "AbsEntry": 1,
      "MaterialGroupCode": "RM01"
    }
  ]
}

CUPCodes​

cUPCodeServiceGetList

Invokes the CUPCodeService_GetList unbound function to retrieve a compact list of CUP codes.

Parameters:

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

Returns: inline_response_200_7|error

Sample code:

inline_response_200_7 result = check client->cUPCodeServiceGetList();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CUPCodeService_GetList",
  "value": [
    {
      "AbsEntry": 1
    }
  ]
}
listCUPCodes

Queries the CUPCodes collection, returning a page of CUP code entities and their linked documents.

Parameters:

NameTypeRequiredDescription
headersListCUPCodesHeadersNoHeaders to be sent with the request
queriesListCUPCodesQueriesNoQueries to be sent with the request

Returns: CUPCodesCollectionResponse|error

Sample code:

CUPCodesCollectionResponse result = check client->listCUPCodes();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#CUPCodes",
  "value": [
    {
      "AbsEntry": 1,
      "Invoices": [
        {"DocEntry": 100}
      ],
      "Orders": [
        {"DocEntry": 200}
      ]
    }
  ],
  "odata.nextLink": "CUPCodes?$skip=20"
}
createCUPCodes

Creates a new CUPCode entity.

Parameters:

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

Returns: CUPCode|error

Sample code:

CUPCode result = check client->createCUPCodes(payload);

Sample response:

{
  "AbsEntry": 1,
  "Invoices": [
    {"DocEntry": 100}
  ],
  "Orders": [
    {"DocEntry": 200}
  ]
}
getCUPCodes

Retrieves a single CUPCode entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetCUPCodesQueriesNoQueries to be sent with the request

Returns: CUPCode|error

Sample code:

CUPCode result = check client->getCUPCodes(1);

Sample response:

{
  "AbsEntry": 1,
  "Invoices": [
    {"DocEntry": 100}
  ],
  "Orders": [
    {"DocEntry": 200}
  ]
}
deleteCUPCodes

Deletes the CUPCode entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteCUPCodes(1);
updateCUPCodes

Partially updates a CUPCode entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadCUPCodeYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateCUPCodes(1, payload);

ExportDeterminations​

exportDeterminationServiceGetDeterminations

Invokes the ExportDeterminationService_GetDeterminations unbound function to look up export determinations for a given electronic document protocol code.

Parameters:

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

Returns: inline_response_200_24|error

Sample code:

inline_response_200_24 result = check client->exportDeterminationServiceGetDeterminations(payload);

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ExportDeterminationService_GetDeterminations",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "edpcs_NFe",
      "Priority": 1,
      "BusinessPartner": "C0001",
      "Country": "BR",
      "DocumentType": "Invoice",
      "ExportFormat": 1
    }
  ]
}
listExportDeterminations

Queries the ExportDeterminations collection, returning a page of export determination entities that map documents to electronic file formats.

Parameters:

NameTypeRequiredDescription
headersListExportDeterminationsHeadersNoHeaders to be sent with the request
queriesListExportDeterminationsQueriesNoQueries to be sent with the request

Returns: ExportDeterminationsCollectionResponse|error

Sample code:

ExportDeterminationsCollectionResponse result = check client->listExportDeterminations();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#ExportDeterminations",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "edpcs_NFe",
      "Priority": 1,
      "BusinessPartner": "C0001",
      "Country": "BR",
      "Series": 1,
      "DocumentType": "Invoice",
      "ExportFormat": 1
    }
  ],
  "odata.nextLink": "ExportDeterminations?$skip=20"
}
createExportDeterminations

Creates a new ExportDetermination entity.

Parameters:

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

Returns: ExportDetermination|error

Sample code:

ExportDetermination result = check client->createExportDeterminations(payload);

Sample response:

{
  "AbsEntry": 1,
  "Code": "edpcs_NFe",
  "Priority": 1,
  "BusinessPartner": "C0001",
  "Country": "BR",
  "Series": 1,
  "DocumentType": "Invoice",
  "ExportFormat": 1
}
getExportDeterminations

Retrieves a single ExportDetermination entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetExportDeterminationsQueriesNoQueries to be sent with the request

Returns: ExportDetermination|error

Sample code:

ExportDetermination result = check client->getExportDeterminations(1);

Sample response:

{
  "AbsEntry": 1,
  "Code": "edpcs_NFe",
  "Priority": 1,
  "BusinessPartner": "C0001",
  "Country": "BR",
  "Series": 1,
  "DocumentType": "Invoice",
  "ExportFormat": 1
}
deleteExportDeterminations

Deletes the ExportDetermination entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteExportDeterminations(1);
updateExportDeterminations

Partially updates an ExportDetermination entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadExportDeterminationYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateExportDeterminations(1, payload);

NotaFiscalCST​

listNotaFiscalCST

Queries the NotaFiscalCST collection, returning a page of Brazilian Nota Fiscal CST (tax situation code) entities.

Parameters:

NameTypeRequiredDescription
headersListNotaFiscalCSTHeadersNoHeaders to be sent with the request
queriesListNotaFiscalCSTQueriesNoQueries to be sent with the request

Returns: NotaFiscalCSTCollectionResponse|error

Sample code:

NotaFiscalCSTCollectionResponse result = check client->listNotaFiscalCST();

Sample response:

{
  "odata.metadata": "https://localhost:50000/b1s/v1/$metadata#NotaFiscalCST",
  "value": [
    {
      "ID": 1,
      "Code": "00",
      "Situation": "Tributada integralmente",
      "TaxCategory": 1,
      "CSTCodeOutgoing": "00",
      "DescriptionOutgoing": "Tributada integralmente"
    }
  ],
  "odata.nextLink": "NotaFiscalCST?$skip=20"
}
createNotaFiscalCST

Creates a new NotaFiscalCST entity.

Parameters:

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

Returns: NotaFiscalCST|error

Sample code:

NotaFiscalCST result = check client->createNotaFiscalCST(payload);

Sample response:

{
  "ID": 1,
  "Code": "00",
  "Situation": "Tributada integralmente",
  "TaxCategory": 1,
  "CSTCodeOutgoing": "00",
  "DescriptionOutgoing": "Tributada integralmente"
}
getNotaFiscalCST

Retrieves a single NotaFiscalCST entity identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetNotaFiscalCSTQueriesNoQueries to be sent with the request

Returns: NotaFiscalCST|error

Sample code:

NotaFiscalCST result = check client->getNotaFiscalCST(1);

Sample response:

{
  "ID": 1,
  "Code": "00",
  "Situation": "Tributada integralmente",
  "TaxCategory": 1,
  "CSTCodeOutgoing": "00",
  "DescriptionOutgoing": "Tributada integralmente"
}
deleteNotaFiscalCST

Deletes the NotaFiscalCST entity identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteNotaFiscalCST(1);
updateNotaFiscalCST

Partially updates a NotaFiscalCST entity using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
payloadNotaFiscalCSTYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateNotaFiscalCST(1, payload);

SelfInvoices​

selfInvoiceServiceApproveAndAdd

Approves and adds the self-invoice document supplied in the payload in a single call to the SelfInvoiceService_ApproveAndAdd function import.

Parameters:

NameTypeRequiredDescription
payloadSelfInvoiceService_ApproveAndAdd_bodyYesRequest payload containing the Document to approve and add
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->selfInvoiceServiceApproveAndAdd(payload);
selfInvoiceServiceApproveAndUpdate

Approves and updates the self-invoice document supplied in the payload in a single call to the SelfInvoiceService_ApproveAndUpdate function import.

Parameters:

NameTypeRequiredDescription
payloadSelfInvoiceService_ApproveAndUpdate_bodyYesRequest payload containing the Document to approve and update
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->selfInvoiceServiceApproveAndUpdate(payload);
selfInvoiceServiceCloseByDate

Closes self-invoice documents up to a specified date using the closing parameters supplied in the payload.

Parameters:

NameTypeRequiredDescription
payloadSelfInvoiceService_CloseByDate_bodyYesRequest payload containing the DocumentCloseParams (DocEntry, SpecifiedClosingDate, ClosingOption)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->selfInvoiceServiceCloseByDate(payload);
selfInvoiceServiceExportEWayBill

Exports the e-way bill for the self-invoice document supplied in the payload.

Parameters:

NameTypeRequiredDescription
payloadSelfInvoiceService_ExportEWayBill_bodyYesRequest payload containing the Document to export the e-way bill for
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->selfInvoiceServiceExportEWayBill(payload);
selfInvoiceServiceGetApprovalTemplates

Retrieves the approval templates applicable to the self-invoice document supplied in the payload.

Parameters:

NameTypeRequiredDescription
payloadSelfInvoiceService_GetApprovalTemplates_bodyYesRequest payload containing the Document to evaluate
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: Document|error

Sample code:

Document result = check client->selfInvoiceServiceGetApprovalTemplates(payload);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1001,
  "DocType": "dDocument_Items",
  "CardCode": "C0001",
  "CardName": "Example Vendor",
  "DocDate": "2026-07-01",
  "DocTotal": 500.00
}
selfInvoiceServiceHandleApprovalRequest

Handles a pending approval request for a self-invoice document.

Parameters:

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

Returns: error?

Sample code:

error? result = check client->selfInvoiceServiceHandleApprovalRequest();
selfInvoiceServiceInitData

Initializes and returns default data for a new self-invoice document.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->selfInvoiceServiceInitData();

Sample response:

{
  "DocEntry": 0,
  "DocNum": 0,
  "DocType": "dDocument_Items",
  "CardCode": "",
  "DocDate": "2026-07-14",
  "DocTotal": 0
}
listSelfInvoices

Queries the SelfInvoices collection, returning a page of Document entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListSelfInvoicesHeadersNoHeaders to be sent with the request
queriesListSelfInvoicesQueriesNoQueries to be sent with the request

Returns: SelfInvoicesCollectionResponse|error

Sample code:

SelfInvoicesCollectionResponse result = check client->listSelfInvoices();

Sample response:

{
  "odata.metadata": "$metadata#SelfInvoices",
  "value": [
    {
      "DocEntry": 1,
      "DocNum": 1001,
      "DocType": "dDocument_Items",
      "CardCode": "C0001",
      "CardName": "Example Vendor",
      "DocDate": "2026-07-01",
      "DocTotal": 500.00
    }
  ],
  "odata.nextLink": "SelfInvoices?$skip=20"
}
createSelfInvoices

Creates a new SelfInvoices document (a Document record) from the supplied payload.

Parameters:

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

Returns: Document|error

Sample code:

Document result = check client->createSelfInvoices(payload);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1001,
  "DocType": "dDocument_Items",
  "CardCode": "C0001",
  "CardName": "Example Vendor",
  "DocDate": "2026-07-01",
  "DocTotal": 500.00
}
getSelfInvoices

Retrieves a single SelfInvoices Document identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetSelfInvoicesQueriesNoQueries to be sent with the request

Returns: Document|error

Sample code:

Document result = check client->getSelfInvoices(1);

Sample response:

{
  "DocEntry": 1,
  "DocNum": 1001,
  "DocType": "dDocument_Items",
  "CardCode": "C0001",
  "CardName": "Example Vendor",
  "DocDate": "2026-07-01",
  "DocTotal": 500.00
}
deleteSelfInvoices

Deletes the SelfInvoices Document identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteSelfInvoices(1);
updateSelfInvoices

Partially updates (PATCH/MERGE semantics) the SelfInvoices Document identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
payloadDocumentYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateSelfInvoices(1, payload);
selfInvoicesCancel

Invokes the bound Cancel action (binding type Document) on the SelfInvoices document identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->selfInvoicesCancel(1);
selfInvoicesClose

Invokes the bound Close action (binding type Document) on the SelfInvoices document identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->selfInvoicesClose(1);
selfInvoicesCreateCancellationDocument

Invokes the bound CreateCancellationDocument action (binding type Document), creating and returning a cancellation document for the SelfInvoices document identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: Document|error

Sample code:

Document result = check client->selfInvoicesCreateCancellationDocument(1);

Sample response:

{
  "DocEntry": 2,
  "DocNum": 1002,
  "DocType": "dDocument_Items",
  "CardCode": "C0001",
  "CardName": "Example Vendor",
  "DocDate": "2026-07-14",
  "DocTotal": -500.00
}
selfInvoicesReopen

Invokes the bound Reopen action (binding type Document) on the SelfInvoices document identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->selfInvoicesReopen(1);

ServiceGroups​

listServiceGroups

Queries the ServiceGroups collection, returning a page of ServiceGroup entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListServiceGroupsHeadersNoHeaders to be sent with the request
queriesListServiceGroupsQueriesNoQueries to be sent with the request

Returns: ServiceGroupsCollectionResponse|error

Sample code:

ServiceGroupsCollectionResponse result = check client->listServiceGroups();

Sample response:

{
  "odata.metadata": "$metadata#ServiceGroups",
  "value": [
    {
      "Description": "Consulting Services",
      "ServiceGroupCode": "SG001",
      "AbsEntry": 1
    }
  ],
  "odata.nextLink": "ServiceGroups?$skip=20"
}
createServiceGroups

Creates a new ServiceGroup from the supplied payload.

Parameters:

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

Returns: ServiceGroup|error

Sample code:

ServiceGroup result = check client->createServiceGroups(payload);

Sample response:

{
  "Description": "Consulting Services",
  "ServiceGroupCode": "SG001",
  "AbsEntry": 1
}
getServiceGroups

Retrieves a single ServiceGroup identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetServiceGroupsQueriesNoQueries to be sent with the request

Returns: ServiceGroup|error

Sample code:

ServiceGroup result = check client->getServiceGroups(1);

Sample response:

{
  "Description": "Consulting Services",
  "ServiceGroupCode": "SG001",
  "AbsEntry": 1
}
deleteServiceGroups

Deletes the ServiceGroup identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteServiceGroups(1);
updateServiceGroups

Partially updates (PATCH/MERGE semantics) the ServiceGroup identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadServiceGroupYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateServiceGroups(1, payload);
serviceGroupsServiceGetServiceGroupList

Retrieves the list of service groups (AbsEntry/ServiceGroupCode pairs) via the ServiceGroupsService_GetServiceGroupList function import.

Parameters:

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

Returns: inline_response_200_43|error

Sample code:

inline_response_200_43 result = check client->serviceGroupsServiceGetServiceGroupList();

Sample response:

{
  "odata.metadata": "$metadata#ServiceGroupsService_GetServiceGroupList",
  "value": [
    {
      "ServiceGroupCode": "SG001",
      "AbsEntry": 1
    }
  ]
}

ISDDocuments​

listISDDocuments

Queries the ISDDocuments collection, returning a page of ISDDocument entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListISDDocumentsHeadersNoHeaders to be sent with the request
queriesListISDDocumentsQueriesNoQueries to be sent with the request

Returns: ISDDocumentsCollectionResponse|error

Sample code:

ISDDocumentsCollectionResponse result = check client->listISDDocuments();

Sample response:

{
  "odata.metadata": "$metadata#ISDDocuments",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 101,
      "SourceLocationCode": 1,
      "SourceLocationName": "Head Office",
      "Series": 1,
      "PostingDate": "2026-07-01",
      "DocDate": "2026-07-01",
      "DocumentStatus": "isdds_Open",
      "Revised": "tNO"
    }
  ],
  "odata.nextLink": "ISDDocuments?$skip=20"
}
createISDDocuments

Creates a new ISDDocument from the supplied payload.

Parameters:

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

Returns: ISDDocument|error

Sample code:

ISDDocument result = check client->createISDDocuments(payload);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 101,
  "SourceLocationCode": 1,
  "SourceLocationName": "Head Office",
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "DocumentStatus": "isdds_Open"
}
getISDDocuments

Retrieves a single ISDDocument identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetISDDocumentsQueriesNoQueries to be sent with the request

Returns: ISDDocument|error

Sample code:

ISDDocument result = check client->getISDDocuments(1);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 101,
  "SourceLocationCode": 1,
  "SourceLocationName": "Head Office",
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "DocumentStatus": "isdds_Open"
}
deleteISDDocuments

Deletes the ISDDocument identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteISDDocuments(1);
updateISDDocuments

Partially updates (PATCH/MERGE semantics) the ISDDocument identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
payloadISDDocumentYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateISDDocuments(1, payload);
iSDDocumentsServiceCancel

Cancels an ISD document identified by the DocumentEntry/DocumentNumber pair supplied in the payload's ISDParams.

Parameters:

NameTypeRequiredDescription
payloadISDDocumentsService_Cancel_bodyYesRequest payload containing the ISDParams (DocumentEntry, DocumentNumber)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->iSDDocumentsServiceCancel(payload);
iSDDocumentsServiceGetList

Retrieves the list of ISD document identifiers (DocumentEntry/DocumentNumber) via the ISDDocumentsService_GetList function import.

Parameters:

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

Returns: inline_response_200_28|error

Sample code:

inline_response_200_28 result = check client->iSDDocumentsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#ISDDocumentsService_GetList",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 101
    }
  ]
}

BEMReplicationPeriods​

bEMReplicationPeriodServiceGetList

Retrieves the list of BEM replication period identifiers via the BEMReplicationPeriodService_GetList function import.

Parameters:

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

Returns: inline_response_200|error

Sample code:

inline_response_200 result = check client->bEMReplicationPeriodServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#BEMReplicationPeriodService_GetList",
  "value": [
    {
      "AbsEntry": 1
    }
  ]
}
listBEMReplicationPeriods

Queries the BEMReplicationPeriods collection, returning a page of BEMReplicationPeriod entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListBEMReplicationPeriodsHeadersNoHeaders to be sent with the request
queriesListBEMReplicationPeriodsQueriesNoQueries to be sent with the request

Returns: BEMReplicationPeriodsCollectionResponse|error

Sample code:

BEMReplicationPeriodsCollectionResponse result = check client->listBEMReplicationPeriods();

Sample response:

{
  "odata.metadata": "$metadata#BEMReplicationPeriods",
  "value": [
    {
      "StartDate": "2026-07-01",
      "Status": "bemStatus_Complete",
      "UpdateDate": "2026-07-02",
      "ScopeName": "FinancialData",
      "ScopeKey": "1",
      "LastRepId": "abc123",
      "RepMessage": "Replication completed",
      "AbsEntry": 1,
      "Periodic": "bemPeriodic_Daily"
    }
  ],
  "odata.nextLink": "BEMReplicationPeriods?$skip=20"
}
createBEMReplicationPeriods

Creates a new BEMReplicationPeriod from the supplied payload.

Parameters:

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

Returns: BEMReplicationPeriod|error

Sample code:

BEMReplicationPeriod result = check client->createBEMReplicationPeriods(payload);

Sample response:

{
  "StartDate": "2026-07-01",
  "Status": "bemStatus_New",
  "ScopeName": "FinancialData",
  "ScopeKey": "1",
  "AbsEntry": 1,
  "Periodic": "bemPeriodic_Daily"
}
getBEMReplicationPeriods

Retrieves a single BEMReplicationPeriod identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetBEMReplicationPeriodsQueriesNoQueries to be sent with the request

Returns: BEMReplicationPeriod|error

Sample code:

BEMReplicationPeriod result = check client->getBEMReplicationPeriods(1);

Sample response:

{
  "StartDate": "2026-07-01",
  "Status": "bemStatus_Complete",
  "ScopeName": "FinancialData",
  "ScopeKey": "1",
  "AbsEntry": 1,
  "Periodic": "bemPeriodic_Daily"
}
deleteBEMReplicationPeriods

Deletes the BEMReplicationPeriod identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteBEMReplicationPeriods(1);
updateBEMReplicationPeriods

Partially updates (PATCH/MERGE semantics) the BEMReplicationPeriod identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadBEMReplicationPeriodYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateBEMReplicationPeriods(1, payload);

BrazilMultiIndexers​

listBrazilMultiIndexers

Queries the BrazilMultiIndexers collection, returning a page of BrazilMultiIndexer entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListBrazilMultiIndexersHeadersNoHeaders to be sent with the request
queriesListBrazilMultiIndexersQueriesNoQueries to be sent with the request

Returns: BrazilMultiIndexersCollectionResponse|error

Sample code:

BrazilMultiIndexersCollectionResponse result = check client->listBrazilMultiIndexers();

Sample response:

{
  "odata.metadata": "$metadata#BrazilMultiIndexers",
  "value": [
    {
      "SecondRefIndexerCode": "IDX2",
      "IndexerType": "bmit_Percentage",
      "FirstRefIndexerCode": "IDX1",
      "Description": "Multi indexer example",
      "ThirdRefIndexerCode": "IDX3",
      "ID": 1,
      "Code": "MI001"
    }
  ],
  "odata.nextLink": "BrazilMultiIndexers?$skip=20"
}
createBrazilMultiIndexers

Creates a new BrazilMultiIndexer from the supplied payload.

Parameters:

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

Returns: BrazilMultiIndexer|error

Sample code:

BrazilMultiIndexer result = check client->createBrazilMultiIndexers(payload);

Sample response:

{
  "SecondRefIndexerCode": "IDX2",
  "IndexerType": "bmit_Percentage",
  "FirstRefIndexerCode": "IDX1",
  "Description": "Multi indexer example",
  "ID": 1,
  "Code": "MI001"
}
getBrazilMultiIndexers

Retrieves a single BrazilMultiIndexer identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetBrazilMultiIndexersQueriesNoQueries to be sent with the request

Returns: BrazilMultiIndexer|error

Sample code:

BrazilMultiIndexer result = check client->getBrazilMultiIndexers(1);

Sample response:

{
  "SecondRefIndexerCode": "IDX2",
  "IndexerType": "bmit_Percentage",
  "FirstRefIndexerCode": "IDX1",
  "Description": "Multi indexer example",
  "ID": 1,
  "Code": "MI001"
}
deleteBrazilMultiIndexers

Deletes the BrazilMultiIndexer identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteBrazilMultiIndexers(1);
updateBrazilMultiIndexers

Partially updates (PATCH/MERGE semantics) the BrazilMultiIndexer identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
payloadBrazilMultiIndexerYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateBrazilMultiIndexers(1, payload);
brazilMultiIndexersGetIndexerTypeList

Invokes the bound GetIndexerTypeList action (binding type BrazilMultiIndexer) on the BrazilMultiIndexer identified by its ID key, returning the applicable indexer types.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: inline_response_200_3|error

Sample code:

inline_response_200_3 result = check client->brazilMultiIndexersGetIndexerTypeList(1);

Sample response:

{
  "odata.metadata": "$metadata#BrazilMultiIndexers_GetIndexerTypeList",
  "value": [
    {
      "ID": 1
    }
  ]
}

CIGCodes​

cIGCodeServiceGetList

Retrieves the list of CIG code identifiers via the CIGCodeService_GetList function import.

Parameters:

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

Returns: inline_response_200_6|error

Sample code:

inline_response_200_6 result = check client->cIGCodeServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#CIGCodeService_GetList",
  "value": [
    {
      "AbsEntry": 1
    }
  ]
}
listCIGCodes

Queries the CIGCodes collection, returning a page of CIGCode entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListCIGCodesHeadersNoHeaders to be sent with the request
queriesListCIGCodesQueriesNoQueries to be sent with the request

Returns: CIGCodesCollectionResponse|error

Sample code:

CIGCodesCollectionResponse result = check client->listCIGCodes();

Sample response:

{
  "odata.metadata": "$metadata#CIGCodes",
  "value": [
    {
      "AbsEntry": 1,
      "Orders": [],
      "Invoices": [],
      "CreditNotes": []
    }
  ],
  "odata.nextLink": "CIGCodes?$skip=20"
}
createCIGCodes

Creates a new CIGCode (a grouping of related purchase/sales documents) from the supplied payload.

Parameters:

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

Returns: CIGCode|error

Sample code:

CIGCode result = check client->createCIGCodes(payload);

Sample response:

{
  "AbsEntry": 1,
  "Orders": [],
  "Invoices": [],
  "CreditNotes": []
}
getCIGCodes

Retrieves a single CIGCode identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetCIGCodesQueriesNoQueries to be sent with the request

Returns: CIGCode|error

Sample code:

CIGCode result = check client->getCIGCodes(1);

Sample response:

{
  "AbsEntry": 1,
  "Orders": [],
  "Invoices": [],
  "CreditNotes": []
}
deleteCIGCodes

Deletes the CIGCode identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteCIGCodes(1);
updateCIGCodes

Partially updates (PATCH/MERGE semantics) the CIGCode identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadCIGCodeYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateCIGCodes(1, payload);

IndiaHsn​

listIndiaHsn

Queries the IndiaHsn collection, returning a page of IndiaHsn entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListIndiaHsnHeadersNoHeaders to be sent with the request
queriesListIndiaHsnQueriesNoQueries to be sent with the request

Returns: IndiaHsnCollectionResponse|error

Sample code:

IndiaHsnCollectionResponse result = check client->listIndiaHsn();

Sample response:

{
  "odata.metadata": "$metadata#IndiaHsn",
  "value": [
    {
      "Heading": "01",
      "Description": "Live animals",
      "Chapter": "1",
      "ChapterID": "01",
      "SubHeading": "0101",
      "AbsEntry": 1
    }
  ],
  "odata.nextLink": "IndiaHsn?$skip=20"
}
createIndiaHsn

Creates a new IndiaHsn (HSN classification code) from the supplied payload.

Parameters:

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

Returns: IndiaHsn|error

Sample code:

IndiaHsn result = check client->createIndiaHsn(payload);

Sample response:

{
  "Heading": "01",
  "Description": "Live animals",
  "Chapter": "1",
  "ChapterID": "01",
  "SubHeading": "0101",
  "AbsEntry": 1
}
getIndiaHsn

Retrieves a single IndiaHsn identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetIndiaHsnQueriesNoQueries to be sent with the request

Returns: IndiaHsn|error

Sample code:

IndiaHsn result = check client->getIndiaHsn(1);

Sample response:

{
  "Heading": "01",
  "Description": "Live animals",
  "Chapter": "1",
  "ChapterID": "01",
  "SubHeading": "0101",
  "AbsEntry": 1
}
deleteIndiaHsn

Deletes the IndiaHsn identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteIndiaHsn(1);
updateIndiaHsn

Partially updates (PATCH/MERGE semantics) the IndiaHsn identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadIndiaHsnYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateIndiaHsn(1, payload);
indiaHsnServiceGetList

Retrieves the list of India HSN code identifiers via the IndiaHsnService_GetList function import.

Parameters:

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

Returns: inline_response_200_34|error

Sample code:

inline_response_200_34 result = check client->indiaHsnServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#IndiaHsnService_GetList",
  "value": [
    {
      "ChapterID": "01",
      "AbsEntry": 1
    }
  ]
}

NFModels​

listNFModels

Queries the NFModels collection, returning a page of NFModel entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListNFModelsHeadersNoHeaders to be sent with the request
queriesListNFModelsQueriesNoQueries to be sent with the request

Returns: NFModelsCollectionResponse|error

Sample code:

NFModelsCollectionResponse result = check client->listNFModels();

Sample response:

{
  "odata.metadata": "$metadata#NFModels",
  "value": [
    {
      "AbsEntry": "1",
      "NFMCode": "55",
      "NFMDescription": "NF-e Model 55",
      "Orders": [],
      "Invoices": []
    }
  ],
  "odata.nextLink": "NFModels?$skip=20"
}
createNFModels

Creates a new NFModel (Brazilian Nota Fiscal model, grouping related documents) from the supplied payload.

Parameters:

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

Returns: NFModel|error

Sample code:

NFModel result = check client->createNFModels(payload);

Sample response:

{
  "AbsEntry": "1",
  "NFMCode": "55",
  "NFMDescription": "NF-e Model 55",
  "Orders": [],
  "Invoices": []
}
getNFModels

Retrieves a single NFModel identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntrystringYesKey property 'AbsEntry' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetNFModelsQueriesNoQueries to be sent with the request

Returns: NFModel|error

Sample code:

NFModel result = check client->getNFModels("1");

Sample response:

{
  "AbsEntry": "1",
  "NFMCode": "55",
  "NFMDescription": "NF-e Model 55",
  "Orders": [],
  "Invoices": []
}
deleteNFModels

Deletes the NFModel identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntrystringYesKey property 'AbsEntry' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteNFModels("1");
updateNFModels

Partially updates (PATCH/MERGE semantics) the NFModel identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntrystringYesKey property 'AbsEntry' (Edm.String)
payloadNFModelYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateNFModels("1", payload);
nFModelsServiceGetList

Retrieves the list of NF model identifiers via the NFModelsService_GetList function import.

Parameters:

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

Returns: inline_response_200_39|error

Sample code:

inline_response_200_39 result = check client->nFModelsServiceGetList();

Sample response:

{
  "odata.metadata": "$metadata#NFModelsService_GetList",
  "value": [
    {
      "NFMDescription": "NF-e Model 55",
      "NFMCode": "55",
      "NFMName": "Model 55"
    }
  ]
}

DatevRuns​

listDatevRuns

Queries the DatevRuns collection, returning a page of DatevRun entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListDatevRunsHeadersNoHeaders to be sent with the request
queriesListDatevRunsQueriesNoQueries to be sent with the request

Returns: DatevRunsCollectionResponse|error

Sample code:

DatevRunsCollectionResponse result = check client->listDatevRuns();

Sample response:

{
  "odata.metadata": "$metadata#DatevRuns",
  "value": [
    {
      "RunId": 1,
      "Status": "Completed",
      "Description": "Monthly DATEV export",
      "ExportPath": "C:\\Datev\\Export",
      "StartDate": "2026-07-01",
      "EndDate": "2026-07-31"
    }
  ],
  "odata.nextLink": "DatevRuns?$skip=20"
}
createDatevRuns

Creates a new DatevRun (a DATEV export run configuration) from the supplied payload.

Parameters:

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

Returns: DatevRun|error

Sample code:

DatevRun result = check client->createDatevRuns(payload);

Sample response:

{
  "RunId": 1,
  "Status": "New",
  "Description": "Monthly DATEV export",
  "StartDate": "2026-07-01",
  "EndDate": "2026-07-31"
}
getDatevRuns

Retrieves a single DatevRun identified by its RunId key.

Parameters:

NameTypeRequiredDescription
runIdint:Signed32YesKey property 'RunId' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetDatevRunsQueriesNoQueries to be sent with the request

Returns: DatevRun|error

Sample code:

DatevRun result = check client->getDatevRuns(1);

Sample response:

{
  "RunId": 1,
  "Status": "Completed",
  "Description": "Monthly DATEV export",
  "StartDate": "2026-07-01",
  "EndDate": "2026-07-31"
}
deleteDatevRuns

Deletes the DatevRun identified by its RunId key.

Parameters:

NameTypeRequiredDescription
runIdint:Signed32YesKey property 'RunId' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteDatevRuns(1);
updateDatevRuns

Partially updates (PATCH/MERGE semantics) the DatevRun identified by its RunId key.

Parameters:

NameTypeRequiredDescription
runIdint:Signed32YesKey property 'RunId' (Edm.Int32)
payloadDatevRunYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateDatevRuns(1, payload);

LegalData​

listLegalData

Queries the LegalData collection, returning a page of LegalData entities with optional OData filtering, sorting, and paging.

Parameters:

NameTypeRequiredDescription
headersListLegalDataHeadersNoHeaders to be sent with the request
queriesListLegalDataQueriesNoQueries to be sent with the request

Returns: LegalDataCollectionResponse|error

Sample code:

LegalDataCollectionResponse result = check client->listLegalData();

Sample response:

{
  "odata.metadata": "$metadata#LegalData",
  "value": [
    {
      "DocEntry": 1,
      "DocumentNumber": "FISC-0001",
      "FiscalNumber": "123456789",
      "PrinterType": "Bematech",
      "PrinterBrand": "Bematech",
      "PrinterModel": "MP-4200",
      "DateOfPrinting": "2026-07-01",
      "TimeOfPrinting": "10:15:00"
    }
  ],
  "odata.nextLink": "LegalData?$skip=20"
}
createLegalData

Creates a new LegalData (fiscal printer/legal document metadata) record from the supplied payload.

Parameters:

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

Returns: LegalData|error

Sample code:

LegalData result = check client->createLegalData(payload);

Sample response:

{
  "DocEntry": 1,
  "DocumentNumber": "FISC-0001",
  "FiscalNumber": "123456789",
  "PrinterType": "Bematech",
  "PrinterBrand": "Bematech",
  "PrinterModel": "MP-4200"
}
getLegalData

Retrieves a single LegalData record identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetLegalDataQueriesNoQueries to be sent with the request

Returns: LegalData|error

Sample code:

LegalData result = check client->getLegalData(1);

Sample response:

{
  "DocEntry": 1,
  "DocumentNumber": "FISC-0001",
  "FiscalNumber": "123456789",
  "PrinterType": "Bematech",
  "PrinterBrand": "Bematech",
  "PrinterModel": "MP-4200"
}
deleteLegalData

Deletes the LegalData record identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteLegalData(1);
updateLegalData

Partially updates (PATCH/MERGE semantics) the LegalData record identified by its DocEntry key.

Parameters:

NameTypeRequiredDescription
docEntryint:Signed32YesKey property 'DocEntry' (Edm.Int32)
payloadLegalDataYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateLegalData(1, payload);

EBooks​

listEBooks

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

Parameters:

NameTypeRequiredDescription
headersListEBooksHeadersNoHeaders to be sent with the request
queriesListEBooksQueriesNoQueries to be sent with the request

Returns: EBooksCollectionResponse|error

Sample code:

EBooksCollectionResponse result = check client->listEBooks();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#EBooks",
  "value": [
    {
      "AbsEntry": 1,
      "Series": "10",
      "InvoiceType": "itSale",
      "IssueDate": "2026-07-01",
      "TotalGrossValue": 1500.00,
      "Currency": "USD"
    }
  ],
  "odata.nextLink": "EBooks?$skip=20"
}
createEBooks

Creates a new EBooks entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: EBooks|error

Sample code:

EBooks result = check client->createEBooks(payload);

Sample response:

{
  "AbsEntry": 1,
  "Series": "10",
  "InvoiceType": "itSale",
  "IssueDate": "2026-07-01",
  "TotalGrossValue": 1500.00,
  "Currency": "USD"
}
getEBooks

Retrieves a single EBooks entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetEBooksQueriesNoQueries to be sent with the request

Returns: EBooks|error

Sample code:

EBooks result = check client->getEBooks(1);

Sample response:

{
  "AbsEntry": 1,
  "Series": "10",
  "InvoiceType": "itSale",
  "IssueDate": "2026-07-01",
  "TotalGrossValue": 1500.00,
  "Currency": "USD"
}
deleteEBooks

Deletes an EBooks entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteEBooks(1);
updateEBooks

Partially updates an EBooks entity identified by its AbsEntry key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadEBooksYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateEBooks(1, payload);
eBooksGetByDocKey

Invokes the bound action GetByDocKey on an EBooks entity to look it up by its document key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: inline_response_200_10|error

Sample code:

inline_response_200_10 result = check client->eBooksGetByDocKey(1);

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#EBooks",
  "value": [
    {
      "LinkedDocType": 13,
      "LinkedDocEntry": 45,
      "MARK": "M-001"
    }
  ]
}
eBooksGetByMark

Invokes the bound action GetByMark on an EBooks entity to look it up by its MARK value.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: EBooks|error

Sample code:

EBooks result = check client->eBooksGetByMark(1);

Sample response:

{
  "AbsEntry": 1,
  "Series": "10",
  "InvoiceType": "itSale",
  "IssueDate": "2026-07-01",
  "TotalGrossValue": 1500.00,
  "Currency": "USD"
}

ISDRecipientInvoices​

listISDRecipientInvoices

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

Parameters:

NameTypeRequiredDescription
headersListISDRecipientInvoicesHeadersNoHeaders to be sent with the request
queriesListISDRecipientInvoicesQueriesNoQueries to be sent with the request

Returns: ISDRecipientInvoicesCollectionResponse|error

Sample code:

ISDRecipientInvoicesCollectionResponse result = check client->listISDRecipientInvoices();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#ISDRecipientInvoices",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 100,
      "Series": 1,
      "PostingDate": "2026-07-01",
      "DocDate": "2026-07-01",
      "DocumentStatus": "iddsOpen"
    }
  ],
  "odata.nextLink": "ISDRecipientInvoices?$skip=20"
}
createISDRecipientInvoices

Creates a new ISDRecipientInvoice entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: ISDRecipientInvoice|error

Sample code:

ISDRecipientInvoice result = check client->createISDRecipientInvoices(payload);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 100,
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "DocumentStatus": "iddsOpen"
}
getISDRecipientInvoices

Retrieves a single ISDRecipientInvoice entity identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetISDRecipientInvoicesQueriesNoQueries to be sent with the request

Returns: ISDRecipientInvoice|error

Sample code:

ISDRecipientInvoice result = check client->getISDRecipientInvoices(1);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 100,
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "DocumentStatus": "iddsOpen"
}
deleteISDRecipientInvoices

Deletes an ISDRecipientInvoice entity identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteISDRecipientInvoices(1);
updateISDRecipientInvoices

Partially updates an ISDRecipientInvoice entity identified by its DocumentEntry key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
payloadISDRecipientInvoiceYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateISDRecipientInvoices(1, payload);
iSDRecipientInvoicesCancel

Invokes the bound action Cancel on an ISDRecipientInvoice entity to cancel it.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->iSDRecipientInvoicesCancel(1);
iSDRecipientInvoicesServiceGetList

Calls the ISDRecipientInvoicesService_GetList function-import to retrieve a list of ISD recipient invoice params.

Parameters:

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

Returns: inline_response_200_31|error

Sample code:

inline_response_200_31 result = check client->iSDRecipientInvoicesServiceGetList();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#ISDRecipientInvoices",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 100
    }
  ]
}

ISDCreditMemos​

listISDCreditMemos

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

Parameters:

NameTypeRequiredDescription
headersListISDCreditMemosHeadersNoHeaders to be sent with the request
queriesListISDCreditMemosQueriesNoQueries to be sent with the request

Returns: ISDCreditMemosCollectionResponse|error

Sample code:

ISDCreditMemosCollectionResponse result = check client->listISDCreditMemos();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#ISDCreditMemos",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 200,
      "Series": 1,
      "PostingDate": "2026-07-01",
      "DocDate": "2026-07-01",
      "DocumentStatus": "iddsOpen"
    }
  ],
  "odata.nextLink": "ISDCreditMemos?$skip=20"
}
createISDCreditMemos

Creates a new ISDCreditMemo entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: ISDCreditMemo|error

Sample code:

ISDCreditMemo result = check client->createISDCreditMemos(payload);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 200,
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "DocumentStatus": "iddsOpen"
}
getISDCreditMemos

Retrieves a single ISDCreditMemo entity identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetISDCreditMemosQueriesNoQueries to be sent with the request

Returns: ISDCreditMemo|error

Sample code:

ISDCreditMemo result = check client->getISDCreditMemos(1);

Sample response:

{
  "DocumentEntry": 1,
  "DocumentNumber": 200,
  "Series": 1,
  "PostingDate": "2026-07-01",
  "DocDate": "2026-07-01",
  "DocumentStatus": "iddsOpen"
}
deleteISDCreditMemos

Deletes an ISDCreditMemo entity identified by its DocumentEntry key.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteISDCreditMemos(1);
updateISDCreditMemos

Partially updates an ISDCreditMemo entity identified by its DocumentEntry key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
payloadISDCreditMemoYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateISDCreditMemos(1, payload);
iSDCreditMemosCancel

Invokes the bound action Cancel on an ISDCreditMemo entity to cancel it.

Parameters:

NameTypeRequiredDescription
documentEntryint:Signed32YesKey property 'DocumentEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->iSDCreditMemosCancel(1);
iSDCreditMemosServiceGetList

Calls the ISDCreditMemosService_GetList function-import to retrieve a list of ISD credit memo params.

Parameters:

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

Returns: inline_response_200_27|error

Sample code:

inline_response_200_27 result = check client->iSDCreditMemosServiceGetList();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#ISDCreditMemos",
  "value": [
    {
      "DocumentEntry": 1,
      "DocumentNumber": 200
    }
  ]
}

TransportationDocument​

listTransportationDocument

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

Parameters:

NameTypeRequiredDescription
headersListTransportationDocumentHeadersNoHeaders to be sent with the request
queriesListTransportationDocumentQueriesNoQueries to be sent with the request

Returns: TransportationDocumentCollectionResponse|error

Sample code:

TransportationDocumentCollectionResponse result = check client->listTransportationDocument();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#TransportationDocument",
  "value": [
    {
      "TranspDocNumber": 1,
      "TransportationNumber": "TR-001",
      "VehicleID": "V-100",
      "WarehouseCode": "WH01",
      "Weight": 1200.5,
      "Canceled": "tNO"
    }
  ],
  "odata.nextLink": "TransportationDocument?$skip=20"
}
createTransportationDocument

Creates a new TransportationDocumentData entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: TransportationDocumentData|error

Sample code:

TransportationDocumentData result = check client->createTransportationDocument(payload);

Sample response:

{
  "TranspDocNumber": 1,
  "TransportationNumber": "TR-001",
  "VehicleID": "V-100",
  "WarehouseCode": "WH01",
  "Weight": 1200.5,
  "Canceled": "tNO"
}
getTransportationDocument

Retrieves a single TransportationDocumentData entity identified by its TranspDocNumber key.

Parameters:

NameTypeRequiredDescription
transpDocNumberint:Signed32YesKey property 'TranspDocNumber' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetTransportationDocumentQueriesNoQueries to be sent with the request

Returns: TransportationDocumentData|error

Sample code:

TransportationDocumentData result = check client->getTransportationDocument(1);

Sample response:

{
  "TranspDocNumber": 1,
  "TransportationNumber": "TR-001",
  "VehicleID": "V-100",
  "WarehouseCode": "WH01",
  "Weight": 1200.5,
  "Canceled": "tNO"
}
deleteTransportationDocument

Deletes a TransportationDocumentData entity identified by its TranspDocNumber key.

Parameters:

NameTypeRequiredDescription
transpDocNumberint:Signed32YesKey property 'TranspDocNumber' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteTransportationDocument(1);
updateTransportationDocument

Partially updates a TransportationDocumentData entity identified by its TranspDocNumber key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
transpDocNumberint:Signed32YesKey property 'TranspDocNumber' (Edm.Int32)
payloadTransportationDocumentDataYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateTransportationDocument(1, payload);
transportationDocumentCancelTransportationDocument

Invokes the bound action CancelTransportationDocument on a TransportationDocumentData entity to cancel it.

Parameters:

NameTypeRequiredDescription
transpDocNumberint:Signed32YesKey property 'TranspDocNumber' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->transportationDocumentCancelTransportationDocument(1);

BrazilNumericIndexers​

listBrazilNumericIndexers

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

Parameters:

NameTypeRequiredDescription
headersListBrazilNumericIndexersHeadersNoHeaders to be sent with the request
queriesListBrazilNumericIndexersQueriesNoQueries to be sent with the request

Returns: BrazilNumericIndexersCollectionResponse|error

Sample code:

BrazilNumericIndexersCollectionResponse result = check client->listBrazilNumericIndexers();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#BrazilNumericIndexers",
  "value": [
    {
      "IndexerType": "bnitFuelGroup",
      "Description": "Fuel group indexer",
      "ID": 1,
      "Code": 10
    }
  ],
  "odata.nextLink": "BrazilNumericIndexers?$skip=20"
}
createBrazilNumericIndexers

Creates a new BrazilNumericIndexer entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: BrazilNumericIndexer|error

Sample code:

BrazilNumericIndexer result = check client->createBrazilNumericIndexers(payload);

Sample response:

{
  "IndexerType": "bnitFuelGroup",
  "Description": "Fuel group indexer",
  "ID": 1,
  "Code": 10
}
getBrazilNumericIndexers

Retrieves a single BrazilNumericIndexer entity identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetBrazilNumericIndexersQueriesNoQueries to be sent with the request

Returns: BrazilNumericIndexer|error

Sample code:

BrazilNumericIndexer result = check client->getBrazilNumericIndexers(1);

Sample response:

{
  "IndexerType": "bnitFuelGroup",
  "Description": "Fuel group indexer",
  "ID": 1,
  "Code": 10
}
deleteBrazilNumericIndexers

Deletes a BrazilNumericIndexer entity identified by its ID key.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteBrazilNumericIndexers(1);
updateBrazilNumericIndexers

Partially updates a BrazilNumericIndexer entity identified by its ID key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
payloadBrazilNumericIndexerYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateBrazilNumericIndexers(1, payload);
brazilNumericIndexersGetIndexerTypeList

Invokes the bound action GetIndexerTypeList on a BrazilNumericIndexer entity to retrieve its list of indexer type params.

Parameters:

NameTypeRequiredDescription
iDint:Signed32YesKey property 'ID' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: inline_response_200_4|error

Sample code:

inline_response_200_4 result = check client->brazilNumericIndexersGetIndexerTypeList(1);

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#BrazilNumericIndexers",
  "value": [
    {
      "ID": 1
    }
  ]
}

CertificateSeries​

listCertificateSeries

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

Parameters:

NameTypeRequiredDescription
headersListCertificateSeriesHeadersNoHeaders to be sent with the request
queriesListCertificateSeriesQueriesNoQueries to be sent with the request

Returns: CertificateSeriesCollectionResponse|error

Sample code:

CertificateSeriesCollectionResponse result = check client->listCertificateSeries();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#CertificateSeries",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "CS-01",
      "Section": 1,
      "DefaultSeries": 1,
      "Location": 1
    }
  ],
  "odata.nextLink": "CertificateSeries?$skip=20"
}
createCertificateSeries

Creates a new CertificateSeries entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: CertificateSeries|error

Sample code:

CertificateSeries result = check client->createCertificateSeries(payload);

Sample response:

{
  "AbsEntry": 1,
  "Code": "CS-01",
  "Section": 1,
  "DefaultSeries": 1,
  "Location": 1
}
getCertificateSeries

Retrieves a single CertificateSeries entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetCertificateSeriesQueriesNoQueries to be sent with the request

Returns: CertificateSeries|error

Sample code:

CertificateSeries result = check client->getCertificateSeries(1);

Sample response:

{
  "AbsEntry": 1,
  "Code": "CS-01",
  "Section": 1,
  "DefaultSeries": 1,
  "Location": 1
}
deleteCertificateSeries

Deletes a CertificateSeries entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteCertificateSeries(1);
updateCertificateSeries

Partially updates a CertificateSeries entity identified by its AbsEntry key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadCertificateSeriesYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateCertificateSeries(1, payload);
certificateSeriesServiceGetCertificateSeriesList

Calls the CertificateSeriesService_GetCertificateSeriesList function-import to retrieve the certificate series list.

Parameters:

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

Returns: inline_response_200_8|error

Sample code:

inline_response_200_8 result = check client->certificateSeriesServiceGetCertificateSeriesList();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#CertificateSeries",
  "value": [
    {
      "AbsEntry": 1,
      "Code": "CS-01",
      "Section": 1
    }
  ]
}

IndiaSacCode​

listIndiaSacCode

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

Parameters:

NameTypeRequiredDescription
headersListIndiaSacCodeHeadersNoHeaders to be sent with the request
queriesListIndiaSacCodeQueriesNoQueries to be sent with the request

Returns: IndiaSacCodeCollectionResponse|error

Sample code:

IndiaSacCodeCollectionResponse result = check client->listIndiaSacCode();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#IndiaSacCode",
  "value": [
    {
      "ServiceCode": "SAC001",
      "ServiceName": "Consulting services",
      "AbsEntry": 1
    }
  ],
  "odata.nextLink": "IndiaSacCode?$skip=20"
}
createIndiaSacCode

Creates a new IndiaSacCode entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: IndiaSacCode|error

Sample code:

IndiaSacCode result = check client->createIndiaSacCode(payload);

Sample response:

{
  "ServiceCode": "SAC001",
  "ServiceName": "Consulting services",
  "AbsEntry": 1
}
getIndiaSacCode

Retrieves a single IndiaSacCode entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetIndiaSacCodeQueriesNoQueries to be sent with the request

Returns: IndiaSacCode|error

Sample code:

IndiaSacCode result = check client->getIndiaSacCode(1);

Sample response:

{
  "ServiceCode": "SAC001",
  "ServiceName": "Consulting services",
  "AbsEntry": 1
}
deleteIndiaSacCode

Deletes an IndiaSacCode entity identified by its AbsEntry key.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteIndiaSacCode(1);
updateIndiaSacCode

Partially updates an IndiaSacCode entity identified by its AbsEntry key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absEntryint:Signed32YesKey property 'AbsEntry' (Edm.Int32)
payloadIndiaSacCodeYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateIndiaSacCode(1, payload);
indiaSacCodeServiceGetList

Calls the IndiaSacCodeService_GetList function-import to retrieve a list of India SAC code params.

Parameters:

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

Returns: inline_response_200_35|error

Sample code:

inline_response_200_35 result = check client->indiaSacCodeServiceGetList();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#IndiaSacCode",
  "value": [
    {
      "ServiceCode": "SAC001",
      "AbsEntry": 1
    }
  ]
}

NFTaxCategories​

listNFTaxCategories

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

Parameters:

NameTypeRequiredDescription
headersListNFTaxCategoriesHeadersNoHeaders to be sent with the request
queriesListNFTaxCategoriesQueriesNoQueries to be sent with the request

Returns: NFTaxCategoriesCollectionResponse|error

Sample code:

NFTaxCategoriesCollectionResponse result = check client->listNFTaxCategories();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#NFTaxCategories",
  "value": [
    {
      "Locked": "tNO",
      "GPCId": 5,
      "Code": "NFT01",
      "AbsId": 1,
      "CESTrel": "tNO"
    }
  ],
  "odata.nextLink": "NFTaxCategories?$skip=20"
}
createNFTaxCategories

Creates a new NFTaxCategory entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: NFTaxCategory|error

Sample code:

NFTaxCategory result = check client->createNFTaxCategories(payload);

Sample response:

{
  "Locked": "tNO",
  "GPCId": 5,
  "Code": "NFT01",
  "AbsId": 1,
  "CESTrel": "tNO"
}
getNFTaxCategories

Retrieves a single NFTaxCategory entity identified by its AbsId key.

Parameters:

NameTypeRequiredDescription
absIdint:Signed32YesKey property 'AbsId' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetNFTaxCategoriesQueriesNoQueries to be sent with the request

Returns: NFTaxCategory|error

Sample code:

NFTaxCategory result = check client->getNFTaxCategories(1);

Sample response:

{
  "Locked": "tNO",
  "GPCId": 5,
  "Code": "NFT01",
  "AbsId": 1,
  "CESTrel": "tNO"
}
deleteNFTaxCategories

Deletes an NFTaxCategory entity identified by its AbsId key.

Parameters:

NameTypeRequiredDescription
absIdint:Signed32YesKey property 'AbsId' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteNFTaxCategories(1);
updateNFTaxCategories

Partially updates an NFTaxCategory entity identified by its AbsId key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
absIdint:Signed32YesKey property 'AbsId' (Edm.Int32)
payloadNFTaxCategoryYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateNFTaxCategories(1, payload);
nFTaxCategoriesServiceGetList

Calls the NFTaxCategoriesService_GetList function-import to retrieve a list of NF tax category params.

Parameters:

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

Returns: inline_response_200_40|error

Sample code:

inline_response_200_40 result = check client->nFTaxCategoriesServiceGetList();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#NFTaxCategories",
  "value": [
    {
      "Code": "NFT01",
      "AbsId": 1
    }
  ]
}

DefaultElementsforCR​

listDefaultElementsforCR

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

Parameters:

NameTypeRequiredDescription
headersListDefaultElementsforCRHeadersNoHeaders to be sent with the request
queriesListDefaultElementsforCRQueriesNoQueries to be sent with the request

Returns: DefaultElementsforCRCollectionResponse|error

Sample code:

DefaultElementsforCRCollectionResponse result = check client->listDefaultElementsforCR();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#DefaultElementsforCR",
  "value": [
    {
      "Code": 1,
      "Name": "Default CR Element"
    }
  ],
  "odata.nextLink": "DefaultElementsforCR?$skip=20"
}
createDefaultElementsforCR

Creates a new DefaultElementsforCR entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: DefaultElementsforCR|error

Sample code:

DefaultElementsforCR result = check client->createDefaultElementsforCR(payload);

Sample response:

{
  "Code": 1,
  "Name": "Default CR Element"
}
getDefaultElementsforCR

Retrieves a single DefaultElementsforCR entity identified by its Code key.

Parameters:

NameTypeRequiredDescription
codeint:Signed32YesKey property 'Code' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetDefaultElementsforCRQueriesNoQueries to be sent with the request

Returns: DefaultElementsforCR|error

Sample code:

DefaultElementsforCR result = check client->getDefaultElementsforCR(1);

Sample response:

{
  "Code": 1,
  "Name": "Default CR Element"
}
deleteDefaultElementsforCR

Deletes a DefaultElementsforCR entity identified by its Code key.

Parameters:

NameTypeRequiredDescription
codeint:Signed32YesKey property 'Code' (Edm.Int32)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteDefaultElementsforCR(1);
updateDefaultElementsforCR

Partially updates a DefaultElementsforCR entity identified by its Code key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
codeint:Signed32YesKey property 'Code' (Edm.Int32)
payloadDefaultElementsforCRYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateDefaultElementsforCR(1, payload);

LocalEra​

listLocalEra

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

Parameters:

NameTypeRequiredDescription
headersListLocalEraHeadersNoHeaders to be sent with the request
queriesListLocalEraQueriesNoQueries to be sent with the request

Returns: LocalEraCollectionResponse|error

Sample code:

LocalEraCollectionResponse result = check client->listLocalEra();

Sample response:

{
  "odata.metadata": "https://service-layer-host:50000/b1s/v1/$metadata#LocalEra",
  "value": [
    {
      "EraName": "Reiwa",
      "StartDate": "2019-05-01",
      "Code": "R"
    }
  ],
  "odata.nextLink": "LocalEra?$skip=20"
}
createLocalEra

Creates a new LocalEra entity from the supplied payload and returns the created entity.

Parameters:

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

Returns: LocalEra|error

Sample code:

LocalEra result = check client->createLocalEra(payload);

Sample response:

{
  "EraName": "Reiwa",
  "StartDate": "2019-05-01",
  "Code": "R"
}
getLocalEra

Retrieves a single LocalEra entity identified by its Code key.

Parameters:

NameTypeRequiredDescription
codestringYesKey property 'Code' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request
queriesGetLocalEraQueriesNoQueries to be sent with the request

Returns: LocalEra|error

Sample code:

LocalEra result = check client->getLocalEra("R");

Sample response:

{
  "EraName": "Reiwa",
  "StartDate": "2019-05-01",
  "Code": "R"
}
deleteLocalEra

Deletes a LocalEra entity identified by its Code key.

Parameters:

NameTypeRequiredDescription
codestringYesKey property 'Code' (Edm.String)
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->deleteLocalEra("R");
updateLocalEra

Partially updates a LocalEra entity identified by its Code key using PATCH/MERGE semantics.

Parameters:

NameTypeRequiredDescription
codestringYesKey property 'Code' (Edm.String)
payloadLocalEraYesRequest payload
headersmap<string|string[]>NoHeaders to be sent with the request

Returns: error?

Sample code:

error? result = check client->updateLocalEra("R", payload);