API para Tipos de documentos financeiros

Última atualização: 2 dias atrás Tempo de leitura: 2 minutos

O que é?

Existe um endpoint para a API WEB que possibilita a consulta dos tipos de documentos financeiros cadastrados no sistema.

O endpoint só suporta o método GET.

Como Funciona no Uniplus?

1. Consultar os tipos de documentos financeiros

Para consultar todos os tipos de documentos financeiros, o endpoint fica “/public-api/v1/tipo-documento-financeiro”.
Se deseja consultar as informações de apenas um tipo de documento, basta informa o código (id) no formato “/public-api/v1/tipo-documento-financeiro/20”.
Nesse formato será consultada as informações do tipo de documento de ID 20.

Pode ser usado parâmetros para melhorar a consulta, basta usa no seguinte formato: “/public-api/v1/tipo-documento-financeiro?<parametro>”.
Exemplo: “/public-api/v1/tipo-documento-financeiro?codigo=20”.

É possível ser adicionado o caractere “&” seguido do campo desejado para obter mais de uma informação.
Exemplo com vários parâmetros: “/public-api/v1/tipo-documento-financeiro?acao=15&localUso=2”

No endpoint do tipo de documento financeiro, se os campos “localUso” e “tipoUso” forem nulos, eles não aparecerão nas informações.

O JSON retornado será no formato:

[ {

"identificacao": "TDF",

"tabela": "tipodocumentofinanceiro",

"descricaoLayout": "Tipo documento financeiro",

"codigo": -20,

"descricao": "Pagamento do Vale presente",

"acao": 15,

"inativo": 0,

"baixaGeraComissao": 0,

"permiteGerarBoleto": 0,

"utilizadoEmNegociacao": 0,

"tipoUso": 2,

"enviaMobile": 0,

"enviaEcommerce": 0,

"localUso": 2,

"calcularEncargosFinanceiros": 0,

"juros": "0.00",

"multa": "0.00",

"descontoAntecipacao": "0.00",

"desconsideraSabado": 0,

"desconsideraDomingo": 0,

"diasDesconsiderarJuros": 0,

"diasDesconsiderarMulta": 0,

"diasDesconsiderarDesconto": 0,

"tipoCalculoJuros": 0,

"formaPagamentoNfe": ""

}

]

2. Lista de parâmetros

Identificador

Descrição

Obrigatório

Tipo

Tamanho

Decimais

Observações

codigo

Código do tipo documento financeiro

Numérico

descricao

Descrição

Caracter

50

acao

Tipo da ação a ser executada

Numérico

0 – Caixa;
2 – Receber;
3 – Pagar;
4 – Conta corrente;
10 – Cheques;
11 – Cheques terceiro;
12 – Depósito de cheque;
13 – Troca de endosso;
14 – Devolução;
15 – Baixa;
16 – Adiantamento de clientes;
17 – Pagamento de adiantamento de clientes;
8 – Pré Pago;
19 – Paga Pré Pago;
20 – Cartão Crédito;
21 – Cartão Débito;
22 – Carteira digital;
23 – PIX;
24 – Cartão de Crédito próprio;
25 – Cartão de Débito próprio;

inativo

Numérico

1

0 – Não;
1 – Sim;

baixaGeraComissao

Indica se ao baixar duplicatas gera comissão

Numérico

1

0 – Não;
1 – Sim

permiteGerarBoleto

Indica se poderá gerar boletos

Numérico

1

0 – Não;
1 – Sim;

utilizadoEmNegociacao

Indica se o tipo de documento é utilizado para negociações

Numérico

1

0 – Não;
1 – Sim;

tipoUso

Tipo de uso do tipo de documento

Numérico

0 – Ambos
1 – Cadastramento
2 – Forma de pagamento/recebimento

enviaMobile

Identifica se este tipo de documento será enviada ao Unimobile Vendas

Numérico

1

0 – Não;
1 – Sim;

enviaEcommerce

Identifica se este tipo de documento será enviar para o ecommerce

Numérico

1

0 – Não;
1 – Sim;

localUso

Local de uso do tipo de documento

Numérico

1

0 – “Ambos”;
1 – “Contas a receber”;
2 – “Contas a pagar”;

calcularEncargosFinanceiros

Calcular encargos financeiros

Numérico

1

0 – Não;
1 – Sim;

juros

Juros dos encargos financeiros

Numérico

5

2

multa

Multa dos encargos financeiros

Numérico

5

2

descontoAntecipacao

Desconto na antecipação

Numérico

5

2

desconsideraSabado

Desconsiderar sábados

Numérico

1

0 – Não;
1 – Sim;

desconsideraDomingo

Desconsiderar domingos

Numérico

1

0 – Não;
1 – Sim;

diasDesconsiderarJuros

Dias de carência para juros

Numérico

diasDesconsiderarMulta

Dias de carência para multa

Numérico

diasDesconsiderarDesconto

Dias de carência para desconto

Numérico

tipoCalculoJuros

Tipo de cálculo do juros

Numérico

1

0 – “Simples”;
1 – “Composto”;

formaPagamentoNfe

Forma de pagamento da NF-e

Caracter

01 – Dinheiro;
02 – Cheque;
03 – Cartão de crédito;
04 – Cartão de débito;
05 – Crédito loja;
10 – Vale alimentação;
11 – Vale refeição;
12 – Vale presente;
13 – Vale combustível;
14 – Duplicata Mercantil;
15 – Boleto Bancário;
16 – Depósito Bancário;
17 – Pagamento Instantâneo (PIX);
18 – Transferência bancária, Carteira Digital;
19 – Programa de fidelidade, Cashback, Crédito Virtual;
90 – Sem pagamento;
99 – Outros;

Saiba mais

_