Saltar al contenido principal
GET
Obtener prórrogas

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de consulta

folio
string

Folio del documento prorrogado.

businessIdentifier
string

RUT del cliente (cedente) dueño del documento prorrogado.

stakeholderIdentifier
string

RUT del deudor del documento prorrogado.

status
enum<string>
predeterminado:all

Estado de la prórroga. active devuelve las prórrogas activas, completed las completadas y all todas, sin importar su estado.

Opciones disponibles:
all,
active,
completed
paid
enum<string>

Filtra por el campo paid de cada prórroga. Con true devuelve solo las prórrogas cuyo paid es true; con false, todas las demás, incluidas las que están en revisión o rechazadas. Si no lo envías no se filtra por pago.

Opciones disponibles:
true,
false
startDueDate
string<date>

Vencimiento de la prórroga desde esta fecha (inclusive).

endDueDate
string<date>

Vencimiento de la prórroga hasta esta fecha (inclusive). No puede ser anterior a startDueDate.

startCreatedAt
string<date>

Fecha de creación de la prórroga desde este día (inclusive).

endCreatedAt
string<date>

Fecha de creación de la prórroga hasta este día. No puede ser anterior a startCreatedAt.

startActivationDate
string<date>

Inicio de la prórroga desde esta fecha (inclusive).

endActivationDate
string<date>

Inicio de la prórroga hasta esta fecha (inclusive). No puede ser anterior a startActivationDate.

page
integer
predeterminado:1

Número de página, desde 1.

Rango requerido: x >= 1
pageSize
integer
predeterminado:10

Cantidad de prórrogas por página.

Rango requerido: 1 <= x <= 100

Respuesta

Página de prórrogas.

data
object[]
requerido
pagination
object
requerido