Axuz Developers

GET /teams/{teamId}/receivables/receivables

Responde GET /receivables com filtros combinados.

  • 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 GET /receivables com filtros combinados.

Motivo: tela principal de contas a receber. Comportamento: filtros opcionais status, customer_id (uuid), period (YYYY-MM → intervalo mensal via due_date), overdue=true (status overdue OU due_date<hoje) e q (ILIKE em title/reference/customer.name); ordena por due_date ASC; cap 500.

Entradas: teamID, query strings. Retorno: JSON {items:[]}. Efeitos: SELECT team-scoped em receivables JOIN customers. Fluxo: GET /receivables em RegisterTeam.

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

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 GET 'https://api.axuz.net/teams/TEAM_ID/receivables/receivables' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://api.axuz.net/teams/TEAM_ID/receivables/receivables", {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
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(
    "GET",
    "https://api.axuz.net/teams/TEAM_ID/receivables/receivables",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())