Merge pull request #656 from DannyvdSluijs/Update-from-documentation-2024-08-27

feat: Update based on documentation d.d. 2024-08-27

Author: stephangroen

src/Picqer/Financials/Exact/Account.php

@@ -80,7 +80,7 @@
  * @property string $InvoiceAccountCode Code of InvoiceAccount
  * @property string $InvoiceAccountName Name of InvoiceAccount
  * @property int $InvoiceAttachmentType Indicates which attachment types should be sent when a sales invoice is printed. Only values in related table with Invoice=1 are allowed
- * @property int $InvoicingMethod Method of sending for sales invoices. Values: 1: Paper, 2: EMail, 4: Mailbox (electronic exchange), 8: Send and track
+ * @property int $InvoicingMethod Method of sending for sales invoices. Values: 1: Paper, 2: EMail, 4: Mailbox (electronic exchange), 8: Send and trackTake notes: To use the '4 - Mailbox (electronic exchange)' option, the 'Mailbox' feature set is required in the licence.
  * @property int $IsAccountant Indicates whether the account is an accountant. Values: 0 = No accountant, 1 = True, but accountant doesn't want his name to be published in the list of accountants, 2 = True, and accountant is published in the list of accountants
  * @property int $IsAgency Indicates whether the accounti is an agency
  * @property int $IsAnonymised Indicates whtether the account is anonymised.
@@ -119,7 +119,7 @@
  * @property string $PhoneExtension Phone number extention
  * @property string $Postcode Visit address postcode
  * @property string $PriceList Default sales price list for account
- * @property string $PurchaseCurrency Currency of purchase
+ * @property string $PurchaseCurrency Currency of purchaseTake notes: If the currency code input is not in the active currencies, the value will be set to empty.
  * @property string $PurchaseCurrencyDescription Description of PurchaseCurrency
  * @property int $PurchaseLeadDays Indicates number of days required to receive a purchase. Acts as a default
  * @property string $PurchaseVATCode Default VAT code used for purchase entries
@@ -130,7 +130,7 @@
  * @property string $ResellerCode Code of Reseller
  * @property string $ResellerName Name of Reseller
  * @property string $RSIN Fiscal number for NL legislation
- * @property string $SalesCurrency Currency of Sales used for Time & Billing
+ * @property string $SalesCurrency Currency of Sales used for Time & BillingTake notes: If the currency code input is not in the active currencies, the value will be set to empty.
  * @property string $SalesCurrencyDescription Description of SalesCurrency
  * @property string $SalesVATCode Default VAT code for a sales entry
  * @property string $SalesVATCodeDescription Description of SalesVATCode

src/Picqer/Financials/Exact/Address.php

@@ -45,7 +45,7 @@
  * @property string $FreeTextField_03 Free text field 3
  * @property string $FreeTextField_04 Free text field 4
  * @property string $FreeTextField_05 Free text field 5
- * @property string $Mailbox Mailbox
+ * @property string $Mailbox MailboxTake notes: The 'Mailbox' functionality required the Mailbox feature set in the licence.
  * @property bool $Main Indicates if the address is the main address for this type
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier

src/Picqer/Financials/Exact/CostTransaction.php

@@ -8,7 +8,7 @@
  * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=ProjectCostTransactions
  *
  * @property string $ID Primary key
- * @property string $Account Guid ID of account that is linked to the project
+ * @property string $Account Reference to the account
  * @property string $AccountName Name of account that is linked to the project
  * @property float $AmountFC Calculated amount of the transaction based on (Quantity * PriceFC)
  * @property string $Attachment Attachment linked to the transaction (not mandatory)

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, User and Contact
+ * @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 $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/DefaultAddressForAccount.php

@@ -45,7 +45,7 @@
  * @property string $FreeTextField_03 Free text field 3
  * @property string $FreeTextField_04 Free text field 4
  * @property string $FreeTextField_05 Free text field 5
- * @property string $Mailbox Mailbox
+ * @property string $Mailbox MailboxTake notes: The 'Mailbox' functionality required the Mailbox feature set in the licence.
  * @property bool $Main Indicates if the address is the main address for this type
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier

src/Picqer/Financials/Exact/Employee.php

@@ -29,6 +29,7 @@
  * @property string $Creator User ID of creator
  * @property string $CreatorFullName Name of creator
  * @property string $Customer Customer ID
