Obtener detalle de un documento
curl --request GET \
--url https://api.pruff.com/api/clients/reporting/document/{documentId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.pruff.com/api/clients/reporting/document/{documentId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.pruff.com/api/clients/reporting/document/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pruff.com/api/clients/reporting/document/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pruff.com/api/clients/reporting/document/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.pruff.com/api/clients/reporting/document/{documentId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pruff.com/api/clients/reporting/document/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "00123456-dd49-43ae-8429-f5ef123456f2",
"folio": "12673",
"amount": 1045631,
"code": "33",
"type": "Factura electrónica",
"confirmDate": null,
"issuedDate": "2026-01-29T00:00:00.000Z",
"cancelDate": null,
"creditNoteAmount": 0,
"businessName": "Cliente Ejemplo SpA",
"stakeholderName": "Deudor Ejemplo Ltda.",
"startingPaymentDate": "2026-03-01T00:00:00.000Z",
"lastExtensionDate": "2026-03-20T00:00:00.000Z",
"extensions": [
{
"id": 12,
"rate": 1.5,
"startDate": "2026-03-01T00:00:00.000Z",
"dueDate": "2026-03-20T00:00:00.000Z",
"status": "ACTIVE",
"statusEsp": "Activa",
"observation": null,
"createdAt": "2026-02-27T14:30:00.000Z",
"paid": "Pagado"
}
],
"daysToCount": 46,
"paidAt": null,
"amountConciliated": 500000,
"arrearConciliation": 0,
"documentConciliation": 500000,
"documentRemainingAmountNet": 490000,
"documentRemainingAmount": 545631,
"conciliations": [
{
"requestId": 4521,
"typeEsp": "Pago recibido",
"type": "payIn",
"amount": 500000,
"conciliationDocumentAmount": 500000,
"conciliationArrearAmount": 0,
"conciliationAmount": 500000,
"date": "2026-03-25T00:00:00.000Z",
"payInDate": "2026-03-25T00:00:00.000Z",
"accountingDate": "2026-03-25T00:00:00.000Z",
"conciliationDate": "2026-03-26T10:15:00.000Z",
"documentAmountDebtBefore": 1045631,
"arrearAmountDebtBefore": 0,
"documentAmountDebtAfter": 545631,
"arrearAmountDebtAfter": 0,
"paidBy": "Deudor",
"arrearRate": 3
}
],
"paymentDate": "2026-03-20T00:00:00.000Z",
"requestId": 5634,
"rate": 1.8,
"advance": 99,
"arrearRate": 3,
"operationDate": "2026-02-02T00:00:00.000Z",
"requestType": "factoring"
}{
"message": "Unauthorized: Invalid API Key"
}{
"message": "Rate limit exceeded: 501 requests in the current 60s window, limit is 500. Retry in 12s.",
"displayMessage": "Superaste el límite de 500 solicitudes cada 60 segundos. Vuelve a intentarlo en 12 segundos.",
"data": {
"code": "RATE_LIMIT_EXCEEDED",
"scope": "All API keys of your company share this budget.",
"limit": 500,
"used": 501,
"windowSeconds": 60,
"retryAfterSeconds": 12,
"resetAt": "2026-11-04T15:00:12.000Z",
"hint": "Wait until resetAt (or honor the Retry-After header) before retrying. Avoid repeating identical requests: reuse responses you already fetched, use filters and larger pageSize values instead of one request per item, and cap your client concurrency."
}
}{
"message": "Internal server error"
}{
"message": "request_timeout",
"displayMessage": "La solicitud excedió el tiempo máximo permitido"
}Reportes
Obtener detalle de un documento
Devuelve el detalle de un documento financiado: datos del documento, solicitud que lo financió, vencimiento vigente y prórrogas, saldos, mora e historial de abonos.
Obtén el documentId del campo id de GET /reporting/portfolio o del campo documentId de GET /reporting/collection.
Usa el documentId de un documento de tu empresa que esté financiado por una solicitud aceptada.
GET
/
reporting
/
document
/
{documentId}
Obtener detalle de un documento
curl --request GET \
--url https://api.pruff.com/api/clients/reporting/document/{documentId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.pruff.com/api/clients/reporting/document/{documentId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.pruff.com/api/clients/reporting/document/{documentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pruff.com/api/clients/reporting/document/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pruff.com/api/clients/reporting/document/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.pruff.com/api/clients/reporting/document/{documentId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pruff.com/api/clients/reporting/document/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "00123456-dd49-43ae-8429-f5ef123456f2",
"folio": "12673",
"amount": 1045631,
"code": "33",
"type": "Factura electrónica",
"confirmDate": null,
"issuedDate": "2026-01-29T00:00:00.000Z",
"cancelDate": null,
"creditNoteAmount": 0,
"businessName": "Cliente Ejemplo SpA",
"stakeholderName": "Deudor Ejemplo Ltda.",
"startingPaymentDate": "2026-03-01T00:00:00.000Z",
"lastExtensionDate": "2026-03-20T00:00:00.000Z",
"extensions": [
{
"id": 12,
"rate": 1.5,
"startDate": "2026-03-01T00:00:00.000Z",
"dueDate": "2026-03-20T00:00:00.000Z",
"status": "ACTIVE",
"statusEsp": "Activa",
"observation": null,
"createdAt": "2026-02-27T14:30:00.000Z",
"paid": "Pagado"
}
],
"daysToCount": 46,
"paidAt": null,
"amountConciliated": 500000,
"arrearConciliation": 0,
"documentConciliation": 500000,
"documentRemainingAmountNet": 490000,
"documentRemainingAmount": 545631,
"conciliations": [
{
"requestId": 4521,
"typeEsp": "Pago recibido",
"type": "payIn",
"amount": 500000,
"conciliationDocumentAmount": 500000,
"conciliationArrearAmount": 0,
"conciliationAmount": 500000,
"date": "2026-03-25T00:00:00.000Z",
"payInDate": "2026-03-25T00:00:00.000Z",
"accountingDate": "2026-03-25T00:00:00.000Z",
"conciliationDate": "2026-03-26T10:15:00.000Z",
"documentAmountDebtBefore": 1045631,
"arrearAmountDebtBefore": 0,
"documentAmountDebtAfter": 545631,
"arrearAmountDebtAfter": 0,
"paidBy": "Deudor",
"arrearRate": 3
}
],
"paymentDate": "2026-03-20T00:00:00.000Z",
"requestId": 5634,
"rate": 1.8,
"advance": 99,
"arrearRate": 3,
"operationDate": "2026-02-02T00:00:00.000Z",
"requestType": "factoring"
}{
"message": "Unauthorized: Invalid API Key"
}{
"message": "Rate limit exceeded: 501 requests in the current 60s window, limit is 500. Retry in 12s.",
"displayMessage": "Superaste el límite de 500 solicitudes cada 60 segundos. Vuelve a intentarlo en 12 segundos.",
"data": {
"code": "RATE_LIMIT_EXCEEDED",
"scope": "All API keys of your company share this budget.",
"limit": 500,
"used": 501,
"windowSeconds": 60,
"retryAfterSeconds": 12,
"resetAt": "2026-11-04T15:00:12.000Z",
"hint": "Wait until resetAt (or honor the Retry-After header) before retrying. Avoid repeating identical requests: reuse responses you already fetched, use filters and larger pageSize values instead of one request per item, and cap your client concurrency."
}
}{
"message": "Internal server error"
}{
"message": "request_timeout",
"displayMessage": "La solicitud excedió el tiempo máximo permitido"
}Respuesta
Detalle del documento.
Detalle de un documento financiado.