Skip to content

Initializing a new contract

GET

There is the following process for creating a contract for the specified application:

  1. First, a ticket is created. You can find a description of creating an application here . Please note that when creating an order in the channel of receipt, you must uncheck the "Automatic creation of a contract" (Admin -> E-commerce -> Channels -> Channel Name).

-> 2. Then initialization of the contract on the loan application occurs. Passing the generateName parameter with the value false will not generate a contract number. This parameter is optional and is set to true by default, which generates the next contract number. To automatically create contracts, to avoid the CONTRACT_SERIAL_NUMBER_IS_NOT_UNIQUE error, it is advisable to specify generateName = falsе. This field will be filled in automatically the next time you call the save method for the contract (see next step).

  1. The last step is creating a new contract

Parameters

Path Parameters

loanApplicationId*

loanApplicationId

Type
integer
Required
Format
"int64"

Query Parameters

generateName

generateName

Type
boolean
Default
true

Responses

OK

*/*
object
object

Additional

Branch ID

Format"int64"

Captive

Client ID

Format"int64"
Format"int64"

Comment

Agent ID

Format"int64"

Collector ID

Format"int64"

Creation date in YYYY format -MM-DD

Format"date"
object

Loan conditions

Loan Specialist ID

Format"int64"

Loan product identifier

Format"int64"

Credit product name

Currency identifier

Format"int64"
Format"date-time"
Format"date"
Format"int32"
Format"int32"

Specified amount for distribution of prepayment by interest

Format"double"
Format"int64"
Format"int64"
Format"date"
Format"int64"
Format"double"

Estimated contribution (Rate)

Format"double"

First maturity date in the format YYYY-MM-DD

Format"date"

Fixed Estimated Contribution (Amount)

Format"double"

Fixed Insurance Premium (Amount)

Format"double"

Fixed entry fee (Amount)

Format"double"

Flag "For issue"

Format"int64"
Format"date-time"
Format"double"

Contract ID ( when creating a new contract - you do not need to specify it )

Format"int64"

Date of delivery on initiation

Format"date"

Insurance

Insurance premium (Rate)

Format"double"

Insurance policy

Insurance premium amount

Format"double"

Insurance premium rate

Format"double"

Scheduled issue date in the format YYYY-MM-DD

Format"date"

Entry Fee (Rate)

Format"double"

Upload date (if the contract was transferred from a third-party accounting system). Upload date This field automatically records the contract migration date. In this case, the field Loading date = the date on which we load the balances. All settlement of the contract will start from this date. If the contract was created in BS (not migrated), then the field will be NULL

Format"date"

Loan amount

Format"double"

Loan Application ID

Format"int64"

Loan category identifier

Format"int64"

Loan stage.

The mechanism for setting loanStage is as follows:
the loanStage parameter is set to the loan stage (1, 2, 3 ... etc.). When creating a new loan application (if it is the first for this client), this field is filled with the value 1. If the application is approved, then in the contract this field will contain 1 value 2 (step 2), provided that the first application for this client was approved.
Example:
an application with a step 3 is created, the application goes to the decision making system (which will be pre-configured in the system), there an expression will be executed that will apply the loan product that corresponds to the stage of the loan. When the application is approved in the decision-making system, the value of the loanStage parameter in the contract will be set to 3

Format"int32"
Format"double"
Format"double"
Format"double"

Contract number

Offer code

Format"int64"
Format"int32"
Format"int32"

Repayment rate

Format"double"

Scheduled maturity date in the format YYYY-MM-DD

Format"date"

Department ID

Format"int64"
Format"double"

Flag of the Code of Laws

Claim amount of debt

Format"double"

Date of appeal to court

Format"date"
Format"date"
Valid values"error""ok"
Format"int64"