12 posts tagged with "API"

Production availability​

• ARHistoricalData is disabled in Production. The arHistoricalData query and its fields appear in the GraphQL reference, but the corresponding ETL is not enabled in Production. This documentation does not announce production availability for AR historical data.
• InventoryItems is enabled in Production. Use the inventoryItems query to retrieve inventory item data.

New Endpoints​

Both are marked EXPERIMENTAL: they may change or be removed without notice, and they are not yet recommended for production integrations. They are published now so you can evaluate them and give feedback on the pagination contract before it is fixed.

• generalLedgerBalancesForwardByGroupV2 - Forward-period expansion paginated by group, replacing generalLedgerBalancesForwardByGroup. Same arguments and same response shape; the difference is that page cost no longer grows with the size of your company's dataset.
• generalLedgerBalancesByPeriodV2 - The latest balance at or before a given financial period, one row per ledgerId / branchId / accountId / subaccountId group, replacing generalLedgerBalancesByPeriod.

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.

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.