Histórico da Página
...
Descrição: | Utilize esta função para efetuar configurações na BemaOne.dll ou também aplicar configurações relacionadas ao sistema. |
Tipo: | String. |
Exemplo: | Bematech_Fiscal_EfetuarConfiguracoes(dados) |
Observações: | dados é uma string em formato JSON contendo os parâmetros listados abaixo: |
Retorno: | String de retorno em formato JSON. |
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
|
...
{ |
...
"sistema": |
...
{ |
...
"path": "string", |
...
"nivelLog": "string" |
...
} |
...
"nfe": |
...
{ |
...
"timeoutWebservice": "string", |
...
}
|
...
} |
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
|
{
|
...
"configuracao": [ |
...
{
|
...
"nome": "string", |
...
"valor": "string" |
...
}
|
...
]
|
...
} |
...
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
|
{
|
...
"sucesso": false, |
...
"codigo": 0, |
...
"descricao": "string", |
...
} |
08.20. Bematech_Fiscal_ObterInformacoesContingencia
Descrição: | Utilize esta função para obter informações relacionadas ao estado de contingência da aplicação. |
Tipo: | String. |
Exemplo: | Bematech_Fiscal_ObterInformacoesContingencia() |
Observações: | Obs.Função não possui parâmetros de envio. |
Retorno: | String de retorno em formato JSON. |
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
{
|
...
"situacao": "string", |
...
"codigo": 0, |
...
"notasEmContingencia": 0, |
...
"dataEntradaContingencia": "2016-08-23T20:24:30.680Z", |
...
"minutosEmContingencia": 0, |
...
"minutosRestantesEmContingencia": 0 |
...
} |
08.21. Bematech_Fiscal_TrocaEstadoContingencia
Descrição: | Utilize esta função para efetuar a troca do modo de contingência da aplicação entre os modos: Operação ON-LINE e Resolução de contingências. |
Tipo: | String. |
Exemplo: | Bematech_Fiscal_TrocaEstadoContingencia() |
Observações: | Obs.Função não possui parâmetros de envio. |
Retorno: | String de retorno em formato JSON. |
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
{
|
...
"situacao": "string", |
...
"codigo": 0, |
...
"notasEmContingencia": 0, |
...
"dataEntradaContingencia": "2016-08-23T20:24:30.681Z", |
...
"minutosEmContingencia": 0, |
...
"minutosRestantesEmContingencia": 0 |
...
} |
...
09. FLUXOS DE OPERAÇÃO USANDO A BEMAONE.DLL + APIONE
...
6. Bematech_Fiscal_ImprimirDocumentoFiscal (via chave)
| Nota | ||
|---|---|---|
| ||
Lembrando que cada uma das funções recebe um retorno de execução através de uma string com conteúdo em formato JSON, o tratamento destes retornos é de extrema importância para eventuais situações adversas durante a operação da aplicação. |
09.02. Obter informações do Sistema.
...
Considere a execução da leitura das informações do certificado digital, para tal utilize a seguinte função:
| Nota | ||
|---|---|---|
| ||
A dll receberá o JSON de retorno dentro de uma variável String. O tratamento do JSON deverá ser efetuado de acordo com a definição da linguagem utilizada para o desenvolvimento da aplicação. |
Em caso de sucesso o retorno recebido pela função seguirá o seguinte padrão:
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "versao": "string", "totalNotasRejeitadas": 0, "totalNotasRejeitasEmitidasContingencia": 0, "certificado": { "situacao": "string", "dataExpiracao": "2016-08-23T20:24:30.672Z", "diasParaExpiracao": 0 } } |
| Aviso | ||
|---|---|---|
| ||
A string de retorno não possui quebra de linhas, a apresentação acima "identada" tem como objetivo facilitar a visualização do conteúdo retornado. |
10. USANDO SERVIÇOS RESTFUL
...
Cada recurso da API possui uma URL que dá acesso aos detalhes do mesmo, esta documentação está vinculada ao Fiscal Manager para acessá-la utilize a URL: http://localhost:9999/docs/#/
| Nota | ||
|---|---|---|
| ||
É imprescindível que o Fiscal Manager esteja instalado e em execução para que você tenha acesso a lista de serviços da API. |
Nos próximos tópicos abordaremos em detalhes cada um dos serviços RestFul disponíveis na API de integração com o Fiscal Manager.em
...
11. RECURSOS DA API
Neste tópico, apresentamos todos os recursos disponíveis para a detalhes de cada um dos serviços RestFul disponíveis na API de integração com o Fiscal Manager NFC-E e SAT.
11.01. Abrir Cupom
Método: | POST |
Descrição: | Utilize este recurso da API para iniciar/abrir um novo |
Modelo JSON (Envio e Retorno): |
...
Método: | GET |
Descrição: | Utilize este recurso para alterar a forma do modo de tratamento do modo de contingência do Fiscal Manager, onde basicamente: Se a aplicação estiver ON-LINE ao executar o método a resolução das notas mudará para emissão em contingência e vice-versa. |
Modelo JSON (Envio e Retorno): | http://localhost:9999/docs/#!/sistema/alterarModoDeContingencia |
12. EXEMPLOS JSON NFC-E
Os exemplos foram categorizados através do tipo de método utilizado.
12.01. Método: GET (Fiscal Manager NFC-E e SAT)
Recurso utilizado: | Informações sobre o sistema |
Tipo de dados de Envio: | application/JSON |
Tipo de dados de Retorno: | application/JSON |
Detalhes da operação: | Este método deve consultar informações do Fiscal Manager retornando um JSON com as seguintes informações: Versão do Fiscal Manager. Número total de notas rejeitadas. Número total de Notas rejeitas emitidas em contingência. Situação do Certificado digital. Data de expiração do certificado. Dias restantes para expirar. |
_Observação _: | Em caso de sucesso a resposta será: (Status 200) SuccessFull Operation. |
Exemplo:
| Bloco de código | ||
|---|---|---|
|
...
| ||||||||
{ |
...
"versao": "02.00.00 build 01", |
...
"totalNotasRejeitadas": 1, |
...
"totalNotasRejeitasEmitidasContingencia": 0, |
...
"certificado": { |
...
"situacao": "No prazo", |
...
"dataExpiracao": "03/04/2017", |
...
"diasParaExpiracao": 97 |
...
}
|
...
} |
12.02. Método: POST (Utilizando Fiscal Manager NFC-e)
Recurso utilizado: | Abrir um cupom para venda. |
Tipo de dados de Envio: | application/JSON |
Tipo de dados de Retorno: | application/JSON |
Detalhes da operação: | Este método abrirá o registro de uma venda. |
_Observação _: | Em caso de sucesso a resposta será: (Status 200) SuccessFull Operation. |
Exemplo de JSON de envio
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
|
...
| |||||
{ "versao": "3.10", |
...
"configuracao": { |
...
"imprimir": true, |
...
"email": true |
...
}, |
...
"identificacao": { |
...
"cuf": "41", |
...
"cnf": "00005000", |
...
"natOp": "VENDA", "indPag": 0, |
...
"mod": "65", |
...
"serie": "768", |
...
"nnf": "5000", |
...
"dhEmi": "2016-12-29T14:06:57-02:00", |
...
"tpNF": "1", |
...
"idDest": 1, "tpImp": 4, |
...
"tpEmis": 1, |
...
"cdv": 8, |
...
"tpAmb": 2, |
...
"finNFe": 1, |
...
"indFinal": 1, |
...
"indPres": 1, "procEmi": 0, |
...
"verProc": "1.0.0.0", |
...
"cMunFG": "4106902" |
...
}, |
...
"emitente": { |
...
"cnpj": "82373077000171", |
...
"endereco": { |
...
"nro": "0", "uf": "PR", |
...
"cep": "81320400", |
...
"fone": "4184848484", |
...
"xBairro": "CABRAL", |
...
"xLgr": "AV Teste", |
...
"cMun": "4106902", |
...
"cPais": "1058", |
...
"xPais": "BRASIL", |
...
"xMun": "Curitiba" |
...
}, "ie": "1018146530", "crt": 3, |
...
"xNome": "BEMATECH SA", |
...
"xFant": "BEMATECH" |
...
}, |
...
"destinatario": { |
...
"cpf": "76643539129", |
...
"endereco": { "nro": "842", |
...
"uf": "PR", |
...
"cep": "80020320", |
...
"fone": "41927598874", |
...
"xBairro": "Centro", "xLgr": "Marechal Deodoro", |
...
"cMun": "4106902", |
...
"cPais": "1058", "xPais": "Brasil", "xMun": "Curitiba" |
...
}, "indIEDest": 9, |
...
"email": "[email protected]", |
...
"xNome": "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL " |
...
} |
...
} |
12.03. Método: DELETE (Utilizando Fiscal Manager NFC-E)
...
Exemplo de JSON de Retorno:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
{
|
...
"sucesso": true, |
...
"codigo": 9500, |
...
"descricao": "Operação realizada com sucesso" |
...
} |
13. EXEMPLOS JSON SAT
Os exemplos foram categorizados através do tipo de método utilizado.
13.01. Método: GET (Fiscal Manager NFC-E e SAT)
Recurso utilizado: Informações sobre o sistema |
Tipo de dados de Envio:application/JSON |
Tipo de dados de Retorno: application/JSON |
Detalhes da operação: Este método deve consultar informações do Fiscal Manager retornando um JSON com as seguintes informações: Versão do Fiscal Manager. Número total de notas rejeitadas. Número total de Notas rejeitas emitidas em contingência. Situação do Certificado digital. Data de expiração do certificado. Dias restantes para expirar. |
_Observação _: |
Em caso de sucesso a resposta será: (Status 200) SuccessFull Operation. |
...
SuccessFull Operation. |
Exemplo:
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
|
...
{ |
...
"versao": "02.00.00 build 01", |
...
"totalNotasRejeitadas": 1, |
...
"totalNotasRejeitasEmitidasContingencia": 0, |
...
"certificado": { |
...
"situacao": "No prazo", |
...
"dataExpiracao": "03/04/2017", |
...
"diasParaExpiracao": 97 |
...
}
|
...
} |
13.02. Método: POST (Utilizando Fiscal Manager SAT)
Recurso utilizado: Atualizar configurações do Fiscal Manager SAT. |
Tipo de dados de Envio:application/vnd+Bematech.fmsatconf-v1+json |
Tipo de dados de Retorno: application/vnd+Bematech.resposta-v1+json |
Detalhes da operação: Este irá cancelar uma nota gerada. |
_Observação _: |
Em caso de sucesso a resposta será: (Status 200) SuccessFull Operation. Este método não possui Parâmetros de retorno. |
Exemplo de JSON de envio
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
{ |
...
|
...
"configuracao": [{ |
...
"nome": "PROXY", |
...
"valor": "0" |
...
|
...
}, { |
...
|
...
"nome": "PRINT_LOGO", |
...
|
...
"valor": "1" |
...
}]
|
...
} |
13.03. Método: POST (Utilizando Fiscal Manager SAT)
Recurso utilizado: Abrir um cupom para venda. |
Tipo de dados de Envio:application/JSON |
Tipo de dados de Retorno: application/JSON |
Detalhes da operação: Este método abrirá o registro de uma venda. |
_Observação _: |
Em caso de sucesso a resposta será: (Status 200) SuccessFull Operation. |
Exemplo de JSON de envio
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
{ "identificacao": { |
...
"cnpj": "16716114000172", |
...
"numeroCaixa": "001", |
...
"signAC": "SGR-SAT SISTEMA DE GESTAO E RETAGUARDA DO SAT" |
...
}, |
...
"emitente": |
...
{ "cnpj": "61099008000141", |
...
"ie": "111111111111", |
...
"indRatISSQN": "S" |
...
}, |
...
"destinatario": { |
...
"cpf": "09324114107", |
...
"xNome": "Paulo" |
...
}, |
...
"entrega": { |
...
"cpf": "09324114107", |
...
"endereco": { |
...
"xLgr": "Rua |
...
Teste", "nro": "450", "xCpl": "teste", |
...
"xBairro": "Fazendinha", |
...
"xMun": "Curitiba", |
...
"uf": "PR" |
...
} |
...
} |
...
} |
...
3.04. Método: DELETE (Utilizando Fiscal Manager SAT)
Recurso utilizado: Estornar o registro de uma venda (cupom/nota). |
Tipo de dados de Envio:application/JSON |
Tipo de dados de Retorno: application/JSON |
Detalhes da operação: Este irá estornar uma nota gerada. |
_Observação _: |
Em caso de sucesso a resposta será: (Status 200) SuccessFull Operation. |
Exemplo de JSON de Retorno
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
|
...
| |||||
{
|
...
"sucesso": true |
...
} |
14. FLUXOS DE OPERAÇÃO USANDO A INTEGRAÇÃO DIRETA ATRAVÉS DA APIONE
...
Considerando uma venda (NFC-e ou SAT), que possua 2 produtos e uma única forma de pagamento, os seguintes recursos da API serão utilizados:
A listagem abaixo apresenta somente o nome dos métodos, para maiores informações sobre "URL Request" e conteúdo do JSON, consulte neste manual o tópico: "Recursos da API"
1. Abrir cupom
2. Adicionar Item de Venda
3. Adicionar Item de Venda
4. Adicionar Pagamento
5. Fechar cupom
...
6. Impressão de DANFE (via chave)
7. Impressão de DANFE (via número e série)
| Nota | ||
|---|---|---|
| ||
Lembrando que cada uma dos recursos/serviços da API recebe um retorno de execução também no formato JSON o tratamento destes retornos é de extrema importância para eventuais situações adversas durante a operação da aplicação. |
14.02. Obter informações do Sistema.
...
A dll receberá o JSON de retorno dentro de uma variável String. O tratamento do JSON deverá ser efetuado de acordo com a definição da linguagem utilizada para o desenvolvimento da aplicação.
Em caso de sucesso o retorno recebido pela função seguirá o seguinte padrão:
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "versao": "Fiscal Manager SAT - 3.0.0", "totalNotasRejeitadas": 0, "totalNotasRejeitasEmitidasContingencia": 0 } |
15. LEGISLAÇÃO
Para maiores informações e detalhes sobre a legislação, tanto em relação a NFC-E quanto ao SAT, você consultar os links abaixo:
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas