Deep links enable an external application to create a link that directs the user to a specific resource within a specific Xero Organisation. They provide a high quality user experience for customers that are using both Xero and a connected app and need to jump between the two applications in order to complete certain tasks or view certain data.
By using the Organisation ShortCode, you can construct a deep link to a resource in Xero that will reference the correct Xero Organisation, for example:
https://go.xero.com/organisationlogin/default.aspx?shortcode=!NLglS&redirecturl=/Contacts/View.aspx?contactID=3E776C4B-EA9E-4BB1-96BE-6B0C7A71A37F
The ShortCode for a Xero Organisation can be retrieved from the Organisation endpoint.
Note: We suggest using the new UI view. The old UI view is included for legacy reasons and will be redirected to the new UI view at a later stage.
Useful for directing a user to where they can disconnect an integration from within Xero.
Invoices & Bills have an additional feature that enables a link to be created to an external product or source document.
For integrations that create Invoices & Bills this feature enables a two way linkage between the Xero & 3rd party applications.
The Invoice
PUT/POST /Invoice
<Invoices>
<Invoice>
<Type>ACCREC</Type>
<Contact>
<Name>Martin Hudson</Name>
</Contact>
<Date>2017-07-24T00:00:00</Date>
<DueDate>2017-07-31T00:00:00</DueDate>
<LineAmountTypes>Exclusive</LineAmountTypes>
<Url>https://MyAppPortal.xero/Invoice/XYZ123</Url>
<LineItems>
<LineItem>
<Description>Monthly rental for property at 56a Wilkins Avenue</Description>
<Quantity>4.3400</Quantity>
<UnitAmount>395.00</UnitAmount>
<AccountCode>200</AccountCode>
</LineItem>
</LineItems>
</Invoice>
</Invoices>