All API resources
API reference

Reports

Trial balance, profit and loss, balance sheet, current accounts, depreciation schedule and the general ledger.

Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.

Get general ledger grouped by account

GET/api/public/v1/entities/{entityId}/general-ledger/account

SDK: prosaic.generalLedger.byAccount(entityId, params)

Returns journal entries grouped by account with running balances and period totals. Supports various period presets and custom date ranges.

Path parameters

  • entityIdstringrequired

Query parameters

  • periodTypestring

    Period preset for date range filtering

    One of: custom, this-month, last-month, this-quarter, last-quarter, this-financial-year, last-financial-year, month-to-date, quarter-to-date, year-to-date

  • startDatestring

    Start date. Required when periodType is custom.

  • endDatestring

    End date. Required when periodType is custom.

  • accountIdsarray of strings

    Comma-separated list of entity account IDs to filter by

  • includeVoidedboolean

    Include voided journals (default false)

    Default: false

Responses

200 Successful response

  • metadataobjectrequired
    Show 7 child attributes
    • entityIdstringrequired
    • entityNamestringrequired
    • periodDescriptionstringrequired
    • startDatestringrequired
    • endDatestringrequired
    • generatedAtstringrequired
    • currencystringrequired
  • accountsarray of objectsrequired
    Show 12 child attributes
    • accountIdstringrequired
    • accountCodestringrequired
    • accountMappedCodestringrequirednullable
    • accountNamestringrequired
    • accountTypestringrequired
    • accountSubtypestringrequired
    • beginningBalancestringrequired
    • endingBalancestringrequired
    • totalDebitsstringrequired
    • totalCreditsstringrequired
    • netMovementstringrequired
    • entriesarray of objectsrequired
      Show 18 child attributes
      • idstringrequired
      • journalIdstringrequired
      • logicalJournalIdstringrequired
      • datestringrequired
      • narrationstringrequired
      • descriptionstringrequired
      • lineTypestringrequired
      • parentIdstringrequirednullable
      • sourcestringrequired
      • journalStatusstringrequired
      • debitstringrequired
      • creditstringrequired
      • netstringrequired
      • grossstringrequired
      • runningBalancestringrequired
      • gstAmountstringrequired
      • taxRateobject
        Show 3 child attributes
        • idstringrequired
        • namestringrequired
        • ratestringrequired
      • bankTransactionobject
        Show 10 child attributes
        • idstringrequired
        • datestringrequired
        • amountstringrequired
        • typestringrequired
        • descriptionstringrequired
        • particularsstring
        • codestring
        • merchantobject
          Show 4 child attributes
          • idstringrequired
          • namestringrequired
          • providerstring
          • identifierstring
        • categoryobject
          Show 4 child attributes
          • idstringrequired
          • namestringrequired
          • groupNamestring
          • providerstring
        • bankAccountobjectrequired
          Show 3 child attributes
          • namestringrequired
          • accountNumberstring
          • institutionstring
  • totalsobjectrequired
    Show 3 child attributes
    • totalDebitsstringrequired
    • totalCreditsstringrequired
    • netMovementstringrequired
  • 400 Bad request - invalid parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const result = await prosaic.generalLedger.byAccount(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/general-ledger/account \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Get general ledger as flat entry list

GET/api/public/v1/entities/{entityId}/general-ledger/transaction

SDK: prosaic.generalLedger.byTransaction(entityId, params)

Returns a flat list of journal entries with embedded account metadata. Entries are ordered by date, createdAt, and id for deterministic results.

Path parameters

  • entityIdstringrequired

Query parameters

  • periodTypestring

    Period preset for date range filtering

    One of: custom, this-month, last-month, this-quarter, last-quarter, this-financial-year, last-financial-year, month-to-date, quarter-to-date, year-to-date

  • startDatestring

    Start date. Required when periodType is custom.

  • endDatestring

    End date. Required when periodType is custom.

  • accountIdsarray of strings

    Comma-separated list of entity account IDs to filter by

  • includeVoidedboolean

    Include voided journals (default false)

    Default: false

Responses

200 Successful response

  • metadataobjectrequired
    Show 7 child attributes
    • entityIdstringrequired
    • entityNamestringrequired
    • periodDescriptionstringrequired
    • startDatestringrequired
    • endDatestringrequired
    • generatedAtstringrequired
    • currencystringrequired
  • entriesarray of objectsrequired
    Show 19 child attributes
    • accountobjectrequired
      Show 6 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountMappedCodestringrequirednullable
      • accountNamestringrequired
      • accountTypestringrequired
      • accountSubtypestringrequired
    • idstringrequired
    • journalIdstringrequired
    • logicalJournalIdstringrequired
    • datestringrequired
    • narrationstringrequired
    • descriptionstringrequired
    • lineTypestringrequired
    • parentIdstringrequirednullable
    • sourcestringrequired
    • journalStatusstringrequired
    • debitstringrequired
    • creditstringrequired
    • netstringrequired
    • grossstringrequired
    • runningBalancestringrequired
    • gstAmountstringrequired
    • taxRateobject
      Show 3 child attributes
      • idstringrequired
      • namestringrequired
      • ratestringrequired
    • bankTransactionobject
      Show 10 child attributes
      • idstringrequired
      • datestringrequired
      • amountstringrequired
      • typestringrequired
      • descriptionstringrequired
      • particularsstring
      • codestring
      • merchantobject
        Show 4 child attributes
        • idstringrequired
        • namestringrequired
        • providerstring
        • identifierstring
      • categoryobject
        Show 4 child attributes
        • idstringrequired
        • namestringrequired
        • groupNamestring
        • providerstring
      • bankAccountobjectrequired
        Show 3 child attributes
        • namestringrequired
        • accountNumberstring
        • institutionstring
  • totalsobjectrequired
    Show 3 child attributes
    • totalDebitsstringrequired
    • totalCreditsstringrequired
    • netMovementstringrequired
  • 400 Bad request - invalid parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const result = await prosaic.generalLedger.byTransaction(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/general-ledger/transaction \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Get ledger entries

GET/api/public/v1/entities/{entityId}/ledger

SDK: prosaic.ledger.list(entityId, params)

Deprecated. It still works, but new integrations should not use it.

Deprecated. This was the original general ledger endpoint and has been replaced by the general ledger report endpoints. New integrations should use GET /api/public/v1/entities/{entityId}/general-ledger/transaction (flat entry list) or GET /api/public/v1/entities/{entityId}/general-ledger/account (grouped by account) instead. Returns paginated journal lines (ledger entries) for an entity with optional date range and account filtering. Only includes posted journals, excluding reversal entries.

Path parameters

  • entityIdstringrequired

Query parameters

  • pageinteger

    Page number (starts at 1)

    Default: 1

  • pageSizeinteger

    Number of items per page

    Default: 20

  • dateFromstring (date)

    Start date for filtering ledger entries (ISO 8601 format YYYY-MM-DD, interpreted in NZ timezone)

  • dateTostring (date)

    End date for filtering ledger entries (ISO 8601 format YYYY-MM-DD, interpreted in NZ timezone)

  • accountIdsarray of strings

    Comma-separated list of entity account IDs to filter by

  • journalIdstring (uuid)

    Filter by journal ID to get all ledger entries for a specific journal

Responses

200 Successful response

  • dataarray of objectsrequired
    Show 20 child attributes
    • narrationstringrequired
    • journalTypestringrequired
    • bankTransactionIdstringrequirednullable
    • gststringrequired
    • idstringrequired
    • descriptionstringrequirednullable
    • updatedAtstring (date-time)required
    • createdAtstring (date-time)required
    • parentIdstringrequirednullable
    • journalIdstringrequired
    • entityAccountIdstringrequired
    • taxRateIdstringrequired
    • creditstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • debitstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • entityAccountobjectrequired
      Show 3 child attributes
      • idstringrequired
      • namestringrequired
      • codestringrequired
    • taxRateobjectrequired
      Show 5 child attributes
      • idstringrequired
      • namestringrequired
      • descriptionstringrequirednullable
      • codestringrequired
      • ratestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • accountVersionnumberrequirednullable
    • lineNumbernumberrequired
    • sumAccountCreditsstringrequirednullable

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • sumAccountDebitsstringrequirednullable

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • paginationobjectrequired
    Show 6 child attributes
    • currentPagenumberrequired
    • pageSizenumberrequired
    • totalCountnumberrequired
    • totalPagesnumberrequired
    • hasNextPagebooleanrequired
    • hasPreviousPagebooleanrequired
  • 400 Bad request - invalid parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const page = await prosaic.ledger.list(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/ledger \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Get trial balance report

GET/api/public/v1/entities/{entityId}/trial-balance

SDK: prosaic.reports.trialBalance(entityId, params)

Returns a trial balance report for the specified entity. Supports cumulative and movement modes, optional period comparisons, and flexible grouping.

Cumulative mode (default): Balance sheet accounts show all-time cumulative balances; P&L accounts show current financial year activity.

Movement mode: Shows only journal activity within a specified date range for all account types. Use movementStartDate and movementEndDate to specify the range; when omitted the service defaults to the current financial year.

Path parameters

  • entityIdstringrequired

Query parameters

  • asOfDatestring

    As-of date for cumulative mode. Defaults to today.

  • reportModestring

    Report calculation mode

    One of: cumulative, movement

  • movementStartDatestring

    Start date for movement mode.

  • movementEndDatestring

    End date for movement mode.

  • groupBystring

    How to group accounts. Use reportGroup for saved report groups in the entity's country order. Each group's type is its stable key and name is its label. Accounts without a saved group appear together under unassigned. Use none to group rows yourself. **Deprecated.** Use groupBy=reportGroup in place of groupBy=subtype.

    One of: type, subtype, reportGroup, none

  • includeZeroBalancesstring

    Include accounts with zero balances

    One of: false, true

  • comparisonstring

    Whether to include comparison columns

    One of: none, periods

  • comparisonTypestring

    Type of comparison period. Used when comparison=periods.

    One of: year, month

  • comparisonPeriodsstring

    Number of comparison periods (1-12). Used when comparison=periods.

  • compareToEndOfMonthstring

    Snap comparison dates to end of month

    One of: false, true

  • compareToEndOfFinancialYearstring

    Snap comparison dates to end of financial year (31 March)

    One of: false, true

Responses

200 Successful response

  • metadataobjectrequired
    Show 9 child attributes
    • entityIdstringrequired
    • entityNamestringrequired
    • generatedAtstringrequired
    • currencystringrequired
    • timezonestringrequired
    • reportTypestringrequired

      One of: trial-balance

    • asOfDatestringrequired
    • movementStartDatestring
    • movementEndDatestring
  • totalsobjectrequired
    Show 4 child attributes
    • totalDebitsstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • totalCreditsstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • isBalancedbooleanrequired
    • variancestringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • accountGroupsarray of objectsrequired
    Show 4 child attributes
    • typestringrequired
    • namestringrequired
    • accountsarray of objectsrequired
      Show 17 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountNamestringrequired
      • accountTypestringrequired

        One of: Equity, Revenue, Expense, Asset, Liability

      • accountSubtypestringrequired
      • reportGroupKeystringnullable
      • reportGroupNamestring
      • reportCategoryKeystringnullable
      • reportGroupobjectnullable
        Show 2 child attributes
        • keystringrequired
        • namestringrequired
      • reportCategoryobjectnullable
        Show 2 child attributes
        • keystringrequired
        • namestringrequired
      • debitBalancestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • creditBalancestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • netBalancestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalCreditstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalDebitstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • isSystemGeneratedboolean
      • earningsTypestringnullable

        One of: retained

    • subtotalobjectrequired
      Show 3 child attributes
      • debitsstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • creditsstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • netstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • comparisonTotalsobject
  • 400 Bad request - invalid query parameters or missing/invalid system account setup (SYSTEM_ACCOUNT_VALIDATION).
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const result = await prosaic.reports.trialBalance(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/trial-balance \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Get profit & loss report

GET/api/public/v1/entities/{entityId}/reports/profit-loss

SDK: prosaic.reports.profitLoss(entityId, params)

Returns a profit & loss report for the specified entity.

Path parameters

  • entityIdstringrequired

Query parameters

  • periodTypestring

    Period type for the report. Matches the presets available in the Prosaic UI. Relative periods (this-month, this-quarter, etc.) are resolved to full NZ calendar periods, so omit startDate/endDate when using them. Use custom to supply explicit startDate and endDate.

    One of: custom, this-month, last-month, this-quarter, last-quarter, this-financial-year, last-financial-year

  • startDatestring

    Start date for custom period. Required when periodType is custom.

  • endDatestring

    End date for custom period. Required when periodType is custom.

  • comparisonstring

    Whether to include comparison columns

    One of: none, periods

  • comparisonTypestring

    Granularity of each comparison period. For UI-consistent results, pair month with this-month/last-month, quarter with this-quarter/last-quarter, and year with the financial-year periods.

    One of: custom, year, month, quarter

  • comparisonPeriodsstring

    Number of comparison periods (1-12)

  • includeZeroBalancesstring

    Include accounts with zero balances

    One of: false, true

Responses

200 Successful response

  • metadataobjectrequired
    Show 10 child attributes
    • entityIdstringrequired
    • entityNamestringrequired
    • generatedAtstringrequired
    • currencystringrequired
    • reportTypestringrequired

      One of: profit-loss

    • startDatestringrequired
    • endDatestringrequired
    • periodDescriptionstringrequired
    • comparisonPeriodsarray of strings
    • comparisonPeriodRangesarray of objects
      Show 3 child attributes
      • labelstringrequired
      • startDatestringrequired
      • endDatestringrequired
  • tradingIncomeobjectrequired
    Show 6 child attributes
    • headerstringrequired
    • totalLabelstringrequired
    • accountsarray of objectsrequired
      Show 10 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountNamestringrequired
      • accountTypestringrequired

        One of: Revenue, Expense

      • accountSubtypestringrequired
      • totalCreditstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalDebitstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • balancestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • comparisonPeriodsobject
      • segmentsobject
    • totalstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • comparisonTotalsobjectrequired
    • segmentTotalsobject
  • costOfSalesobjectrequired
    Show 6 child attributes
    • headerstringrequired
    • totalLabelstringrequired
    • accountsarray of objectsrequired
      Show 10 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountNamestringrequired
      • accountTypestringrequired

        One of: Revenue, Expense

      • accountSubtypestringrequired
      • totalCreditstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalDebitstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • balancestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • comparisonPeriodsobject
      • segmentsobject
    • totalstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • comparisonTotalsobjectrequired
    • segmentTotalsobject
  • otherIncomeobjectrequired
    Show 6 child attributes
    • headerstringrequired
    • totalLabelstringrequired
    • accountsarray of objectsrequired
      Show 10 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountNamestringrequired
      • accountTypestringrequired

        One of: Revenue, Expense

      • accountSubtypestringrequired
      • totalCreditstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalDebitstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • balancestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • comparisonPeriodsobject
      • segmentsobject
    • totalstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • comparisonTotalsobjectrequired
    • segmentTotalsobject
  • operatingExpensesobjectrequired
    Show 6 child attributes
    • headerstringrequired
    • totalLabelstringrequired
    • accountsarray of objectsrequired
      Show 10 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountNamestringrequired
      • accountTypestringrequired

        One of: Revenue, Expense

      • accountSubtypestringrequired
      • totalCreditstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalDebitstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • balancestringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • comparisonPeriodsobject
      • segmentsobject
    • totalstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • comparisonTotalsobjectrequired
    • segmentTotalsobject
  • hasTradingSectionbooleanrequired
  • totalsobjectrequired
    Show 4 child attributes
    • grossProfitstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • grossProfitComparisonobjectrequired
    • netProfitstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • netProfitComparisonobjectrequired
  • segmentColumnsarray of objects
    Show 5 child attributes
    • keystringrequired
    • labelstringrequired
    • isArchivedbooleanrequired
    • dimensionIdstring
    • dimensionNamestring
  • 400 Bad request - invalid query parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const result = await prosaic.reports.profitLoss(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/reports/profit-loss \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Get balance sheet report

GET/api/public/v1/entities/{entityId}/reports/balance-sheet

SDK: prosaic.reports.balanceSheet(entityId, params)

Returns a balance sheet report for the specified entity.

Path parameters

  • entityIdstringrequired

Query parameters

  • asOfDatestring

    As-of date for the report. Defaults to today.

  • includeZeroBalancesstring

    Include accounts with zero balances

    One of: false, true

  • comparisonstring

    Whether to include comparison columns

    One of: none, periods

  • comparisonTypestring

    Type of comparison period

    One of: year, month

  • comparisonPeriodsstring

    Number of comparison periods (1-12)

Responses

200 Successful response

  • metadataobjectrequired
    Show 6 child attributes
    • entityIdstringrequired
    • entityNamestringrequired
    • generatedAtstringrequired
    • currencystringrequired
    • reportTypestringrequired

      One of: balance-sheet

    • asOfDatestringrequired
  • sectionsobjectrequired
    Show 3 child attributes
    • assetsobjectrequired
      Show 4 child attributes
      • typestringrequired

        One of: Equity, Assets, Liabilities

      • namestringrequired
      • groupsarray of objectsrequired
        Show 4 child attributes
        • typestringrequired
        • namestringrequired
        • accountsarray of objectsrequired
          Show 9 child attributes
          • accountIdstringrequired
          • accountCodestringrequired
          • accountNamestringrequired
          • accountTypestringrequired

            One of: Equity, Asset, Liability

          • accountSubtypestringrequired
          • earningsTypestring

            One of: retained, current-year

          • balancestringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

          • totalCreditstringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

          • totalDebitstringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

        • subtotalstringrequired

          Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • liabilitiesobjectrequired
      Show 4 child attributes
      • typestringrequired

        One of: Equity, Assets, Liabilities

      • namestringrequired
      • groupsarray of objectsrequired
        Show 4 child attributes
        • typestringrequired
        • namestringrequired
        • accountsarray of objectsrequired
          Show 9 child attributes
          • accountIdstringrequired
          • accountCodestringrequired
          • accountNamestringrequired
          • accountTypestringrequired

            One of: Equity, Asset, Liability

          • accountSubtypestringrequired
          • earningsTypestring

            One of: retained, current-year

          • balancestringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

          • totalCreditstringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

          • totalDebitstringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

        • subtotalstringrequired

          Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • equityobjectrequired
      Show 4 child attributes
      • typestringrequired

        One of: Equity, Assets, Liabilities

      • namestringrequired
      • groupsarray of objectsrequired
        Show 4 child attributes
        • typestringrequired
        • namestringrequired
        • accountsarray of objectsrequired
          Show 9 child attributes
          • accountIdstringrequired
          • accountCodestringrequired
          • accountNamestringrequired
          • accountTypestringrequired

            One of: Equity, Asset, Liability

          • accountSubtypestringrequired
          • earningsTypestring

            One of: retained, current-year

          • balancestringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

          • totalCreditstringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

          • totalDebitstringrequired

            Exact decimal serialized as a string. Use Decimal.js for arithmetic.

        • subtotalstringrequired

          Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • totalstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • totalsobjectrequired
    Show 6 child attributes
    • totalAssetsstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • totalLiabilitiesstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • totalEquitystringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • netAssetsstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • isBalancedbooleanrequired
    • variancestringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • earningsBreakdownobject
    Show 2 child attributes
    • currentYearEarningsstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • retainedEarningsstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • comparisonTotalsobject
  • 400 Bad request - invalid query parameters or missing/invalid system account setup (SYSTEM_ACCOUNT_VALIDATION).
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const result = await prosaic.reports.balanceSheet(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/reports/balance-sheet \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Get current accounts report

GET/api/public/v1/entities/{entityId}/reports/current-accounts

SDK: prosaic.reports.currentAccounts(entityId, params)

Returns a current accounts report for the specified entity.

Path parameters

  • entityIdstringrequired

Query parameters

  • periodTypestring

    Period type for the report. Matches the presets available in the Prosaic UI. Relative periods (this-month, this-quarter, etc.) are resolved to full NZ calendar periods, so omit startDate/endDate when using them. Use custom to supply explicit startDate and endDate.

    One of: custom, this-month, last-month, this-quarter, last-quarter, this-financial-year, last-financial-year

  • startDatestring

    Start date for custom period. Required when periodType is custom.

  • endDatestring

    End date for custom period. Required when periodType is custom.

  • comparisonstring

    Whether to include comparison columns

    One of: none, periods

  • comparisonTypestring

    Granularity of each comparison period. For UI-consistent results, pair month with this-month/last-month, quarter with this-quarter/last-quarter, and year with the financial-year periods.

    One of: custom, year, month, quarter

  • comparisonPeriodsstring

    Number of comparison periods (1-12)

Responses

200 Successful response

  • metadataobjectrequired
    Show 12 child attributes
    • entityIdstringrequired
    • entityNamestringrequired
    • entityTypestringrequired
    • generatedAtstringrequired
    • currencystringrequired
    • reportTypestringrequired
    • startDatestringrequired
    • endDatestringrequired
    • periodDescriptionstringrequired
    • reportTitlestringrequired
    • comparisonPeriodsarray of strings
    • comparisonPeriodRangesarray of objects
      Show 3 child attributes
      • labelstringrequired
      • startDatestringrequired
      • endDatestringrequired
  • openingBalancestringrequired

    Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • openingBalanceComparisonobject
  • increasesobjectrequired
    Show 3 child attributes
    • accountsarray of objectsrequired
      Show 5 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountNamestringrequired
      • amountstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • comparisonPeriodsobject
    • totalstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • comparisonTotalsobject
  • decreasesobjectrequired
    Show 3 child attributes
    • accountsarray of objectsrequired
      Show 5 child attributes
      • accountIdstringrequired
      • accountCodestringrequired
      • accountNamestringrequired
      • amountstringrequired

        Exact decimal serialized as a string. Use Decimal.js for arithmetic.

      • comparisonPeriodsobject
    • totalstringrequired

      Exact decimal serialized as a string. Use Decimal.js for arithmetic.

    • comparisonTotalsobject
  • closingBalancestringrequired

    Exact decimal serialized as a string. Use Decimal.js for arithmetic.

  • closingBalanceComparisonobject
  • 400 Bad request - invalid query parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const result = await prosaic.reports.currentAccounts(entityId);
curl
curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/reports/current-accounts \
  -H "Authorization: Bearer $PROSAIC_API_KEY"

Get depreciation schedule report

GET/api/public/v1/entities/{entityId}/reports/depreciation-schedule

SDK: prosaic.reports.depreciationSchedule(entityId, params)

Returns a depreciation schedule report for the specified entity.

Path parameters

  • entityIdstringrequired

Query parameters

  • startDatestringrequired

    Start date for the schedule.

  • endDatestringrequired

    End date for the schedule.

Responses

200 Successful response

  • metadataobjectrequired
    Show 7 child attributes
    • entityIdstringrequired
    • entityNamestringrequired
    • currencystringrequired
    • startDatestringrequired
    • endDatestringrequired
    • generatedAtstringrequired
    • periodDescriptionstringrequired
  • assetsarray of objectsrequired
    Show 18 child attributes
    • assetIdstringrequired
    • namestringrequired
    • assetTypeNamestringrequirednullable
    • costAccountNamestringrequirednullable
    • expenseAccountNamestringrequirednullable
    • methodstringrequired
    • ratenumberrequirednullable
    • privateUsePercentagenumberrequired
    • purchaseDatestringrequirednullable
    • costnumberrequired
    • openingValuenumberrequired
    • purchasesnumberrequired
    • disposalsnumberrequired
    • depreciationnumberrequired
    • investmentBoostnumber
    • accumulatedDepreciationnumberrequired
    • closingValuenumberrequired
    • privateUseAmountnumberrequired
  • totalsobjectrequired
    Show 9 child attributes
    • costnumberrequired
    • openingValuenumberrequired
    • purchasesnumberrequired
    • disposalsnumberrequired
    • depreciationnumberrequired
    • investmentBoostnumber
    • accumulatedDepreciationnumberrequired
    • closingValuenumberrequired
    • privateUseAmountnumberrequired
  • 400 Bad request - invalid or missing query parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - No access to the specified entity
  • 500 Internal server error
Node SDK
const result = await prosaic.reports.depreciationSchedule(entityId, {
  startDate: '2026-04-01',
  endDate: '2026-04-01',
});
curl
curl -G https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/reports/depreciation-schedule \
  -H "Authorization: Bearer $PROSAIC_API_KEY" \
  --data-urlencode "startDate=2026-04-01" \
  --data-urlencode "endDate=2026-04-01"