Merge pull request #642 from DannyvdSluijs/Update-09-04-2024

feat: Update to documentation d.d. 09-04-2024

src/Picqer/Financials/Exact/AcceptQuotation.php

@@ -8,7 +8,7 @@
  * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=CRMAcceptQuotation
  *
  * @property string $QuotationID Identifier of the quotation.
- * @property int $Action 0 = No action (Default), 1 = create sales order, 2 = create sales invoice, 3 = create project, 4 = add to existing project, 5 = create subscription, 99 = follow email with sign off action.
+ * @property int $Action 0 = No action (Default), 1 = create sales order, 2 = create sales invoice, 3 = create project, 4 = add to existing project, 5 = create subscription, 99 = follow email with sign off action. For CRM standalone: Code 99 only applicable for quotation with status '60 - Awaiting online acceptance'.
  * @property string $AddToExistingProjectSuccess Contains information if the quotation was successfully added to existing project.
  * @property bool $CreateItemPriceAgreement Create a project item price agreement. Only needed when Action = 3 or Action = 4. Default = True.
  * @property bool $CreateProjectWBS Create a project work breakdown structure. Only needed when ProjectBudgetType = 2.

src/Picqer/Financials/Exact/Account.php

@@ -113,6 +113,8 @@
  * @property string $PaymentConditionPurchaseDescription Description of PaymentConditionPurchase
  * @property string $PaymentConditionSales Code of default payment condition for sales
  * @property string $PaymentConditionSalesDescription Description of PaymentConditionSales
+ * @property string $PeppolIdentifier Peppol identifier user entered manually, corresponds to picked peppol adress
+ * @property int $PeppolIdentifierType Peppol identifier type that user picked manually - GLN, COC, etc
  * @property string $Phone Phone number
  * @property string $PhoneExtension Phone number extention
  * @property string $Postcode Visit address postcode
@@ -261,6 +263,8 @@ class Account extends Model
         'PaymentConditionPurchaseDescription',
         'PaymentConditionSales',
         'PaymentConditionSalesDescription',
+        'PeppolIdentifier',
+        'PeppolIdentifierType',
         'Phone',
         'PhoneExtension',
         'Postcode',

src/Picqer/Financials/Exact/DirectDebitMandate.php

@@ -9,6 +9,8 @@
  *
  * @property string $ID Primary key
  * @property string $Account Account to which the mandate belongs.
+ * @property string $Attachment Contain attachment (Format: Base64 encoded) of the mandate belongs. Binaries are not sent in the response.
+ * @property string $AttachmentFileName Filename of the attachment to which the mandate belongs.
  * @property string $BankAccount Bank account to which the mandate belongs.
  * @property string $CancellationDate Date that the mandate is cancelled. Used to check the validity of the mandate.
  * @property string $Created Creation date
@@ -34,6 +36,8 @@ class DirectDebitMandate extends Model
     protected $fillable = [
         'ID',
         'Account',
+        'Attachment',
+        'AttachmentFileName',
         'BankAccount',
         'CancellationDate',
         'Created',

src/Picqer/Financials/Exact/EmailWithSignOffQuotation.php

@@ -10,7 +10,7 @@
  * @property string $QuotationID Identifier of the quotation.
  * @property string $AcceptEmailLayout If you enter for this field, your customer receives an email with the quotation after approval of the quotation.
  * @property string $AcceptOpportunityStage The stage of the opportunity after approval of the quotation.
- * @property int $Action 0 = No action (Default), 1 = create sales order, 2 = create sales invoice, 3 = create project, 4 = add to existing project, 5 = create subscription
+ * @property int $Action 0 = No action (Default), 1 = create sales order, 2 = create sales invoice, 3 = create project, 4 = add to existing project, 5 = create subscription. For CRM standalone: If the value is not provided, the default value will set to '2 - create sales invoice'. If the value is provided, the value must be '2 - create sales invoice'. Otherwise, the error message will be thrown.
  * @property bool $AllowProvideYourRef Allow customers to enter their purchase order number.
  * @property bool $CreateItemPriceAgreement Create a project item price agreement. Only needed when Action = 3 or Action = 4. Default = True.
  * @property bool $CreateProjectWBS Create a project work breakdown structure. Only needed when ProjectBudgetType = 2.
@@ -19,7 +19,7 @@
  * @property string $EmailLayout Based on this layout the email text is produced.
  * @property string $ErrorMessage Contains the error message if an error occurred during the creation of the Email.
  * @property string $ExtraText Extra text that can be added to the printed document and email.
- * @property string $InvoiceJournal The journal in which the sales invoice will be booked. Mandatory for Action = 2.
+ * @property string $InvoiceJournal The journal in which the sales invoice will be booked. Mandatory for Action = 2. For CRM standalone: If the value is not provided, the default value will set to 'sales journal'. If the value is provided, the value must be 'sales journal'. Otherwise, the error message will be thrown.
  * @property int $ProjectBudgetType The budget type of the project that will be created. 0 = None (Default), 1 = Hours per hour type, 2 = Work breakdown structure (WBS).
  * @property string $ProjectClassification The ID of the project classification.
  * @property string $ProjectCode The code of the project that will be created. Mandatory for Action = 3.

src/Picqer/Financials/Exact/Employment.php

@@ -15,8 +15,8 @@
  * @property string $Employee Employee ID
  * @property string $EmployeeFullName Name of employee
  * @property int $EmployeeHID Numeric number of Employee
+ * @property int $EmploymentNumber Employment number
  * @property string $EndDate End date of employment
- * @property int $HID Numeric ID of the employment
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
@@ -40,8 +40,8 @@ class Employment extends Model
         'Employee',
         'EmployeeFullName',
         'EmployeeHID',
+        'EmploymentNumber',
         'EndDate',
-        'HID',
         'Modified',
         'Modifier',
         'ModifierFullName',

src/Picqer/Financials/Exact/EmploymentOrganization.php

@@ -22,16 +22,15 @@
  * @property string $Employee ID of employee
  * @property string $EmployeeFullName Name of employee
  * @property int $EmployeeHID Numeric ID of the employee
- * @property string $Employment Employement ID
- * @property int $EmploymentHID Numeric ID of the employment
+ * @property string $Employment Employment ID
+ * @property int $EmploymentNumber Employment number
  * @property string $EndDate Organization end date
  * @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 $Notes Explanation or extra information can be stored in the notes
  * @property string $StartDate Organization start date
  */
 class EmploymentOrganization extends Model
@@ -55,15 +54,14 @@ class EmploymentOrganization extends Model
         'EmployeeFullName',
         'EmployeeHID',
         'Employment',
-        'EmploymentHID',
+        'EmploymentNumber',
         'EndDate',
         'JobTitle',
         'JobTitleCode',
         'JobTitleDescription',
         'Modified',
         'Modifier',
         'ModifierFullName',
-        'Notes',
         'StartDate',
     ];
 

