Skip to main content
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": "<string>",
          "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": "<string>",
              "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
  },
  "holding_fee_amount": 49999950,
  "restrict_credits_to_application": true,
  "metadata": {},
  "move_in_date": 123,
  "move_out_date": 123,
  "owner_options": {
    "apply_unit_fees": true
  },
  "renewal_intent": "<string>",
  "send_email": true,
  "start_date": 123,
  "start_date_config": {
    "day": 16,
    "month": 6,
    "year": 123
  },
  "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": "<string>",
                    "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": "<string>",
                            "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
    },
    "holding_fee_amount": 49999950,
    "restrict_credits_to_application": True,
    "metadata": {},
    "move_in_date": 123,
    "move_out_date": 123,
    "owner_options": { "apply_unit_fees": True },
    "renewal_intent": "<string>",
    "send_email": True,
    "start_date": 123,
    "start_date_config": {
        "day": 16,
        "month": 6,
        "year": 123
    },
    "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: '<string>', 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: '<string>', 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},
    holding_fee_amount: 49999950,
    restrict_credits_to_application: true,
    metadata: {},
    move_in_date: 123,
    move_out_date: 123,
    owner_options: {apply_unit_fees: true},
    renewal_intent: '<string>',
    send_email: true,
    start_date: 123,
    start_date_config: {day: 16, month: 6, year: 123},
    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' => '<string>',
                                                                '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' => '<string>',
                                                                                                                                                                                                                                                                '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
    ],
    'holding_fee_amount' => 49999950,
    'restrict_credits_to_application' => true,
    'metadata' => [
        
    ],
    'move_in_date' => 123,
    'move_out_date' => 123,
    'owner_options' => [
        'apply_unit_fees' => true
    ],
    'renewal_intent' => '<string>',
    'send_email' => true,
    'start_date' => 123,
    'start_date_config' => [
        'day' => 16,
        'month' => 6,
        'year' => 123
    ],
    '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\": \"<string>\",\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\": \"<string>\",\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  \"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  },\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  \"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\": \"<string>\",\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\": \"<string>\",\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  \"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  },\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  \"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\": \"<string>\",\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\": \"<string>\",\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  \"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  },\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  \"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>",
  "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",
  "deal_assignee": "<string>",
  "deposit_amount": 123,
  "has_owner": true,
  "holding_fee_amount": 123,
  "restrict_credits_to_application": true,
  "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
  },
  "partial_payment": {
    "amount": 49999950,
    "description": "<string>"
  },
  "rent_term": "<string>",
  "start_date": 123,
  "status": "<string>",
  "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": "<string>",
          "tax_percent": 123
        },
        "description": "<string>",
        "metadata": {},
        "price": "<string>",
        "schedule": [
          {
            "amount": 123,
            "effective_at": 123,
            "effective_at_config": {
              "day": 16,
              "month": 6,
              "year": 123
            }
          }
        ],
        "tax_rate": "<string>",
        "transfer_destination": "<string>",
        "unit": "<string>"
      }
    ],
    "phases": [
      {
        "start_date": 123,
        "items": [
          {
            "price_data": {
              "amount": 123,
              "currency": "<string>",
              "tax_percent": 123
            },
            "description": "<string>",
            "metadata": {},
            "price": "<string>",
            "schedule": [
              {
                "amount": 123,
                "effective_at": 123,
                "effective_at_config": {
                  "day": 16,
                  "month": 6,
                  "year": 123
                }
              }
            ],
            "tax_rate": "<string>",
            "transfer_destination": "<string>",
            "unit": "<string>"
          }
        ]
      }
    ],
    "start_date": 123,
    "start_date_config": {
      "day": 16,
      "month": 6,
      "year": 123
    }
  },
  "unit": "<string>",
  "unit_snapshot": {
    "name": "<string>"
  },
  "account": "<string>",
  "deleted": false,
  "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>"
          }
        ],
        "pre_qualification": {
          "affordability": {
            "company_name": "<string>",
            "gross_annual_salary": 123,
            "role": "<string>"
          },
          "nationality": "<string>"
        }
      }
    ]
  },
  "metadata": {},
  "overrides": {
    "rent_increase": {
      "tenancy_start_at": 123,
      "first_increase_at": 123
    }
  },
  "steps": [
    {
      "id": "<string>",
      "status": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
application_configuration
string
required

The identifier of the application configuration to create the application with.

Pattern: ^[a-zA-Z0-9_]+$
​
applicants
object[]
required

The applicants for the application.

Required array length: 1 - 10 elements
​
subscription_data
object
required

The subscription data for the application.

​
type
enum<string>
required

The type of the application.

Available options:
active_tenancy,
let_only,
renewal,
standard
​
unit
string
required

The identifier of the unit to create the application with.

Pattern: ^[a-zA-Z0-9_]+$
​
accept
boolean

Set to true to attempt to accept this application immediately. The parameter defaults to false and is only allowed when type=active_tenancy.

​
advance_rent_amount
integer | null

The advance rent amount for the application.

Required range: 0 <= x <= 99999900
​
assignee
string | null

The identifier of the assignee for the application.

Pattern: ^[a-zA-Z0-9_]+$
​
contract_options
object

The contract options for the application.

​
contract_template
string

The contract template to use for the application. Required if type is one of standard, renewal or let_only.

​
create_subscriptions
boolean
default:true

Whether to create subscriptions for this application. Defaults to true. Set to false to skip all subscription creation.

​
deal_assignee
string | null

The identifier of the deal assignee for the application.

Pattern: ^[a-zA-Z0-9_]+$
​
deposit_amount
integer | null

The deposit amount for the application.

Required range: 0 <= x <= 99999900
​
end_behavior
enum<string>

The end behavior for the application. Can only be set to complete when an end date is provided.

Available options:
roll,
complete
​
end_date
integer | null

The end date of the application.

​
end_date_config
object | null

The end date configuration for the application.

​
from_application
object

Create an application from an existing application.

​
holding_fee_amount
integer | null

The holding fee amount for the application.

Required range: 0 <= x <= 99999900
​
restrict_credits_to_application
boolean

Whether move-in credits (holding fee and advance rent) are reserved for this application’s own invoices. Defaults to the account setting.

​
metadata
object | null

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.

​
move_in_date
integer | null

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.

​
move_out_date
integer | null

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.

​
owner_options
object

The owner options for the application.

​
partial_payment
object

The partial payment for the application.

​
renewal_intent
string | null

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_]+$
​
send_email
boolean

Whether to send an email to the applicant when the application is created.

​
start_date
integer | null

The start date of the application.

​
start_date_config
object | null

The start date configuration for the application.

​
update_unit_rent
boolean

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.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
application
​
advance_rent_amount
integer | null
required

The advance rent amount for the application.

​
application_configuration
required

The identifier of the application configuration.

​
application_mode
enum<string>
required

The mode of the application.

Available options:
classic,
configuration
​
assignee
string | null
required

The identifier of the assignee for the application.

Pattern: ^[a-zA-Z0-9_]+$
​
building
required

The identifier of the building for the application.

​
building_snapshot
object
required

A snapshot of the building at the time of the application.

​
completed_at
integer | null
required

The date and time the application was completed.

​
contract
required

The identifier of the contract for the application.

​
contract_address
string | null
required

The address of the contract for the application.

​
contract_options
object
required

The contract options for the application.

​
contract_template
required

The identifier of the contract template for the application.

​
current_step
Advance rent · object
required

The current step of the application configuration.

​
currency
enum<string>
required

The currency for the application.

Available options:
gbp,
usd,
eur,
sek
Example:

"gbp"

​
deal_assignee
string | null
required

The identifier of the deal assignee for the application.

Pattern: ^[a-zA-Z0-9_]+$
​
deposit_amount
integer | null
required

The deposit amount for the application.

​
has_owner
boolean
required

Whether the application has an owner.

​
holding_fee_amount
integer | null
required

The holding fee amount for the application.

​
restrict_credits_to_application
boolean
required

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.

​
end_behavior
enum<string> | null
required

The end behavior for the application.

Available options:
roll,
complete,
null
​
end_date
integer | null
required

The end date of the application.

​
from_application
object | null
required

The from application for the application.

​
move_in_date
integer | null
required

The expected move in date for the application.

​
move_out_date
integer | null
required

The expected move out date for the application.

​
open
boolean
required

Whether the application is open.

​
owner_options
object | null
required

The owner options for the application.

​
partial_payment
object | null
required

The partial payment details for the application.

​
rent_term
string | null
required

The rent term for the application.

​
start_date
integer | null
required

The start date of the application.

​
status
string
required

The status of the application.

​
subscription_data
object
required

The subscription data for the application.

​
type
enum<string>
required

The type of the application.

Available options:
active_tenancy,
let_only,
renewal,
standard
​
unit
required

The identifier of the unit for the application.

​
unit_snapshot
object
required

A snapshot of the unit at the time of the application.

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
applicants
object

The applicants for the application.

​
metadata
object | null

The metadata for the application.

​
overrides
object | null

Manual overrides carried forward at the tenancy level, applied when generating documents such as the Form 4A rent increase notice.

​
steps
object[]

The steps of the application configuration.