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
  }
}