Get Credit Application Details

get

http://{url}{}/api/method/emotive_app.api.crm.credit_app.get_credit_application

Endpoint Description

This endpoint retrieves the details of a specific credit application based on the provided application name. It is designed to fetch comprehensive information about the credit application, including its status, associated buyers, and other relevant data.

Request

Method: GET
URL: {{url}}/api/method/emotive_app.api.crm.credit_app.get_credit_application
Query Parameters:
- name (string, required): The unique identifier of the credit application you wish to retrieve. For example, C-2024-08-00013.

Response

The response will be a JSON object containing the following structure:

message: An object that encapsulates the details of the credit application.
- application: An object containing information about the credit application.
  - name: The name of the application.
  - owner: The owner of the application.
  - creation: The timestamp of when the application was created.
  - modified: The timestamp of the last modification.
  - modified_by: The user who last modified the application.
  - docstatus: The document status of the application (e.g., 0 for draft).
  - idx: An index number for the application.
  - buyer: The buyer associated with the application.
  - naming_series: The naming series for the application.
  - status: The current status of the application.
  - company: The company associated with the application.
  - from_opportunity: Reference to the related opportunity.
  - buyer_name: The name of the buyer.
  - buyer_include_in_ratio: Indicates if the buyer is included in the financial ratio.
  - co_buyer_1_include_in_ratio: Indicates if the first co-buyer is included in the financial ratio.
  - co_buyer_2_include_in_ratio: Indicates if the second co-buyer is included in the financial ratio.
  - co_signer_include_in_ratio: Indicates if the co-signer is included in the financial ratio.
  - doctype: The document type of the application.
- buyer: An object containing details about the buyer.
  - applicant_id: The unique identifier for the applicant.
  - customer_id: The unique identifier for the customer.
  - image: A URL or reference to the buyer's image (if available).
  - customer_type: The type of customer (e.g., individual, business).
  - primary_contact: The primary contact information for the buyer.
  - salutation: The salutation of the buyer.
  - suffix: Any suffix associated with the buyer's name.
  - first_name: The first name of the buyer.
  - middle_name: The middle name of the buyer.
  - last_name: The last name of the buyer.
  - preferred_pronoun: The preferred pronoun of the buyer.
  - pronoun: The pronoun used by the buyer.
  - email_id: The email address of the buyer.
  - linkedin_username: The LinkedIn username of the buyer.
  - facebook_username: The Facebook username of the buyer.
  - twitter_username: The Twitter username of the buyer.
  - phone: The phone number of the buyer.
  - instagram_username: The Instagram username of the buyer.
  - ssn: The social security number of the buyer.
  - ssn_last_digits: The last few digits of the social security number (if applicable).
  - phone_type: The type of phone number provided.
- co_buyer_1: Details of the first co-buyer (if applicable).
- co_buyer_2: Details of the second co-buyer (if applicable).
- co_signer: Details of the co-signer (if applicable).
- non_applicant_spouse: Details of the non-applicant spouse (if applicable).

This structure allows the client to understand the credit application and its associated parties in detail.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Request Query Parameters

name (string, required)
The unique identifier (name) of the credit application whose details you want to retrieve.
Example: C-2024-08-00013

Response Explanation

Returns a JSON object with detailed information about the specified credit application. The response contains a message object with the following nested details:

Response Body Fields

