Listar Balances

Endpoint: GET /balances/

¿Para qué sirve?

Mediante esta consulta, podrás listar los balances disponibles para consulta de la empresa a la que iniciaste sesión previamente. Corresponde al detalle de las obligaciones al día o en mora de la entidad.

PARÁMETROS

DESCRIPCIÓN

session_key

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

Respuesta

Parámetro

Descripción

status

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

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

balances

Los balances de la empresa.

Ejemplos

Listar balances

GET /balances/ 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
curl -X GET "https://fiscal.sandbox.prometeoapi.com/balances/" -d "session_key=ce11f66e-ed28-4a4c-acc7-bb28bb899c75" -H "X-API-Key: <API KEY>"
import requests

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

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

Respuesta exitosa

{
    "status" : "success",
    "balances" : [
        {
            "value" : 0,
            "amount" : 26,
            "type" : "al dia"
        },
        {
            "value" : 47280000,
            "amount" : 3,
            "type" : "saldo a favor"
        }
    ]
}

Respuesta errónea o session_key expirada

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

Did this page help you?