Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

01. CONTEÚDO

Índice
minLevel2indent10px
stylenonelist-group-item

02. VISÃO GERAL

A APIOne é ferramenta que integra a Plataforma Fiscal com a sua aplicação de automação comercial. Nossa API conta com um amplo conjunto de funções que permite a emissão de documentos fiscais (NFC-e e CF-e). Trabalhando com a tecnologia JSON, a integração de sua aplicação com a nossa plataforma fiscal agora pode ser executada de maneira direta, sem a necessidade de uso de middleware para interface com o Fiscal Manager. Ao utilizar a API você terá mais controle sobre o processo de emissão de notas, trazendo benefícios para a gestão de informações dentro da aplicação.

...

Por ser uma ferramenta versátil, você pode usar a API de forma direta, consumindo os recursos disponibilizados por ela, ou ainda se preferir você também pode usar a API através da BemaOne.dll, esta, por sua vez, atuará diretamente como uma interface entre o seu software e a Plataforma Fiscal a API.


Card documentos

...

InformacaoO uso da BemaOne.dll lhe permite trabalhar com a APIOne, mesmo em linguagens mais antigas,
TituloDICA


Usar a APIOne reduz o número de componentes de integração, facilita a atualização e a manutenção em sua aplicação e também melhora a performance na emissão de documentos uma vez que toda a integração utilizará um componente único.

No gráfico abaixo apresentamos os componentes para integração através da API.

diagrama APIOne

04. VANTAGENS

...

EM SE UTILIZAR A APIONE

  • Flexibilidade: Você pode usar a APIOne de forma nativa, consumindo os serviços REST para integração da Plataforma Fiscal com sua automação comercial. Mas se preferir também é possível utilizar a BemaOne.dll que através de um conjunto de funções também consumirá os serviços da APIOne. Utilizando os serviços REST ou a BemaOne.dll abrimos um leque de possibilidades para que o processo de desenvolvimento e integração atenda as principais necessidades do mercado de Software.

  • Integração MultiPlataforma: Uma única ferramenta, várias plataformas! A APIOne por permitir a integração nativa através de serviços RestFul, você poderá atender novas demandas do mercado de maneira rápida.

  • Várias legislações uma única ferramenta: Através da API você pode de maneira unificada emitir NFC-e e CF-e permitindo que a administração e atualização de componentes dentro do software ocorra de forma simplificada.

  • Maior controle para aplicação: Sua aplicação passa a ter maior controle sobre o processo de emissão de notas. Este controle ocorre desde a gestão da numeração de notas, data e hora de emissão até a gestão de tributos necessários nas operações de venda, bem como rotinas de cálculo de acréscimo e desconto.

  • Facilidade e agilidade na integração : A APIOne utiliza a tecnologia JSON, facilitando o envio e recebimento de comandos e reduzindo o tempo gasto no processo de integração.

...

Agora que já apresentamos a você as vantagens e a arquitetura da nova API, vamos ver em detalhes como iniciar a integração da Plataforma Fiscal através da APIOne.

05.01.

...

Integração da Plataforma Fiscal usando APIOne + BemaOne.dll

Neste método de integração a dll torna-se uma camada intermediária entre a sua aplicação e o Fiscal Manager e a API.

...

Dica

Para informações sobre o processo de instalação do Fiscal Manager, consulte: Pré-Requisitos da Plataforma Fiscal+Instalação da Plataforma Fiscal (Fiscal Manager)

Uma vez que o Fiscal Manager esteja instalado e configurado corretamente, as rotinas de integração podem ser iniciadas.

...


Parâmetros de retorno da função.

Bloco de código
languagexml
firstline1
titleParâmetros de retorno da funçao
linenumberstrue
collapsetrue
{

...

	"sucesso": false,

...

	"codigo": 0,

...

	"descricao": "string",

...

	"numeroSessao": "string"

...

}

...

08.03. Bematech_Fiscal_FecharNota

...

Descrição:

Utilize esta função para o registro de um item dentro na nota.

Tipo:

String.

Exemplo:

