--- title: "Get Customer Dashboard" method: GET path: "/v1/reports/customer/{customerReferenceNo}/dashboard" tags: ["Report"] --- # Get Customer Dashboard `GET /v1/reports/customer/{customerReferenceNo}/dashboard` ## Request - Base URL: `https://api.credilinq.ai` - URL: `https://api.credilinq.ai/v1/reports/customer/{customerReferenceNo}/dashboard` - Auth: HTTP bearer ## Path parameters - `customerReferenceNo` string, required ## Headers - `accept-language` string ## Response `200` Customer's Dashboard Details - GetCustomerDashboardResponse - `statusCode` number, required: The HTTP status code of the error - `data` CustomerSummaryResponse, required - `customerName` string, required: Customer or a Company's Full Name - `customerEmail` string, required: Email address of Customer/company which is used for login to B2B PayLater portal - `mobileNo` string, required: Company/Customer's Mobile number along with country code - `businessRegistrationNo` string, required: Business Registration Number is a company registration number provided by the government agency - `customerReferenceNo` string, required: Customer Reference number this will be used to execute all APIs further to activate customer, to create loan and so on - `availableCredit` number, required: Customer's available credit limit - `approvedCredit` number, required: Customer's approved credit limit - `totalOutstandingAmount` number, required: Total payable outstanding amount by customer - `loans` LoanSummaryResponse[], required: All loans of customer - `loanId` string, required: Id of the created loan - `loanStatus` string, required: Status of loan We support these three statuses, 1. ```pending-for-approval``` - Loan is pending for approval 2. ```waiting-for-disbursal``` - Loan is pending for disbursal, 3. ```active``` - Loan is active, 4. ```rejected``` - Loan is rejected for some reason, 5. ```closed``` - Loan is paid & closed - `loanReferenceNo` string, required: Loan Reference number - `loanType` string, required: Type of loan We support these 4 types, 1. ```BNPL``` - Buyer Financing 2. ```BNPL_Term``` - Buyer Financing Term Loan 3. ```GMV``` - Seller Financing 4. ```GMV_Term``` - Seller Financing Term Loan - `customerReferenceNo` string, required: Customer Reference number, for which loan is created - `loanTerm` 30 | 45 | 60 | 90 | 120 | 150 | 180 | 210 | 240 | 270 | 300 | 330 | 360, required: Duration of the loan. Based on loan terms selected at the cusomer level, The customer for whom loan is being created should be - `loanAmount` number, required: Loan Amount - `totalServiceFee` number, required: Total Service fee applied on loan - `totalServiceFeeDue` number, required: Total Service fee Due for loan - `expectedRepaymentAmount` number, required: Total Expected Repayment Amount - `totalDueAmount` number, required: Total Due amount that is remaining to repay - `loanDueDate` string, required: Loan Due Date eg. 18 September 2023 - `dueDatePostGracePeriod` string, required: Due date with Grace Period, eg. Loan Due date is 18 September 2023, and grace period is 3 days. so dueDatePostGracePeriod will be 21 September 2023 - `gracePeriodInDays` number, required: Grace Period(In Days), After which loan goes into overdue. - `totalPenaltyDue` number, required: Penalty outstanding that needs to repay - `currency` string, required: Currency Code - `requestedDate` string, required: Loan Due Date eg. 18 Aug 2023 - `repaymentSchedule` RepaymentScheduleV2Response[], required: Repayment schedule for loan - `dueDate` string, required: Loan Due Date eg. 18 September 2023 - `totalDueForPeriod` number, required: Total due payment for current period - `penaltyDueForPeriod` number, required: Total due penalty for current period - `totalServiceFeeForPeriod` number, required: Total Service fee for current period - `totalServiceFeeDueForPeriod` number, required: Total Service fee due for current period - `principalDueForPeriod` number, required: Total due principal for current period - `dueDatePostGracePeriod` string, required: Due date with grace period eg. 21 September 2023 - `paid` boolean, required: indicates that payment is completed or not - `payments` LoanPayment[], required: All payments done by customer for the loan - `paymentId` string, required: Id of the payment - `paymentDate` string, required: Date of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z - `paymentAmount` number, required: Payment Amount - `paymentMethod` string, required: Payment Amount - `paymentReferenceNo` string, required: Payment reference number provided while making payment - `accountNumber` string, required: Account Number varies based on payment types. So for bank transfer payment( this field will contain ```bank account number``` & for UEN number payment this will contain ```UEN Number``` - `accountName` string, required: Account Name to which payment has been made. - `bankName` string, required: Bank Name varies based on payment types. So for bank transfer payment this field will be present, for rest of the types it will be empty - `bankSwiftCode` string, required: Bank Swift Code varies based on payment types. So for bank transfer payment this field will be present, for rest of the types it will be empty - `paymentStatus` number, required: We have 3 types of payment status codes. For payment rejected: ```0``` For payment done, but verification pending: ```1``` For payment done & verified: ```2``` - `loanId` string, required: Loan Id, for which payment has been made. - `customerReferenceNo` string, required: Customer Reference Number, for which payment has been made. - `metadata` string, required: Metadata for payments. It can be used for reporting, reconciliation purpose. - `createdAt` string, required: Created Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z - `updatedAt` string, required: Updated Timestamp of the payment in UTC Format eg. 2023-03-30T11:46:42.195Z - `currency` string, required: Currency Code - `createdAt` string, required: Created Timestamp of the customer in UTC Format eg. 2023-03-30T11:46:42.195Z - `updatedAt` string, required: Updated Timestamp of the customer in UTC Format eg. 2023-03-30T11:46:42.195Z - `message` string, required: Human-readable message containing all available details about the operation - `success` boolean, required: A boolean indicating whether this was a success response or an error response ## Other responses - `400`: Invalid Request - `401`: Invalid credentials - `403`: Forbidden resource - `404`: Requested Data Not Found - `500`: Internal Server Error, Some problem is there, please try after sometime ## Changes - **2026-11-03** `9c7459ed471b`: 5 info - the `createdAt` response's property default value changed from `2026-10-22T10:32:50.366Z` to `2026-11-03T05:12:55.489Z` for the status `200` - the `createdAt` response's property default value changed from `2026-10-22T10:32:50.370Z` to `2026-11-03T05:12:55.503Z` for the status `200` - the `paymentDate` response's property default value changed from `2026-10-22T10:32:50.365Z` to `2026-11-03T05:12:55.489Z` for the status `200` - the `updatedAt` response's property default value changed from `2026-10-22T10:32:50.366Z` to `2026-11-03T05:12:55.489Z` for the status `200` - …1 more - **2026-10-22** `2e0ba4079f74`: 5 info - the `createdAt` response's property default value changed from `2026-10-13T13:38:11.993Z` to `2026-10-22T10:32:50.366Z` for the status `200` - the `createdAt` response's property default value changed from `2026-10-13T13:38:12.003Z` to `2026-10-22T10:32:50.370Z` for the status `200` - the `paymentDate` response's property default value changed from `2026-10-13T13:38:11.993Z` to `2026-10-22T10:32:50.365Z` for the status `200` - the `updatedAt` response's property default value changed from `2026-10-13T13:38:11.993Z` to `2026-10-22T10:32:50.366Z` for the status `200` - …1 more - …earlier changes not shown [Operation history](https://skmtc.dev/credilinq/apis/credilinq-apis/changes/v1/reports/customer/:customerReferenceNo/dashboard/get.md) --- [API](https://skmtc.dev/credilinq/apis/credilinq-apis.md) - [All operations](https://skmtc.dev/credilinq/apis/credilinq-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/credilinq/apis/credilinq-apis/revisions/9c7459ed471b?raw)