Merge pull request #661 from DannyvdSluijs/Update-from-documentation-2024-10-28

feat: Update based on documentation d.d. 2024-10-28

Author: stephangroen

src/Picqer/Financials/Exact/DivisionClassName.php

@@ -14,7 +14,6 @@
  * @property string $Customer ID of customer
  * @property string $Description Description of classification
  * @property int $DescriptionTermID Term ID of the classification
- * @property DivisionClass[] $DivisionClasses Collection of classification properties
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
@@ -32,7 +31,6 @@ class DivisionClassName extends Model
         'Customer',
         'Description',
         'DescriptionTermID',
-        'DivisionClasses',
         'Modified',
         'Modifier',
         'ModifierFullName',

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 $ContractNumber Contract Number
  * @property string $Created Creation date
  * @property string $Creator User ID of creator
  * @property string $CreatorFullName Name of creator
@@ -69,6 +70,7 @@ class Document extends Model
         'CategoryDescription',
         'Contact',
         'ContactFullName',
+        'ContractNumber',
         'Created',
         'Creator',
         'CreatorFullName',

src/Picqer/Financials/Exact/Me.php

@@ -27,6 +27,7 @@
  * @property bool $IsEmployeeSelfServiceUser Employee user with limited access and specific start page
  * @property bool $IsMyFirmLiteUser MyFirm lite user of accountant with limited access and specific start page (internal use)
  * @property bool $IsMyFirmPortalUser MyFirm user of accountant with limited access and specific start page (internal use)
+ * @property bool $IsOEIMigrationMandatory Determines whether one exact identity migration is mandatory for the user. True - User does have to migrate, False - User does not have to migrate
  * @property bool $IsStarterUser Starter user with limited access and specific start page (internal use)
  * @property string $Language Language spoken by this user
  * @property string $LanguageCode Language (culture) that is used in Exact Online
@@ -73,6 +74,7 @@ class Me extends Model
         'IsEmployeeSelfServiceUser',
         'IsMyFirmLiteUser',
         'IsMyFirmPortalUser',
+        'IsOEIMigrationMandatory',
         'IsStarterUser',
         'Language',
         'LanguageCode',

src/Picqer/Financials/Exact/PrintedSalesInvoice.php

@@ -18,6 +18,8 @@
  * @property string $EmailLayout Based on this layout the email text is produced
  * @property string $ExtraText Extra text that can be added to the printed document and email
  * @property string $InvoiceDate Date of the invoice
+ * @property string $PeppolCreationError Contains the error message if an error occurred during the sending via peppol
+ * @property string $PeppolCreationSuccess Contains information if sending via peppol was succesfully sent
  * @property string $PostboxMessageCreationError Contains the error message if an error occurred during the sending of a postbox message
  * @property string $PostboxMessageCreationSuccess Contains information if a postbox message was succesfully sent
  * @property string $PostboxSender The postbox from where the message is sent
@@ -26,6 +28,7 @@
  * @property bool $SendEmailToCustomer Set to True if an email containing the invoice should be sent to the invoice customer. This option overrules SendInvoiceToCustomerPostbox.
  * @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.
  */
 class PrintedSalesInvoice extends Model
@@ -47,6 +50,8 @@ class PrintedSalesInvoice extends Model
         'EmailLayout',
         'ExtraText',
         'InvoiceDate',
+        'PeppolCreationError',
+        'PeppolCreationSuccess',
         'PostboxMessageCreationError',
         'PostboxMessageCreationSuccess',
         'PostboxSender',
@@ -55,6 +60,7 @@ class PrintedSalesInvoice extends Model
         'SendEmailToCustomer',
         'SenderEmailAddress',
         'SendInvoiceToCustomerPostbox',
+        'SendInvoiceViaPeppol',
         'SendOutputBasedOnAccount',
     ];
 

src/Picqer/Financials/Exact/Project.php

@@ -47,6 +47,7 @@
  * @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 string $InvoiceDescription Description for generate project invoice
  * @property InvoiceTerm[] $InvoiceTerms Collection of invoice terms
  * @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
@@ -118,6 +119,7 @@ class Project extends Model
         'InternalNotes',
         'InvoiceAddress',
         'InvoiceAsQuoted',
+        'InvoiceDescription',
         'InvoiceTerms',
         'IsWBSRequiredForEntry',
         'Manager',

src/Picqer/Financials/Exact/Schedule.php

@@ -8,28 +8,32 @@
  * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=HRMSchedules
  *
  * @property string $ID Primary key
- * @property float $AverageHours Average hours per week in a schedule
+ * @property float $AverageHours Average hours per week in a schedulePlease be aware this property is mandatory if you use ScheduleType 1 or 2.For Time and Billing basic company, when creating a new schedule, the value is set to 0. When schedule entries are created, the BC will set the calculated value for Average hours per week.
  * @property float $BillabilityTarget Billability target
  * @property string $Code Schedule code
  * @property string $Created Creation date
  * @property string $Creator ID of creator
  * @property string $CreatorFullName Name of the creator
- * @property float $Days Average days per week in the schedule
+ * @property float $Days Average days per week in the scheduleFor Time and Billing basic company, when creating a new schedule, the value is set to 0. When schedule entries are created, the BC will set the calculated value for Average days per week.
  * @property string $Description Description of the schedule
  * @property int $Division Division code
