Jump to

• Request
• Response
• Examples

Get Bill Details by ID

get

/bcws/webresources/v1.0/installmentManagement/installmentSchedule/bills

Gets the details for the bills with the specified bill ID.

Request

Query Parameters

• billIds: string
  Oneor more bill IDs, for example: 0.0.0.1+-bill+1234567 or 0.0.0.1+-bill+2345678,0.0.0.1+-bill+3456789

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The installment schedule bill information was retrieved successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object InstallmentScheduleBill

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

Nested Schema : InstallmentScheduleBill

Type: object

Show Source

• billNo(required): string
  The installment schedule bill number.
• createdAt(required): string
  The date and time the installment schedule bill was created.
• dueAmount: object Money
• dueAt(required): string
  The date and time the installment schedule bill is due.
• id(required): string
  The installment schedule bill ID.
• status(required): string
  The installment schedule bill status.
• totalAmount: object Money

{
    "required":[
        "billNo",
        "createdAt",
        "dueAt",
        "id",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The installment schedule bill ID."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the installment schedule bill was created."
        },
        "dueAt":{
            "type":"string",
            "description":"The date and time the installment schedule bill is due."
        },
        "billNo":{
            "type":"string",
            "description":"The installment schedule bill number."
        },
        "totalAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "dueAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "status":{
            "type":"string",
            "description":"The installment schedule bill status."
        }
    }
}

Nested Schema : Money

Type: object

Show Source

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get bill details 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/installmentScheduleSpec/bills?billIds=0.0.0.1+-bill+3567045'

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.

[
 {
	"id": "0.0.0.1+-bill+3567045",
	"billNo": "B1-20110",
	"totalAmount": 
	{
		"amount":2000
	},
	"dueAmount":
	  {
		"amount":0
	  }
 }
]

Back to Top