application (object)
Details about the credit application:
- name (string) — Credit application identifier.
- owner (string) — Email of the user who created the application.
- creation (string) — Timestamp when the application was created.
- modified (string) — Timestamp of the last modification.
- modified_by (string) — Email of the user who last modified the application.
- docstatus (number) — Document status (e.g., 0 for Draft).
- idx (number) — Internal index (for ordering/pagination).
- buyer (string) — Buyer applicant ID.
- naming_series (string) — Pattern for document numbering.
- status (string) — Current status (e.g., Working, Approved, New).
- company (string) — Company associated with the application.
- from_opportunity (string) — Opportunity identifier the credit application was created from.
- buyer_name (string) — Name of the main buyer.
- buyer_include_in_ratio (number) — Whether buyer is included in ratio calculations (1 = included, 0 = not included).
- co_buyer_1_include_in_ratio (number) — Whether co-buyer 1 is included in ratio.
- co_buyer_2_include_in_ratio (number) — Whether co-buyer 2 is included in ratio.
- co_signer_include_in_ratio (number) — Whether co-signer is included in ratio.
- doctype (string) — Always "Credit Application".
buyer (object)
Detailed information about the main buyer applicant:
- applicant_id (string) — Unique applicant ID for the buyer.
- customer_id (string) — Customer ID of the buyer.
- image (string/null) — Image URL or null if not present.
- customer_type (string) — Individual or Company.
- primary_contact (string) — Name of the primary contact.
- salutation (string/null) — Salutation (Mr./Ms. etc.) or null.
- suffix (string) — Suffix, if any.
- first_name (string) — Buyer’s first name.
- middle_name (string) — Buyer’s middle name.
- last_name (string) — Buyer’s last name.
- preferred_pronoun (string) — Preferred pronoun.
- pronoun (string/null) — Pronoun or null.
- email_id (string) — Email address of the buyer.
- linkedin_username (string) — LinkedIn username or empty.
- facebook_username (string) — Facebook username or empty.
- twitter_username (string) — Twitter username or empty.
- phone (string/null) — Phone number or null.
- instagram_username (string) — Instagram username or empty.
- ssn (string) — SSN or empty for security.
- ssn_last_digits (string/null) — Last digits of SSN or null.
- phone_type (string/null) — Phone type or null.
co_buyer_1 (object/null)
Detailed info about the first co-buyer if exists, otherwise null.
co_buyer_2 (object/null)
Detailed info about the second co-buyer if exists, otherwise null.
co_signer (object/null)
Detailed info about the co-signer if exists, otherwise null.
non_applicant_spouse (object/null)
Info for a non-applicant spouse if applicable, otherwise null.

Example Response

{
  "message": {
    "application": {
      "name": "C-2024-08-00013",
      "owner": "[email protected]",
      "creation": "2024-08-20 07:00:40.910804",
      "modified": "2024-08-20 07:01:12.952162",
      "modified_by": "[email protected]",
      "docstatus": 0,
      "idx": 0,
      "buyer": "2024-CA-08-000018",
      "naming_series": "C-.YYYY.-.MM. -.#####.",
      "status": "Working",
      "company": "Emotive Auto Sales Inc.",
      "from_opportunity": "CRM-OPP-2024-00040",
      "buyer_name": "Austin2 olvis",
      "buyer_include_in_ratio": 1,
      "co_buyer_1_include_in_ratio": 0,
      "co_buyer_2_include_in_ratio": 0,
      "co_signer_include_in_ratio": 0,
      "doctype": "Credit Application"
    },
    "buyer": {
      "applicant_id": "2024-CA-08-000018",
      "customer_id": "Austin olvis",
      "image": null,
      "customer_type": "Individual",
      "primary_contact": "Austin olvis",
      "salutation": null,
      "suffix": "",
      "first_name": "Austin2",
      "middle_name": "",
      "last_name": "olvis",
      "preferred_pronoun": "",
      "pronoun": null,
      "email_id": "[email protected]",
      "linkedin_username": "",
      "facebook_username": "",
      "twitter_username": "",
      "phone": null,
      "instagram_username": "",
      "ssn": "",
      "ssn_last_digits": null,
      "phone_type": null
    },
    "co_buyer_1": null,
    "co_buyer_2": null,
    "co_signer": null,
    "non_applicant_spouse": null
  }
}

Responses

Request Query Parameters

Response Explanation

Response Body Fields

Example Response

200OK

400Bad Request

403Forbidden

404Not Found

500Internal Server Error