Control P Informática S/C Ltda.

AtendeSmart

Manual de integração de pedidos de venda – versão 1.0
10/03/2016

Esse documento visa orientar sobre o consumo do serviço (webservice) para transmissão de pedidos de vendas e captura de status dos pedidos importados.

Histórico de revisão

Versão	Data	Autor	Ação
1.0	03/10/2016	Arthur de Camargo	Criação do documento.

Sobre esse documento

Esse documento objetiva-se a explicar o sistema de troca de informações que o AtendeSmart disponibiliza para terceiros para envio de pedidos de vendas e verificação de seus status.

Sobre o webservice

Pendente: Descrever qual padrão foi utilizado.

Serviços disponíveis

Serviço	Descrição
importar_pedido	Recebe os pedidos, passando como parâmetros um usuário, sua senha, e um texto no formato XML com o leiaute do pedido a ser inserido no AtendeSmart.
consultar_status_pedido	Consulta o status do pedido, passando como parâmetros um usuário, sua senha, e o ID do pedido no AtendeSmart.

Descrição das colunas do leiaute

Coluna “Id #”: Identificação do campo no leiaute do XML.

Coluna “Campo”: Nome literal da tag (elemento) ou do atributo da tag.

Coluna “Descrição”: Descreve o propósito do campo.

Coluna “Elemento”: Descreve o tipo de elemento da estrutura do XML que é o campo. As siglas usadas são descritas na tabela abaixo:

Abreviatura	Descrição
G	O elemento é um grupo.
A	Atributo do elemento anterior.
RC	O campo é uma restrição de chave (key constraint), para garantir a unicidade de valor.
E	O campo é um elemento do XML.
EE	O campo é um elemento de escolha. Somente um dos elementos do grupo constará no resultado final do XML.

Tabela 1 – Elementos

Coluna “Pai”: Identifica, pelo “Id #”, qual o elemento hierarquicamente superior ao elemento que está sendo descrito.

Coluna “Tipo”: Identifica o tipo dos dados na coluna:

Sigla	Descrição
C	Campo alfanumérico
N	Campo numérico
D	Campo de data ou data e hora

Tabela 2 – Tipos dos campos

Coluna “Ocor.”: Indica a ocorrência do elemento no arquivo XML, no formato “x-y”, onde “x” indica a ocorrência mínima e “y” indica a ocorrência máxima.

Coluna “Tamanho”: Indica o tamanho do campo, no formato “x-y(vw-z)”, onde “x” indica o camanho mínimo e “y” o tamanho máximo. “v”, quando presente, indica a possibilidade de valores decimais, seguido de “w”, que indica a quantidade mínima de decimais esperado e “z”, a quantidade máxima de decimais. Na ausência de dois grupos de dígitos, o valor informado é a quantidade absoluta esperada.

Campo “Observações”: Apresenta informações adicionais referente ao(s) campo(s), como regras, limites ou detalhamento.

Leiaute XML dos pedidos

Para facilitar a integração, a importação utiliza como base um XML similar ao XML da nota fiscal eletrônica. Assim, sistemas que já possuem o processamento de NFe podem se integrar mais facilmente com o AtendeSmart.

