GF - Methods and Parameters

APIs – Folio Manager 3.0 (GF 3.0)

---

1. Introduction

Folio Manager 3.0 (GF 3.0) exposes a set of REST APIs that allow you to:

• Manage billers
• Query primary ranges
• Manage sub-ranges
• Obtain numbering for document issuance

The operation model depends on the biller type:

• Local Biller → works with sub-ranges
• Centralized Biller → requests number by number

---

2. Operation model

2.1 Local Biller

The biller requests a complete sub-range of numbering and manages it locally.

Advantages:

• Lower latency
• Offline operation possible
• Lower API consumption

Responsibility:

• Control internal sequence
• Release unused sub-ranges

---

2.2 Centralized Biller

The biller requests one number for each issued document.

Advantages:

• Absolute centralized control
• No local range management

Responsibility:

• Request number before each issuance

---

3. APIs for Local Billers

---

3.1 POST RefillSubRange

Description

Requests a new numbering sub-range from the assigned primary range.

Expected result

The system returns:

• Sub-range start number
• Sub-range end number
• Sub-range identifier
• Series
• Document type

Typical use

When:

• The current sub-range is exhausted
• Operation starts
• A low internal threshold is detected

---

3.2 POST ReleaseSubRange

Description

Queries which sub-ranges are available to be released (returned to GF).

Typical use

Before executing the final release.

Expected result

List of sub-ranges:

• Sub-range Id
• From / To
• Status

---

3.3 POST ConfirmReleaseSubRange

Description

Confirms the release of the previously selected sub-range.

Expected result

• The sub-range becomes available again in the primary range
• Status is updated to released

⚠ This operation is irreversible.

---

4. APIs for Centralized Billers

---

4.1 POST GetNextNumber

Description

Delivers the next available number from the primary range.

Expected result

Returns:

• Series
• Number
• Document type
• Assignment Id

Typical use

Must be invoked:

• Before issuing each document

⚠ The delivered number is reserved and cannot be reused.

---

5. General Use APIs

---

5.1 POST AddBiller

Description

Creates a new biller in GF 3.0.

Use

Used when registering:

• New branches
• New checkouts
• New issuing points

---

5.2 POST UpdateBiller

Description

Updates information or configurations of an existing biller.

Examples:

• Change of type (local / centralized)
• Threshold configuration
• Activation / deactivation

---

5.3 GET GetBillers

Description

Returns the complete list of registered billers.

Includes:

• UUID
• Type
• Status