Difference between revisions of "MYOB Advanced and Wageloch Onboarding"

From Wageloch Wiki

Line 31: Line 31:


=Creating Endpoints under the "WagelochOnboarding" Endpoint=
=Creating Endpoints under the "WagelochOnboarding" Endpoint=
In the <b>Web Service Endpoints</b> screen, select the newly created endpoint <b>WagelochOnboarding</b>


The endpoints we need to create are:


===EmployeeClasses Endpoint===
* EmployeeClasses
* VelixoBranches
* Departments
* Calendar
* Positions
* VelixoExpenseAccounts
* VelixoExpenseSubAccounts
* CashAccounts
* PayGroups




===VelixoBranches Endpoint===
When creating the above endpoints, we'll be presented with a <b>Create Entity</b> box; the <b>Object Name</b> and the above endpoint names <u>need</u> to match.




===Departments Endpoint===
==EmployeeClasses Endpoint==


* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.


===Calendar Endpoint===


[[File:MYOBAD-add-ep.png]]


===Positions Endpoint===
* You'll now see the <b>Create Entity</b> box.
* Type <b>EmployeeClasses</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.




===VelixoExpenseAccounts Endpoint===
[[File:MYOBAD-ep-insert.png]]


* Type <b>EP2020PL</b> into the Search box up the top right.
* Double click <b>EmployeeClasses</b> with the <b>Screen ID:</b> EP.20.20.PL or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.


===VelixoExpenseSubAccounts Endpoint===


[[File:MYOBAD-empclass-ep.png|top]]  [[File:MYOBAD-save-EP.png|500px|top]]


===CashAccounts Endpoint===


==VelixoBranches Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.


===PayGroups Endpoint===
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>VelixoBranches</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>VE500020</b> into the Search box up the top right.
* Double click <b>VelixoReportsPro-Branches</b> with the <b>Screen ID:</b> VE.50.00.20 or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-velixobranch-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]
 
 
==Departments Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.
 
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>Departments</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>EP201500</b> into the Search box up the top right.
* Double click <b>Departments</b> with the <b>Screen ID:</b> EP.20.15.00 or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-dept-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]
 
 
==Calendar Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.
 
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>Calendar</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>CS2090PL</b> into the Search box up the top right.
* Double click <b>Work Calendar</b> with the <b>Screen ID:</b> EP.20.90.PL or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-workcal-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]
 
==Positions Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.
 
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>EmployeeClasses</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>EP201000</b> into the Search box up the top right.
* Double click <b>Positions</b> with the <b>Screen ID:</b> EP.20.10.00 or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-position-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]
 
 
==VelixoExpenseAccounts Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.
 
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>VelixoExpenseAccounts</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>VE500015</b> into the Search box up the top right.
* Double click <b>VelixoReportsPro-Accounts</b> with the <b>Screen ID:</b> VE.50.00.15 or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-velixoacct-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]
 
 
==VelixoExpenseSubAccounts Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.
 
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>VelixoReportsPro-Subaccounts</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>VE500090</b> into the Search box up the top right.
* Double click <b>VelixoReportsPro-Subaccounts</b> with the <b>Screen ID:</b> VE.50.00.90 or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-velixosubacct-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]
 
==CashAccounts Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.
 
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>CashAccounts</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>CA202000</b> into the Search box up the top right.
* Double click <b>CashAccounts</b> with the <b>Screen ID:</b> CA.20.20.00 or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-cash-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]
 
 
==PayGroups Endpoint==
* Select the <b>ENDPOINT</b> heading in the list
* Click the <b>+INSERT</b> button above.
 
 
[[File:MYOBAD-add-ep.png]]
 
* You'll now see the <b>Create Entity</b> box.
* Type <b>PayGroups</b> into the <b>Object Name</b>
* Click the magnifying glass next to <b>Screen Name</b>.
 
 
[[File:MYOBAD-ep-insert.png]]
 
* Type <b>MPPP2710</b> into the Search box up the top right.
* Double click <b>PayGroups</b> with the <b>Screen ID:</b> MP.PP.27.10 or use the Select button.
* Wait for <b>ScreenID</b> to populate and click <b>OK</b> to get back to your endpoint menu.
* Ensure you hit the <b>Save</b> icon up the top of the screen after <u>every</u> Endpoint creation to prevent loss of data.
 
 
[[File:MYOBAD-paygroup-ep.png]]  [[File:MYOBAD-save-EP.png|500px|top]]

