Docs
API Referencesdks@platform/sdk-accounting

@platform/sdk-accounting

Typed TypeScript client for services/accounting. The page is generated from the SDK package source plus its generated OpenAPI types.

Installation

npm install @platform/sdk-accounting

You’ll also need the shared auth/client helpers:

npm install @platform/hosts @platform/sdk

Quick start

import { LoopClient } from "@platform/sdk";
import { platformHost, SERVICE_NAMES } from "@platform/hosts";
import { createAccountingClient } from "@platform/sdk-accounting";
 
const loop = new LoopClient({
  clientId: process.env.LOOP_CLIENT_ID!,
  clientSecret: process.env.LOOP_CLIENT_SECRET!,
  redirectUri: "https://your-app.example.com/auth/loop/callback",
});
 
const accounting = createAccountingClient({
  baseUrl: platformHost({ service: SERVICE_NAMES.ACCOUNTING }),
  accessToken: tokens.access_token,
});

Use the convenience helpers below when the SDK exposes them, or call the typed endpoint methods directly with GET / POST / PATCH / DELETE.

Convenience helpers

This SDK does not add convenience helpers beyond the typed endpoint calls below.

Endpoint calls

GET /readyz

Underlying REST endpoint: GET /readyz

Parameters

None

Return type

Promise<{
  data?: paths["/readyz"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.GET("/readyz");

GET /v1/accounts/{id}

Underlying REST endpoint: GET /v1/accounts/\{id\}

Parameters

  • path: paths["/v1/accounts/{id}"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/accounts/{id}"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.GET("/v1/accounts/{id}", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/accounts/{id}/balance

Underlying REST endpoint: GET /v1/accounts/\{id\}/balance

Parameters

  • path: paths["/v1/accounts/{id}/balance"]["get"]["parameters"]["path"]

Return type

Promise<{
  data?: paths["/v1/accounts/{id}/balance"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.GET("/v1/accounts/{id}/balance", {
  params: {
    path: {
      id: "<id>",
    },
  },
});

GET /v1/accounts/{id}/ledger

Underlying REST endpoint: GET /v1/accounts/\{id\}/ledger

Parameters

  • path: paths["/v1/accounts/{id}/ledger"]["get"]["parameters"]["path"]
  • query?: paths["/v1/accounts/{id}/ledger"]["get"]["parameters"]["query"]

Return type

Promise<{
  data?: paths["/v1/accounts/{id}/ledger"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.GET("/v1/accounts/{id}/ledger", {
  params: {
    path: {
      id: "<id>",
    },
    query: {
      /* paths["/v1/accounts/{id}/ledger"]["get"]["parameters"]["query"] */
    },
  },
});

GET /v1/accounts/me/balance

Underlying REST endpoint: GET /v1/accounts/me/balance

Parameters

None

Return type

Promise<{
  data?: paths["/v1/accounts/me/balance"]["get"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.GET("/v1/accounts/me/balance");

POST /v1/admin/reconciliation/loop-cash-bc-drift

Underlying REST endpoint: POST /v1/admin/reconciliation/loop-cash-bc-drift

Parameters

None

Return type

Promise<{
  data?: paths["/v1/admin/reconciliation/loop-cash-bc-drift"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.POST("/v1/admin/reconciliation/loop-cash-bc-drift");

POST /v1/idempotency/cleanup

Underlying REST endpoint: POST /v1/idempotency/cleanup

Parameters

None

Return type

Promise<{
  data?: paths["/v1/idempotency/cleanup"]["post"]["responses"]["200"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.POST("/v1/idempotency/cleanup");

POST /v1/transactions

Underlying REST endpoint: POST /v1/transactions

Parameters

  • header: paths["/v1/transactions"]["post"]["parameters"]["header"]
  • body: paths["/v1/transactions"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/transactions"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.POST("/v1/transactions", {
  params: {
    header: {
      /* paths["/v1/transactions"]["post"]["parameters"]["header"] */
    },
  },
  body: {
    /* paths["/v1/transactions"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

POST /v1/transactions/{id}/reverse

Underlying REST endpoint: POST /v1/transactions/\{id\}/reverse

Parameters

  • path: paths["/v1/transactions/{id}/reverse"]["post"]["parameters"]["path"]
  • header: paths["/v1/transactions/{id}/reverse"]["post"]["parameters"]["header"]
  • body: paths["/v1/transactions/{id}/reverse"]["post"]["requestBody"]["content"]["application/json"]

Return type

Promise<{
  data?: paths["/v1/transactions/{id}/reverse"]["post"]["responses"]["201"]["content"]["application/json"];
  error?: unknown;
  response: Response;
}>

Example

const result = await accounting.POST("/v1/transactions/{id}/reverse", {
  params: {
    path: {
      id: "<id>",
    },
    header: {
      /* paths["/v1/transactions/{id}/reverse"]["post"]["parameters"]["header"] */
    },
  },
  body: {
    /* paths["/v1/transactions/{id}/reverse"]["post"]["requestBody"]["content"]["application/json"] */
  },
});

Related

Overview@platform/sdk-affiliates