ProjectionService

Perform projection calculations.

Symitar eDocs References: Coming soon.

Operations

calculatePaymentAmount

post

Computes the payment amount for a loan considering relevant factors.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InterestRatenumber · floatOptional

InterestTypeintegerOptional

PaymentFrequencyintegerOptional

MAprPrepaidFinanceChgnumber · floatOptional

MilitaryAprLoanbooleanOptional

DqCalculationMethodintegerOptional

DueDateAdvanceCodeintegerOptional

LoanDatestring · dateOptional

PaymentTypeintegerOptional

PaymentCalculationTypeintegerOptional

AmortizeScheduleintegerOptional

AmortizeScheduleTypeintegerOptional

PaymentSkipsintegerOptional

PaymentSkipStartDayintegerOptional

DueDay1integerOptional

DueDay2integerOptional

FirstDueDatestring · dateOptional

BalloonDatestring · dateOptional

BalloonAmountnumber · floatOptional

FirstInsuredBirthDatestring · dateOptional

SecondInsuredBirthDatestring · dateOptional

InsuranceTypeintegerOptional

EscrowAmountnumber · floatOptional

PrepaidFinanceChgnumber · floatOptional

LoanAmountnumber · floatOptional

MaturityDatestring · dateOptional

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Paymentnumber · floatOptional

LoanAmountnumber · floatOptional

PaymentCountintegerOptional

FinalPaymentnumber · floatOptional

FinalDueDatestring · dateOptional

FirstPaymentDatestring · dateOptional

TotalInterestnumber · floatOptional

TotalPaymentsnumber · floatOptional

TotalEscrownumber · floatOptional

TotalMaprFeesnumber · floatOptional

Lifenumber · floatOptional

Disabilitynumber · floatOptional

LifeErrorstringOptional

DisabilityErrorstringOptional

Aprnumber · floatOptional

Maprnumber · floatOptional

post/calculatePaymentAmount

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/projection/calculatePaymentAmount HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InterestRate": "5.000",
  "InterestType": 0,
  "PaymentFrequency": 1,
  "LoanDate": "2026-07-03",
  "FirstDueDate": "2026-08-03",
  "LoanAmount": "1000.00",
  "MaturityDate": "2027-07-03",
  "PaymentType": 0,
  "PaymentCalculationType": 0
}

200

Successful operation.

{
  "StatusMessage": null,
  "Payment": "1004.25",
  "LoanAmount": "1000.00",
  "PaymentCount": 1,
  "FinalPayment": "1004.25",
  "FinalDueDate": "2026-08-03",
  "FirstPaymentDate": "2026-08-03",
  "TotalInterest": "4.25",
  "TotalPayments": "1004.25",
  "TotalEscrow": "0.00",
  "TotalMaprFees": "0.00",
  "Life": "0.00",
  "Disability": "0.00",
  "LifeError": null,
  "DisabilityError": null,
  "Apr": "0.000",
  "Mapr": "0.000",
  "MessageId": "calculatePaymentAmount",
  "StatusCode": 0
}

calculateLoanAmount

post

Determines the loan amount based on specified parameters.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InterestRatenumber · floatOptional

InterestTypeintegerOptional

PaymentFrequencyintegerOptional

MAprPrepaidFinanceChgnumber · floatOptional

MilitaryAprLoanbooleanOptional

DqCalculationMethodintegerOptional

DueDateAdvanceCodeintegerOptional

LoanDatestring · dateOptional

PaymentTypeintegerOptional

PaymentCalculationTypeintegerOptional

AmortizeScheduleintegerOptional

AmortizeScheduleTypeintegerOptional

PaymentSkipsintegerOptional

PaymentSkipStartDayintegerOptional

DueDay1integerOptional

DueDay2integerOptional

FirstDueDatestring · dateOptional

BalloonDatestring · dateOptional

BalloonAmountnumber · floatOptional

FirstInsuredBirthDatestring · dateOptional

SecondInsuredBirthDatestring · dateOptional

InsuranceTypeintegerOptional

EscrowAmountnumber · floatOptional

PrepaidFinanceChgnumber · floatOptional

MaturityDatestring · dateOptional

Paymentnumber · floatOptional

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Paymentnumber · floatOptional

LoanAmountnumber · floatOptional

PaymentCountintegerOptional

FinalPaymentnumber · floatOptional

FinalDueDatestring · dateOptional

FirstPaymentDatestring · dateOptional

