Merge pull request #638 from DannyvdSluijs/Update-from-documentation-…

…2024-03-06

feat: Update to documentation d.d. 06-03-2024

src/Picqer/Financials/Exact/CustomField.php

@@ -11,7 +11,7 @@
  * @property string $BusinessComponentName Business component name
  * @property string $Caption Custom field description
  * @property string $PropertyName Custom business property name
- * @property string $RefersTo The name of the referencing entity. The supported values are Item, Account, Project, Opportunity, SalesOrder and Contact
+ * @property string $RefersTo The name of the referencing entity. The supported values are Item, Account, Project, Opportunity, SalesOrder, User and Contact
  * @property string $Type Represents the data type of the custom field. The supported datatypes are boolean, integer, string, double, date and GUID
  * @property string $Value Custom field data
  */

src/Picqer/Financials/Exact/Employee.php

@@ -51,7 +51,6 @@
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
- * @property string $Municipality Municipality
  * @property int $NameComposition
  * @property string $Nationality NationalityNote: The value is only returned if user has any of the following roles: View userEnter variable payroll mutationsManage employeesAnonymise employee and userView personal information Of employees
  * @property string $NickName Nick name
@@ -121,7 +120,6 @@ class Employee extends Model
         'Modified',
         'Modifier',
         'ModifierFullName',
-        'Municipality',
         'NameComposition',
         'Nationality',
         'NickName',

src/Picqer/Financials/Exact/EmploymentContract.php

@@ -21,12 +21,11 @@
  * @property int $EmployeeType Type of employee. 1 - Employee, 2 - Contractor, 3 - Temporary, 4 - Student, 5 - Flexworker
  * @property string $EmployeeTypeDescription Employee type description
  * @property string $Employment Employment ID
- * @property int $EmploymentHID Numeric ID of the employment
+ * @property int $EmploymentNumber Employment number
  * @property string $EndDate End date of employment contract
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
- * @property string $Notes Notes of employment contract
  * @property string $ProbationEndDate Employment probation end date
  * @property int $ProbationPeriod Employment probation period
  * @property int $ReasonContract Employment contract reason code. 1 - New employment, 2 - Employment change, 3 - New legal employer, 4 - Acquisition 5 - Previous contract expired, 6 - Other
@@ -55,12 +54,11 @@ class EmploymentContract extends Model
         'EmployeeType',
         'EmployeeTypeDescription',
         'Employment',
-        'EmploymentHID',
+        'EmploymentNumber',
         'EndDate',
         'Modified',
         'Modifier',
         'ModifierFullName',
-        'Notes',
         'ProbationEndDate',
         'ProbationPeriod',
         'ReasonContract',

src/Picqer/Financials/Exact/PaymentCondition.php

@@ -26,7 +26,7 @@
  * @property int $PaymentDays Number of days to be included in the due date calculation. Example: invoice date = 17/01 PaymentEndOfMonths = 2 => 31/03 PaymentDays = 15 => 15/04
  * @property string $PaymentDiscountType Type of payment discount. Values: B = Settlement discount, K = Credit surcharge
  * @property int $PaymentEndOfMonths Number of month endings to be included in the due date calculation
- * @property string $PaymentMethod Method of payment. Values: B = On credit, I = Collection, K = Cash
+ * @property string $PaymentMethod Method of payment. Values: B = On credit, I = Collection, K = Cash, Q = PSP Collection
  * @property float $Percentage Percentage (stored as fraction) of total invoice amount
  * @property string $VATCalculation Indicates how the VAT amount is calculated Values: E = Excluding discount, I = Including discount
  */

src/Picqer/Financials/Exact/ShopOrder.php

@@ -55,6 +55,8 @@
  * @property int $ShopOrderMaterialPlanBackflushCount Number of shop order material plans, which are backflushed, for this shop order
  * @property int $ShopOrderMaterialPlanCount Number of shop order material plans for this shop order
  * @property ShopOrderMaterialPlan[] $ShopOrderMaterialPlans Collection of Shop order Material plans
+ * @property int $ShopOrderMaterialPlansNonIssuedByproductsCount Count of non-issued shop order material plans related to byproducts
+ * @property int $ShopOrderMaterialPlansNonIssuedMaterialsCount Count of non-issued shop order material plans related to materials
  * @property int $ShopOrderNumber Unique number to indentify the shop order
  * @property string $ShopOrderNumberString Unique number to indentify the shop order (as a string to allow OData filtering, e.g. $filter=substringof('123',ShopOrderNumberString) eq true
  * @property string $ShopOrderParent Shop order parent
@@ -123,6 +125,8 @@ class ShopOrder extends Model
         'ShopOrderMaterialPlanBackflushCount',
         'ShopOrderMaterialPlanCount',
         'ShopOrderMaterialPlans',
+        'ShopOrderMaterialPlansNonIssuedByproductsCount',
+        'ShopOrderMaterialPlansNonIssuedMaterialsCount',
         'ShopOrderNumber',
         'ShopOrderNumberString',
         'ShopOrderParent',

src/Picqer/Financials/Exact/StockBatchNumber.php

@@ -28,7 +28,7 @@
  * @property string $PickOrderLine ID of pick order entry in which this serial or batch number was used.
  * @property float $Quantity Quantity of this batch number entering or leaving inventory
  * @property string $Remarks Remarks
- * @property string $SalesOrderLine ID of sales order line
+ * @property string $SalesOrderLine ID of sales order in which this serial or batch number was reserved. Provided only for the Exact Online Premium users.
  * @property string $SalesReturnLine ID of sales return entry in which this serial or batch number was used
  * @property string $StockCountLine ID of stock count entry
  * @property string $StockTransactionID ID of the stock transaction in which this serial or batch number was used

src/Picqer/Financials/Exact/StockSerialNumber.php

@@ -25,7 +25,7 @@
  * @property string $ParentID ID to link part item to assembled item (assembly order and pick order only)
  * @property string $PickOrderLine ID of pick order entry in which this serial or batch number was used.
  * @property string $Remarks Remarks
- * @property string $SalesOrderLine ID of sales order line
+ * @property string $SalesOrderLine ID of sales order in which this serial or batch number was reserved. Provided only for the Exact Online Premium users.
  * @property string $SalesReturnLine ID of sales return entry in which this serial or batch number was used
  * @property string $SerialNumber Human readable serial number
  * @property string $SerialNumberID Serial number ID

src/Picqer/Financials/Exact/SyncStockSerialBatchNumber.php

@@ -28,7 +28,7 @@
  * @property string $PurchaseTransaction ID of purchase transaction associated with this serial or batch number.
  * @property float $Quantity Quantity of this serial or batch number entering or leaving inventory
  * @property string $Remarks Remarks
- * @property string $SalesOrderLine ID of sales order line associated with this serial or batch number.
+ * @property string $SalesOrderLine ID of sales order in which this serial or batch number was reserved. Provided only for the Exact Online Premium users.
  * @property string $SalesReturnLine ID of sales return associated with this serial or batch number.
  * @property string $SalesTransaction ID of sales transaction associated with this serial or batch number.
  * @property string $SerialBatchNumber Serial or Batch Number ID

src/Picqer/Financials/Exact/UpdateCustomField.php

@@ -11,7 +11,7 @@
  * @property string $BusinessComponentName Business component name
  * @property string $Caption Custom field description
  * @property string $PropertyName Custom business property name
- * @property string $RefersTo The name of the referencing entity. The supported values are Item, Account, Project, Opportunity, SalesOrder and Contact
+ * @property string $RefersTo The name of the referencing entity. The supported values are Item, Account, Project, Opportunity, SalesOrder, User and Contact
  * @property string $Type Represents the data type of the custom field. The supported datatypes are boolean, integer, string, double, date and GUID
  * @property string $Value Custom field data
  */

src/Picqer/Financials/Exact/WBSActivity.php

@@ -36,6 +36,8 @@
  * @property string $PartOfDescription Description of part of
  * @property string $Project ID of the project that linked to WBS activity
  * @property string $ProjectDescription Project description that is linked to WBS activity
+ * @property bool $ReleaseInvoiceTerm Action to release the invoice term. You can only release a WBS activity's invoice term once and it cannot be undo
+ * @property string $ReleaseInvoiceTermDate Release invoice term date. The linked invoice term date can be updated by using this property. The update will only happen when releasing a WBS activity's invoice term
  * @property int $SequenceNumber Sequence number of the WBS activity. Last sequence will be selected if not specified
  * @property string $StartDate Start date of the WBS activity
  * @property float $TimeQuantityToAlert Alert when exceeding this time quantity
@@ -75,6 +77,8 @@ class WBSActivity extends Model
         'PartOfDescription',
         'Project',
         'ProjectDescription',
+        'ReleaseInvoiceTerm',
+        'ReleaseInvoiceTermDate',
         'SequenceNumber',
         'StartDate',
         'TimeQuantityToAlert',

src/Picqer/Financials/Exact/WBSExpense.php

@@ -13,6 +13,7 @@
  * @property bool $BlockRebilling To indicated if rebilling is blocked
  * @property float $BudgetedCost Budget cost of the WBS expense
  * @property float $BudgetedRevenue Revenue of the WBS expense
+ * @property bool $Completed To indicated if the WBS expense is completed
  * @property string $Created The date and time when the WBS expense was created
  * @property string $Creator The ID of the user that created the WBS expense
  * @property string $CreatorFullName The full name of the user that created the WBS expense
@@ -35,6 +36,8 @@
  * @property string $ProjectDescription Project description that is linked to WBS expense
  * @property float $PurchasePrice Purchase price of the item
  * @property float $Quantity Quantity of the WBS
+ * @property bool $ReleaseInvoiceTerm Action to release the invoice term. You can only release a WBS expense's invoice term once and it cannot be undo
+ * @property string $ReleaseInvoiceTermDate Release invoice term date. The linked invoice term date can be updated by using this property. The update will only happen when releasing a WBS expense's invoice term
  * @property int $SequenceNumber Sequence number of the WBS deliverable. Last sequence will be selected if not specified
  * @property string $StartDate Start date of the WBS expense
  * @property string $Supplier Supplier of the item
@@ -51,6 +54,7 @@ class WBSExpense extends Model
         'BlockRebilling',
         'BudgetedCost',
         'BudgetedRevenue',
+        'Completed',
         'Created',
         'Creator',
         'CreatorFullName',
@@ -73,6 +77,8 @@ class WBSExpense extends Model
         'ProjectDescription',
         'PurchasePrice',
         'Quantity',
+        'ReleaseInvoiceTerm',
+        'ReleaseInvoiceTermDate',
         'SequenceNumber',
         'StartDate',
         'Supplier',