Actions

The ballerinax/microsoft.dynamics365.finance.system package exposes the following clients:

Client	Purpose
`Client`	Provides full CRUD access to Microsoft Dynamics 365 Finance System entities via the OData REST API.

Client

Provides full CRUD access to Microsoft Dynamics 365 Finance System entities via the OData REST API.

Configuration

Field	Type	Default	Description
`auth`	`OAuth2ClientCredentialsGrantConfig`	Required	OAuth2 client credentials grant configuration used to authenticate with Microsoft Entra ID (`tokenUrl`, `clientId`, `clientSecret`, `scopes`).
`httpVersion`	`http:HttpVersion`	`http:HTTP_2_0`	The HTTP version understood by the client.
`http1Settings`	`http:ClientHttp1Settings`	`{}`	Configurations related to the HTTP/1.x protocol.
`secureSocket`	`http:ClientSecureSocket`	`()`	SSL/TLS-related options.
`proxy`	`http:ProxyConfig`	`()`	Proxy server related options.

Initializing the client

import ballerinax/microsoft.dynamics365.finance.system;

configurable string tokenUrl = ?;
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string serviceUrl = ?;

system:Client fo = check new (
    {
        auth: {
            tokenUrl,
            clientId,
            clientSecret
        }
    },
    serviceUrl
);

Operations

Abbreviations

listAbbreviations

Lists Abbreviations records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListAbbreviationsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: AbbreviationsCollection|error

Sample code:

system:AbbreviationsCollection result = check fo->listAbbreviations();

createAbbreviations

Creates a new Abbreviations record.

Parameters:

Name	Type	Required	Description
`payload`	`Abbreviations`	Yes	The Abbreviations record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: Abbreviations|error

Sample code:

system:Abbreviations payload = {
    addrTypeCode: "HQ",
    addrTypeName: "Headquarters",
    addrTypeFullName: "Corporate Headquarters",
    addrTypeLevel: 1
};
system:Abbreviations result = check fo->createAbbreviations(payload);

getAbbreviations

Retrieves a single Abbreviations by its key.

Parameters:

Name	Type	Required	Description
`addrTypeCode`	`string`	Yes	The address type code key field, e.g. `"HQ"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetAbbreviationsQueries`	No	OData query options: `$expand`, `$select`.

Returns: Abbreviations|error

Sample code:

system:Abbreviations result = check fo->getAbbreviations("HQ");

deleteAbbreviations

Deletes a Abbreviations by its key.

Parameters:

Name	Type	Required	Description
`addrTypeCode`	`string`	Yes	The address type code key field, e.g. `"HQ"`.
`headers`	`DeleteAbbreviationsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteAbbreviations("HQ");

updateAbbreviations

Updates an existing Abbreviations.

Parameters:

Name	Type	Required	Description
`addrTypeCode`	`string`	Yes	The address type code key field, e.g. `"HQ"`.
`payload`	`Abbreviations`	Yes	The fields to update.
`headers`	`UpdateAbbreviationsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: Abbreviations|error

Sample code:

system:Abbreviations payload = {
    addrTypeFullName: "Global Corporate Headquarters"
};
system:Abbreviations result = check fo->updateAbbreviations("HQ", payload);

All Products

listAllProducts

Lists EveryProduct records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListAllProductsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: AllProductsCollection|error

Sample code:

system:AllProductsCollection result = check fo->listAllProducts();

createAllProducts

Creates a new EveryProduct.

Parameters:

Name	Type	Required	Description
`payload`	`EveryProduct`	Yes	The EveryProduct record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: EveryProduct|error

Sample code:

system:EveryProduct payload = {
    productNumber: "P-1001",
    productName: "Widget A",
    productDescription: "Standard widget",
    productSearchName: "WIDGETA"
};
system:EveryProduct result = check fo->createAllProducts(payload);

getAllProducts

Retrieves a single EveryProduct by its key.

Parameters:

Name	Type	Required	Description
`productNumber`	`string`	Yes	The product number key field, e.g. `"P-1001"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetAllProductsQueries`	No	OData query options: `$expand`, `$select`.

Returns: EveryProduct|error

Sample code:

system:EveryProduct result = check fo->getAllProducts("P-1001");

deleteAllProducts

Deletes a EveryProduct by its key.

Parameters:

Name	Type	Required	Description
`productNumber`	`string`	Yes	The product number key field, e.g. `"P-1001"`.
`headers`	`DeleteAllProductsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteAllProducts("P-1001");

updateAllProducts

Updates an existing EveryProduct.

Parameters:

Name	Type	Required	Description
`productNumber`	`string`	Yes	The product number key field, e.g. `"P-1001"`.
`payload`	`EveryProduct`	Yes	The fields to update.
`headers`	`UpdateAllProductsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: EveryProduct|error

Sample code:

system:EveryProduct payload = {
    productDescription: "Standard widget - revised"
};
system:EveryProduct result = check fo->updateAllProducts("P-1001", payload);

CFPS Table

