Obter Lista de Recebíveis

Descrição

Retorna a lista de contas a receber (receivables) com filtros avançados por datas, valores, tipos de pagamento, status, vendas, membro, faturas e paginação. A resposta contém coleções com os registros (lista, list, ids — que possuem a mesma estrutura de objeto), a quantidade (qtde), informações resumidas de indicadores (informacoesIndicados) e o último id de conciliação (idUltimaConciliacao).

Parâmetros

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.

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

Resposta

A resposta possui contadores/coleções e objetos detalhados de cada receivable.

Campo	Tipo	Descrição
qtde	int32	Quantidade total de registros retornados (count).
lista	array	Coleção principal de receivables (objetos com estrutura detalhada abaixo).
list	array	Coleção (mesma estrutura que lista) — mantida no contrato.
ids	array	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.

Observação: 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.
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.
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	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	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 `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).

Exemplo de Resposta

{
  "qtde": 0,
  "lista": [
    {
      "idReceivable": 0,
      "description": "string",
      "registrationDate": "2025-08-10T00:15:06.047Z",
      "dueDate": "2025-08-10T00:15:06.047Z",
      "receivingDate": "2025-08-10T00:15:06.047Z",
      "competenceDate": "2025-08-10T00:15:06.047Z",
      "cancellationDate": "2025-08-10T00:15:06.047Z",
      "ammount": 0,
      "ammountPaid": 0,
      "status": {
        "id": 0,
        "name": "string"
      },
      "currentInstallment": 0,
      "totalInstallments": 0,
      "authorization": "string",
      "payerName": "string",
      "idMemberPayer": 0,
      "idProspectPayer": 0,
      "idBranchMember": 0,
      "idSale": 0,
      "bankAccount": {
        "id": 0,
        "name": "string"
      },
      "paymentType": {
        "id": 0,
        "name": "string"
      },
      "invoiceDetails": [
        {
          "invoiceNumber": "string",
          "issuedAmount": 0,
          "status": "string",
          "sendDate": "2025-08-10T00:15:06.047Z",
          "canceledDate": "2025-08-10T00:15:06.047Z",
          "urlPdf": "string",
          "idInvoiceType": 0,
          "invoiceType": "string"
        }
      ],
      "fees": 0,
      "conciliated": true,
      "logTef": {
        "authorization": "string",
        "tefId": "string",
        "merchantCheckoutGuid": "string"
      },
      "tid": "string",
      "nsu": "string",
      "updateDate": "2025-08-10T00:15:06.047Z",
      "chargeDate": "2025-08-10T00:15:06.047Z",
      "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": "2025-08-10T00:15:06.047Z"
    }
  ],
  "list": [
    {
      "idReceivable": 0,
      "description": "string",
      "registrationDate": "2025-08-10T00:15:06.047Z",
      "dueDate": "2025-08-10T00:15:06.047Z",
      "receivingDate": "2025-08-10T00:15:06.048Z",
      "competenceDate": "2025-08-10T00:15:06.048Z",
      "cancellationDate": "2025-08-10T00:15:06.048Z",
      "ammount": 0,
      "ammountPaid": 0,
      "status": {
        "id": 0,
        "name": "string"
      },
      "currentInstallment": 0,
      "totalInstallments": 0,
      "authorization": "string",
      "payerName": "string",
      "idMemberPayer": 0,
      "idProspectPayer": 0,
      "idBranchMember": 0,
      "idSale": 0,
      "bankAccount": {
        "id": 0,
        "name": "string"
      },
      "paymentType": {
        "id": 0,
        "name": "string"
      },
      "invoiceDetails": [
        {
          "invoiceNumber": "string",
          "issuedAmount": 0,
          "status": "string",
          "sendDate": "2025-08-10T00:15:06.048Z",
          "canceledDate": "2025-08-10T00:15:06.048Z",
          "urlPdf": "string",
          "idInvoiceType": 0,
          "invoiceType": "string"
        }
      ],
      "fees": 0,
      "conciliated": true,
      "logTef": {
        "authorization": "string",
        "tefId": "string",
        "merchantCheckoutGuid": "string"
      },
      "tid": "string",
      "nsu": "string",
      "updateDate": "2025-08-10T00:15:06.048Z",
      "chargeDate": "2025-08-10T00:15:06.048Z",
      "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": "2025-08-10T00:15:06.048Z"
    }
  ],
  "ids": [
    {
      "idReceivable": 0,
      "description": "string",
      "registrationDate": "2025-08-10T00:15:06.048Z",
      "dueDate": "2025-08-10T00:15:06.048Z",
      "receivingDate": "2025-08-10T00:15:06.048Z",
      "competenceDate": "2025-08-10T00:15:06.048Z",
      "cancellationDate": "2025-08-10T00:15:06.048Z",
      "ammount": 0,
      "ammountPaid": 0,
      "status": {
        "id": 0,
        "name": "string"
      },
      "currentInstallment": 0,
      "totalInstallments": 0,
      "authorization": "string",
      "payerName": "string",
      "idMemberPayer": 0,
      "idProspectPayer": 0,
      "idBranchMember": 0,
      "idSale": 0,
      "bankAccount": {
        "id": 0,
        "name": "string"
      },
      "paymentType": {
        "id": 0,
        "name": "string"
      },
      "invoiceDetails": [
        {
          "invoiceNumber": "string",
          "issuedAmount": 0,
          "status": "string",
          "sendDate": "2025-08-10T00:15:06.048Z",
          "canceledDate": "2025-08-10T00:15:06.048Z",
          "urlPdf": "string",
          "idInvoiceType": 0,
          "invoiceType": "string"
        }
      ],
      "fees": 0,
      "conciliated": true,
      "logTef": {
        "authorization": "string",
        "tefId": "string",
        "merchantCheckoutGuid": "string"
      },
      "tid": "string",
      "nsu": "string",
      "updateDate": "2025-08-10T00:15:06.048Z",
      "chargeDate": "2025-08-10T00:15:06.048Z",
      "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": "2025-08-10T00:15:06.048Z"
    }
  ],
  "informacoesIndicados": {
    "cadastros": 0,
    "visitas": 0,
    "conversoes": 0,
    "valorTotal": 0,
    "pendentes": 0,
    "total": 0
  },
  "idUltimaConciliacao": 0
}

Obter Lista de Recebíveis

Descrição

Parâmetros

Tipos de Pagamento paymentTypes

Status da Conta accountStatus

Resposta

Estrutura dos Objetos lista, list, ids

Estrutura do Objeto invoiceDetails

Estrutura do Objeto logTef

Estrutura do Objeto creditDetails

Estrutura do Objeto informacoesIndicados