# `Nfse.Schema.V1_01.TCBeneficioMunicipal`
[🔗](https://github.com/ideia4it/nfse/blob/v0.1.0/lib/nfse/schema/v1_01/tc_beneficio_municipal.ex#L2)

Tipo `TCBeneficioMunicipal` do leiaute 1.01, em `tiposComplexos_v1.01.xsd`.

| Campo | XML | Tipo | Ocorrência | Descrição |
|---|---|---|---|---|
| `n_bm` | `nBM` | `TSNumBeneficioMunicipal` | 1 | Identificador do benefício parametrizado pelo município. Trata-se de um identificador único que foi gerado pelo Sistema Nacional no momento em que o município de incidência do ISSQN incluiu o benefício no sistema. Critério de formação do número de identificação de parâmetros municipais: 7 dígitos - posição 1 a 7: número identificador do Município, conforme código IBGE; 2 dígitos - posições 8 e 9 : número identificador do tipo de parametrização (01-legislação, 02-regimes especiais, 03-retenções, 04-outros benefícios); 5 dígitos - posição 10 a 14 : número sequencial definido pelo sistema quando do registro específico do parâmetro dentro do tipo de parametrização no sistema; |
| `v_red_bcbm` | `vRedBCBM` | `TSDec15V2` | 0..1, escolha 1 | Valor monetário informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM). |
| `p_red_bcbm` | `pRedBCBM` | `TSDec3V2` | 0..1, escolha 1 | Valor percentual informado pelo emitente para redução da base de cálculo (BC) do ISSQN devido a um Benefício Municipal (BM). |

Escolha 1: no máximo um entre `v_red_bcbm` e `p_red_bcbm`.

# `t`

```elixir
@type t() :: %Nfse.Schema.V1_01.TCBeneficioMunicipal{
  n_bm: String.t() | nil,
  p_red_bcbm: Decimal.t() | nil,
  v_red_bcbm: Decimal.t() | nil
}
```

# `decode`

```elixir
@spec decode(Saxy.SimpleForm.t()) :: {:ok, t()} | {:error, Nfse.Error.t()}
```

Lê o elemento, na árvore do `Saxy.SimpleForm`, como este struct e valida o resultado.

# `encode`

```elixir
@spec encode(t(), String.t(), [Nfse.Schema.Runtime.attribute()]) :: iodata()
```

Escreve o struct já validado como o elemento `tag`, na forma canônica. Os `extra_attributes`,
como as declarações de namespace, saem antes dos atributos do struct.

# `new`

```elixir
@spec new(map() | keyword() | t()) :: {:ok, t()} | {:error, Nfse.Error.t()}
```

Converte `attrs` (mapa, lista de palavras-chave ou o próprio struct, também nos campos
aninhados) neste struct e valida o resultado. As regras estão em `Nfse.Schema.Runtime`.

# `validate`

```elixir
@spec validate(t()) :: :ok | {:error, Nfse.Error.t()}
```

Valida o struct contra o XSD e devolve cada erro com o caminho do campo.

---

*Consult [api-reference.md](api-reference.md) for complete listing*