Saltar al contenido principal
GET
Obtener detalle de un documento

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de ruta

documentId
string<uuid>
requerido

Identificador del documento.

Respuesta

Detalle del documento.

Detalle de un documento financiado.

id
string<uuid>
requerido

Identificador del documento.

Ejemplo:

"00123456-dd49-43ae-8429-f5ef123456f2"

folio
string
requerido

Folio del documento.

Ejemplo:

"12673"

amount
number
requerido

Monto del documento.

Ejemplo:

1045631

code
string
requerido

Código del tipo de documento (por ejemplo 33 para factura electrónica afecta, 34 para exenta). 33 si el documento no informa subtipo.

Ejemplo:

"33"

type
string
requerido

Tipo de documento en español.

Ejemplo:

"Factura electrónica"

issuedDate
string<date-time>
requerido

Fecha de emisión del documento.

Ejemplo:

"2026-01-29T00:00:00.000Z"

creditNoteAmount
number
requerido

Monto neto de notas de crédito asociadas al documento.

Ejemplo:

0

businessName
string
requerido

Nombre del cliente o acreedor (emisor del documento).

Ejemplo:

"Cliente Ejemplo SpA"

extensions
object[]
requerido

Prórrogas del documento. Arreglo vacío si no tiene.

daysToCount
integer
requerido

Días entre la fecha de operación y el vencimiento vigente del documento.

Ejemplo:

25

amountConciliated
number
requerido

Monto total abonado al documento, redondeado al entero más cercano.

Ejemplo:

500000

arrearConciliation
number
requerido

Parte de lo abonado que se aplicó a la mora, redondeada al entero más cercano.

Ejemplo:

0

documentConciliation
number
requerido

Parte de lo abonado que se aplicó al documento, redondeada al entero más cercano.

Ejemplo:

500000

documentRemainingAmountNet
number
requerido

Saldo financiado del documento, redondeado al entero más cercano. 0 si está pagado.

Ejemplo:

565631

documentRemainingAmount
number
requerido

Saldo del documento, redondeado al entero más cercano.

Ejemplo:

545631

conciliations
object[]
requerido

Historial de abonos aplicados al documento.

confirmDate
string<date-time> | null

Fecha del acuse de recibo. null si no tiene.

Ejemplo:

null

cancelDate
string<date-time> | null

Fecha de rechazo del documento. null si no fue rechazado.

Ejemplo:

null

stakeholderName
string | null

Nombre del deudor del documento.

Ejemplo:

"Deudor Ejemplo Ltda."

startingPaymentDate
string<date-time>

Vencimiento original del documento en la solicitud, sin prórrogas.

Ejemplo:

"2026-03-01T00:00:00.000Z"

lastExtensionDate
string<date-time> | null

Vencimiento fijado por la última prórroga. null si el documento no tiene prórrogas.

Ejemplo:

"2026-03-20T00:00:00.000Z"

paidAt
string<date-time> | null

Fecha y hora en que el documento quedó pagado. null si aún no está pagado.

Ejemplo:

null

paymentDate
string<date-time>

Vencimiento vigente del documento, incluyendo la última prórroga si existe.

Ejemplo:

"2026-03-20T00:00:00.000Z"

requestId
integer

Identificador de la solicitud que financió el documento.

Ejemplo:

5634

rate
number

Tasa de la solicitud (%).

Ejemplo:

1.8

advance
number

Porcentaje de anticipo de la solicitud (%). En créditos y confirming es 100.

Ejemplo:

99

arrearRate
number | null

Tasa de mora aplicable al documento (%). null si la mora se calcula por tabla o no está definida.

Ejemplo:

3

operationDate
string<date-time>

Fecha de operación de la solicitud.

Ejemplo:

"2026-02-02T00:00:00.000Z"

requestType
enum<string>

Producto de la solicitud que financió el documento.

Opciones disponibles:
factoring,
credit,
confirming
Ejemplo:

"factoring"