IN Faturamento: mudanças entre as edições
| Linha 73: | Linha 73: | ||
==== ListarComissoesPorRepresentante ==== | ==== ListarComissoesPorRepresentante ==== | ||
==== CadastrarNotasFiscais ==== | ==== CadastrarNotasFiscais ==== | ||
<p align="justify"> | |||
Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os | |||
dados da Nota Fiscal deverão estar em formato XML para requisições SOAP e JSON para | |||
requisições REST. Ambos com estrutura específica conforme descrito a seguir. | |||
</p> | |||
*<b>Requisição</b> | |||
**<b>Soap:</b> http://servidor/CadastroNotaFiscal.integrador.asmx | |||
**<b>Rest/JSon:</b> http://servidor/CadastroNotaFiscal.integrador.ashx/metodo | |||
**<b>Tipo de registro:</b> CADNF1 | |||
*<b>Parâmetros:</b></br> | |||
<div style="background-color: #f2f2f2"> | |||
**<b>pin:</b> | |||
***Obrigatório, Tipo: String 20 | |||
**<b>statusRegistro</b> | |||
***Obrigatório, Tipo: String 1 | |||
****L=Liberado, P=Pendente | |||
****Se for informado algo diferente de P ou L não será aplicado nenhum filtro. | |||
**<b>notaFiscalXml</b> | |||
***Obrigatório apenas para requisições SOAP. Tipo: String | |||
****Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas. | |||
**<b>notaFiscalJson:</b> | |||
***Obrigatório apenas para requisições REST/JSON. Tipo: String | |||
****Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas. | |||
</div> | |||
</br> | |||
*Exemplo: | |||
**<categorytree mode="categories">CadastroNotaFiscal.XML</categorytree> | |||
==== RegistrarNotaFiscalInutilizada ==== | ==== RegistrarNotaFiscalInutilizada ==== | ||
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"> | <p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"> | ||
Edição das 15h26min de 5 de outubro de 2020
Cadastrar
ListarId
ListarPendentes
LiberarPendentes
ListarNotasFiscais
ListarNotasFiscaisInutilizadas
Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.
Parâmetros:
• pin: Obrigatório, Tipo: String • nf: Tipo: numerico • serie: Tipo: String • codigoUnidadeNegocio: Tipo: String
Exemplo de Retorno XML:
<Retorno>
<fagernfe>
<reg>
<nf>0000687623</nf>
<serie>NFE</serie>
<codigoUnidadeNegocio>2</codigoUnidadeNegocio>
<codigoRetornoInutilizacao>102</codigoRetornoInutilizacao>
<descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao>
<dataNota>DD/MM/AAAA</dataNota>
<dataEnvio>DD/MM/AAAA</dataEnvio>
<dataRetorno>DD/MM/AAAA</dataRetorno>
<horaRetorno>HHMMSS</horaRetorno>
<status>6</status>
<numeroProtocolo>143170000292574</numeroProtocolo>
<tipoAmbiente>2</tipoAmbiente>
<especieNota>S</especieNota>
<xmlEnvio>..........</xmlEnvio>
<xmlRetorno>........</xmlRetorno>
</reg>
</fagernfe>
</Retorno>
Exemplo de Retorno JSON:
[
{
"nf": "0000687623",
"serie": "NFE",
"codigoUnidadeNegocio": "2",
"codigoRetornoInutilizacao": "102",
"descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",
"dataNota": "DD/MM/AAAA",
"dataEnvio": "DD/MM/AAAA",
"dataRetorno": "DD/MM/AAAA",
"horaRetorno": "HHMMSS",
"status": "6",
"numeroProtocolo": "143170000292574",
"tipoAmbiente": "2",
"especieNota": "S",
"xmlEnvio": "............",
"xmlRetorno": "..........."
}
]
ListarNotasFiscaisPaf
ListasNFsMultiplasFormasPagamento
ListarComissoesPorRepresentante
CadastrarNotasFiscais
Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os dados da Nota Fiscal deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.
- Requisição
- Soap: http://servidor/CadastroNotaFiscal.integrador.asmx
- Rest/JSon: http://servidor/CadastroNotaFiscal.integrador.ashx/metodo
- Tipo de registro: CADNF1
- Parâmetros:
- pin:
- Obrigatório, Tipo: String 20
- pin:
- statusRegistro
- Obrigatório, Tipo: String 1
- L=Liberado, P=Pendente
- Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
- Obrigatório, Tipo: String 1
- statusRegistro
- notaFiscalXml
- Obrigatório apenas para requisições SOAP. Tipo: String
- Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.
- Obrigatório apenas para requisições SOAP. Tipo: String
- notaFiscalXml
- notaFiscalJson:
- Obrigatório apenas para requisições REST/JSON. Tipo: String
- Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
- Obrigatório apenas para requisições REST/JSON. Tipo: String
- notaFiscalJson:
- Exemplo:
- sem subcategorias
RegistrarNotaFiscalInutilizada
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.
| Parâmetro | Tipo | Máscara | Observação |
| *pin: | String | 20A | |
| *statusRegistro: | String | 1A | L=Liberado, P=Pendente |
| *codigoUnidadeNegocio: | String | 3A | |
| *nf: | numérico | 10 | |
| *serie | String | 5A | |
| *codigoRetorno: | String | 3A | Retorno informado em cStat |
| *descricaoRetorno: | String | 255A | Retorno informado em xMotivo |
| *dataRecibo: | Date | ##/##/##A | |
| *horaRecibo: | Time | HH:MM:SS | |
| *numeroProtocolo: | String | 15A | Retorno informado em nProt |
| *xmlEnvio: | Blob | Xml de Envio | |
| *xmlRetorno: | Blob | XML de Retorno | |
| *chaveAcesso: | String | 41A |
| (*) Campo obrigatório |
Retornos:
Se pin inválido:
O usuário não possui direitos suficientes para executar esta rotina.
Se nenhum registro encontrado:
A consulta não retornou nenhum registro.
