API Reference

Criar Configuração

Cria uma configuração.

Log in to see full request history

Cria Configuração

As configurações representam os parâmetros que governam o funcionamento de funções específicas em nossas aplicações. Esta rota possibilita a definição inicial desses parâmetros durante a criação de um Estabelecimento (EC), os quais podem ser posteriormente ajustados conforme necessário.

O usuário deve se atentar na regra a seguir no momento que for preencher os campos:

  • Regra do Desconto:
    Só é permitido utilizar uma Regra de Desconto por vez, atualmente possuímos duas, que são elas:
    • Desconto por Porcentagem:
      O valor do desconto é definido mediante à uma porcentagem escolhida pelo cliente. O desconto será dinâmico sob o valor total da fatura. O campo correspondente à esta configuração é o "por_desconto".
    • Valor de Desconto:
      O valor do desconto será fixo e independe do valor total fatura, o mesmo também é definido pelo cliente. O campo correspondente à esta configuração é "valor_desconto".

Abaixo temos um exemplo de como os dados devem ser passados no Body para que possa ser criada uma nova configuração.

{ "estabelecimento_id":123, "grupo_id":321, "juros":true, "por_multa":1.0, "dias_antes_do_vencimento":1, "por_desconto":1.0, "valor_desconto":1.0 }

É necessário passar o token gerado no momento em que o usuário realiza o login no header "Authorization", para que a autenticação do usuário seja realizada e liberar o acesso para a utilização da mesma.

Abaixo temos um exemplo de como inserir essa informação usando JSON.

{ "Authorization":"eyJhbGciOiJIUzI1NiIjk3Mjc5NDYwLCJpc3ljZSJ9.JDk3aHgk65apDkNIYyQZjtXsQ" }
Body Params
int32

Id do Estabelecimento.

int32
required

Id do Grupo ao qual o Estabelecimento pertence.

boolean

Se irá aplicar juros ou não caso o cliente realize o pagamento após o vencimento da fatura.

float

Valor da multa aplicada caso o cliente pague a fatura após o vencimento.

int32

Quantidade de dias anteriores ao vencimento em que o cliente, ao efetuar um pagamento, recebe um desconto em sua fatura.

float

Porcentagem do desconto sob o valor da fatura.

float

Valor a ser descontado na fatura.

Headers
string
required

Token gerado no momento em que o usuário realiza o login. Ex.: eyJhbGciOiJIUzI1NiIjk3Mjc5NDYwLCJpc3ljZSJ9.JDk3aHgk65apDkNIYyQZjtXsQ

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json