Registrar la entrega del arriendo
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/tenancy/deliver \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"delivered_on": "2023-12-25",
"billed_through": "2023-12-25",
"vacated": true
}
'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({delivered_on: '2023-12-25', billed_through: '2023-12-25', vacated: true})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/tenancy/deliver', 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}/contract_submissions/{contract_submission_id}/tenancy/deliver"
payload = {
"delivered_on": "2023-12-25",
"billed_through": "2023-12-25",
"vacated": True
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"delivery": {
"id": 123,
"delivered_on": "2023-12-25",
"billed_through": "2023-12-25",
"keys_count": 123,
"keys_note": "<string>",
"condition_notes": "<string>",
"readings": {},
"utilities_settled": true,
"charges": [
{
"concept": "<string>",
"amount": "<string>",
"beneficiary": "owner"
}
],
"deposit_outcome": "returned",
"deposit_amount": "<string>",
"termination_cause": "<string>",
"contract_submission_id": 123,
"document_id": 123,
"recorded_by_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"contract_id": 123,
"utilities_prorate": {
"amount": "<string>",
"beneficiary": "owner"
}
}
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"errors": [
"<string>"
]
}Contract Submissions
Registrar la entrega del arriendo
Registra que te devolvieron el inmueble del arriendo en curso del contrato. No cierra el arriendo ni su cobro: el cierre va por POST .../tenancy/close. Required: delivered_on, billed_through, vacated. utilities_prorate (amount, beneficiary: owner o agency) es required cuando utilities_settled es false. También: readings, charges[], termination. Necesitas exactamente un respaldo: support_submission_id (un acta de entrega firmada, mira delivery_supports) o multipart support/attachments.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
contract_submissions
/
{contract_submission_id}
/
tenancy
/
deliver
Registrar la entrega del arriendo
curl --request POST \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/tenancy/deliver \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"delivered_on": "2023-12-25",
"billed_through": "2023-12-25",
"vacated": true
}
'const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({delivered_on: '2023-12-25', billed_through: '2023-12-25', vacated: true})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/contract_submissions/{contract_submission_id}/tenancy/deliver', 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}/contract_submissions/{contract_submission_id}/tenancy/deliver"
payload = {
"delivered_on": "2023-12-25",
"billed_through": "2023-12-25",
"vacated": True
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"delivery": {
"id": 123,
"delivered_on": "2023-12-25",
"billed_through": "2023-12-25",
"keys_count": 123,
"keys_note": "<string>",
"condition_notes": "<string>",
"readings": {},
"utilities_settled": true,
"charges": [
{
"concept": "<string>",
"amount": "<string>",
"beneficiary": "owner"
}
],
"deposit_outcome": "returned",
"deposit_amount": "<string>",
"termination_cause": "<string>",
"contract_submission_id": 123,
"document_id": 123,
"recorded_by_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"contract_id": 123,
"utilities_prorate": {
"amount": "<string>",
"beneficiary": "owner"
}
}
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"errors": [
"<string>"
]
}Path Parameters
Body
application/jsonmultipart/form-data
No cierra el arriendo. Required: delivered_on, billed_through, vacated. utilities_prorate es required cuando utilities_settled es false. Respaldo: support_submission_id o multipart support/attachments.