listCFPSTable

Lists CFPSTable records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListCFPSTableQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: CFPSTableCollection|error

Sample code:

system:CFPSTableCollection result = check fo->listCFPSTable();

createCFPSTable

Creates a new CFPSTable.

Parameters:

Name	Type	Required	Description
`payload`	`CFPSTable`	Yes	The CFPSTable record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: CFPSTable|error

Sample code:

system:CFPSTable payload = {
    dataAreaId: "BRMF",
    transactionType: "Sales",
    cFPSCode: "CFPS-01",
    name: "Standard CFPS code",
    searchName: "CFPS01"
};
system:CFPSTable result = check fo->createCFPSTable(payload);

getCFPSTable

Retrieves a single CFPSTable by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"BRMF"`.
`transactionType`	`string`	Yes	The transaction type key field (`Sales`, `Purch`, or `Both`), e.g. `"Sales"`.
`cFPSCode`	`string`	Yes	The CFPS code key field, e.g. `"CFPS-01"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetCFPSTableQueries`	No	OData query options: `$expand`, `$select`.

Returns: CFPSTable|error

Sample code:

system:CFPSTable result = check fo->getCFPSTable("BRMF", "Sales", "CFPS-01");

deleteCFPSTable

Deletes a CFPSTable by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"BRMF"`.
`transactionType`	`string`	Yes	The transaction type key field, e.g. `"Sales"`.
`cFPSCode`	`string`	Yes	The CFPS code key field, e.g. `"CFPS-01"`.
`headers`	`DeleteCFPSTableHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteCFPSTable("BRMF", "Sales", "CFPS-01");

updateCFPSTable

Updates an existing CFPSTable.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"BRMF"`.
`transactionType`	`string`	Yes	The transaction type key field, e.g. `"Sales"`.
`cFPSCode`	`string`	Yes	The CFPS code key field, e.g. `"CFPS-01"`.
`payload`	`CFPSTable`	Yes	The fields to update.
`headers`	`UpdateCFPSTableHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: CFPSTable|error

Sample code:

system:CFPSTable payload = {
    name: "Standard CFPS code - revised"
};
system:CFPSTable result = check fo->updateCFPSTable("BRMF", "Sales", "CFPS-01", payload);

Components

listComponents

Lists Component records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListComponentsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: ComponentsCollection|error

Sample code:

system:ComponentsCollection result = check fo->listComponents();

createComponents

Creates a new Component.

Parameters:

Name	Type	Required	Description
`payload`	`Component`	Yes	The Component record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: Component|error

Sample code:

system:Component payload = {
    dataAreaId: "INMF",
    taxType: "GST",
    taxComponent: "CGST",
    description: "Central GST component"
};
system:Component result = check fo->createComponents(payload);

getComponents

Retrieves a single Component by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"INMF"`.
`taxComponent`	`string`	Yes	The tax component key field, e.g. `"CGST"`.
`taxType`	`string`	Yes	The tax type key field, e.g. `"GST"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetComponentsQueries`	No	OData query options: `$expand`, `$select`.

Returns: Component|error

Sample code:

system:Component result = check fo->getComponents("INMF", "CGST", "GST");

deleteComponents

Deletes a Component by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"INMF"`.
`taxComponent`	`string`	Yes	The tax component key field, e.g. `"CGST"`.
`taxType`	`string`	Yes	The tax type key field, e.g. `"GST"`.
`headers`	`DeleteComponentsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteComponents("INMF", "CGST", "GST");

updateComponents

Updates an existing Component.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"INMF"`.
`taxComponent`	`string`	Yes	The tax component key field, e.g. `"CGST"`.
`taxType`	`string`	Yes	The tax type key field, e.g. `"GST"`.
`payload`	`Component`	Yes	The fields to update.
`headers`	`UpdateComponentsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: Component|error

Sample code:

system:Component payload = {
    description: "Central GST component - revised"
};
system:Component result = check fo->updateComponents("INMF", "CGST", "GST", payload);

Date Intervals

listDateIntervals

Lists DateInterval records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListDateIntervalsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: DateIntervalsCollection|error

Sample code:

system:DateIntervalsCollection result = check fo->listDateIntervals();

createDateIntervals

Creates a new DateInterval.

Parameters:

Name	Type	Required	Description
`payload`	`DateInterval`	Yes	The DateInterval record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: DateInterval|error

Sample code:

system:DateInterval payload = {
    dataAreaId: "USMF",
    dateIntervalCode: "FY-STD",
    description: "Standard fiscal year interval",
    startPeriodType: "FiscalYear",
    endPeriodType: "FiscalYear"
};
system:DateInterval result = check fo->createDateIntervals(payload);

getDateIntervals

Retrieves a single DateInterval by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`dateIntervalCode`	`string`	Yes	The date interval code key field, e.g. `"FY-STD"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetDateIntervalsQueries`	No	OData query options: `$expand`, `$select`.

Returns: DateInterval|error

Sample code:

