Porcentagem de Taxa por Centro de Custo

Listar

Endpoint que lista todas as porcentagem de uma taxa adicional de rateio e centro de custo.

Method URI Headers Authorization
GET /api/v3/cost-centers-percentage-fees Content-Type:application/json Authorization: Bearer {token}

Parameters

additional_fee_id: 1 (required, integer) - "Filtra por Id da taxa adicional de rateio.",
cost_center_id: 1 (integer) - "Filtra por Id do centro de custo.",
_sort: 'id' (string) ('id', 'percentage') - "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,
      "additional_fee_id": 1,
      "cost_center": {
        "id": 1,
        "name": "CDC 1"
      },
      "percentage": 88.88
    },
    {
      "id": 2,
      "additional_fee_id": 1,
      "cost_center": {
        "id": 2,
        "name": "CDC 2"
      },
      "percentage": 50
    }
  ],
  "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 porcentagem de uma taxa adicional de rateio e centro de custo.

Method URI Headers Authorization
GET /api/v3/cost-centers-percentage-fees/{id} Content-Type:application/json Authorization: Bearer {token}

Parameters

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

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "additional_fee_id": 1,
    "cost_center": {
        "id": 1,
        "name": "CDC1"
    },
    "percentage": 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 porcentagem de uma taxa adicional de rateio e centro de custo.

Method URI Headers Authorization
POST /api/v3/cost-centers-percentage-fees Content-Type:application/json Authorization: Bearer {token}

{info} Regras:
Apenas uma porcentagem por taxa adicional (período) e centro de custo.

Attributes

additional_fee_id: 1 (integer, required) - "Id da taxa adicional de rateio.",
cost_center_id: 1 (integer, required) - "Id do centro de custo.",
percentage: 88.88 (float, required) - "Valor fixo em porcentagem por centro de custo"

Response

{success} Response 201 (application/json)

{
    "id": 1,
    "additional_fee_id": 1,
    "cost_center": {
        "id": 1,
        "name": "CDC1"
    },
    "percentage": 88.88
}

{warning} Response 400 (application/json)

Quando der algum erro no cadastro.

Atualizar

Endpoint que atualiza uma porcentagem de uma taxa adicional de rateio e centro de custo.

Method URI Headers Authorization
PUT /api/v3/cost-centers-percentage-fees/{id} Content-Type:application/json Authorization: Bearer {token}

{info} Regras:
Apenas uma porcentagem por taxa adicional (período) e centro de custo.

Parameters

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

Attributes

additional_fee_id: 1 (integer) - "Id da taxa adicional de rateio.",
cost_center_id: 1 (integer) - "Id do centro de custo.",
percentage: 88.88 (float) - "Valor fixo em porcentagem por centro de custo"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "additional_fee_id": 1,
    "cost_center": {
        "id": 1,
        "name": "CDC1"
    },
    "percentage": 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 porcentagem de uma taxa adicional de rateio e centro de custo.

Method URI Headers Authorization
DELETE /api/v3/cost-centers-percentage-fees/{id} Content-Type:application/json Authorization: Bearer {token}

Parameters

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

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.