sfdc-ux (CWP)

(0 reviews)

TMF666-retrieveBillingAccount

/{businessId}/billingAccount

[GET]

This method is to retrieve billing account details.

https://nonprod.cwp.esb.cloud.lla.com/dev/sfdc-ux-cwp/sfdc-ux/v1/{businessId}/billingAccount/{id}
url Param
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BS, JM) identifying the business unit. Expected:PAY
idstringBilling Account idY
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier 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. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API requestN
Sample Response
{
    "id": "206025980000",
    "billable": true,
    "accountType": "R",
    "description": "Residencial",
    "name": "ANIBAL RIVERA BATISTA",
    "paymentStatus": "Active",
    "state": "W-Activo",
    "accountBalance": [
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "NetPayable"
        },
        {
            "amount": {
                "value": 58.78,
                "unit": "PAB"
            },
            "balanceType": "LastBillAmount",
            "validFor": {
                "endDateTime": "2026-01-31T00:00:00.000-05:00"
            }
        },
        {
            "amount": {
                "value": 58.78,
                "unit": "PAB"
            },
            "balanceType": "LastPayment Amount",
            "validFor": {
                "endDateTime": "2026-01-09T09:46:35.000-05:00"
            }
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "Overdue Amount"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "DepositRequired"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "WrittenOffAmount"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "TotalQuery"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "TotalOutstandingBalance"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "DepositHeld"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "Total Query Tax"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "TotalAdjustmentCredit"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "TotalDepositPaid"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "TotalServiceChargeCredit"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "TotalRewards"
        },
        {
            "amount": {
                "value": 0,
                "unit": "PAB"
            },
            "balanceType": "TotalAvailablePointsAmount"
        }
    ],
    "billStructure": {
        "cycleSpecification": {
            "id": "D",
            "paymentDueDate": "2026-01-31T00:00:00.000Z",
            "billingDay": 3
        },
        "presentationMedia": [
            {
                "id": "N",
                "name": "Non-paper Based Bill"
            },
            {
                "id": "S",
                "name": "BillLanguage"
            }
        ]
    },
    "paymentPlan": [
        {
            "priority": 0,
            "planType": "J",
            "status": "",
            "@Type": "SupportsRecurringPayments"
        }
    ],
    "relatedParty": [
        {
            "id": "8-370-5",
            "name": "ANIBAL RIVERA BATISTA",
            "role": "customer",
            "@type": "Customer",
            "@referredType": "Customer",
            "@baseType": "RelatedParty",
            "characteristic": [
                {
                    "name": "DocumentType",
                    "value": "C"
                },
                {
                    "name": "DocumentNumber",
                    "value": "8-370-5"
                },
                {
                    "name": "Email",
                    "value": "arivera28017115@gmail.com"
                },
                {
                    "name": "Gender",
                    "value": "M"
                },
                {
                    "name": "FirstName",
                    "value": "ANIBAL",
                    "valueType": "string"
                },
                {
                    "name": "LastName",
                    "value": "RIVERA BATISTA",
                    "valueType": "string"
                },
                {
                    "name": "Date-Of-Birth",
                    "value": "27-Jan-1971 00:00:00",
                    "valueType": "string"
                },
                {
                    "name": "StartDate",
                    "value": "2010-04-14T19:00:00.000-05:00",
                    "valueType": "DateTime"
                },
                {
                    "name": "Customer Identity",
                    "valueType": "array",
                    "value": [
                        {
                            "DocumentType": "C",
                            "DocumentNumber": "8-370-5",
                            "DocumentDescription": "Cedula"
                        }
                    ]
                }
            ]
        },
        {
            "id": "0",
            "role": "MigratedAccount"
        },
        {
            "id": "LIME",
            "role": "legalEntity"
        },
        {
            "@type": "Account",
            "characteristic": [
                {
                    "name": "BaseAccountType",
                    "value": "RES"
                }
            ]
        },
        {
            "id": "990005",
            "name": "RESI_BRONCE",
            "role": "marketingCategory"
        }
    ],
    "contact": [
        {
            "contactMedium": [
                {
                    "mediumType": "BillingAddress",
                    "characteristic": {
                        "street1": "PANAMA  BETHANIA",
                        "street2": "LA LOCERIA MULTI GUADALUPE 30",
                        "city": "APTO 3 B",
                        "stateOrProvince": "CALLE PRINCIPAL FRENTE A LA ESC JAPON"
                    }
                },
                {
                    "mediumType": "Telephone",
                    "characteristic": {
                        "phoneNumber": "2604140",
                        "contactType": "serviceNumber"
                    }
                },
                {
                    "mediumType": "Email",
                    "characteristic": {
                        "emailAddress": "arivera28017115@gmail.com"
                    }
                }
            ]
        },
        {
            "contactName": "ANIBAL RIVERA BATISTA",
            "partyRoleType": "OWNER",
            "contactMedium": [
                {
                    "mediumType": "Email",
                    "characteristic": {
                        "emailAddress": "arivera28017115@gmail.com",
                        "contactType": "email"
                    }
                },
                {
                    "mediumType": "Telephone",
                    "characteristic": {
                        "phoneNumber": "68773953",
                        "contactType": "mobile1"
                    }
                },
                {
                    "mediumType": "Telephone",
                    "characteristic": {
                        "phoneNumber": "3161145",
                        "contactType": "home"
                    }
                },
                {
                    "mediumType": "Mobile",
                    "characteristic": {
                        "phoneNumber": "68773953",
                        "contactType": "mobile1"
                    }
                }
            ]
        }
    ],
    "creditLimit": {
        "unit": "PAB",
        "value": 0
    },
    "defaultPaymentMethod": {
        "id": "C",
        "name": "Cash"
    },
    "financialAccount": {
        "id": "206025980000",
        "@referredType": "FinancialAccount"
    },
    "sourceBSS": "LIBERATE"
}

Reviews