system:DateInterval result = check fo->getDateIntervals("USMF", "FY-STD");

deleteDateIntervals

Deletes a DateInterval by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`dateIntervalCode`	`string`	Yes	The date interval code key field, e.g. `"FY-STD"`.
`headers`	`DeleteDateIntervalsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteDateIntervals("USMF", "FY-STD");

updateDateIntervals

Updates an existing DateInterval.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`dateIntervalCode`	`string`	Yes	The date interval code key field, e.g. `"FY-STD"`.
`payload`	`DateInterval`	Yes	The fields to update.
`headers`	`UpdateDateIntervalsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: DateInterval|error

Sample code:

system:DateInterval payload = {
    description: "Standard fiscal year interval - revised"
};
system:DateInterval result = check fo->updateDateIntervals("USMF", "FY-STD", payload);

EM Item Types

listEMItemTypes

Lists EMItemType records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListEMItemTypesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: EMItemTypesCollection|error

Sample code:

system:EMItemTypesCollection result = check fo->listEMItemTypes();

createEMItemTypes

Creates a new EMItemType.

Parameters:

Name	Type	Required	Description
`payload`	`EMItemType`	Yes	The EMItemType record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: EMItemType|error

Sample code:

system:EMItemType payload = {
    dataAreaId: "USMF",
    messageItemType: "EXPCTRL",
    description: "Export control message item"
};
system:EMItemType result = check fo->createEMItemTypes(payload);

getEMItemTypes

Retrieves a single EMItemType by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`messageItemType`	`string`	Yes	The message item type key field, e.g. `"EXPCTRL"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetEMItemTypesQueries`	No	OData query options: `$expand`, `$select`.

Returns: EMItemType|error

Sample code:

system:EMItemType result = check fo->getEMItemTypes("USMF", "EXPCTRL");

deleteEMItemTypes

Deletes a EMItemType by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`messageItemType`	`string`	Yes	The message item type key field, e.g. `"EXPCTRL"`.
`headers`	`DeleteEMItemTypesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteEMItemTypes("USMF", "EXPCTRL");

updateEMItemTypes

Updates an existing EMItemType.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`messageItemType`	`string`	Yes	The message item type key field, e.g. `"EXPCTRL"`.
`payload`	`EMItemType`	Yes	The fields to update.
`headers`	`UpdateEMItemTypesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: EMItemType|error

Sample code:

system:EMItemType payload = {
    description: "Export control message item - revised"
};
system:EMItemType result = check fo->updateEMItemTypes("USMF", "EXPCTRL", payload);

Estate Status

listEstateStatus

Lists EstateStatus records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListEstateStatusQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: EstateStatusCollection|error

Sample code:

system:EstateStatusCollection result = check fo->listEstateStatus();

createEstateStatus

Creates a new EstateStatus.

Parameters:

Name	Type	Required	Description
`payload`	`EstateStatus`	Yes	The EstateStatus record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: EstateStatus|error

Sample code:

system:EstateStatus payload = {
    dataAreaId: "RUMF",
    estStatId: "ACTIVE",
    name: "Active estate"
};
system:EstateStatus result = check fo->createEstateStatus(payload);

getEstateStatus

Retrieves a single EstateStatus by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`estStatId`	`string`	Yes	The estate status id key field, e.g. `"ACTIVE"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetEstateStatusQueries`	No	OData query options: `$expand`, `$select`.

Returns: EstateStatus|error

Sample code:

system:EstateStatus result = check fo->getEstateStatus("RUMF", "ACTIVE");

deleteEstateStatus

Deletes a EstateStatus by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`estStatId`	`string`	Yes	The estate status id key field, e.g. `"ACTIVE"`.
`headers`	`DeleteEstateStatusHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteEstateStatus("RUMF", "ACTIVE");

updateEstateStatus

Updates an existing EstateStatus.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`estStatId`	`string`	Yes	The estate status id key field, e.g. `"ACTIVE"`.
`payload`	`EstateStatus`	Yes	The fields to update.
`headers`	`UpdateEstateStatusHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: EstateStatus|error

Sample code:

system:EstateStatus payload = {
    name: "Active estate - revised"
};
system:EstateStatus result = check fo->updateEstateStatus("RUMF", "ACTIVE", payload);

Ext Code Tables

listExtCodeTables

Lists ExtCodeTable records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListExtCodeTablesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: ExtCodeTablesCollection|error

Sample code:

system:ExtCodeTablesCollection result = check fo->listExtCodeTables();

createExtCodeTables

Creates a new ExtCodeTable.

Parameters:

Name	Type	Required	Description
`payload`	`ExtCodeTable`	Yes	The ExtCodeTable record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: ExtCodeTable|error

Sample code:

system:ExtCodeTable payload = {
    dataAreaId: "MXMF",
    codeType: "UnitOfMeasure",
    version: "2.0",
    codeId: "H87",
    description: "Piece",
    validFrom: "2026-01-01"
};
system:ExtCodeTable result = check fo->createExtCodeTables(payload);