Bematech_Fiscal_VenderItem(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
languagexml
firstline1
titleParâmetros de entrada da função

...

linenumberstrue
collapsetrue
{
	"nItem": 0,

...

	"produto": {

...

		"cProd": "string",

...

		"cean": "string",

...

		"xProd": "string",

...

		"ncm": "string",

...

		"nve": "string",

...

		"extipi": "string",

...

		"cfop": "string",

...

		"uCom": "string",

...

		"qCom": "string",

...

		"vUnCom": 0,

...

		"vProd": 0,

...

		"indRegra": 0,

...

		"ceanTrib": "string",

...

		"uTrib": "string",

...

		"qTrib": 0,

...

		"vUnTrib": "string",

...

		"vFrete": 0,

...

		"vSeg": 0,

...

		"vDesc": 0,

...

		"vOutro": 0,

...

		"vItem": 0,

...

		"vRatDesc": 0,

...

		"vRatAcr": 0,

...

		"indTot": 0,

...

		"cest": "string",

...

		"declaracoesImportacao": [

...

{

...

			"ndi": "string",

...

			"ddi": "2016-08-23T20:24:30.570Z",

...

			"xLocDesemb": "string",

...

			"ufDesemb": "string",

...

			"dDesemb": "2016-08-23T20:24:30.570Z",

...

			"tpViaTransp": 0,

...

			"vafrmm": 0,

...

			"tpIntermedio": 0,

...

			"cnpj": "string",

...

			"ufTerceiro": "string",

...

			"cExportador": "string",

...

			"adicoes": [

...

{

...

				"nAdicao": 0,

...

				"nSeqAdic": 0,

...

				"cFabricante": "string",

...

				"vDescDI": 0,

...

				"nDraw": 0

...

			}]
		}],
		"detsExportacao": [

...

{

...

			"nDraw": 0,

...

			"exportacaoIndireta": {

...

				"nre": "string",

...

				"chNFe": "string",

...

				"qExport": 0

...

			}

...

		}],

...

		"xPed": "string",

...

		"nItemPed": "string",

...

		"nfci": "string",

...

		"veiculo": {

...

			"tpOp": 0,

...

			"chassi": "string",

...

			"cCor": "string",

...

			"xCor": "string",

...

			"pot": "string",

...

			"cilin": "string",

...

			"pesoL": "string",

...

			"pesoB": "string",

...

			"nSerie": "string",

...

			"tpComb": "string",

...

			"nMotor": "string",

...

			"cmt": "string",

...

			"dist": "string",

...

			"anoMod": 0,

...

			"anoFab": 0,

...

			"tpPint": "string",

...

			"tpVeic": 0,

...

			"espVeic": 0,

...

			"vin": "string",

...

			"condVeic": 0,

...

			"cMod": "string",

...

			"cCorDENATRAN": 0,

...

			"lota": 0,

...

			"tpRest": 0

...

		},

...

		"medicamentos": [

...

{

...

			"nLote": "string",

...

			"qLote": 0,

...

			"dFab": "2016-08-23T20:24:30.570Z",

...

			"dVal": "2016-08-23T20:24:30.570Z",

...

			"vpmc": 0

...

		}],

...

		"armamentos": [

...

{

...

			"tpArma": 0,

...

			"nSerie": "string",

...

			"nCano": "string",

...

			"descr": "string"

...

		}],

...

		"combustivel": {

...

			"cProdANP": "string",

...

			"pMixGN": 0,

...

			"codif": "string",

...

			"qTemp": 0,

...

			"ufCons": "string",

...

			"cide": {

...

				"qbcProd": 0,

...

				"vAliqProd": 0,

...

				"vcide": 0

...

			},

...

			"encerrante": {

...

				"nBico": "string",

...

				"nBomba": "string",

...

				"nTanque": "string",

...

				"vEncIni": "string",

...

				"vEncFin": "string"

...

			}

...

		},

...

		"nrecopi": "string",

...

		"obsFiscoDetalhamento": [

...

{

...

			"getxCampoDet": "string",

...

			"getxTextoDet": "string"

...

		}]

...

	},

...

	"imposto": {

...

		"vTotTrib": 0,

...

		"icms": {

...

			"icms00": {

...

				"orig": 0,

...

				"cst": "string",

...

				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0

...

			},

...

			"icms10": {

...

				"orig": 0,

...

				"cst": "string",

...

				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...

				"pRedBCST": 0,

...

				"vBCST": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0

...

			},

...

			"icms20": {

...

				"orig": 0,

...

				"cst": "string",

...

				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"pRedBC": 0,

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0

...

			},

...

			"icms30": {

...

				"orig": 0,

...

				"cst": "string",

...

				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...

				"pRedBCST": 0,

...

				"vBCST": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0,

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0

...

			},

...

			"icms40": {

...

				"orig": 0,

...

				"cst": "string",

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0

...

			},

...

			"icms41": {

...

				"orig": 0,

...

				"cst": "string",

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0

...

			},

...

			"icms50": {

...

				"orig": 0,

...


				"cst": "string",

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0

...

			},

...

			"icms51": {

...

				"orig": 0,

...

				"cst": "string",

...

				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0,

...

				"pRedBCST": 0,

...

				"vicmsOp": 0,

...

				"pDif": 0,

...

				"vicmsDif": 0

...

			},

...

			"icms60": {

...

				"orig": 0,

...

				"cst": "string",

...

				"vbcstRet": 0,

...

				"vicmsstRet": 0

...

			},

...

			"icms70": {

...

				"orig": 0,

...

				"cst": "string",

...


				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...

				"pRedBCST": 0,

...

				"vBCST": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0,

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0,

...

				"pRedBC": 0

...

			},

...

			"icms90": {

...

				"orig": 0,

...

				"cst": "string",

...

				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...

				"pRedBCST": 0,

...

				"vBCST": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0,

...

				"vicmsDeson": 0,

...

				"motDesICMS": 0,

...


				"pRedBC": 0

...

			},

...

			"icmsPart": {

...

				"orig": 0,

...

				"cst": "string",

...

				"modBC": 0,

...

				"vbc": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...

				"pRedBCST": 0,

...

				"vBCST": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0,

...

				"pRedBC": 0,

...

				"pbcOp": 0,

...

				"ufst": "string"

...

			},

...

			"icmsst": {

...

				"orig": 0,

...

				"cst": "string",

...

				"vbcstRet": "string",

...

				"vicmsstRet": "string",

...

				"vbcstDest": "string",

...

				"vicmsstDest": "string"

...

			},

...

			"icms101": {

...

				"orig": 0,

...

				"csosn": 0,

...

				"pCredSN": 0,

...

				"vCredICMSSN": 0

...

			},

...

			"icms102": {

...

				"orig": 0,

...

				"csosn": 0

...

			},

...

			"icms201": {

...

				"orig": 0,

...

				"csosn": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...

				"pRedBCST": 0,

...

				"vbcst": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0,

...

				"pCredSN": 0,

...

				"vCredICMSSN": 0

...

			},

...

			"icms202": {

...

				"orig": 0,

...

				"csosn": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...


				"pRedBCST": 0,

...

				"vbcst": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0

...

			},

...

			"icms500": {

...

				"orig": 0,

...

				"csosn": 0,

...

				"vbcstRet": 0,

...

				"vicmsstRet": 0

...

			},

...

			"icms900": {

...

				"orig": 0,

...

				"csosn": 0,

...

				"modBC": 0,

...

				"vbc": 0,

...

				"pRedBC": 0,

...

				"picms": 0,

...

				"vicms": 0,

...

				"modBCST": 0,

...

				"pmvast": 0,

...

				"pRedBCST": 0,

...

				"vbcst": 0,

...

				"picmsst": 0,

...

				"vicmsst": 0,

...

				"pCredSN": 0,

...

				"vCredICMSSN": 0

...

			}

...

		},

...

		"ipi": {

...

			"clEnq": "string",

...

			"cnpjProd": "string",

...

			"cSelo": "string",

...

			"qSelo": 0,

...

			"cEnq": "string",

...

			"ipiTrib": {

...

				"cst": "string",

...

				"vbc": 0,

...

				"pipi": 0,

...

				"qUnid": 0,

...

				"vUnid": 0,

...

				"vipi": 0

...

			},

...

			"ipint": {

...

				"cst": "string"

...

			}

...

		},

...

		"ii": {

...

			"vbc": 0,

...

			"vDespAdu": 0,

...

			"vii": 0,

...

			"viof": 0

...

		},

...

		"pis": {

...

			"pisAliq": {

...

				"cst": "string",

...

				"vbc": 0,

...

				"ppis": 0,

...

				"vpis": 0

...

			},

...

			"pisQtde": {

...

				"cst": "string",

...

				"qbcProd": 0,

...

				"vAliqProd": 0,

...

				"vpis": 0

...

			},

...

			"pisnt": {

...

				"cst": "string"

...

			},

...

			"pisOutr": {

...

				"cst": "string",

...

				"vbc": 0,

...

				"ppis": 0,

...

				"qbcProd": 0,

...

				"vAliqProd": 0,

...

				"vpis": 0

...

			},

...

			"pissn": {

...

				"cst": "string"

...

			}

...

		},

...

		"pisst": {

...

			"vbc": 0,

...

			"ppis": 0,

...

			"qbcProd": 0,

...

			"vAliqProd": 0,

...

			"vpis": 0

...

		},

...

		"cofins": {

...

			"cofinsAliq": {

...

				"cst": "string",

...

				"vbc": 0,

...

				"pcofins": 0,

...

				"vcofins": 0

...

			},

...

			"cofinsQtde": {

...

				"cst": "string",

...

				"qbcProd": 0,

...

				"vAliqProd": 0,

...

				"vcofins": 0

...

			},

...

			"cofinsnt": {

...

				"cst": "string"

...

			},

...

			"cofinsOutr": {

...

				"cst": "string",

...

				"vbc": 0,

...

				"pcofins": 0,

...

				"qbcProd": 0,

...

				"vAliqProd": 0,

...

				"vcofins": 0

...

			}

...

		},

...

		"cofinsst": {

...

			"vbc": 0,

...

			"pcofins": 0,

...

			"qbcProd": 0,

...

			"vAliqProd": 0,

...

			"vcofins": 0

...

		},

...

		"issqn": {

...

			"vbc": 0,

...

			"vAliq": 0,

...

			"vissqn": 0,

...

			"cMunFG": 0,

...

			"cListServ": "string",

...

			"vDeducao": 0,

...

			"vOutro": 0,

...

			"vDescIncond": 0,

...

			"vDescCond": 0,

...

			"vissRet": 0,

...

			"indISS": 0,

...

			"cServico": "string",

...

			"cMun": 0,

...

			"cPais": 0,

...

			"nProcesso": "string",

...

			"indIncentivo": 0,

...

			"cNatOp": "string"

...

		},

...

		"vItem12741": "string"

...

	},

...

	"impostoDevolvido": {

...

		"pDevol": 0,

...

		"ipiDevolvido": {

...

			"vipiDevol": "string"

...

		}

...

	},

...

	"infAdProd": "string"

...

}




Parâmetros de retorno da função.
1{
2"sucesso": false,
3"codigo": 0,
4"descricao": "string"
5}

...