src/Picqer/Financials/Exact/EmploymentSalary.php

@@ -8,71 +8,95 @@
  * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=PayrollEmploymentSalaries
  *
  * @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 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
  * @property string $Created Creation date
  * @property string $Creator User ID of creator
  * @property string $CreatorFullName Name of creator
+ * @property string $Description General section: Custom description
  * @property int $Division Division code
  * @property string $Employee Employee ID
  * @property string $EmployeeFullName Name of employee
  * @property int $EmployeeHID Employee number
  * @property string $Employment Employment
- * @property int $EmploymentHID Employment number
+ * @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 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
  * @property float $FulltimeAmount Salary when working fulltime
  * @property float $HourlyWage Hourly wage
+ * @property float $IntercompanyRate Rate Section: Intercompany rate
  * @property float $InternalRate Internal rate for time & billing or professional service user
  * @property int $JobLevel Employee job level in context of a wage scale
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
  * @property float $ParttimeAmount Salary when working parttime
  * @property float $ParttimeFactor Contract hours / Fulltime contract hours
+ * @property int $SalaryBasedType Salary Section: Salary based on.Value: 0 - Manual entry, 1 - Wagescale, 2 - Minimum wage, 3 - Minimum hourly wage
+ * @property string $SalaryBasedTypeDescription When SalaryBasedType value is 0, return 'Manual entry'When SalaryBasedType value 1, return 'Wage scale'When SalaryBasedType value 2, return 'Minimum wage'When SalaryBasedType value 3, return 'Minimum hourly wage'
  * @property string $Scale Employee wage scale
  * @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 $WageScale Salary Section: Wagescale ID