getExtCodeTables

Retrieves a single ExtCodeTable by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"MXMF"`.
`codeType`	`string`	Yes	The extended code type key field, e.g. `"UnitOfMeasure"`.
`version`	`string`	Yes	The code table version key field, e.g. `"2.0"`.
`codeId`	`string`	Yes	The code id key field, e.g. `"H87"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetExtCodeTablesQueries`	No	OData query options: `$expand`, `$select`.

Returns: ExtCodeTable|error

Sample code:

system:ExtCodeTable result = check fo->getExtCodeTables("MXMF", "UnitOfMeasure", "2.0", "H87");

deleteExtCodeTables

Deletes a ExtCodeTable by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"MXMF"`.
`codeType`	`string`	Yes	The extended code type key field, e.g. `"UnitOfMeasure"`.
`version`	`string`	Yes	The code table version key field, e.g. `"2.0"`.
`codeId`	`string`	Yes	The code id key field, e.g. `"H87"`.
`headers`	`DeleteExtCodeTablesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteExtCodeTables("MXMF", "UnitOfMeasure", "2.0", "H87");

updateExtCodeTables

Updates an existing ExtCodeTable.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"MXMF"`.
`codeType`	`string`	Yes	The extended code type key field, e.g. `"UnitOfMeasure"`.
`version`	`string`	Yes	The code table version key field, e.g. `"2.0"`.
`codeId`	`string`	Yes	The code id key field, e.g. `"H87"`.
`payload`	`ExtCodeTable`	Yes	The fields to update.
`headers`	`UpdateExtCodeTablesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: ExtCodeTable|error

Sample code:

system:ExtCodeTable payload = {
    description: "Piece (unit)"
};
system:ExtCodeTable result = check fo->updateExtCodeTables("MXMF", "UnitOfMeasure", "2.0", "H87", payload);

Format Codes

listFormatCodes

Lists FormatCode records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListFormatCodesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: FormatCodesCollection|error

Sample code:

system:FormatCodesCollection result = check fo->listFormatCodes();

createFormatCodes

Creates a new FormatCode.

Parameters:

Name	Type	Required	Description
`payload`	`FormatCode`	Yes	The FormatCode record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: FormatCode|error

Sample code:

system:FormatCode payload = {
    dataAreaId: "USMF",
    'type: "ServiceLevel",
    code: "URGP",
    description: "Urgent payment"
};
system:FormatCode result = check fo->createFormatCodes(payload);

getFormatCodes

Retrieves a single FormatCode by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`code`	`string`	Yes	The format code key field, e.g. `"URGP"`.
`'type`	`string`	Yes	The format code type key field, e.g. `"ServiceLevel"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetFormatCodesQueries`	No	OData query options: `$expand`, `$select`.

Returns: FormatCode|error

Sample code:

system:FormatCode result = check fo->getFormatCodes("USMF", "URGP", "ServiceLevel");

deleteFormatCodes

Deletes a FormatCode by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`code`	`string`	Yes	The format code key field, e.g. `"URGP"`.
`'type`	`string`	Yes	The format code type key field, e.g. `"ServiceLevel"`.
`headers`	`DeleteFormatCodesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteFormatCodes("USMF", "URGP", "ServiceLevel");

updateFormatCodes

Updates an existing FormatCode.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`code`	`string`	Yes	The format code key field, e.g. `"URGP"`.
`'type`	`string`	Yes	The format code type key field, e.g. `"ServiceLevel"`.
`payload`	`FormatCode`	Yes	The fields to update.
`headers`	`UpdateFormatCodesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: FormatCode|error

Sample code:

system:FormatCode payload = {
    description: "Urgent payment - revised"
};
system:FormatCode result = check fo->updateFormatCodes("USMF", "URGP", "ServiceLevel", payload);

Houses

listHouses

Lists House records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListHousesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: HousesCollection|error

Sample code:

system:HousesCollection result = check fo->listHouses();

createHouses

Creates a new House.

Parameters:

Name	Type	Required	Description
`payload`	`House`	Yes	The House record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: House|error

Sample code:

system:House payload = {
    dataAreaId: "RUMF",
    houseId: "H-001",
    houseNum: "12",
    buildNum: "A",
    postalCode: "123456",
    startDate: "2026-01-01"
};
system:House result = check fo->createHouses(payload);

getHouses

Retrieves a single House by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`houseId`	`string`	Yes	The house id key field, e.g. `"H-001"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetHousesQueries`	No	OData query options: `$expand`, `$select`.

Returns: House|error

Sample code:

system:House result = check fo->getHouses("RUMF", "H-001");

deleteHouses

Deletes a House by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`houseId`	`string`	Yes	The house id key field, e.g. `"H-001"`.
`headers`	`DeleteHousesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteHouses("RUMF", "H-001");

updateHouses

