Location.paymentBy is now nullable​

The deprecated paymentBy field on the Location type has changed from Int! to Int:

• paymentBy: Int - returns the raw ERP payment by code (0 = Due Date, 1 = Discount Date), and null when the ERP holds no value.

The underlying ERP column is nullable, so the previous non-null declaration could not be guaranteed. In practice existing locations all carry a value; clients that read the deprecated paymentBy field should nevertheless handle null. The recommended field remains paymentByType: String, which is unchanged and returns "Due Date", "Discount Date", or null when the ERP holds no value or a value outside the known set.

The descriptions of both paymentBy and paymentByType have been updated accordingly.

Location sync reports missing Payment By values as null​

Locations with no Payment By value in the ERP now sync with paymentBy and paymentByType set to null. Previously a missing value was silently reported as the default Due Date, which could not be distinguished from a real setting. Locations with an unrecognised Payment By code continue to sync with paymentByType: null while keeping the raw code in paymentBy.

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.

New ETL: Financial Periods​

The FinancialPeriods collection is now synced from the ERP. Each document describes a period in the company's financial calendar:

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

The collection supports deletion tracking and reconciliation (deletedDatabaseRecord).

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.

Budgets collection reimport​

The Budgets collection has been updated to use the full GLBudgetLine composite key (companyId, branchId, ledgerId, financialYear, groupId, parentGroupId). Sibling budget lines that share a groupId but differ in parentGroupId were previously collapsed under a single document, causing related rows to be lost.

Data Quality Improvements​

• Deletion tracking is now available for all collections except Budgets, GeneralLedgerBalances, and JournalTransactions. The API exposes an includeDeleted filter so integrations can choose whether soft-deleted records are included in query results.

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 Fields​

SupplierDocumentLine / APInvoiceLine​

Field	Type	Description
DeferralScheduleNbr	string	The deferral schedule's business number, populated separately from the existing DeferralSchedule (description) and DeferredCode (code) values.