Register presigned contract
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts \
--header 'Content-Type: multipart/form-data' \
--header 'api_access_token: <api-key>' \
--form 'contract={
"contract_type_id": 123,
"signers": [
{
"contact_id": 123,
"role": "<string>"
}
],
"file": "<string>",
"document_id": 123,
"document_folder_id": 123,
"property_id": 123,
"signed_date": "2023-12-25",
"contract_start_date": "2023-12-25",
"contract_end_date": "2023-12-25",
"monthly_amount": 123,
"billing_day": 16
}'const form = new FormData();
form.append('contract', '{
"contract_type_id": 123,
"signers": [
{
"contact_id": 123,
"role": "<string>"
}
],
"file": "<string>",
"document_id": 123,
"document_folder_id": 123,
"property_id": 123,
"signed_date": "2023-12-25",
"contract_start_date": "2023-12-25",
"contract_end_date": "2023-12-25",
"monthly_amount": 123,
"billing_day": 16
}');
const options = {method: 'POST', headers: {api_access_token: '<api-key>'}};
options.body = form;
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract\"\r\n\r\n{\r\n \"contract_type_id\": 123,\r\n \"signers\": [\r\n {\r\n \"contact_id\": 123,\r\n \"role\": \"<string>\"\r\n }\r\n ],\r\n \"file\": \"<string>\",\r\n \"document_id\": 123,\r\n \"document_folder_id\": 123,\r\n \"property_id\": 123,\r\n \"signed_date\": \"2023-12-25\",\r\n \"contract_start_date\": \"2023-12-25\",\r\n \"contract_end_date\": \"2023-12-25\",\r\n \"monthly_amount\": 123,\r\n \"billing_day\": 16\r\n}\r\n-----011000010111000001101001--"
headers = {"api_access_token": "<api-key>"}
response = requests.post(url, data=payload, headers=headers)
print(response.text){}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Presigned Contracts
Register presigned contract
Register a contract signed outside Yampi. It always states its type and at least one contact who signed it; its PDF (a new file or a library document), property, dates and the rent and billing day it declares are optional. All or nothing: a refused property or person leaves no contract behind.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
presigned_contracts
Register presigned contract
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts \
--header 'Content-Type: multipart/form-data' \
--header 'api_access_token: <api-key>' \
--form 'contract={
"contract_type_id": 123,
"signers": [
{
"contact_id": 123,
"role": "<string>"
}
],
"file": "<string>",
"document_id": 123,
"document_folder_id": 123,
"property_id": 123,
"signed_date": "2023-12-25",
"contract_start_date": "2023-12-25",
"contract_end_date": "2023-12-25",
"monthly_amount": 123,
"billing_day": 16
}'const form = new FormData();
form.append('contract', '{
"contract_type_id": 123,
"signers": [
{
"contact_id": 123,
"role": "<string>"
}
],
"file": "<string>",
"document_id": 123,
"document_folder_id": 123,
"property_id": 123,
"signed_date": "2023-12-25",
"contract_start_date": "2023-12-25",
"contract_end_date": "2023-12-25",
"monthly_amount": 123,
"billing_day": 16
}');
const options = {method: 'POST', headers: {api_access_token: '<api-key>'}};
options.body = form;
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"contract\"\r\n\r\n{\r\n \"contract_type_id\": 123,\r\n \"signers\": [\r\n {\r\n \"contact_id\": 123,\r\n \"role\": \"<string>\"\r\n }\r\n ],\r\n \"file\": \"<string>\",\r\n \"document_id\": 123,\r\n \"document_folder_id\": 123,\r\n \"property_id\": 123,\r\n \"signed_date\": \"2023-12-25\",\r\n \"contract_start_date\": \"2023-12-25\",\r\n \"contract_end_date\": \"2023-12-25\",\r\n \"monthly_amount\": 123,\r\n \"billing_day\": 16\r\n}\r\n-----011000010111000001101001--"
headers = {"api_access_token": "<api-key>"}
response = requests.post(url, data=payload, headers=headers)
print(response.text){}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{}{}Was this page helpful?