+ * @property string $CustomField Custom field endpoint. Provided only for the Exact Online Premium users.
  * @property int $Division Division code
  * @property string $Email Page: User maintenance page; Section: PersonalE-mail address of a user. If employee is linked to a user, the user email is stored in this property.Note: 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 employeesUsers created in Exact Online can access the company or companies in an administration.
  * @property int $EmployeeHID Employee number
@@ -60,7 +61,9 @@
  * @property string $Person Reference to the persons table in which the personal data of the employee is stored
  * @property string $Phone Phone numberNote: 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 $PhoneExtension Phone number extensionNote: 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 $Picture Bytes of the logo image
  * @property string $PictureFileName Filename of picture
+ * @property string $PictureThumbnailUrl Thumbnail url of the picture
  * @property string $PictureUrl Url of picture
  * @property string $Postcode PostcodeNote: 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 $PrivateEmail Section: Personal Personal e-mail address of the employee.Note: 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
@@ -98,6 +101,7 @@ class Employee extends Model
         'Creator',
         'CreatorFullName',
         'Customer',
+        'CustomField',
         'Division',
         'Email',
         'EmployeeHID',
@@ -129,7 +133,9 @@ class Employee extends Model
         'Person',
         'Phone',
         'PhoneExtension',
+        'Picture',
         'PictureFileName',
+        'PictureThumbnailUrl',
         'PictureUrl',
         'Postcode',
         'PrivateEmail',

src/Picqer/Financials/Exact/Employment.php

@@ -25,7 +25,7 @@
  * @property int $ReasonEndFlex Reason of ended flexible employment
  * @property string $ReasonEndFlexDescription Other reason for end of employment
  * @property string $StartDate Start date of employment
