Financeiro

A rota permite listar tanto um registro específico com base no ID fornecido quanto todos os registros da base de dados, oferecendo flexibilidade para consultar dados individuais ou uma visão completa dos itens disponíveis.

Introdução

Nesta documentação, detalhamos os campos que você pode esperar manipular ao interagir com a API. Cada campo é descrito para esclarecer sua função e o tipo de dado esperado, garantindo que você possa fornecer ou obter informações precisas.

Veja abaixo:

URLs

Método	URL	Ação	Descrição
GET	/api/v1/financial	Listar	Lista todos as movimentaçoes
GET	/api/v1/financial{id}	Visualizar	Exibe uma determinada movimentação pelo ID

Listar

Endpoint: /api/v1/financial

Método: GET

Retorna uma lista de todos as movimentações financeiras. Suporta busca e paginação para gerenciar grandes volumes de dados.

Ordenação

Para melhorar a experiência de visualização dos dados, oferecemos suporte à ordenação de registros. Você pode especificar a ordenação dos dados através de dois parâmetros:

Parâmetros:

• sort: Define a direção da ordenação. Valores permitidos: asc para ascendente, desc para descendente.
• field_sort: Especifica o campo pelo qual os registros devem ser ordenados.

Exemplo de Uso: Para ordenar as movimentações pelo ID em ordem ascendente: /api/v1/financial?field_sort=id&sort=asc

Paginação

A paginação é essencial para o gerenciamento eficiente dos dados, especialmente quando lidamos com grandes volumes. Cada página pode conter um número definido de registros, reduzindo o tempo de carregamento e melhorando a usabilidade.

Parâmetro:

• page: Número da página desejada.
• limit (opcional): Número de registros por página, o limite e de até 200 registros.

Exemplo de Uso: Para acessar a segunda página de registros: /api/v1/financial?page=2&limit=10

Resumo

Utilizar as funcionalidades de Ordenação, Paginação em conjunto permite uma manipulação eficiente e precisa dos dados na nossa API. Por exemplo, para listar movimentações ordenados pelo ID, e exibir apenas os primeiros 10 resultados, você pode usar a seguinte URL:

/api/v1/financial?field_sort=id&sort=desc&page=1&limit=10

Esta combinação otimiza suas consultas, permitindo que você obtenha dados específicos de forma rápida e organizada.

Response:

{
  "data": [
    {
      "id": "2673",
      "datapagamento": "2024-06-23",
      "datacompetencia": "2024-06-23",
      "tipocobranca": "Despesa",
      "idrecebidode": "4",
      "recebidode": "Fornecedores/Parceiros",
      "informede": "Jonathan Moreira",
      "descricao": "Pagamento fornecedor",
      "valor": "150.00",
      "juros": "0.00",
      "multa": "0.00",
      "desconto": "0.00",
      "pago": "nao",
      "idconta": "7",
      "conta": "Nubank",
      "idcategoria": "11",
      "categoria": "Não Informado",
      "idcentrodecusto": "12",
      "centrodecusto": "Não Informado",
      "mododepagamento": "Não Informado",
      "parcelas": null,
      "idevento": "2673",
      "evento": "Green Gold Plaza"
    }
  ],
  "pagination": {
    "page": 1, // Página atual
    "page_size": 200, // Quantidade de resgistros exibida por pagina
    "total_page": 1, // Quantidade de paginas no total
    "total_data": 1 // Quantidade total de registros encontrados
  }
}

Visualizar

Endpoint: /api/v1/financial/{id}

Método: GET

Para visualizar as informações de uma movimentação, você pode fazer uma solicitação GET para endpoint acima. Não é necessário fornecer informações no corpo da solicitação, já que você estará apenas recuperando dados. O ID do cliente a ser consultado deve ser especificado no endpoint.

Response:

{
  "id": "2673",
  "datapagamento": "2024-06-23",
  "datacompetencia": "2024-06-23",
  "tipocobranca": "Despesa",
  "idrecebidode": "4",
  "recebidode": "Fornecedores/Parceiros",
  "informede": "Jonathan Moreira",
  "descricao": "Pagamento fornecedor",
  "valor": "150.00",
  "juros": "0.00",
  "multa": "0.00",
  "desconto": "0.00",
  "pago": "nao",
  "idconta": "7",
  "conta": "Nubank",
  "idcategoria": "11",
  "categoria": "Não Informado",
  "idcentrodecusto": "12",
  "centrodecusto": "Não Informado",
  "mododepagamento": "Não Informado",
  "parcelas": null,
  "idevento": "2673",
  "evento": "Green Gold Plaza"
}