Update Adjustment
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/subscriptions/{subscription_id}/adjustments/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"adjustment": {
"amount": 123,
"concept": "<string>",
"description": "<string>",
"start_period": "2023-12-25",
"total_cycles": 123,
"product_id": 123,
"product_base_amount": 123,
"adjustment_concept_id": 123,
"issue_support_document": true
}
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adjustment: {
amount: 123,
concept: '<string>',
description: '<string>',
start_period: '2023-12-25',
total_cycles: 123,
product_id: 123,
product_base_amount: 123,
adjustment_concept_id: 123,
issue_support_document: true
}
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/subscriptions/{subscription_id}/adjustments/{id}', 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}/treasury/subscriptions/{subscription_id}/adjustments/{id}"
payload = { "adjustment": {
"amount": 123,
"concept": "<string>",
"description": "<string>",
"start_period": "2023-12-25",
"total_cycles": 123,
"product_id": 123,
"product_base_amount": 123,
"adjustment_concept_id": 123,
"issue_support_document": True
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"payload": {
"id": 123,
"adjustment_type": "debit",
"recurrence_type": "fixed_cycles",
"amount": 123,
"concept": "<string>",
"start_period": "2023-12-25",
"end_period": "2023-12-25",
"lifecycle_status": "pending_application",
"locked_for_editing": true,
"can_cancel_future_applications": true,
"editable_forward": true,
"total_cycles": 123,
"cycles_applied": 123,
"active": true,
"remaining_cycles": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"name": "<string>"
},
"status": "<string>",
"release_status": "pending_evidence",
"requires_evidence": true,
"adjustment_concept_id": 123,
"product_id": 123,
"product_snapshot": {},
"product_base_amount": 123,
"vat_rate": 123,
"subscription_id": 123,
"currency": "<string>",
"property": {
"id": 123,
"address": "<string>"
}
}
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}Treasury Adjustments
Update Adjustment
Actualiza un ajuste de una suscripción. Si el ajuste ya se aplicó en al menos un ciclo (locked_for_editing en true), solo puedes cambiar concept, description y amount, y solo cuando editable_forward es true. El cambio aplica a los ciclos que faltan; los ciclos ya aplicados conservan su valor. Si envías otro campo, la respuesta es 422.
PATCH
/
api
/
v1
/
accounts
/
{account_id}
/
treasury
/
subscriptions
/
{subscription_id}
/
adjustments
/
{id}
Update Adjustment
curl --request PATCH \
--url https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/subscriptions/{subscription_id}/adjustments/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"adjustment": {
"amount": 123,
"concept": "<string>",
"description": "<string>",
"start_period": "2023-12-25",
"total_cycles": 123,
"product_id": 123,
"product_base_amount": 123,
"adjustment_concept_id": 123,
"issue_support_document": true
}
}
'const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
adjustment: {
amount: 123,
concept: '<string>',
description: '<string>',
start_period: '2023-12-25',
total_cycles: 123,
product_id: 123,
product_base_amount: 123,
adjustment_concept_id: 123,
issue_support_document: true
}
})
};
fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/treasury/subscriptions/{subscription_id}/adjustments/{id}', 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}/treasury/subscriptions/{subscription_id}/adjustments/{id}"
payload = { "adjustment": {
"amount": 123,
"concept": "<string>",
"description": "<string>",
"start_period": "2023-12-25",
"total_cycles": 123,
"product_id": 123,
"product_base_amount": 123,
"adjustment_concept_id": 123,
"issue_support_document": True
} }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"payload": {
"id": 123,
"adjustment_type": "debit",
"recurrence_type": "fixed_cycles",
"amount": 123,
"concept": "<string>",
"start_period": "2023-12-25",
"end_period": "2023-12-25",
"lifecycle_status": "pending_application",
"locked_for_editing": true,
"can_cancel_future_applications": true,
"editable_forward": true,
"total_cycles": 123,
"cycles_applied": 123,
"active": true,
"remaining_cycles": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"name": "<string>"
},
"status": "<string>",
"release_status": "pending_evidence",
"requires_evidence": true,
"adjustment_concept_id": 123,
"product_id": 123,
"product_snapshot": {},
"product_base_amount": 123,
"vat_rate": 123,
"subscription_id": 123,
"currency": "<string>",
"property": {
"id": 123,
"address": "<string>"
}
}
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}