- * @property string $StartDateOrganization Start date of the employee in the organization. This field is used to count the years in service.
+ * @property string $StartDateOrganization Start date of the employee in the organization. This field is used to count the years in service.Note: For PUT, this property will update the start date years in service for all employments of this employee
  */
 class Employment extends Model
 {

src/Picqer/Financials/Exact/EmploymentContract.php

@@ -10,7 +10,9 @@
  * @property string $ID Primary key
  * @property int $ContractFlexPhase Flexible employment contract phase
  * @property string $ContractFlexPhaseDescription Flexible employment contract phase description.
+ * @property bool $CreateAutoCorrection Confirmation: Create Auto CorrectionWhen the 'payroll run' already finalized and the update is made to the employment contract start date, the system will first block the PUT action with the message below. With the 'PayrollCorrection' right, the error message below will be thrown:  This change will lead to a recalculation of previous periods. A correction request will be created with the following data:   Activation date: 01-01-2019   Payroll year: 2019   Period: 1  If you are confirmed want to proceed, set the [CreateAutoCorrection] to True and re-submit the request. Without the 'PayrollCorrection' right, the error message below will be thrown:  You do not have rights to change data that can influence processed payroll transactions. Note : If you delete this contract in an already calculated period, auto corrections will be created for this employee.
  * @property string $Created Creation date
+ * @property bool $CreatePredecessorsForLinkedAgencies Confirmation: Create Predecessors For Linked AgenciesThe system will block the POST/PUT action when one of the condition below fulfilled: When create (POST) a new successor, the employment contract successor start date is set to an earlier payroll year. When update (PUT) the existing employment contract start date to an earlier payroll year. The error message below will be thrown:  Attention: If you change the start date to an earlier payroll year, predecessors will be created for linked agencies.  You will have to check if the data of the predecessors is correct.  If you are confirmed want to proceed, set the [CreatePredecessorsForLinkedAgencies] to True and re-submit the request.
  * @property string $Creator User ID of creator
  * @property string $CreatorFullName Name of creator
  * @property int $Division Division code
@@ -28,10 +30,11 @@
  * @property string $ModifierFullName Name of modifier
  * @property string $ProbationEndDate Employment probation end date
  * @property int $ProbationPeriod Employment probation period
+ * @property string $ProbationPeriodDescription Contract probation period description
  * @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
  * @property string $ReasonContractDescription Employment contract reason description
  * @property int $Sequence Sequence number
- * @property string $StartDate Start date of employment contract
+ * @property string $StartDate Start date of employment contractNote : Be aware that for PUT, when you use a start date in the past it will also update years in service to this date.
  * @property int $Type Type of employment contract. 1 - Definite, 2 - Indefinite, 3 - External
  * @property string $TypeDescription Description of employment contract type
  */
@@ -43,7 +46,9 @@ class EmploymentContract extends Model
         'ID',
         'ContractFlexPhase',
         'ContractFlexPhaseDescription',
+        'CreateAutoCorrection',
         'Created',
+        'CreatePredecessorsForLinkedAgencies',
         'Creator',
         'CreatorFullName',
         'Division',
@@ -61,6 +66,7 @@ class EmploymentContract extends Model
         'ModifierFullName',
         'ProbationEndDate',
         'ProbationPeriod',
+        'ProbationPeriodDescription',
         'ReasonContract',
         'ReasonContractDescription',
         'Sequence',

src/Picqer/Financials/Exact/EmploymentOrganization.php

@@ -24,14 +24,14 @@
  * @property int $EmployeeHID Numeric ID of the employee
  * @property string $Employment Employment ID
  * @property int $EmploymentNumber Employment number
- * @property string $EndDate Organization end date
+ * @property string $EndDate Organization end dateNote : This property only supported for successor
  * @property string $JobTitle ID of job title
  * @property string $JobTitleCode Job title code
  * @property string $JobTitleDescription Job title description
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
- * @property string $StartDate Organization start date
+ * @property string $StartDate Organization start dateNote : This property only supported for successor
  */
 class EmploymentOrganization extends Model
 {

src/Picqer/Financials/Exact/EmploymentSalary.php

@@ -10,6 +10,7 @@
  * @property string $ID Primary key
  * @property int $AmountType Salary Section: Salary typeValue: 0 - Gross, 1 - Net.
  * @property string $AmountTypeDescription Salary Section: Salary type descriptionWhen AmountType value is 0, return 'Gross'When AmountType value 1, return 'Net'
+ * @property bool $AutoCorrection Confirmation: Create Auto CorrectionWhen the 'payroll run' already finalized and the update is made to the employment salary amount, the system will first block the PUT action with the message below. With the 'PayrollCorrection' right, the error message below will be thrown:  This change will lead to a recalculation of previous periods. A correction request will be created with the following data:   Activation date: 01-01-2019   Payroll year: 2019   Period: 1  If you are confirmed want to proceed, set the [AutoCorrection] to True and re-submit the request. Without the 'PayrollCorrection' right, the error message below will be thrown:  You do not have rights to change data that can influence processed payroll transactions. Note : If you delete this salary in an already calculated period, auto corrections will be created for this employee.
  * @property float $AverageDaysPerWeek The average number of contract days that an employee works per week
  * @property float $AverageHoursPerWeek The average number of contract hours that an employee works per week
  * @property float $BillabilityTarget Schedule Section: Billability target
@@ -25,7 +26,7 @@
  * @property int $EmploymentNumber Employment number
  * @property int $EmploymentSalaryType Salary type of employment. 1 - Periodical (fixed), 2 - Per hour (variable)
  * @property string $EmploymentSalaryTypeDescription Salary type description
- * @property string $EndDate Salary record end date
+ * @property string $EndDate Salary record end dateNote : This property only supported for successor.
  * @property float $ExternalRate Rate Section: External rate
  * @property int $Frequency Frequency: 1 - Yearly, 2 - Quarterly, 3 - Monthly, 4 - 4-weekly, 5 - Weekly, 11 - Yearly (Pro forma), 12 - Quarterly (Pro forma), 13 - Monthly (Pro forma), 14 - 4-Weekly (Pro forma), 15 - Weekly (Pro forma)
  * @property string $FrequencyDescription Payroll period frequency description
@@ -45,7 +46,7 @@
  * @property string $Schedule Employment schedule
  * @property string $ScheduleCode Employment schedule code
  * @property string $ScheduleDescription Description of employment schedule
- * @property string $StartDate Salary record start date
+ * @property string $StartDate Salary record start dateNote : This property only supported for successor.
  * @property string $WageScale Salary Section: Wagescale ID
  * @property int $WageScalePeriod Salary Section: Period for automatic step increase
  * @property string $WageScaleStep Salary Section: Wagescale Step Code
@@ -58,6 +59,7 @@ class EmploymentSalary extends Model
         'ID',
         'AmountType',
         'AmountTypeDescription',
+        'AutoCorrection',
         'AverageDaysPerWeek',
         'AverageHoursPerWeek',
         'BillabilityTarget',