9 posts tagged with "API"

New query: financialPeriods​

The financialPeriods query and the FinancialPeriod type are now available, exposing the company's financial calendar:

• Core fields: finPeriodId, startDate, endDate, description, active, year.
• Per-module close flags: closedInGeneralLedger, closedInSupplierLedger, closedInCustomerLedger, closedInInventoryManagement, closedInCashManagement, closedInFixedAssets.

Budget type now uses the full composite key​

The Budget type has been updated so that its GraphQL key matches the full GLBudgetLine primary key:

• branchId, ledgerId and financialYear are now marked as part of the key (@partOfKey).
• A new non-nullable field parentGroupId: String! has been added and is also part of the key.

This aligns the schema with the underlying ETL collection, which has been reimported with the same composite key. Clients querying the Budget type should add parentGroupId to their selection sets where the parent budget line is relevant.

Removed Query Arguments​

includeDeleted argument removed from selected queries​

The includeDeleted argument has been removed from the queries listed below. For these entities the underlying deletedDatabaseRecord field is not populated, so the argument had no effect - it was previously documented as Not active yet for budgets and journalTransactions, and as deprecated for the GL balance queries. It has now been dropped from the schema entirely.

New Fields​

deferralScheduleNbr on invoice line types​

A new optional deferralScheduleNbr: String field is exposed on the following types. It carries the deferral schedule's business number, separate from the existing deferralSchedule (description) and deferredCode (code) values.

• APInvoiceLine
• SupplierDocumentLine

New Query Arguments​

includeDeleted parameter added to additional queries​

Not active yet.

The includeDeleted argument (Boolean! = false) is now available on the following queries. When false (the default), soft-deleted records (deletedDatabaseRecord = true) are excluded from results. Pass includeDeleted: true to include them.

Improvements​

All ETLs now enabled in production​

All available ETL processes are now enabled in production. Previously disabled ETLs can now be activated through the provisioning API.

New Fields​

CustomerDocumentLine​

Field	Type	Description
lineType	String	The line type, letting you distinguish between different categories of customer document lines.
manualAmount	Decimal!	The manually entered amount override on the customer document line.
manualAmountInCurrency	Decimal!	The manually entered amount override expressed in the document's currency.

New Fields​

Experimental GL balance queries​

The generalLedgerBalanceExperimentalForwardPeriodsByGroup and generalLedgerBalanceExperimentalForwardPeriodsExpanded queries now accept an optional periodsUpTo parameter.

Parameter	Type	Description
periodsUpTo	String (format: yyyyMM)	Upper-bound financial period for forward expansion. When omitted, the current month is used (previous default behaviour).

New Endpoints​

• generalLedgerBalancesForwardByGroup - Forward-period expansion paginated by group. Each affected (branchId, accountId, subaccountId) group is expanded with virtual monthly periods up to the current month. Use lastGroupKey for cursor-based pagination. Marked as EXPERIMENTAL.
• generalLedgerBalancesForwardExpanded - Forward-period expansion with overflow. pageSize controls approximate source documents processed; response may exceed pageSize due to virtual period expansion. Use lastGroupKey for cursor-based pagination. Marked as EXPERIMENTAL.