Methods and parameters

Folio Manager 3.0 exposes a REST API split into two services:

• Administration API — creation and configuration of billers and primary ranges. Consumed by implementation teams and configuration portals.
• Emission API — numbering retrieval at runtime. Consumed by emitting systems (xPOS, SDTA API, kiosks) on each operation.

Base URLs

Administration API (Biller and Primary Range methods):

SBXhttps://inbox-emission-numbermanager-all-adminapi-sbx.azurewebsites.net

PRDhttps://inbox-emission-numbermanager-all-adminapi.azurewebsites.net

Emission API (runtime numbering methods):

SBXhttps://inbox-emission-numbermanager-all-api-sbx.azurewebsites.net

PRDhttps://inbox-emission-numbermanager-all-api-prd.azurewebsites.net

The pages for each method use paths relative to these base URLs (e.g. POST /AddBiller).

Operation model

The model depends on the biller profile:

	Local biller	Centralized biller
How it obtains numbering	Requests a full sub-range and manages it locally	Requests one number per document issued
Advantages	Lower latency, offline operation possible, lower API consumption	Absolute centralized control, no local range handling
Issuer's responsibility	Control the internal sequence and release unused sub-ranges	Request a number before each emission

Method groups

Group	Service	What it covers
Biller	Administration	Creation, query, reload/threshold configuration and removal of billers.
Primary Range	Administration	Registration, query and removal of primary numbering ranges.
Emission API	Emission	GetNextNumber (centralized); RefillSubRange, ReleaseSubRange and ConfirmReleaseSubRange (local).

Recommended flows

Local biller

1. Create the biller — AddBiller.
2. Configure the sub-range size and reload threshold — SaveBillerConfiguration, SaveBillerThreshold.
3. Request a sub-range — RefillSubRange.
4. Issue documents using the local numbering.
5. When numbering must be returned: query the releasable sub-ranges — ReleaseSubRange — and confirm the release — ConfirmReleaseSubRange.

Centralized biller

1. Create the biller — AddBiller.
2. Before each emission, request a number — GetNextNumber.
3. Issue the document.

Integration best practices

• Never reuse numbers under any circumstance: every number delivered stays reserved.
• Implement error handling and controlled retries.
• Log every request to the GF.
• Validate the biller status before operating.
• Monitor primary range availability and reload thresholds.

Technical considerations

• All APIs are REST with GET / POST / DELETE methods and JSON payloads.
• Billers, primary ranges and sub-ranges are identified by UUID.
• Every operation is audited (author and source fields in each request).