This guide provides step-by-step instructions on how to set up the Xero API Integration credentials and transfer payroll/remittance data directly from Venus to Xero.
Xero Developer Portal Setup (One-Time Setup)
To connect Venus with Xero, an authorized administrator must generate API credentials and configure permission scopes in the Xero Developer Portal.
1: Log in to Xero Developer Portal
Open your web browser and go to the Xero Developer Portal.
Click Log in at the top right and log in with your company's Xero administrator or adviser account.
2: Create a New Application (App)
Navigate to the My Apps menu at the top right corner.
Click the New app button.
-
On the "Add a new Xero app" screen, configure the fields exactly as follows:
App name: Venus Payroll Integration
Integration type: Select Custom connection (Crucial: This enables the 'client_credentials' grant type used by Venus)
AI Usage: Select No
Security Requirements: Select Yes
Company or application URL: Enter your company’s website URL
Check the box to agree to the Terms & Conditions and click Create app.
3: Email Invitation & Initial Authorization
Upon clicking 'Create app', Xero will restrict immediate access and automatically send an authorization request email to the registered email address of the Xero account subscriber.
-
The administrator must open their email inbox, find the message from Xero (Subject: "Xero Custom Connection authorization request"), and click the Connect button inside the email.
4: Select Organization & Confirm Connection
Clicking the Connect button in the email will open a web browser.
Under the "Select an organization" dropdown, select the correct company profile/organization to which you want to transfer Venus payroll data.
Click the Connect button at the bottom right to finalize the link.
5: Select Required Scopes & Generate Credentials
Once the connection is approved via email, return to the Xero Developer Portal and navigate to the Configuration tab on the left-hand menu.
-
In the Scopes section, ensure the following permissions are strictly checked:
accounting.contacts (Required to map payroll/subcontractor contacts)
accounting.invoices (Crucial: Required to create Bills/ACCPAY in Xero)
accounting.settings.read (Required to read organization configuration)
-
Copy your Client ID & Client Secret displayed on the screen.
* CRITICAL WARNING: The Client Secret is visible ONLY ONCE immediately after generation. If you refresh or close the page, it will be hidden permanently. Copy and store it securely right away.