One-Time Fee

The One-Time Fee service is designed to handle the fees associated with a single, non-recurring charge within OCS.io. This service ensures that the costs related to a one-time event or action are accurately charged.

Key features of the One-Time Fee service include:

  1. Applicable for Single Events: The service charges a fee for a one-time event or action. This ensures that specific, non-recurring processes are properly monetized.

  2. Event-Specific Fees: The one-time fee is specific to each event, allowing for tailored fee structures that reflect the costs associated with different actions.

  3. Cost Coverage: The fee is designed to cover the costs associated with the one-time event or action. This ensures that all necessary expenses are accounted for during the process.

  4. Non-Recurring Requirement: The one-time fee is only applicable for non-recurring events, meaning that the charge is applied once and does not repeat.

Configuration in the GUI

This section describes the configuration of a one-time fee in the GUI.

One-Time Fee Service
Item Description

Charging Class

Choose Charging Class which will be assigned to the Charge.

Charge

Enter Charge which will be applied.

Tax

Choose Tax which will be applied.

Tax Included

If checked, Charge is inclusive Tax.

GL Code

Choose GL Code which will be assigned to the Charge. If no GL Code is chosen, GL Code which is configured on Charging Class level will be applied.

Configuration via the Spreadsheet API

Pre-Requisites

For the configuration of the One-Time Fee, it is essential that the product is set up as a singleton. This setup implies that the product should only contain one service, which in this case is the One-Time Fee.

Endpoint

The configuration API for managing one-time fees is available at the following endpoint: {{url}}/loader/v1/one-time-fees/{oneTimeFee}.

The {oneTimeFee} is a placeholder for the unique identifier of the one time fee product.

Payload

The following table lists the attributes of the payload for the one-time fee configuration.

Code (Line #1) Name (Line #2) Type Description Note

productCode

Product Code

String, Not null

The unique identifier for a product.

productServiceCode

Product Service Code

String, Not null

The unique identified for a specific service associated with a product.

versionCode

Version Code

String, Not null

The code indicating the version of an offer.

versionDescription

Version Description

String

A detailed description of the specific version of an offer.

offerName

Offer Name

String, Not null

The name of a specific offer.

offerCode

Offer Code

String, Not null

The unique code assigned to a specific offer.

offerDescription

Offer Description

String

A detailed description of the offer.

currency

Currency

String, Not null

The code of the currency associated with a specific offer.

priority

Priority

Number, Not null

Priority of the fee application.

The lower value, the higher priority during fee application.

chargingClass

Charging Class

String, Not null

The code of charging class assigned to an event.

tax

Tax

String, Not null

The code of tax assigned to the offer.

charge

Charge

Number, Not null

The charge for the offer.

Shifted by 6 decimal points. E.g. 1000000 = 1 EUR/USD/etc.

taxIncluded

Charge incl. Tax

Boolean

Indicates whether the charge includes tax.

  • Y = True

  • N = False

glCode

GL Code

String, Not null

The General Ledger code associated with the offer.

error

Error

String

Any errors associated with the configuration.

Only on the output.