Configurações de Rateios

Detalhes

Endpoint que retorna uma configuração de rateio específico.

Method URI Headers Authorization
GET /api/v3/apportionment-settings/{apportionmentId} Content-Type:application/json Authorization: Bearer {token}

Parameters

apportionmentId: 1 (integer, required) - "Id do Rateio"

Response

{success} Response 200 (application/json)

{
  "id": 22,
  "apportionment_id": 1,
  "distributor": {
    "id": 1,
    "name": "Distribuidora"
  },
  "voltage_class": {
    "id": 1,
    "name": "A1"
  },
  "tariff_modality": {
    "id": 1,
    "name": "Verde"
  },
  "icms": 1,
  "pis_cofins": 1.1
}

{primary} Response 204 (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 configuração de rateio.

Method URI Headers Authorization
POST /api/v3/apportionment-settings Content-Type:application/json Authorization: Bearer {token}

Attributes

apportionment_id: 1 (integer, required) - "Id do rateio.",
distributor_id: 1 (integer, required) - "Id do distribuidor.",
voltage_class_id: 3 (integer) - "Id da classe de voltagem.",
tariff_modality_id: 1 (integer) - "Id da modalidade tarifária.",
icms: 1.0 (decimal) - "Valor do ICMS.",
pis_cofins: 1.0 (decimal) - "Valor do Pis/Cofins."

Response

{success} Response 201 (application/json)

{
  "id": 22,
  "apportionment_id": 1,
  "distributor": {
    "id": 1,
    "name": "Distribuidora"
  },
  "voltage_class": {
    "id": 1,
    "name": "A1"
  },
  "tariff_modality": {
    "id": 1,
    "name": "Verde"
  },
  "icms": 1,
  "pis_cofins": 1.1
}

Atualizar

Endpoint que atualiza uma configuração de rateio.

Method URI Headers Authorization
PUT /api/v3/apportionment-settings/{apportionmentId} Content-Type:application/json Authorization: Bearer {token}

Parameters

apportionmentId: 1 (integer, required) - "Id do Rateio"

Attributes

distributor_id: 1 (integer, required) - "Id do distribuidor.",
voltage_class_id: null (integer) - "Id da classe de voltagem.",
tariff_modality_id: null (integer) - "Id da modalidade tarifária.",
icms: 1 (decimal) - "Valor do ICMS.",
pis_cofins: 1.1 (decimal) - "Valor do Pis/Cofins."

Response

{success} Response 200 (application/json)

{
  "id": 20,
  "apportionment_id": 2,
  "distributor": {
    "id": 1,
    "name": "Distribuidora"
  },
  "voltage_class": {
    "id": 1,
    "name": "A1"
  },
  "tariff_modality": {
    "id": 1,
    "name": "Verde"
  },
  "icms": 85.19,
  "pis_cofins": 11.82
}

{warning} Response 400 (application/json)

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

{warning} Response 422 (application/json)

Quando o rateio não existir ou os parâmetros não forem enviados corretamente.

[
    "Houve um problema ao buscar este registro."
]
{
    "distributor_id": [
        "O campo distributor id selecionado é inválido."
    ],
    "icms": [
        "O campo icms deve ser um número."
    ],
    "pis_cofins": [
        "O campo pis cofins deve ser um número."
    ]
}

Deletar

Endpoint que deleta uma configuração de rateio.

Method URI Headers Authorization
DELETE /api/v3/apportionment-settings/{apportionmentId} Content-Type:application/json Authorization: Bearer {token}

Parameters

apportionmentId: 1 (integer, required) - "Id do Rateio"

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.

{warning} Response 400 (application/json)

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