Jump to

• Request
• Response
• Examples

Get G/L IDs

get

/bcws/webresources/v1.0/installmentManagement/glid

Gets the general ledger IDs (G/L IDs) that match the specified query criteria.

Request

Query Parameters

• descr: string
  The description of the GL/ID.
• glid: string
  The G/l ID, for example: 101

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The G/L ID information was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object gLIDSpec

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GLIDSpec"
    }
}

Nested Schema : gLIDSpec

Type: object

Show Source

• descr(required): string
  The general ledger label or name.
• glid(required): string
  The general ledger ID.

{
    "required":[
        "descr",
        "glid"
    ],
    "type":"object",
    "properties":{
        "glid":{
            "type":"string",
            "description":"The general ledger ID."
        },
        "descr":{
            "type":"string",
            "description":"The general ledger label or name."
        }
    },
    "xml":{
        "name":"gLIDSpec"
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get all G/L IDs by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/installmentManagement/glid'

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format.

[
    {
        "glid": "101",
        "descr": "Purchase Fees"
    },
    {
        "glid": "102",
        "descr": "Monthly Fees"
    },
    {
        "glid": "103",
        "descr": "Cancel Fees"
    },
    {
        "glid": "106",
        "descr": "Writeoff Adjustments"
    },
    {
        "glid": "107",
        "descr": "Dispute Adjustments"
    },
    {
        "glid": "108",
        "descr": "Dispute Settlements"
    },
    {
        "glid": "109",
        "descr": "Payment received"
    },
    {
        "glid": "111",
        "descr": "Write-off reversal"
    },
    {
        "glid": "1001",
        "descr": "Tax on purchase fee"
    },
    {
        "glid": "1002",
        "descr": "Tax on cycle forward fee"
    },
    {
        "glid": "1003",
        "descr": "Tax on cancellation fee"
    },
    {
        "glid": "1414",
        "descr": "Deposit Interest"
    },
    {
        "glid": "1415",
        "descr": "Deposit Refund"
    },
    {
        "glid": "1416",
        "descr": "Deposit Amount"
    },
    {
        "glid": "1420",
        "descr": "National Airtime Telephony"
    },
    {
        "glid": "1421",
        "descr": "Intl. Airtime Tel."
    },
    {
        "glid": "1430",
        "descr": "National Airtime SMS"
    },
    {
        "glid": "1431",
        "descr": "International Airtime SMS"
    },
    {
        "glid": "1440",
        "descr": "National Airtime other GSM"
    },
    {
        "glid": "1441",
        "descr": "Intl. Airtime other GSM"
    },
    {
        "glid": "1450",
        "descr": "National Usage GPRS"
    },
    {
        "glid": "1451",
        "descr": "International Usage GPRS"
    },
    {
        "glid": "1460",
        "descr": "Nat. Usage other Services"
    },
    {
        "glid": "1461",
        "descr": "Intl. Usage other Services"
    },
    {
        "glid": "1503",
        "descr": "Int. Incoming Roaming GSM"
    },
    {
        "glid": "1504",
        "descr": "Int. Outgoing Roaming GSM"
    },
    {
        "glid": "1510",
        "descr": "National VAS"
    },
    {
        "glid": "1511",
        "descr": "International VAS"
    },
    {
        "glid": "1515",
        "descr": "Installment GL ID"
    }
]

Back to Top