Base URL: https://{tenant-domain}/api/v2/applications |
Stage updates
Endpoint:/{applicationId}/{action}
Method: Post
Description: Moves an application to the next, previous, or reverts the current stage with comprehensive validation checks.
URL Parameters :
Parameter | Type | Required | Description | Constraints |
applicationId | integer | Yes | ID of the application to move | Must be numeric |
action | string | Yes | Action to perform | next, previous, or revert |
Payload:
{ noteAdded": true // Required when mandatory note action is set for the stage } |
Response:
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Status updates
URL Parameters :
Parameter | Type | Required | Description | Constraints |
applicationId | integer | Yes | ID of the application to update | Must be numeric |
Payload:
{ "status": "Discontinue", "next_invoice_due_date": "2024-07-01", // Optional: Date for next invoice "discontinue_reason_id":3, // Optional: ID of discontinue reason "noteAdded": true // Required when mandatory note action is set for the stage"
} |
Response:
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Date Updates
Endpoint:/{applicationId}
Method: Put
Description: Updates various date fields including start/end dates, intake dates, and invoice due dates.
URL Parameters :
Parameter | Type | Required | Description | Constraints |
applicationId | integer | Yes | ID of the application to update | Must be numeric |
Payload: For start date and end date
{ "start_date": "2024-02-01", "end_date": "2024-07-31", } |
Payload: For applied intake date
{ "applied_intake_date": "2024-09-01", } |
Payload: For expected win date
{ "expected_win_date": "2024-08-15", } |
Response:
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
Update Partner and Products Type
Endpoint:/{applicationId}/partner-update
Method: Put
Description: Updates various date fields including start/end dates, intake dates, and invoice due dates.
URL Parameters :
Parameter | Type | Required | Description | Constraints |
applicationId | integer | Yes | ID of the application to update | Must be numeric |
Payload:
{ "vendor_branch_id": 1, "partner_id": 1, "product_id": 1 } |
Response:
{ "message": "You’ve successfully updated your Partner and Product’s information." } |
HTTP Status Codes:
- 200 OK: Success
- 401 Unauthorized: Invalid or missing authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Entity not found