+ * @property int $WageScalePeriod Salary Section: Period for automatic step increase
+ * @property string $WageScaleStep Salary Section: Wagescale Step Code
  */
 class EmploymentSalary extends Model
 {
     use Query\Findable;
 
     protected $fillable = [
         'ID',
+        'AmountType',
+        'AmountTypeDescription',
         'AverageDaysPerWeek',
         'AverageHoursPerWeek',
+        'BillabilityTarget',
         'Created',
         'Creator',
         'CreatorFullName',
+        'Description',
         'Division',
         'Employee',
         'EmployeeFullName',
         'EmployeeHID',
         'Employment',
-        'EmploymentHID',
+        'EmploymentNumber',
         'EmploymentSalaryType',
         'EmploymentSalaryTypeDescription',
         'EndDate',
+        'ExternalRate',
         'Frequency',
+        'FrequencyDescription',
         'FulltimeAmount',
         'HourlyWage',
+        'IntercompanyRate',
         'InternalRate',
         'JobLevel',
         'Modified',
         'Modifier',
         'ModifierFullName',
         'ParttimeAmount',
         'ParttimeFactor',
+        'SalaryBasedType',
+        'SalaryBasedTypeDescription',
         'Scale',
         'Schedule',
         'ScheduleCode',
         'ScheduleDescription',
         'StartDate',
+        'WageScale',
+        'WageScalePeriod',
+        'WageScaleStep',
     ];
 
     protected $url = 'payroll/EmploymentSalaries';

src/Picqer/Financials/Exact/EmploymentTaxAuthoritiesGeneral.php

@@ -17,7 +17,7 @@
  * @property string $EmployeeFullName Name of employee
  * @property int $EmployeeHID Employee number
  * @property string $Employment Employment
- * @property int $EmploymentHID Employment number
+ * @property int $EmploymentNumber Employment number
  * @property string $EndDate End date of employment agencies
  * @property string $InfluenceInsuranceObligation Influence insurance obligation
  * @property string $InfluenceInsuranceObligationDescription Influence insurance obligation description
@@ -46,7 +46,7 @@ class EmploymentTaxAuthoritiesGeneral extends Model
         'EmployeeFullName',
         'EmployeeHID',
         'Employment',
-        'EmploymentHID',
+        'EmploymentNumber',
         'EndDate',
         'InfluenceInsuranceObligation',
         'InfluenceInsuranceObligationDescription',

src/Picqer/Financials/Exact/ProjectTimeTransaction.php

@@ -26,7 +26,7 @@
  * @property string $EndTime End time of the time transaction
  * @property int $EntryNumber Number that represents the grouping of time transactions
  * @property string $ErrorText (Only used by backgroundjobs) To determine which transaction has an error
- * @property int $HourStatus Status of the transaction: 1 = Draft, 2 = Rejected, 10 = Submitted, 11 = Failed on approval, 14 = Processing, 16 = Processing, 19 = Failed while undoing approval, 20 = Final
+ * @property int $HourStatus For POST/PUT: Status of the transaction: 1 = Draft, 2 = Rejected, 10 = Submitted For GET: Status of the transaction: 1 = Draft, 2 = Rejected, 10 = Submitted, 11 = Failed on approval, 14 = Processing, 16 = Processing, 19 = Failed while undoing approval, 20 = Final
  * @property string $Item Item that is linked to the transaction, which provides the time information
  * @property string $ItemDescription Description of the item that is linked to the transaction
  * @property bool $ItemDivisable Indicates if fractional quantities of the item can be used, for example quantity = 0.4

src/Picqer/Financials/Exact/StockSerialNumber.php

@@ -22,7 +22,7 @@
  * @property string $Modified Last modified date
  * @property string $Modifier User ID of modifier
  * @property string $ModifierFullName Name of modifier
- * @property string $ParentID ID to link part item to assembled item (assembly order and pick order only)
+ * @property string $ParentID The main item’s serial number ID, which should be linked to the issued part’s item serial number for the shop order.
  * @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 in which this serial or batch number was reserved. Provided only for the Exact Online Premium users.

src/Picqer/Financials/Exact/SyncAccount.php

@@ -114,6 +114,8 @@
  * @property string $PaymentConditionPurchaseDescription Description of PaymentConditionPurchase
  * @property string $PaymentConditionSales Code of default payment condition for sales
  * @property string $PaymentConditionSalesDescription Description of PaymentConditionSales
+ * @property string $PeppolIdentifier Peppol identifier user entered manually, corresponds to picked peppol adress
+ * @property int $PeppolIdentifierType Peppol identifier type that user picked manually - GLN, COC, etc
  * @property string $Phone Phone number
  * @property string $PhoneExtension Phone number extention
  * @property string $Postcode Visit address postcode
@@ -264,6 +266,8 @@ class SyncAccount extends Model
         'PaymentConditionPurchaseDescription',
         'PaymentConditionSales',
         'PaymentConditionSalesDescription',
+        'PeppolIdentifier',
+        'PeppolIdentifierType',
         'Phone',
         'PhoneExtension',
         'Postcode',

src/Picqer/Financials/Exact/SyncBankAccount.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Picqer\Financials\Exact;
+
+/**
+ * Class SyncBankAccount.
+ *
+ * @see https://start.exactonline.nl/docs/HlpRestAPIResourcesDetails.aspx?name=SyncPayrollBankAccounts
+ *
+ * @property int $Timestamp Timestamp
+ * @property string $BankAccountHolderName The bank account holder name. (maximum of 50 characters)
+ * @property string $BICCode BIC code of the bank where the bank account is held. (maximum of 11 characters)
+ * @property string $Created Creation date
+ * @property string $Creator User ID of creator
+ * @property string $CreatorFullName Name of creator
+ * @property string $Description The description of the bank account. (maximum of 60 characters)
+ * @property string $Employee This is the employee id to which the bank account belongs to.
+ * @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 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.
+ */
+class SyncBankAccount extends Model
+{
+    use Query\Findable;
+
+    protected $primaryKey = 'Timestamp';
+
+    protected $fillable = [
+        'Timestamp',
+        'BankAccountHolderName',
+        'BICCode',
+        'Created',
+        'Creator',
+        'CreatorFullName',
+        'Description',
+        'Employee',
+        'EmployeeFullName',
+        'EmployeeHID',
+        'ID',
+        'Main',
+        'Modified',
+        'Modifier',
+        'ModifierFullName',
+        'Number',
+    ];
+
+    protected $url = 'sync/Payroll/BankAccounts';
+}

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
+ * @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 string $ID Primary key
  */
 class SyncDeleted extends Model