Updates an existing House.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`houseId`	`string`	Yes	The house id key field, e.g. `"H-001"`.
`payload`	`House`	Yes	The fields to update.
`headers`	`UpdateHousesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: House|error

Sample code:

system:House payload = {
    postalCode: "654321"
};
system:House result = check fo->updateHouses("RUMF", "H-001", payload);

Import Modes

listImportModes

Lists ImportMode records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListImportModesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: ImportModesCollection|error

Sample code:

system:ImportModesCollection result = check fo->listImportModes();

createImportModes

Creates a new ImportMode.

Parameters:

Name	Type	Required	Description
`payload`	`ImportMode`	Yes	The ImportMode record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: ImportMode|error

Sample code:

system:ImportMode payload = {
    dataAreaId: "USMF",
    methodOfImport: "EFT",
    description: "Electronic funds transfer",
    className: "ImportEFT",
    classID: 101,
    bankAccount: "BANK-001"
};
system:ImportMode result = check fo->createImportModes(payload);

getImportModes

Retrieves a single ImportMode by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`methodOfImport`	`string`	Yes	The method of import key field, e.g. `"EFT"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetImportModesQueries`	No	OData query options: `$expand`, `$select`.

Returns: ImportMode|error

Sample code:

system:ImportMode result = check fo->getImportModes("USMF", "EFT");

deleteImportModes

Deletes a ImportMode by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`methodOfImport`	`string`	Yes	The method of import key field, e.g. `"EFT"`.
`headers`	`DeleteImportModesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteImportModes("USMF", "EFT");

updateImportModes

Updates an existing ImportMode.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`methodOfImport`	`string`	Yes	The method of import key field, e.g. `"EFT"`.
`payload`	`ImportMode`	Yes	The fields to update.
`headers`	`UpdateImportModesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: ImportMode|error

Sample code:

system:ImportMode payload = {
    description: "Electronic funds transfer - revised"
};
system:ImportMode result = check fo->updateImportModes("USMF", "EFT", payload);

Item GTDs

listItemGTDs

Lists ItemGTD records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListItemGTDsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: ItemGTDsCollection|error

Sample code:

system:ItemGTDsCollection result = check fo->listItemGTDs();

createItemGTDs

Creates a new ItemGTD.

Parameters:

Name	Type	Required	Description
`payload`	`ItemGTD`	Yes	The ItemGTD record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: ItemGTD|error

Sample code:

system:ItemGTD payload = {
    dataAreaId: "RUMF",
    itemNumber: "ITEM-001",
    gTDNumber: "GTD-2026-001",
    itemOriginCountryRegionId: "CHN"
};
system:ItemGTD result = check fo->createItemGTDs(payload);

getItemGTDs

Retrieves a single ItemGTD by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`itemNumber`	`string`	Yes	The item number key field, e.g. `"ITEM-001"`.
`gTDNumber`	`string`	Yes	The GTD (customs declaration) number key field, e.g. `"GTD-2026-001"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetItemGTDsQueries`	No	OData query options: `$expand`, `$select`.

Returns: ItemGTD|error

Sample code:

system:ItemGTD result = check fo->getItemGTDs("RUMF", "ITEM-001", "GTD-2026-001");

deleteItemGTDs

Deletes a ItemGTD by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`itemNumber`	`string`	Yes	The item number key field, e.g. `"ITEM-001"`.
`gTDNumber`	`string`	Yes	The GTD (customs declaration) number key field, e.g. `"GTD-2026-001"`.
`headers`	`DeleteItemGTDsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteItemGTDs("RUMF", "ITEM-001", "GTD-2026-001");

updateItemGTDs

Updates an existing ItemGTD.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"RUMF"`.
`itemNumber`	`string`	Yes	The item number key field, e.g. `"ITEM-001"`.
`gTDNumber`	`string`	Yes	The GTD (customs declaration) number key field, e.g. `"GTD-2026-001"`.
`payload`	`ItemGTD`	Yes	The fields to update.
`headers`	`UpdateItemGTDsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: ItemGTD|error

Sample code:

system:ItemGTD payload = {
    itemOriginCountryRegionId: "VNM"
};
system:ItemGTD result = check fo->updateItemGTDs("RUMF", "ITEM-001", "GTD-2026-001", payload);

Load Templates

listLoadTemplates

Lists LoadTemplate records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListLoadTemplatesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: LoadTemplatesCollection|error

Sample code:

system:LoadTemplatesCollection result = check fo->listLoadTemplates();

createLoadTemplates

Creates a new LoadTemplate.

Parameters:

Name	Type	Required	Description
`payload`	`LoadTemplate`	Yes	The LoadTemplate record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: LoadTemplate|error

Sample code:

system:LoadTemplate payload = {
    dataAreaId: "USMF",
    templateId: "PALLET-STD",
    maximumLoadWeight: 500.0,
    maximumQuantity: 100,
    isLoadFloorStacked: "Yes"
};
system:LoadTemplate result = check fo->createLoadTemplates(payload);

getLoadTemplates