+ * @property string $Employee Employee ID of the schedule
+ * @property string $EmployeeFullName Employee full name of the schedule
  * @property string $Employment Employment ID for schedule
- * @property int $EmploymentHID Employment number
+ * @property string $EmploymentCLA Employment CLA ID of the schedule
+ * @property int $EmploymentNumber Employment number
  * @property string $EndDate End date of the schedule
  * @property float $Hours Number of hours per week in a CLA for which the schedule is built
- * @property float $LeaveHoursCompensation Number of hours which are built up each week for later leave
+ * @property float $LeaveHoursCompensation Number of hours which are built up each week for later leaveFor Time and Billing basic company, the value is set to 0.
  * @property int $Main Indication if the schedule is a main schedule for a CLA. 1 = Yes, 0 = No
  * @property string $Modified Last modified date
  * @property string $Modifier ID of modifier
  * @property string $ModifierFullName Name of the modifier
  * @property float $PaymentParttimeFactor Part-time factor for payroll calculation. Value between 0 and 1
- * @property int $ScheduleType Type of schedule. 1 = Hours and average days, 2 = Hours and specific days, 3 = Hours per day, 4 = Time frames per day
+ * @property ScheduleEntry[] $ScheduleEntries The collection of schedule entries
+ * @property int $ScheduleType Type of schedule. 1 = Hours and average days, 2 = Hours and specific days, 3 = Hours per day, 4 = Time frames per day1 - Hours and average days, StartWeek will automatically set to 12 - Hours and specific days, StartWeek must be greater or equal to 1, AverageDaysPerWeek will automatically set to 03 - Hours per day, StartWeek must be greater or equal to 1, AverageHoursPerWeek and AverageDaysPerWeek will automatically set to 04 - Time frames per day, Hours per day, StartWeek must be greater or equal to 1, AverageHoursPerWeek and AverageDaysPerWeek will automatically set to 0Note: For Time and Billing basic company, the schedule type is automatically set to value "3 - Hour per day".
  * @property string $ScheduleTypeDescription Description of the schedule type
- * @property string $StartDate Week in the schedule which is used to start with. By default the number will be 1.
+ * @property string $StartDate Start date of the schedule
  * @property int $StartWeek Week to start the schedule from for an employee
  */
 class Schedule extends Model
@@ -47,8 +51,11 @@ class Schedule extends Model
         'Days',
         'Description',
         'Division',
+        'Employee',
+        'EmployeeFullName',
         'Employment',
-        'EmploymentHID',
+        'EmploymentCLA',
+        'EmploymentNumber',
         'EndDate',
         'Hours',
         'LeaveHoursCompensation',
@@ -57,6 +64,7 @@ class Schedule extends Model
         'Modifier',
         'ModifierFullName',
         'PaymentParttimeFactor',
+        'ScheduleEntries',
         'ScheduleType',
         'ScheduleTypeDescription',
         'StartDate',

src/Picqer/Financials/Exact/SyncBankAccount.php

@@ -18,11 +18,11 @@
  * @property string $EmployeeFullName Name of employee
  * @property int $EmployeeHID Numeric number of Employee
  * @property string $ID Primary key
- * @property bool $Main This indicates if the bank account is the main bank account. Set this to true if the bank account is the main bank account. If there are no bank accounts, the first bank account will automatically be set as the main bank account.
+ * @property bool $Main This indicates if the bank account is the main bank account
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
- * @property string $Number This is the bank account number.
+ * @property string $Number This is the bank account number. (maximum of 34 characters)
  */
 class SyncBankAccount 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 $ContractNumber Contract Number
  * @property string $Created Creation date
  * @property string $Creator User ID of creator
  * @property string $CreatorFullName Name of creator
@@ -73,6 +74,7 @@ class SyncDocument extends Model
         'CategoryDescription',
         'Contact',
         'ContactFullName',
+        'ContractNumber',
         'Created',
         'Creator',
         'CreatorFullName',

src/Picqer/Financials/Exact/SyncProject.php

@@ -48,6 +48,7 @@
  * @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 string $Manager Responsible person for this project
  * @property string $ManagerFullname Name of Manager
  * @property float $MarkupPercentage Purchase markup percentage
@@ -115,6 +116,7 @@ class SyncProject extends Model
         'InternalNotes',
         'InvoiceAddress',
         'InvoiceAsQuoted',
+        'InvoiceDescription',
         'IsWBSRequiredForEntry',
         'Manager',
         'ManagerFullname',

src/Picqer/Financials/Exact/SyncSchedule.php

@@ -30,7 +30,7 @@
  * @property float $PaymentParttimeFactor Part-time factor for payroll calculation. Value between 0 and 1
  * @property int $ScheduleType Type of schedule. 1 = Hours and average days, 2 = Hours and specific days, 3 = Hours per day, 4 = Time frames per day
  * @property string $ScheduleTypeDescription Description of the schedule type
- * @property string $StartDate Week in the schedule which is used to start with. By default the number will be 1.
+ * @property string $StartDate Start date of the schedule
  * @property int $StartWeek Week to start the schedule from for an employee
  */
 class SyncSchedule extends Model