Recursos usados frente al plan (datos del tablero inicial)

GET/api/v1/account/resources

Ambiente y habilitación; plan vigente con usados, disponibles, fecha de corte, días para el corte, renovación automática y valor del siguiente cobro; y en el período: documentos (aceptados, rechazados, fallidos, en proceso, de prueba y por tipo), correos al adquiriente, webhooks y almacenamiento. Período por defecto: desde la compra del plan (o el inicio del mes) hasta hoy; from y to lo cambian. Una casa de software ve los totales con sus clientes y el detalle por cliente; un cliente ve lo suyo, sin plan.

Parámetros de consulta

fromstring · date
tostring · date

Respuestas

200OK

accountobject
+ Ver 3 campos− Ocultar 3 campos
- idstring · uuid
- namestring
- kindstring
environmentstring
Valores: staging · habilitacion · production
habilitadaboolean
periodobject
+ Ver 2 campos− Ocultar 2 campos
- fromstring · date
- tostring · date
planobject
+ Ver 11 campos− Ocultar 11 campos
- idstring · uuid
- namestring
  Ejemplo: Casa 10
- documents_includedinteger
  Ejemplo: 10000
- documents_usedinteger
  Ejemplo: 5000
- documents_remaininginteger
  Ejemplo: 5000
- used_percentinteger
  Ejemplo: 50
- starts_atstring · date-time
- cutoff_datestring · date
  Ejemplo: 2027-11-12
- days_to_cutoffinteger
  Ejemplo: 180
- auto_renewboolean
- next_charge_copinteger
  Ejemplo: 280000
documentsobject
+ Ver 6 campos− Ocultar 6 campos
- acceptedinteger
  Aceptados por la DIAN: consumen el plan
- rejectedinteger
- failedinteger
- in_processinteger
- testinteger
  De prueba: no consumen
- by_typeobject<string, integer>
emailsobject
+ Ver 3 campos− Ocultar 3 campos
- sentinteger
- pendinginteger
- failedinteger
webhooksobject
+ Ver 3 campos− Ocultar 3 campos
- sentinteger
- pendinginteger
- failedinteger
storageobject
+ Ver 2 campos− Ocultar 2 campos
- documentsinteger
- bytesinteger
accountsarray<object>
Solo casa de software, por cliente
+ Ver 5 campos− Ocultar 5 campos
- account_idstring · uuid
- nitstring
- namestring
- acceptedinteger
- testinteger

400Datos inválidos (details trae los campos)

codestring
Ejemplo: error.document.invalid
messagestring
errorsarray<object>
Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)
+ Ver 2 campos− Ocultar 2 campos
- fieldstring
  Ruta del campo en el JSON enviado
  Ejemplo: lines[0].quantity
- messagestring
  Ejemplo: Cantidad inválida: debe ser mayor que cero.
detailsarray<string>
Rutas de los campos inválidos (compatibilidad; usa errors)
request_idstring

401Falta la key o es inválida, está deshabilitada, vencida o revocada (error.missing_api_key, error.invalid_api_key, error.api_key.disabled, error.api_key.expired, error.api_key.revoked)

codestring
Ejemplo: error.document.invalid
messagestring
errorsarray<object>
Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)
+ Ver 2 campos− Ocultar 2 campos
- fieldstring
  Ruta del campo en el JSON enviado
  Ejemplo: lines[0].quantity
- messagestring
  Ejemplo: Cantidad inválida: debe ser mayor que cero.
detailsarray<string>
Rutas de los campos inválidos (compatibilidad; usa errors)
request_idstring