Taxas Adicionais de Rateio

• Listar
• Pegar
• Criar
• Atualizar
• Remover

Listar

Endpoint que lista todas as taxas adicionais de rateio.

Parameters

apportionment_id: 1 (required, integer) - "Filtra por Id do rateio.",
_sort: 'id' (string) ('id', 'period', 'name', 'value') - "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."

Response

{success} Response 200 (application/json)

{
  "items": [
    {
      "id": 1,
      "apportionment_id": 1,
      "division_type": {
        "id": 1,
        "name": "Proporcional pelo consumo"
      },
      "name": "Test",
      "period": "2021-05-01",
      "value": 88.88
    },
    {
      "id": 2,
      "apportionment_id": 1,
      "division_type": {
        "id": 3,
        "name": "Valor fixo em porcentagem por CDC"
      },
      "name": "Test 2",
      "period": "2021-05-01",
      "value": 88.88
    }
  ],
  "total": 2,
  "per_page": 10,
  "current_page": 1
}

{primary} Response 204 (application/json).

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

Pegar

Endpoint que pega uma taxa adicional específica.

Parameters

id: 1 (integer) - "Id da taxa adicional"

Response

{success} Response 200 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "division_type": {
    "id": 1,
    "name": "Proporcional pelo consumo"
  },
  "name": "Test",
  "period": "2021-05-01",
  "value": 88.88
}

{warning} Response 400 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Criar

Endpoint que cria uma taxa adicional de rateio.

Attributes

apportionment_id: 1 (integer, required) - "Id do rateio.",
division_type_id: 1 (integer, required) - "Id do tipo de divisão da taxa adicional.",
name: "Test" (string, required) - "Nome da taxa.",
period: '2021-05-01' (string, required) - "Período de referência, sendo sempre no dia 1. Formato Y-m-d.",
value: 88.88 (float, required) - "Valor da taxa"

Response

{success} Response 201 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "division_type": {
    "id": 1,
    "name": "Proporcional pelo consumo"
  },
  "name": "Test",
  "period": "2021-05-01",
  "value": 88.88
}

{warning} Response 400 (application/json)

Quando der algum erro no cadastro.

Atualizar

Endpoint que atualiza uma taxa adicional.

Parameters

id: 1 (integer) - "Id da taxa adicional"

Attributes

division_type_id: 1 (integer) - "Id do tipo de divisão da taxa adicional.",
name: "Test" (string) - "Nome da taxa.",
period: '2021-06-01' (string) - "Período de referência, sendo sempre no dia 1. Formato Y-m-d.",
value: 88.88 (float) - "Valor da taxa"

Response

{success} Response 200 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "division_type": {
    "id": 1,
    "name": "Proporcional pelo consumo"
  },
  "name": "Test",
  "period": "2021-06-01",
  "value": 88.88
}

{warning} Response 400 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Deletar

Endpoint que deleta uma taxa adicional.

Parameters

id: 1 (integer) - "Id da taxa adicional"

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.