Retenciones en la Fuente

Endpoint: GET /retentions/

¿Para qué sirve?

La retención en la fuente grava los ingresos percibidos por el contribuyente con una tarifa reducida, lo que compone un anticipo del impuesto que deberá pagar sobre las utilidades.

Mediante esta consulta podrás obtener un reporte de la declaración jurada mensual de retención en la fuente del usuario al que iniciaste sesión previamente.

Parámetros requeridos

PARÁMETROS

DESCRIPCIÓN

session_key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

year

Año.

period

  • 1: Enero - Enero

  • 2: Febrero - Febrero

  • 3: Marzo - Marzo

  • 4: Abril - Abril

  • 5: Mayo - Mayo

  • 6: Junio - Junio

  • 7: Julio - Julio

  • 8: Agosto - Agosto

  • 9: Septiembre - Septiembre

  • 10: Octubre - Octubre

  • 11: Noviembre - Noviembre

  • 12: Diciembre - Diciembre

Respuesta

STATUS

status

  • success -> la información ha sido accedida correctamente.

  • error -> la sesión o la key es inválida.

Ejemplos

Solicitar declaración jurada mensual de retención de la fuente

GET /retentions/ HTTP/1.1
Host: fiscal.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

session_key=ce11f66e-ed28-4a4c-acc7-bb28bb899c75&year=2017&period=1
curl -X GET "https://fiscal.sandbox.prometeoapi.com/retentions/" -d "session_key=ce11f66e-ed28-4a4c-acc7-bb28bb899c75&year=2017&period=1" -H "X-API-Key: <API KEY>"
import requests

requests.get('https://fiscal.sandbox.prometeoapi.com/retentions/', data={
    'session_key': 'ce11f66e-ed28-4a4c-acc7-bb28bb899c75',
    'year': '2017',
    'period': '1',
}, headers={
    'X-API-Key': '<API KEY>'
})
var request = require('request');

request.get({
  "url": "https://fiscal.sandbox.prometeoapi.com/retentions/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "form": {
    "session_key": "ce11f66e-ed28-4a4c-acc7-bb28bb899c75",
    "year": "2017",
    "period": "1"
  }
});

Respuesta exitosa

{
    "retentions": {
        "direction_code": "3 2",
        "fields": {
            "27": {
                "name": "Rentas de trabajo",
                "number": 27,
                "value": 15972000
            },
            "28": {
                "name": "Rentas de pensiones",
                "number": 28,
                "value": 0
            },
            "29": {
                "name": "Honorarios",
                "number": 29,
                "value": 4200000
            },
            "30": {
                "name": "Comisiones",
                "number": 30,
                "value": 0
            },
            "83": {
                "name": "Más: Sanciones",
                "number": 83,
                "value": 0
            },
            "84": {
                "name": "Total retenciones más sanciones",
                "number": 84,
                "value": 1668000
            }
        },
        "form_number": "3501661737131",
        "nit": "80172487",
        "pdf_url": "/pdf/f9ac62308e8595b1cd2a5756c1c8ce75.pdf",
        "period": 0,
        "reason": "Qualia Fintech SRL",
        "year": 2017
    },
    "status": "success"
}

No existe el documento en el periodo seleccionado

{
    "message": "El sistema no ha encontrado documentos a su nombre o a nombre de la Organización que representa, correspondientes al año gravable, período y periodicidad diligenciados, regrese e intente nuevos parámetros de consulta.",
    "status": "error"
}

Respuesta errónea o session_key expirada

{
    "message" : "Invalid session key",
    "status" : "error"
}

Did this page help you?