Create an Application (V1)

  • Updated

Create an Application (V1)

Description

This web service creates an application and returns the committed record. 

Note:

This web service only supports creating an application for the Product Type, Loan.

Definition

POST https://<domain>/services/apexrest/genesis/v1/applications/

Parameters

The following table provides details of the request parameters used by this web service:

FieldTypeDescription

accountId*

String

  • This is the account ID of the borrower.

contact*

String

  • This is the contact ID of the borrower.

loanAmount*

Decimal

  • This is the requested loan amount.

term*  

Integer

  • This is the new term of the loan application.

  • This must be a positive integer.

  • If you pass null, the original term of the loan application is considered.

expectedStartDate 

Date

  • This is the expected start date of the loan application.

  • If you pass null, the current system date is considered.

productType* 

String

  • This is the Product Type of the loan application.

  • Currently, only Loan is supported.

interestRate*  

Decimal

  • This is the interest rate for the new loan application.

interestCalcMethod

String

  • This is the Interest Rate Calculation Method for this loan.

  • Flexible Repayment, Flat and Declining Balance are the Interest Rate Calculation Methods available in CL Originate.

firstRepaymentDate

Date

  • This is the first payment date. 

  • If you pass null, one month, twenty days after the current system date is considered.

paymentFrequency

String

  • This is the payment frequency. 

  • It can be Daily, Weekly, Bi-weekly, Monthly, Quarterly, Annual.

  • If you pass null, the payment frequency MONTHLY is considered.

interestOnlyPeriod Integer

  • This is the number of payments for which only the interest amount should be considered.

balloonPayment Decimal

  • This is a heavy payment at the end of a repayment schedule.

Error Messages

When you post a web service, you can receive the possible error messages as shown in the following table:

Error CodeError MessageSystem.LabelReasonHTTP Status Code

INVALID_INPUT

Unable to parse the Request parameters

UNABLE_PARSE_REQ_PARAMS

You will receive this error if an error occurs while parsing request parameters.

400

INVALID_INPUT

<exception while parsing the parameters>

NA

You will receive this error if there is any exception while parsing the parameters.

400

INVALID_INPUTProduct Type is nullPRODUCT_TYPE_NULLYou will receive this error if the Product Type is not specified in the request parameters.400
INVALID_INPUTUnable to find product type.PRODUCT_TYPE_NOT_FOUNDYou will receive this error if the Product Type is invalid in the request parameters.400
INVALID_INPUT

Both Contact and Account found null. Please provide at least one of them.

ACCOUNT_CONTACT_ID_NULLYou will receive this error if both accountId and contactId are not specified in the request parameters.400
INVALID_INPUTUnable to find the Account.ACCOUNT_NOT_FOUNDYou will receive this error if the account specified in the request parameters is not found.400
INVALID_INPUTUnable to find the Contact.CONTACT_NOT_FOUNDYou will receive this error if the contact specified in the request parameters is not found.400
INVALID_INPUTInvalid Payment Frequency.PAYMENT_FREQUENCY_NOT_FOUNDYou will receive this error if the payment frequency specified in the request parameters is not valid.400

API_EXCEPTION

<exception_message>

NA

You will receive this error if any validation fails or any unexpected error occurs during the processing of the request, the system will raise the exception.

500

Sample Request

The sample request to be sent is as shown below:

POST  https://na10.salesforce.com/services/apexrest/genesis/v1/applications

Sample Request
Copy
{
  "accountId": "001F000001NtH4N",
  "loanAmount": 1000,
  "interestRate": 10,
  "term": 12,
  "productType": "loan",
  "balloonPayment": 100,
  "interestOnlyPeriod": 2,
  "paymentFrequency": "WEEKLY",
  "interestCalcMethod": "Flat",
  "daysConvention": "ACTUAL/ACTUAL",
  "firstRepaymentDate": "2015-03-15"
}

Sample Response

This sample response contains the newly created application for the given borrower. The sample response is as shown below:

Sample Response
Copy
{
  "status": "SUCCESS",
  "response": [],
  "errorMessage": null,
  "errorCode": "NO_ERROR",
  "content": [
    {
      "attributes": {
        "type": "genesis__Applications__c",
        "url": "/services/data/v32.0/sobjects/genesis__Applications__c/a39F00000005yEUIAY"
      },
      "RecordTypeId": "012F00000012dITIAY",
      "genesis__Loan_Amount__c": 1000,
      "genesis__Term__c": 12,
      "genesis__Interest_Only_Period__c": 2,
      "genesis__Product_Type__c": "LOAN",
      "genesis__Payment_Frequency__c": "WEEKLY",
      "genesis__Expected_First_Payment_Date__c": "2015-03-15",
      "genesis__Interest_Calculation_Method__c": "Flat",
      "genesis__Landing_Sequence__c": 2,
      "genesis__Days_Convention__c": "ACTUAL/ACTUAL",
      "genesis__Status__c": "NEW - ENTERED",
      "genesis__Expected_Start_Date__c": "2015-02-14",
      "Id": "a39F00000005yEUIAY",
      "genesis__Expected_Close_Date__c": "2015-03-06",
      "genesis__Interest_Rate__c": 10,
      "genesis__Balloon_Payment__c": 100,
      "genesis__Account__c": "001F000001NtH4NIAV"
    }
  ]
}

In This Article