A integração do vale compras possibilita a criação e exclusão e uma numeração de voucher disponibilizado em uma API Publica (Padrão REST) validado no sistema Microvix.
Dica
O endereço para integração você pode acessar clicando aqui.
Autenticação Guid no header da requisição
| Campo | Descrição | Tipagem |
|---|---|---|
| IntegrationAutentication | É a chave de integração usada no projeto do WebService de BD, essa chave é gerada pelo time de BD, para que os clientes possam utilizar o WebService, foi feito a mesma autenticação. Chave adquirida após contratação ta integração | string |
Importante!
Deve ser utilizado para todos os métodos.
Localizar Vendedores – Requisição POST
Atenção!
Link de método clicando aqui.
- Parâmetros de entrada - Body tipo JSON
| Nome Campo | Descrição | Tipagem | Obrigatório |
|---|---|---|---|
| CNPJ | Valor contendo o CNPJ da empresa que deseja retornar os clientes. | String | Sim |
- Parâmetros de Saída - Retorno tipo JSON
| Nome Campo | Descrição | Tipagem |
|---|---|---|
| Id | Código do vendedor no Microvix. | Int |
| Nome | Nome do vendedor. | String |
| DataAtualizacao | Data em que o registro foi atualizado. | Datetime?(pode ser nulo) |
| WhatsappProfissional | Número do WhatsApp profissional | String |
| IdVendedorTipoVenda | Defini se o vendedor é de venda padrão (1), ambulante (2) ou ambos (3). | Int |
Motivos da Troca – Requisição POST
Atenção!
Link de método clicando aqui.
- Parâmetros de Saída - JSON
| Nome Campo | Descrição | Tipagem |
| Código | Código do motivo de troca no Microvix. | Int |
| Descrição | Descrição do motivo de troca. | String |
| Depósito | Código do deposito Microvix. | Int |
| GeraNumeracaoPropriaTroca | Define se quem gera o número da troca é o Microvix ou se é passado via parâmetro. | Bool |
| IdentificaTrocaPeriodoAdaptacao | Define se esse motivo permite troca no período de adaptação. | Bool |
| PrazoAdaptacao | Define o período de adaptação, o numero equivale aos dias. | Int |
| Ativo | Define se o motivo troca ainda está ativo no Microvix ou não. | Bool |
Gerar Vale Compra – Requisição POST
Atenção!
Link de método clicando aqui.
- Parâmetros de Saída - JSON
| Nome Campo | Descrição | Tipagem | Obrigatório |
|---|---|---|---|
| CodigoUsuario | Código do usuário no Microvix que ficara vinculado na troca | Int | Sim |
| CNPJ | CNPJ da empresa que está gerando a troca | String | Sim |
| Valor | Valor/saldo da troca para o cliente utilizar | Decimal | Sim |
| DocumentoCliente | CPF do cliente que vai ficar vinculada (utilizar) a troca | String | Sim |
| IdVendedor | Código do vendedor Microvix, pode ser obtido pelos métodos acimas | Int | Sim |
| IdMotivoTroca | Código do motivo da troca Microvix, pode ser obtido pelos métodos acimas | Int | Sim |
| DocumentoOrigem | Código do documento de origem da troca, caso tenha um comprovante ou cupom fiscal | Int | Não |
| CodigoECFOrigem | Código do ECF do documento de origem para a troca, caso tenha um cupom fiscal ECF | String | Não |
| SerieOrigem | Série de origem da Nota Fiscal ou cupom de origem | String | Não |
- Parâmetros de Saída - JSON
| Nome Campo | Descrição | Valor |
|---|---|---|
| IdTroca | Id da troca no Microvix, número interno | Int |
| NumeroTroca | Número da troca gerado, este é o número que será usado para vincular na venda | Int |
| NumeroNotaFiscal | Por padrão retornara 0/nulo | Int |
| TipoTroca | Define o tipo de troca que será gerado no Microvix, por padrão esse sempre será 1 nessa integração | Int |
| SaldoTroca | Valor/Saldo do vale troca gerado | Decimal |
Excluir Vale Trocas – Requisição POST
Atenção!
Link de método clicando aqui.
- Parâmetro de Entrada - Tipo JSON
| Nome Campo | Descrição | Tipagem | Obrigatório |
|---|---|---|---|
| CNPJ | Valor contendo o CNPJ da empresa que deseja retornar os clientes | String | Sim |
| NumeroValeTrocasMicrovix | Número do vale troca a ser excluído no Mmicrovix | String | Sim |
Validar Exclusão – Tipo Booleano
Para a operação concluída visualizará “True “ para possível erro na operação “false”