Contas a receber

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

GET /receivables/summary

Resumo (em aberto, vencido, recebido)

Query params

Campo	Tipo	Obrigatório	Descrição
`from`	string	não	ISO date — filtro de baixas
`to`	string	não	ISO date

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

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

import requests

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

GET /receivables/installments/summary

Resumo das parcelas (saldo, vencidas, quantidades)

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

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

import requests

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

GET /receivables/installments

Listar todas as parcelas (todos os clientes)

Query params

Campo	Tipo	Obrigatório	Descrição
`page`	number	não	Página (padrão 1)
`pageSize`	number	não	Itens por página (padrão 20)
`q`	string	não	Cliente, CPF, pedido ou nº da parcela
`status`	string	não	OPEN \| PARTIAL \| PAID
`customerId`	string	não	UUID do cliente
`overdue`	boolean	não	true — só vencidas
`from`	string	não	ISO date — vencimento inicial
`to`	string	não	ISO date — vencimento final
`sortBy`	string	não	customer \| origin \| sequence \| amount \| balance \| dueDate \| status
`sortDir`	string	não	asc \| desc (padrão asc)

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

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

import requests

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

GET /receivables

Listar contas

Query params

Campo	Tipo	Obrigatório	Descrição
`page`	number	não	Página (padrão 1)
`pageSize`	number	não	Itens por página (padrão 20)
`q`	string	não	Cliente, pedido ou descrição
`status`	string	não	OPEN \| PARTIAL \| PAID \| CANCELLED
`customerId`	string	não	UUID do cliente
`paymentMethodId`	string	não	Forma de pagamento da venda de origem (ex.: boleto, crediário)
`overdue`	boolean	não	true — só vencidas
`excludePaid`	boolean	não	true — oculta contas quitadas
`excludeCancelled`	boolean	não	true — oculta contas canceladas
`sortBy`	string	não	customer \| origin \| originalAmount \| balance \| dueDate \| status
`sortDir`	string	não	asc \| desc (padrão asc)

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

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

import requests

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

GET /receivables/:id

Detalhe com parcelas e baixas

Parâmetros de rota: id

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

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

import requests

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

POST /receivables

Cadastro manual

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`customerId`	string	não	UUID do cliente
`originalAmount`	number	sim	Valor da dívida
`dueDate`	string	não	Data de vencimento
`installmentCount`	number	não	1–48 parcelas
`description`	string	não	Observação opcional

curl -X POST "https://api.nivesistemas.com.br/receivables" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"","originalAmount":0,"dueDate":"","installmentCount":0,"description":""}'

const res = await fetch("https://api.nivesistemas.com.br/receivables", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "",
    "originalAmount": 0,
    "dueDate": "",
    "installmentCount": 0,
    "description": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "customerId": "",
      "originalAmount": 0,
      "dueDate": "",
      "installmentCount": 0,
      "description": ""
    },
)
print(res.json())

POST /receivables/historical-sales

Importar venda antiga sem movimentar estoque, caixa ou fiscal

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`sourceSystem`	string	sim	Sistema de origem
`externalId`	string	sim	Número da nota antiga
`saleDate`	string	sim	Data histórica da venda
`customerId`	string	sim	UUID do cliente
`items`	array	sim	Variantes, quantidades e preços históricos
`totalAmount`	number	sim	Total declarado da nota
`paidAmount`	number	não	Valor já recebido
`firstDueDate`	string	sim	Primeiro vencimento

curl -X POST "https://api.nivesistemas.com.br/receivables/historical-sales" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"sourceSystem":"","externalId":"","saleDate":"","customerId":"","items":[],"totalAmount":0,"paidAmount":0,"firstDueDate":""}'

const res = await fetch("https://api.nivesistemas.com.br/receivables/historical-sales", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "sourceSystem": "",
    "externalId": "",
    "saleDate": "",
    "customerId": "",
    "items": [],
    "totalAmount": 0,
    "paidAmount": 0,
    "firstDueDate": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables/historical-sales",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "sourceSystem": "",
      "externalId": "",
      "saleDate": "",
      "customerId": "",
      "items": [],
      "totalAmount": 0,
      "paidAmount": 0,
      "firstDueDate": ""
    },
)
print(res.json())