ID #	Campo	Descrição	Elemento	Pai	Tipo	Ocor.	Tam.	Observação
1	NFe	TAG raíz do documento XML	G	–		1-1
1.1	infNFe	Informações do pedido	G	1	–	1-50
1.1a	versao	Versão do leiaute.	A	1.1	C	1-1	4	Preencher com o literal “1.00”.
1.1b	Id	Número sequencial de identificação do pedido no documento XML.	RC	1.1	N	1-1	1-2
1.1IDN	ide	Informações para identificação do pedido	G	1.1		1-1
1.1IDN1	dhEmi	Data e hora da emissão do pedido.	E	1.101	D	1-1		Data e hora no formato UTC (AAAA-MM-DDThh:mm:ssTZD).
1.1IDN2	indFinal	Indica operação com Consumidor final	E	1.102	N	1-1	1
1.1DES	dest	Informações do comprador do pedido.	G			1-1
1.1DES01	CNPJ	CNPJ do destinatário	EE	1DES	N	1-1	14	O destinatário será localizado por esses campos. É necessário informar, no caso de CNPJ e CPF, um número de documento válido, pois é utilizado na emissão da NFe/CFe.
1.1DES02	CPF	CPF do destinatário	EE	1DES	N	1-1	11
1.1DES03	idEstrangeiro	Identificação do destinatário estrangeiro.	EE	1DES	C	1-1	5-20
1.1DES04	xNome	Razão social ou nome completo do destinatário	C	1DES	C	1-1	2-100
1.1DES05	xNomeUsual	Nome usual do destinatário.	C	1DES	C	0-1	2-50
1.1DESEND	enderDest	Endereço do destinatário.	G	1DES		1-1
1.1DESEND01	xLgr	Logradouro.	E	1DESEND	C	1-1	2-60
1.1DESEND02	nro	Número.	E	1DESEND	C	1-1	1-20
1.1DESEND03	xCpl	Complemento.	E	1DESEND	C	0-1	1-50
1.1DESEND04	xBairro	Bairro.	E	1DESEND	C	1-1	2-60
1.1DESEND05	cMun	Código do IBGE do município.	E	1DESEND	N	0-1	7	Caso o campo não seja preenchido, o AtendeSmart tentará localizar o município correto usanto as tags “UF” e “xMun”.
1.1DESEND06	xMun	Nome do município.	E	1DESEND	C	1-1	2-50	Nome do município, conforme cadastrado no IBGE.
1.1DESEND07	UF	Sigla da UF.	E	1DESEND	C	1-1	2
1.1DESEND08	CEP	Código do CEP.	E	1DESEND	N	0-1	8	Informar os zeros não significativos. Obrigatório para destinatários nacionais.
1.1DESEND09	cPais	Código do país no BACEN.	E	1DESEND	N	0-1	4	Caso não seja informado, o AtendeSmart tentará encontrar usando a tabela interna, conforme cadastro do BACEN.
1.1DESEND10	xPais	Nome do país.	E	1DESEND	C	0-1	2-50	Nome do país, conforme registrado na tabela do BACEN. Caso não seja informado, o sistema assumirá “Brasil”.
1.1DESEND11	fone	Telefone.	E	1DESEND	N	0-1	6-14	Preencher com DDD e número do telefone. Nas operações com o exterior é permitido informar o código do país, código da localidade e número do telefone.
1.1DES06	indIEDest	Indicador da inscrição estadual do estinatário.	E	1DES	N	0-1	1	1 = Contribuinte do ICMS (Informar a inscrição estadual do destinatário); 2 = Constribuinte isento de inscrição no cadastro de contribuintes estadual; 9 = Não contribuinte.   Caso não seja informado, o sistema informará a opção “1 – Contribuinte do ICMS” caso tenha sido informado a inscrição estadual e “9 – Não contribuinte” na ausência da tag IE.
1.1DES07	IE	Inscrição estadual do destinatário.	E	1DES	N	0-1	2-14
1.1DES08	ISUF	Inscrição na SUFRAMA.	E	1DES	N	0-1	8-9
1.1DES09	IM	Inscrição municipal do tomador do serviço.	E	1DES	C	0-1	1-15	Inscrição municipal do tomador do serviço.
1.1DES10	email	Email.	E	1DES	C	0-1	1-300
1.1DES11	RG	RG.	E	1DES	C	0-1	6-9
1.1ENT	entrega	Endereço de entrega.	G	1.1		0-1		Preencher se o endereço de entrega for diferente do endereço informado no destinatário.
1.1ENT01	CNPJ	CNPJ.	EE	1ENT	N	0-1	14	Informar um dos dois, se for diferente do informado no cadastro do destinatário.
1.1ENT02	CPF	CPF.	EE	1ENT	N	0-1	11
1.1ENT03	xLgr	Logradouro.	E	1ENT	C	1-1	2-100
1.1ENT04	nro	Número.	E	1ENT	C	1-1	1-50
1.1ENT05	xCpl	Complemento.	E	1ENT	C	0-1	1-50
1.1ENT06	xBairro	Bairro	E	1ENT	C	1-1	2-50
1.1ENT07	cMun	Código do município no IBGE.	E	1ENT	N	0-1	7	Informar o código do município de acordo com a tabela do IBGE. Caso não informado, o AtendeSmart tentará localizar o código através do nome do município e UF.
1.1ENT08	xMun	Nome do município, conforme cadastrado no IBGE.	E	1ENT	C	1-1	2-50
1.1ENT09	UF	Sigla da UF	E	1ENT	C	1-1	2
1.1ITN	det	Detalhamento dos itens.	G	1.1		1-990
1.1ITNPRD	prod	Detalhamento de produtos e serviços.	G	1.1ITN		1-1
1.1INTPRD01	cProd	Código do produto ou serviço.	E	1.1ITNPRD	C	1-1	1-50	Código do produto ou serviço. O AtendeSmart usará o conteúdo desse campo para vincular um item do pedido a um produto cadastrado.
1.1INTPRD02	cEAN	Código de barras EAN.	E	1.1ITNPRD	N	0-1	8, 12, 13, 14	Preencher exclusivamente com o código GTIN-8, GTIN-12, GTIN-13 ou GTIN-14.
1.1ITNPRD03	xProd	Nome do produto ou do serviço.	E	1.1ITNPRD	C	1-1	1-100
1.1ITNPRD04	NCM	Código NCM de oito dígitos.	E	1.1ITNPRD	N	0-1	8
1.1ITNPRD05	NVE	Códificação NFE – Nomenclatura de valor aduaneiro e estatística.	E	1.1ITNPRD	C	0-8	6	Codificação opcional que detalha alguns NCM, formado por duas letras maiúsculas e quatro algarísmos. Se a mercadoria se enquadrar em mais de uma codificação, informar até 8 codificações principais.
1.1ITNPRD06	EXTIPI	EX da TIPI.	E	1.1ITNPRD	N	0-1	2-3
1.1ITNPRD07	CFOP	Código fiscal da operação ou prestação.	E	1.1ITNPRD	N	0-1	4
1.1ITNPRD08	uCom	Unidade comercial.	E	1.1ITNPRD	C	1-1	1-6	Unidade de comercialização do produto.
1.1ITNPRD09	qCom	Quantidade comercial.	E	1.1ITNPRD	C	1-1	11v0-4	Quantidade de comercialização do produto.
1.1ITNPRD10	vUnCom	Valor da unidade comercial.	E	1.1ITNPRD	N	1-1	11v0-3	Valor de venda da unidade comercializada.
1.1ITNPRD11	vProd	Valor total do produto ou serviço.	E	1.1ITNPRD	N	1-1	13v2	Valor total de venda do item.
1.1ITNPRD12	cEANTrib	GTIN da unidade tributável/controle.	E	1.1ITNPRD	N	0-1	8, 12, 13, 14	Preencher exclusivamente com os códigos GTIN-8, GTIN-12, GTIN-13 e GTIN-14, se diferir do informado na tag “cEAN” do item.
1.1ITNPRD13	uTrib	Unidade tributável.	E	1.1ITNPRD	C	0-1	1-6	Informar caso os valores divirjam dos valores comerciais do item, ou para fins fiscais.
1.1ITNPRD14	qTrib	Quantidade tributável.	E	1.1ITNPRD	N	0-1	11v0-4
1.1ITNPRD15	vUnTrib	Valor unitário tributado.	E	1.1ITNPRD	N	0-1	11v0-3
1.1ITNPRD16	vFrete	Valor do frete do item.	E	1.1ITNPRD	N	0-1	13v2
1.1ITNPRD17	vSeg	Valor do seguro do item.	E	1.1ITNPRD	N	0-1	13v2
1.1ITNPRD18	vDesc	Valor do desconto.	E	1.1ITNPRD	N	0-1	13v2
1.1ITNPRD19	vOutro	Valor de outras despesas acrescidas.	E	1.1ITNPRD	N	0-1	13v2
1.1ITNPRD20	indTot	Indicador se o item compõe o valor total do pedido.	E	1.1ITNPRD	N	0-1	1	0 = Valor do item não compõe o total do pedido/NF/CF; 1 = Valor do item compõe o valor total do pedido/NF/CF (Padrão caso não seja informado a tag).
1.1ITNPRD21	xPed	Identificação do pedido de origem.	E	1.1ITNPRD	C	0-1	1-15
1.1ITNPRD22	nItemPed	Item do pedido de origem.	E	1.1ITNPRD	N	0-1	6
1.1ITNMED	med	Informações sobre medicamentos e matérias primas	GE²	1.1ITN		0-500
1.1ITNMED01	nLote	Número do lote de medicamentos ou de matérias prima farmacêuticas.	E	1ITNMED	C	1-1	1-20
1.1ITNMED02	qLote	Quantidade de produtos do lote.	E	1ITNMED	N	1-1	8v3
1.1ITNMED03	dFab	Data de fabricação.	D	1ITNMED	D	1-1		Formato “AAAA-MM-DD”.
1.1ITNMED04	dVal	Data de validade.	D	1ITNMED	D	1-1		Formato “AAAA-MM-DD”.
1.1ITNMED05	vPMC	Preço máximo ao consumidor.	N	1ITNMED	N	1-1	13v2
1.1ITNCMB	comb	Informações específicas para combustíveis liquidos e lubrificantes.	GE²	1.1ITN		0-1
1.1ITNCMB01	cProdANP	Código do produto da ANP.	E	1.1ITNCMB	N	1-1	9
1.1ITNCMB02	pMixGN	Percentual de gás natural para o produto GLP.	E	1.1ITNCMB	N	0-1	3v4	Informar quando houver mistura para o cProdANP=210203001.
1.1ITNCMB03	CODIF	Registro do CODIF.	E	1.1ITNCMB	N	0-1	1-21
1.1ITNCMB04	qTemp	Quantidade de combustível faturado à temperatura ambiente.	E	1.1ITNCMB	N	0-1	12v4
1.1ITNCMB05	UFCons	Sigla da UF de consumo.	E	1.1ITNCMB	C	1-1	2
1.1ITNCMBCIDE	CIDE	Informações do CIDE.	G	1.1ITNCMB		0-1
1.1ITNCMBCIDE1	qBCProd	Valor de base de cálculo do CIDE.	E	1.1ITNCMBCIDE	N	1-1	12v0-4
1.1ITNCMBCIDE2	vAliqProd	Valor da alíquota (em reais) do CIDE.	E	1.1ITNCMBCIDE	N	1-1	11v4
1.1ITNCMBCIDE3	vCIDE	Valor do CIDE.	E	1.1ITNCMBCIDE	N	1-1	13v2
1.1ITN01	infAdProd	Informações adicionais do produto.	E	1.1ITN	C	0-1	1-500	Norma referenciada, informações complementares, leis, portarias, etc.
1.1TNP	transp	Informações do transporte.	G	1.1		0-1
1.1TNP01	modFrete	Modalidade do frete.	E	1.1TNP	N	0-1	1	0 = Por conta do emitente; 1 = Por conta do destinatário (Padrão se houver valores); 2 = Por conta de terceiros; 9 = Sem frete (Padrão se não houver valores).
1.1TNPTRA	transporta	Informações da transportadora.	G			0-1
1.1TNPTRA01	CNPJ	CNPJ da transportadora.	EE¹	1.1TNPTRA	N	0-1	14
1.1TNPTRA02	CPF	CPF do transportador.	EE¹	1.1TNPTRA	N	0-1	11
1.1TNPTRA03	xNome	Razão social ou nome completo.	E	1.1TNPTRA	C	0-1	2-50
1.1TNPTRA04	IE	Inscrição estadual.	E	1.1TNPTRA	C	0-1	2-14	1. Informar a inscrição estadual, sem caracteres de formatação, para transportador contribuinte do ICMS; 1.1. A UF deve ser informada para os contribuintes. 2. Informar o literal “ISENTO” para transportador isento de inscrição no cadastro de contribuintes do ICMS; 3. Não informar a tag para não contribuintes do ICMS.
1.1TNPTRA05	xEnder	Endereço completo.	E	1.1TNPTRA	C	0-1	1-100	Incluir número e complemento.
1.1TNPTRA06	xMun	Nome do município.	E	1.1TNPTRA	C	0-1	1-50
1.1TNPTRA07	UF	Sigla da UF.	E	1.1TNPTRA	C	0-1	2	O campo é obrigatório caso tenha sido informado o IE.
1.1COB	cobr	Dados de cobrança.	G	1.1		0-1
1.1COBFAT	fat	Dados da fatura.	G	1.1COB		0-1
1.1COBFAT01	nFat	Número da fatura.	E	1.1COBFAT	C	0-1	1-6
1.1COBFAT02	vOrig	Valor original da fatura.	E	1.1COBFAT	N	0-1	13v2
1.1COBFAT03	vDesc	Valor do desconto.	E	1.1COBFAT	N	0-1	13v2
1.1COBFAT04	vLiq	Valor líquido da fatura.	E	1.1COBFAT	N	0-1	13v2
1.1COBDPL	dup	Grupo de duplicatas.	G	1.1COB		0-120
1.1COBDPL01	nDup	Número da duplicata.	E	1.1COBDPL	C	0-1	1-60
1.1COBDPL02	dVenc	Data de vencimento.	E	1.1COBDPL	D	0-1		Formato “AAAA-MM-DD”.
1.1COBDPL03	vDup	Valor da duplicata.	E	1.1COBDPL	N	1	13v2