TotalInterestnumber · floatOptional

TotalPaymentsnumber · floatOptional

TotalEscrownumber · floatOptional

TotalMaprFeesnumber · floatOptional

Lifenumber · floatOptional

Disabilitynumber · floatOptional

LifeErrorstringOptional

DisabilityErrorstringOptional

Aprnumber · floatOptional

Maprnumber · floatOptional

post/calculateLoanAmount

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/projection/calculateLoanAmount HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 299

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InterestRate": "5.000",
  "InterestType": 0,
  "PaymentFrequency": 1,
  "LoanDate": "2026-07-03",
  "FirstDueDate": "2026-08-03",
  "Payment": "100.00",
  "MaturityDate": "2027-07-03",
  "PaymentType": 0,
  "PaymentCalculationType": 0
}

200

Successful operation.

{
  "StatusMessage": null,
  "Payment": "100.00",
  "LoanAmount": "99.58",
  "PaymentCount": 1,
  "FinalPayment": "100.00",
  "FinalDueDate": "2026-08-03",
  "FirstPaymentDate": "2026-08-03",
  "TotalInterest": "0.42",
  "TotalPayments": "100.00",
  "TotalEscrow": "0.00",
  "TotalMaprFees": "0.00",
  "Life": "0.00",
  "Disability": "0.00",
  "LifeError": null,
  "DisabilityError": null,
  "Apr": "0.000",
  "Mapr": "0.000",
  "MessageId": "calculateLoanAmount",
  "StatusCode": 0
}

calculateLoanTerm

post

Calculates the loan term (duration) based on given criteria.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InterestRatenumber · floatOptional

InterestTypeintegerOptional

PaymentFrequencyintegerOptional

MAprPrepaidFinanceChgnumber · floatOptional

MilitaryAprLoanbooleanOptional

DqCalculationMethodintegerOptional

DueDateAdvanceCodeintegerOptional

LoanDatestring · dateOptional

PaymentTypeintegerOptional

PaymentCalculationTypeintegerOptional

AmortizeScheduleintegerOptional

AmortizeScheduleTypeintegerOptional

PaymentSkipsintegerOptional

PaymentSkipStartDayintegerOptional

DueDay1integerOptional

DueDay2integerOptional

FirstDueDatestring · dateOptional

BalloonDatestring · dateOptional

BalloonAmountnumber · floatOptional

FirstInsuredBirthDatestring · dateOptional

SecondInsuredBirthDatestring · dateOptional

InsuranceTypeintegerOptional

EscrowAmountnumber · floatOptional

PrepaidFinanceChgnumber · floatOptional

LoanAmountnumber · floatOptional

Paymentnumber · floatOptional

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

Paymentnumber · floatOptional

LoanAmountnumber · floatOptional

PaymentCountintegerOptional

FinalPaymentnumber · floatOptional

FinalDueDatestring · dateOptional

FirstPaymentDatestring · dateOptional

TotalInterestnumber · floatOptional

TotalPaymentsnumber · floatOptional

TotalEscrownumber · floatOptional

TotalMaprFeesnumber · floatOptional

Lifenumber · floatOptional

Disabilitynumber · floatOptional

LifeErrorstringOptional

DisabilityErrorstringOptional

Aprnumber · floatOptional

Maprnumber · floatOptional

post/calculateLoanTerm

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/projection/calculateLoanTerm HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InterestRate": "5.000",
  "InterestType": 0,
  "PaymentFrequency": 1,
  "LoanDate": "2026-07-03",
  "FirstDueDate": "2026-08-03",
  "LoanAmount": "1000.00",
  "Payment": "100.00",
  "PaymentType": 0,
  "PaymentCalculationType": 0
}

200

Successful operation.

{
  "StatusMessage": null,
  "Payment": "100.00",
  "LoanAmount": "1000.00",
  "PaymentCount": 14,
  "FinalPayment": "34.15",
  "FinalDueDate": "2039-08-03",
  "FirstPaymentDate": "2026-08-03",
  "TotalInterest": "334.15",
  "TotalPayments": "1334.15",
  "TotalEscrow": "0.00",
  "TotalMaprFees": "0.00",
  "Life": "0.00",
  "Disability": "0.00",
  "LifeError": null,
  "DisabilityError": null,
  "Apr": "0.000",
  "Mapr": "0.000",
  "MessageId": "calculateLoanTerm",
  "StatusCode": 0
}