MYOB Endpoint: Employees - Revision history

Nic at 23:15, 2 April 2025

2025-04-02T23:15:11Z

← Older revision		Revision as of 18:15, 2 April 2025
Line 7:		Line 7:

	The following fields are available for the Employees endpoint.		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		;UID

Nic at 05:45, 22 September 2021

2021-09-22T05:45:30Z

← Older revision		Revision as of 00:45, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== 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 ==		== Fields ==
Line 136:		Line 137:
	:[[MYOB Endpoint: EmployeePayrollDetails\|EmployeePayrollDetails]]		:[[MYOB Endpoint: EmployeePayrollDetails\|EmployeePayrollDetails]]
	:[[MYOB Endpoint: EmployeeStandardPays\|EmployeeStandardPays]]		:[[MYOB Endpoint: EmployeeStandardPays\|EmployeeStandardPays]]


			== Related Topics ==

			:[[MYOB Models]]
			:[[MYOB Endpoints]]

Nic at 05:32, 13 September 2021

2021-09-13T05:32:16Z

← Older revision		Revision as of 00:32, 13 September 2021
Line 132:		Line 132:

	:[[MYOB Endpoint: Cards\|Cards]]		:[[MYOB Endpoint: Cards\|Cards]]
			:[[MYOB Endpoint: EmployeePaymentDetails\|EmployeePaymentDetails]]
			:[[MYOB Endpoint: EmployeePayrollAdvices\|EmployeePayrollAdvices]]
			:[[MYOB Endpoint: EmployeePayrollDetails\|EmployeePayrollDetails]]
			:[[MYOB Endpoint: EmployeeStandardPays\|EmployeeStandardPays]]

Nic at 05:31, 13 September 2021

2021-09-13T05:31:22Z

← Older revision		Revision as of 00:31, 13 September 2021
Line 126:		Line 126:
	:[[MYOB Field: CustomList\|CustomList]]		:[[MYOB Field: CustomList\|CustomList]]
	:[[MYOB Field: CustomField\|CustomField]]		:[[MYOB Field: CustomField\|CustomField]]
			:[[MYOB Field: EmployeePayrollDetails\|EmployeePayrollDetails]]

Nic at 05:30, 13 September 2021

2021-09-13T05:30:58Z

