Cheques

Base: https://api.nivesistemas.com.br · 7 endpoints

GET /cheques/summary

Resumo dos cheques a depositar

curl

curl -X GET "https://api.nivesistemas.com.br/cheques/summary" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/cheques/summary", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/cheques/summary",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /cheques

Listar cheques

Query params

Campo	Tipo	Obrigatório	Descrição
q	string	não	Emitente, banco ou número
status	string	não	Situação do cheque
page	number	não	Página
pageSize	number	não	Itens por página

curl

curl -X GET "https://api.nivesistemas.com.br/cheques" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/cheques", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/cheques",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /cheques

Cadastrar cheque e calcular o próximo dia útil

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
issuerName	string	sim	Emitente
bankName	string	sim	Banco
chequeNumber	string	sim	Número do cheque
amount	number	sim	Valor
receivedDate	string	sim	Data de recebimento (AAAA-MM-DD)
depositDate	string	sim	Data prevista (AAAA-MM-DD)

curl

curl -X POST "https://api.nivesistemas.com.br/cheques" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"issuerName":"","bankName":"","chequeNumber":"","amount":0,"receivedDate":"","depositDate":""}'

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/cheques", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "issuerName": "",
    "bankName": "",
    "chequeNumber": "",
    "amount": 0,
    "receivedDate": "",
    "depositDate": ""
  }),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/cheques",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "issuerName": "",
      "bankName": "",
      "chequeNumber": "",
      "amount": 0,
      "receivedDate": "",
      "depositDate": ""
    },
)
print(res.json())

PATCH /cheques/:id

Atualizar dados do cheque

Parâmetros de rota: id

curl

curl -X PATCH "https://api.nivesistemas.com.br/cheques/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/cheques/{id}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/cheques/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PATCH /cheques/:id/status

Atualizar situação operacional

Parâmetros de rota: id

curl

curl -X PATCH "https://api.nivesistemas.com.br/cheques/{id}/status" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/cheques/{id}/status", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/cheques/{id}/status",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /cheques/:id

Excluir cheque

Parâmetros de rota: id

curl

curl -X DELETE "https://api.nivesistemas.com.br/cheques/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/cheques/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/cheques/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /cheques/:id

Detalhe do cheque

Parâmetros de rota: id

curl

curl -X GET "https://api.nivesistemas.com.br/cheques/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/cheques/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/cheques/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())