POST crm/application

Method to submit new application

Request Information

URI Parameters

None.

Body Parameters

ERP.Api.Models.CRM.ApplicationModel

Name	Description	Type	Additional information
Id	Application ID that will be returned in responce to application submission request.	integer	None.
FriendReferenceId	Customer ID of the friend that send a reference to an applicant.	integer	None.
MainApplicant	Main applicant details	ERP.Api.Models.CRM.ApplicantModel	None.
JointApplicant	Joint applicant details	ERP.Api.Models.CRM.ApplicantModel	None.
AmountToBorrow	Amount that applicant wants to borrow	decimal number	None.
Deposit	Amount of a Deposit (not included in the amount to borrow)	decimal number	None.
Vehicle	Vehicle included in the application	ERP.Api.Models.CRM.VehicleModel	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "friendReferenceId": 1,
  "mainApplicant": {
    "foreName": "sample string 1",
    "surname": "sample string 2",
    "dateOfBirth": "2025-01-19",
    "email": "sample string 4",
    "currentAddress": {
      "flat": "sample string 1",
      "buildingNumber": "sample string 2",
      "buildingName": "sample string 3",
      "street": "sample string 4",
      "town": "sample string 5",
      "county": "sample string 6",
      "postcode": "sample string 7",
      "status": {
        "key": ""
      },
      "startDate": "2025-01-19",
      "endDate": "2025-01-19"
    },
    "previousAddresses": [
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      },
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      }
    ],
    "bankDetails": {
      "accountName": "sample string 1",
      "sortCode": "sample string 2",
      "accountNumber": "sample string 3",
      "dateOpened": "2025-01-19",
      "bankName": "sample string 4"
    },
    "id": 5
  },
  "jointApplicant": {
    "foreName": "sample string 1",
    "surname": "sample string 2",
    "dateOfBirth": "2025-01-19",
    "email": "sample string 4",
    "currentAddress": {
      "flat": "sample string 1",
      "buildingNumber": "sample string 2",
      "buildingName": "sample string 3",
      "street": "sample string 4",
      "town": "sample string 5",
      "county": "sample string 6",
      "postcode": "sample string 7",
      "status": {
        "key": ""
      },
      "startDate": "2025-01-19",
      "endDate": "2025-01-19"
    },
    "previousAddresses": [
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      },
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      }
    ],
    "bankDetails": {
      "accountName": "sample string 1",
      "sortCode": "sample string 2",
      "accountNumber": "sample string 3",
      "dateOpened": "2025-01-19",
      "bankName": "sample string 4"
    },
    "id": 5
  },
  "amountToBorrow": 2.0,
  "deposit": 3.0,
  "vehicle": {
    "make": "sample string 1",
    "model": "sample string 2",
    "id": 3
  }
}

application/xml, text/xml

Sample:

<ApplicationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CRM">
  <AmountToBorrow>2</AmountToBorrow>
  <Deposit>3</Deposit>
  <FriendReferenceId>1</FriendReferenceId>
  <Id>1</Id>
  <JointApplicant>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
    <BankDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
      <d3p1:AccountName>sample string 1</d3p1:AccountName>
      <d3p1:AccountNumber>sample string 3</d3p1:AccountNumber>
      <d3p1:BankName>sample string 4</d3p1:BankName>
      <d3p1:DateOpened>2025-01-19T00:12:30.3574104+00:00</d3p1:DateOpened>
      <d3p1:SortCode>sample string 2</d3p1:SortCode>
    </BankDetails>
    <CurrentAddress>
      <BuildingName>sample string 3</BuildingName>
      <BuildingNumber>sample string 2</BuildingNumber>
      <County>sample string 6</County>
      <EndDate>2025-01-19T00:12:30.3574104+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:30.3574104+00:00</StartDate>
      <Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
      <Street>sample string 4</Street>
      <Town>sample string 5</Town>
    </CurrentAddress>
    <DateOfBirth>2025-01-19T00:12:30.3574104+00:00</DateOfBirth>
    <Email>sample string 4</Email>
    <ForeName>sample string 1</ForeName>
    <PreviousAddresses>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3574104+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3574104+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3574104+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3574104+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
    </PreviousAddresses>
    <Surname>sample string 2</Surname>
  </JointApplicant>
  <MainApplicant>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
    <BankDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
      <d3p1:AccountName>sample string 1</d3p1:AccountName>
      <d3p1:AccountNumber>sample string 3</d3p1:AccountNumber>
      <d3p1:BankName>sample string 4</d3p1:BankName>
      <d3p1:DateOpened>2025-01-19T00:12:30.3574104+00:00</d3p1:DateOpened>
      <d3p1:SortCode>sample string 2</d3p1:SortCode>
    </BankDetails>
    <CurrentAddress>
      <BuildingName>sample string 3</BuildingName>
      <BuildingNumber>sample string 2</BuildingNumber>
      <County>sample string 6</County>
      <EndDate>2025-01-19T00:12:30.3574104+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:30.3574104+00:00</StartDate>
      <Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
      <Street>sample string 4</Street>
      <Town>sample string 5</Town>
    </CurrentAddress>
    <DateOfBirth>2025-01-19T00:12:30.3574104+00:00</DateOfBirth>
    <Email>sample string 4</Email>
    <ForeName>sample string 1</ForeName>
    <PreviousAddresses>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3574104+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3574104+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3574104+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3574104+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
    </PreviousAddresses>
    <Surname>sample string 2</Surname>
  </MainApplicant>
  <Vehicle>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">3</Id>
    <Make>sample string 1</Make>
    <Model>sample string 2</Model>
  </Vehicle>
</ApplicationModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'ERP.Api.Models.CRM.ApplicationModel'.

Response Information

Resource Description

Returns application data with ID and current status

ERP.Api.Models.CRM.ApplicationModel

Name	Description	Type	Additional information
Id	Application ID that will be returned in responce to application submission request.	integer	None.
FriendReferenceId	Customer ID of the friend that send a reference to an applicant.	integer	None.
MainApplicant	Main applicant details	ERP.Api.Models.CRM.ApplicantModel	None.
JointApplicant	Joint applicant details	ERP.Api.Models.CRM.ApplicantModel	None.
AmountToBorrow	Amount that applicant wants to borrow	decimal number	None.
Deposit	Amount of a Deposit (not included in the amount to borrow)	decimal number	None.
Vehicle	Vehicle included in the application	ERP.Api.Models.CRM.VehicleModel	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "friendReferenceId": 1,
  "mainApplicant": {
    "foreName": "sample string 1",
    "surname": "sample string 2",
    "dateOfBirth": "2025-01-19",
    "email": "sample string 4",
    "currentAddress": {
      "flat": "sample string 1",
      "buildingNumber": "sample string 2",
      "buildingName": "sample string 3",
      "street": "sample string 4",
      "town": "sample string 5",
      "county": "sample string 6",
      "postcode": "sample string 7",
      "status": {
        "key": ""
      },
      "startDate": "2025-01-19",
      "endDate": "2025-01-19"
    },
    "previousAddresses": [
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      },
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      }
    ],
    "bankDetails": {
      "accountName": "sample string 1",
      "sortCode": "sample string 2",
      "accountNumber": "sample string 3",
      "dateOpened": "2025-01-19",
      "bankName": "sample string 4"
    },
    "id": 5
  },
  "jointApplicant": {
    "foreName": "sample string 1",
    "surname": "sample string 2",
    "dateOfBirth": "2025-01-19",
    "email": "sample string 4",
    "currentAddress": {
      "flat": "sample string 1",
      "buildingNumber": "sample string 2",
      "buildingName": "sample string 3",
      "street": "sample string 4",
      "town": "sample string 5",
      "county": "sample string 6",
      "postcode": "sample string 7",
      "status": {
        "key": ""
      },
      "startDate": "2025-01-19",
      "endDate": "2025-01-19"
    },
    "previousAddresses": [
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      },
      {
        "flat": "sample string 1",
        "buildingNumber": "sample string 2",
        "buildingName": "sample string 3",
        "street": "sample string 4",
        "town": "sample string 5",
        "county": "sample string 6",
        "postcode": "sample string 7",
        "status": {
          "key": ""
        },
        "startDate": "2025-01-19",
        "endDate": "2025-01-19"
      }
    ],
    "bankDetails": {
      "accountName": "sample string 1",
      "sortCode": "sample string 2",
      "accountNumber": "sample string 3",
      "dateOpened": "2025-01-19",
      "bankName": "sample string 4"
    },
    "id": 5
  },
  "amountToBorrow": 2.0,
  "deposit": 3.0,
  "vehicle": {
    "make": "sample string 1",
    "model": "sample string 2",
    "id": 3
  }
}