Leiaute de resposta do envio dos pedidos

ID #	Campo	Descrição	Elemento	Pai	Tipo	Ocor.	Tam.	Observação
00	resposta	TAG raíz do documento XML	G	–		1-1
0000	retorno	TAG com o conteúdo do retorno	G	00		1-1
000000	codigo	Código do retorno.	E	0000	N	1-1	3	Ver tabela “Retornos”.
000001	mensagem	Descrição do retorno.	E	0000	C	1-1	1-100
000002	idNF	Identificação do pedido no AtendeSmart.	E	0000	N	1-1	9
000003	idNFDestinatario	Identificação do destinatário no AtendeSmart.	E	0000	N	1-1	9
000004	itens	Grupo com os itens do pedido.	G	0000		1-1
00000400	idNFItem	Identificação do item do pedido no AtendeSmart.	E	000004	N	0-990	9
000005	duplicatas	Grupo das duplicatas.	G	0000		1-1
00000501	idDuplicata	Identificação da duplicada no AtendeSmart.	E	000005	N	0-120	9
000006	totalNF	Valor total do pedido.	E	0000	N	1-1	13v0-2

Leiaute do retorno do status do pedido

ID #	Campo	Descrição	Elemento	Pai	Tipo	Ocor.	Tam.	Observação
00	resposta	TAG raíz do documento XML	G	–		1-1
0000	retorno	TAG com o conteúdo do retorno	G	00		1-1
000000	codigo	Código do retorno.	E	0000	N	1-1	3	Ver tabela “Retornos”.
000001	mensagem	Descrição do retorno.	E	0000	C	1-1	1-100

Tabela de retornos

Importação de pedidos

Id#	Mensagem
000	Pedido não inserido.
002	Não foi possível inserir dados do pedido no banco de dados.
100	Pedido importado.
122	Não foi possível carregar o XML.
200	XML inválido.
489	Não foi possível carregar o XML (Conexão inválida).
045	Não foi possível carregar o XML (String em branco).

Consulta de status do pedido

Id #	Mensagem
100	Pedido encontrado.
456	Id do pedido inválido.
458	Id do pedido deve ser maior que zero.
489	Não foi possível carregar o XML (Conexão inválida).
876	XML inválido.
900	Pedido não encontrado.

Envio dos pedidos

Endereço do webservices: https://www.atendesmart.com.br/???????/?????????.php

Serviços disponíveis:
importar_pedido consultar_status_pedido