Histórico da Página

Totvs custom tabs box

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

Totvs custom tabs box items

default	yes
referencia	empre

01. INTRODUÇÃO

Requisição que realiza a inclusão de uma transação por empresa.

Link para documentação técnica: Inclusão de transação

02. UTILIZAÇÃO

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, Body, 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

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

{  
   "cdEmpresa":001,										
   "cdPessoa": 217,										
   "dtMovimento": "25/11/2019",							
   "cdTransacao": "63",	
   "cdOperacao":  501,								
   "cdVendedor": 5,										
   "itens": [
        {
            "cdProduto": "50",		
            "cdEspecie": "XXX",							
            "qtItem": 1,						
            "vlBruto": 259.000,						
            "vlDescontoItem":0.0000 ,				
            "vlDescontoCapa": 0.0000,				
            "vlLiquido": 259.00,					
            "cdVendedor": 5,							
        },
       {
            "cdProduto": "208",
            "cdEspecie": "XXX",
            "qtItem": 1,
            "vlBruto": 89.0000,
            "vlDescontoItem": 17.8000,
            "vlDescontoCapa": 0.0000,
            "vlLiquido": 71.200,
            "cdVendedor": 5,
        }
    ] 
}

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 **	"cdEmpresa":001	Imagem 1 - 5
nrCNPJEmpresa	String	CNPJ da empresa **	"nrCNPJEmpresa": "Informar aqui o CNPJ da empresa"	--
cdPessoa	Int	Código do cliente **	"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": 501	Imagem 3 - 12
cdVendedor	Int	Código do vendedor **	"cdVendedor": 5	Imagem 1 - 2
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 **	"cdVendedor": 5	Imagem 1 - 2 ****
nrCPFVendedor	String	CPF do vendedor **	"nrCPFVendedor": "Informe aqui o CPF do vendedor"	--

* GUID

** 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!

*** O código da operação pode ser encontrado no componente GERFM065.

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

Informações
Todos os campos são obrigatórios. Caso possua a opção de informar código e/ou documento, pelo menos um dos campos deve ser informado!

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

Implementação da API em C#

Totvs custom tabs box items

default	no
referencia	transa

01. INTRODUÇÃ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

02. UTILIZAÇÃO

Totvs custom tabs box

tabs	Envio, Retorno, Exemplo de implementação
ids	envioT,retornoT,codT

Totvs custom tabs box items

default	yes
referencia	envioT

Totvs custom tabs box

tabs	URL, Body, Exemplo de Requisição, Detalhamento dos Campos
ids	urlT,corpoT,exT,campT

Totvs custom tabs box items

default	yes
referencia	urlT

Button

Cor	#61affe
Texto	GET
Link	.

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

Totvs custom tabs box items

default	no
referencia	corpoT

Bloco de código

theme	RDark

{
        "cdEmpresa": 9999,									
        "nrCNPJEmpresa": "XXXXXXXXXXXX",					
        "cdPessoa": 9999,										
        "nrCPFCNPJPessoa": "XXXXXXXXXXXX",					
        "dtMovimento": "99/99/9999",						
        "situacoes": [9],										
        "cdOperacao": 9999,									
        "cdVendedor": 9999,									
        "nrCPFVendedor": "XXXXXXXXXXXX"
}

Totvs custom tabs box items

default	no
referencia	exT

URL

Button

Cor	#61affe
Texto	GET
Link	.

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

BODY

Bloco de código

language	xml
theme	RDark

Totvs custom tabs box items

default	no
referencia	campT

IMAGEM 1 IMAGEM 2

Nome	Tipo	Descrição	Exemplo	VA
cdEmpresa *	Int	Código da empresa **	"cdEmpresa":001	Imagem 1 - 5
nrCNPJEmpresa	String	CNPJ da empresa **	"nrCNPJEmpresa": "Informar aqui o CNPJ da empresa"	--
cdPessoa	Int	Código do cliente **	"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
situacoes	Array	Situação da transação	"situações": [1,2,3,4]
cdOperacao	Int	Código da operação ***	"cdOperacao": 501	Imagem 2 - 12
cdVendedor	Int	Código do vendedor **	"cdVendedor": 5	Imagem 1 - 2
nrCPFVendedor	String	CPF do vendedor **	"nrCPFVendedor": "informar aqui o CPF do vendedor",	--

* Obrigatório

** 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!

*** O código da operação pode ser encontrado no componente GERFM065.

Totvs custom tabs box items

default	no
referencia	retornoT

Totvs custom tabs box

tabs	Sucesso, Erro
ids	sucessoT,erroT

Totvs custom tabs box items

default	yes
referencia	sucessoT

Bloco de código

theme	RDark

{
        "cdEmpresa": 9999,									
        "nrTransacao": 9999,						
        "dtTransacao": "99/99/9999",
}

Totvs custom tabs box items

default	no
referencia	erroT

EXEMPLO DE UMA REQUISIÇÃO Q DEU PAU

*COLOCAR OS TIPOS DE ERROS QUE PODE DAR

Totvs custom tabs box items

default	no
referencia	codT

Implementação da API em C#

Totvs custom tabs box items

default	no
referencia	dados

01. INTRODUÇÃO

Requisição que retorna os dados da transação.

Link para documentação técnica: Consulta dados de transação

02. UTILIZAÇÃO

Totvs custom tabs box

tabs	Envio, Retorno, Exemplo de implementação
ids	envioD,retornoD,codD

Totvs custom tabs box items

default	yes
referencia	envioD

Totvs custom tabs box

