MYOB Endpoint: Employees: Difference between revisions

(7 intermediate revisions by the same user not shown)

Line 1:

== Overview ==

The MYOB '''Employees''' [[Endpoints|endpoint]] allows you to access the list of employee cards. Note, these cards are also available via the ([[MYOB Endpoint: Cards|Cards]] endpoint.

The MYOB '''Employees''' [[MYOB Endpoints|endpoint]] allows you to access the list of employee cards. Note, these cards are also available via the [[MYOB Endpoint: Cards|Cards]] endpoint.

== Fields ==

The following fields are available for the Employees endpoint.

;DataFile

:A [[Field Type: Record|record field]] that provides the [[Field: DataFile|DataFile]] associated with the data.

;UID

Line 63:

Line 67:

;EmployeePayrollDetails

:A [[Field Type: ~~Object~~|~~object~~ field]] that gives access to the [[Field Type: GUID|UID sub-field]].

:A [[Field Type: Record|record field]] that gives access to the [[Field Type: GUID|UID sub-field]].

:See [[#EmployeePayrollDetails Fields|EmployeePayrollDetails Fields]] for more information.

;EmployeePaymentDetails

:A [[Field Type: ~~Object~~|~~object~~ field]] that gives access to the [[Field ~~Type~~: ~~GUID~~|~~UID sub-field]].~~

:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: EmployeePayrollDetails|employee payroll detail link fields]].

~~:See [[#EmployeePaymentDetails Fields|EmployeePaymentDetails Fields~~]] ~~for more information~~.

;EmployeeStandardPay

:A [[Field Type: ~~Object~~|~~object~~ field]] that gives access to the [[Field Type: GUID|UID sub-field]].

:A [[Field Type: Record|record field]] that gives access to the [[Field Type: GUID|UID sub-field]].

:See [[#EmployeeStandardPay Fields|EmployeeStandardPay Fields]] for more information.

;TimeBillingDetails

:A [[Field Type: ~~Object~~|~~object~~ field]] that gives access to the fields used for time-billing.

:A [[Field Type: Record|record field]] that gives access to the fields used for time-billing.

:See [[#TimeBillingDetails Fields|TimeBillingDetails Fields]] for more information.

Line 86:

Line 89:

;RowVersion

:A [[Field Type: Row Version|row version field]].

~~== EmployeePayrollDetails Fields ==~~

~~The [[#Fields|EmployeePayrollDetails]] field contains the following sub-fields.~~

~~;UID~~

~~:A [[Field Type: GUID|GUID field]] representing the payroll details id of this employee. This field can be used to link to [[MYOB Endpoint: EmployeePayrollDetails|EmployeePayrollDetails]] endpoint.~~

Line 125:

Line 120:

== MYOB API ==

For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/contact/~~personal~~/ MYOB API].

For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/contact/employee/ MYOB API].

Line 135:

Line 130:

:[[MYOB Field: CustomList|CustomList]]

:[[MYOB Field: CustomField|CustomField]]

:[[MYOB Field: EmployeePayrollDetails|EmployeePayrollDetails]]

Line 140:

Line 136:

:[[MYOB Endpoint: Cards|Cards]]

:[[MYOB Endpoint: EmployeePaymentDetails|EmployeePaymentDetails]]

:[[MYOB Endpoint: EmployeePayrollAdvices|EmployeePayrollAdvices]]

:[[MYOB Endpoint: EmployeePayrollDetails|EmployeePayrollDetails]]

:[[MYOB Endpoint: EmployeeStandardPays|EmployeeStandardPays]]

== Related Topics ==

:[[MYOB Models]]

:[[MYOB Endpoints]]

@@ Line 1: / Line 1: @@
 == Overview ==
-The MYOB '''Employees''' [[Endpoints|endpoint]] allows you to access the list of employee cards. Note, these cards are also available via the ([[MYOB Endpoint: Cards|Cards]] endpoint.
+The MYOB '''Employees''' [[MYOB Endpoints|endpoint]] allows you to access the list of employee cards. Note, these cards are also available via the [[MYOB Endpoint: Cards|Cards]] endpoint.
 == Fields ==
 The following fields are available for the Employees endpoint.
+;DataFile
+:A [[Field Type: Record|record field]] that provides the [[Field: DataFile|DataFile]] associated with the data.
 ;UID
@@ Line 63: / Line 67: @@
 ;EmployeePayrollDetails
-:A [[Field Type: Object|object field]] that gives access to the [[Field Type: GUID|UID sub-field]].
+:A [[Field Type: Record|record field]] that gives access to the [[Field Type: GUID|UID sub-field]].
 :See [[#EmployeePayrollDetails Fields|EmployeePayrollDetails Fields]] for more information.
 ;EmployeePaymentDetails
-:A [[Field Type: Object|object field]] that gives access to the [[Field Type: GUID|UID sub-field]].
+:A [[Field Type: Record|record field]] that gives access to the [[MYOB Field: EmployeePayrollDetails|employee payroll detail link fields]].
-:See [[#EmployeePaymentDetails Fields|EmployeePaymentDetails Fields]] for more information.
 ;EmployeeStandardPay
-:A [[Field Type: Object|object field]] that gives access to the [[Field Type: GUID|UID sub-field]].
+:A [[Field Type: Record|record field]] that gives access to the [[Field Type: GUID|UID sub-field]].
 :See [[#EmployeeStandardPay Fields|EmployeeStandardPay Fields]] for more information.
 ;TimeBillingDetails
-:A [[Field Type: Object|object field]] that gives access to the fields used for time-billing.
+:A [[Field Type: Record|record field]] that gives access to the fields used for time-billing.
 :See [[#TimeBillingDetails Fields|TimeBillingDetails Fields]] for more information.
@@ Line 86: / Line 89: @@
 ;RowVersion
 :A [[Field Type: Row Version|row version field]].
-== EmployeePayrollDetails Fields ==
-The [[#Fields|EmployeePayrollDetails]] field contains the following sub-fields.
-;UID
-:A [[Field Type: GUID|GUID field]] representing the payroll details id of this employee. This field can be used to link to [[MYOB Endpoint: EmployeePayrollDetails|EmployeePayrollDetails]] endpoint.
@@ Line 125: / Line 120: @@
 == MYOB API ==
-For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/contact/personal/ MYOB API].
+For a detailed run through of the endpoint, you can see the [https://developer.myob.com/api/accountright/v2/contact/employee/ MYOB API].
@@ Line 135: / Line 130: @@
 :[[MYOB Field: CustomList|CustomList]]
 :[[MYOB Field: CustomField|CustomField]]
+:[[MYOB Field: EmployeePayrollDetails|EmployeePayrollDetails]]
@@ Line 140: / Line 136: @@
 :[[MYOB Endpoint: Cards|Cards]]
+:[[MYOB Endpoint: EmployeePaymentDetails|EmployeePaymentDetails]]
+:[[MYOB Endpoint: EmployeePayrollAdvices|EmployeePayrollAdvices]]
+:[[MYOB Endpoint: EmployeePayrollDetails|EmployeePayrollDetails]]
+:[[MYOB Endpoint: EmployeeStandardPays|EmployeeStandardPays]]
+== Related Topics ==
+:[[MYOB Models]]
+:[[MYOB Endpoints]]