Histórico da Página

01. INTRODUÇÃO

Deverá conter uma breve explicação do que é a API e o que ela faz

02. INCLUIR TRANSAÇÃO POR EMPRESA

Totvs custom tabs box

tabs	Incluir transação por Empresa, B, C
ids	empre,transa,dados

Totvs custom tabs box items

default	yes
referencia	empre

Totvs custom tabs box

tabs	Envio, Retorno, Exemplo de implementação
ids	envio,retorno,cod

Totvs custom tabs box items

default	yes
referencia	envio

Totvs custom tabs box

tabs	URL, Corpo, Exemplo de Requisição, Detalhamento dos Campos
ids	urlE,corpoE,exE,campE

Totvs custom tabs box items

default	yes
referencia	urlE

Button

Cor	#61affe
Texto	GET
Link	.

https://www30.bhan.com.br:9443/api/v1/transacao/inclusao

Totvs custom tabs box items

default	no
referencia	corpoE

Corpo da requisição

Bloco de código

language	xml
theme	RDark

{  
   "cdEmpresa":9999,										
   "nrCNPJEmpresa": "XXXXXXXXXXXXXX",					
   "cdPessoa": 999999999,								
   "nrCPFCNPJPessoa": "XXXXXXXXXXXXXX",					
   "dtMovimento": "99/99/9999",							
   "cdTransacao": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",	
   "cdOperacao": 999999,								
   "cdVendedor": 999999,								
   "nrCPFVendedor": "XXXXXXXXXXX",						
   "itens": [
        {
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX",		
            "cdEspecie": "XXX",							
            "qtItem": 9999999.999,						
            "vlBruto": 9999999.99,						
            "vlDescontoItem": 9999999.99,				
            "vlDescontoCapa": 9999999.99,				
            "vlLiquido": 9999999.99,					
            "cdVendedor": 999999,						
            "nrCPFVendedor": "XXXXXXXXXXX"				
        },
       {
            "cdProduto": "XXXXXXXXXXXXXXXXXXXX",
            "cdEspecie": "XXX",
            "qtItem": 9999999.999,
            "vlBruto": 9999999.99,
            "vlDescontoItem": 9999999.99,
            "vlDescontoCapa": 9999999.99,
            "vlLiquido": 9999999.99,
            "cdVendedor": 999999,
            "nrCPFVendedor": "XXXXXXXXXXX"
        }
    ] 
}

Totvs custom tabs box items

default	no
referencia	exE

URL

Button

Cor	#61affe
Texto	GET
Link	.

https://www30.bhan.com.br:9443/api/v1/transacao/inclusao

BODY

Bloco de código

language	xml
theme	RDark

Totvs custom tabs box items

default	no
referencia	campE

IMAGEM 1 IMAGEM 2 IMAGEM 3

Nome	Tipo	Descrição	Exemplo	VA
cdEmpresa	Int	Código da empresa ou CNPJ *	"cdEmpresa":001	Imagem 1 - 5
nrCNPJEmpresa	String	CNPJ ou código da empresa *	"nrCNPJEmpresa": "Informar aqui o CNPJ da empresa"	--
cdPessoa	Int	Código da pessoa *	"cdPessoa": 217	Imagem 1 - 1
nrCPFCNPJPessoa	String	CPF ou CNPJ do cliente *	"nrCPFCNPJPessoa": "Informar aqui o CPF ou CNPJ da pessoa"	--
dtMovimento	String (Date)	Data do movimento	"dtMovimento": "25/11/2019"	Imagem 1 - 4
cdTransacao	String	Código da transação	"cdTransacao": "63"	Imagem 1 - 3
cdOperacao	Int	Código da operação	"cdOperacao": 999999	Imagem 3 - 12
cdVendedor	Int	Código do vendedor *	"cdVendedor": 5	Imagem 1 - 5
nrCPFVendedor	String	CPF do vendedor *	"nrCPFVendedor": "informar aqui o CPF do vendedor",	--
itens	Array	Array com os itens da transação
cdProduto	String	Código de barras ou reduzido do produto	"cdProduto": "208",	Imagem 2 - 6
cdEspecie	String	Espécie do produto	"cdEspecie": "XXX",	--
qtItem	Double	Quantidade de itens	"qtItem": 1	Imagem 2 - 10
vlBruto	Double	Valor bruto da transação	"vlBruto": 89.0000	Imagem 2 - 7
vlDescontoItem	Double	Valor desconto do item	"vlDescontoItem": 17.8000	Imagem 2 - 8
vlDescontoCapa	Double	Valor desconto de capa	"vlDescontoCapa": 0.0000	Imagem 2 - 9
vlLiquido	Double	Valor líquido da transação	"vlLiquido": 71.200	Imagem 2 - 11
cdVendedor	Int	Código do vendedor ou CPF *	"cdVendedor": 5	Imagem 1 - 5 **
nrCPFVendedor	String	CPF ou código do vendedor *	"nrCPFVendedor": "Informe aqui o CPF do vendedor"	--

* Caso o campo Código for informado, não existe a necessidade de informar o documento. Porém, caso o Código não for informado, o documento se torna obrigatório!

** No exemplo, foi utilizado o mesmo vendedor da venda para o item.

Totvs custom tabs box items

default	no
referencia	retorno

Totvs custom tabs box

tabs	Sucesso, Erro
ids	sucesso,erro

Totvs custom tabs box items

default	yes
referencia	sucesso

Bloco de código

language	xml
theme	RDark

{
  "cdEmpresa": 9999,
  "nrTransacao": 999999999
}

Totvs custom tabs box items

default	no
referencia	erro

EXEMPLO DE UMA REQUISIÇÃO Q DEU PAU

*COLOCAR OS TIPOS DE ERROS QUE PODE DAR

Totvs custom tabs box items

default	no
referencia	cod

Totvs custom tabs box items

default	no
referencia	transa

Totvs custom tabs box items

default	no
referencia	dados

Incluir transação por empresa
- Requisição que realiza a inclusão de uma transação por empresa.
- Link para documentação técnica: Inclusão de transação
Consultar transação
- Requisição que retorna as transações filtrando por dia e ou situação.
- Link para documentação técnica: Consulta de transação
Consultar dados de transação
- Requisição que retorna os dados da transação.
- Link para documentação técnica: Consulta dados de transação

Páginas filhas

Versões comparadas

Versão antiga 21

Nova versão 22

Chave

01. INTRODUÇÃO

02. INCLUIR TRANSAÇÃO POR EMPRESA

Incluir transação por empresa

Consultar transação

Consultar dados de transação