tabs	URL, Body, Exemplo de Requisição, Detalhamento dos Campos
ids	urlD,corpoD,exD,campD

Totvs custom tabs box items

default	yes
referencia	urlD

Button

Cor	#61affe
Texto	GET
Link	.

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

Totvs custom tabs box items

default	no
referencia	corpoD

Bloco de código

theme	RDark

{
        "cdEmpresa": 9999,									
        "nrCNPJEmpresanrTransacao": "XXXXXXXXXXXX",					
        "cdPessoa": 9999,										
        "nrCPFCNPJPessoadtTransacao": "XXXXXXXXXXXX",					
        "dtMovimento": "99/99/9999",						
        "situacoes": [9],										
        "cdOperacao": 9999,									
        "cdVendedor": 9999,									
        "nrCPFVendedor": "XXXXXXXXXXXX"
}

Totvs custom tabs box items

default	no
referencia	exD

Totvs custom tabs box items

default	no
referencia	exD

URL

Button

Cor	#61affe
Texto	GET
Link	.

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

BODY

Bloco de código

language	xml
theme	RDark

URL

BODY

* Obrigatório

** 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!

*** O código da operação pode ser encontrado no componente GERFM065.

Image Added

Totvs custom tabs box items

default	no
referencia	campD

IMAGEM 1

Button

Cor	#61affe
Texto	GET
Link	.

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

Bloco de código

language	xml
theme	RDark

Totvs custom tabs box items

default	no
referencia	campD

IMAGEM 1 IMAGEM 2

Image Removed Image Removed

Nome

Tipo

Descrição

Exemplo

VA

cdEmpresa *

Int

Código da empresa **

"cdEmpresa":001

Imagem 1 - 5

nrCNPJEmpresa

String

CNPJ da empresa **

"nrCNPJEmpresa": "Informar aqui o CNPJ da empresa"

--

cdPessoa

Int

Código do cliente **

"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

situacoes

Array

Situação da transação

"situações": [1,2,3,4]

cdOperacao

Int

Código da operação ***

"cdOperacao": 501

Imagem 2 - 12

cdVendedor

Int

Código do vendedor **

"cdVendedor": 5

Imagem 1 - 2

nrCPFVendedor

String

CPF do vendedor **

"nrCPFVendedor": "informar aqui o CPF do vendedor",

--

Nome	Tipo	Descrição	Exemplo	VA
cdEmpresa	Int	Código da empresa	"cdEmpresa":001	Imagem 1 - 1
nrTransacao	Int	Numero da transação	"nrTransacao": 63	Imagem 1 - 2
dtTransacao	String (date)	Data da transação	"dtTransacao": "25/11/2019"	Imagem 1 - 3

Informações
Todos os campos são obrigatórios. Caso possua a opção de informar código e/ou documento, pelo menos um dos campos deve ser informado!

Totvs custom tabs box items

default	no
referencia	retornoD

Totvs custom tabs box

tabs	Sucesso, Erro
ids	sucessoD,erroD

Totvs custom tabs box items

default	yes
referencia	sucessoD

Bloco de código

theme	RDark

{
    "cdEmpresa": 4,											"Código da Empresa"
    "nrTransacao": 578920,									"Número da Transação"
    "dtTransacao": "11/09/2019",							"Data da Transação"
    "cdPessoa": 14098,										"Código do Cliente"
    "cdTransacao": "000000022",								"Código de Transação"
    "cdOperacao": 7,										"Código de Operação"
    "cdVendedor": 50,										"Código do Vendedor"
    "tpSituacao": 4,										"Situação da Transação (Ex.: 1 - Em andamento, 2 - Liberada p/ faturamento; Ex. preenchimento: [1,2,3,4])"
    "itens": [
        {
            "nrItem": 1,									"Número do Item"
            "cdProduto": "82227",							"Código do Produto"
            "dsProduto": "PRODUTO CAMISA 001 AZUL P",		"Descrição do Produto"
            "cdEspecie": "PC",								"Espécie do Produto"
            "qtItem": 1,									"Quantidade Solicitada"
            "vlBruto": 10.54,								"Valor Bruto Total"
            "vlUnitarioBruto": 10.54,						"Valor Unitário Bruto"
            "vlDescontoItem": 10.54,						"Valor de Desconto do Item"
            "vlDescontoCapa": 0,							"Valor de Desconto da Capa"
            "vlLiquido": 0,									"Valor líquido total"

Totvs custom tabs box items

default	no
referencia	retornoD

Totvs custom tabs box

tabs	Sucesso, Erro
ids	sucessoD,erroD

Totvs custom tabs box items

default	yes
referencia	sucessoT

Bloco de código

theme	RDark

{
            "cdEmpresavlUnitarioLiquido": 99990,									"Valor Unitário Líquido"
            "nrTransacaocdVendedor": 9999,50								"Código do Vendedor para o Item"
         "dtTransacao": "99/99/9999",}
    ]
}

Totvs custom tabs box items

default	no
referencia	erroD

EXEMPLO DE UMA REQUISIÇÃO Q DEU PAU

*COLOCAR OS TIPOS DE ERROS QUE PODE DAR

Totvs custom tabs box items

default	no
referencia	codD

Implementação da API em C#

...

Páginas filhas

Versões comparadas

Versão antiga 26

Nova versão 27

Chave

01. INTRODUÇÃO

02. UTILIZAÇÃO

01. INTRODUÇÃO

02. UTILIZAÇÃO

01. INTRODUÇÃO

02. UTILIZAÇÃO