Applications
Create an application
POST
/
v1
/
applications
Create an application
curl --request POST \
--url https://api.yorlet.com/v1/applications \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"application_configuration": "<string>",
"applicants": [
{
"share_of_rent": 50,
"customer": "<string>",
"lead_tenant": true,
"permitted_occupier": true,
"reference_data": {},
"requirements": {
"deposit": true,
"guarantor": true,
"pre_qualification": true
},
"verification_session_data": {
"types": []
}
}
],
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"accept": true,
"advance_rent_amount": 49999950,
"assignee": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"create_subscriptions": true,
"deal_assignee": "<string>",
"deposit_amount": 49999950,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"enquiry": "<string>",
"holding_fee_amount": 49999950,
"restrict_credits_to_application": true,
"metadata": {},
"move_in_date": 123,
"move_out_date": 123,
"owner_options": {
"apply_unit_fees": true,
"custom_fee_amount": 50000000
},
"renewal_intent": "<string>",
"send_email": true,
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"release_unit": true,
"update_unit_rent": true
}
'import requests
url = "https://api.yorlet.com/v1/applications"
payload = {
"application_configuration": "<string>",
"applicants": [
{
"share_of_rent": 50,
"customer": "<string>",
"lead_tenant": True,
"permitted_occupier": True,
"reference_data": {},
"requirements": {
"deposit": True,
"guarantor": True,
"pre_qualification": True
},
"verification_session_data": { "types": [] }
}
],
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": { "day_of_month": 16 },
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"accept": True,
"advance_rent_amount": 49999950,
"assignee": "<string>",
"contract_options": {
"automatic_counter_signature": True,
"legal_entity": "<string>",
"owner_signature_required": True,
"send_applicant_email": True,
"send_owner_completion_email": True
},
"contract_template": "<string>",
"create_subscriptions": True,
"deal_assignee": "<string>",
"deposit_amount": 49999950,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"enquiry": "<string>",
"holding_fee_amount": 49999950,
"restrict_credits_to_application": True,
"metadata": {},
"move_in_date": 123,
"move_out_date": 123,
"owner_options": {
"apply_unit_fees": True,
"custom_fee_amount": 50000000
},
"renewal_intent": "<string>",
"send_email": True,
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"release_unit": True,
"update_unit_rent": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
application_configuration: '<string>',
applicants: [
{
share_of_rent: 50,
customer: '<string>',
lead_tenant: true,
permitted_occupier: true,
reference_data: {},
requirements: {deposit: true, guarantor: true, pre_qualification: true},
verification_session_data: {types: []}
}
],
subscription_data: {
add_invoice_items: [
{
amount: 123,
currency: '<string>',
description: '<string>',
tax_percent: 50,
metadata: {},
price: '<string>',
tax_rate: '<string>',
transfer_destination: '<string>',
unit: '<string>'
}
],
billing_anchor: 123,
billing_anchor_config: {day_of_month: 16},
coupon: '<string>',
custom_fields: [{name: '<string>', value: '<string>'}],
days_before_collection: 3,
days_until_due: 1,
end_date: 123,
end_date_config: {day: 16, month: 6, year: 123},
interval_count: 123,
items: [
{
price_data: {amount: 123, currency: 'gbp', tax_percent: 123},
description: '<string>',
metadata: {},
price: '<string>',
schedule: [{amount: 123, effective_at: 123}],
tax_rate: '<string>',
transfer_destination: '<string>',
unit: '<string>'
}
],
phases: [
{
start_date: 123,
items: [
{
price_data: {amount: 123, currency: 'gbp', tax_percent: 123},
description: '<string>',
metadata: {},
price: '<string>',
schedule: [{amount: 123, effective_at: 123}],
tax_rate: '<string>',
transfer_destination: '<string>',
unit: '<string>'
}
]
}
],
start_date: 123,
start_date_config: {day: 16, month: 6, year: 123}
},
unit: '<string>',
accept: true,
advance_rent_amount: 49999950,
assignee: '<string>',
contract_options: {
automatic_counter_signature: true,
legal_entity: '<string>',
owner_signature_required: true,
send_applicant_email: true,
send_owner_completion_email: true
},
contract_template: '<string>',
create_subscriptions: true,
deal_assignee: '<string>',
deposit_amount: 49999950,
end_date: 123,
end_date_config: {day: 16, month: 6, year: 123},
enquiry: '<string>',
holding_fee_amount: 49999950,
restrict_credits_to_application: true,
metadata: {},
move_in_date: 123,
move_out_date: 123,
owner_options: {apply_unit_fees: true, custom_fee_amount: 50000000},
renewal_intent: '<string>',
send_email: true,
start_date: 123,
start_date_config: {day: 16, month: 6, year: 123},
release_unit: true,
update_unit_rent: true
})
};
fetch('https://api.yorlet.com/v1/applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_configuration' => '<string>',
'applicants' => [
[
'share_of_rent' => 50,
'customer' => '<string>',
'lead_tenant' => true,
'permitted_occupier' => true,
'reference_data' => [
],
'requirements' => [
'deposit' => true,
'guarantor' => true,
'pre_qualification' => true
],
'verification_session_data' => [
'types' => [
]
]
]
],
'subscription_data' => [
'add_invoice_items' => [
[
'amount' => 123,
'currency' => '<string>',
'description' => '<string>',
'tax_percent' => 50,
'metadata' => [
],
'price' => '<string>',
'tax_rate' => '<string>',
'transfer_destination' => '<string>',
'unit' => '<string>'
]
],
'billing_anchor' => 123,
'billing_anchor_config' => [
'day_of_month' => 16
],
'coupon' => '<string>',
'custom_fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'days_before_collection' => 3,
'days_until_due' => 1,
'end_date' => 123,
'end_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
],
'interval_count' => 123,
'items' => [
[
'price_data' => [
'amount' => 123,
'currency' => 'gbp',
'tax_percent' => 123
],
'description' => '<string>',
'metadata' => [
],
'price' => '<string>',
'schedule' => [
[
'amount' => 123,
'effective_at' => 123
]
],
'tax_rate' => '<string>',
'transfer_destination' => '<string>',
'unit' => '<string>'
]
],
'phases' => [
[
'start_date' => 123,
'items' => [
[
'price_data' => [
'amount' => 123,
'currency' => 'gbp',
'tax_percent' => 123
],
'description' => '<string>',
'metadata' => [
],
'price' => '<string>',
'schedule' => [
[
'amount' => 123,
'effective_at' => 123
]
],
'tax_rate' => '<string>',
'transfer_destination' => '<string>',
'unit' => '<string>'
]
]
]
],
'start_date' => 123,
'start_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
]
],
'unit' => '<string>',
'accept' => true,
'advance_rent_amount' => 49999950,
'assignee' => '<string>',
'contract_options' => [
'automatic_counter_signature' => true,
'legal_entity' => '<string>',
'owner_signature_required' => true,
'send_applicant_email' => true,
'send_owner_completion_email' => true
],
'contract_template' => '<string>',
'create_subscriptions' => true,
'deal_assignee' => '<string>',
'deposit_amount' => 49999950,
'end_date' => 123,
'end_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
],
'enquiry' => '<string>',
'holding_fee_amount' => 49999950,
'restrict_credits_to_application' => true,
'metadata' => [
],
'move_in_date' => 123,
'move_out_date' => 123,
'owner_options' => [
'apply_unit_fees' => true,
'custom_fee_amount' => 50000000
],
'renewal_intent' => '<string>',
'send_email' => true,
'start_date' => 123,
'start_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
],
'release_unit' => true,
'update_unit_rent' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/applications"
payload := strings.NewReader("{\n \"application_configuration\": \"<string>\",\n \"applicants\": [\n {\n \"share_of_rent\": 50,\n \"customer\": \"<string>\",\n \"lead_tenant\": true,\n \"permitted_occupier\": true,\n \"reference_data\": {},\n \"requirements\": {\n \"deposit\": true,\n \"guarantor\": true,\n \"pre_qualification\": true\n },\n \"verification_session_data\": {\n \"types\": []\n }\n }\n ],\n \"subscription_data\": {\n \"add_invoice_items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_percent\": 50,\n \"metadata\": {},\n \"price\": \"<string>\",\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"billing_anchor\": 123,\n \"billing_anchor_config\": {\n \"day_of_month\": 16\n },\n \"coupon\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"days_before_collection\": 3,\n \"days_until_due\": 1,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"interval_count\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"phases\": [\n {\n \"start_date\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ]\n }\n ],\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n }\n },\n \"unit\": \"<string>\",\n \"accept\": true,\n \"advance_rent_amount\": 49999950,\n \"assignee\": \"<string>\",\n \"contract_options\": {\n \"automatic_counter_signature\": true,\n \"legal_entity\": \"<string>\",\n \"owner_signature_required\": true,\n \"send_applicant_email\": true,\n \"send_owner_completion_email\": true\n },\n \"contract_template\": \"<string>\",\n \"create_subscriptions\": true,\n \"deal_assignee\": \"<string>\",\n \"deposit_amount\": 49999950,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"enquiry\": \"<string>\",\n \"holding_fee_amount\": 49999950,\n \"restrict_credits_to_application\": true,\n \"metadata\": {},\n \"move_in_date\": 123,\n \"move_out_date\": 123,\n \"owner_options\": {\n \"apply_unit_fees\": true,\n \"custom_fee_amount\": 50000000\n },\n \"renewal_intent\": \"<string>\",\n \"send_email\": true,\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"release_unit\": true,\n \"update_unit_rent\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/applications")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"application_configuration\": \"<string>\",\n \"applicants\": [\n {\n \"share_of_rent\": 50,\n \"customer\": \"<string>\",\n \"lead_tenant\": true,\n \"permitted_occupier\": true,\n \"reference_data\": {},\n \"requirements\": {\n \"deposit\": true,\n \"guarantor\": true,\n \"pre_qualification\": true\n },\n \"verification_session_data\": {\n \"types\": []\n }\n }\n ],\n \"subscription_data\": {\n \"add_invoice_items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_percent\": 50,\n \"metadata\": {},\n \"price\": \"<string>\",\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"billing_anchor\": 123,\n \"billing_anchor_config\": {\n \"day_of_month\": 16\n },\n \"coupon\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"days_before_collection\": 3,\n \"days_until_due\": 1,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"interval_count\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"phases\": [\n {\n \"start_date\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ]\n }\n ],\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n }\n },\n \"unit\": \"<string>\",\n \"accept\": true,\n \"advance_rent_amount\": 49999950,\n \"assignee\": \"<string>\",\n \"contract_options\": {\n \"automatic_counter_signature\": true,\n \"legal_entity\": \"<string>\",\n \"owner_signature_required\": true,\n \"send_applicant_email\": true,\n \"send_owner_completion_email\": true\n },\n \"contract_template\": \"<string>\",\n \"create_subscriptions\": true,\n \"deal_assignee\": \"<string>\",\n \"deposit_amount\": 49999950,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"enquiry\": \"<string>\",\n \"holding_fee_amount\": 49999950,\n \"restrict_credits_to_application\": true,\n \"metadata\": {},\n \"move_in_date\": 123,\n \"move_out_date\": 123,\n \"owner_options\": {\n \"apply_unit_fees\": true,\n \"custom_fee_amount\": 50000000\n },\n \"renewal_intent\": \"<string>\",\n \"send_email\": true,\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"release_unit\": true,\n \"update_unit_rent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/applications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_configuration\": \"<string>\",\n \"applicants\": [\n {\n \"share_of_rent\": 50,\n \"customer\": \"<string>\",\n \"lead_tenant\": true,\n \"permitted_occupier\": true,\n \"reference_data\": {},\n \"requirements\": {\n \"deposit\": true,\n \"guarantor\": true,\n \"pre_qualification\": true\n },\n \"verification_session_data\": {\n \"types\": []\n }\n }\n ],\n \"subscription_data\": {\n \"add_invoice_items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_percent\": 50,\n \"metadata\": {},\n \"price\": \"<string>\",\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"billing_anchor\": 123,\n \"billing_anchor_config\": {\n \"day_of_month\": 16\n },\n \"coupon\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"days_before_collection\": 3,\n \"days_until_due\": 1,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"interval_count\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"phases\": [\n {\n \"start_date\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ]\n }\n ],\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n }\n },\n \"unit\": \"<string>\",\n \"accept\": true,\n \"advance_rent_amount\": 49999950,\n \"assignee\": \"<string>\",\n \"contract_options\": {\n \"automatic_counter_signature\": true,\n \"legal_entity\": \"<string>\",\n \"owner_signature_required\": true,\n \"send_applicant_email\": true,\n \"send_owner_completion_email\": true\n },\n \"contract_template\": \"<string>\",\n \"create_subscriptions\": true,\n \"deal_assignee\": \"<string>\",\n \"deposit_amount\": 49999950,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"enquiry\": \"<string>\",\n \"holding_fee_amount\": 49999950,\n \"restrict_credits_to_application\": true,\n \"metadata\": {},\n \"move_in_date\": 123,\n \"move_out_date\": 123,\n \"owner_options\": {\n \"apply_unit_fees\": true,\n \"custom_fee_amount\": 50000000\n },\n \"renewal_intent\": \"<string>\",\n \"send_email\": true,\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"release_unit\": true,\n \"update_unit_rent\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "application",
"advance_rent_amount": 123,
"application_configuration": "<string>",
"application_mode": "classic",
"assignee": "<string>",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"completed_at": 123,
"contract": "<string>",
"contract_address": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"current_step": {
"id": "<string>",
"next_step": "<string>",
"type": "advance_rent"
},
"currency": "gbp",
"customers": [
{
"id": "<string>",
"email": "<string>",
"name": "<string>"
}
],
"deal_assignee": "<string>",
"deposit_amount": 123,
"has_owner": true,
"holding_fee_amount": 123,
"restrict_credits_to_application": true,
"end_behavior": "roll",
"end_date": 123,
"from_application": {
"action": "revision",
"application": "<string>"
},
"move_in_date": 123,
"move_out_date": 123,
"open": true,
"owner_options": {
"apply_unit_fees": true,
"custom_fee_amount": 50000000
},
"partial_payment": {
"amount": 49999950,
"description": "<string>"
},
"rent_term": "<string>",
"start_date": 123,
"status": "<string>",
"subscription_data": {
"collection_method": "charge_automatically",
"interval": "month",
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"transfer_behavior": "automatic",
"type": "charge",
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"first_invoice_creation": "immediately",
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"type": "charge",
"description": "<string>",
"metadata": {},
"price": "<string>",
"proration_behavior": "create_prorations",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"type": "charge",
"description": "<string>",
"metadata": {},
"price": "<string>",
"proration_behavior": "create_prorations",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"type": "active_tenancy",
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"advance_rent_count": 123,
"advance_rent_total": 123,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"verification_session": "<string>",
"verification_session_required": true,
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>",
"type": "dog"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"customer_emails": [
"<string>"
],
"deposit_count": 123,
"deposit_total": 123,
"holding_fee_count": 123,
"holding_fee_total": 123,
"metadata": {},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"first_increase_at": 123
}
},
"steps": [
{
"id": "<string>",
"status": "<string>",
"type": "<string>"
}
]
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
application/json
The identifier of the application configuration to create the application with.
Pattern:
^[a-zA-Z0-9_]+$The applicants for the application.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
The subscription data for the application.
Show child attributes
Show child attributes
The type of the application.
Available options:
active_tenancy, let_only, renewal, standard The identifier of the unit to create the application with.
Pattern:
^[a-zA-Z0-9_]+$Set to true to attempt to accept this application immediately. The parameter defaults to false and is only allowed when type=active_tenancy.
The advance rent amount for the application.
Required range:
0 <= x <= 99999900The identifier of the assignee for the application.
Pattern:
^[a-zA-Z0-9_]+$The contract options for the application.
Show child attributes
Show child attributes
The contract template to use for the application. Required if type is one of standard, renewal or let_only.
Whether to create subscriptions for this application. Defaults to true. Set to false to skip all subscription creation.
The identifier of the deal assignee for the application.
Pattern:
^[a-zA-Z0-9_]+$The deposit amount for the application.
Required range:
0 <= x <= 99999900The end behavior for the application. Can only be set to complete when an end date is provided. If not provided, defaults to roll.
Available options:
roll, complete The end date of the application.
The end date configuration for the application.
Show child attributes
Show child attributes
The identifier of the lead enquiry this application is being created for. The enquiry moves to application, and to won once the application completes.
Pattern:
^[a-zA-Z0-9_]+$Create an application from an existing application.
Show child attributes
Show child attributes
The holding fee amount for the application.
Required range:
0 <= x <= 99999900Whether move-in credits (holding fee and advance rent) are reserved for this application’s own invoices. Defaults to the account setting.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
The date the tenant is expected to move in. Useful for short term lets where the actual move in date may differ from the contractual move in date.
The date the tenant is expected to move out. Useful for short term lets where the actual move out date may differ from the contractual move out date.
The owner options for the application.
Show child attributes
Show child attributes
The partial payment for the application.
Show child attributes
Show child attributes
The identifier of the renewal intent this application is being created for. When set, completing the application will cancel the source tenancy subscriptions to avoid double billing.
Pattern:
^[a-zA-Z0-9_]+$Whether to send an email to the applicant when the application is created.
The start date of the application.
The start date configuration for the application.
Show child attributes
Show child attributes
Whether to release the unit to the market as part of creating this application. Defaults to false. Occupied units that have not been released cannot otherwise be used for a new letting. Only allowed when type is standard or let_only, and not when creating a revision.
Whether to update the unit rent amount with the pricing used for the application.
Response
200 - application/json
Returns the task object if the request succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
application The advance rent amount for the application.
The identifier of the application configuration.
The mode of the application.
Available options:
classic, configuration The identifier of the assignee for the application.
Pattern:
^[a-zA-Z0-9_]+$The identifier of the building for the application.
A snapshot of the building at the time of the application.
Show child attributes
Show child attributes
The date and time the application was completed.
The identifier of the contract for the application.
The address of the contract for the application.
The contract options for the application.
Show child attributes
Show child attributes
The identifier of the contract template for the application.
The current step of the application configuration.
- Advance rent
- Completion
- Contract
- Deposit
- Holding fee
- Network check
- Partial payment
- Payment method
- Pre-qualification
- Referencing
- Verification session
- Waitpoint
Show child attributes
Show child attributes
The currency for the application.
Available options:
gbp, usd, eur, sek Example:
"gbp"
The customers for the tenancy.
Show child attributes
Show child attributes
The identifier of the deal assignee for the application.
Pattern:
^[a-zA-Z0-9_]+$The deposit amount for the application.
Whether the application has an owner.
The holding fee amount for the application.
Whether move-in credits (holding fee and advance rent) are reserved for this application’s own invoices, rather than the next invoice for the customer.
The end behavior for the application.
Available options:
roll, complete, null The end date of the application.
The from application for the application.
Show child attributes
Show child attributes
The expected move in date for the application.
The expected move out date for the application.
Whether the application is open.
The owner options for the application.
Show child attributes
Show child attributes
The partial payment details for the application.
Show child attributes
Show child attributes
The rent term for the application.
The start date of the application.
The status of the application.
The subscription data for the application.
Show child attributes
Show child attributes
The type of the application.
Available options:
active_tenancy, let_only, renewal, standard The identifier of the unit for the application.
A snapshot of the unit at the time of the application.
Show child attributes
Show child attributes
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The number of advance rent payments collected for the application.
The number of advance rent payments required for the application.
The applicants for the application.
Show child attributes
Show child attributes
The customer emails for the tenancy.
The number of deposit payments collected for the application.
The number of deposit payments required for the application.
The number of holding fee payments collected for the application.
The number of holding fee payments required for the application.
The metadata for the application.
Show child attributes
Show child attributes
Manual overrides carried forward at the tenancy level, applied when generating documents such as the Form 4A rent increase notice.
Show child attributes
Show child attributes
The steps of the application configuration.
Show child attributes
Show child attributes
Was this page helpful?
Create an application
curl --request POST \
--url https://api.yorlet.com/v1/applications \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"application_configuration": "<string>",
"applicants": [
{
"share_of_rent": 50,
"customer": "<string>",
"lead_tenant": true,
"permitted_occupier": true,
"reference_data": {},
"requirements": {
"deposit": true,
"guarantor": true,
"pre_qualification": true
},
"verification_session_data": {
"types": []
}
}
],
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"accept": true,
"advance_rent_amount": 49999950,
"assignee": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"create_subscriptions": true,
"deal_assignee": "<string>",
"deposit_amount": 49999950,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"enquiry": "<string>",
"holding_fee_amount": 49999950,
"restrict_credits_to_application": true,
"metadata": {},
"move_in_date": 123,
"move_out_date": 123,
"owner_options": {
"apply_unit_fees": true,
"custom_fee_amount": 50000000
},
"renewal_intent": "<string>",
"send_email": true,
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"release_unit": true,
"update_unit_rent": true
}
'import requests
url = "https://api.yorlet.com/v1/applications"
payload = {
"application_configuration": "<string>",
"applicants": [
{
"share_of_rent": 50,
"customer": "<string>",
"lead_tenant": True,
"permitted_occupier": True,
"reference_data": {},
"requirements": {
"deposit": True,
"guarantor": True,
"pre_qualification": True
},
"verification_session_data": { "types": [] }
}
],
"subscription_data": {
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": { "day_of_month": 16 },
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"description": "<string>",
"metadata": {},
"price": "<string>",
"schedule": [
{
"amount": 123,
"effective_at": 123
}
],
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"unit": "<string>",
"accept": True,
"advance_rent_amount": 49999950,
"assignee": "<string>",
"contract_options": {
"automatic_counter_signature": True,
"legal_entity": "<string>",
"owner_signature_required": True,
"send_applicant_email": True,
"send_owner_completion_email": True
},
"contract_template": "<string>",
"create_subscriptions": True,
"deal_assignee": "<string>",
"deposit_amount": 49999950,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"enquiry": "<string>",
"holding_fee_amount": 49999950,
"restrict_credits_to_application": True,
"metadata": {},
"move_in_date": 123,
"move_out_date": 123,
"owner_options": {
"apply_unit_fees": True,
"custom_fee_amount": 50000000
},
"renewal_intent": "<string>",
"send_email": True,
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"release_unit": True,
"update_unit_rent": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
application_configuration: '<string>',
applicants: [
{
share_of_rent: 50,
customer: '<string>',
lead_tenant: true,
permitted_occupier: true,
reference_data: {},
requirements: {deposit: true, guarantor: true, pre_qualification: true},
verification_session_data: {types: []}
}
],
subscription_data: {
add_invoice_items: [
{
amount: 123,
currency: '<string>',
description: '<string>',
tax_percent: 50,
metadata: {},
price: '<string>',
tax_rate: '<string>',
transfer_destination: '<string>',
unit: '<string>'
}
],
billing_anchor: 123,
billing_anchor_config: {day_of_month: 16},
coupon: '<string>',
custom_fields: [{name: '<string>', value: '<string>'}],
days_before_collection: 3,
days_until_due: 1,
end_date: 123,
end_date_config: {day: 16, month: 6, year: 123},
interval_count: 123,
items: [
{
price_data: {amount: 123, currency: 'gbp', tax_percent: 123},
description: '<string>',
metadata: {},
price: '<string>',
schedule: [{amount: 123, effective_at: 123}],
tax_rate: '<string>',
transfer_destination: '<string>',
unit: '<string>'
}
],
phases: [
{
start_date: 123,
items: [
{
price_data: {amount: 123, currency: 'gbp', tax_percent: 123},
description: '<string>',
metadata: {},
price: '<string>',
schedule: [{amount: 123, effective_at: 123}],
tax_rate: '<string>',
transfer_destination: '<string>',
unit: '<string>'
}
]
}
],
start_date: 123,
start_date_config: {day: 16, month: 6, year: 123}
},
unit: '<string>',
accept: true,
advance_rent_amount: 49999950,
assignee: '<string>',
contract_options: {
automatic_counter_signature: true,
legal_entity: '<string>',
owner_signature_required: true,
send_applicant_email: true,
send_owner_completion_email: true
},
contract_template: '<string>',
create_subscriptions: true,
deal_assignee: '<string>',
deposit_amount: 49999950,
end_date: 123,
end_date_config: {day: 16, month: 6, year: 123},
enquiry: '<string>',
holding_fee_amount: 49999950,
restrict_credits_to_application: true,
metadata: {},
move_in_date: 123,
move_out_date: 123,
owner_options: {apply_unit_fees: true, custom_fee_amount: 50000000},
renewal_intent: '<string>',
send_email: true,
start_date: 123,
start_date_config: {day: 16, month: 6, year: 123},
release_unit: true,
update_unit_rent: true
})
};
fetch('https://api.yorlet.com/v1/applications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'application_configuration' => '<string>',
'applicants' => [
[
'share_of_rent' => 50,
'customer' => '<string>',
'lead_tenant' => true,
'permitted_occupier' => true,
'reference_data' => [
],
'requirements' => [
'deposit' => true,
'guarantor' => true,
'pre_qualification' => true
],
'verification_session_data' => [
'types' => [
]
]
]
],
'subscription_data' => [
'add_invoice_items' => [
[
'amount' => 123,
'currency' => '<string>',
'description' => '<string>',
'tax_percent' => 50,
'metadata' => [
],
'price' => '<string>',
'tax_rate' => '<string>',
'transfer_destination' => '<string>',
'unit' => '<string>'
]
],
'billing_anchor' => 123,
'billing_anchor_config' => [
'day_of_month' => 16
],
'coupon' => '<string>',
'custom_fields' => [
[
'name' => '<string>',
'value' => '<string>'
]
],
'days_before_collection' => 3,
'days_until_due' => 1,
'end_date' => 123,
'end_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
],
'interval_count' => 123,
'items' => [
[
'price_data' => [
'amount' => 123,
'currency' => 'gbp',
'tax_percent' => 123
],
'description' => '<string>',
'metadata' => [
],
'price' => '<string>',
'schedule' => [
[
'amount' => 123,
'effective_at' => 123
]
],
'tax_rate' => '<string>',
'transfer_destination' => '<string>',
'unit' => '<string>'
]
],
'phases' => [
[
'start_date' => 123,
'items' => [
[
'price_data' => [
'amount' => 123,
'currency' => 'gbp',
'tax_percent' => 123
],
'description' => '<string>',
'metadata' => [
],
'price' => '<string>',
'schedule' => [
[
'amount' => 123,
'effective_at' => 123
]
],
'tax_rate' => '<string>',
'transfer_destination' => '<string>',
'unit' => '<string>'
]
]
]
],
'start_date' => 123,
'start_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
]
],
'unit' => '<string>',
'accept' => true,
'advance_rent_amount' => 49999950,
'assignee' => '<string>',
'contract_options' => [
'automatic_counter_signature' => true,
'legal_entity' => '<string>',
'owner_signature_required' => true,
'send_applicant_email' => true,
'send_owner_completion_email' => true
],
'contract_template' => '<string>',
'create_subscriptions' => true,
'deal_assignee' => '<string>',
'deposit_amount' => 49999950,
'end_date' => 123,
'end_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
],
'enquiry' => '<string>',
'holding_fee_amount' => 49999950,
'restrict_credits_to_application' => true,
'metadata' => [
],
'move_in_date' => 123,
'move_out_date' => 123,
'owner_options' => [
'apply_unit_fees' => true,
'custom_fee_amount' => 50000000
],
'renewal_intent' => '<string>',
'send_email' => true,
'start_date' => 123,
'start_date_config' => [
'day' => 16,
'month' => 6,
'year' => 123
],
'release_unit' => true,
'update_unit_rent' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/applications"
payload := strings.NewReader("{\n \"application_configuration\": \"<string>\",\n \"applicants\": [\n {\n \"share_of_rent\": 50,\n \"customer\": \"<string>\",\n \"lead_tenant\": true,\n \"permitted_occupier\": true,\n \"reference_data\": {},\n \"requirements\": {\n \"deposit\": true,\n \"guarantor\": true,\n \"pre_qualification\": true\n },\n \"verification_session_data\": {\n \"types\": []\n }\n }\n ],\n \"subscription_data\": {\n \"add_invoice_items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_percent\": 50,\n \"metadata\": {},\n \"price\": \"<string>\",\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"billing_anchor\": 123,\n \"billing_anchor_config\": {\n \"day_of_month\": 16\n },\n \"coupon\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"days_before_collection\": 3,\n \"days_until_due\": 1,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"interval_count\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"phases\": [\n {\n \"start_date\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ]\n }\n ],\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n }\n },\n \"unit\": \"<string>\",\n \"accept\": true,\n \"advance_rent_amount\": 49999950,\n \"assignee\": \"<string>\",\n \"contract_options\": {\n \"automatic_counter_signature\": true,\n \"legal_entity\": \"<string>\",\n \"owner_signature_required\": true,\n \"send_applicant_email\": true,\n \"send_owner_completion_email\": true\n },\n \"contract_template\": \"<string>\",\n \"create_subscriptions\": true,\n \"deal_assignee\": \"<string>\",\n \"deposit_amount\": 49999950,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"enquiry\": \"<string>\",\n \"holding_fee_amount\": 49999950,\n \"restrict_credits_to_application\": true,\n \"metadata\": {},\n \"move_in_date\": 123,\n \"move_out_date\": 123,\n \"owner_options\": {\n \"apply_unit_fees\": true,\n \"custom_fee_amount\": 50000000\n },\n \"renewal_intent\": \"<string>\",\n \"send_email\": true,\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"release_unit\": true,\n \"update_unit_rent\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/applications")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"application_configuration\": \"<string>\",\n \"applicants\": [\n {\n \"share_of_rent\": 50,\n \"customer\": \"<string>\",\n \"lead_tenant\": true,\n \"permitted_occupier\": true,\n \"reference_data\": {},\n \"requirements\": {\n \"deposit\": true,\n \"guarantor\": true,\n \"pre_qualification\": true\n },\n \"verification_session_data\": {\n \"types\": []\n }\n }\n ],\n \"subscription_data\": {\n \"add_invoice_items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_percent\": 50,\n \"metadata\": {},\n \"price\": \"<string>\",\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"billing_anchor\": 123,\n \"billing_anchor_config\": {\n \"day_of_month\": 16\n },\n \"coupon\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"days_before_collection\": 3,\n \"days_until_due\": 1,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"interval_count\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"phases\": [\n {\n \"start_date\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ]\n }\n ],\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n }\n },\n \"unit\": \"<string>\",\n \"accept\": true,\n \"advance_rent_amount\": 49999950,\n \"assignee\": \"<string>\",\n \"contract_options\": {\n \"automatic_counter_signature\": true,\n \"legal_entity\": \"<string>\",\n \"owner_signature_required\": true,\n \"send_applicant_email\": true,\n \"send_owner_completion_email\": true\n },\n \"contract_template\": \"<string>\",\n \"create_subscriptions\": true,\n \"deal_assignee\": \"<string>\",\n \"deposit_amount\": 49999950,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"enquiry\": \"<string>\",\n \"holding_fee_amount\": 49999950,\n \"restrict_credits_to_application\": true,\n \"metadata\": {},\n \"move_in_date\": 123,\n \"move_out_date\": 123,\n \"owner_options\": {\n \"apply_unit_fees\": true,\n \"custom_fee_amount\": 50000000\n },\n \"renewal_intent\": \"<string>\",\n \"send_email\": true,\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"release_unit\": true,\n \"update_unit_rent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/applications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"application_configuration\": \"<string>\",\n \"applicants\": [\n {\n \"share_of_rent\": 50,\n \"customer\": \"<string>\",\n \"lead_tenant\": true,\n \"permitted_occupier\": true,\n \"reference_data\": {},\n \"requirements\": {\n \"deposit\": true,\n \"guarantor\": true,\n \"pre_qualification\": true\n },\n \"verification_session_data\": {\n \"types\": []\n }\n }\n ],\n \"subscription_data\": {\n \"add_invoice_items\": [\n {\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"description\": \"<string>\",\n \"tax_percent\": 50,\n \"metadata\": {},\n \"price\": \"<string>\",\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"billing_anchor\": 123,\n \"billing_anchor_config\": {\n \"day_of_month\": 16\n },\n \"coupon\": \"<string>\",\n \"custom_fields\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"days_before_collection\": 3,\n \"days_until_due\": 1,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"interval_count\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ],\n \"phases\": [\n {\n \"start_date\": 123,\n \"items\": [\n {\n \"price_data\": {\n \"amount\": 123,\n \"currency\": \"gbp\",\n \"tax_percent\": 123\n },\n \"description\": \"<string>\",\n \"metadata\": {},\n \"price\": \"<string>\",\n \"schedule\": [\n {\n \"amount\": 123,\n \"effective_at\": 123\n }\n ],\n \"tax_rate\": \"<string>\",\n \"transfer_destination\": \"<string>\",\n \"unit\": \"<string>\"\n }\n ]\n }\n ],\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n }\n },\n \"unit\": \"<string>\",\n \"accept\": true,\n \"advance_rent_amount\": 49999950,\n \"assignee\": \"<string>\",\n \"contract_options\": {\n \"automatic_counter_signature\": true,\n \"legal_entity\": \"<string>\",\n \"owner_signature_required\": true,\n \"send_applicant_email\": true,\n \"send_owner_completion_email\": true\n },\n \"contract_template\": \"<string>\",\n \"create_subscriptions\": true,\n \"deal_assignee\": \"<string>\",\n \"deposit_amount\": 49999950,\n \"end_date\": 123,\n \"end_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"enquiry\": \"<string>\",\n \"holding_fee_amount\": 49999950,\n \"restrict_credits_to_application\": true,\n \"metadata\": {},\n \"move_in_date\": 123,\n \"move_out_date\": 123,\n \"owner_options\": {\n \"apply_unit_fees\": true,\n \"custom_fee_amount\": 50000000\n },\n \"renewal_intent\": \"<string>\",\n \"send_email\": true,\n \"start_date\": 123,\n \"start_date_config\": {\n \"day\": 16,\n \"month\": 6,\n \"year\": 123\n },\n \"release_unit\": true,\n \"update_unit_rent\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "application",
"advance_rent_amount": 123,
"application_configuration": "<string>",
"application_mode": "classic",
"assignee": "<string>",
"building": "<string>",
"building_snapshot": {
"name": "<string>",
"single_unit": true
},
"completed_at": 123,
"contract": "<string>",
"contract_address": "<string>",
"contract_options": {
"automatic_counter_signature": true,
"legal_entity": "<string>",
"owner_signature_required": true,
"send_applicant_email": true,
"send_owner_completion_email": true
},
"contract_template": "<string>",
"current_step": {
"id": "<string>",
"next_step": "<string>",
"type": "advance_rent"
},
"currency": "gbp",
"customers": [
{
"id": "<string>",
"email": "<string>",
"name": "<string>"
}
],
"deal_assignee": "<string>",
"deposit_amount": 123,
"has_owner": true,
"holding_fee_amount": 123,
"restrict_credits_to_application": true,
"end_behavior": "roll",
"end_date": 123,
"from_application": {
"action": "revision",
"application": "<string>"
},
"move_in_date": 123,
"move_out_date": 123,
"open": true,
"owner_options": {
"apply_unit_fees": true,
"custom_fee_amount": 50000000
},
"partial_payment": {
"amount": 49999950,
"description": "<string>"
},
"rent_term": "<string>",
"start_date": 123,
"status": "<string>",
"subscription_data": {
"collection_method": "charge_automatically",
"interval": "month",
"add_invoice_items": [
{
"amount": 123,
"currency": "<string>",
"description": "<string>",
"tax_percent": 50,
"transfer_behavior": "automatic",
"type": "charge",
"metadata": {},
"price": "<string>",
"tax_rate": "<string>",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"billing_anchor": 123,
"billing_anchor_config": {
"day_of_month": 16
},
"coupon": "<string>",
"custom_fields": [
{
"name": "<string>",
"value": "<string>"
}
],
"days_before_collection": 3,
"days_until_due": 1,
"end_date": 123,
"end_date_config": {
"day": 16,
"month": 6,
"year": 123
},
"first_invoice_creation": "immediately",
"interval_count": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"type": "charge",
"description": "<string>",
"metadata": {},
"price": "<string>",
"proration_behavior": "create_prorations",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>",
"unit": "<string>"
}
],
"phases": [
{
"start_date": 123,
"items": [
{
"price_data": {
"amount": 123,
"currency": "gbp",
"tax_percent": 123
},
"type": "charge",
"description": "<string>",
"metadata": {},
"price": "<string>",
"proration_behavior": "create_prorations",
"schedule": [
{
"amount": 123,
"effective_at": 123,
"effective_at_config": {
"day": 16,
"month": 6,
"year": 123
}
}
],
"tax_rate": "<string>",
"transfer_behavior": "automatic",
"transfer_destination": "<string>",
"unit": "<string>"
}
]
}
],
"start_date": 123,
"start_date_config": {
"day": 16,
"month": 6,
"year": 123
}
},
"type": "active_tenancy",
"unit": "<string>",
"unit_snapshot": {
"name": "<string>"
},
"account": "<string>",
"deleted": false,
"advance_rent_count": 123,
"advance_rent_total": 123,
"applicants": {
"count": 1,
"has_more": false,
"object": "list",
"data": [
{
"id": "<string>",
"created": 123,
"object": "application.applicant",
"application": "<string>",
"advance_rent": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"currency": "gbp",
"customer": "<string>",
"deposit": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"guarantor": "<string>",
"guarantor_contract": "<string>",
"holding_fee": {
"amount": 123,
"paid": true,
"paid_off_platform": true,
"transaction": "<string>"
},
"lead_tenant": true,
"permitted_occupier": true,
"requirements": {
"guarantor": true
},
"share_of_rent": 123,
"status": "<string>",
"tos_acceptance": {
"date": 123,
"ip": "<string>"
},
"verification_session": "<string>",
"verification_session_required": true,
"account": "<string>",
"deleted": false,
"pets": [
{
"age": 123,
"name": "<string>",
"type": "dog"
}
],
"pre_qualification": {
"affordability": {
"company_name": "<string>",
"gross_annual_salary": 123,
"role": "<string>"
},
"nationality": "<string>"
}
}
]
},
"customer_emails": [
"<string>"
],
"deposit_count": 123,
"deposit_total": 123,
"holding_fee_count": 123,
"holding_fee_total": 123,
"metadata": {},
"overrides": {
"rent_increase": {
"tenancy_start_at": 123,
"first_increase_at": 123
}
},
"steps": [
{
"id": "<string>",
"status": "<string>",
"type": "<string>"
}
]
}