Revision as of 05:17, 10 November 2023

If you use MYOB Advanced and are considering using Wageloch's onboarding tool, there is a very specific setup that needs to be completed.

This process outlines creating the end points in MYOB Advanced that will help employee's onboarding information transfer freely between Wageloch and MYOB Advanced.

Create Initial Endpoint

  • Log into MYOB Advanced.
  • Select More Items from the left menu and click Integrations.
  • In the Preferences category, select Web Service Endpoints.


MYOBAD-more-integrations.png MYOBAD-integration-endpoints.png

  • Select the Default endpoint name (top of the list).
  • When opened, confirm that the Endpoint Version is showing as 20.200.001. or update it.
  • Above the Endpoint Name field, click Extend Endpoint.
    • NOTE: If not visible, click "..." and it should appear.


MYOBAD-default-ep.png MYOBAD-epver-eep.png

  • A box will appear for Extend Current Endpoint; some fields cannot be edited.
    • Base Endpoint Name: Default
    • Base Endpoint Version: 20.200.001
    • Endpoint Name: WagelochOnboarding (must be exact!)
    • Endpoint Version: 20.200.001
    • Click OK to finish


MYOBAD-extend-ep.png

Creating Endpoints under the "WagelochOnboarding" Endpoint

In the Web Service Endpoints screen, select the newly created endpoint WagelochOnboarding

The endpoints we need to create are:

  • EmployeeClasses
  • VelixoBranches
  • Departments
  • Calendar
  • Positions
  • VelixoExpenseAccounts
  • VelixoExpenseSubAccounts
  • CashAccounts
  • PayGroups


When creating the above endpoints, we'll be presented with a Create Entity box; the Object Name and the above endpoint names need to match.


EmployeeClasses Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type EmployeeClasses into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type EP2020PL into the Search box up the top right.
  • Double click EmployeeClasses with the Screen ID: EP.20.20.PL or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-empclass-ep.png MYOBAD-save-EP.png


VelixoBranches Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type VelixoBranches into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type VE500020 into the Search box up the top right.
  • Double click VelixoReportsPro-Branches with the Screen ID: VE.50.00.20 or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-velixobranch-ep.png MYOBAD-save-EP.png


Departments Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type Departments into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type EP201500 into the Search box up the top right.
  • Double click Departments with the Screen ID: EP.20.15.00 or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-dept-ep.png MYOBAD-save-EP.png


Calendar Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type Calendar into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type CS2090PL into the Search box up the top right.
  • Double click Work Calendar with the Screen ID: EP.20.90.PL or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-workcal-ep.png MYOBAD-save-EP.png

Positions Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type EmployeeClasses into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type EP201000 into the Search box up the top right.
  • Double click Positions with the Screen ID: EP.20.10.00 or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-position-ep.png MYOBAD-save-EP.png


VelixoExpenseAccounts Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type VelixoExpenseAccounts into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type VE500015 into the Search box up the top right.
  • Double click VelixoReportsPro-Accounts with the Screen ID: VE.50.00.15 or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-velixoacct-ep.png MYOBAD-save-EP.png


VelixoExpenseSubAccounts Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type VelixoReportsPro-Subaccounts into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type VE500090 into the Search box up the top right.
  • Double click VelixoReportsPro-Subaccounts with the Screen ID: VE.50.00.90 or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-velixosubacct-ep.png MYOBAD-save-EP.png

CashAccounts Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type CashAccounts into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type CA202000 into the Search box up the top right.
  • Double click CashAccounts with the Screen ID: CA.20.20.00 or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-cash-ep.png MYOBAD-save-EP.png


PayGroups Endpoint

  • Select the ENDPOINT heading in the list
  • Click the +INSERT button above.


MYOBAD-add-ep.png

  • You'll now see the Create Entity box.
  • Type PayGroups into the Object Name
  • Click the magnifying glass next to Screen Name.


MYOBAD-ep-insert.png

  • Type MPPP2710 into the Search box up the top right.
  • Double click PayGroups with the Screen ID: MP.PP.27.10 or use the Select button.
  • Wait for ScreenID to populate and click OK to get back to your endpoint menu.
  • Ensure you hit the Save icon up the top of the screen after every Endpoint creation to prevent loss of data.


MYOBAD-paygroup-ep.png MYOBAD-save-EP.png