| VA |
---|
cdEmpresa * | Int | Código da empresa ** | "cdEmpresa":001 | Referencia 1 | nrCNPJEmpresa | String | CNPJ da empresa ** | "nrCNPJEmpresa": "Informar aqui o CNPJ da empresa" | -- | cdPessoa | Int | Código do cliente ** | "cdPessoa": 217 | Referencia 2 | 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" | Referencia 3 | situacoes | Array | Situação da transação | "situações": [1,2,3,4] | Referencia 4 | cdOperacao | Int | Código da operação *** | "cdOperacao": 501 | Referencia 5 | cdVendedor | Int | Código do vendedor ** | "cdVendedor": 5 | Referencia 6 | 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 |
---|
| {
"cdEmpresa": 9999,
"nrTransacao": 9999,
"dtTransacao": "99/99/9999",
} |
|
Totvs custom tabs box items |
---|
| Bloco de código |
---|
| {
"dsErro": "Mensagem informativa do erro"
} |
|
|
|
Totvs custom tabs box items |
---|
| Totvs custom tabs box |
---|
tabs | BuscarTransação, Token, Transação |
---|
ids | buscarTransacao,tokenBT,transacaoBT |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | buscarTransacao |
---|
| Totvs custom tabs box |
---|
tabs | BuscarTransação, DtoConsultaBuilder |
---|
ids | buscarTransacaoBT,popularBusca |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | buscarTransacaoBT |
---|
| Bloco de código |
---|
| public class ApiTransacao
{
static void BuscarTransação(string[] args)
{
var token = Token.ObterToken();
var dto = PopularDto();
var teste = Transacao.ConsultarTransacao(token, dto);
}
private static ConsultarTransacaoDTO.Envio PopularDto()
{
var dto = new DtoConsultaBuilder()
.ComCodigoEmpresa(1)
.ComDataMovimento("25/11/2019")
.Build();
return dto;
}
} |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | popularBusca |
---|
| Bloco de código |
---|
| public class DtoConsultaBuilder
{
private ConsultarTransacaoDTO.Envio _dto;
public DtoConsultaBuilder()
{
_dto = new ConsultarTransacaoDTO.Envio();
}
public DtoConsultaBuilder ComCodigoEmpresa (int codigo)
{
_dto.CodigoEmpresa = codigo;
return this;
}
public DtoConsultaBuilder ComCNPJEmpresa (string CNPJEmpresa)
{
_dto.NumeroCNPJEmpresa = CNPJEmpresa;
return this;
}
public DtoConsultaBuilder ComCodigoPesssoa (int codigoPessoa)
{
_dto.CodigoPessoa = codigoPessoa;
return this;
}
public DtoConsultaBuilder ComDocumentoPessoa (string codigoPessoa)
{
_dto.NumeroCNPJEmpresa = codigoPessoa;
return this;
}
public DtoConsultaBuilder ComDataMovimento (string dataMovimento)
{
_dto.DataMovimento = dataMovimento;
return this;
}
public DtoConsultaBuilder ComSituacoes (IList<int> situacoes)
{
_dto.Situacoes = situacoes;
return this;
}
public DtoConsultaBuilder ComOperacao (int operacao)
{
_dto.CodigoOperacao = operacao;
return this;
}
public DtoConsultaBuilder ComCodigoVendedor (int codigoVendedor)
{
_dto.CodigoVendedor = codigoVendedor;
return this;
}
public DtoConsultaBuilder ComCPFVendedor (string documentoVendedor)
{
_dto.NumeroCPFVendedor = documentoVendedor;
return this;
}
public ConsultarTransacaoDTO.Envio Build() => _dto;
} |
|
|
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | tokenBT |
---|
| Totvs custom tabs box |
---|
tabs | ObterToken, LoginDTO |
---|
ids | obterTokenBT,loginBT |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | obterTokenBT |
---|
| Bloco de código |
---|
| public class Token
{
private const string _applicationJson = "application/json";
private const string _baseUri = @"http://www30.bhan.com.br:9443/api/v1/";
private const string _usuario = "desen";
private const string _senha = "123456";
public static string ObterToken()
{
LoginDTO.Envio login = new LoginDTO.Envio(_usuario, _senha);
var cliente = PopularCliente();
var uri = @"autorizacao/token";
var conteudo = new StringContent(_applicationJson);
var response = cliente.PostAsync(uri, conteudo).Result;
if (!response.IsSuccessStatusCode)
throw new Exception();
var retorno = JsonConvert.DeserializeObject<LoginDTO.Retorno>(response.Content.ReadAsStringAsync().Result);
return retorno.Token.Replace("Bearer", "").Trim();
}
private static HttpClient PopularCliente()
{
HttpClient cliente = new HttpClient();
cliente.BaseAddress = new Uri($"{_baseUri}");
cliente.DefaultRequestHeaders.Accept.Clear();
cliente.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(_applicationJson));
cliente.DefaultRequestHeaders.Add("usuario", _usuario);
cliente.DefaultRequestHeaders.Add("senha", _senha);
cliente.Timeout = TimeSpan.FromDays(1);
return cliente;
}
} |
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | loginBT |
---|
| Bloco de código |
---|
| public class LoginDTO
{
public class Envio
{
[JsonProperty("usuario")]
public string Usuario { get; set; }
[JsonProperty("senha")]
public string Senha { get; set; }
public Envio(string usuario, string senha)
{
Usuario = usuario;
Senha = senha;
}
}
public class Retorno
{
[JsonProperty("cdToken")]
public string Token { get; set; }
[JsonProperty("dtExpiracao")]
public string DataExpiracao { get; set; }
public Retorno(string token, string dataExpitacao)
{
Token = token;
DataExpiracao = dataExpitacao;
}
}
} |
|
|
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | transacaoBT |
---|
| Totvs custom tabs box |
---|
tabs | ConsultarTransacao, ConsultarTransacaoDTO |
---|
ids | consultarBT,consDTObt |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | consultarBT |
---|
| Bloco de código |
---|
| public class Transacao
{
private const string _balseUri = @"http://10.11.1.60:9443/api/v1/";
private const string _applicationJson = "application/json";
public static List<ConsultarTransacaoDTO.Retorno> ConsultarTransacao(string token, ConsultarTransacaoDTO.Envio dto)
{
var uri = @"transacao/lista";
var json = JsonConvert.SerializeObject(dto);
var cliente = PopularCliente(token);
var conteudo = new StringContent(json, Encoding.UTF8, _applicationJson);
var response = cliente.PostAsync(uri, conteudo).Result;
if (!response.IsSuccessStatusCode)
throw new Exception();
return JsonConvert.DeserializeObject<List<ConsultarTransacaoDTO.Retorno>>(response.Content.ReadAsStringAsync().Result);
}
}
|
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | consDTObt |
---|
| Bloco de código |
---|
| public class ConsultarTransacaoDTO
{
public class Envio
{
[JsonProperty("cdEmpresa")]
public int CodigoEmpresa { get; set; }
[JsonProperty("nrCNPJEmpresa")]
public string NumeroCNPJEmpresa { get; set; }
[JsonProperty("cdPessoa")]
public int CodigoPessoa { get; set; }
[JsonProperty("nrCPFCNPJPessoa")]
public string NumeroDocumentoPessoa { get; set; }
[JsonProperty("dtMovimento")]
public string DataMovimento { get; set; }
[JsonProperty("situacoes")]
public IList<int> Situacoes { get; set; }
[JsonProperty("cdOperacao")]
public int CodigoOperacao { get; set; }
[JsonProperty("cdVendedor")]
public int CodigoVendedor { get; set; }
[JsonProperty("nrCPFVendedor")]
public string NumeroCPFVendedor { get; set; }
}
public class Retorno
{
[JsonProperty("cdEmpresa")]
public int CodigoEmpresa { get; set; }
[JsonProperty("nrTransacao")]
public int NumeroTransacao { get; set; }
[JsonProperty("dtTransacao")]
public string DataTransacao { get; set; }
}
} |
|
|
|
|
|
|
|
Totvs custom tabs box items |
---|
| 01. INTRODUÇÃOTem como finalidade retornar os dados da 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 |
---|
| https://www30.bhan.com.br:9443/api/v1/transacao/dados |
---|
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | corpoD |
---|
| Bloco de código |
---|
| {
"cdEmpresa": 9999,
"nrTransacao": 9999,
"dtTransacao": "99/99/9999",
} |
|
Totvs custom tabs box items |
---|
| URL
HEADER Authorizathion | Bearer {{token}} |
---|
BODY Bloco de código |
---|
| {
"cdEmpresa": 1,
"nrTransacao": 63,
"dtTransacao": "25/11/2019",
} |
|
Totvs custom tabs box items |
---|
|
Image Added
Nome | Tipo | Descrição | Exemplo | VA |
---|
cdEmpresa | Int | Código da empresa | "cdEmpresa":001 | Referencia 1 | nrTransacao | Int | Numero da transação | "nrTransacao": 63 | Referencia 2 | dtTransacao | String (date) | Data da transação | "dtTransacao": "25/11/2019" | Referencia 3 |
Informações |
---|
Todos os campos são obrigatórios. |
|
|
|
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 |
---|
| {
"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"
"cdCfop": 5101, "Código CFOP"
"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"
"vlUnitarioLiquido": 0, "Valor Unitário Líquido"
"cdVendedor": 50 "Código do Vendedor para o Item"
}
]
} |
|
Totvs custom tabs box items |
---|
| Bloco de código |
---|
| {
"dsErro": "Mensagem informativa do erro"
} |
|
|
|
Totvs custom tabs box items |
---|
| Implementação da API em C# |
|
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | cancela |
---|
| 01. INTRODUÇÃOTem como finalidade realizar o cancelamento de uma transação em andamento. 02. UTILIZAÇÃO Totvs custom tabs box |
---|
tabs | Envio, Retorno, Exemplo de implementação |
---|
ids | envioC,retornoC,codC |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | envioC |
---|
| Totvs custom tabs box |
---|
tabs | URL, Body, Exemplo de Requisição, Detalhamento dos Campos |
---|
ids | urlC,corpoC,exC,campC |
---|
| Totvs custom tabs box items |
---|
| |
Totvs custom tabs box items |
---|
default | no |
---|
referencia | corpoC |
---|
| Bloco de código |
---|
| {
"cdEmpresa": 9999,
"nrTransacao": 9999,
"dtTransacao": "99/99/9999",
} |
|
Totvs custom tabs box items |
---|
| URL
HEADER Authorizathion | Bearer {{token}} |
---|
BODY Bloco de código |
---|
| {
"cdEmpresa": 1,
"nrTransacao": 63,
"dtTransacao": "25/11/2019",
} |
|
Totvs custom tabs box items |
---|
|
Image Added
Nome | Tipo | Descrição | Exemplo | VA |
---|
cdEmpresa | Int | Código da empresa | "cdEmpresa":001 | Referencia 1 | nrTransacao | Int | Numero da transação | "nrTransacao": 63 | Referencia 2 | dtTransacao | String (date) | Data da transação | "dtTransacao": "25/11/2019" | Referencia 3 |
Informações |
---|
Todos os campos são obrigatórios. |
|
|
|
Totvs custom tabs box items |
---|
default | no |
---|
referencia | retornoC |
---|
| Totvs custom tabs box |
---|
tabs | Sucesso, Erro |
---|
ids | sucessoC,erroC |
---|
| Totvs custom tabs box items |
---|
default | yes |
---|
referencia | sucessoC |
---|
| Bloco de código |
---|
| {
dsMensagem : "Transação cancelada com sucesso!"
} |
|
Totvs custom tabs box items |
---|
| Bloco de código |
---|
| {
"dsErro": "Mensagem informativa do erro"
} |
|
|
|
Totvs custom tabs box items |
---|
|
|
|
|