Customer Bill Management Biz API

(0 reviews)

GET-CustomerBillByID-pdf-mobile

GET

This operation Fetch CustomerBill PDF billReference.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[localhost]:[port]/tmf-api/customerBillManagement/v1/{businessId}/customerBill/{id}

URL PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (PR) identifying the business unit	Y
id	string	Bill Reference identifier: PDF ID	Y

name	value	description	required
client_id	string	This Client ID must be valid and generate by Operation Team.	required
client_secret	string	This Client Secret must be valid and provisioned by Operation Team.	required
X-Correlation-ID		Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N
channeId	string	Channel to business: Digital or SFDC-B2C or APP	N
lob	string	The Line of Business Identifier currently available are: FIXED PREPAID POSTPAID	N
targetSystem	string	Use this data type to indicate target system name/id in your request. EVERTEC	N

QUERY PARAMS

name	type	description	required
pdf	boolean	true or false	Y
billingAccount.id	string	Customer account ID	N
billDate	date	Invoice Date to filter right PDF from the List	N

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - retrieveCustomerBill request processed successfully, response body contains an entity corresponding to the requested resource.

{
    "billDocument": [
        {
            "content": "PDF CONTENT",
            "@type": "pdfBinaryRepresentation"
        }
    ]
}