Contas a pagar

Despesas e pagamentos a fornecedores.

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

GET /payables/summary

Resumo

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

const res = await fetch("https://api.nivesistemas.com.br/payables/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/payables/summary",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /payables/installments/summary

Resumo

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

const res = await fetch("https://api.nivesistemas.com.br/payables/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/payables/installments/summary",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /payables/installments

Listar parcelas

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

const res = await fetch("https://api.nivesistemas.com.br/payables/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/payables/installments",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /payables

Listar contas a pagar

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

const res = await fetch("https://api.nivesistemas.com.br/payables", {
  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/payables",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /payables/suppliers/:supplierId/payments

Registrar pagamento / baixa

Parâmetros de rota: supplierId

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

const res = await fetch("https://api.nivesistemas.com.br/payables/suppliers/{supplierId}/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/payables/suppliers/{supplierId}/payments",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /payables/:id

Detalhe

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/payables/{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/payables/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /payables

Criar conta a pagar

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

const res = await fetch("https://api.nivesistemas.com.br/payables", {
  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/payables",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PATCH /payables/:id

Atualizar

Parâmetros de rota: id

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

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

import requests

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

POST /payables/:id/payments

Registrar pagamento / baixa

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/payables/{id}/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/payables/{id}/payments",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /payables/:id/cancel

Cancelar (body opcional: { reason })

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/payables/{id}/cancel", {
  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/payables/{id}/cancel",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /payables/:id/payments/:paymentId

Excluir baixa/pagamento

Parâmetros de rota: id, paymentId

curl -X DELETE "https://api.nivesistemas.com.br/payables/{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/payables/{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/payables/{id}/payments/{paymentId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /payables/:id

Excluir

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/payables/{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/payables/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /payables/alerts

Alertas de contas a pagar (vencidas, a vencer, aguardando aprovação)

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

const res = await fetch("https://api.nivesistemas.com.br/payables/alerts", {
  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/payables/alerts",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /payables/:id/approve

Aprovar conta (exige permissão de aprovar)

Parâmetros de rota: id

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

const res = await fetch("https://api.nivesistemas.com.br/payables/{id}/approve", {
  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/payables/{id}/approve",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /payables/:id/reject

Reprovar conta (exige permissão de aprovar)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`reason`	string	não	Motivo

curl -X POST "https://api.nivesistemas.com.br/payables/{id}/reject" \
  -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/payables/{id}/reject", {
  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/payables/{id}/reject",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "reason": ""
    },
)
print(res.json())

POST /payables/batch-payments

Pagar várias contas de uma vez

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`items`	array	sim	[{ payableId, installmentId, amount, lateFeeAmount, interestAmount, discountAmount }]
`paidAt`	string	não	Data do pagamento
`paymentMethodId`	string	não	Forma de pagamento
`financialAccountId`	string	não	Conta financeira
`notes`	string	não	Observações

curl -X POST "https://api.nivesistemas.com.br/payables/batch-payments" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"items":[],"paidAt":"","paymentMethodId":"","financialAccountId":"","notes":""}'

const res = await fetch("https://api.nivesistemas.com.br/payables/batch-payments", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "items": [],
    "paidAt": "",
    "paymentMethodId": "",
    "financialAccountId": "",
    "notes": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/payables/batch-payments",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "items": [],
      "paidAt": "",
      "paymentMethodId": "",
      "financialAccountId": "",
      "notes": ""
    },
)
print(res.json())

POST /payables/:id/attachments

Anexar comprovante/boleto (multipart, campo file, até 10 MB)

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`file`	file	sim	Arquivo
`paymentId`	uuid	não	Pagamento ao qual o anexo pertence

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/payables/{id}/attachments" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"file":null,"paymentId":"00000000-0000-0000-0000-000000000000"}'

const res = await fetch("https://api.nivesistemas.com.br/payables/{id}/attachments", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "file": null,
    "paymentId": "00000000-0000-0000-0000-000000000000"
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/payables/{id}/attachments",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "file": None,
      "paymentId": "00000000-0000-0000-0000-000000000000"
    },
)
print(res.json())

GET /payables/:id/attachments/:attachmentId/url

URL temporária para baixar o anexo

Parâmetros de rota: id, attachmentId

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

const res = await fetch("https://api.nivesistemas.com.br/payables/{id}/attachments/{attachmentId}/url", {
  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/payables/{id}/attachments/{attachmentId}/url",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /payables/:id/attachments/:attachmentId

Excluir anexo

Parâmetros de rota: id, attachmentId

Resposta: 204 No Content

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

const res = await fetch("https://api.nivesistemas.com.br/payables/{id}/attachments/{attachmentId}", {
  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/payables/{id}/attachments/{attachmentId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /payables/batch-cancel

Cancelar várias contas a pagar de uma vez

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`ids`	uuid[]	sim	Contas a cancelar (1 a 200)
`reason`	string	não	Motivo (até 500)

Resposta: { requested, succeeded, failed }. Cada conta é processada na própria transação: failed lista { id, description, message } (conta já paga, já cancelada, não encontrada…) sem desfazer as demais.

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

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

import requests

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

POST /payables/batch-delete

Excluir várias contas a pagar de uma vez

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`ids`	uuid[]	sim	Contas a excluir (1 a 200)

Resposta: { requested, succeeded, failed } — mesmo formato do cancelamento em lote; falhas individuais não derrubam as demais.

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

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

import requests

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