Get receivables

GET https://evo-integracao-api.w12app.com.br/api/v1/receivables

Obter Lista de Recebíveis

Descrição

Recupera uma lista de recebíveis com informações detalhadas, incluindo status, valores, pagador e outros dados relevantes.

---

Parâmetros

Parâmetro	Tipo	Descrição
registrationDateStart	Datetime (yyyy-mm-ddThh:mm)	Data inicial de lançamento.
registrationDateEnd	Datetime (yyyy-mm-ddThh:mm)	Data final de lançamento.
dueDateStart	Datetime (yyyy-mm-ddThh:mm)	Data inicial de vencimento do recebimento.
dueDateEnd	Datetime (yyyy-mm-ddThh:mm)	Data final de vencimento do recebimento.
receivingDateStart	Datetime (yyyy-mm-ddThh:mm)	Data inicial de recebimento efetivo.
receivingDateEnd	Datetime (yyyy-mm-ddThh:mm)	Data final de recebimento efetivo.
competenceDateStart	Datetime (yyyy-mm-ddThh:mm)	Data inicial do período de competência.
competenceDateEnd	Datetime (yyyy-mm-ddThh:mm)	Data final do período de competência.
chargeDateStart	Datetime (yyyy-mm-ddThh:mm)	Data inicial de cobrança do aluno
chargeDateStart	Datetime (yyyy-mm-ddThh:mm)	Data final de cobrança do aluno
ammountStart	Double	Valor mínimo do recebível.
ammountEnd	Double	Valor máximo do recebível.
paymentTypes	Int32	Lista de IDs separados por vírgula dos tipos de pagamento (Ex: 1,2,3).
accountStatus	String	Status da conta (ex.: ativo, pendente, cancelado).
take	Int32	Quantidade de registros retornados.
skip	Int32	Quantidade de registros ignorados.
idSale	Int32	ID da venda associada ao recebimento.
idReceivable	Int32	ID único do recebível.
saleDateStart	Datetime (yyyy-mm-ddThh:mm)	Data inicial da venda associada.
saleDateEnd	Datetime (yyyy-mm-ddThh:mm)	Data final da venda associada.

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

---

Resposta

A resposta é um array de objetos com a seguinte estrutura:

Campo	Tipo	Descrição
idReceivable	inteiro	Identificador único do recebível.
description	string	Descrição detalhada do recebível.
registrationDate	string	Data de registro do recebível no sistema.
dueDate	string	Data de vencimento do recebível.
receivingDate	string	Data de recebimento do pagamento, se aplicável.
competenceDate	string	Data de competência associada ao recebível.
cancellationDate	string	Data de cancelamento do recebível, se aplicável.
ammount	float	Valor total do recebível.
ammountPaid	float	Valor pago até o momento.
status	objeto	Objeto contendo o status do recebível.
status.id	inteiro	Identificador do status do recebível.
status.name	string	Nome do status do recebível.
payerName	string	Nome do pagador.
idSale	inteiro	Identificador da venda associada ao recebimento.
paymentType	objeto	Tipo de pagamento do recebível.
paymentType.id	inteiro	Identificador do tipo de pagamento.
paymentType.name	string	Nome do tipo de pagamento.
updateDate	string	Data da última atualização do recebível.
saleDate	string	Data da venda associada.

---

Estrutura do Objeto status

Campo	Tipo	Descrição
id	inteiro	Identificador do status.
name	string	Nome do status do recebível.

Estrutura do Objeto paymentType

Campo	Tipo	Descrição
id	inteiro	Identificador do tipo de pagamento.
name	string	Nome do tipo de pagamento.

---

Exemplo de Resposta

JSON

[
  {
    "idReceivable": 306846,
    "description": "Cartão de Crédito 12/12",
    "registrationDate": "2023-10-20T19:54:58",
    "dueDate": "2024-10-14T00:00:00",
    "receivingDate": null,
    "competenceDate": "2023-10-20T19:54:58",
    "cancellationDate": "2023-11-17T04:33:19",
    "ammount": 199.13,
    "ammountPaid": 193.57,
    "status": {
      "id": 3,
      "name": "Canceled"
    },
    "payerName": "Gregory Phillips",
    "idSale": 208692,
    "paymentType": {
      "id": 2,
      "name": "Credit card"
    },
    "updateDate": "2023-10-20T19:56:39",
    "saleDate": "2023-10-20T19:54:58"
  }
]