API Obsoletion Policy
Overview
We understand the criticality of maintaining compatibility and continuity for our users while evolving our API offerings. Our API obsoletion policy is designed to provide clarity and support during transitions, ensuring a smooth journey for developers and applications alike.
Marking Obsolescence
When a feature or property is marked for obsolescence, it is clearly denoted with a since-version tag and accompanied by a remark detailing its deprecation. We strive to have a grace period of at least two years, which means that for example if a property is marked as obsolete in version 24.4, its end-of-life is typically not before version 26.4. This labeling ensures developers are aware of the changes and can plan their migration strategies accordingly.
Throughout the grace period, we are committed to maintaining command functionality whenever realistically possible. For simpler changes we ensure backward compatibility by supporting both old and new values variants.
In cases of significant structural alterations to entities served by the query API, we strive to preserve continuity and retain the existing structure. However there might be cases when this is not possible due to the nature of changes.
By adhering to these principles, we aim to empower our users with the confidence to embrace innovation while ensuring a seamless transition path for their applications.
v25.5
v25.2
| Type |
Property name |
Notes |
| Warehouses |
TimeZoneId |
Time zone is now on company level. All warhouses will return the same value as the company time zone. |
| CreateExtraField |
Identifier |
Replaced with ExtraFieldTemplateId |
| ExtraFieldValue |
Identifier |
Replaced with ExtraFieldTemplateId |
v25.1
v24.9
v24.7
| Type |
Property name |
Notes |
| PlannedAbsences |
Approved |
Use status instead. (Returns true if status is approved else returns false) |
| CreatePlannedAbsence |
Approved |
Use status instead. (Returns true if status is approved else returns false) |
| UpdatePlannedAbsence |
Approved |
Use status instead. (True = Approved, False = Applied for) |
| UpdateSupplierPartLink |
PartId |
Use SupplierPartLinkId since duplicate supplier is allowed in AddSupplierPartLink command |
| UpdateSupplierPartLink |
SupplierId |
Use SupplierPartLinkId since duplicate supplier is allowed in AddSupplierPartLink command |
v24.5
| Type |
Property name |
Notes |
| VatRates |
ReferenceTextId |
Replaced by Reference. |
| VatRates |
ReferenceText |
Replaced by Reference. |
v24.3
| Type |
Property name |
Notes |
| Inquiries |
CreatedById |
Unavailable |
| Inquiries |
VatNumber |
Unavailable |
| Suppliers |
SupplierAccountGroupId |
Refer to DeliveryAddress |
| Customers |
ShowPartStatisticalGoodsCodeAndCountryOfOriginInForms |
Replaced by ShowPartStatisticalGoodsCodeInForms and ShowCountryOfOriginInForms |
| CustomerOrders |
SupplierAccountGroupId |
Refer to DeliveryAddress |
| CustomerOrderRows |
PlannedDateOfArrival |
Unavailable |
v24.1
| Type |
Property name |
Notes |
| ProductRecords |
CustomerOrderPartRevisionId |
Replaced by PartRevisionId |
v23.6
| Type |
Property name |
Notes |
| Customers |
VatRateId |
Replaced by VatGroupId on DeliveryAddress |
| Customers |
VatRate |
Replaced by VatGroup from DeliveryAddress |
| SetProperties |
VatRateId |
Replaced by VatGroupId on DeliveryAddress |
| FileLink |
AllowExternalEditing |
Will always return true. |
v23.3
| Type |
Property name |
Notes |
| PhysicalInventoryRows |
Reported |
Use ReportingState to get current state and see if row is reported, pending approval or rejected |
v22.8
v22.7
| Type |
Property name |
Notes |
| FormReportConfigurations |
Type |
Replaced by TypeId.
$filter and $orderby cannot be used with this property. Use TypeId instead |
| AddBookingRow |
DebitAmountInCompanyCurreny |
Replaced by correctly spelled DebitAmountInCompanyCurrency |
v22.4
| Type |
Property name |
Notes |
| PaymentTerms |
IsFreeDeliveryMonth |
Replaced by Method |
v22.2
| Type |
Property name |
Notes |
| Shedules |
(all/type) |
Use TimeRecording/Schedules instead |
v2.54
| Type |
Property name |
Notes |
| Warehouses |
PalletRegistrationNumber |
Never used in G5. |
v2.49
| Type |
Property name |
Notes |
| BookingRows |
AuthorizedWhen |
Now returns AuthorizedWhen from last row authorization |
v2.48
v2.44
v2.41
| Type |
Property name |
Notes |
| Customers |
UseComprehensiveInvoices |
Replaced by ComprehensiveInvoiceGroupingMode |
| CustomerOrders |
IsPartOfComprehensiveInvoice |
Replaced by ComprehensiveInvoiceGroupingMode |
| CustomerOrderInvoices |
IsPartOfComprehensiveInvoice |
Replaced by ComprehensiveInvoiceGroupingMode |
v2.39
| Type |
Property name |
Notes |
| Countries |
VatGroupId |
Replaced by CustomerVatGroupId/SupplierVatGroupId |
v2.36
v2.35
| Type |
Property name |
Notes |
| CustomerOrders |
PrintoutTimeStamp |
Printout date is not stored on the order |
| CustomerOrders |
PrintoutBy |
Printout user is not stored on the order |
v2.32
| Type |
Property name |
Notes |
| Suppliers |
EdiCode |
Replaced by OtherSupplierNumbers |
| Customers |
EdiCode |
Replaced by OtherCustomerNumbers |
v2.30
| Type |
Property name |
Notes |
| CustomerOrders |
CustomerAccountGroupId |
Replaced by AccountGroupId |
v2.29
| Type |
Property name |
Notes |
| Customers |
TimeZoneOffset |
Replaced by TimeZone |
| Warehouses |
TimeZone |
Replaced by TimeZoneId |
v2.18
| Type |
Property name |
Notes |
| DeliveryAddresses |
DeliveryWeekdays |
Can be found under Warehouses |