PATCH /receivables/:id

Atualizar conta e parcelamento (não quitada/cancelada)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`customerId`	string	não	UUID do cliente
`description`	string	não	Observação
`installmentCount`	number	não	Regerar parcelas (sem baixas)
`firstDueDate`	string	não	1º vencimento ao regerar
`installments`	array	não	Lista { id?, sequence, amount, dueDate } — soma = valor original

curl -X PATCH "https://api.nivesistemas.com.br/receivables/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"","description":"","installmentCount":0,"firstDueDate":"","installments":[]}'

const res = await fetch("https://api.nivesistemas.com.br/receivables/{id}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "",
    "description": "",
    "installmentCount": 0,
    "firstDueDate": "",
    "installments": []
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/receivables/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "customerId": "",
      "description": "",
      "installmentCount": 0,
      "firstDueDate": "",
      "installments": []
    },
)
print(res.json())

POST /receivables/:id/payments

Registrar baixa

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`amount`	number	sim	Valor recebido
`installmentId`	string	não	Parcela específica
`paymentMethodId`	string	sim	Forma de recebimento
`notes`	string	não	Observação opcional

curl -X POST "https://api.nivesistemas.com.br/receivables/{id}/payments" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"amount":0,"installmentId":"","paymentMethodId":"","notes":""}'

const res = await fetch("https://api.nivesistemas.com.br/receivables/{id}/payments", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "amount": 0,
    "installmentId": "",
    "paymentMethodId": "",
    "notes": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables/{id}/payments",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "amount": 0,
      "installmentId": "",
      "paymentMethodId": "",
      "notes": ""
    },
)
print(res.json())

PATCH /receivables/:id/payments/:paymentId

Editar baixa e recalcular saldos

Parâmetros de rota: id, paymentId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`amount`	number	sim	Valor recebido
`paidAt`	string	não	Data/hora da baixa (ISO)
`installmentId`	string	não	Parcela específica (null = ordem de vencimento)
`paymentMethodId`	string	sim	Forma de recebimento
`discountAmount`	number	não	Desconto concedido
`lateFeeAmount`	number	não	Multa cobrada
`interestAmount`	number	não	Juros cobrados
`notes`	string	não	Observação opcional

curl -X PATCH "https://api.nivesistemas.com.br/receivables/{id}/payments/{paymentId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"amount":0,"paidAt":"","installmentId":"","paymentMethodId":"","discountAmount":0,"lateFeeAmount":0,"interestAmount":0,"notes":""}'

const res = await fetch("https://api.nivesistemas.com.br/receivables/{id}/payments/{paymentId}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "amount": 0,
    "paidAt": "",
    "installmentId": "",
    "paymentMethodId": "",
    "discountAmount": 0,
    "lateFeeAmount": 0,
    "interestAmount": 0,
    "notes": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/receivables/{id}/payments/{paymentId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "amount": 0,
      "paidAt": "",
      "installmentId": "",
      "paymentMethodId": "",
      "discountAmount": 0,
      "lateFeeAmount": 0,
      "interestAmount": 0,
      "notes": ""
    },
)
print(res.json())

POST /receivables/:id/cancel

Cancelar conta — baixa por perda (zera saldo sem entrada no caixa; mantém baixas)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`reason`	string	sim	Motivo (mín. 10 caracteres)

curl -X POST "https://api.nivesistemas.com.br/receivables/{id}/cancel" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"reason":""}'

const res = await fetch("https://api.nivesistemas.com.br/receivables/{id}/cancel", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": ""
  }),
});
const data = await res.json();

import requests

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

POST /receivables/:id/reopen

Reverter cancelamento (somente administrador; saldo recalculado pelas baixas)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`reason`	string	sim	Motivo (mín. 10 caracteres)

