Create special rate

POST 
/rates/special

JSON-RPC

rates.special.create

Request

application/json

Bodyrequired

rate_tables_idintegerrequired
Rate table ID.
code_namestringrequired
Destination code name. The code name will be unfolded to the list of all respective codes under the hood.
effective_fromdate-timerequired
Effective date.
valuedecimalrequired
Rate for a single unit of the event. The unit is defined by rating_units_id attribute of the respective service.
Possible values: >= -999999999 and <= 999999999
time_profiles_idintegerrequired
Time profile ID.
end_datedate-timenullable
End date. If not defined, the rate is active till the next effective date of the next rate with the same code.
Default value: null
min_volumeinteger
Minimum billed volume. To be defined in the units of rating_params_units_id attribute of the respective service.
Possible values: >= 1
Default value: 1
pay_intervalinteger
Payment interval. Applied when volume of the event is greater than min_volume. To be defined in the units of rating_params_units_id attribute of the respective service.
Possible values: >= 1
Default value: 1
pay_setupdecimal
Setup fee. Charged when volume of the event is not zero.
Default value: 0
grace_volumeinteger
Volume below which events will not be billed. To be defined in the units of rating_params_units_id attribute of the respective service.
Possible values: >= 0
Default value: 0
tagstring
Tag.
Default value: @
num_length_maxinteger | nullnullable
Maximum dst number length. If destination number does not match the length, the rate will not be applied.
Possible values: >= 1
Default value: null
num_length_mininteger | nullnullable
Minimum dst number length. If destination number does not match the length, the rate will not be applied.
Possible values: >= 1
Default value: null
notesstring | nullnullable
Notes.
Default value: null
statusstring
Status.
Possible values: [active, stashed]
Default value: active
stash_futureboolean
If True, the rates with the same code for the future will be set in stashed status.
Default value: false
force_notificationboolean
If True, the notification will be sent after new rate creation.
Default value: false

Responses

200

List containing the special rate created and all corresponding regular rates objects as have been stored.

application/json

Schema

Schema

Array [
object
]

Example (auto)

[
  {}
]

400

The request contains invalid arguments or is malformed

application/json

Schema

Schema

error object
messagestring
Error message
Example: Invalid request
dataobject
Details for validation errors (if applicable)
Example: {"name":"Empty value is not allowed","payment_terms_id":"Object \"payment_terms(123)\" was not found!"}

Example (auto)

{
  "error": {
    "message": "Invalid request",
    "data": {
      "name": "Empty value is not allowed",
      "payment_terms_id": "Object \"payment_terms(123)\" was not found!"
    }
  }
}

401

Access is not authorized

application/json

Schema

Schema

error object
messagestring
Example: utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed
data object
codestring
Error code
Example: utoken-auth-failed
messagestring
Example: Authentication Failed: IP 10.0.0.1 is not allowed

Example (auto)

{
  "error": {
    "message": "utoken-auth-failed: Authentication Failed: IP 10.0.0.1 is not allowed",
    "data": {
      "code": "utoken-auth-failed",
      "message": "Authentication Failed: IP 10.0.0.1 is not allowed"
    }
  }
}

404

Requested object was not found

application/json

Schema

Schema

error object
messagestring
Example: not_found: Object "clients(123)" was not found!
data object
codestring
Error code (static: not_found)
Example: not_found
messagestring
Error message
Example: Object "clients(123)" was not found!
object_namestring
Type of the object
Example: clients
object_idstring
ID of the object
Example: 123

Example (auto)

{
  "error": {
    "message": "not_found: Object \"clients(123)\" was not found!",
    "data": {
      "code": "not_found",
      "message": "Object \"clients(123)\" was not found!",
      "object_name": "clients",
      "object_id": "123"
    }
  }
}

422

A logical error occurred, making the request unprocessable

application/json

Schema

Schema

error object
messagestring
Error message
Example: invoices-zero-amount: Impossible to create an invoice with zero amount
data object
codestring
Error code
Example: invoices-zero-amount
messagestring
Error message
Example: Impossible to create an invoice with zero amount

Example (auto)

{
  "error": {
    "message": "invoices-zero-amount: Impossible to create an invoice with zero amount",
    "data": {
      "code": "invoices-zero-amount",
      "message": "Impossible to create an invoice with zero amount"
    }
  }
}

500

An unexpected error occurred

application/json

Schema

Schema

error object
messagestring
Error message
Example: An unexpected error occurred

Example (auto)

{
  "error": {
    "message": "An unexpected error occurred"
  }
}

Authorization: X-Api-Key

name: X-Api-Keytype: apiKeyin: headerdescription: Token for API access

• curl
• python
• nodejs
• php

• CURL

curl -L -X POST 'https://docs.jerasoft.net/rates/special' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Api-Key: <X-Api-Key>'

Request Collapse all

Auth

ApiKeyAuth

Body required

{
  "rate_tables_id": 0,
  "code_name": "string",
  "effective_from": "2024-07-29T15:51:28.071Z",
  "value": 0,
  "time_profiles_id": 0,
  "min_volume": 1,
  "pay_interval": 1,
  "pay_setup": 0,
  "grace_volume": 0,
  "tag": "@",
  "status": "active",
  "stash_future": false,
  "force_notification": false
}