Retrieves a single LoadTemplate by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`templateId`	`string`	Yes	The load template id key field, e.g. `"PALLET-STD"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetLoadTemplatesQueries`	No	OData query options: `$expand`, `$select`.

Returns: LoadTemplate|error

Sample code:

system:LoadTemplate result = check fo->getLoadTemplates("USMF", "PALLET-STD");

deleteLoadTemplates

Deletes a LoadTemplate by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`templateId`	`string`	Yes	The load template id key field, e.g. `"PALLET-STD"`.
`headers`	`DeleteLoadTemplatesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteLoadTemplates("USMF", "PALLET-STD");

updateLoadTemplates

Updates an existing LoadTemplate.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`templateId`	`string`	Yes	The load template id key field, e.g. `"PALLET-STD"`.
`payload`	`LoadTemplate`	Yes	The fields to update.
`headers`	`UpdateLoadTemplatesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: LoadTemplate|error

Sample code:

system:LoadTemplate payload = {
    maximumLoadWeight: 600.0
};
system:LoadTemplate result = check fo->updateLoadTemplates("USMF", "PALLET-STD", payload);

Loyalty Levels

listLoyaltyLevels

Lists LoyaltyLevel records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListLoyaltyLevelsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: LoyaltyLevelsCollection|error

Sample code:

system:LoyaltyLevelsCollection result = check fo->listLoyaltyLevels();

createLoyaltyLevels

Creates a new LoyaltyLevel.

Parameters:

Name	Type	Required	Description
`payload`	`LoyaltyLevel`	Yes	The LoyaltyLevel record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: LoyaltyLevel|error

Sample code:

system:LoyaltyLevel payload = {
    dataAreaId: "USMF",
    levelPhrase: "GOLD",
    levelDescription: "Gold tier"
};
system:LoyaltyLevel result = check fo->createLoyaltyLevels(payload);

getLoyaltyLevels

Retrieves a single LoyaltyLevel by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`levelPhrase`	`string`	Yes	The loyalty level phrase key field, e.g. `"GOLD"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetLoyaltyLevelsQueries`	No	OData query options: `$expand`, `$select`.

Returns: LoyaltyLevel|error

Sample code:

system:LoyaltyLevel result = check fo->getLoyaltyLevels("USMF", "GOLD");

deleteLoyaltyLevels

Deletes a LoyaltyLevel by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`levelPhrase`	`string`	Yes	The loyalty level phrase key field, e.g. `"GOLD"`.
`headers`	`DeleteLoyaltyLevelsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteLoyaltyLevels("USMF", "GOLD");

updateLoyaltyLevels

Updates an existing LoyaltyLevel.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`levelPhrase`	`string`	Yes	The loyalty level phrase key field, e.g. `"GOLD"`.
`payload`	`LoyaltyLevel`	Yes	The fields to update.
`headers`	`UpdateLoyaltyLevelsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: LoyaltyLevel|error

Sample code:

system:LoyaltyLevel payload = {
    levelDescription: "Gold tier - revised"
};
system:LoyaltyLevel result = check fo->updateLoyaltyLevels("USMF", "GOLD", payload);

Model Tables

listModelTables

Lists ModelTable records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListModelTablesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: ModelTablesCollection|error

Sample code:

system:ModelTablesCollection result = check fo->listModelTables();

createModelTables

Creates a new ModelTable.

Parameters:

Name	Type	Required	Description
`payload`	`ModelTable`	Yes	The ModelTable record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: ModelTable|error

Sample code:

system:ModelTable payload = {
    dataAreaId: "USMF",
    model: "STD-DEPR",
    description: "Standard depreciation model"
};
system:ModelTable result = check fo->createModelTables(payload);

getModelTables

Retrieves a single ModelTable by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`model`	`string`	Yes	The model key field, e.g. `"STD-DEPR"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetModelTablesQueries`	No	OData query options: `$expand`, `$select`.

Returns: ModelTable|error

Sample code:

system:ModelTable result = check fo->getModelTables("USMF", "STD-DEPR");

deleteModelTables

Deletes a ModelTable by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`model`	`string`	Yes	The model key field, e.g. `"STD-DEPR"`.
`headers`	`DeleteModelTablesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteModelTables("USMF", "STD-DEPR");

updateModelTables

Updates an existing ModelTable.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`model`	`string`	Yes	The model key field, e.g. `"STD-DEPR"`.
`payload`	`ModelTable`	Yes	The fields to update.
`headers`	`UpdateModelTablesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: ModelTable|error

Sample code:

system:ModelTable payload = {
    description: "Standard depreciation model - revised"
};
system:ModelTable result = check fo->updateModelTables("USMF", "STD-DEPR", payload);

Of Businesses

listOfBusinesses

Lists OfBusiness records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListOfBusinessesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: OfBusinessesCollection|error

Sample code:

system:OfBusinessesCollection result = check fo->listOfBusinesses();

createOfBusinesses

Creates a new OfBusiness.

Parameters:

Name	Type	Required	Description
`payload`	`OfBusiness`	Yes	The OfBusiness record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: OfBusiness|error

