Request Method

• POST

End Point

{{url}}/api/method/emotive_app.api.crm.credit_app.remove_buyer

Example Request

{
    "applicant_id": "2024-CA-08-000035",
    "applicant_type": "co_buyer_1",
    "application_id": "C-2024-08-00014"
}

Response Explanation

On successful removal, the API returns an updated credit application object.

Response Body Parameters

• name (string)
  Unique identifier of the credit application.

• owner (string)
  Email ID of the user who created the credit application.

• creation (string)
  Timestamp of when the credit application was created.

• modified (string)
  Timestamp showing when the record was last modified.

• modified_by (string)
  Email ID of the user who last modified the record.

• docstatus (number)
  Document status indicator (e.g., 0 for Draft).

• idx (number)
  Index used internally for ordering (generally 0).

• workflow_state (string)
  Current state of the application's workflow (e.g., "New").

• buyer (string)
  Unique ID of the main buyer for the application.

• co_buyer_1 (string)
  Unique ID of the first co-buyer (empty if none assigned).

• naming_series (string)
  Pattern used to generate the application number.

• status (string)
  Status of the credit application (e.g., "New").

• company (string)
  Company name associated with the credit application.

• buyer_name (string)
  Name of the main buyer.

• buyer_customer_id (string)
  Customer ID of the main buyer.

• co_buyer_1_customer_id (string)
  Customer ID of the first co-buyer (empty if none assigned).

• buyer_include_in_ratio (number)
  Whether main buyer is included in the financial ratio calculation (1 = included, 0 = not included).

• co_buyer_1_include_in_ratio (number)
  Whether co-buyer 1 is included in the ratio (1 = included, 0 = not included).

• co_buyer_2_include_in_ratio (number)
  Whether co-buyer 2 is included in the ratio (1 = included, 0 = not included).

• co_signer_include_in_ratio (number)
  Whether co-signer is included in the ratio (1 = included, 0 = not included).

• doctype (string)
  Document type (for this API, always "Credit Application").

{
    "name": "C-2026-01-00004",
    "owner": "[email protected]",
    "creation": "2026-01-22 07:54:35.524850",
    "modified": "2026-01-22 22:25:18.131764",
    "modified_by": "[email protected]",
    "docstatus": 0,
    "idx": 0,
    "workflow_state": "New",
    "buyer": "2026-CA-01-000005",
    "co_buyer_1": "",
    "naming_series": "C-.YYYY.-.MM.-.#####.",
    "status": "New",
    "company": "Emotive Auto Sales Inc.",
    "buyer_name": "Austin Kumar Jr.",
    "buyer_customer_id": "2026-00028",
    "co_buyer_1_customer_id": "",
    "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"
}