Get receivables
GET
https://evo-integracao-api.w12app.com.br/api/v1/receivables
🌐 API Reference/Receivables
Obter Lista de Recebíveis
Descrição
🔑 Parâmetros de Consulta (Query Params)
| Parâmetro | Tipo | Descrição |
|---|---|---|
| registrationDateStart | Datetime (yyyy-mm-dd) | Data inicial de registro. |
| registrationDateEnd | Datetime (yyyy-mm-dd) | Data final de registro. |
| dueDateStart | Datetime (yyyy-mm-dd) | Data de vencimento inicial. |
| dueDateEnd | Datetime (yyyy-mm-dd) | Data de vencimento final. |
| receivingDateStart | Datetime (yyyy-mm-dd) | Data inicial de recebimento efetivo. |
| receivingDateEnd | Datetime (yyyy-mm-dd) | Data final de recebimento efetivo. |
| competenceDateStart | Datetime (yyyy-mm-dd) | Data inicial do período de competência. |
| competenceDateEnd | Datetime (yyyy-mm-dd) | Data final do período de competência. |
| cancellationDateStart | Datetime (yyyy-mm-dd) | Data inicial de cancelamento. |
| cancellationDateEnd | Datetime (yyyy-mm-dd) | Data final de cancelamento. |
| chargeDateStart | Datetime (yyyy-mm-dd) | Data inicial da cobrança. |
| chargeDateEnd | Datetime (yyyy-mm-dd) | Data final da cobrança. |
| updateDateStart | Datetime (yyyy-mm-dd) | Data inicial de atualização. |
| updateDateEnd | Datetime (yyyy-mm-dd) | Data final de atualização. |
| description | string | Descrição. |
| ammountStart | number (double) | Filtrar pelo valor mínimo. |
| ammountEnd | number (double) | Filtrar pelo valor máximo. |
| paymentTypes | string | Lista de ids de tipos de pagamento (vírgula-separados). Veja mais a seguir. |
| accountStatus | string | Lista de status (vírgula-separados). Veja mais a seguir. |
| take | int32 | Total de registros a retornar (máximo 50). Default: 50. |
| skip | int32 | Total de registros a pular (paginação). Default: 0. |
| memberId | int32 | Id do membro. |
| idSale | int32 | Id da venda. |
| idReceivable | int32 | Id do recebível. |
| invoiceDateStart | Datetime (yyyy-mm-dd) | Data de emissão inicial da nota/fatura. |
| invoiceDateEnd | Datetime (yyyy-mm-dd) | Data de emissão final da nota/fatura. |
| invoiceCanceledDateStart | Datetime (yyyy-mm-dd) | Data inicial de cancelamento da fatura. |
| invoiceCanceledDateEnd | Datetime (yyyy-mm-dd) | Data final de cancelamento da fatura. |
| saleDateStart | Datetime (yyyy-mm-dd) | Data inicial da venda. |
| saleDateEnd | Datetime (yyyy-mm-dd) | Data final da venda. |
| idBranch | int32 | Filtrar pelo número da filial. |
🔷 Tipos de Pagamento paymentTypes
| ID | Tipo de Pagamento |
|---|---|
| 1 | Dinheiro |
| 2 | Cartão de Crédito |
| 3 | Cartão de Débito |
| 4 | Cheque |
| 5 | Boleto Bancário |
| 6 | PagSeguro |
| 7 | Depósito |
| 8 | Débito em Conta |
| 9 | Internet |
| 11 | Créditos de Venda |
| 12 | Cartão de Crédito Online |
| 13 | Transferência |
| 18 | Pix |
| 0 | Saldo Devedor |
🔷 Status da Conta accountStatus
| ID | Status |
|---|---|
| 1 | Em aberto |
| 2 | Recebido |
| 3 | Cancelado |
| 4 | Atrasado |
📤 Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| qtde | int32 | Quantidade total de registros retornados (count). |
| lista | array<object> | Coleção principal de receivables (objetos com estrutura detalhada abaixo). |
| list | array<object> | Coleção (mesma estrutura que lista) — mantida no contrato. |
| ids | array<object> | Coleção (mesma estrutura que lista) — mantida no contrato. |
| informacoesIndicados | object | Indicadores de indicação (cadastros, visitas, conversões, valores). |
| idUltimaConciliacao | int32 | ID da última conciliação. |
🚧 OBS. lista, list e ids retornam objetos com a mesma estrutura apresentada abaixo.
🧩 Estrutura dos Objetos lista, list, ids
| Campo | Tipo | Descrição |
|---|---|---|
| idReceivable | int32 | ID do receivable. |
| description | string | Descrição do item/lançamento. |
| registrationDate | Datetime (yyyy-mm-dd) | Data de registro do recebível. |
| dueDate | Datetime (yyyy-mm-dd) | Data de vencimento. |
| receivingDate | Datetime (yyyy-mm-dd) | Data de recebimento (quando houver). |
| competenceDate | Datetime (yyyy-mm-dd) | Data de competência. |
| cancellationDate | Datetime (yyyy-mm-dd) | Data de cancelamento (quando houver). |
| ammount | number | Valor do título. |
| ammountPaid | number | Valor já pago. |
| status | object | Objeto com id (int) e name (string) do status. |
| responsibles | array<object> | Detalhes de responsáveis. |
| currentInstallment | int32 | Parcela atual (ex.: 1). |
| totalInstallments | int32 | Total de parcelas. |
| authorization | string | Código/autorização. |
| payerName | string | Nome do pagador. |
| idMemberPayer | int32 | ID do membro pagador (se aplicável). |
| idProspectPayer | int32 | ID do prospect pagador (se aplicável). |
| idBranchMember | int32 | ID da filial do membro. |
| idResponsible | int32 | ID do responsável. |
| idMemberResponsible | int32 | ID do membro que atua como responsável. |
| cpfResponsible | string | CPF do responsável. |
| idSale | int32 | ID da venda associada. |
| bankAccount | object | Objeto { id:int, name:string } com conta bancária associada. |
| paymentType | object | Objeto { id:int, name:string } com o tipo de pagamento. |
| invoiceDetails | array<object> | Array com detalhes da(s) fatura(s). |
| fees | number | Taxas associadas. |
| conciliated | boolean | Indica se foi conciliado. |
| logTef | object | Objeto com log TEF { authorization, tefId, merchantCheckoutGuid }. |
| tid | string | ID TID (transação). |
| nsu | string | NSU da transação. |
| updateDate | Datetime (yyyy-mm-dd) | Data da última atualização do registro. |
| chargeDate | Datetime (yyyy-mm-dd) | Data de cobrança efetiva. |
| idReceivableFrom | int32 | ID do receivable de origem (em estornos/transferências). |
| transactionToken | string | Token de transação (quando aplicável). |
| idRevenueCenter | int32 | ID do centro de receitas associado. |
| cardAcquirer | string | Nome da adquirente do cartão. |
| cardFlag | string | Nome/bandeira do cartão. |
| creditDetails | array<object> | Detalhes de créditos vinculados. |
| cancellationDescription | string | Motivo/descritivo do cancelamento. |
| source | string | Origem do lançamento. |
| saleDate | Datetime (yyyy-mm-dd) | Data da venda associada. |
🧩 Estrutura do Objeto responsibles
| Campo | Tipo | Descrição |
|---|---|---|
| idResponsible | int32 | ID do responsável financeiro. |
| idMember | int32 | ID do membro ao qual o responsável está vinculado. |
| name | string | Nome do responsável. |
| cpf | string | CPF do responsável. |
| string | E-mail do responsável. | |
| phone | string | Telefone do responsável. |
| observation | string | Observações adicionais sobre o responsável. |
| idMemberResponsible | int32 | ID do membro que atua como responsável. |
| acessFiti | boolean | Indica se o responsável possui acesso ao Fiti. |
| financialResponsible | boolean | Indica se é o responsável financeiro. |
| personType | string | Tipo de pessoa do responsável (ex.: Física ou Jurídica). |
| document | string | Documento do responsável (CPF ou CNPJ, conforme o tipo de pessoa). |
🧩 Estrutura do Objeto invoiceDetails
| Campo | Tipo | Descrição |
|---|---|---|
| invoiceNumber | string | Número da nota/fatura. |
| issuedAmount | number | Valor emitido na fatura. |
| status | string | Status da fatura. |
| sendDate | Datetime (yyyy-mm-dd) | Data de envio da fatura. |
| canceledDate | Datetime (yyyy-mm-dd) | Data de cancelamento da fatura. |
| urlPdf | string | URL do PDF da fatura. |
| idInvoiceType | int32 | ID do tipo de fatura. |
| invoiceType | string | Descrição do tipo de fatura. |
🧩 Estrutura do Objeto logTef
| Campo | Tipo | Descrição |
|---|---|---|
| authorization | string | Código de autorização TEF. |
| tefId | string | ID TEF. |
| merchantCheckoutGuid | string | GUID do checkout do lojista. |
🧩 Estrutura do Objeto creditDetails
| Campo | Tipo | Descrição |
|---|---|---|
| idCredit | int32 | ID do crédito. |
| idCancelationCredit | int32 | ID do cancelamento do crédito (se houver). |
| idBranchOrigin | int32 | ID da filial de origem do crédito. |
| ammount | number | Valor do crédito. |
| branchDocument | string | Documento/identificador da filial. |
| idSaleOrigin | int32 | ID da venda de origem do crédito. |
| idReceivableOrigin | int32 | ID do receivable de origem associado ao crédito. |
🧩 Estrutura do Objeto informacoesIndicados
| Campo | Tipo | Descrição |
|---|---|---|
| cadastros | int32 | Quantidade de cadastros indicados. |
| visitas | int32 | Quantidade de visitas geradas. |
| conversoes | int32 | Quantidade de conversões obtidas. |
| valorTotal | number | Valor total relacionado (ex.: valor das conversões). |
| pendentes | int32 | Quantidade/valor pendente (conforme contrato). |
| total | number | Valor/contagem total (conforme contrato). |
Request
Query Params
Responses
Request Request Example
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' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 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
}Modified at 2026-05-15 04:38:45