Sample code:

system:OfBusiness payload = {
    dataAreaId: "USMF",
    lineOfBusiness: "RETAIL",
    description: "Retail line of business"
};
system:OfBusiness result = check fo->createOfBusinesses(payload);

getOfBusinesses

Retrieves a single OfBusiness by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`lineOfBusiness`	`string`	Yes	The line of business key field, e.g. `"RETAIL"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetOfBusinessesQueries`	No	OData query options: `$expand`, `$select`.

Returns: OfBusiness|error

Sample code:

system:OfBusiness result = check fo->getOfBusinesses("USMF", "RETAIL");

deleteOfBusinesses

Deletes a OfBusiness by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`lineOfBusiness`	`string`	Yes	The line of business key field, e.g. `"RETAIL"`.
`headers`	`DeleteOfBusinessesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteOfBusinesses("USMF", "RETAIL");

updateOfBusinesses

Updates an existing OfBusiness.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`lineOfBusiness`	`string`	Yes	The line of business key field, e.g. `"RETAIL"`.
`payload`	`OfBusiness`	Yes	The fields to update.
`headers`	`UpdateOfBusinessesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: OfBusiness|error

Sample code:

system:OfBusiness payload = {
    description: "Retail line of business - revised"
};
system:OfBusiness result = check fo->updateOfBusinesses("USMF", "RETAIL", payload);

Other Clients

listOtherClients

Lists OtherClients records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListOtherClientsQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: OtherClientsCollection|error

Sample code:

system:OtherClientsCollection result = check fo->listOtherClients();

createOtherClients

Creates a new OtherClients.

Parameters:

Name	Type	Required	Description
`payload`	`OtherClients`	Yes	The OtherClients record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: OtherClients|error

Sample code:

system:OtherClients payload = {
    dataAreaId: "USMF",
    code: "OC-001",
    name: "Regional Tax Authority",
    partyNumber: "000123",
    address: "123 Main St"
};
system:OtherClients result = check fo->createOtherClients(payload);

getOtherClients

Retrieves a single OtherClients by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`code`	`string`	Yes	The other client code key field, e.g. `"OC-001"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetOtherClientsQueries`	No	OData query options: `$expand`, `$select`.

Returns: OtherClients|error

Sample code:

system:OtherClients result = check fo->getOtherClients("USMF", "OC-001");

deleteOtherClients

Deletes a OtherClients by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`code`	`string`	Yes	The other client code key field, e.g. `"OC-001"`.
`headers`	`DeleteOtherClientsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteOtherClients("USMF", "OC-001");

updateOtherClients

Updates an existing OtherClients.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`code`	`string`	Yes	The other client code key field, e.g. `"OC-001"`.
`payload`	`OtherClients`	Yes	The fields to update.
`headers`	`UpdateOtherClientsHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: OtherClients|error

Sample code:

system:OtherClients payload = {
    name: "Regional Tax Authority - revised"
};
system:OtherClients result = check fo->updateOtherClients("USMF", "OC-001", payload);

Parameters

listParameters

Lists Parameters records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListParametersQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: ParametersCollection|error

Sample code:

system:ParametersCollection result = check fo->listParameters();

createParameters

Creates a new Parameters.

Parameters:

Name	Type	Required	Description
`payload`	`Parameters`	Yes	The Parameters record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: Parameters|error

Sample code:

system:Parameters payload = {
    dataAreaId: "USMF",
    industry: "Manufacturing",
    orgNumber: "123456789"
};
system:Parameters result = check fo->createParameters(payload);

getParameters

Retrieves a single Parameters by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`'key`	`int`	Yes	The entity key value, e.g. `1`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetParametersQueries`	No	OData query options: `$expand`, `$select`.

Returns: Parameters|error

Sample code:

system:Parameters result = check fo->getParameters("USMF", 1);

deleteParameters

Deletes a Parameters by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`'key`	`int`	Yes	The entity key value, e.g. `1`.
`headers`	`DeleteParametersHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteParameters("USMF", 1);

updateParameters

Updates an existing Parameters.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`'key`	`int`	Yes	The entity key value, e.g. `1`.
`payload`	`Parameters`	Yes	The fields to update.
`headers`	`UpdateParametersHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: Parameters|error

Sample code:

system:Parameters payload = {
    industry: "Discrete manufacturing"
};
system:Parameters result = check fo->updateParameters("USMF", 1, payload);

Service Codes

listServiceCodes

Lists ServiceCodes records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListServiceCodesQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: ServiceCodesCollection|error

Sample code:

system:ServiceCodesCollection result = check fo->listServiceCodes();

createServiceCodes

Creates a new ServiceCodes.

Parameters:

Name	Type	Required	Description
`payload`	`ServiceCodes`	Yes	The ServiceCodes record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: ServiceCodes|error

Sample code:

system:ServiceCodes payload = {
    dataAreaId: "INMF",
    serviceCode: "SC-001",
    name: "Consulting services",
    serviceAccountingCode: "998311",
    minorHead: "0001"
};
system:ServiceCodes result = check fo->createServiceCodes(payload);

getServiceCodes

Retrieves a single ServiceCodes by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"INMF"`.
`serviceCode`	`string`	Yes	The service code key field, e.g. `"SC-001"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetServiceCodesQueries`	No	OData query options: `$expand`, `$select`.

