Axuz Developers

POST /teams/{teamId}/payables/boleto/parse

— endpoint síncrono do boleto parser.

  • 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`.

— endpoint síncrono do boleto parser.

Contrato: multipart/form-data com campo "file" (PDF ou imagem). O handler: 1. lê o upload direto pra disco sob STORAGE_LOCAL_DIR (mesma convenção do módulo files) e cria uma linha em files_files com status 'uploaded' — atalho em relação ao fluxo init/upload/complete usado pelo Files UI, justificável aqui porque o arquivo é de uso internal-only (anexar num bill). 2. chama ParseUploadedFile inline; 422 se nada casou, 201 com o bill criado caso contrário.

Worker async consumindo file.uploaded fica como fase seguinte — o endpoint síncrono já resolve o fluxo "arrastei o boleto aqui agora".

Parameters

NameInTypeRequiredDescription
teamIdpathstringyes

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

NameTypeRequiredDescription
(corpo)objectno
{}

Responses

200

TBD

401

Sem credencial valida

NameTypeRequiredDescription
errorstringyes

403

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

NameTypeRequiredDescription
errorstringyes

429

Limite de requisições excedido.

NameTypeRequiredDescription
errorstringyes

500

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

NameTypeRequiredDescription
errorstringyes

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/payables/boleto/parse' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

const res = await fetch("https://api.axuz.net/teams/TEAM_ID/payables/boleto/parse", {
  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/payables/boleto/parse",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={},
    timeout=30,
)
res.raise_for_status()
print(res.json())