Adjust Chargeable Event

The AdjustChargeableEvent API is used to adjust chargeable events in OCS.io.

API Overview

Fields Required for Adjusting Chargeable Event

The following table lists and describes the fields required to adjust a chargeable event through the AdjustChargeableEvent API:

Field Description

chargeableEventRefId

ID (Ref ID) of the Chargeable Event.

chargeType

Charge Type:

  • 'CREDIT' - Original Event is Credited by Adjusted amount.

  • 'DEBIT' - Original Event is Debited by Adjusted amount.

chargeAdjustment

Charge Adjustment.

currency

Currency ISO Code of the Adjustment.

taxIncluded

Indicates whether Tax is included in the charge adjustment.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when adjusting a chargeable event:

Adjust Chargeable Event Example

Use the following request’s body to adjust a chargeable event:

{
  "requestId": "{{$guid}}",
  "user": "crm",
  "chargeableEventRefId": "chargeable_event_ref_id",
  "chargeType": "CREDIT",
  "chargeAdjustment": 1000000,
  "currency": "EUR",
  "taxIncluded": true
}

The outcome of the API call is as follows:

  • It is validated that the chargeable event with Ref ID chargeable_event_ref_id exists.

  • The chargeable event is adjusted as per the provided values.