7. Consulta Receitas

Endpoint

POST https://cashtrack.com.br/api/cliente/show/receitas?page=1

Headers

Accept: application/json
Content-Type: application/json
Authorization: Bearer {{SEU_TOKEN}}

Corpo da Requisição (Request Body)

json

{
  "id": null,
  "data_inicial": "",
  "data_final": "",
  "valor": "",
  "situacao": "",
  "forma_pagamento": "",
  "empresa": "",
  "banco": "",
  "cliente":""
}

• id (opcional): ID da receita.

• data_inicial e data_final: filtro para a coluna data_lancamento (formato dd/mm/aaaa) sendo a data inicial e final da tabela ''receitas''.

• valor: filtra por valor (na base 100), considerando o valor da coluna "valor" na tabela "receitas".

• situacao: Indica a situação da receita podendo ser filtrado pelo ID (1,2,3 ou 4) ou pelas situações, sendo elas:

  • pago

  • recebido

  • a_receber

  • a_pagar

• forma_pagamento: Indica a forma de pagamento podendo ser filtrado pelo ID (1,2,3,4,5,6 ou 7) ou pelas formas de pagamento, sendo elas:

  • pix

  • boleto

  • cartao

  • dinheiro

  • transferencia

  • cheque

  • debito_automatico

• empresa: filtro pelo apelido da empresa (modo like) ou filtro pelo ID da empresa quando o campo conter apenas números.

• banco: filtro pelo ID do banco quando o campo conter apenas números ou filtro em modo like pelo nome/apelido do banco, caso apelido seja null o filtro será aplicado pelo nome do banco.

• cliente : filtro pelo apelido do cliente (modo like) ou filtro pelo ID do cliente quando o campo conter apenas números.

Exemplo de Resposta

json

{
  "current_page": 1,
  "data": [
      {
        "id": 37343,
        "empresa_id": 949,
        "data_lancamento": "28/01/2025",
        "situacao": 3,
        "valor": "1180.29",
        "forma_pagamento": 2,
        "cliente_id": 4745,
        "related_id": null,
        "categoria_id": 84200,
        "banco_id": 1488,
        "parcelamento": 1,
        "numero_parcelas": 2,
        "detalhes": "BOLETO 110\nNFs 107",
        "centro_id": null,
        "numero_parcelas_recorrencia": null
    },
    {
        "id": 37344,
        "empresa_id": 949,
        "data_lancamento": "28/02/2025",
        "situacao": 3,
        "valor": "1180.29",
        "forma_pagamento": 2,
        "cliente_id": 4745,
        "related_id": null,
        "categoria_id": 84200,
        "banco_id": 1488,
        "parcelamento": 1,
        "numero_parcelas": 2,
        "detalhes": "BOLETO 110\nNFs 107",
        "centro_id": 941,
        "numero_parcelas_recorrencia": null
    }
    // ...demais registros
  ],
  "first_page_url": "https://cashtrack.com.br/api/cliente/show/receitas?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://cashtrack.com.br/api/cliente/show/receitas?page=1",
  "links": [...],
  "next_page_url": null,
  "path": "https://cashtrack.com.br/api/cliente/show/receitas",
  "per_page": 25,
  "prev_page_url": null,
  "to": 4,
  "total": 4
}