Add Buyer
This endpoint allows you to add a buyer to a credit application in the system. It is typically used when you need to include additional parties involved in a credit application process.
Request
-
Method: POST
-
Endpoint:
{{url}}/api/method/emotive_app.api.crm.credit_app.add_buyer
Request Body
The request body must be sent in JSON format and should include the following parameters:
-
application_id (string): The unique identifier for the credit application to which the buyer is being added.
-
party_name (string): The name of the buyer being added.
-
role (string): The role of the buyer in the application process (e.g., "Co Buyer 1").
Example Request Body:
{
"application_id": "C-2024-08-00014",
"party_name": "Allen Dobbins",
"role": "Co Buyer 1"
}
Response
The response will provide confirmation of the buyer's addition to the specified credit application. The structure of the response typically includes:
-
status (string): Indicates whether the operation was successful or if there was an error.
-
message (string): A descriptive message providing additional context about the operation's result.
-
buyer_id (string): The unique identifier for the newly added buyer, if applicable.
Example Response:
{
"status": "success",
"message": "Buyer added successfully.",
"buyer_id": "B-2024-08-00001"
}
Ensure that the request body is correctly formatted to avoid errors and receive the expected response.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Request Method
- POST
Endpoint
{{url}}/api/method/emotive_app.api.crm.credit_app.add_buyer
Example Request
{
"application_id": "C-2024-08-00014",
"party_name": "Allen Dobbins",
"role": "Co Buyer 1"
}Response Explanation
A successful response returns HTTP status 200 and an empty JSON object.
Example Response
{} 403Forbidden
404Not Found
409Conflict
422Unprocessable Entity
500Internal Server Error
