Introduction
APIs
- GETList accounts of customer
- POSTCreate an account
- GETGet an account
- DELDelete an account
- PATCHUpdate an account
- GETList rate cards
- POSTBulk rate card operations on a schedule
- POSTBulk edit schedules of an account
- GETList pricing schedules of an account
- GETGet list of errors of a acc schedule
- DELDiscard schedules of an account
- POSTFinalize schedules of an account
- GETList pricing rules of a account schedule
- PUTUpdate pricing rules of a account schedule
- GET
- GET
curl --request GET \
--url https://api.togai.com/v2/accounts/{account_id}/schedules \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"accountId": "<string>",
"pricePlanId": "<string>",
"version": 123,
"deferredRevenue": true,
"pricePlanInfo": {
"name": "<string>",
"description": "<string>"
},
"accountScheduleInfo": {
"supportedCurrencies": [
"<string>"
],
"pricingCycleConfig": {
"interval": "WEEKLY",
"gracePeriod": 3,
"startOffset": {
"dayOffset": "<string>",
"monthOffset": "<string>"
},
"anniversaryCycle": true
},
"pricingRules": [
{
"id": "<string>",
"name": "<string>",
"version": 2,
"order": 2,
"computation": "<string>",
"action": {
"type": "ADD",
"target": "<string>",
"id": "<string>",
"description": "<string>",
"metadata": {}
},
"invoiceTiming": "IN_ADVANCE",
"condition": "<string>"
}
]
},
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"allowOngoingCycleUpdates": true,
"isOverridden": true
}
],
"nextToken": "<string>",
"previousToken": "<string>"
}List pricing schedules of an account
List pricing schedules of an account
curl --request GET \
--url https://api.togai.com/v2/accounts/{account_id}/schedules \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"accountId": "<string>",
"pricePlanId": "<string>",
"version": 123,
"deferredRevenue": true,
"pricePlanInfo": {
"name": "<string>",
"description": "<string>"
},
"accountScheduleInfo": {
"supportedCurrencies": [
"<string>"
],
"pricingCycleConfig": {
"interval": "WEEKLY",
"gracePeriod": 3,
"startOffset": {
"dayOffset": "<string>",
"monthOffset": "<string>"
},
"anniversaryCycle": true
},
"pricingRules": [
{
"id": "<string>",
"name": "<string>",
"version": 2,
"order": 2,
"computation": "<string>",
"action": {
"type": "ADD",
"target": "<string>",
"id": "<string>",
"description": "<string>",
"metadata": {}
},
"invoiceTiming": "IN_ADVANCE",
"condition": "<string>"
}
]
},
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"allowOngoingCycleUpdates": true,
"isOverridden": true
}
],
"nextToken": "<string>",
"previousToken": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
account_id corresponding to an account
50"ACC00001"
Query Parameters
Possible values:
- ACTIVE - Get the active rate card
- DRAFT - Get the draft rate card
"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
10
Response
Paginated response for pricing schedules
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents configurations related to pricing cycle
Show child attributes
Show child attributes
Interval field allow you to define the billing interval you would like to set
WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY, ANNUALLY Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. For example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period.
3
Represents the start of pricing cycle in terms of
- dayOffset - number of days from beginning of week / month and
- monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn't exist for a month, closest previous day is considered Examples: WEEKLY -
- {dayOffset: 1, monthOffset: NIL} - First day of every week (Monday)
- {dayOffset: 3, monthOffset: NIL} - 3rd day of every week (Wednesday)
- {dayOffset: LAST, monthOffset: NIL} - Last day of every week (Sunday) MONTHLY -
- {dayOffset: 1, monthOffset: NIL} - First day of every month
- {dayOffset: 12, monthOffset: NIL} - 12th of every month
- {dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...
- {dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...
- {dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ... QUARTERLY
- {dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct
- {dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov
- {dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec
- {dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY
- {dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul
- {dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct
- {dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec ANNUALLY
- {dayOffset: 15, monthOffset: FIRST} - 15th Jan
- {dayOffset: 15, monthOffset: 1} - 15th Jan
- {dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise
- {dayOffset: 15, monthOffset: 8} - 15th Aug
- {dayOffset: 15, monthOffset: LAST} - 15th Dec
Show child attributes
Show child attributes
If interval is WEEKLY, min: "1" and max: "7" as strings. Spl. string allowed: LAST Otherwise, min: "1" and max: "31" as strings. Spl. string allowed: LAST
min: "1" and max: "12". Spl. string allowed: FIRST / LAST. For QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY.
Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY -
- 23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL}
- 25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL}
- 29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY -
- 1st Oct - {dayOffset: 1, monthOffset: NIL}
- 12th Oct - {dayOffset: 12, monthOffset: NIL}
- 28th Oct - {dayOffset: 28, monthOffset: NIL}
- 30th Oct - {dayOffset: 30, monthOffset: NIL}
- 31th Oct - {dayOffset: LAST, monthOffset: NIL} QUARTERLY
- 15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}
- 15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2}
- 15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY
- 15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1}
- 15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4}
- 15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY
- 15th Jan - {dayOffset: 15, monthOffset: 1}
- 29th Feb on Leap year - {dayOffset: LAST, monthOffset: 2}
- 28th Feb - {dayOffset: LAST, monthOffset: 2}
- 15th Aug - {dayOffset: 15, monthOffset: 8}
- 15th Dec - {dayOffset: 15, monthOffset: 12}
Show child attributes
Show child attributes
x >= 1x >= 1JSON logic to be computed
JSON logic to be computed
Show child attributes
Show child attributes
ADD, UPDATE If IN_ADVANCE, the rule will be applied on rate cards with invoice timing IN_ADVANCE . If IN_ARREARS, the rule will be applied on rate cards with invoice timing IN_ARREARS .
IN_ADVANCE, IN_ARREARS JSON logic condition deciding whether to compute this pricing rule or not
Indicates whether the schedule is overridden. Note: A null value for this field does not imply that the schedule is not overridden.