Saltar al contenido principal
GET
Obtener cuentas pendientes

Autorizaciones

x-api-key
string
header
requerido

API key que Pruff entrega a tu empresa.

Parámetros de consulta

type
enum<string>
requerido

Tipo de cuenta pendiente: receivable (por cobrar) o payable (por pagar).

Opciones disponibles:
receivable,
payable
paid
enum<string>

true retorna solo las cuentas pagadas y false solo las pendientes de pago. Sin este filtro se retornan ambas.

Opciones disponibles:
true,
false
category
string

Nombre de la categoría de la cuenta pendiente (búsqueda parcial).

categoryId
integer

Identificador de la categoría de la cuenta pendiente. Si se envía, tiene prioridad sobre category.

id
integer

Identificador de la cuenta pendiente.

Rango requerido: x >= 1
startDate
string<date>

Fecha de creación de la cuenta pendiente desde la cual quieres el reporte (YYYY-MM-DD).

endDate
string<date>

Fecha de creación de la cuenta pendiente hasta la cual quieres el reporte (YYYY-MM-DD). Incluye el día completo.

stakeholderIdentifier
string

RUT del deudor. Solo para type=receivable.

stakeholderName
string

Nombre del deudor (búsqueda parcial). Solo para type=receivable.

true retorna solo las cuentas en cobranza judicial y false las que no lo están. Solo para type=receivable.

Opciones disponibles:
true,
false
businessIdentifier
string

RUT del acreedor. Solo para type=payable.

businessName
string

Nombre del acreedor (búsqueda parcial). Solo para type=payable.

executiveName
string

Nombre del ejecutivo comercial que tiene al acreedor en su cartera (búsqueda parcial). Solo para type=payable.

page
integer
predeterminado:1

Número de página, desde 1.

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

Cantidad de cuentas por página (máximo 100).

Rango requerido: 1 <= x <= 100

Respuesta

Cuentas pendientes de la página pedida.

data
object[]
requerido

Cuentas pendientes de la página pedida.

pagination
object
requerido