GET - Retrieve Deal by ID

Retrieve the deal related information using the deal id.

Retrieve a Deal

Method: GET

Endpoint: /DEAL/{dealid}

Headers:

Name	Value
Content-Type	application/json
Authorization	Bearer <API TOKEN>

Fields	Possible Values
loanType	New Renewal Add On Refinance
status	Application Received In Progress Additional Info Required Approved Contracts Sent Pending Settlement Settled Withdrawn Declined
subStatus(In Progress)	Under Review Scrubbing Scrubbing Complete Submitted to Credit
subStatus(Application Received)	Banks In
subStatus(Additional Info Required)	Pending info - with customer Pending info - with ISO
subStatus(Approved)	Pending Stips Pending Presentation Offer Made With ISO
subStatus(Contracts Sent)	Sent by SS Sent by DS DS Contract Viewed No Response
subStatus(Pending Settlement)	Contract Signed Pre-Final review Final Review Final Review - Pending Info Pending Funding Call Funding Call Complete Funding Waiting Approval
subStatus(Settled)	Performing Not performing Defaulted
subStatus(Withdrawn)	Term too short Cost No longer Required Loan Amount Too Low Got another loan facility Not Ready No reason provided
subStatus(Declined)	Time in business too short Revenue too low Serviceability Credit History Bank statement conduct ATO debt Other debts Not a business High risk industry Prohibited industry Insufficient Documentation Integrity of applicants Has competitor loan
callClientOrBroker	Call Client Call Broker

Example Request (JavaScript - Fetch):

const myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer <API TOKEN>");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://bizmate.fasttask.net/api/v1/deal/{{dealid}}", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Example Request (cURL):

curl --location 'https://bizmate.fasttask.net/api/v1/deal/{{dealid}}' \
--header 'Authorization: Bearer <API TOKEN>'

Response

200

{
    "id": "id",
    "createdAt": "2024-08-08T00:20:15.867Z",
    "createdBy": "",
    "updatedAt": "2024-08-08T00:20:16.551Z",
    "updatedBy": "",
    "fields": {
        "status": "Application Received",
        "watchers": [
            {
                "type": "user",
                "id": ""
            }
        ],
        "statusSinceDate": "2024-08-08T00:20:16.000Z",
        "subStatusSinceDate": "2024-08-08T00:20:16.000Z",
        "lastActivityDate": null,
        "subStatus": "Banks In",
        "name": "Some Text",
        "customer": {
            "id": "",
            "name": "Some Text"
        },
        "callClientOrBroker": "Call Client",
        "broker": {
            "id": "",
            "name": "Test Bizcap"
        },
        "brokerRep": {
            "id": "",
            "firstName": "Test Bizcap",
            "lastName": "Partner Contact"
        },
        "loanType": null,
        "internalBdmUser": null,
        "omNumberOfPayments": null,
        "omPaybackAmount": null,
        "omTermDays": null,
        "omDeclineReasons": null,
        "omCollectionFrequency": null,
        "omPrincipalAmount": null,
        "omAdvanceID": null,
        "omDateFunded": null,
        "omAdvanceType": null,
        "amount": "123.00",
        "numberOfCallsMade": 0,
        "bankStatementsCreditsSenseLink": ",
        "bankStatementsUpdateLink": null,
        "sfid": null,
        "lastCallDate": null,
        "callOnBehalfOf": "Some Text",
        "partnerLeadReferenceId": "Some Text",
        "applicationLink": ""
    }
}

400

{
  "error": "Invalid request"
}