# Cria um filtro

Cria um novo filtro salvo para uma área específica do sistema.

Endpoint: POST /api/v3/filters
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

  - `Idempotency-Key` (string, required)
    UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro.

## Request fields (application/json):

  - `name` (string, required)
    Nome do filtro.
    Example: "Extrato financeiro do ultimo mês"

  - `system_area` (string, required)
    Área do sistema à qual o filtro se aplica. Nem todas as áreas estão disponíveis no momento.

Observação: Este campo é obrigatório apenas na criação. Na atualização ele é ignorado.

- extract: Extrato
    Enum: "extract"

  - `filters` (object, required)
    Configuração dos filtros aplicados. O mesmo padrão de validação do relatório relacionado.

- extract: /api/v3/financial/transactions
    Example: {"type":"income","date_start":"2024-01-01","date_end":"2024-01-31"}

## Response 201 fields (application/json):

  - `id` (integer)
    Identificador único do filtro.
    Example: 123

  - `name` (string, required)
    Nome do filtro.
    Example: "Extrato financeiro do ultimo mês"

  - `system_area` (string, required)
    Área do sistema à qual o filtro se aplica. Nem todas as áreas estão disponíveis no momento.

- extract: Extrato
    Enum: "extract"

  - `filters` (object, required)
    Configuração dos filtros aplicados. O mesmo padrão de validação do relatório relacionado.

- extract: /api/v3/financial/transactions
    Example: {"type":"income","date_start":"2024-01-01","date_end":"2024-01-31"}

  - `created_at` (string)
    Data e hora de criação do filtro.
    Example: "2024-01-15T10:30:00Z"

  - `updated_at` (string)
    Data e hora da última atualização do filtro.
    Example: "2024-01-15T14:45:00Z"

## 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 403 fields