Retenciones recibidas
Los comprobantes de retención que tus clientes (agentes de retención) emitieron sobre tus ventas. Registrarlas alimenta la conciliación de cartera y el crédito tributario. Recurso JSON:API
withholding_received
.
El objeto withholding_received
#
agent_id
string
requerido
RUC del agente de retención (tu cliente).
country
enum
requerido
País (
EC
,
PE
).
ECPE
environment
enum
requerido
Partición del dato: por una llave solo viaja
production
.
testproduction
issue_date
date
requerido
Fecha de emisión (AAAA-MM-DD).
kind
enum
requerido
retencionpercepcion
perceived
string
requerido
ret_iva
string
requerido
IVA retenido, como cadena decimal.
ret_renta
string
requerido
Renta retenida, como cadena decimal.
tenant_slug
string
requerido
La organización dueña del libro.
agent_name
string
Razón social del agente de retención.
authorization
string
Autorización o clave de acceso de la retención.
book_id
uuid
El libro contable dueño del registro — siempre el de tu llave.
number
string
Número del comprobante de retención (
001-001-000004567
).
sale_access_key
string
Clave de acceso de esa factura.
sale_number
string
Número de tu factura sobre la que se retuvo.
Filtrable por: agent_idagent_nameauthorizationbook_idcountryenvironmentidissue_datekindnumberperceivedret_ivaret_rentasale_access_keysale_numbertenant_slug
Ordenable por: agent_idagent_nameauthorizationbook_idcountryenvironmentidissue_datekindnumberperceivedret_ivaret_rentasale_access_keysale_numbertenant_slug
Registrar una retención recibida#
/api/v1/withholdings-received
Bearer
Content-Type: application/vnd.api+json
agent_id
string
requerido
RUC del agente de retención (tu cliente).
country
enum
requerido
País (
EC
,
PE
).
ECPE
issue_date
date
requerido
Fecha de emisión (AAAA-MM-DD).
agent_name
string
Razón social del agente de retención.
authorization
string
Autorización o clave de acceso de la retención.
kind
enum
retencionpercepcion
number
string
Número del comprobante de retención (
001-001-000004567
).
perceived
string
ret_iva
string
IVA retenido, como cadena decimal.
ret_renta
string
Renta retenida, como cadena decimal.
sale_access_key
string
Clave de acceso de esa factura.
sale_number
string
Número de tu factura sobre la que se retuvo.
Devuelve
·
201
con
data
·
400
si el cuerpo no cumple el esquema.
curl -X POST https://edge.datil.com/api/v1/withholdings-received \
-H "Authorization: Bearer $DATIL_API_KEY" \
-H "Content-Type: application/vnd.api+json" \
-d '{
"data": {
"type": "withholding_received",
"attributes": {
"country": "EC",
"issue_date": "2026-07-03",
"agent_id": "1790012345001",
"agent_name": "Corporación Cliente S.A.",
"number": "001-001-000004567",
"authorization": "0307202607179000000000110010010000045671234567812",
"ret_iva": "10.35",
"ret_renta": "2.00",
"sale_number": "001-002-000000123"
}
}
}'{
"data": {
"type": "withholding_received",
"id": "3e5a7c9b-1d3f-4a6c-8e0b-2c4e6a8b0d2f",
"attributes": {
"agent_id": "1790012345001",
"country": "EC",
"environment": "production",
"issue_date": "2026-07-03",
"kind": "retencion",
"perceived": "…",
"ret_iva": "10.35",
"ret_renta": "2.00",
"tenant_slug": "acme",
"agent_name": "Corporación Cliente S.A.",
"authorization": "0307202607179000000000110010010000045671234567812",
"book_id": "1d2f4b6a-8c0e-4a2b-9d3f-5e7a9c1b3d5f",
"number": "001-001-000004567",
"sale_access_key": "0307202601099234567800110010020000001231234567814",
"sale_number": "001-002-000000123"
}
}
}Listar retenciones recibidas#
/api/v1/withholdings-received
Bearer
filter[…]
object
Filtra por atributo:
filter[kind]=customer
, u operadores anidados como
filter[issue_date][greater_than]=2026-07-01
. Combinable con
filter[and]
/
filter[or]
.
sort
string
Atributos separados por coma; prefijo
-
para descendente:
sort=-issue_date
.
page[limit]
integer
Máximo de registros por página.
page[offset]
integer
Desplazamiento desde el inicio del listado.
page[count]
boolean
Con
true
, la respuesta incluye el total en
meta.page.total
.
fields[tipo]
string
Atributos a devolver, separados por coma — el sparse fieldset de JSON:API.
Devuelve
·
200
con
data
— lista de objetos
withholding_received
.
curl "https://edge.datil.com/api/v1/withholdings-received?sort=-issue_date&page[limit]=20" \
-H "Authorization: Bearer $DATIL_API_KEY"{
"data": [
{
"type": "withholding_received",
"id": "3e5a7c9b-1d3f-4a6c-8e0b-2c4e6a8b0d2f",
"attributes": {
"agent_id": "1790012345001",
"country": "EC",
"environment": "production",
"issue_date": "2026-07-03",
"kind": "retencion",
"perceived": "…",
"ret_iva": "10.35",
"ret_renta": "2.00",
"tenant_slug": "acme",
"agent_name": "Corporación Cliente S.A.",
"authorization": "0307202607179000000000110010010000045671234567812",
"book_id": "1d2f4b6a-8c0e-4a2b-9d3f-5e7a9c1b3d5f",
"number": "001-001-000004567",
"sale_access_key": "0307202601099234567800110010020000001231234567814",
"sale_number": "001-002-000000123"
}
}
]
}Consultar una retención recibida#
/api/v1/withholdings-received/:id
Bearer
id
uuid
requerido
Id de la retención.
Devuelve
·
200
con
data
·
404
.
curl "https://edge.datil.com/api/v1/withholdings-received/3e5a7c9b-1d3f-4a6c-8e0b-2c4e6a8b0d2f" \
-H "Authorization: Bearer $DATIL_API_KEY"{
"data": {
"type": "withholding_received",
"id": "3e5a7c9b-1d3f-4a6c-8e0b-2c4e6a8b0d2f",
"attributes": {
"agent_id": "1790012345001",
"country": "EC",
"environment": "production",
"issue_date": "2026-07-03",
"kind": "retencion",
"perceived": "…",
"ret_iva": "10.35",
"ret_renta": "2.00",
"tenant_slug": "acme",
"agent_name": "Corporación Cliente S.A.",
"authorization": "0307202607179000000000110010010000045671234567812",
"book_id": "1d2f4b6a-8c0e-4a2b-9d3f-5e7a9c1b3d5f",
"number": "001-001-000004567",
"sale_access_key": "0307202601099234567800110010020000001231234567814",
"sale_number": "001-002-000000123"
}
}
}