Returns: ServiceCodes|error

Sample code:

system:ServiceCodes result = check fo->getServiceCodes("INMF", "SC-001");

deleteServiceCodes

Deletes a ServiceCodes by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"INMF"`.
`serviceCode`	`string`	Yes	The service code key field, e.g. `"SC-001"`.
`headers`	`DeleteServiceCodesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteServiceCodes("INMF", "SC-001");

updateServiceCodes

Updates an existing ServiceCodes.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"INMF"`.
`serviceCode`	`string`	Yes	The service code key field, e.g. `"SC-001"`.
`payload`	`ServiceCodes`	Yes	The fields to update.
`headers`	`UpdateServiceCodesHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: ServiceCodes|error

Sample code:

system:ServiceCodes payload = {
    name: "Consulting services - revised"
};
system:ServiceCodes result = check fo->updateServiceCodes("INMF", "SC-001", payload);

Site Gate

listSiteGate

Lists SiteGate records, with optional OData query support.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`ListSiteGateQueries`	No	OData query options: `$skip`, `$top`, `$filter`, `$orderby`, `$expand`, `cross-company`, `$count`, `$select`.

Returns: SiteGateCollection|error

Sample code:

system:SiteGateCollection result = check fo->listSiteGate();

createSiteGate

Creates a new SiteGate.

Parameters:

Name	Type	Required	Description
`payload`	`SiteGate`	Yes	The SiteGate record to create.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.

Returns: SiteGate|error

Sample code:

system:SiteGate payload = {
    dataAreaId: "USMF",
    'type: "In",
    siteId: "SITE-01",
    gateId: "GATE-01",
    description: "Inbound receiving gate"
};
system:SiteGate result = check fo->createSiteGate(payload);

getSiteGate

Retrieves a single SiteGate by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`'type`	`string`	Yes	The site gate type key field (`In` or `Out`), e.g. `"In"`.
`gateId`	`string`	Yes	The gate id key field, e.g. `"GATE-01"`.
`siteId`	`string`	Yes	The site id key field, e.g. `"SITE-01"`.
`headers`	`map<string\|string[]>`	No	Optional HTTP headers to include in the request.
`queries`	`GetSiteGateQueries`	No	OData query options: `$expand`, `$select`.

Returns: SiteGate|error

Sample code:

system:SiteGate result = check fo->getSiteGate("USMF", "In", "GATE-01", "SITE-01");

deleteSiteGate

Deletes a SiteGate by its key.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`'type`	`string`	Yes	The site gate type key field (`In` or `Out`), e.g. `"In"`.
`gateId`	`string`	Yes	The gate id key field, e.g. `"GATE-01"`.
`siteId`	`string`	Yes	The site id key field, e.g. `"SITE-01"`.
`headers`	`DeleteSiteGateHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: error?

Sample code:

check fo->deleteSiteGate("USMF", "In", "GATE-01", "SITE-01");

updateSiteGate

Updates an existing SiteGate.

Parameters:

Name	Type	Required	Description
`dataAreaId`	`string`	Yes	The company data area identifier, e.g. `"USMF"`.
`'type`	`string`	Yes	The site gate type key field (`In` or `Out`), e.g. `"In"`.
`gateId`	`string`	Yes	The gate id key field, e.g. `"GATE-01"`.
`siteId`	`string`	Yes	The site id key field, e.g. `"SITE-01"`.
`payload`	`SiteGate`	Yes	The fields to update.
`headers`	`UpdateSiteGateHeaders`	No	Optional headers, including `ifMatch` (ETag for optimistic concurrency).

Returns: SiteGate|error

Sample code:

system:SiteGate payload = {
    description: "Inbound receiving gate - revised"
};
system:SiteGate result = check fo->updateSiteGate("USMF", "In", "GATE-01", "SITE-01", payload);

Client​

Configuration​

Initializing the client​

Operations​

Abbreviations​

All Products​

CFPS Table​

Components​

Date Intervals​

EM Item Types​

Estate Status​

Ext Code Tables​

Format Codes​

Houses​

Import Modes​

Item GTDs​

Load Templates​

Loyalty Levels​

Model Tables​

Of Businesses​

Other Clients​

Parameters​

Service Codes​

Site Gate​

Client

Configuration

Initializing the client

Operations

Abbreviations

All Products

CFPS Table

Components

Date Intervals

EM Item Types

Estate Status

Ext Code Tables

Format Codes

Houses

Import Modes

Item GTDs

Load Templates

Loyalty Levels

Model Tables

Of Businesses

Other Clients

Parameters

Service Codes

Site Gate