SivaNFe v1.0
Emissor NFe/NFCe v3.10
WCF (Windows Communication Foundation) integrador ao webservice de Nota Fiscal Eletrônica da SEFAZ.
Métodos
Estão disponíveis neste WCF os seguintes métodos:
-
CreateNFe: Cria uma nova NFe ou NFCe;
-
Soap: SivaNFe.svc/CreateNFe;
-
Rest: SivaNFe.svc/rest/CreateNFe;
-
Help: SivaNFe.svc/rest/help/operations/CreateNFe.
-
-
CheckNFe: Verifica e retorna o status de uma NFe ou NFCe;
-
Soap: SivaNFe.svc/CheckNFe;
-
Rest: SivaNFe.svc/rest/CheckNFe;
-
Help: SivaNFe.svc/rest/help/operations/CheckNFe.
-
-
CancelNFe: Cancela uma NFe ou NFCe;
-
Soap: SivaNFe.svc/CancelNFe;
-
Rest: SivaNFe.svc/rest/CancelNFe;
-
Help: SivaNFe.svc/rest/help/operations/CancelNFe.
-
-
GetPdf: Retorna o arquivo PDF de uma NFe ou NFCe;
-
Soap: SivaNFe.svc/GetPdf;
-
Rest: SivaNFe.svc/rest/GetPdf;
-
Help: SivaNFe.svc/rest/help/operations/GetPdf.
-
-
GetXml: Retorna o arquivo XML de uma NFe ou NFCe;
-
Soap: SivaNFe.svc/GetXml;
-
Rest: SivaNFe.svc/rest/GetXml;
-
Help: SivaNFe.svc/rest/help/operations/GetXml.
-
-
ListNFe: Retorna uma listagem de NFe ou NFCe;
-
Soap: SivaNFe.svc/rest/ListNFe;
-
Rest: SivaNFe.svc/rest/ListNFe;
-
Help: SivaNFe.svc/rest/help/operations/ListNFe.
-
-
GetNextNFe: Retorna o próximo número da NFe ou NFCe a ser emitida;
-
Soap: SivaNFe.svc/rest/GetNextNFe;
-
Rest: SivaNFe.svc/rest/GetNextNFe;
-
Help: SivaNFe.svc/rest/help/operations/GetNextNFe.
-
-
CheckContrib: Verifica e retorna os dados do contribuinte;
-
Soap: SivaNFe.svc/rest/CheckContribNFe;
-
Rest: SivaNFe.svc/rest/CheckContribNFe;
-
Help: SivaNFe.svc/rest/help/operations/CheckContribNFe.
-
Criar NFe/NFCe
REQUEST
Para criar uma NFe ou NFCe será necessário consumir o método CreateNFe informando, além dos dados da NFe ou NFCe, dados de acesso e configuração do sistema:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
- emailsBcc: emails para os quais serão enviados o XML da NF.
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"emailsBcc":"email_1@exemplo.com.br; email_2@exemplo.com.br",
"NFe310":{
"infNFe":{
"Id":"String content",
"autXML":[{
"CNPJ":"String content",
"CPF":"String content"
}],
"avulsa":{
"CNPJ":"String content",
"UF":"String content",
"dEmi":"String content",
"dPag":"String content",
"fone":"String content",
"matr":"String content",
"nDAR":"String content",
"repEmi":"String content",
"vDAR":"String content",
"xAgente":"String content",
"xOrgao":"String content"
},
"cana":{
"deduc":[{
"vDed":"String content",
"xDed":"String content"
}],
"forDia":[{
"dia":"String content",
"qtde":"String content"
}],
"qTotAnt":"String content",
"qTotGer":"String content",
"qTotMes":"String content",
"ref":"String content",
"safra":"String content",
"vFor":"String content",
"vLiqFor":"String content",
"vTotDed":"String content"
},
"cobr":{
"dup":[{
"dVenc":"String content",
"nDup":"String content",
"vDup":"String content"
}],
"fat":{
"nFat":"String content",
"vDesc":"String content",
"vLiq":"String content",
"vOrig":"String content"
}
},
"compra":{
"xCont":"String content",
"xNEmp":"String content",
"xPed":"String content"
},
"dest":{
"CNPJ":"String content",
"CPF":"String content",
"IE":"String content",
"IM":"String content",
"ISUF":"String content",
"email":"String content",
"enderDest":{
"CEP":"String content",
"UF":"String content",
"cMun":"String content",
"cPais":"String content",
"fone":"String content",
"nro":"String content",
"xBairro":"String content",
"xCpl":"String content",
"xLgr":"String content",
"xMun":"String content",
"xPais":"String content"
},
"idEstrangeiro":"String content",
"indIEDest":0,
"xNome":"String content"
},
"det":[{
"imposto":{
"COFINS":{
"COFINSAliq":{
"CST":0,
"pCOFINS":"String content",
"vBC":"String content",
"vCOFINS":"String content"
},
"COFINSNT":{
"CST":0
},
"COFINSOutr":{
"CST":0,
"pCOFINS":"String content",
"qBCProd":"String content",
"vAliqProd":"String content",
"vBC":"String content",
"vCOFINS":"String content"
},
"COFINSQtde":{
"CST":0,
"qBCProd":"String content",
"vAliqProd":"String content",
"vCOFINS":"String content"
}
},
"COFINSST":{
"pCOFINS":"String content",
"qBCProd":"String content",
"vAliqProd":"String content",
"vBC":"String content",
"vCOFINS":"String content"
},
"ICMS":{
"ICMS00":{
"CST":0,
"modBC":0,
"orig":0,
"pICMS":"String content",
"vBC":"String content",
"vICMS":"String content"
},
"ICMS10":{
"CST":0,
"modBC":0,
"modBCST":0,
"orig":0,
"pICMS":"String content",
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBCST":"String content",
"vBC":"String content",
"vBCST":"String content",
"vICMS":"String content",
"vICMSST":"String content"
},
"ICMS20":{
"CST":0,
"modBC":0,
"motDesICMS":0,
"orig":0,
"pICMS":"String content",
"pRedBC":"String content",
"vBC":"String content",
"vICMS":"String content",
"vICMSDeson":"String content"
},
"ICMS30":{
"CST":0,
"modBCST":0,
"motDesICMS":0,
"orig":0,
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBCST":"String content",
"vBCST":"String content",
"vICMSDeson":"String content",
"vICMSST":"String content"
},
"ICMS40":{
"CST":0,
"motDesICMS":0,
"orig":0,
"vICMSDeson":"String content"
},
"ICMS51":{
"CST":0,
"modBC":0,
"orig":0,
"pDif":"String content",
"pICMS":"String content",
"pRedBC":"String content",
"vBC":"String content",
"vICMS":"String content",
"vICMSDif":"String content",
"vICMSOp":"String content"
},
"ICMS60":{
"CST":0,
"orig":0,
"vBCSTRet":"String content",
"vICMSSTRet":"String content"
},
"ICMS70":{
"CST":0,
"modBC":0,
"modBCST":0,
"motDesICMS":0,
"orig":0,
"pICMS":"String content",
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBC":"String content",
"pRedBCST":"String content",
"vBC":"String content",
"vBCST":"String content",
"vICMS":"String content",
"vICMSDeson":"String content",
"vICMSST":"String content"
},
"ICMS90":{
"CST":0,
"modBC":0,
"modBCST":0,
"motDesICMS":0,
"orig":0,
"pICMS":"String content",
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBC":"String content",
"pRedBCST":"String content",
"vBC":"String content",
"vBCST":"String content",
"vICMS":"String content",
"vICMSDeson":"String content",
"vICMSST":"String content"
},
"ICMSPart":{
"CST":0,
"UFST":"String content",
"modBC":0,
"modBCST":0,
"orig":0,
"pBCOp":"String content",
"pICMS":"String content",
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBC":"String content",
"pRedBCST":"String content",
"vBC":"String content",
"vBCST":"String content",
"vICMS":"String content",
"vICMSST":"String content"
},
"ICMSSN101":{
"CSOSN":0,
"orig":0,
"pCredSN":"String content",
"vCredICMSSN":"String content"
},
"ICMSSN102":{
"CSOSN":0,
"orig":0
},
"ICMSSN201":{
"CSOSN":0,
"modBCST":0,
"orig":0,
"pCredSN":"String content",
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBCST":"String content",
"vBCST":"String content",
"vCredICMSSN":"String content",
"vICMSST":"String content"
},
"ICMSSN202":{
"CSOSN":0,
"modBCST":0,
"orig":0,
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBCST":"String content",
"vBCST":"String content",
"vICMSST":"String content"
},
"ICMSSN500":{
"CSOSN":0,
"orig":0,
"vBCSTRet":"String content",
"vICMSSTRet":"String content"
},
"ICMSSN900":{
"CSOSN":0,
"modBC":0,
"modBCST":0,
"orig":0,
"pCredSN":"String content",
"pICMS":"String content",
"pICMSST":"String content",
"pMVAST":"String content",
"pRedBC":"String content",
"pRedBCST":"String content",
"vBC":"String content",
"vBCST":"String content",
"vCredICMSSN":"String content",
"vICMS":"String content",
"vICMSST":"String content"
},
"ICMSST":{
"CST":0,
"orig":0,
"vBCSTDest":"String content",
"vBCSTRet":"String content",
"vICMSSTDest":"String content",
"vICMSSTRet":"String content"
}
},
"II":{
"vBC":"String content",
"vDespAdu":"String content",
"vII":"String content",
"vIOF":"String content"
},
"IPI":{
"CNPJProd":"String content",
"IPINT":{
"CST":0
},
"IPITrib":{
"CST":0,
"pIPI":"String content",
"qUnid":"String content",
"vBC":"String content",
"vIPI":"String content",
"vUnid":"String content"
},
"cEnq":"String content",
"cSelo":"String content",
"clEnq":"String content",
"qSelo":"String content"
},
"ISSQN":{
"cListServ":0,
"cMun":"String content",
"cMunFG":"String content",
"cPais":"String content",
"cServico":"String content",
"indISS":0,
"indIncentivo":0,
"nProcesso":"String content",
"vAliq":"String content",
"vBC":"String content",
"vDeducao":"String content",
"vDescCond":"String content",
"vDescIncond":"String content",
"vISSQN":"String content",
"vISSRet":"String content",
"vOutro":"String content"
},
"PIS":{
"PISAliq":{
"CST":0,
"pPIS":"String content",
"vBC":"String content",
"vPIS":"String content"
},
"PISNT":{
"CST":0
},
"PISOutr":{
"CST":0,
"pPIS":"String content",
"qBCProd":"String content",
"vAliqProd":"String content",
"vBC":"String content",
"vPIS":"String content"
},
"PISQtde":{
"CST":0,
"qBCProd":"String content",
"vAliqProd":"String content",
"vPIS":"String content"
}
},
"PISST":{
"pPIS":"String content",
"qBCProd":"String content",
"vAliqProd":"String content",
"vBC":"String content",
"vPIS":"String content"
},
"vTotTrib":"String content"
},
"impostoDevol":{
"IPI":{
"vIPIDevol":"String content"
},
"pDevol":"String content"
},
"infAdProd":"String content",
"nItem":"String content",
"prod":{
"CFOP":0,
"DI":[{
"CNPJ":"String content",
"UFDesemb":"String content",
"UFTerceiro":"String content",
"cExportador":"String content",
"dDI":"String content",
"dDesemb":"String content",
"nDI":"String content",
"tpIntermedio":0,
"tpViaTransp":0,
"vAFRMM":"String content",
"xLocDesemb":"String content"
}],
"EXTIPI":"String content",
"NCM":"String content",
"NVE":["String content"],
"arma":{
"descr":"String content",
"nCano":"String content",
"nSerie":"String content",
"tpArma":0
},
"cEAN":"String content",
"cEANTrib":"String content",
"cProd":"String content",
"comb":{
"CIDE":{
"qBCProd":"String content",
"vAliqProd":"String content",
"vCIDE":"String content"
},
"CODIF":"String content",
"UFCons":"String content",
"cProdANP":0,
"pMixGN":"String content",
"qTemp":"String content"
},
"detExport":[{
"exportInd":{
"chNFe":"String content",
"nRE":"String content",
"qExport":"String content"
},
"nDraw":"String content"
}],
"indTot":0,
"med":{
"dFab":"String content",
"dVal":"String content",
"nLote":"String content",
"qLote":"String content",
"vPMC":"String content"
},
"nFCI":"String content",
"nItemPed":"String content",
"nRECOPI":"String content",
"qCom":"String content",
"qTrib":"String content",
"uCom":"String content",
"uTrib":"String content",
"vDesc":"String content",
"vFrete":"String content",
"vOutro":"String content",
"vProd":"String content",
"vSeg":"String content",
"vUnCom":"String content",
"vUnTrib":"String content",
"veicProd":{
"CMT":"String content",
"VIN":0,
"anoFab":"String content",
"anoMod":"String content",
"cCor":"String content",
"cCorDENATRAN":"String content",
"cMod":"String content",
"chassi":"String content",
"cilin":"String content",
"condVeic":0,
"dist":"String content",
"espVeic":"String content",
"lota":"String content",
"nMotor":"String content",
"nSerie":"String content",
"pesoB":"String content",
"pesoL":"String content",
"pot":"String content",
"tpComb":"String content",
"tpOp":0,
"tpPint":"String content",
"tpRest":0,
"tpVeic":"String content",
"xCor":"String content"
},
"xPed":"String content",
"xProd":"String content"
}
}],
"emit":{
"CNAE":"String content",
"CNPJ":"String content",
"CPF":"String content",
"CRT":0,
"IE":"String content",
"IM":"String content",
"enderEmit":{
"CEP":"String content",
"UF":"String content",
"cMun":"String content",
"cPais":0,
"fone":"String content",
"nro":"String content",
"xBairro":"String content",
"xCpl":"String content",
"xLgr":"String content",
"xMun":"String content"
},
"iEST":"String content",
"xFant":"String content",
"xNome":"String content"
},
"entrega":{
"CNPJ":"String content",
"CPF":"String content",
"UF":"String content",
"cMun":"String content",
"nro":"String content",
"xBairro":"String content",
"xCpl":"String content",
"xLgr":"String content",
"xMun":"String content"
},
"exporta":{
"UFSaidaPais":"String content",
"xLocDespacho":"String content",
"xLocExporta":"String content"
},
"ide":{
"NFref":{
"refCTe":"String content",
"refECF":{
"mod":0,
"nCOO":"String content",
"nECF":"String content"
},
"refNF":{
"AAMM":"String content",
"CNPJ":"String content",
"cUF":"String content",
"mod":0,
"nNF":"String content",
"serie":"String content"
},
"refNFP":{
"AAMM":"String content",
"CNPJ":"String content",
"CPF":"String content",
"IE":"String content",
"cUF":"String content",
"mod":0,
"nNF":"String content",
"serie":"String content"
},
"refNFe":"String content"
},
"cDV":"String content",
"cMunFG":"String content",
"cNF":"String content",
"cUF":"String content",
"dhCont":"String content",
"dhEmi":"String content",
"dhSaiEnt":"String content",
"finNFe":0,
"idDest":0,
"indFinal":0,
"indPag":0,
"indPres":0,
"mod":0,
"nNF":"String content",
"natOp":"String content",
"procEmi":0,
"serie":"String content",
"tpAmb":0,
"tpEmis":0,
"tpImp":0,
"tpNF":0,
"verProc":"String content",
"xJust":"String content"
},
"infAdic":{
"infAdFisco":"String content",
"infCpl":"String content",
"obsCont":[{
"xCampo":"String content",
"xTexto":"String content"
}],
"obsFisco":[{
"xCampo":"String content",
"xTexto":"String content"
}],
"procRef":[{
"indProc":0,
"nProc":"String content"
}]
},
"pag":[{
"card":{
"CNPJ":"String content",
"cAut":"String content",
"tBand":0
},
"tPag":0,
"vPag":"String content"
}],
"retirada":{
"CNPJ":"String content",
"CPF":"String content",
"UF":"String content",
"cMun":"String content",
"nro":"String content",
"xBairro":"String content",
"xCpl":"String content",
"xLgr":"String content",
"xMun":"String content"
},
"total":{
"ICMSTot":{
"vBC":"String content",
"vBCST":"String content",
"vCOFINS":"String content",
"vDesc":"String content",
"vFrete":"String content",
"vICMS":"String content",
"vICMSDeson":"String content",
"vII":"String content",
"vIPI":"String content",
"vNF":"String content",
"vOutro":"String content",
"vPIS":"String content",
"vProd":"String content",
"vST":"String content",
"vSeg":"String content",
"vTotTrib":"String content"
},
"ISSQNtot":{
"cRegTrib":0,
"dCompet":"String content",
"vBC":"String content",
"vCOFINS":"String content",
"vDeducao":"String content",
"vDescCond":"String content",
"vDescIncond":"String content",
"vISS":"String content",
"vISSRet":"String content",
"vOutro":"String content",
"vPIS":"String content",
"vServ":"String content"
},
"retTrib":{
"_vRetPrev":"String content",
"vBCIRRF":"String content",
"vBCRetPrev":"String content",
"vIRRF":"String content",
"vRetCOFINS":"String content",
"vRetCSLL":"String content",
"vRetPIS":"String content"
}
},
"transp":{
"balsa":"String content",
"modFrete":0,
"reboque":{
"RNTC":"String content",
"UF":"String content",
"placa":"String content"
},
"retTransp":{
"CFOP":0,
"cMunFG":"String content",
"pICMSRet":"String content",
"vBCRet":"String content",
"vICMSRet":"String content",
"vServ":"String content"
},
"transporta":{
"CNPJ":"String content",
"CPF":"String content",
"IE":"String content",
"UF":"String content",
"xEnder":"String content",
"xMun":"String content",
"xNome":"String content"
},
"vagao":"String content",
"veicTransp":{
"RNTC":"String content",
"UF":"String content",
"placa":"String content"
},
"vol":[{
"esp":"String content",
"lacres":[{
"nLacre":"String content"
}],
"marca":"String content",
"nVol":"String content",
"pesoB":"String content",
"pesoL":"String content",
"qVol":"String content"
}]
},
"versao":"String content"
}
}
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
-
actionNFe: corresponde a uma ação criada (neste caso uma criação de NFe).
- actionId: ID único da ação;
- environment: ambiente de geração da NF (1: Produção, 2: Homologação);
- message: XML de envio ou recebimento da SEFAZ ou texto de erro;
- status: texto referente ao último status da ação;
- statusId: ID referente ao último status da ação.
{
"errorMessage":"String content",
"success":true,
"actionNFe":{
"actionId":9223372036854775807,
"environment":2,
"message":"String content",
"status":"String content",
"statusId":0
}
}
Checar Status NFE/NFCe
REQUEST
Após checar o status de uma NFe ou NFCe será necessário consumir o método CheckNFe para atualizar o status da respectiva NF. Os seguintes dados serão necessários:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
- actionId: ID único da ação.
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"actionId":9223372036854775807
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
- actionNFe: corresponde a uma ação criada (neste caso uma criação de NFe).
- actionId: ID único da ação;
- environment: ambiente de geração da NF (1: Produção, 2: Homologação);
- message: XML de envio ou recebimento da SEFAZ ou texto de erro;
- status: texto referente ao último status da ação;
- statusId: ID referente ao último status da ação.
{
"errorMessage":"String content",
"success":true,
"actionNFe":{
"actionId":9223372036854775807,
"environment":2,
"message":"String content",
"status":"String content",
"statusId":0
}
}
Cancelar NFe/NFCe
REQUEST
Para cancelar uma NFe ou NFCe será necessário consumir o método CancelNFe informando os seguintes dados:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
- actionId: ID único da ação;
- justification: justificativa para o cancelamento(obrigatório - de 15 a 256 caracteres)
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"actionId":9223372036854775807,
"justification":"String content"
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
- actionNFe: corresponde a uma ação criada (neste caso uma criação de NFe).
- actionId: ID único da ação;
- environment: ambiente de geração da NF (1: Produção, 2: Homologação);
- message: XML de envio ou recebimento da SEFAZ ou texto de erro;
- status: texto referente ao último status da ação;
- statusId: ID referente ao último status da ação.
{
"errorMessage":"String content",
"success":true,
"actionNFe":{
"actionId":9223372036854775807,
"environment":2,
"message":"String content",
"status":"String content",
"statusId":0
}
}
Retornar Pdf NFe/NFCe
REQUEST
Para retornar o arquivo PDF de uma NFe ou NFCe será necessário consumir o método GetPdf informando os seguintes dados:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
- actionId: ID único da ação;
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"actionId":9223372036854775807
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
- filePdf: corresponde ao arquivo PDF de uma NFe ou NFCe.
- file: array de bytes ;
- fileName: nome do arquivo.
{
"errorMessage":"String content",
"success":true,
"filePdf":{
"file":[],
"fileName":"String content"
}
}
Retornar Xml NFe/NFCe
REQUEST
Para retornar o arquivo XML de uma NFe ou NFCe será necessário consumir o método GetXml informando os seguintes dados:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
- actionId: ID único da ação;
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"actionId":9223372036854775807
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
- fileXml: corresponde ao arquivo XML de uma NFe ou NFCe.
- file: array de bytes ;
- fileName: nome do arquivo.
{
"errorMessage":"String content",
"success":true,
"fileXml":{
"file":[],
"fileName":"String content"
}
}
Listar NFe/NFCe
REQUEST
Para listar as NFes ou NFCes será necessário consumir o método ListNFe informando os seguintes dados:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
-
serachNFe: filtro de pesquisa.
- document: CPF ou CNPJ do destinatário;
- dteIssueFinish: data final da emissão;
- dteIssueInit: data inicial da emissão;
- email: email do destinatário;
- environment: ambiente de geração da NF (1: Produção, 2: Homologação);
- name: nome do destinatário;
- nfNumber: número da NFe ou NFCe;
- nfSerie: número da NFe ou NFCe;
- nfType: tipo de NF (1: NFe, 2: NFCe);
- pageRegisters: númeto da paginação dos registros (obrigatório);
- qtdRegisters: quantidade de registros que serão retornados (obrigatório).
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"searchNFe":{
"document":"String content",
"dteIssueFinish":"/Date(928160400000-0300)/",
"dteIssueInit":"/Date(928160400000-0300)/",
"email":"String content",
"environment":0,
"name":"String content",
"nfNumber":"String content",
"nfSerie":"String content",
"nfType":0,
"pageRegisters":2147483647,
"qtdRegisters":2147483647
}
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
-
listNFe: listagem de NFe ou NFCe.
- actionId: ID único da ação;
- actionType: tipo de NF (1: NFe, 2: NFCe);
- document: CPF ou CNPJ do destinatário;
- dteCreate: data de criação da NFe ou NFCe;
- dteIssue: data da emissão da NFe ou NFCe;
- email: email do destinatário;
- environment: ambiente de geração da NF (1: Produção, 2: Homologação);
- locator: chave localizadora da NFe ou NFCe;
- name: nome do destinatário;
- nfNumber: número da NFe ou NFCe;
- nfSerie: número da NFe ou NFCe;
-
status: último status na NFe ou NFCe;
- dteCreate: data de criação do status;
- identifier: protocolo retornado pela SEFAZ;
- message: XML de envio ou recebimento da SEFAZ ou texto de erro;
- status: texto referente ao último status da ação;
- statusId: ID referente ao último status da ação.
- total: valor total da NFe ou NFCe ;
- uf: UF do destinatário.
{
"errorMessage":"String content",
"success":true,
"listNFe":[{
"actionId":9223372036854775807
"actionType":0,
"document":"String content",
"dteCreate":"/Date(928160400000-0300)/",
"dteIssue":"/Date(928160400000-0300)/",
"email":"String content",
"environment":0,>
"locator":"String content",
"name":"String content",an>
"nfNumber":"String content",
"nfSerie":"String content",
"status":{
"dteCreate":"/Date(928160400000-0300)/",
"identifier":"String content",
"message":"String content",
"status":"String content",
"statusId":0
},
"total":1.26743233E+15,
"uf":"String content"
}]
}
Retornar Próxima NFe/NFCe
REQUEST
Para retornar o número da próxima NFe ou NFCe a ser emitida será necessário consumir o método GetNextNFe informando os seguintes dados:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
- serie: série da NFe ou NFCe a ser emitida;
- environment: ambiente de geração da NF (1: Produção, 2: Homologação);
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"serie":"String content",
"environment":0
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
- nextNumber: número da próxima NFe ou NFCe a ser emitida.
{
"errorMessage":"String content",
"success":true,
"nextNumber":9223372036854775807
}
Checar Contribuinte NFe/NFCe
REQUEST
Para checar um contribuinte será necessário consumir o método CheckContrib informando os seguintes dados:
- enterpriseKey: chave de acesso ao sistema (obrigatório);
- pdaIdentifier: identificador do PDA;
- timeZone: fuso-horário do emissor (obrigatório);
-
consCad: filtro de pesquisa (obrigatório exclusivo);
-
infCad: informações do filtro;
- CNPJ: CNPJ do contribuinte (obrigatório exclusivo);
- CPF: CPF do contribuinte (obrigatório exclusivo);
- IE: inscrição estadual do contribuinte (obrigatório exclusivo);
- UF: UF do contribuinte (obrigatório).
-
infCad: informações do filtro;
- contribKey: chave de pesquisa recebida (obrigatório exclusivo).
{
"enterpriseKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"pdaIdentifier":"String content",
"timeZone":-3,
"consCad":{
"infCons":{
"CNPJ":"String content",
"CPF":"String content",
"IE":"String content",
"UF":"String content"
}
}
"contribKey":"1627aea5-8e0a-4371-9022-9b504344e724"
}
RESPONSE
Na resposta do método serão disponibilizados os seguinte campos:
- success: se "true" o request foi recebido em sua totalidade; se "false" algum erro aconteceu no recebimento do request;
- errorMessage: mensagem do erro (se success for "false");
- contribKey: chave de pesquisa.
- retConsCad: dados do contribuinte.
{
"errorMessage":"String content",
"success":true,
"contribKey":"1627aea5-8e0a-4371-9022-9b504344e724",
"retConsCad":{
"infCons":{
"CNPJ":"String content",
"CPF":"String content",
"IE":"String content",
"UF":"String content",
"cStat":"String content",
"cUF":0,
"dhCons":"String content",
"infCad":[{
"CNAE":"String content",
"CNPJ":"String content",
"CPF":"String content",
"IE":"String content",
"IEAtual":"String content",
"IEUnica":"String content",
"UF":"String content",
"cSit":0,
"dBaixa":"String content",
"dIniAtiv":"String content",
"dUltSit":"String content",
"ender":{
"CEP":"String content",
"cMun":"String content",
"nro":"String content",
"xBairro":"String content",
"xCpl":"String content",
"xLgr":"String content",
"xMun":"String content"
},
"indCredCTe":0,
"indCredNFe":0,
"xFant":"String content",
"xNome":"String content",
"xRegApur":"String content"
}],
"verAplic":"String content",
"xMotivo":"String content"
},
"versao":"String content"
}
}
Layout NFE/NFCe
Estrutura de Diretórios
O sistema SivaNFe possui a seguinte estrutura de diretórios abaixo:
APLICATIVOS
ARQUIVOS
CERTIFICADO DE SEGURANÇA
Os certificados de segurança, nesta estrutura, são armazenados com o nome do CNPJ da respectiva empresa:
LOGOTIPO NFe/NFCe
Os logotipos (w:190px; h:60px), nesta estrutura, são armazenados com o nome do CNPJ da respectiva empresa:
ARQUIVOS DE RETORNO
Os logotipos (w:190px; h:60px), nesta estrutura, são armazenados com o nome do CNPJ da respectiva empresa:
