(GET) Consult all Loans

GET /invoice/loans

This endpoint allows users to retrieve details of all loans by customerID

Headers:

Name	Value
API Key	Bearer <token>
API Secret	Bearer <token>

Response

200

{  
  "customerID": 3f020d62-6cef-4f2c-87ed-b096abc5cac9,
  "riskID": 3f020d62-6cef-4f2c-87ed-b096abc5cac9,
}
{  
  "LoanOfferID": 3f020d62-6cef-4f2c-87ed-b096abc5cac9,
{
      "PartnerID": 3f020d62-b096abc5cac9
      "productTypes": [
      "Personal_loan"
  ],
}
    "accountLinkSettings": {
      "enabled": true,
      "linkableDepositProductKey": "string",
      "linkedAccountOptions": [
        "AUTO_LINK_ACCOUNTS"
      ],
      "settlementMethod": "FULL_DUE_AMOUNTS"
    },
    "accountingSettings": {
      "accountingMethod": "NONE",
      "accountingRules": [
        {
          "encodedKey": "string",
          "financialResource": "PORTFOLIO_CONTROL",
          "glAccountKey": "string",
          "transactionChannelKey": "string"
        }
      ],
      "interestAccrualCalculation": "NONE",
      "interestAccruedAccountingMethod": "NONE"
    },
    "adjustInterestForFirstInstallment": true,
    "allowCustomRepaymentAllocation": true,
    "arrearsSettings": {
      "dateCalculationMethod": "ACCOUNT_FIRST_WENT_TO_ARREARS",
      "encodedKey": "string",
      "monthlyToleranceDay": 0,
      "nonWorkingDaysMethod": "INCLUDED",
      "toleranceCalculationMethod": "ARREARS_TOLERANCE_PERIOD",
      "toleranceFloorAmount": 0,
      "tolerancePercentageOfOutstandingPrincipal": {
        "defaultValue": 0,
        "maxValue": 0,
        "minValue": 0
      },
      "tolerancePeriod": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      }
    },
    "availabilitySettings": {
      "availableFor": [
        "INDIVIDUALS"
      ],
      "branchSettings": {
        "availableProductBranches": [
          "string"
        ],
        "forAllBranches": true
      }
    },
    "category": "PERSONAL_LENDING",
    "creationDate": "2016-09-06T13:37:50+03:00",
    "creditArrangementSettings": {
      "creditArrangementRequirement": "OPTIONAL"
    },
    "currency": {
      "code": "AED",
      "currencyCode": "string"
    },
    "encodedKey": "string",
    "feesSettings": {
      "allowArbitraryFees": true,
      "fees": [
        {
          "accountingRules": [
            {
              "encodedKey": "string",
              "financialResource": "PORTFOLIO_CONTROL",
              "glAccountKey": "string",
              "transactionChannelKey": "string"
            }
          ],
          "amortizationSettings": {
            "amortizationProfile": "NONE",
            "encodedKey": "string",
            "feeAmortizationUponRescheduleRefinanceOption": "END_AMORTIZATION_ON_THE_ORIGINAL_ACCOUNT",
            "frequency": "ACCOUNT_INSTALLMENTS_DUE_DATES",
            "intervalCount": 0,
            "intervalType": "PREDEFINED_INTERVALS",
            "periodCount": 0,
            "periodUnit": "DAYS"
          },
          "amount": 0,
          "amountCalculationFunctionName": "string",
          "amountCalculationMethod": "FLAT",
          "applyDateMethod": "MONTHLY_FROM_ACTIVATION",
          "creationDate": "2016-09-06T13:37:50+03:00",
          "encodedKey": "string",
          "feeApplication": "REQUIRED",
          "id": "string",
          "lastModifiedDate": "2016-09-06T13:37:50+03:00",
          "name": "string",
          "percentageAmount": 0,
          "state": "ACTIVE",
          "taxSettings": {
            "taxableCalculationMethod": "DEFAULT"
          },
          "trigger": "MANUAL"
        }
      ]
    },
    "fundingSettings": {
      "enabled": true,
      "funderInterestCommission": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      },
      "funderInterestCommissionAllocationType": "PERCENTAGE_OF_LOAN_FUNDING",
      "lockFundsAtApproval": true,
      "organizationInterestCommission": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      },
      "requiredFunds": 0
    },
    "gracePeriodSettings": {
      "gracePeriod": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      },
      "gracePeriodType": "NONE"
    },
    "id": "string",
    "interestSettings": {
      "accrueLateInterest": true,
      "compoundingFrequency": "DAILY",
      "daysInYear": "ACTUAL_365_FIXED",
      "indexRateSettings": {
        "accrueInterestAfterMaturity": true,
        "allowNegativeInterestRate": true,
        "encodedKey": "string",
        "indexSourceKey": "string",
        "interestChargeFrequency": "ANNUALIZED",
        "interestChargeFrequencyCount": 0,
        "interestRate": {
          "defaultValue": 0,
          "maxValue": 0,
          "minValue": 0
        },
        "interestRateCeilingValue": 0,
        "interestRateFloorValue": 0,
        "interestRateReviewCount": 0,
        "interestRateReviewUnit": "DAYS",
        "interestRateSource": "FIXED_INTEREST_RATE",
        "interestRateTerms": "FIXED",
        "interestRateTiers": [
          {
            "encodedKey": "string",
            "endingBalance": 0,
            "interestRate": 0
          }
        ]
      },
      "interestApplicationDays": {
        "daysInMonth": [
          0
        ],
        "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH"
      },
      "interestApplicationMethod": "AFTER_DISBURSEMENT",
      "interestBalanceCalculationMethod": "ONLY_PRINCIPAL",
      "interestCalculationMethod": "FLAT",
      "interestRateChangePMTAdjustmentThreshold": {
        "method": "WORKING_DAYS",
        "numberOfDays": 0
      },
      "interestRateSettings": [
        {
          "encodedKey": "string",
          "indexSourceKey": "string",
          "interestRate": {
            "defaultValue": 0,
            "maxValue": 0,
            "minValue": 0
          },
          "interestRateCeilingValue": 0,
          "interestRateFloorValue": 0,
          "interestRateReviewCount": 0,
          "interestRateReviewUnit": "DAYS",
          "interestRateSource": "FIXED_INTEREST_RATE"
        }
      ],
      "interestType": "SIMPLE_INTEREST",
      "scheduleInterestDaysCountMethod": "REPAYMENT_PERIODICITY"
    },
    "internalControls": {
      "dormancyPeriodDays": 0,
      "fourEyesPrinciple": {
        "activeForLoanApproval": true
      },
      "lockSettings": {
        "cappingConstraintType": "SOFT_CAP",
        "cappingMethod": "OUTSTANDING_PRINCIPAL_PERCENTAGE",
        "cappingPercentage": 0,
        "lockPeriodDays": 0
      }
    },
    "lastModifiedDate": "2016-09-06T13:37:50+03:00",
    "loanAmountSettings": {
      "loanAmount": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      },
      "trancheSettings": {
        "maxNumberOfTranches": 0
      }
    },
    "name": "string",
    "newAccountSettings": {
      "accountInitialState": "PARTIAL_APPLICATION",
      "idGeneratorType": "INCREMENTAL_NUMBER",
      "idPattern": "string"
    },
    "notes": "string",
    "offsetSettings": {
      "allowOffset": true
    },
    "paymentSettings": {
      "amortizationMethod": "STANDARD_PAYMENTS",
      "latePaymentsRecalculationMethod": "OVERDUE_INSTALLMENTS_INCREASE",
      "paymentMethod": "HORIZONTAL",
      "prepaymentSettings": {
        "applyInterestOnPrepaymentMethod": "AUTOMATIC",
        "elementsRecalculationMethod": "PRINCIPAL_EXPECTED_FIXED",
        "ercFreeAllowance": 0,
        "futurePaymentsAcceptance": "NO_FUTURE_PAYMENTS",
        "prepaymentAcceptance": "ACCEPT_PREPAYMENTS",
        "prepaymentRecalculationMethod": "NO_RECALCULATION",
        "principalPaidInstallmentStatus": "PARTIALLY_PAID"
      },
      "principalPaymentSettings": {
        "amount": {
          "defaultValue": 0,
          "encodedKey": "string",
          "maxValue": 0,
          "minValue": 0
        },
        "defaultPrincipalRepaymentInterval": 0,
        "encodedKey": "string",
        "includeFeesInFloorAmount": true,
        "includeInterestInFloorAmount": true,
        "percentage": {
          "defaultValue": 0,
          "encodedKey": "string",
          "maxValue": 0,
          "minValue": 0
        },
        "principalCeilingValue": 0,
        "principalFloorValue": 0,
        "principalPaymentMethod": "FLAT",
        "totalDueAmountFloor": 0,
        "totalDuePayment": "FLAT"
      },
      "repaymentAllocationOrder": [
        "PRINCIPAL"
      ]
    },
    "penaltySettings": {
      "loanPenaltyCalculationMethod": "NONE",
      "loanPenaltyGracePeriod": 0,
      "penaltyRate": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      }
    },
    "redrawSettings": {
      "allowRedraw": true
    },
    "scheduleSettings": {
      "amortizationPeriod": {
        "defaultValue": 0,
        "maxValue": 0,
        "minValue": 0
      },
      "billingCycles": {
        "enabled": true,
        "startDays": [
          0
        ]
      },
      "defaultRepaymentPeriodCount": 0,
      "firstRepaymentDueDateOffset": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      },
      "fixedDaysOfMonth": [
        0
      ],
      "interestAccrualSince": "DISBURSEMENT",
      "numInstallments": {
        "defaultValue": 0,
        "encodedKey": "string",
        "maxValue": 0,
        "minValue": 0
      },
      "previewSchedule": {
        "numberOfPreviewedInstalments": 0,
        "previewScheduleEnabled": true
      },
      "repaymentMethod": "AMOUNT",
      "repaymentPeriodUnit": "DAYS",
      "repaymentReschedulingMethod": "NONE",
      "repaymentScheduleEditOptions": [
        "ADJUST_PAYMENT_DATES"
      ],
      "repaymentScheduleMethod": "NONE",
      "roundingSettings": {
        "repaymentCurrencyRounding": "NO_ROUNDING",
        "repaymentElementsRoundingMethod": "NO_ROUNDING",
        "roundingRepaymentScheduleMethod": "NO_ROUNDING"
      },
      "scheduleDueDatesMethod": "INTERVAL",
      "shortMonthHandlingMethod": "LAST_DAY_IN_MONTH"
    },
    "securitySettings": {
      "isCollateralEnabled": true,
      "isGuarantorsEnabled": true,
      "requiredGuaranties": 0
    },
    "state": "ACTIVE",
    "taxSettings": {
      "taxCalculationMethod": "INCLUSIVE",
      "taxSourceKey": "string",
      "taxesOnFeesEnabled": true,
      "taxesOnInterestEnabled": true,
      "taxesOnPenaltyEnabled": true
    },
    "templates": [
      {
        "creationDate": "2016-09-06T13:37:50+03:00",
        "encodedKey": "string",
        "lastModifiedDate": "2016-09-06T13:37:50+03:00",
        "name": "string",
        "type": "ACCOUNT"
      }
    ],
    "type": "FIXED_TERM_LOAN"
  }
]

400

{
  "error": "Invalid request"
}