post
http://{{url}}/api/method/emotive_app.api.loan_onboarding.loan_onboarding.create_loan_onboarding-1
This API supports creating, updating, copying, saving as draft, and submitting Loan Onboarding records using a single endpoint. The operation performed depends on the values of loan_onboarding_id and is_draft in the request body.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
API Behavior overview and matrix
This API does not use different URLs for different actions.
Instead, behavior is controlled by request parameters.
loan_onboarding_id– Determines whether the request creates a new Loan Onboarding record or updates an existing one.is_draft– Indicates whether the Loan Onboarding record is saved as Draft (true) or Submitted (false).
| Operation | loan_onboarding_id | is_draft | Result |
|---|---|---|---|
| Create New Loan Onboarding (Draft) | null | true | Creates a new Loan Onboarding in Draft state |
| Create New Loan Onboarding (Draft Copy) | null | true | Creates a new Draft by cloning an existing Loan Onboarding |
| Create & Submit New Loan Onboarding | null | false | Creates and submits a new Loan Onboarding |
| Update Existing Loan Onboarding (Draft) | Existing ID | true | Updates an existing Draft Loan Onboarding |
| Update & Submit Existing Loan Onboarding | Existing ID | false | Updates and submits an existing Loan Onboarding |
| Submit Existing Loan Onboarding | Existing ID | false | Submits an existing Draft Loan Onboarding |
Request URL
{{url}}/api/method/emotive_app.api.loan_onboarding.loan_onboarding.create_loan_onboardingRequest Fields
- loan_onboarding_id – Identifier of the loan onboarding record; set to
nullto create a new loan or provide an ID to update an existing one. - is_draft – Determines whether the loan onboarding record is saved as Draft (
true) or submitted (false). - doc – Complete loan onboarding payload containing customer, vehicle, sales, payment, insurance, and product details.
Loan Details (doc)
doc)- loan_type – Type of loan contract being created (e.g., Retail Installment Contract).
- creation_method – Method used to create the loan account.
- is_collateralized – Indicates whether the loan is secured with collateral.
- company – Legal company under which the loan is created.
- company_branch – Branch associated with the loan onboarding.
- portfolio – Loan portfolio to which the account belongs.
- loan_product – Loan product configuration applied to the account.
- supplier – Entity funding or supplying the loan.
- program – Lending program associated with the loan.
- securitization – Securitization structure applied to the loan.
- metro_2_account_number – Metro 2 reporting account number.
- alternate_account – Alternate internal account reference.
- risk_rating – Risk classification assigned to the loan.
Buyer (doc.buyer)
doc.buyer)- customer_type – Specifies whether the buyer is an Individual or Company.
- customer_group – Customer classification used for reporting and segmentation.
- territory – Geographic territory of the buyer.
- market_segment – Market segment to which the buyer belongs.
- industry – Industry classification of the buyer.
- website – Buyer’s website URL.
Buyer Addresses (doc.buyer.addresses)
doc.buyer.addresses)- address_status – Indicates whether the address is Current or Previous.
- address_type – Type of address (Physical or Mailing).
- country – Country of residence.
- address_line1 – Primary street address.
- city – City of residence.
- state – State or province.
- county – County of residence.
- pincode – Postal or ZIP code.
- payment_type – Housing payment type such as Rent or Own.
- rent_per_month – Monthly rent amount, if applicable.
- is_preferred_address – Indicates the primary address for communication.
Buyer Contact (doc.buyer.contact)
doc.buyer.contact)- first_name – Buyer’s first name.
- middle_name – Buyer’s middle name.
- last_name – Buyer’s last name.
- salutation – Title used for the buyer.
- date_of_birth – Buyer’s date of birth.
- ssn – Buyer’s Social Security Number.
- dl_number – Driver’s license number.
- dl_state – State that issued the driver’s license.
- preferred_language – Preferred language for communication.
- preferred_communication – Preferred communication channel.
Buyer Phone Numbers (doc.buyer.contact.phone_nos)
doc.buyer.contact.phone_nos)- phone – Phone number of the buyer.
- is_primary_phone – Indicates whether this is the primary phone number.
- is_primary_mobile_no – Indicates whether this is the primary mobile number.
- type – Type of phone number (Phone, Mobile, Other).
Buyer Email IDs (doc.buyer.contact.email_ids)
doc.buyer.contact.email_ids)- email_id – Email address of the buyer.
- is_primary – Indicates whether this is the primary email address.
Vehicle (doc.vehicle_item)
doc.vehicle_item)- vin – Vehicle Identification Number.
- odometer_reading – Recorded mileage of the vehicle.
- odometer_reading_type – Type of odometer reading (Actual or Not Actual).
- odometer_reading_date – Date when the odometer reading was recorded.
Sales Details (doc)
doc)- sale_date – Date of vehicle sale.
- sale_price – Final sale price of the vehicle.
- discount – Discount applied to the sale price.
- cash_down – Cash down payment amount.
- finance_charge – Total finance charges applied to the loan.
Payment & Interest (doc)
doc)- interest_start_date – Date from which interest starts accruing.
- first_payment_due – Due date of the first installment.
- rate – Interest rate applied to the loan.
- frequency – Payment frequency (Monthly, Bi-Weekly, etc.).
- term – Loan term duration in months.
Payment Streams (doc.payment_streams)
doc.payment_streams)- term – Number of installments in the payment stream.
- payment – Payment amount per installment.
- start_date – Start date of the payment stream.
- end_date – End date of the payment stream.
Fees (doc.fee_detail)
doc.fee_detail)- name1 – Name of the fee charged.
- amount – Fee amount.
- type – Indicates whether the fee is financed or paid outside closing.
Taxes (doc.taxes)
doc.taxes)- tax_item – Name of the tax applied.
- rate – Tax percentage rate.
- amount – Tax amount applied to the loan.
Insurance Products (doc.insurance_products)
doc.insurance_products)- supplier – Insurance provider.
- insurance_product – Type of insurance coverage.
- policy_number – Insurance policy reference number.
- premium – Insurance premium amount.
- term_months – Coverage duration in months.
- refundable – Indicates whether the insurance is refundable.
Example Request
{
"doc": {
"loan_type": "Retail Installment Contract",
"creation_method": "Book a New Loan Account",
"is_collateralized": 1,
"company": "Emotive Related Finance Company",
"company_branch": "Emotive Finance Company - 01",
"portfolio": "Car Loan Portfolio CL",
"loan_product": "Loan Onboard ERFC",
"supplier": "Emotive Finance Company",
"program": "Secured Auto Loans",
"securitization": "Securitization for Good Loans",
"metro_2_account_number": "ACC042101",
"alternate_account": "PRCHLOAN",
"risk_rating": "A",
"buyer": {
"customer_type": "Individual",
"customer_group": "Individual",
"territory": "United States",
"market_segment": "Upper Income",
"website": "www.JamesDwels.com",
"industry": "Automotive",
"linkedin_username": "JamesDwelsJOrgupdated",
"twitter_username": "JamesDwelsJOrg",
"facebook_username": "JamesDwelsJOrg",
"instagram_username": "JamesDwelsJOrg",
"addresses": [
{
"address_status": "Current",
"country": "United States",
"address_type": "Physical",
"address_line1": "1290 New Lane Highlane",
"address_line2": "wales street",
"city": "Austin",
"county": "Travis",
"state": "TX",
"pincode": "73301-0001",
"payment_type": "Rent",
"rent_per_month": 1000,
"start_date": "2024-02-19",
"end_date": "",
"is_preferred_address": 1,
"landlord_company_name": "Austin Org",
"landlord_name": "Austins",
"landlord_address_line_1": "1291 New Lane Highlane",
"landlord_city": "Austin",
"landlord_county": "Travis",
"landlord_state": "TX",
"landlord_zip": "73301-0001",
"landlord_phone": "2140211001",
"landlord_country": "United States"
},
{
"address_status": "Previous",
"country": "United States",
"address_type": "Physical",
"address_line1": "1291 New Lane Highlane",
"city": "Austin",
"county": "Travis",
"state": "TX",
"pincode": "73301-0001",
"payment_type": "Rent",
"rent_per_month": 1000,
"start_date": "2022-02-19",
"end_date": "2024-02-19",
"is_preferred_address": 1,
"landlord_company_name": "Austin Org",
"landlord_name": "Austins",
"landlord_address_line_1": "1291 New Lane Highlane",
"landlord_city": "Austin",
"landlord_county": "Travis",
"landlord_state": "TX",
"landlord_zip": "73301-0001",
"landlord_phone": "2140211002",
"landlord_country": "United States"
},
{
"address_status": "Previous",
"country": "United States",
"address_type": "Physical",
"address_line1": "1292 New Lane Highlane",
"city": "Austin",
"county": "Travis",
"state": "TX",
"pincode": "73301-0001",
"payment_type": "Rent",
"rent_per_month": 1000,
"start_date": "2022-02-19",
"end_date": "2024-02-19",
"is_preferred_address": 1,
"landlord_company_name": "Austin Org",
"landlord_name": "Austins",
"landlord_address_line_1": "1291 New Lane Highlane",
"landlord_city": "Austin",
"landlord_county": "Travis",
"landlord_state": "TX",
"landlord_zip": "73301-0001",
"landlord_phone": "2140211004",
"landlord_country": "United States"
}
],
"relationships": [
{
"role": "Care Taker",
"relationship": "Friend",
"title": "Mr",
"party_name": "Brook A Berlin",
"years_known": 2,
"months_known": 9
},
{
"role": "Decision Maker",
"relationship": "Neighbour",
"title": "Mr",
"party_name": "Brook B Berlin",
"years_known": 1,
"months_known": 2
}
],
"contact": {
"first_name": "James",
"middle_name": "Dwels",
"last_name": "SwisB",
"salutation": "Mr",
"suffix": "Sr.",
"preferred_pronoun": "Custom",
"pronoun": "Them",
"date_of_birth": "1970-10-30",
//Identity
"ssn": "111920242",
"ssn_last_digits": "0242",
"active_service_member": "Yes",
"is_smoker": 1,
"dl_number": "TXDL20242",
//Driver License Information
"dl_state": "TX-Texas",
"dl_issue_date": "1990-10-30",
"dl_expiration_date": "2000-10-30",
//contact preferences
"preferred_time": "21:31:41",
"preferred_language": "en",
"do_not_call": 1,
"do_not_text": 1,
"do_not_email": 1,
"preferred_communication": "Email",
"no_marketing": 1,
"do_not_mail": 1,
"no_mass_mail": 1,
"alternate_identity_information": [
{
"govt_id_type": "US passport or passport card",
"govt_id_no": "1118202401",
"country": "United States",
"state": "Texas",
"issue_date": "2024-11-01",
"expiry_date": "2035-11-01"
},
{
"govt_id_type": "Permanent Resident Card",
"govt_id_no": "1118202402",
"country": "United States",
"state": "Texas",
"issue_date": "2024-11-01",
"expiry_date": "2036-11-01"
}
],
"phone_nos": [
{
"phone": "2140211009",
"is_primary_phone": 1,
"is_primary_mobile_no": 1,
"do_not_call": 1,
"do_not_text": 0,
"is_priority": 1,
"type": "Phone"
},
{
"phone": "2140211008",
"is_primary_phone": 1,
"is_primary_mobile_no": 0,
"do_not_call": 1,
"do_not_text": 1,
"is_priority": 0,
"type": "Other"
}
],
"email_ids": [
{
"email_id": "[email protected]",
"is_primary": 1
},
{
"email_id": "[email protected]",
"is_primary": 0
}
]
},
"note": "Customer is looking for a new car and need a loan "
},
"co_buyer_1": {
"customer_name": "James Swis B Org",
"customer_type": "Company",
"customer_group": "Commercial",
"territory": "United States",
"market_segment": "Upper Income",
"fed_id": "111920244",
"website": "www.JamesDwels.com",
"no_of_employees": "1-10",
"annual_revenue": 10000,
"industry": "Automotive",
"linkedin_username": "JamesDwelsWOrg",
"twitter_username": "JamesDwelsWOrg",
"facebook_username": "JamesDwelsWOrg",
"instagram_username": "JamesDwelsWOrg",
"business_phone_nos": [
{
"phone": "2412026001",
"is_primary_phone": 1,
"is_primary_mobile_no": 1,
"is_priority": 1,
"type": "Business 1"
},
{
"phone": "+919912099143",
"is_primary_phone": 1,
"is_primary_mobile_no": 1,
"is_priority": 0,
"type": "Business 2"
}
],
"addresses": [
{
"address_status": "Current",
"country": "United States",
"address_type": "Physical",
"address_line1": "1290 New Lane Highlane",
"city": "Austin",
"county": "Travis",
"state": "TX",
"pincode": "73301-0001",
"payment_type": "Rent",
"rent_per_month": 1000,
"start_date": "2022-02-19",
"end_date": "",
"is_preferred_address": 1,
"landlord_company_name": "Austin Org",
"landlord_name": "Austins",
"landlord_address_line_1": "1291 New Lane Highlane",
"landlord_city": "Austin",
"landlord_county": "Travis",
"landlord_state": "TX",
"landlord_zip": "73301-0001",
"landlord_phone": "11290129011",
"landlord_country": "United States"
},
{
"address_status": "Previous",
"country": "United States",
"address_type": "Physical",
"address_line1": "1291 New Lane Highlane",
"city": "Austin",
"county": "Travis",
"state": "TX",
"pincode": "73301-0001",
"payment_type": "Rent",
"rent_per_month": 1000,
"start_date": "2022-02-19",
"end_date": "2024-02-19",
"is_preferred_address": 1,
"landlord_company_name": "Austin Org",
"landlord_name": "Austins",
"landlord_address_line_1": "1291 New Lane Highlane",
"landlord_city": "Austin",
"landlord_county": "Travis",
"landlord_state": "TX",
"landlord_zip": "73301-0001",
"landlord_phone": "11290129011",
"landlord_country": "United States"
},
{
"address_status": "Previous",
"country": "United States",
"address_type": "Physical",
"address_line1": "1292 New Lane Highlane",
"city": "Austin",
"county": "Travis",
"state": "TX",
"pincode": "73301-0001",
"payment_type": "Rent",
"rent_per_month": 1000,
"start_date": "2022-02-19",
"end_date": "2024-02-19",
"is_preferred_address": 1,
"landlord_company_name": "Austin Org",
"landlord_name": "Austins",
"landlord_address_line_1": "1291 New Lane Highlane",
"landlord_city": "Austin",
"landlord_county": "Travis",
"landlord_state": "TX",
"landlord_zip": "73301-0001",
"landlord_phone": "11290129011",
"landlord_country": "United States"
}
],
"relationships": [
{
"role": "Care Taker",
"relationship": "Friend",
"title": "Mr",
"party_name": "Brook A Berlin",
"years_known": 2,
"months_known": 9
},
{
"role": "Decision Maker",
"relationship": "Neighbour",
"title": "Mr",
"party_name": "Brook B Berlin",
"years_known": 1,
"months_known": 2
}
],
"contact": {
"first_name": "James",
"middle_name": "Swis B",
"last_name": "Org",
"salutation": "Mr",
"suffix": "Sr.",
"preferred_pronoun": "Custom",
"pronoun": "Them",
"date_of_birth": "1970-10-30",
//Identity
"ssn": "111920242",
"ssn_last_digits": "0242",
"active_service_member": "Yes",
"is_smoker": 1,
"dl_number": "TXDL20242",
//Driver License Information
"dl_state": "TX-Texas",
"dl_issue_date": "1990-10-30",
"dl_expiration_date": "2000-10-30",
//contact preferences
"preferred_time": "10:31:41",
"preferred_language": "en",
"do_not_call": 1,
"do_not_text": 1,
"do_not_email": 1,
"preferred_communication": "Email",
"no_marketing": 1,
"do_not_mail": 1,
"no_mass_mail": 1,
"alternate_identity_information": [
{
"govt_id_type": "US passport or passport card",
"govt_id_no": "1118202401",
"country": "United States",
"state": "Texas",
"issue_date": "2024-11-01",
"expiry_date": "2035-11-01"
},
{
"govt_id_type": "Permanent Resident Card",
"govt_id_no": "1118202402",
"country": "United States",
"state": "Texas",
"issue_date": "2024-11-01",
"expiry_date": "2036-11-01"
}
],
"phone_nos": [
{
"phone": "+919912099141",
"is_primary_phone": 1,
"is_primary_mobile_no": 1,
"do_not_call": 1,
"do_not_text": 0,
"is_priority": 1,
"type": "Phone"
},
{
"phone": "+919912099142",
"is_primary_phone": 1,
"is_primary_mobile_no": 0,
"do_not_call": 1,
"do_not_text": 1,
"is_priority": 0,
"type": "Other"
}
],
"email_ids": [
{
"email_id": "[email protected]",
"is_primary": 1
},
{
"email_id": "[email protected]",
"is_primary": 0
}
]
},
"note": "Customer is looking for a new car and need a loan "
},
"co_buyer_2": "James Dwels A Org",
"co_signer": "James Dwels D Org",
"non_applicant_spouse": "James Dwels E Org",
"vehicle_item": {
"vin": "1N6AD0ER0EN788169",
"odometer_reading": "1500",
"odometer_reading_type": "Actual",
"odometer_reading_date": "2026-04-20"
},
//Sales and Contract Details - Original Sale Details
"sale_date": "2026-01-15",
"sale_price": 10000,
"discount": 100,
"accessories": 250,
"net_trade": 1000,
"back_adds": 300.00,
"cash_down": 150,
"deferred_down_amount": 200.00,
"rebate": 250.00,
"finance_charge": 472.67,
//Sales and Contract Details - Payment Calculation and Payment Schedule
"interest_start_date": "2026-01-25",
"first_payment_due": "2026-02-15",
"days_until_1st_payment": 31,
"rate": 9,
"post_maturity_rate": 9,
"effective_apr": 9.262,
"regz_apr": 9.262,
"frequency": "Monthly",
"regular_payment_amount": 1000,
"term": 11,
"contract": "Retail Installment Contract - TX Advanced",
"payment_streams": [
{
"term": 10,
"payment": 1000.00,
"start_date": "2026-02-15",
"end_date": "2026-11-15"
},
{
"term": 1,
"payment": 755.42,
"start_date": "2026-02-14",
"end_date": "2026-02-14"
}
],
"fee_detail": [
{
"name1": "Registration Fee",
"amount": 64.75,
"type": "Financed"
},
{
"idx": 2,
"name1": "CPI",
"amount": 90,
"type": "Paid Outside Of Closing"
},
{
"idx": 3,
"name1": "Convenience Fee",
"amount": 18,
"type": "Financed"
},
{
"idx": 5,
"name1": "Doc Fee",
"amount": 150,
"type": "Financed"
},
{
"docstatus": 0,
"idx": 6,
"name1": "Motor Vehicle Inspection Fee",
"amount": 50,
"type": "Financed"
}
],
"taxes": [
{
"tax_item": "TX-State Tax",
"county": "TX-Andrews County",
"rate": 6.25,
"amount": 625,
"supplier": "Texas Auto Auction"
},
{
"tax_item": "TX-Vehicle Inventory Tax",
"rate": 0.25,
"amount": 25,
"supplier": null
}
],
"loan_account_products": [
{
"type": "Service Contract",
"supplier": "Tenneco",
"product": "36 Months 10000 miles",
"price": 100,
"term_months": 10,
"deductible": 9999,
"disappearing_deductible": 100,
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Provider",
"in_service_date": "2026-01-15",
"expiry_date": null,
"contract_number": "ContractProduct#1",
"contract_type": "Payable to 3rd Party",
"mileage": "100",
"max_mileage": "200",
"description": "Payable to 3rd Party"
},
{
"idx": 2,
"type": "Service Contract",
"supplier": "Tenneco",
"product": "36 Months 10000 Mile",
"price": 200,
"term_months": 10,
"deductible": 20000,
"disappearing_deductible": 200,
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Lender",
"in_service_date": "2026-01-15",
"expiry_date": null,
"contract_number": "ContractProduct#2",
"contract_type": "Commission Only",
"mileage": "200",
"max_mileage": "400",
"description": "Commission Only"
}
],
"insurance_products": [
{
"idx": 1,
"supplier": "Allstate",
"insurance_product": "A&H",
"policy_number": "INSPOLICY#1",
"premium": 100,
"funded_by_company": 1,
"cost": 1000,
"commission": 50,
"expiration_date": "2027-02-01",
"a_and_h_schedule": "Retro 14",
"term_months": 30,
"alt_schedule_number": "",
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Provider",
"buyer": 1,
"co_buyer_2": 1,
"co_buyer_1": 1,
"co_signer": 1
},
{
"idx": 2,
"supplier": "Ensurace",
"insurance_product": "GAP Waiver",
"policy_number": "INSPOLICY#2",
"premium": 100,
"funded_by_company": 1,
"cost": 1000,
"commission": 50,
"expiration_date": "2027-02-01",
"a_and_h_schedule": "None",
"term_months": 15,
"alt_schedule_number": "",
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Dealer",
"buyer": 1,
"co_buyer_2": 1,
"co_buyer_1": 1,
"co_signer": 1
}
],
"recourse": "With Recourse",
"arbitration": "Yes",
"current_total_balance": 0,
"current_earned_interest_balance": 0,
"current_principal_balance": 12364.61,
"origination_fee": 125,
"incentive_amount": 125,
"incentive_expense_account": "7430 - Cost of Customer Good Will - ERFC",
"current_customer_owed_deferred_sales_tax_balance": 0,
"current_total_past_due_amount": 0,
"code": "LF_ORG_Discount %",
"discount_structure": "Percentage",
"new_discount_percentage": 15,
"discount_amount": null,
"old_discount_percentage": 0,
"add_insurance_details": 1,
"insurance_details": {
"insurance_company": "Texan Insurance",
"policy_number": "112248799000",
"insurance_status": "Active",
"insurance_agent": "Oliver",
"is_cpi_provider": 1,
"effective_date": "2024-09-01",
"cancel_date": "2029-12-31",
"collision_deductible_amount": 30,
"comprehensive_deductible_amount": 35,
"fire": 1,
"theft": 1,
"address_line_1": "1291 1/2 Adams St",
"address_line_2": "New wales St",
"city": "Wabash",
"county": "Wabash",
"insurance_state": "IN",
"zip": "46992-3409",
"agent_phone_number": "+918088919041",
"agent_extension": "112",
"insurance_company_phone": "1773450989",
"insurance_company_extension": "129"
}
},
"loan_onboarding_id": null,
"is_draft": true
}Response structure
Core Identifiers & Metadata
name– System-generated unique identifier of the Loan Onboarding record.owner– Email ID of the user who created the Loan Onboarding record.creation– Timestamp when the Loan Onboarding record was created.modified– Timestamp of the most recent update to the record.modified_by– Email ID of the user who last modified the record.docstatus– Document status (0= Draft,1= Submitted).idx– Internal index used for ordering.naming_series– Naming series used to generate the Loan Onboarding ID.
Loan Configuration & Classification
is_legacy_loan_onboarding– Indicates whether the record was migrated from a legacy system.is_direct_lending– Specifies whether the loan follows a direct lending model.loan_type– Type of loan contract used for onboarding.creation_method– Method through which the loan onboarding was initiated.is_collateralized– Indicates whether the loan is backed by collateral.company– Finance company under which the loan is onboarded.company_branch– Branch of the finance company handling the loan.portfolio– Loan portfolio to which this loan belongs.loan_product– Loan product applied to the onboarding.supplier– Supplier or seller associated with the loan.program– Lending program under which the loan is issued.securitization– Securitization scheme applicable to the loan.risk_rating– Credit risk rating assigned to the loan.lending_account– Linked lending account reference, if created.metro_2_account_number– Metro 2 reporting account number.alternate_account– Alternate internal account reference.credit_to– Accounting ledger account credited during onboarding.
Buyer & Party Information
buyer– Primary buyer customer ID.buyer_name– Full name of the primary buyer.buyer_mobile_no– Mobile number of the buyer.buyer_email_id– Email address of the buyer.buyer_primary_address– Primary residential address of the buyer.co_buyer_1– First co-buyer customer ID.co_buyer_one_name– Name of the first co-buyer.co_buyer_one_mobile_no– Mobile number of the first co-buyer.co_buyer_one_email_id– Email address of the first co-buyer.co_buyer_one_primary_address– Address of the first co-buyer.co_buyer_2– Second co-buyer identifier.co_buyer_two_name– Name of the second co-buyer.co_buyer_two_mobile_no– Mobile number of the second co-buyer.co_buyer_two_email_id– Email address of the second co-buyer.co_signer– Co-signer customer reference.co_signer_name– Name of the co-signer.non_applicant_spouse– Non-applicant spouse reference.non_applicant_spouse_name– Name of the non-applicant spouse.
Sale & Financial Breakdown
sale_date– Date on which the sale occurred.sale_price– Base sale price of the vehicle.discount– Discount applied to the sale price.accessories– Cost of accessories added to the sale.rebate– Manufacturer or dealer rebate applied.cash_down– Cash down payment amount.deferred_down_amount– Deferred portion of the down payment.net_trade– Net value of trade-in vehicles.gross_sale– Gross sale amount before financing.fees– Total fees applied to the loan.other_taxes– Total of non-deferred taxes.doc_stamps– Documentation stamp charges.amount_financed– Total amount financed under the loan.interest_bearing_amount– Principal amount on which interest is calculated.finance_charge– Total finance charges applied.total_of_payments– Total amount payable over the loan term.back_adds– Additional financed items added to the loan.
Loan Terms & Interest
rate– Nominal interest rate for the loan.effective_apr– Effective annual percentage rate.regz_apr– Regulation Z compliant APR.term– Loan tenure in months.frequency– Payment frequency (e.g., Monthly).interest_start_date– Date from which interest calculation begins.regular_payment_amount– Standard installment payment amount.first_payment_due– Due date of the first payment.days_until_1st_payment– Days between sale and first payment.post_maturity_rate– Interest rate applied after maturity.interest_method– Method used to calculate interest.calculate_pay_off_using– Method used to compute payoff amount.time_counting_method– Time counting basis for interest accrual.days_in_year– Day count convention used for interest.
Fees, Penalties & Compliance
charge_late_fees– Indicates whether late fees are applicable.late_fee_method– Method used to calculate late fees.late_fee_percent– Percentage used for late fee calculation.late_fee_minimum_amount– Minimum late fee amount.late_fee_maximum_amount– Maximum late fee amount.late_fee_flat_amount– Flat late fee amount, if applicable.default_bad_check_fee– Fee charged for returned or bad checks.recourse– Indicates whether the loan is with or without recourse.arbitration– Specifies whether arbitration applies.
Insurance Details
add_insurance_details– Indicates whether insurance details are included.insurance_company– Name of the insurance provider.policy_number– Insurance policy number.insurance_status– Current status of the insurance policy.insurance_agent– Insurance agent handling the policy.effective_date– Insurance coverage start date.cancel_date– Insurance coverage end date.collision_deductible_amount– Deductible amount for collision coverage.comprehensive_deductible_amount– Deductible amount for comprehensive coverage.
Child Tables
insurance_products– List of insurance products linked to the loan.taxes– Itemized tax details applied to the loan.payment_streams– Payment schedule breakdown across the loan term.fee_detail– Detailed list of individual fees applied.loan_account_products– Additional products or service contracts financed.collateral– Assets pledged as collateral for the loan.amortisation– Amortization schedule entries (if generated).deferred_down– Deferred down payment breakdown, if applicable.
Example response
{
"message": {
"name": "LO-02369",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 0,
"naming_series": "LO-",
"is_legacy_loan_onboarding": 0,
"is_direct_lending": 0,
"loan_type": "Retail Installment Contract",
"creation_method": "Book a New Loan Account",
"is_collateralized": 1,
"company": "Emotive Related Finance Company",
"company_branch": "Emotive Finance Company - 01",
"portfolio": "Car Loan Portfolio CL",
"loan_product": "Loan Onboard ERFC",
"supplier": "Emotive Finance Company",
"payoff_amount": 0.0,
"disbursement_status": "",
"program": "Secured Auto Loans",
"securitization": "Securitization for Good Loans",
"metro_2_account_number": "ACC042101",
"alternate_account": "PRCHLOAN",
"risk_rating": "A",
"lending_account": "",
"credit_to": "2167 - AP Due to Loan Seller - ERFC",
"buyer": "2026-00045",
"buyer_mobile_no": "2140211009",
"buyer_name": "Mr James Dwels SwisB Sr.",
"buyer_email_id": "[email protected]",
"buyer_primary_address": "1290 New Lane Highlane<br>\nwales street<br>Austin, TX 73301-0001<br>",
"co_buyer_1": "2026-00046",
"co_buyer_one_mobile_no": "919912099141",
"co_buyer_one_primary_address": "1290 New Lane Highlane<br>\nAustin, TX 73301-0001<br>",
"co_buyer_one_name": "James Swis B Org",
"co_buyer_one_email_id": "[email protected]",
"co_buyer_2": "James Dwels A Org",
"co_buyer_two_mobile_no": "5055368077",
"co_buyer_two_name": "James Dwels A Org",
"co_buyer_two_email_id": "[email protected]",
"co_signer": "James Dwels D Org",
"co_signer_name": "James Dwels D Org",
"non_applicant_spouse": "James Dwels E Org",
"non_applicant_spouse_name": "James Dwels E Org",
"sale_date": "2026-01-15",
"sale_price": 10000.0,
"discount": 100.0,
"accessories": 250.0,
"pre_paid_finance": 0.0,
"finance_charge_fees": 0.0,
"amount_financed": 10282.75,
"finance_charge": 472.67,
"net_trade": 1000.0,
"gross_sale": 10882.75,
"total_of_payments": 10755.42,
"back_adds": 300.0,
"fees": 282.75,
"doc_stamps": 0.0,
"deferred_taxes": 0.0,
"other_taxes": 650.0,
"cash_down": 150.0,
"deferred_down_amount": 200.0,
"rebate": 250.0,
"interest_bearing_amount": 10282.75,
"days_until_1st_payment": 31,
"first_payment_due": "2026-02-15",
"days_until_2nd_payment": 0,
"create_deferred_balance": 0,
"rate": 9.0,
"effective_apr": 9.262,
"frequency": "Monthly",
"interest_start_date": "2026-01-25",
"regular_payment_amount": 1000.0,
"regz_apr": 9.262,
"post_maturity_rate": 9.0,
"term": 11,
"contract": "Retail Installment Contract - TX Advanced",
"contract_class": "TX-Texas - Tax Advanced - Simple US",
"tax_deferred": 0,
"charge_late_fees": 1,
"charge_late_fees_only_on_unpaid_portion": 0,
"state": "TX-Texas",
"default_bad_check_fee": 30.0,
"late_fee_apply_days": 1,
"late_fee_notice_days": 1,
"late_fee_method": "Percent",
"late_fee_percent": 10.0,
"late_fee_minimum_amount": 1.0,
"late_fee_maximum_amount": 100.0,
"late_fee_flat_amount": 0.0,
"interest_method": "Simple US Rule",
"calculate_pay_off_using": "Simple Interest",
"time_counting_method": "Per Diem",
"days_in_year": "Days 365",
"recourse": "With Recourse",
"arbitration": "Yes",
"current_total_balance": 0.0,
"current_earned_interest_balance": 0.0,
"current_principal_balance": 12364.61,
"current_customer_owed_deferred_sales_tax_balance": 0.0,
"current_total_past_due_amount": 0.0,
"code": "LF_ORG_Discount %",
"discount_structure": "Percentage",
"new_discount_percentage": 15.0,
"discount_amount": 1542.41,
"old_discount_percentage": 0.0,
"add_insurance_details": 1,
"insurance_company": "Texan Insurance",
"policy_number": "112248799000",
"insurance_status": "Active",
"insurance_agent": "Oliver",
"is_cpi_provider": 1,
"effective_date": "2024-09-01",
"cancel_date": "2029-12-31",
"collision_deductible_amount": 30.0,
"comprehensive_deductible_amount": 35.0,
"fire": 1,
"theft": 1,
"collision": 0,
"comprehensive": 0,
"collision_term": 0,
"comprehensive_term": 0,
"fire_term": 0,
"fire_deductible_amount": 0.0,
"theft_term": 0,
"theft_deductible_amount": 0.0,
"address_line_1": "1291 1/2 Adams St",
"address_line_2": "New wales St",
"city": "Wabash",
"county": "Wabash",
"insurance_state": "IN",
"zip": "46992-3409",
"country": "United States",
"agent_phone_number": "+918088919041",
"agent_extension": "112",
"insurance_company_phone": "1773450989",
"insurance_company_extension": "129",
"origination_fee": 125.0,
"incentive_amount": 125.0,
"loan_cancellation_fee": 0.0,
"origination_fee_income_account": "4220 - Fees Income (NSF, Extsn, Other) - ERFC",
"incentive_expense_account": "7430 - Cost of Customer Good Will - ERFC",
"loan_cancellation_fee_account": "",
"supplier_paid_status": "Unpaid",
"supplier_due_amount": 8640.34,
"outstanding_amount": 0.0,
"collect_fee_on_cancellation": 0,
"doctype": "Loan Onboarding",
"amortisation": [],
"insurance_products": [
{
"name": "3hpc40g52s",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 1,
"supplier": "Allstate",
"insurance_product": "A&H",
"policy_number": "INSPOLICY#1",
"premium": 100.0,
"funded_by_company": 1,
"income_account": "4140 - Credit Life - AD&D - A&H - IUI Sales - ERFC",
"cost": 1000.0,
"expense_account": "5140 - Cost of Sales - Credit Life - AD&D - A&H - IUI - ERFC",
"commission": 50.0,
"commission_account": "1505 - Prepaid Expenses - ERFC",
"expiration_date": "2027-02-01",
"a_and_h_schedule": "Retro 14",
"term_months": 30,
"alt_schedule_number": "",
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Provider",
"property_coverage": "No Property",
"max_coverage": 0.0,
"buyer": 1,
"co_buyer_2": 1,
"co_buyer_1": 1,
"co_signer": 1,
"parent": "LO-02369",
"parentfield": "insurance_products",
"parenttype": "Loan Onboarding",
"doctype": "Lending Account Insurance Products",
"__unsaved": 1
},
{
"name": "3hpc1hfpi2",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 2,
"supplier": "Ensurace",
"insurance_product": "GAP Waiver",
"policy_number": "INSPOLICY#2",
"premium": 100.0,
"funded_by_company": 1,
"income_account": "4135 - GAP Insurance Sales - ERFC",
"cost": 1000.0,
"expense_account": "5135 - Cost of Sales - Gap Insurance - ERFC",
"commission": 50.0,
"commission_account": "1505 - Prepaid Expenses - ERFC",
"expiration_date": "2027-02-01",
"a_and_h_schedule": "None",
"term_months": 15,
"alt_schedule_number": "",
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Dealer",
"property_coverage": "No Property",
"max_coverage": 0.0,
"buyer": 1,
"co_buyer_2": 1,
"co_buyer_1": 1,
"co_signer": 1,
"parent": "LO-02369",
"parentfield": "insurance_products",
"parenttype": "Loan Onboarding",
"doctype": "Lending Account Insurance Products",
"__unsaved": 1
}
],
"taxes": [
{
"name": "3hpck951jk",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 1,
"tax_item": "TX-State Tax",
"county": "",
"rate": 6.25,
"amount": 625.0,
"supplier": "Texas Auto Auction",
"is_vit": 0,
"form_id": "56",
"tax_formula": "[\n {\n \"Form ID\": 1,\n \"Tax Item\": \"TIC-1-Sale Price-0072\"\n },\n {\n \"Form ID\": 10015,\n \"Tax Item\": \"TIC-10015-Trade In 1 Amount-0013\"\n },\n {\n \"Form ID\": 10021,\n \"Tax Item\": \"TIC-10021-Trade In 2 Amount-0009\"\n },\n {\n \"Form ID\": 10012,\n \"Tax Item\": \"TIC-10012-Manufacturer Rebate-0014\"\n },\n {\n \"Form ID\": 10001,\n \"Tax Item\": \"TIC-10001-Additions-0021\"\n },\n {\n \"Form ID\": 10016,\n \"Tax Item\": \"TIC-10016-Taxes Paid to Another State-0012\"\n }\n]",
"from_tax_package": 0,
"edited": 0,
"parent": "LO-02369",
"parentfield": "taxes",
"parenttype": "Loan Onboarding",
"doctype": "Taxes",
"__unsaved": 1
},
{
"name": "3hpctpddut",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 2,
"tax_item": "TX-Vehicle Inventory Tax",
"county": "",
"rate": 0.25,
"amount": 25.0,
"supplier": "",
"is_vit": 1,
"form_id": "200",
"tax_formula": "[\n {\n \"Form ID\": 1,\n \"Tax Item\": \"TIC-1-Sale Price-0072\"\n }\n]",
"from_tax_package": 0,
"edited": 0,
"parent": "LO-02369",
"parentfield": "taxes",
"parenttype": "Loan Onboarding",
"doctype": "Taxes",
"__unsaved": 1
}
],
"payment_streams": [
{
"name": "3hpch4bhlt",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 1,
"term": 10,
"payment": 1000.0,
"start_date": "2026-02-15",
"end_date": "2026-11-15",
"rate": 0.0,
"parent": "LO-02369",
"parentfield": "payment_streams",
"parenttype": "Loan Onboarding",
"doctype": "Payment_Streams",
"__unsaved": 1
},
{
"name": "3hpc4rons9",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 2,
"term": 1,
"payment": 755.42,
"start_date": "2026-02-14",
"end_date": "2026-02-14",
"rate": 0.0,
"parent": "LO-02369",
"parentfield": "payment_streams",
"parenttype": "Loan Onboarding",
"doctype": "Payment_Streams",
"__unsaved": 1
}
],
"fee_detail": [
{
"name": "3hpc5du61m",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 1,
"name1": "Registration Fee",
"amount": 64.75,
"type": "Financed",
"fee_type": "Registration Fee",
"fee_category": "Registration",
"form_id": 46,
"tax_index": 0,
"from_fee_package": 0,
"edited": 0,
"parent": "LO-02369",
"parentfield": "fee_detail",
"parenttype": "Loan Onboarding",
"doctype": "Fee Detail",
"__unsaved": 1
},
{
"name": "3hpclrd275",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 2,
"name1": "CPI",
"amount": 90.0,
"type": "Paid Outside Of Closing",
"fee_type": "Registration Fee",
"fee_category": "Regular",
"supplier": "",
"form_id": 0,
"tax_index": 0,
"from_fee_package": 0,
"edited": 0,
"parent": "LO-02369",
"parentfield": "fee_detail",
"parenttype": "Loan Onboarding",
"doctype": "Fee Detail",
"__unsaved": 1
},
{
"name": "3hpcmk5dcp",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 3,
"name1": "Convenience Fee",
"amount": 18.0,
"type": "Financed",
"fee_type": "Dealer Fee",
"fee_category": "Regular",
"form_id": 1023,
"tax_index": 0,
"from_fee_package": 0,
"edited": 0,
"parent": "LO-02369",
"parentfield": "fee_detail",
"parenttype": "Loan Onboarding",
"doctype": "Fee Detail",
"__unsaved": 1
},
{
"name": "3hpcblqsh4",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 5,
"name1": "Doc Fee",
"amount": 150.0,
"type": "Financed",
"fee_type": "Dealer Fee",
"fee_category": "Regular",
"form_id": 1001,
"tax_index": 0,
"from_fee_package": 0,
"edited": 0,
"parent": "LO-02369",
"parentfield": "fee_detail",
"parenttype": "Loan Onboarding",
"doctype": "Fee Detail",
"__unsaved": 1
},
{
"name": "3hpcvdedob",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 6,
"name1": "Motor Vehicle Inspection Fee",
"amount": 50.0,
"type": "Financed",
"fee_type": "Dealer Fee",
"fee_category": "Regular",
"form_id": 1087,
"tax_index": 0,
"from_fee_package": 0,
"edited": 0,
"parent": "LO-02369",
"parentfield": "fee_detail",
"parenttype": "Loan Onboarding",
"doctype": "Fee Detail",
"__unsaved": 1
}
],
"loan_account_products": [
{
"name": "3hpc1cc2ig",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 1,
"type": "Service Contract",
"supplier": "Tenneco",
"product": "36 Months 10000 miles",
"price": 100.0,
"term_months": 10,
"deductible": 9999.0,
"disappearing_deductible": 100.0,
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Provider",
"in_service_date": "2026-01-15",
"contract_number": "ContractProduct#1",
"contract_type": "Payable to 3rd Party",
"mileage": "100",
"max_mileage": "200",
"description": "Payable to 3rd Party",
"parent": "LO-02369",
"parentfield": "loan_account_products",
"parenttype": "Loan Onboarding",
"doctype": "Loan Account Products",
"__unsaved": 1
},
{
"name": "3hpcfust4l",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 2,
"type": "Service Contract",
"supplier": "Tenneco",
"product": "36 Months 10000 Mile",
"price": 200.0,
"term_months": 10,
"deductible": 20000.0,
"disappearing_deductible": 200.0,
"refundable": 1,
"refund_method": "Pro Rata",
"refunded_by": "Lender",
"in_service_date": "2026-01-15",
"contract_number": "ContractProduct#2",
"contract_type": "Commission Only",
"mileage": "200",
"max_mileage": "400",
"description": "Commission Only",
"parent": "LO-02369",
"parentfield": "loan_account_products",
"parenttype": "Loan Onboarding",
"doctype": "Loan Account Products",
"__unsaved": 1
}
],
"collateral": [
{
"name": "3hu6g532kh",
"owner": "[email protected]",
"creation": "2026-01-24 08:15:06.842881",
"modified": "2026-01-24 08:15:22.219611",
"modified_by": "[email protected]",
"docstatus": 0,
"idx": 1,
"collateral_type": "Vehicle Item",
"collateral": "2014 Nissan Frontier-1N6AD0ER0EN788169",
"is_primary": 0,
"parent": "LO-02369",
"parentfield": "collateral",
"parenttype": "Loan Onboarding",
"doctype": "Loan Onboarding Collateral",
"__unsaved": 1
}
],
"deferred_down": []
}
}