POST /teams/{teamId}/receivables/receipts
Responde POST /receipts criando um recebimento.
- Access: Member with permission
- Service:
https://api.axuz.net
Accepted authentication
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 /receipts criando um recebimento.
Motivo: registra um pagamento recebido; opcionalmente já aloca contra um ou mais receivables na mesma TX. Comportamento: valida amount>0, aceita received_at RFC3339 ou YYYY-MM-DD (default now UTC), default method= bank_transfer; se allocations preenchidas, delega para allocateTx. Entradas: teamID, actorID, body receiptIn. Retorno: 201 + Receipt. Efeitos: INSERT receipts + possivelmente INSERT receipt_allocations + UPDATE receivables em uma TX; audit_events (receipt.created). Fluxo: POST /receipts.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes |
Request body
Corpo JSON. O schema detalhado deste endpoint ainda não está tipado na spec; veja a descrição da operação.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
(corpo) | object | no |
{}Responses
200
TBD
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
Erro interno. Tente de novo com backoff; reporte o X-Request-Id.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
curl
curl -sS -X POST 'https://api.axuz.net/teams/TEAM_ID/receivables/receipts' \
-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/receipts", {
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/receipts",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={},
timeout=30,
)
res.raise_for_status()
print(res.json())