REST API Reference for Billing Care

Create Credit Limits for a Balance Group

post

/bcws/webresources/v1.0/billunits/balancegroups/creditlimit/{id}

Creates credit limits and credit thresholds for the specified currency or noncurrency balance group.

Request

Path Parameters

id(required): string

The ID of the balance group.

Supported Media Types

application/xml
application/json

Include limit set to one of these values:

null: No change in credit limit.
-1: The credit limit is set to unlimited.
value: The credit limit is set to that value.

Root Schema : schema

Type: object

Show Source

dynamicFloor: boolean

Whether to use a dynamic credit floor (true) or not (false). The default is false.
extension: object extension

The extended attributes.
fixedThresholds: string

The value of any fixed thresholds.
floor: number

The credit floor, which is a number that indicates none of the balance has been used. For example, it specifies the allowance of minutes or gigabytes that you granted to a customer. For currency balances, the credit floor is 0.
limit: number

The credit limit amount.
overrideCreditLimit: integer (int32)

Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).
resourceId: integer (int32)

The resource ID.
rollUp: boolean
tempCreditLimit: array tempCreditLimit
thresholds: string

The value of any percentage thresholds.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID.",
            "format":"int32"
        },
        "thresholds":{
            "type":"string",
            "description":"The value of any percentage thresholds."
        },
        "dynamicFloor":{
            "type":"boolean",
            "description":"Whether to use a dynamic credit floor (<b>true</b>) or not (<b>false</b>). The default is <b>false</b>."
        },
        "floor":{
            "type":"number",
            "description":"The credit floor, which is a number that indicates none of the balance has been used. For example, it specifies the allowance of minutes or gigabytes that you granted to a customer. For currency balances, the credit floor is 0."
        },
        "overrideCreditLimit":{
            "type":"integer",
            "description":"Whether to override the credit limit. Allowed Values: <b>0</b> (Enforce Credit Limit) or <b>1</b> (Override credit limit).",
            "format":"int32"
        },
        "fixedThresholds":{
            "type":"string",
            "description":"The value of any fixed thresholds."
        },
        "tempCreditLimit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TempCreditLimit"
            }
        },
        "rollUp":{
            "type":"boolean"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : tempCreditLimit

Type: array

Show Source

Array of: object TempCreditLimit

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

Nested Schema : TempCreditLimit

Type: object

Show Source

extension: object extension

The extended attributes.
limit: number

The temporary credit limit amount.
resourceId: integer (int32)

The resource ID associated with the temporary credit limit.
validFrom(required): string (date-time)

The date and time temporary credit limit's validity starts.
validFromOffset: integer (int32)

The offset for the temporary credit limit's validity period start.
validFromUnit: integer (int32)

The unit for the temporary credit limit's validity period start.
validTo(required): string (date-time)

The date and time temporary credit limit's validity ends.
validToOffset: integer (int32)

The offset for the temporary credit limit's validity period end.
validToUnit: integer (int32)

The unit for the temporary credit limit's validity period end.

{
    "required":[
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The temporary credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the temporary credit limit.",
            "format":"int32"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity ends.",
            "format":"date-time"
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity starts.",
            "format":"date-time"
        },
        "validToUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validToOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validFromUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period start.",
            "format":"int32"
        },
        "validFromOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period start.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Include limit set to one of these values:

null: No change in credit limit.
-1: The credit limit is set to unlimited.
value: The credit limit is set to that value.

Root Schema : schema

Type: object

Show Source

dynamicFloor: boolean

Whether to use a dynamic credit floor (true) or not (false). The default is false.
extension: object extension

The extended attributes.
fixedThresholds: string

The value of any fixed thresholds.
floor: number

The credit floor, which is a number that indicates none of the balance has been used. For example, it specifies the allowance of minutes or gigabytes that you granted to a customer. For currency balances, the credit floor is 0.
limit: number

The credit limit amount.
overrideCreditLimit: integer (int32)

Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).
resourceId: integer (int32)

The resource ID.
rollUp: boolean
tempCreditLimit: array tempCreditLimit
thresholds: string

The value of any percentage thresholds.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID.",
            "format":"int32"
        },
        "thresholds":{
            "type":"string",
            "description":"The value of any percentage thresholds."
        },
        "dynamicFloor":{
            "type":"boolean",
            "description":"Whether to use a dynamic credit floor (<b>true</b>) or not (<b>false</b>). The default is <b>false</b>."
        },
        "floor":{
            "type":"number",
            "description":"The credit floor, which is a number that indicates none of the balance has been used. For example, it specifies the allowance of minutes or gigabytes that you granted to a customer. For currency balances, the credit floor is 0."
        },
        "overrideCreditLimit":{
            "type":"integer",
            "description":"Whether to override the credit limit. Allowed Values: <b>0</b> (Enforce Credit Limit) or <b>1</b> (Override credit limit).",
            "format":"int32"
        },
        "fixedThresholds":{
            "type":"string",
            "description":"The value of any fixed thresholds."
        },
        "tempCreditLimit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TempCreditLimit"
            }
        },
        "rollUp":{
            "type":"boolean"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : tempCreditLimit

Type: array

Show Source

Array of: object TempCreditLimit

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

Nested Schema : TempCreditLimit

Type: object

Show Source

extension: object extension

The extended attributes.
limit: number

The temporary credit limit amount.
resourceId: integer (int32)

The resource ID associated with the temporary credit limit.
validFrom(required): string (date-time)

The date and time temporary credit limit's validity starts.
validFromOffset: integer (int32)

The offset for the temporary credit limit's validity period start.
validFromUnit: integer (int32)

The unit for the temporary credit limit's validity period start.
validTo(required): string (date-time)

The date and time temporary credit limit's validity ends.
validToOffset: integer (int32)

The offset for the temporary credit limit's validity period end.
validToUnit: integer (int32)

The unit for the temporary credit limit's validity period end.

{
    "required":[
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The temporary credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the temporary credit limit.",
            "format":"int32"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity ends.",
            "format":"date-time"
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity starts.",
            "format":"date-time"
        },
        "validToUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validToOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validFromUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period start.",
            "format":"int32"
        },
        "validFromOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period start.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Response

201 Response

The credit limits and credit thresholds were created successfully.

500 Response

An internal server error occurred.

Examples

This example shows how to create credit limits for a balance group by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/v1.0/billunits/balancegroups/creditlimit/0.0.0.1+-balance_group+82896' -H 'content-type: application/json' -d @creditLimits.json

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.
creditLimits.json is the JSON file that specifies the credit limits to create for the balance group.

Example of Request Body

This example shows the contents of the creditLimits.json file sent as the request body. This request creates a regular credit limit of 12, a credit floor of 1, and a fixed notification threshold of 1. It also sets a temporary credit limit of 100, valid for 10 days, starting in 30 days. Temporary credit limits are used when granting a loan or allowing the customer to temporarily breach their credit limit.

{
  "limit": "12.00",
  "thresholds": null,
  "floor": "1.00",
  "fixedThresholds": "1.00",
  "resourceId": 840,
  "tempCreditLimit": [
    {
      "limit": 100,
      "resourceId": 840,
      "validToUnit": 4,
      "validToOffset": 10,
      "validFromUnit": 4,
      "validFromOffset": 30
    }
  ]
}

Example of Response Body

If successful, the response code 201 is returned with Ok in the response body.