Nfse.Schema.V1_00.TCEndereco (nfse v0.1.0)

Copy Markdown View Source

Tipo TCEndereco do leiaute 1.00, em tiposComplexos_v1.00.xsd.

CampoXMLTipoOcorrênciaDescrição
end_nacendNacNfse.Schema.V1_00.TCEnderNac1, escolha 1Grupo de informações específicas de endereço nacional
end_extendExtNfse.Schema.V1_00.TCEnderExt1, escolha 1Grupo de informações específicas de endereço no exterior
x_lgrxLgrTSLogradouro1Tipo e nome do logradouro da localização do imóvel
nronroTSNumeroEndereco1Número do imóvel
x_cplxCplTSComplementoEndereco0..1Complemento do endereço
x_bairroxBairroTSBairro1Bairro

Escolha 1: no máximo um entre end_nac e end_ext.

Summary

Functions

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

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.

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.

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

Types

t()

@type t() :: %Nfse.Schema.V1_00.TCEndereco{
  end_ext: Nfse.Schema.V1_00.TCEnderExt.t() | nil,
  end_nac: Nfse.Schema.V1_00.TCEnderNac.t() | nil,
  nro: String.t() | nil,
  x_bairro: String.t() | nil,
  x_cpl: String.t() | nil,
  x_lgr: String.t() | nil
}

Functions

decode(element)

@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(struct, tag, extra_attributes \\ [])

@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(attrs)

@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(struct)

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

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