Medições - Impostos

• Listar
• Pegar
• Criar
• Atualizar
• Remover

Listar

Endpoint que lista os impostos da Medição.

Parameters

_sort: id (string) ("id", "initial_date") - "Define o campo de ordenação da lista."
_order: desc (string) ("asc", "desc") - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."
equipment_id: 1 (required, integer) - "Id do Equipamento",
tax_name: "ICMS" (string) - "Filtra pelo nome do Impostos. Valores permitidos: ICMS ou PIS_COFINS"

Response

{success} Response 200 (application/json)

{
    "items": [
        {
            "id": 2,
            "equipment_id": 1,
            "tax_name": "ICMS",
            "initial_date": "2024-12-31"
        },
        {
            "id": 6,
            "equipment_id": 1,
            "tax_name": "PIS_COFINS",
            "initial_date": "2025-01-03"
        }
    ],
    "total": 3,
    "per_page": 10,
    "current_page": 1,
    "last_page": 1
}

{primary} Response 204 (application/json)

Quando os critérios de parâmetros não contiver registros a serem retornados.

{warning} Response 422 (application/json)

{
    "equipment_id": [
        "O campo medição selecionada é inválida."
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Pegar

Endpoint que pega os dados de um imposto da medição.

Parameters

TaxId: 1 - (integer, required) - "Id do imposto"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "equipment_id": 1,
    "tax_name": "PIS_COFINS",
    "value": 58.16,
    "initial_date": "2024-08-02"
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Criar

Endpoint que cria um imposto para a medição.

Attributes

equipment_id: (required, integer) - "Id do Equipamento",
tax_name: (required, string) - "nome do Imposto. Valores permitidos: ICMS ou PIS_COFINS",
initial_date:  (required,date) = "Data de início da vigência do imposto",
value:  120 (required, float) - "Valor em porcentagem do imposto"

Response

{success} Response 201 (application/json)

{
    "equipment_id": 1,
    "tax_name": "PIS_COFINS",
    "initial_date": "2024-01-05",
    "value": 20,
    "id": 1
}

{warning} Response 422 (application/json)

{
    "equipment_id": [
        "O campo medição é obrigatório."
    ],
    "tax_name": [
        "O campo tax name é obrigatório."
    ],
    "initial_date": [
        "O campo data inicial é obrigatório."
    ],
    "value": [
        "O campo value é obrigatório."
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Atualizar

Endpoint que atualiza um imposto da medição.

Attributes

equipment_id: (integer) - "Id do Equipamento",
tax_name: (string) - "nome do Imposto. Valores permitidos: ICMS ou PIS_COFINS",
initial_date:  (required,date) = "Data de início da vigência do imposto",
value:  120 (float) - "Valor em porcentagem do imposto"

Response

{success} Response 200 (application/json)

{
    "equipment_id": 1,
    "tax_name": "PIS_COFINS",
    "initial_date": "2024-01-05",
    "value": 20,
    "id": 1
}

{warning} Response 422 (application/json)

{
    "equipment_id": [
        "O campo medição deve ser um número inteiro.",
        "Permissões insuficientes para esse grupo econômico"
    ],
    "value": [
        "O campo value deve ser um número inteiro."
    ],
    "days_week": [
        "O campo days week deve ser uma matriz."
    ],
    "initial_date": [
    "O campo data inicial não é uma data válida."
],
}

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.

Deletar

Endpoint que deleta um imposto da medição.

Response

{primary} Response 204 (application/json)

Quando o registro for excluido com sucesso.

{warning} Response 400 (application/json)

Quando ocorre algum erro ou usuário não tem permissão.