Skip to main content
GET
/
documents
/
summary
Get Documents Summary
curl --request GET \
  --url http://localhost:8000/documents/summary
{
  "authorized_revenue": "<string>",
  "pending_count": 123,
  "total_documents": 123
}

Headers

​
authorization
string | null
​
x-api-key
string | null
​
x-tenant-id
string | null

Query Parameters

​
document_type
string | null
​
status
enum<string> | null

Status values for document lifecycle.

Available options:
DRAFT,
VALIDATED,
NUMBER_RESERVED,
XML_GENERATED,
SIGNED,
RECEPTION_PENDING,
SUBMITTED_TO_SRI,
RECEIVED_BY_SRI,
AUTHORIZATION_PENDING,
AUTHORIZED,
REJECTED,
RECEPTION_RETRY_SCHEDULED,
AUTHORIZATION_RETRY_SCHEDULED,
RECEPTION_UNKNOWN,
AUTHORIZATION_UNKNOWN,
MANUAL_REVIEW_REQUIRED,
FAILED_PERMANENT,
CANCELLATION_REQUESTED,
CANCELLED,
VOIDED_BY_NC
​
search
string | null
​
date_from
string<date> | null
​
date_to
string<date> | null
​
issuer_id
string<uuid> | null

Cookies

​
factio_access_token
string | null

Response

Successful Response

Métricas agregadas para el header del listado.

​
authorized_revenue
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
pending_count
integer
required
​
total_documents
integer
required