Get receivables
GET
https://evo-integracao-api.w12app.com.br/api/v1/receivables
🌐 API Reference/Receivables
Obtener Lista de Cuentas por Cobrar
Descripción
receivables) con filtros avanzados por fechas, valores, tipos de pago, estado, ventas, miembro, facturas y paginación. La respuesta contiene colecciones con los registros (lista, list, ids — que poseen la misma estructura de objeto), la cantidad (qtde), información resumida de indicadores (informacoesIndicados) y el último ID de conciliación (idUltimaConciliacao).🔑 Parámetros de Consulta (Query Params)
| Parámetro | Tipo | Descripción |
|---|---|---|
| registrationDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de registro. |
| registrationDateEnd | Datetime (yyyy-mm-dd) | Fecha final de registro. |
| dueDateStart | Datetime (yyyy-mm-dd) | Fecha de vencimiento inicial. |
| dueDateEnd | Datetime (yyyy-mm-dd) | Fecha de vencimiento final. |
| receivingDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de recepción efectiva. |
| receivingDateEnd | Datetime (yyyy-mm-dd) | Fecha final de recepción efectiva. |
| competenceDateStart | Datetime (yyyy-mm-dd) | Fecha inicial del período de competencia. |
| competenceDateEnd | Datetime (yyyy-mm-dd) | Fecha final del período de competencia. |
| cancellationDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de cancelación. |
| cancellationDateEnd | Datetime (yyyy-mm-dd) | Fecha final de cancelación. |
| chargeDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de cobro. |
| chargeDateEnd | Datetime (yyyy-mm-dd) | Fecha final de cobro. |
| updateDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de actualización. |
| updateDateEnd | Datetime (yyyy-mm-dd) | Fecha final de actualización. |
| description | string | Descripción. |
| ammountStart | number (double) | Filtrar por valor mínimo. |
| ammountEnd | number (double) | Filtrar por valor máximo. |
| paymentTypes | string | Lista de IDs de tipos de pago (separados por comas). |
| accountStatus | string | Lista de estados (separados por comas). |
| take | int32 | Total de registros a devolver (máximo 50). Default: 50. |
| skip | int32 | Total de registros a omitir (paginación). Default: 0. |
| memberId | int32 | ID del miembro. |
| idSale | int32 | ID de la venta. |
| idReceivable | int32 | ID del receivable. |
| invoiceDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de emisión de la factura. |
| invoiceDateEnd | Datetime (yyyy-mm-dd) | Fecha final de emisión de la factura. |
| invoiceCanceledDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de cancelación de la factura. |
| invoiceCanceledDateEnd | Datetime (yyyy-mm-dd) | Fecha final de cancelación de la factura. |
| saleDateStart | Datetime (yyyy-mm-dd) | Fecha inicial de la venta. |
| saleDateEnd | Datetime (yyyy-mm-dd) | Fecha final de la venta. |
| idBranch | int32 | Filtrar por el número de la sucursal. |
🔷 Tipos de Pago paymentTypes
| ID | Tipo de Pago |
|---|---|
| 1 | Efectivo |
| 2 | Tarjeta de Crédito |
| 3 | Tarjeta de Débito |
| 4 | Cheque |
| 5 | Boleto Bancario |
| 6 | PagSeguro |
| 7 | Depósito |
| 8 | Débito en Cuenta |
| 9 | Internet |
| 11 | Créditos de Venta |
| 12 | Tarjeta de Crédito Online |
| 13 | Transferencia |
| 18 | Pix |
| 0 | Saldo Deudor |
🔷 Estado de la Cuenta accountStatus
| ID | Estado |
|---|---|
| 1 | Pendiente |
| 2 | Recibido |
| 3 | Cancelado |
| 4 | Atrasado |
📤 Estructura de la Respuesta
| Campo | Tipo | Descripción |
|---|---|---|
| qtde | int32 | Cantidad total de registros devueltos. |
| lista | array<object> | Colección principal de receivables (objetos con estructura detallada). |
| list | array<object> | Colección (misma estructura que lista) — mantenida por compatibilidad. |
| ids | array<object> | Colección (misma estructura que lista) — mantenida por compatibilidad. |
| informacoesIndicados | object | Indicadores de referencia (registros, visitas, conversiones, valores). |
| idUltimaConciliacao | int32 | ID de la última conciliación. |
🚧 OBS. lista,listyidsdevuelven objetos con la misma estructura.
🧩 Estructura de los Objetos lista, list, ids
| Campo | Tipo | Descripción |
|---|---|---|
| idReceivable | int32 | ID del receivable. |
| description | string | Descripción del ítem/movimiento. |
| registrationDate | Datetime (yyyy-mm-dd) | Fecha de registro del receivable. |
| dueDate | Datetime (yyyy-mm-dd) | Fecha de vencimiento. |
| receivingDate | Datetime (yyyy-mm-dd) | Fecha de recepción (si aplica). |
| competenceDate | Datetime (yyyy-mm-dd) | Fecha de competencia. |
| cancellationDate | Datetime (yyyy-mm-dd) | Fecha de cancelación (si aplica). |
| ammount | number | Valor del título. |
| ammountPaid | number | Valor ya pagado. |
| status | object | Objeto con id (int) y name (string) del estado. |
| responsibles | array<object> | Detalles de responsables. |
| currentInstallment | int32 | Cuota actual (ej.: 1). |
| totalInstallments | int32 | Total de cuotas. |
| authorization | string | Código de autorización. |
| payerName | string | Nombre del pagador. |
| idMemberPayer | int32 | ID del miembro pagador (si aplica). |
| idProspectPayer | int32 | ID del prospecto pagador (si aplica). |
| idBranchMember | int32 | ID de la sucursal del miembro. |
| idResponsible | int32 | ID del responsable. |
| idMemberResponsible | int32 | ID del miembro que actúa como responsable. |
| cpfResponsible | string | CPF del responsable. |
| idSale | int32 | ID de la venta asociada. |
| bankAccount | object | Objeto { id:int, name:string } con la cuenta bancaria asociada. |
| paymentType | object | Objeto { id:int, name:string } con el tipo de pago. |
| invoiceDetails | array<object> | Array con detalles de las facturas. |
| fees | number | Comisiones asociadas. |
| conciliated | boolean | Indica si fue conciliado. |
| logTef | object | Objeto { authorization, tefId, merchantCheckoutGuid }. |
| tid | string | ID TID (transacción). |
| nsu | string | NSU de la transacción. |
| updateDate | Datetime (yyyy-mm-dd) | Fecha de última actualización del registro. |
| chargeDate | Datetime (yyyy-mm-dd) | Fecha de cobro efectivo. |
| idReceivableFrom | int32 | ID del receivable de origen (en estornos/transferencias). |
| transactionToken | string | Token de transacción (cuando aplica). |
| idRevenueCenter | int32 | ID del centro de ingresos asociado. |
| cardAcquirer | string | Nombre del adquirente de la tarjeta. |
| cardFlag | string | Nombre de la marca de la tarjeta. |
| creditDetails | array<object> | Detalles de créditos vinculados. |
| cancellationDescription | string | Motivo/descripción de la cancelación. |
| source | string | Origen del movimiento. |
| saleDate | Datetime (yyyy-mm-dd) | Fecha de la venta asociada. |
🧩 Estructura del Objeto responsibles
| Campo | Tipo | Descripción |
|---|---|---|
| idResponsible | int32 | ID del responsable financiero. |
| idMember | int32 | ID del miembro al que el responsable está vinculado. |
| name | string | Nombre del responsable. |
| cpf | string | CPF del responsable. |
| string | Correo electrónico del responsable. | |
| phone | string | Teléfono del responsable. |
| observation | string | Observaciones adicionales sobre el responsable. |
| idMemberResponsible | int32 | ID del miembro que actúa como responsable. |
| acessFiti | boolean | Indica si el responsable tiene acceso a Fiti. |
| financialResponsible | boolean | Indica si es el responsable financiero. |
| personType | string | Tipo de persona del responsable (ej.: Física o Jurídica). |
| document | string | Documento del responsable (CPF o CNPJ, según el tipo de persona). |
🧩 Estructura del Objeto invoiceDetails
| Campo | Tipo | Descripción |
|---|---|---|
| invoiceNumber | string | Número de la factura. |
| issuedAmount | number | Valor emitido en la factura. |
| status | string | Estado de la factura. |
| sendDate | Datetime (yyyy-mm-dd) | Fecha de envío de la factura. |
| canceledDate | Datetime (yyyy-mm-dd) | Fecha de cancelación de la factura. |
| urlPdf | string | URL del PDF de la factura. |
| idInvoiceType | int32 | ID del tipo de factura. |
| invoiceType | string | Descripción del tipo de factura. |
🧩 Estructura del Objeto logTef
| Campo | Tipo | Descripción |
|---|---|---|
| authorization | string | Código de autorización TEF. |
| tefId | string | ID TEF. |
| merchantCheckoutGuid | string | GUID del checkout del comerciante. |
🧩 Estructura del Objeto creditDetails
| Campo | Tipo | Descripción |
|---|---|---|
| idCredit | int32 | ID del crédito. |
| idCancelationCredit | int32 | ID de la cancelación del crédito (si aplica). |
| idBranchOrigin | int32 | ID de la sucursal de origen del crédito. |
| ammount | number | Valor del crédito. |
| branchDocument | string | Documento/identificador de la sucursal. |
| idSaleOrigin | int32 | ID de la venta de origen del crédito. |
| idReceivableOrigin | int32 | ID del receivable de origen asociado al crédito. |
🧩 Estructura del Objeto informacoesIndicados
| Campo | Tipo | Descripción |
|---|---|---|
| cadastros | int32 | Cantidad de registros referidos. |
| visitas | int32 | Cantidad de visitas generadas. |
| conversoes | int32 | Cantidad de conversiones obtenidas. |
| valorTotal | number | Valor total relacionado (ej.: valor de las conversiones). |
| pendentes | int32 | Cantidad/valor pendiente (según contrato). |
| total | number | Valor/total de registros (según contrato). |
Solicitud
Parámetros de consulta
Respuestas
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/receivables?registrationDateStart=undefined®istrationDateEnd=undefined&dueDateStart=undefined&dueDateEnd=undefined&receivingDateStart=undefined&receivingDateEnd=undefined&competenceDateEnd=undefined&competenceDateStart=undefined&cancellationDateStart=undefined&cancellationDateEnd=undefined&chargeDateStart=undefined&chargeDateEnd=undefined&updateDateStart=undefined&updateDateEnd=undefined&description=undefined&ammountStart=undefined&ammountEnd=undefined&paymentTypes=undefined&accountStatus=undefined&take=undefined&skip=undefined&memberId=undefined&idSale=undefined&idReceivable=undefined&invoiceDateStart=undefined&invoiceDateEnd=undefined&invoiceCanceledDateStart=undefined&invoiceCanceledDateEnd=undefined&saleDateStart=undefined&saleDateEnd=undefined&idBranch=undefined'Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
{
"qtde": 0,
"lista": [
{
"idReceivable": 0,
"description": "string",
"registrationDate": "2019-08-24T14:15:22.123Z",
"dueDate": "2019-08-24T14:15:22.123Z",
"receivingDate": "2019-08-24T14:15:22.123Z",
"competenceDate": "2019-08-24T14:15:22.123Z",
"cancellationDate": "2019-08-24T14:15:22.123Z",
"ammount": 0,
"ammountPaid": 0,
"responsibles": [
{
"idResponsible": 0,
"idMember": 0,
"name": "string",
"cpf": "string",
"email": "string",
"phone": "string",
"observation": "string",
"idMemberResponsible": 0,
"acessFiti": true,
"financialResponsible": true,
"personType": "string",
"document": "string",
"cep": "string",
"adress": "string",
"number": "string",
"complement": "string",
"district": "string",
"city": "string",
"state": "string"
}
],
"status": {
"id": 0,
"name": "string"
},
"currentInstallment": 0,
"totalInstallments": 0,
"authorization": "string",
"payerName": "string",
"idMemberPayer": 0,
"idProspectPayer": 0,
"idBranchMember": 0,
"idResponsible": 0,
"idMemberResponsible": 0,
"cpfResponsible": "string",
"idSale": 0,
"bankAccount": {
"id": 0,
"name": "string"
},
"paymentType": {
"id": 0,
"name": "string"
},
"invoiceDetails": [
{
"invoiceNumber": "string",
"issuedAmount": 0,
"status": "string",
"sendDate": "2019-08-24T14:15:22.123Z",
"canceledDate": "2019-08-24T14:15:22.123Z",
"urlPdf": "string",
"idInvoiceType": 0,
"invoiceType": "string"
}
],
"fees": 0,
"conciliated": true,
"logTef": {
"authorization": "string",
"tefId": "string",
"merchantCheckoutGuid": "string"
},
"tid": "string",
"nsu": "string",
"updateDate": "2019-08-24T14:15:22.123Z",
"chargeDate": "2019-08-24T14:15:22.123Z",
"idReceivableFrom": 0,
"transactionToken": "string",
"idRevenueCenter": 0,
"cardAcquirer": "string",
"cardFlag": "string",
"creditDetails": [
{
"idCredit": 0,
"idCancelationCredit": 0,
"idBranchOrigin": 0,
"ammount": 0,
"branchDocument": "string",
"idSaleOrigin": 0,
"idReceivableOrigin": 0
}
],
"cancellationDescription": "string",
"source": "string",
"saleDate": "2019-08-24T14:15:22.123Z"
}
],
"list": [
{
"idReceivable": 0,
"description": "string",
"registrationDate": "2019-08-24T14:15:22.123Z",
"dueDate": "2019-08-24T14:15:22.123Z",
"receivingDate": "2019-08-24T14:15:22.123Z",
"competenceDate": "2019-08-24T14:15:22.123Z",
"cancellationDate": "2019-08-24T14:15:22.123Z",
"ammount": 0,
"ammountPaid": 0,
"responsibles": [
{
"idResponsible": 0,
"idMember": 0,
"name": "string",
"cpf": "string",
"email": "string",
"phone": "string",
"observation": "string",
"idMemberResponsible": 0,
"acessFiti": true,
"financialResponsible": true,
"personType": "string",
"document": "string",
"cep": "string",
"adress": "string",
"number": "string",
"complement": "string",
"district": "string",
"city": "string",
"state": "string"
}
],
"status": {
"id": 0,
"name": "string"
},
"currentInstallment": 0,
"totalInstallments": 0,
"authorization": "string",
"payerName": "string",
"idMemberPayer": 0,
"idProspectPayer": 0,
"idBranchMember": 0,
"idResponsible": 0,
"idMemberResponsible": 0,
"cpfResponsible": "string",
"idSale": 0,
"bankAccount": {
"id": 0,
"name": "string"
},
"paymentType": {
"id": 0,
"name": "string"
},
"invoiceDetails": [
{
"invoiceNumber": "string",
"issuedAmount": 0,
"status": "string",
"sendDate": "2019-08-24T14:15:22.123Z",
"canceledDate": "2019-08-24T14:15:22.123Z",
"urlPdf": "string",
"idInvoiceType": 0,
"invoiceType": "string"
}
],
"fees": 0,
"conciliated": true,
"logTef": {
"authorization": "string",
"tefId": "string",
"merchantCheckoutGuid": "string"
},
"tid": "string",
"nsu": "string",
"updateDate": "2019-08-24T14:15:22.123Z",
"chargeDate": "2019-08-24T14:15:22.123Z",
"idReceivableFrom": 0,
"transactionToken": "string",
"idRevenueCenter": 0,
"cardAcquirer": "string",
"cardFlag": "string",
"creditDetails": [
{
"idCredit": 0,
"idCancelationCredit": 0,
"idBranchOrigin": 0,
"ammount": 0,
"branchDocument": "string",
"idSaleOrigin": 0,
"idReceivableOrigin": 0
}
],
"cancellationDescription": "string",
"source": "string",
"saleDate": "2019-08-24T14:15:22.123Z"
}
],
"ids": [
{
"idReceivable": 0,
"description": "string",
"registrationDate": "2019-08-24T14:15:22.123Z",
"dueDate": "2019-08-24T14:15:22.123Z",
"receivingDate": "2019-08-24T14:15:22.123Z",
"competenceDate": "2019-08-24T14:15:22.123Z",
"cancellationDate": "2019-08-24T14:15:22.123Z",
"ammount": 0,
"ammountPaid": 0,
"responsibles": [
{
"idResponsible": 0,
"idMember": 0,
"name": "string",
"cpf": "string",
"email": "string",
"phone": "string",
"observation": "string",
"idMemberResponsible": 0,
"acessFiti": true,
"financialResponsible": true,
"personType": "string",
"document": "string",
"cep": "string",
"adress": "string",
"number": "string",
"complement": "string",
"district": "string",
"city": "string",
"state": "string"
}
],
"status": {
"id": 0,
"name": "string"
},
"currentInstallment": 0,
"totalInstallments": 0,
"authorization": "string",
"payerName": "string",
"idMemberPayer": 0,
"idProspectPayer": 0,
"idBranchMember": 0,
"idResponsible": 0,
"idMemberResponsible": 0,
"cpfResponsible": "string",
"idSale": 0,
"bankAccount": {
"id": 0,
"name": "string"
},
"paymentType": {
"id": 0,
"name": "string"
},
"invoiceDetails": [
{
"invoiceNumber": "string",
"issuedAmount": 0,
"status": "string",
"sendDate": "2019-08-24T14:15:22.123Z",
"canceledDate": "2019-08-24T14:15:22.123Z",
"urlPdf": "string",
"idInvoiceType": 0,
"invoiceType": "string"
}
],
"fees": 0,
"conciliated": true,
"logTef": {
"authorization": "string",
"tefId": "string",
"merchantCheckoutGuid": "string"
},
"tid": "string",
"nsu": "string",
"updateDate": "2019-08-24T14:15:22.123Z",
"chargeDate": "2019-08-24T14:15:22.123Z",
"idReceivableFrom": 0,
"transactionToken": "string",
"idRevenueCenter": 0,
"cardAcquirer": "string",
"cardFlag": "string",
"creditDetails": [
{
"idCredit": 0,
"idCancelationCredit": 0,
"idBranchOrigin": 0,
"ammount": 0,
"branchDocument": "string",
"idSaleOrigin": 0,
"idReceivableOrigin": 0
}
],
"cancellationDescription": "string",
"source": "string",
"saleDate": "2019-08-24T14:15:22.123Z"
}
],
"informacoesIndicados": {
"cadastros": 0,
"visitas": 0,
"conversoes": 0,
"valorTotal": 0,
"pendentes": 0,
"total": 0
},
"idUltimaConciliacao": 0
}Modificado en 2026-05-15 13:34:34