← Older revision		Revision as of 00:30, 13 September 2021
Line 67:		Line 67:

	;EmployeePaymentDetails		;EmployeePaymentDetails
	:A [[Field Type: Record\|record 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		;EmployeeStandardPay
Line 86:		Line 85:
	;RowVersion		;RowVersion
	:A [[Field Type: Row Version\|row version field]].		: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.~~

Nic at 04:32, 30 August 2021

2021-08-30T04:32:26Z

← Older revision		Revision as of 23:32, 29 August 2021
Line 1:		Line 1:
	== Overview ==		== 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''' [[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 ==		== Fields ==

Nic at 01:46, 30 August 2021

2021-08-30T01:46:58Z

← Older revision		Revision as of 20:46, 29 August 2021
Line 125:		Line 125:
	== MYOB API ==		== 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].

Nic at 00:41, 30 August 2021

2021-08-30T00:41:56Z

← Older revision		Revision as of 19:41, 29 August 2021
Line 63:		Line 63:

	;EmployeePayrollDetails		;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.		:See [[#EmployeePayrollDetails Fields\|EmployeePayrollDetails Fields]] for more information.

	;EmployeePaymentDetails		;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 [[Field Type: GUID\|UID sub-field]].
	:See [[#EmployeePaymentDetails Fields\|EmployeePaymentDetails Fields]] for more information.		:See [[#EmployeePaymentDetails Fields\|EmployeePaymentDetails Fields]] for more information.

	;EmployeeStandardPay		;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.		:See [[#EmployeeStandardPay Fields\|EmployeeStandardPay Fields]] for more information.

	;TimeBillingDetails		;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.		:See [[#TimeBillingDetails Fields\|TimeBillingDetails Fields]] for more information.

Nic: Created page with "== Overview == The MYOB '''Employees''' endpoint allows you to access the list of employee cards. Note, these cards are also available via the (MYOB Endpoint:..."

2021-08-30T00:14:14Z

Created page with "== Overview == The MYOB '''Employees''' endpoint allows you to access the list of employee cards. Note, these cards are also available via the (MYOB Endpoint:..."

New page

== 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.

== Fields ==

The following fields are available for the Employees endpoint.

;UID
:A [[Field Type: GUID|GUID field]] representing the internal id of a card. This field can be used to link to other endpoints.
:Note that the UID will be the same as that on the [[MYOB Endpoint: Cards|Cards]] endpoint.

;CompanyName
:A [[Field Type: Text|text field]] used as the company name of the card.
:Note this only applies to cards set as companies and not individuals.

;LastName
:A [[Field Type: Text|text field]] used as the last name of the card.
:Note this only applies to cards set as individuals and not companies.

;FirstName
:A [[Field Type: Text|text field]] used as the first name of the card.
:Note this only applies to cards set as individuals and not companies.

;IsIndividual
:A [[Field Type: Boolean|true/false value]] that indicates if the card is an individual or a company.

;DisplayID
:A [[Field Type: Text|text field]] used as the Card ID.

;IsActive
:A [[Field Type: Boolean|true/false value]] that indicates if the card is active and can be used on new transactions.

;Addresses
:A [[Field Type: Table|table field]] that stores multiple [[MYOB Field: Addresses|addresses]] for this card.

;Notes
:A [[Field Type: Text|text field]] that stores notes for the card.

;Identifiers
:A [[Field Type: Table|table field]] that stores multiple [[MYOB Field: Identifiers|identifiers]] selected for this card.

;CustomList1
:A [[Field Type: Record|record field]] that stores the first [[MYOB Field: CustomList|custom list value]] selected for this card.

;CustomList2
:A [[Field Type: Record|record field]] that stores the second [[MYOB Field: CustomList|custom list value]] selected for this card.

;CustomList3
:A [[Field Type: Record|record field]] that stores the third [[MYOB Field: CustomList|custom list value]] selected for this card.

;CustomField1
:A [[Field Type: Record|record field]] that stores the first [[MYOB Field: CustomField|custom field value]] entered for this card.

;CustomField2
:A [[Field Type: Record|record field]] that stores the second [[MYOB Field: CustomField|custom field value]] entered for this card.

;CustomField3
:A [[Field Type: Record|record field]] that stores the third [[MYOB Field: CustomField|custom field value]] entered for this card.

;CurrentBalance
:A [[Field Type: Decimal|decimal field]] that gives access to the current outstanding balance of this card (amount owing or owed).

;EmployeePayrollDetails
:A [[Field Type: Object|object 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]].
: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]].
: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.
:See [[#TimeBillingDetails Fields|TimeBillingDetails Fields]] for more information.

;LastModified
:A [[Field Type: DateTimeOffset|date time field]] that stores the last date and time this card was modified.

;PhotoURI
:A [[Field Type: Text|text field]] that stores a URL that can be used to access the photo associated with this card.

;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.

== EmployeePaymentDetails Fields ==

The [[#Fields|EmployeePaymentDetails]] 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: EmployeePaymentDetails|EmployeePaymentDetails]] endpoint.

== EmployeeStandardPay Fields ==

The [[#Fields|EmployeeStandardPay]] 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: EmployeeStandardPays|EmployeeStandardPays]] endpoint.

== TimeBillingDetails Fields ==

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

;EmployeeBillingRateExcludingTax
:A [[Field Type: Decimal|decimal field]] that gives access to the time billing rate for this employee.

;CostPerHour
:A [[Field Type: Decimal|decimal field]] that gives access to the cost per employee of employing this employee.

== 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].

== Related Fields ==

:[[MYOB Field: Addresses|Addresses]]
:[[MYOB Field: Cards|Cards]]
:[[MYOB Field: Identifiers|Identifiers]]
:[[MYOB Field: CustomList|CustomList]]
:[[MYOB Field: CustomField|CustomField]]

== Related Endpoints==

:[[MYOB Endpoint: Cards|Cards]]