# Lista de transações financeiras

Retorna lista das transações financeiras (Contas a pagar e Contas a receber).

Endpoint: GET /api/v3/financial/transactions
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `financial_transactions_id` (string)
    Filtra pelos IDs das transações financeiras. Pode passar mais de um ID alfanumérico separado por virgula.
    Example: "696e636f6d657c3235"

  - `type` (string)
    Filtra pelo tipo da transação financeira.

Exemplo:

  - income: Receita
  - expense: Despesa
    Enum: "income", "expense"

  - `date_fields` (string)
    Determina o campo de data que será utilizado para filtrar as transações financeiras nos campos date_start e date_end. Pode passar mais de um separado por virgula.
    Enum: "due_date", "payment_date", "competence_date"

  - `date_start` (string)
    Data inicial para filtrar as transações financeiras.
    Example: "2025-01-01"

  - `date_end` (string)
    Data final para filtrar as transações financeiras.
    Example: "2025-01-01"

  - `status` (string)
    Filtra pelo status da transação financeira.

Exemplo:

  - paid: Pago
  - unpaid: Não pago
  - partially_paid: Parcialmente pago
    Enum: "paid", "unpaid", "partially_paid"

  - `description` (string)
    Descrição da transação financeira.
    Example: "Compra de equipamentos"

  - `account_plan_id` (number)
    Indica o ID do plano de contas.
    Example: 134

  - `bank_account_id` (number)
    Filtra pelo ID da conta bancária.
    Example: 134

  - `cost_center_id` (number)
    Filtra pelo ID do centro de custo.
    Example: 134

  - `payment_method_id` (number)
    Filtra pelo ID do método de pagamento.
    Example: 134

  - `card_brand_id` (number)
    Filtra pelo ID da bandeira de cartão.
    Example: 134

  - `customer_id` (number)
    Filtra pelo ID do cliente.
    Example: 134

  - `supplier_id` (number)
    Filtra pelo ID do fornecedor.
    Example: 134

  - `transfer` (string)
    Filtro para determinar a inclusão de registros de transferência.

- include: Inclui todos os registros, independente de ser de transferência ou não.
- not_include: Oculta os registros de transferência.
- only: Exibe apenas os registros de transferência.
    Enum: "not_include", "include", "only"

  - `min_value` (number)
    Valor mínimo para filtrar as transações financeiras.
    Example: 100.5

  - `max_value` (number)
    Valor máximo para filtrar as transações financeiras.
    Example: 1000

  - `is_to_hide_pos_bank_account` (integer)
    Filtro para ocultar contas bancárias do PDV.

- 0 (false): Exibe todas as transações, incluindo as de contas bancárias do PDV
- 1 (true): Oculta as transações cujas contas bancárias são do PDV
    Enum: 0, 1

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.financial_transactions` (array)
    Representa a lista de transações financeiras

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields