Merge pull request #663 from DannyvdSluijs/Update-from-documentation-2024-12-31

feat: Update based on documentation d.d. 2024-12-31

Author: stephangroen

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, Contact, User, Employee and Document
+ * @property string $RefersTo The name of the referencing entity. The supported values are Item, Account, Project, Opportunity, SalesOrder, Contact, User, Employee, Document and Team
  * @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/Document.php

@@ -17,6 +17,7 @@
  * @property string $CategoryDescription Description of Category
  * @property string $Contact ID of the related contact of this document
  * @property string $ContactFullName Contact full name
+ * @property string $ContractID The contract linked to the document
  * @property string $ContractNumber Contract Number
  * @property string $Created Creation date
  * @property string $Creator User ID of creator
@@ -70,6 +71,7 @@ class Document extends Model
         'CategoryDescription',
         'Contact',
         'ContactFullName',
+        'ContractID',
         'ContractNumber',
         'Created',
         'Creator',

src/Picqer/Financials/Exact/ExchangeRate.php

@@ -15,7 +15,7 @@
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
- * @property float $Rate The exchange rate is stored as 1 TARGET CURRENCY = x SOURCE CURRENCY
+ * @property float $Rate The exchange rate is stored as 1 TARGET CURRENCY = 1/x SOURCE CURRENCY
  * @property string $SourceCurrency The foreign currency
  * @property string $SourceCurrencyDescription Description of the foreign currency
  * @property string $StartDate The date as of which the rate is valid. The rate is valid until a next rate is defined

src/Picqer/Financials/Exact/ManufacturingSetting.php

@@ -12,8 +12,6 @@
  * @property int $InventorySubMethod What is the division's sub inventory method? Perpetual=1,NonPerpetual=2,AngloSaxon=3
  * @property int $NegativeStockIsAllowed Does the current division allow negative stock?
  * @property int $SerialNumbersAreMandatory Are serial numbers mandatory in this division?
- * @property int $ShowBackflushMaterials Should ShopOrderMaterialPlans with Backflush=True be shown within Smart Shop Floor?
- * @property int $ShowSubOrderMaterials Should ShopOrderMaterialPlans linked to a SubOrder be shown within Smart Shop Floor?
  */
 class ManufacturingSetting extends Model
 {
@@ -27,8 +25,6 @@ class ManufacturingSetting extends Model
         'InventorySubMethod',
         'NegativeStockIsAllowed',
         'SerialNumbersAreMandatory',
-        'ShowBackflushMaterials',
-        'ShowSubOrderMaterials',
     ];
 
     protected $url = 'manufacturing/ManufacturingSettings';

src/Picqer/Financials/Exact/PrintedSalesInvoice.php

@@ -29,7 +29,7 @@
  * @property string $SenderEmailAddress Email address from which the email will be sent. If not specified, the company email address will be used.
  * @property bool $SendInvoiceToCustomerPostbox Set to True if a postbox message containing the invoice should be sent to the invoice customer Take notes:The digital postbox option only available if the license has Mailbox feature set.
  * @property bool $SendInvoiceViaPeppol Set to True if the invoice should be sent via peppol to the invoice customer.
- * @property bool $SendOutputBasedOnAccount Set to True if the output preference should be taken from the account. It will be either Document only, Email or Digital postbox. This option overrules both SendEmailToCustomer and SendInvoiceToCustomerPostbox. Take notes:The digital postbox option only available if the license has Mailbox feature set.
+ * @property bool $SendOutputBasedOnAccount Set to True if the output preference should be taken from the account. It will be either Document only, Email, Digital postbox or Peppol. This option overrules by SendEmailToCustomer, SendInvoiceToCustomerPostbox, SendInvoiceViaPeppol. Take notes:The digital postbox option only available if the license has Mailbox feature set.
  */
 class PrintedSalesInvoice extends Model
 {

src/Picqer/Financials/Exact/Project.php

@@ -28,7 +28,7 @@
  * @property string $BudgetTypeDescription Budget type description
  * @property string $Classification Used only for PSA to link a project classification to the project
  * @property string $ClassificationDescription Description of Classification
- * @property string $Code Code
+ * @property string $Code Code Note : Code is not mandatory in PSA packages.If no code is provided, project auto number will be used, but this can only be applied to PSA packages.
  * @property float $CostsAmountFC Used only for PSA to store the budgetted costs of a project (except for project type Campaign and Non-billable). Positive quantities only
  * @property string $Created Creation date
  * @property string $Creator User ID of creator

src/Picqer/Financials/Exact/ProjectProgressReport.php

@@ -28,6 +28,7 @@
 class ProjectProgressReport extends Model
 {
     use Query\Findable;
+    use Persistance\Storable;
 
     protected $fillable = [
         'ID',

src/Picqer/Financials/Exact/SyncDeleted.php

@@ -12,7 +12,7 @@
  * @property string $DeletedDate Deleted date
  * @property int $Division Division code
  * @property string $EntityKey Entity key
- * @property int $EntityType Entity Types: 1= TransactionLines 2= Accounts 3= Addresses 4= Attachments 5= Contacts 6= Documents 7= GLAccounts 8= ItemPrices 9= Items 10= PaymentTerms 12= SalesOrders (This entity is going to be removed. Please refer to the new entity SalesOrderHeaders, SalesOrderLines.) 13= SalesInvoices 14= TimeCostTransactions 15= StockPositions 16= GoodsDeliveries 17= GoodsDeliveryLines 18= GLClassifications 19= ItemWarehouses 20= StorageLocationStockPositions 21= Projects 22= PurchaseOrders 23= Subscriptions 24= SubscriptionLines 25= ProjectWBS 26= ProjectPlanning 27= LeaveAbsenceHoursByDay 28= SerialBatchNumbers 29= StockSerialBatchNumbers 30= ItemAccounts 31= DiscountTables 32= SalesOrderHeaders 33= SalesOrderLines 34= QuotationHeaders 35= QuotationLines 36= ShopOrders 37= ShopOrderMaterialPlans 38= ShopOrderRoutingStepPlans 39= Schedules 40= ScheduleEntries 41= ItemStorageLocations 42= Employees 43= Employments 44= EmploymentContracts 45= EmploymentOrganizations 46= EmploymentCLAs 47= EmploymentSalaries 48= BankAccounts 49= EmploymentTaxAuthoritiesGeneral
+ * @property int $EntityType Entity Types: 1= TransactionLines 2= Accounts 3= Addresses 4= Attachments 5= Contacts 6= Documents 7= GLAccounts 8= ItemPrices 9= Items 10= PaymentTerms 12= SalesOrders (This entity is going to be removed. Please refer to the new entity SalesOrderHeaders, SalesOrderLines.) 13= SalesInvoices 14= TimeCostTransactions 15= StockPositions 16= GoodsDeliveries 17= GoodsDeliveryLines 18= GLClassifications 19= ItemWarehouses 20= StorageLocationStockPositions 21= Projects 22= PurchaseOrders 23= Subscriptions 24= SubscriptionLines 25= ProjectWBS 26= ProjectPlanning 27= LeaveAbsenceHoursByDay 28= SerialBatchNumbers 29= StockSerialBatchNumbers 30= ItemAccounts 31= DiscountTables 32= SalesOrderHeaders 33= SalesOrderLines 34= QuotationHeaders 35= QuotationLines 36= ShopOrders 37= ShopOrderMaterialPlans 38= ShopOrderRoutingStepPlans 39= Schedules 40= ScheduleEntries 41= ItemStorageLocations 42= Employees 43= Employments 44= EmploymentContracts 45= EmploymentOrganizations 46= EmploymentCLAs 47= EmploymentSalaries 48= BankAccounts 49= EmploymentTaxAuthoritiesGeneral 50= ShopOrderPurchasePlanning 51= ShopOrderSubOrders
  * @property string $ID Primary key
  */
 class SyncDeleted extends Model

src/Picqer/Financials/Exact/SyncDocument.php

@@ -17,6 +17,7 @@
  * @property string $CategoryDescription Description of Category
  * @property string $Contact ID of the related contact of this document
  * @property string $ContactFullName Contact full name
+ * @property string $ContractID The contract linked to the document
  * @property string $ContractNumber Contract Number
  * @property string $Created Creation date
  * @property string $Creator User ID of creator
@@ -74,6 +75,7 @@ class SyncDocument extends Model
         'CategoryDescription',
         'Contact',
         'ContactFullName',
+        'ContractID',
         'ContractNumber',
         'Created',
         'Creator',

src/Picqer/Financials/Exact/SyncProject.php

@@ -37,6 +37,7 @@
  * @property string $Description Description of the project
  * @property int $Division Division code
  * @property string $DivisionName Name of Division
+ * @property bool $EnableWorkInProgress Work in progress: To be invoiced
  * @property string $EndDate End date of the project. In combination with the start date the status is determined
  * @property string $FixedPriceItem Item used for fixed price invoicing. To be defined per project. If empty the functionality relies on the setting
  * @property string $FixedPriceItemDescription Description of FixedPriceItem
@@ -47,8 +48,8 @@
  * @property string $InternalNotes Internal notes not to be printed in invoice
  * @property string $InvoiceAddress Invoice address
  * @property bool $InvoiceAsQuoted Indicates whether the project is invoice as quoted
- * @property int $IsWBSRequiredForEntry Indicates whether the project WBS is required for time and cost entry E.g: 0 = Based on company setting, 1 = Yes, 2 = No
  * @property string $InvoiceDescription Description for generate project invoice
+ * @property int $IsWBSRequiredForEntry Indicates whether the project WBS is required for time and cost entry E.g: 0 = Based on company setting, 1 = Yes, 2 = No
  * @property string $Manager Responsible person for this project
  * @property string $ManagerFullname Name of Manager
  * @property float $MarkupPercentage Purchase markup percentage
@@ -106,6 +107,7 @@ class SyncProject extends Model
         'Description',
         'Division',
         'DivisionName',
+        'EnableWorkInProgress',
         'EndDate',
         'FixedPriceItem',
         'FixedPriceItemDescription',