All API resources
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
/api/public/v1/entities/{entityId}/general-ledger/accountSDK: 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
periodTypestringPeriod 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-datestartDatestringStart date. Required when periodType is
custom.endDatestringEnd date. Required when periodType is
custom.accountIdsarray of stringsComma-separated list of entity account IDs to filter by
includeVoidedbooleanInclude voided journals (default false)
Default:
false
Responses
200 Successful response
metadataobjectrequiredShow 7 child attributesHide child attributes
entityIdstringrequiredentityNamestringrequiredperiodDescriptionstringrequiredstartDatestringrequiredendDatestringrequiredgeneratedAtstringrequiredcurrencystringrequired
accountsarray of objectsrequiredShow 12 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountMappedCodestringrequirednullableaccountNamestringrequiredaccountTypestringrequiredaccountSubtypestringrequiredbeginningBalancestringrequiredendingBalancestringrequiredtotalDebitsstringrequiredtotalCreditsstringrequirednetMovementstringrequiredentriesarray of objectsrequiredShow 18 child attributesHide child attributes
idstringrequiredjournalIdstringrequiredlogicalJournalIdstringrequireddatestringrequirednarrationstringrequireddescriptionstringrequiredlineTypestringrequiredparentIdstringrequirednullablesourcestringrequiredjournalStatusstringrequireddebitstringrequiredcreditstringrequirednetstringrequiredgrossstringrequiredrunningBalancestringrequiredgstAmountstringrequiredtaxRateobjectShow 3 child attributesHide child attributes
idstringrequirednamestringrequiredratestringrequired
bankTransactionobjectShow 10 child attributesHide child attributes
idstringrequireddatestringrequiredamountstringrequiredtypestringrequireddescriptionstringrequiredparticularsstringcodestringmerchantobjectShow 4 child attributesHide child attributes
idstringrequirednamestringrequiredproviderstringidentifierstring
categoryobjectShow 4 child attributesHide child attributes
idstringrequirednamestringrequiredgroupNamestringproviderstring
bankAccountobjectrequiredShow 3 child attributesHide child attributes
namestringrequiredaccountNumberstringinstitutionstring
totalsobjectrequiredShow 3 child attributesHide child attributes
totalDebitsstringrequiredtotalCreditsstringrequirednetMovementstringrequired
400Bad request - invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const result = await prosaic.generalLedger.byAccount(entityId);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
/api/public/v1/entities/{entityId}/general-ledger/transactionSDK: 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
periodTypestringPeriod 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-datestartDatestringStart date. Required when periodType is
custom.endDatestringEnd date. Required when periodType is
custom.accountIdsarray of stringsComma-separated list of entity account IDs to filter by
includeVoidedbooleanInclude voided journals (default false)
Default:
false
Responses
200 Successful response
metadataobjectrequiredShow 7 child attributesHide child attributes
entityIdstringrequiredentityNamestringrequiredperiodDescriptionstringrequiredstartDatestringrequiredendDatestringrequiredgeneratedAtstringrequiredcurrencystringrequired
entriesarray of objectsrequiredShow 19 child attributesHide child attributes
accountobjectrequiredShow 6 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountMappedCodestringrequirednullableaccountNamestringrequiredaccountTypestringrequiredaccountSubtypestringrequired
idstringrequiredjournalIdstringrequiredlogicalJournalIdstringrequireddatestringrequirednarrationstringrequireddescriptionstringrequiredlineTypestringrequiredparentIdstringrequirednullablesourcestringrequiredjournalStatusstringrequireddebitstringrequiredcreditstringrequirednetstringrequiredgrossstringrequiredrunningBalancestringrequiredgstAmountstringrequiredtaxRateobjectShow 3 child attributesHide child attributes
idstringrequirednamestringrequiredratestringrequired
bankTransactionobjectShow 10 child attributesHide child attributes
idstringrequireddatestringrequiredamountstringrequiredtypestringrequireddescriptionstringrequiredparticularsstringcodestringmerchantobjectShow 4 child attributesHide child attributes
idstringrequirednamestringrequiredproviderstringidentifierstring
categoryobjectShow 4 child attributesHide child attributes
idstringrequirednamestringrequiredgroupNamestringproviderstring
bankAccountobjectrequiredShow 3 child attributesHide child attributes
namestringrequiredaccountNumberstringinstitutionstring
totalsobjectrequiredShow 3 child attributesHide child attributes
totalDebitsstringrequiredtotalCreditsstringrequirednetMovementstringrequired
400Bad request - invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const result = await prosaic.generalLedger.byTransaction(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/general-ledger/transaction \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get ledger entries
/api/public/v1/entities/{entityId}/ledgerSDK: 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
pageintegerPage number (starts at 1)
Default:
1pageSizeintegerNumber of items per page
Default:
20dateFromstring (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 stringsComma-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 objectsrequiredShow 20 child attributesHide child attributes
narrationstringrequiredjournalTypestringrequiredbankTransactionIdstringrequirednullablegststringrequiredidstringrequireddescriptionstringrequirednullableupdatedAtstring (date-time)requiredcreatedAtstring (date-time)requiredparentIdstringrequirednullablejournalIdstringrequiredentityAccountIdstringrequiredtaxRateIdstringrequiredcreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
debitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
entityAccountobjectrequiredShow 3 child attributesHide child attributes
idstringrequirednamestringrequiredcodestringrequired
taxRateobjectrequiredShow 5 child attributesHide child attributes
idstringrequirednamestringrequireddescriptionstringrequirednullablecodestringrequiredratestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
accountVersionnumberrequirednullablelineNumbernumberrequiredsumAccountCreditsstringrequirednullableExact decimal serialized as a string. Use Decimal.js for arithmetic.
sumAccountDebitsstringrequirednullableExact decimal serialized as a string. Use Decimal.js for arithmetic.
paginationobjectrequiredShow 6 child attributesHide child attributes
currentPagenumberrequiredpageSizenumberrequiredtotalCountnumberrequiredtotalPagesnumberrequiredhasNextPagebooleanrequiredhasPreviousPagebooleanrequired
400Bad request - invalid parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const page = await prosaic.ledger.list(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/ledger \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get trial balance report
/api/public/v1/entities/{entityId}/trial-balanceSDK: 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
asOfDatestringAs-of date for cumulative mode. Defaults to today.
reportModestringReport calculation mode
One of:
cumulative,movementmovementStartDatestringStart date for movement mode.
movementEndDatestringEnd date for movement mode.
groupBystringHow to group accounts. Use
reportGroupfor saved report groups in the entity's country order. Each group'stypeis its stable key andnameis its label. Accounts without a saved group appear together underunassigned. Usenoneto group rows yourself. **Deprecated.** UsegroupBy=reportGroupin place ofgroupBy=subtype.One of:
type,subtype,reportGroup,noneincludeZeroBalancesstringInclude accounts with zero balances
One of:
false,truecomparisonstringWhether to include comparison columns
One of:
none,periodscomparisonTypestringType of comparison period. Used when comparison=periods.
One of:
year,monthcomparisonPeriodsstringNumber of comparison periods (1-12). Used when comparison=periods.
compareToEndOfMonthstringSnap comparison dates to end of month
One of:
false,truecompareToEndOfFinancialYearstringSnap comparison dates to end of financial year (31 March)
One of:
false,true
Responses
200 Successful response
metadataobjectrequiredShow 9 child attributesHide child attributes
entityIdstringrequiredentityNamestringrequiredgeneratedAtstringrequiredcurrencystringrequiredtimezonestringrequiredreportTypestringrequiredOne of:
trial-balanceasOfDatestringrequiredmovementStartDatestringmovementEndDatestring
totalsobjectrequiredShow 4 child attributesHide child attributes
totalDebitsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalCreditsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
isBalancedbooleanrequiredvariancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
accountGroupsarray of objectsrequiredShow 4 child attributesHide child attributes
typestringrequirednamestringrequiredaccountsarray of objectsrequiredShow 17 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Equity,Revenue,Expense,Asset,LiabilityaccountSubtypestringrequiredreportGroupKeystringnullablereportGroupNamestringreportCategoryKeystringnullablereportGroupobjectnullableShow 2 child attributesHide child attributes
keystringrequirednamestringrequired
reportCategoryobjectnullableShow 2 child attributesHide child attributes
keystringrequirednamestringrequired
debitBalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
creditBalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
netBalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
isSystemGeneratedbooleanearningsTypestringnullableOne of:
retained
subtotalobjectrequiredShow 3 child attributesHide child attributes
debitsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
creditsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
netstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobject
400Bad request - invalid query parameters or missing/invalid system account setup (SYSTEM_ACCOUNT_VALIDATION).401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const result = await prosaic.reports.trialBalance(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/trial-balance \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get profit & loss report
/api/public/v1/entities/{entityId}/reports/profit-lossSDK: prosaic.reports.profitLoss(entityId, params)
Returns a profit & loss report for the specified entity.
Path parameters
entityIdstringrequired
Query parameters
periodTypestringPeriod 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-yearstartDatestringStart date for custom period. Required when periodType is
custom.endDatestringEnd date for custom period. Required when periodType is
custom.comparisonstringWhether to include comparison columns
One of:
none,periodscomparisonTypestringGranularity 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,quartercomparisonPeriodsstringNumber of comparison periods (1-12)
includeZeroBalancesstringInclude accounts with zero balances
One of:
false,true
Responses
200 Successful response
metadataobjectrequiredShow 10 child attributesHide child attributes
entityIdstringrequiredentityNamestringrequiredgeneratedAtstringrequiredcurrencystringrequiredreportTypestringrequiredOne of:
profit-lossstartDatestringrequiredendDatestringrequiredperiodDescriptionstringrequiredcomparisonPeriodsarray of stringscomparisonPeriodRangesarray of objectsShow 3 child attributesHide child attributes
labelstringrequiredstartDatestringrequiredendDatestringrequired
tradingIncomeobjectrequiredShow 6 child attributesHide child attributes
headerstringrequiredtotalLabelstringrequiredaccountsarray of objectsrequiredShow 10 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Revenue,ExpenseaccountSubtypestringrequiredtotalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
balancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonPeriodsobjectsegmentsobject
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobjectrequiredsegmentTotalsobject
costOfSalesobjectrequiredShow 6 child attributesHide child attributes
headerstringrequiredtotalLabelstringrequiredaccountsarray of objectsrequiredShow 10 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Revenue,ExpenseaccountSubtypestringrequiredtotalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
balancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonPeriodsobjectsegmentsobject
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobjectrequiredsegmentTotalsobject
otherIncomeobjectrequiredShow 6 child attributesHide child attributes
headerstringrequiredtotalLabelstringrequiredaccountsarray of objectsrequiredShow 10 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Revenue,ExpenseaccountSubtypestringrequiredtotalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
balancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonPeriodsobjectsegmentsobject
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobjectrequiredsegmentTotalsobject
operatingExpensesobjectrequiredShow 6 child attributesHide child attributes
headerstringrequiredtotalLabelstringrequiredaccountsarray of objectsrequiredShow 10 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Revenue,ExpenseaccountSubtypestringrequiredtotalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
balancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonPeriodsobjectsegmentsobject
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobjectrequiredsegmentTotalsobject
hasTradingSectionbooleanrequiredtotalsobjectrequiredShow 4 child attributesHide child attributes
grossProfitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
grossProfitComparisonobjectrequirednetProfitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
netProfitComparisonobjectrequired
segmentColumnsarray of objectsShow 5 child attributesHide child attributes
keystringrequiredlabelstringrequiredisArchivedbooleanrequireddimensionIdstringdimensionNamestring
400Bad request - invalid query parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const result = await prosaic.reports.profitLoss(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/reports/profit-loss \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get balance sheet report
/api/public/v1/entities/{entityId}/reports/balance-sheetSDK: prosaic.reports.balanceSheet(entityId, params)
Returns a balance sheet report for the specified entity.
Path parameters
entityIdstringrequired
Query parameters
asOfDatestringAs-of date for the report. Defaults to today.
includeZeroBalancesstringInclude accounts with zero balances
One of:
false,truecomparisonstringWhether to include comparison columns
One of:
none,periodscomparisonTypestringType of comparison period
One of:
year,monthcomparisonPeriodsstringNumber of comparison periods (1-12)
Responses
200 Successful response
metadataobjectrequiredShow 6 child attributesHide child attributes
entityIdstringrequiredentityNamestringrequiredgeneratedAtstringrequiredcurrencystringrequiredreportTypestringrequiredOne of:
balance-sheetasOfDatestringrequired
sectionsobjectrequiredShow 3 child attributesHide child attributes
assetsobjectrequiredShow 4 child attributesHide child attributes
typestringrequiredOne of:
Equity,Assets,Liabilitiesnamestringrequiredgroupsarray of objectsrequiredShow 4 child attributesHide child attributes
typestringrequirednamestringrequiredaccountsarray of objectsrequiredShow 9 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Equity,Asset,LiabilityaccountSubtypestringrequiredearningsTypestringOne of:
retained,current-yearbalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
subtotalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
liabilitiesobjectrequiredShow 4 child attributesHide child attributes
typestringrequiredOne of:
Equity,Assets,Liabilitiesnamestringrequiredgroupsarray of objectsrequiredShow 4 child attributesHide child attributes
typestringrequirednamestringrequiredaccountsarray of objectsrequiredShow 9 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Equity,Asset,LiabilityaccountSubtypestringrequiredearningsTypestringOne of:
retained,current-yearbalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
subtotalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
equityobjectrequiredShow 4 child attributesHide child attributes
typestringrequiredOne of:
Equity,Assets,Liabilitiesnamestringrequiredgroupsarray of objectsrequiredShow 4 child attributesHide child attributes
typestringrequirednamestringrequiredaccountsarray of objectsrequiredShow 9 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredaccountTypestringrequiredOne of:
Equity,Asset,LiabilityaccountSubtypestringrequiredearningsTypestringOne of:
retained,current-yearbalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalCreditstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalDebitstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
subtotalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalsobjectrequiredShow 6 child attributesHide child attributes
totalAssetsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalLiabilitiesstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
totalEquitystringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
netAssetsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
isBalancedbooleanrequiredvariancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
earningsBreakdownobjectShow 2 child attributesHide child attributes
currentYearEarningsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
retainedEarningsstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobject
400Bad request - invalid query parameters or missing/invalid system account setup (SYSTEM_ACCOUNT_VALIDATION).401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const result = await prosaic.reports.balanceSheet(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/reports/balance-sheet \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get current accounts report
/api/public/v1/entities/{entityId}/reports/current-accountsSDK: prosaic.reports.currentAccounts(entityId, params)
Returns a current accounts report for the specified entity.
Path parameters
entityIdstringrequired
Query parameters
periodTypestringPeriod 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-yearstartDatestringStart date for custom period. Required when periodType is
custom.endDatestringEnd date for custom period. Required when periodType is
custom.comparisonstringWhether to include comparison columns
One of:
none,periodscomparisonTypestringGranularity 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,quartercomparisonPeriodsstringNumber of comparison periods (1-12)
Responses
200 Successful response
metadataobjectrequiredShow 12 child attributesHide child attributes
entityIdstringrequiredentityNamestringrequiredentityTypestringrequiredgeneratedAtstringrequiredcurrencystringrequiredreportTypestringrequiredstartDatestringrequiredendDatestringrequiredperiodDescriptionstringrequiredreportTitlestringrequiredcomparisonPeriodsarray of stringscomparisonPeriodRangesarray of objectsShow 3 child attributesHide child attributes
labelstringrequiredstartDatestringrequiredendDatestringrequired
openingBalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
openingBalanceComparisonobjectincreasesobjectrequiredShow 3 child attributesHide child attributes
accountsarray of objectsrequiredShow 5 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredamountstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonPeriodsobject
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobject
decreasesobjectrequiredShow 3 child attributesHide child attributes
accountsarray of objectsrequiredShow 5 child attributesHide child attributes
accountIdstringrequiredaccountCodestringrequiredaccountNamestringrequiredamountstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonPeriodsobject
totalstringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
comparisonTotalsobject
closingBalancestringrequiredExact decimal serialized as a string. Use Decimal.js for arithmetic.
closingBalanceComparisonobject
400Bad request - invalid query parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const result = await prosaic.reports.currentAccounts(entityId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/reports/current-accounts \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get depreciation schedule report
/api/public/v1/entities/{entityId}/reports/depreciation-scheduleSDK: prosaic.reports.depreciationSchedule(entityId, params)
Returns a depreciation schedule report for the specified entity.
Path parameters
entityIdstringrequired
Query parameters
startDatestringrequiredStart date for the schedule.
endDatestringrequiredEnd date for the schedule.
Responses
200 Successful response
metadataobjectrequiredShow 7 child attributesHide child attributes
entityIdstringrequiredentityNamestringrequiredcurrencystringrequiredstartDatestringrequiredendDatestringrequiredgeneratedAtstringrequiredperiodDescriptionstringrequired
assetsarray of objectsrequiredShow 18 child attributesHide child attributes
assetIdstringrequirednamestringrequiredassetTypeNamestringrequirednullablecostAccountNamestringrequirednullableexpenseAccountNamestringrequirednullablemethodstringrequiredratenumberrequirednullableprivateUsePercentagenumberrequiredpurchaseDatestringrequirednullablecostnumberrequiredopeningValuenumberrequiredpurchasesnumberrequireddisposalsnumberrequireddepreciationnumberrequiredinvestmentBoostnumberaccumulatedDepreciationnumberrequiredclosingValuenumberrequiredprivateUseAmountnumberrequired
totalsobjectrequiredShow 9 child attributesHide child attributes
costnumberrequiredopeningValuenumberrequiredpurchasesnumberrequireddisposalsnumberrequireddepreciationnumberrequiredinvestmentBoostnumberaccumulatedDepreciationnumberrequiredclosingValuenumberrequiredprivateUseAmountnumberrequired
400Bad request - invalid or missing query parameters401Unauthorized - Invalid or missing API key403Forbidden - No access to the specified entity500Internal server error
const result = await prosaic.reports.depreciationSchedule(entityId, {
startDate: '2026-04-01',
endDate: '2026-04-01',
});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"