curl -X POST "https://api.nivesistemas.com.br/receivables/{id}/reopen" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"reason":""}'

const res = await fetch("https://api.nivesistemas.com.br/receivables/{id}/reopen", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": ""
  }),
});
const data = await res.json();

import requests

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

DELETE /receivables/:id/payments/:paymentId

Excluir baixa e recalcular saldos

Parâmetros de rota: id, paymentId

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

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

import requests

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

DELETE /receivables/:id

Excluir conta, parcelas e baixas

Parâmetros de rota: id

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

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

import requests

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

POST /receivables/historical-sales/parse-text

Interpretar venda histórica (texto/IA)

curl -X POST "https://api.nivesistemas.com.br/receivables/historical-sales/parse-text" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables/historical-sales/parse-text",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /receivables/historical-sales/parse-image

Interpretar venda histórica (imagem/IA)

curl -X POST "https://api.nivesistemas.com.br/receivables/historical-sales/parse-image" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables/historical-sales/parse-image",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /receivables/payments

Obter pagamentos / baixas

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

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

import requests

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

POST /receivables/customers/:customerId/card-payments

Criar pagamento com cartão

Parâmetros de rota: customerId

curl -X POST "https://api.nivesistemas.com.br/receivables/customers/{customerId}/card-payments" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables/customers/{customerId}/card-payments",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /receivables/customers/:customerId/payments

Registrar pagamento / baixa

Parâmetros de rota: customerId

curl -X POST "https://api.nivesistemas.com.br/receivables/customers/{customerId}/payments" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

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

DELETE /receivables/customers/:customerId/settlements/:settlementId

Excluir baixa do cliente (lote) e recalcular saldos

Parâmetros de rota: customerId, settlementId

curl -X DELETE "https://api.nivesistemas.com.br/receivables/customers/{customerId}/settlements/{settlementId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

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

GET /receivables/customers/:customerId/credit-status

Obter status de crédito

Parâmetros de rota: customerId

curl -X GET "https://api.nivesistemas.com.br/receivables/customers/{customerId}/credit-status" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

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

GET /receivables/customers/:customerId/statement

Listar / obter extrato

Parâmetros de rota: customerId

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

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

import requests

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

POST /receivables/customers/:customerId/statement/notify

Notificar cliente

Parâmetros de rota: customerId

curl -X POST "https://api.nivesistemas.com.br/receivables/customers/{customerId}/statement/notify" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

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

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables/customers/{customerId}/statement/notify",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /receivables/renegotiate

Renegociar parcelas

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

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

import requests

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

POST /receivables/:id/notify

Notificar cliente

Parâmetros de rota: id

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

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

import requests

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

GET /receivables/:id/charges

Obter cobranças

Parâmetros de rota: id

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

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

import requests

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

POST /receivables/:id/card-payments

Criar pagamento com cartão

Parâmetros de rota: id

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

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

import requests

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

GET /receivables/customers/:customerId/charges

Prévia de encargos (multa/juros) para baixa do cliente

Parâmetros de rota: customerId

Query params

Campo	Tipo	Obrigatório	Descrição
`amount`	number	sim	Valor principal
`paidAt`	string	não	Data da baixa (ISO)

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

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

import requests

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

GET /receivables/collection-desk

Mesa de cobrança: clientes com parcelas vencidas

Query params

Campo	Tipo	Obrigatório	Descrição
`page`	integer	não	Página
`pageSize`	integer	não	Itens por página (até 100)

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

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

import requests

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

POST /receivables/collection-desk/notify-batch

Enviar lembrete de cobrança em lote

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`receivableIds`	uuid[]	sim	Até 50 contas

curl -X POST "https://api.nivesistemas.com.br/receivables/collection-desk/notify-batch" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"receivableIds":null}'

const res = await fetch("https://api.nivesistemas.com.br/receivables/collection-desk/notify-batch", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "receivableIds": null
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/receivables/collection-desk/notify-batch",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "receivableIds": None
    },
)
print(res.json())