Axuz Developers

POST /teams/{teamId}/receivables/receivables/{receivableId}/pay

Responde POST /receivables/{receivableId}/pay.

  • Acesso: Membro com permissão
  • Serviço: https://api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

Responde POST /receivables/{receivableId}/pay.

Motivo: atalho para o caso comum "recebi X contra este boleto/nota" — evita dupla chamada createReceipt+allocate. Comportamento: em TX, lock FOR UPDATE do receivable; amount vazio → paga saldo total; recusa se já paid/cancelled; método default bank_transfer; received_at aceita RFC3339 ou YYYY-MM-DD (default now UTC); cria receipt + allocation contra este receivable e atualiza status (partially_paid|paid) + paid_date. Entradas: teamID, actorID, receivableId, body payReceivableIn. Retorno: 200 + {receivable, receipt_id}. Efeitos: INSERT receipts + INSERT receipt_allocations + UPDATE receivables em TX; audit_events (receivable.paid); publish realtime receivable.paid ou receivable.updated.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim
receivableIdpathstringsim

Corpo da requisição

Corpo JSON. O schema detalhado deste endpoint ainda não está tipado na spec; veja a descrição da operação.

application/json

NomeTipoObrigatórioDescrição
(corpo)objectnão
{}

Respostas

200

TBD

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NomeTipoObrigatórioDescrição
errorstringsim

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X POST 'https://api.axuz.net/teams/TEAM_ID/receivables/receivables/RECEIVABLE_ID/pay' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

const res = await fetch("https://api.axuz.net/teams/TEAM_ID/receivables/receivables/RECEIVABLE_ID/pay", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://api.axuz.net/teams/TEAM_ID/receivables/receivables/RECEIVABLE_ID/pay",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={},
    timeout=30,
)
res.raise_for_status()
print(res.json())