POST /Japi/Tigrillo/getSIMBilling

Returns billing information for a single SIM card.

Authentication

  • User required to login

Headers

For information about headers, see Configuring headers.

Request Body application/json

Schema

Object name Description Required?
ICCID The SIM card ICCID for which you want to view billing information.
startDate

The first date included in the search, in the format: "yyyy-mm-dd hh:mm:ss". If no time is included, the default is used: 00:00:00.

The default is null, which returns the most recent records.

  
endDate

The last date included in the search, in the format "yyyy-mm-dd hh:mm:ss". If no time is included, the default is used: 00:00:00.

The default is null, which returns the most recent records.

  
sortOrder

Sort the results by Activity ("A") or Event ("E"). The default is null, which sorts the returned results by Event in descending order.

Type A (ascending) or D (descending) immediately after the field indicator to arrange the results using the selected field.

For example, "AA" sorts the results by Activity, in ascending (0-9, A to Z) order. "AD" sorts the results by Activity, in descending order (9-0, Z to A).

If you do not specify a date range, the results are returned in descending order only.

  
startRec

The start record for returned results. The default is null (alternatively, use "0"), which returns all the results listed from the first record (record 0). Use "1" to return all the results from record 1 onwards, "2" to return the results from record 2 onwards, and so on.

  
numRecs

The number of records to return. The default is null, which returns ten records. Use "1" to return one result, "2" to return two results, and so on.

  
filter

Filter the results according to record type, either:

  • Data – "D"
  • SMS – "S"
  • Voice – "V"

The default is null, which returns all record types.

  

Example

Copy
Body raw JSON
{
"ICCID" : "8944538523013522377" ,
 "startDate" : null ,
 "endDate" : "2018-11-15" ,
 "sortOrder" : null ,
 "startRec" : null ,
 "numRecs" : null ,
 "filter" : null
}

Responses application/json

Schema

JSON key Description
totalRecs Total number of records returned
recs The array, listing the billing records.
activity

The activity type, either:

  • "Data"
  • "SMS"
  • "Voice"
  • "Other"
start The event start date and time stamp, in the format: yyyy-mm-dd hh:mm:ss.
stop The event stop date and time stamp, in the format: yyyy-mm-dd hh:mm:ss.
description The activity description, as displayed in your contract.
quantity

The total activity usage amount in the event.

Activity Measured in
Data Bytes
SMS Number of messages
Voice Number of seconds
price The amount billed for the event in the currency specified in the SIM card contract, rounded to two decimal points.
mcc

Mobile Country Code – the country the device was in when the event occurred, in three-digit numeric format. For more information, see http://en.wikipedia.org/wiki/Mobile_country_code.
mnc

Mobile Network Code – the network operator the device was using when the event occurred, in one or two digit numeric format. For more information, see http://en.wikipedia.org/wiki/Mobile_country_code.
packageID The package reference number for the SIM at the time of the event.
status

The array, containing details about the request status.
status

"OK" – the request processed successfully

"ERR" – the request failed
errorCode

"" – the request processed successfully

"<ErrorCodeNumber>" – the request failed because of this specific error.

For more information, see Troubleshooting errors: Tigrillo API.
errorMessage

"" – the request processed successfully

"<ErrorCodeMessage>" – displays an explanation of the error if the request failed.

For more information, see Troubleshooting errors: Tigrillo API.

Example

Copy
JSON
{
    "totalRecs": 2,
    "recs": [
        {
            "activity": "Data",
            "start": "2018-11-14 23:41:47",
            "stop": "2018-11-15 02:34:46",
            "description": "Data",
            "quantity": 2048,
            "price": "9.37",
            "mcc": "310",
            "mnc": "410",
            "packageID": 10001
        },
        {
            "activity": "Data",
            "start": "2018-10-31 22:20:58",
            "stop": "2018-10-31 23:59:59",
            "description": "EU",
            "quantity": 2000,
            "price": "0.56",
            "mcc": "310",
            "mnc": "410",
            "packageID": 13518
        }
    ],
    "status": {
        "status": "OK",
        "errorCode": "",
        "errorMessage": ""
    }
}

Where to next?

Related resources