application/xml, text/xml

Sample:

<ApplicationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models.CRM">
  <AmountToBorrow>2</AmountToBorrow>
  <Deposit>3</Deposit>
  <FriendReferenceId>1</FriendReferenceId>
  <Id>1</Id>
  <JointApplicant>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
    <BankDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
      <d3p1:AccountName>sample string 1</d3p1:AccountName>
      <d3p1:AccountNumber>sample string 3</d3p1:AccountNumber>
      <d3p1:BankName>sample string 4</d3p1:BankName>
      <d3p1:DateOpened>2025-01-19T00:12:30.3604052+00:00</d3p1:DateOpened>
      <d3p1:SortCode>sample string 2</d3p1:SortCode>
    </BankDetails>
    <CurrentAddress>
      <BuildingName>sample string 3</BuildingName>
      <BuildingNumber>sample string 2</BuildingNumber>
      <County>sample string 6</County>
      <EndDate>2025-01-19T00:12:30.3604052+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:30.3604052+00:00</StartDate>
      <Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
      <Street>sample string 4</Street>
      <Town>sample string 5</Town>
    </CurrentAddress>
    <DateOfBirth>2025-01-19T00:12:30.3604052+00:00</DateOfBirth>
    <Email>sample string 4</Email>
    <ForeName>sample string 1</ForeName>
    <PreviousAddresses>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3604052+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3604052+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3604052+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3604052+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
    </PreviousAddresses>
    <Surname>sample string 2</Surname>
  </JointApplicant>
  <MainApplicant>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">5</Id>
    <BankDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/ERP.Domain.CRM.Applicant">
      <d3p1:AccountName>sample string 1</d3p1:AccountName>
      <d3p1:AccountNumber>sample string 3</d3p1:AccountNumber>
      <d3p1:BankName>sample string 4</d3p1:BankName>
      <d3p1:DateOpened>2025-01-19T00:12:30.3604052+00:00</d3p1:DateOpened>
      <d3p1:SortCode>sample string 2</d3p1:SortCode>
    </BankDetails>
    <CurrentAddress>
      <BuildingName>sample string 3</BuildingName>
      <BuildingNumber>sample string 2</BuildingNumber>
      <County>sample string 6</County>
      <EndDate>2025-01-19T00:12:30.3604052+00:00</EndDate>
      <Flat>sample string 1</Flat>
      <Postcode>sample string 7</Postcode>
      <StartDate>2025-01-19T00:12:30.3604052+00:00</StartDate>
      <Status xmlns:d4p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
      <Street>sample string 4</Street>
      <Town>sample string 5</Town>
    </CurrentAddress>
    <DateOfBirth>2025-01-19T00:12:30.3604052+00:00</DateOfBirth>
    <Email>sample string 4</Email>
    <ForeName>sample string 1</ForeName>
    <PreviousAddresses>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3604052+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3604052+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
      <Address>
        <BuildingName>sample string 3</BuildingName>
        <BuildingNumber>sample string 2</BuildingNumber>
        <County>sample string 6</County>
        <EndDate>2025-01-19T00:12:30.3604052+00:00</EndDate>
        <Flat>sample string 1</Flat>
        <Postcode>sample string 7</Postcode>
        <StartDate>2025-01-19T00:12:30.3604052+00:00</StartDate>
        <Status xmlns:d5p1="http://schemas.datacontract.org/2004/07/ERP.Api.Models" />
        <Street>sample string 4</Street>
        <Town>sample string 5</Town>
      </Address>
    </PreviousAddresses>
    <Surname>sample string 2</Surname>
  </MainApplicant>
  <Vehicle>
    <Id xmlns="http://schemas.datacontract.org/2004/07/ERP.Api.Models">3</Id>
    <Make>sample string 1</Make>
    <Model>sample string 2</Model>
  </Vehicle>
</ApplicationModel>