API

API リファレンス

全 353 エンドポイントの主な入り口を、業務 ID とあわせて一覧にしています。それぞれのエンドポイントは、@UseCase 注釈でシーケンス定義に結び付いています。

認証

全エンドポイントで Bearer JWT が必要です (login と logout は例外)。 リクエストヘッダー: Authorization: Bearer <access_token>

認証 (Auth)

  • POST/api/auth/loginUC-CM-001
  • POST/api/auth/logoutUC-CM-013

販売 (Sales)

  • GET/api/v1/sales/customersUC-SL-001..032
  • POST/api/v1/sales/customersUC-SL-001
  • POST/api/v1/sales/invoicesUC-SL-003
  • GET/api/v1/sales/invoices/{id}/pdfUC-SL-004
  • POST/api/v1/sales/invoices/{id}/postUC-SL-013

購買 (Purchase)

  • POST/api/v1/purchase/suppliersUC-PL-001
  • POST/api/v1/purchase/ordersUC-PL-003
  • POST/api/v1/purchase/invoicesUC-PL-006
  • POST/api/v1/purchase/payments/runUC-PL-009

在庫 (Stock)

  • POST/api/v1/stock/itemsUC-ST-001
  • POST/api/v1/stock/movements/{stockKey}/receiptsUC-ST-003
  • POST/api/v1/stock/movements/{stockKey}/issuesUC-ST-004

総勘定元帳 (GL)

  • POST/api/v1/gl/batchesUC-GL-002
  • POST/api/v1/gl/batches/{id}/linesUC-GL-002
  • POST/api/v1/gl/batches/{id}/postUC-GL-004
  • GET/api/v1/gl/reports/trial-balanceUC-GL-006
  • GET/api/v1/gl/reports/trial-balance/pdfUC-GL-006

給与 (Payroll)

  • POST/api/v1/payroll/periodsUC-PY-004
  • POST/api/v1/payroll/periods/{id}/runUC-PY-004

IRS

  • POST/api/irs/incomeUC-IRS-002
  • POST/api/irs/expenseUC-IRS-003
  • POST/api/irs/migrate-to-glUC-IRS-012

管理 (Admin)

  • POST/api/v1/usersUC-CM-004
  • GET/api/v1/audit/logsUC-CM-009

エラー形式

{
  "code": "USER_USERNAME_DUPLICATE",
  "message": "Username 'ekw' is already taken",
  "status": 409
}