Skip to main content

XML

O módulo XML é responsável por realizar ações de manipulação de arquivos que tenha a extensão .xml.

xmlToJson​

Método responsável por obter um objeto javascript (JSON) de um arquivo XML. As tags XML serão transformadas em um JSON no qual cada propriedade corresponderá com uma tag XML.

const fileXML = await XML.xmlToJson["v1_0_0"]({
 xmlPath: `C:\\Users\\Roberty\\Downloads\\nf.xml`
})

Parâmetros obrigatórios​

  • xmlPath: String - espera o caminho em que está o arquivo XML.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará o seguinte objeto:

  • json: Object - retornará todo o xml em forma de JSON. Basta usar json.tag-presente-no-xml para pegar a propriedade desejada. Exemplo:
fileXML.json.NFe.infNFe

xmlGetFields​

Método responsável por obter um campo ou mais de um JSON obtido pela a ação xmlToJson.

const file = await XML.xmlGetFields["v1_0_0"]({
 xmlJson: fileXML,
 fields: [`xProd`, `ide`]
})

Parâmetros obrigatórios​

  • xmlJson: Object from xmlToJson - espera um valor retornado pela a ação xmlToJson.
  • fields: String[] - espera um array de strings onde as strings são cada string é um campo desejado do JSON.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará o seguinte objeto:

  • fields: Object - retornará um objeto com todas as propriedades passadas no campo fields. Basta usar fields.valor-passado-no-array para pegar a propriedade desejada. Exemplo:
file.fields.xProd
file.fields.ide

getTotalValues​

Método responsável por obter os campos da seção valores totais de uma nota fiscal brasileira.

const getTotalValues = await XML.getTotalValues["v1_0_0"]({
 xmlPath: fileXML,
})

Parâmetros obrigatórios​

  • xmlPath: Object from xmlToJson - espera um valor retornado pela a ação xmlToJson.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará os seguintes objetos:

  • vBC: number,
  • vICMS: number,
  • vICMSDeson: number,
  • vFCPUFDest: number,
  • vFCP: number,
  • vBCST: number,
  • vST: number,
  • vFCPST: number,
  • vFCPSTRet: number,
  • vProd: number,
  • vFrete: number,
  • vSeg: number,
  • vDesc: number,
  • vII: number,
  • vIPI: number,
  • vIPIDevol: number,
  • vPIS: number,
  • vCOFINS: number,
  • vOutro: number,
  • vNF: number

getRecipientInformation​

Método responsável por obter os campos da tag <dest> (destinatário) de uma Nota Fiscal Eletrônica brasileira.

const getRecipientInformation = await XML.getRecipientInformation["v1_0_0"]({
 xmlJson: fileXML,
})

Parâmetros obrigatórios​

  • xmlJson: Object from xmlToJson - espera um valor retornado pela a ação xmlToJson.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará os seguintes objetos:

  • CNPJ: number,
  • CPF: number,
  • xNome: string,
  • xFant: string,
  • IM: number,
  • CNAE: number,
  • IE: number,
  • IEST: number,
  • CRT: number,
  • xLgr: string,
  • nro: number,
  • xCpl: string,
  • xBairro: string,
  • cMun: number,
  • xMun: string,
  • UF: string,
  • CEP: number,
  • cPais: number,
  • xPais: string,
  • fone: string,
  • email: string

getIssuertInformation​

Ação responsável por obter os campos da tag <emit> (emitente) de uma Nota Fiscal Eletrônica brasileira.

const getIssuertInformation = await XML.getIssuertInformation["v1_0_0"]({
 xmlJson: fileXML,
})

Parâmetros obrigatórios​

  • xmlJson: Object from xmlToJson - espera um valor retornado pela a ação xmlToJson.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará os seguintes objetos:

  • CNPJ: number,
  • CPF: number,
  • xNome: string,
  • xFant: string,
  • IM: number,
  • CNAE: number,
  • IE: number,
  • IEST: number,
  • CRT: number,
  • xLgr: string,
  • nro: number,
  • xCpl: string,
  • xBairro: string,
  • cMun: number,
  • xMun: string,
  • UF: string,
  • CEP: number,
  • cPais: number,
  • xPais: string,
  • fone: string,
  • email: string

getInvoiceIdentificationFields​

Ação responsável por obter os campos da tag <ide> (identificação) de uma Nota Fiscal Eletrônica brasileira

const getInvoiceIdentificationFields = await XML.getInvoiceIdentificationFields["v1_0_0"]({
 xmlJson: fileXML,
})

Parâmetros obrigatórios​

  • xmlJson: Object from xmlToJson - espera um valor retornado pela a ação xmlToJson.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará os seguintes objetos:

  • cUF: number,
  • cNF: number,
  • natOp: string,
  • mod: number,
  • serie: number,
  • nNF: number,
  • dhEmi: string,
  • fusoHorario: string,
  • dhSaiEnt: string,
  • tpNf: number,
  • idDest: number,
  • indFinal: number,
  • indPres: number,
  • indIntermed: number,
  • cMunFg: number,
  • tpImp: number,
  • tpEmis: number,
  • cDV: number,
  • tpAmb: number,
  • xJust: string,
  • dhCont: string,
  • finNFe: number,
  • EmailArquivos: string,
  • NumeroPedido: string,
  • procEmi: string

getAdditionalInformation​

Ação responsável por obter os campos da seção "Informações adicionais" de uma nota fiscal brasileira.

const getAdditionalInformation = await XML.getAdditionalInformation["v1_0_0"]({
 xmlJson: fileXML,
})

Parâmetros obrigatórios​

  • xmlJson: Object from xmlToJson - espera um valor retornado pela a ação xmlToJson.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará os seguintes objetos:

  • infAdFisco: string,
  • infCpl: string

forEachProduct​

Ação responsável por passar (iterar) em cada produto existente em uma nota fiscal brasileira obtendo todas as informações de cada produto em cada iteração do loop.

const forEachProduct = await XML.forEachProduct["v1_0_0"]({
 xmlJson: fileXML,
})

Parâmetros obrigatórios​

  • xmlJson: Object from xmlToJson - espera um valor retornado pela a ação xmlToJson.

Parâmetros opcionais​

  • Não há parâmetros opcionais.

Retorno​

Esse método retornará os seguintes objetos:

  • currentRow: string,
  • cProd: number,
  • cEAN: number,
  • xProd: string,
  • NCM: number,
  • CEST: number,
  • indEscala: string,
  • CFOP: number,
  • uCom: string,
  • qCom: number,
  • vUnCom: number,
  • vProd: number,
  • cEANTrib: number,
  • uTrib: string,
  • qTrib: number,
  • vUnTrib: number,
  • indTot: number,
  • xPed: number,
  • cBarra: string,
  • ICMS: any,
  • IPI: any,
  • PIS: any,
  • COFINS: any