Developers
Ingresar a la plataforma

Listar estados de cuenta

GET/api/public/v1/statements

Devuelve una página de estados de cuenta de la empresa en formato HAL, con el detalle de sus conceptos (details), los montos y fechas del período y su estado de pago. Admite filtros por empresa, estado de pago, tipo de estado de cuenta, fecha límite de pago y período facturado (todas las fechas inclusive). Según la configuración de la empresa, cada período genera un único estado de cuenta ALL o dos separados (CONSUMPTION y FEE).

Autorización

apiKeyScheme
X-API-KEY<token>

En: header

Parámetros de consulta

page?integer

Número de página a devolver, comenzando en 0.

Formatoint32
size?integer

Cantidad de resultados por página. Por defecto 20, máximo 500.

Formatoint32
sort?array<>

Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.

Criterios de ordenamiento, enviados como sort[0].property y sort[0].direction (ASC o DESC). Sin ordenamiento explícito, el orden de los resultados no está garantizado.

property?string
direction?string

Valor en

  • "ASC"
  • "DESC"
text?string

Actualmente no se aplica como filtro: se acepta por compatibilidad y no modifica el resultado.

include?array<string>

Códigos únicos (uniqueCode) de estados de cuenta: sólo se devuelven los estados de cuenta cuyo código está en la lista.

paymentStatus?array<>

Estados de pago por los que filtrar (PENDING, PARTIALLY_PAID, EXPIRED, PAID, PAID_AFTER_EXPIRATION). Se devuelven los que tienen cualquiera de los estados indicados.

Valor en

  • "PENDING"
  • "EXPIRED"
  • "PAID"
  • "PAID_AFTER_EXPIRATION"
  • "PARTIALLY_PAID"
companyCode?string

Código (uniqueCode) de la empresa por la que filtrar los estados de cuenta.

paymentDateLimitFrom?string

Fecha desde la cual filtrar por fecha límite de pago (inclusive).

Formatodate-time
paymentDateLimitTo?string

Fecha hasta la cual filtrar por fecha límite de pago (inclusive).

Formatodate-time
periodDateFrom?string

Fecha desde la cual filtrar por período facturado (inclusive).

Formatodate-time
periodDateTo?string

Fecha hasta la cual filtrar por período facturado (inclusive).

Formatodate-time
types?array<>

Tipos de estado de cuenta por los que filtrar (CONSUMPTION, FEE, ALL). La comparación es literal: ALL devuelve sólo los estados de cuenta de tipo ALL, no todos los tipos.

Valores válidos por cluster:

ClusterValores
MéxicoALL
CMFCONSUMPTION, FEE
ArgentinaALL, CONSUMPTION, FEE
BICECONSUMPTION, FEE

Valor en

  • "CONSUMPTION"
  • "FEE"
  • "ALL"

Cuerpo de la respuesta

application/vnd.hal+json

application/json

application/json

curl -X GET "https://example.com/api/public/v1/statements?page=0&size=20&companyCode=8407574f-3b34-4d42-894c-31016dd2e426&paymentDateLimitFrom=2024-11-13T16%3A51%3A00.000Z&paymentDateLimitTo=2024-11-13T16%3A51%3A00.000Z&periodDateFrom=2024-11-13T16%3A51%3A00.000Z&periodDateTo=2024-11-13T16%3A51%3A00.000Z"
{  "_embedded": {    "statements": [      {        "deleted": true,        "uniqueCode": "0590843e-1d92-4d51-82c6-4a22a6b8be82",        "companyCode": "8407574f-3b34-4d42-894c-31016dd2e426",        "lastModifiedDate": "2024-11-13T16:51:00.000Z",        "createdDate": "2024-11-13T16:51:00.000Z",        "createdBy": "string",        "externalId": "string",        "paidAmount": 2358,        "totalAmount": 5000,        "consumptionRemainingBalance": -150,        "currencyCode": "string",        "fullyPaidDate": "2024-11-13T16:51:00.000Z",        "periodDateFrom": "2024-11-13T16:51:00.000Z",        "periodDateTo": "2024-11-13T16:51:00.000Z",        "paymentDateLimit": "2024-11-13T16:51:00.000Z",        "details": [          {            "companyCode": "8407574f-3b34-4d42-894c-31016dd2e426",            "type": "PREVIOUS_DEBT",            "amount": 150,            "payableAmount": 150,            "paymentsAmount": 100,            "bonusAmount": 10,            "fullyPaid": true,            "fullyPaidDate": "2024-11-13T16:51:00.000Z"          }        ],        "statementType": "CONSUMPTION",        "paymentStatus": "PENDING",        "exchangeRate": 0      }    ]  },  "_links": {    "property1": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    },    "property2": {      "href": "string",      "hreflang": "string",      "title": "string",      "type": "string",      "deprecation": "string",      "profile": "string",      "name": "string",      "templated": true    }  },  "page": {    "size": 0,    "totalElements": 0,    "totalPages": 0,    "number": 0  }}