Nic: Created page with "== Overview == The Xero '''GetInvoiceUrl''' endpoint provides a method to retrieve a url that can be used to send to your customers so they can..."

2025-10-08T04:39:01Z

Created page with "== Overview == The Xero '''GetInvoiceUrl''' endpoint provides a method to retrieve a url that can be used to send to your customers so they can..."

New page

== Overview ==

The Xero '''GetInvoiceUrl''' [[Xero Accounting Endpoints|endpoint]] provides a method to retrieve a url that can be used to send to your customers so they can view the invoice as recorded within Xero. Note that it only supports customer invoices and not supplier invoices.

Two variations of this function exists.
* '''GetInvoiceUrl''' works for a single data file.
* '''GetInvoiceUrlDataFile''' is recommended when using the consolidation OData Feed.

This function requires a single call to Xero for a single transaction. As such, it should only be used for a few transactions otherwise Xero will quickly impose the [[OdataLink Error Code 9004: Xero imposed a limit of 5000 calls per day on this data file|5000 calls daily limit]].

It is a [[Function Endpoints|function]] that accepts a series of parameters.

== Parameters ==

The GetInvoiceUrl is a [[Function Endpoints|function]] that accepts the following parameters.

;DataFile ''(for GetInvoiceUrlDataFile only)''
:A [[Field Type: Text|text field]] that accepts the data file id, name or code.

;InvoiceID
:A [[Field Type: GUID|GUID field]] that accepts the id of the invoice.

== Fields ==

The following fields are available for the GetHistoryInvoice endpoint.

;DataFileID
:A [[Field Type: GUID|GUID field]] representing the internal id of the data file within OdataLink. This field can be used to link to the [[Endpoint: DataFiles|data files endpoints]].

;DataFileName
:A [[Field Type: Text|text field]] used as the data file name.

;DataFileCode
:A [[Field Type: Text|text field]] used as the data file code.

;InvoiceID
:A [[Field Type: GUID|guid field]] that provides the id of the invoice.

;OnlineInvoiceUrl
:A [[Field Type: Text|text field]] that provides the url to view the invoice.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/invoices#retrieving-the-online-invoice-url Xero API].

== Related Fields ==

:None

== Related Endpoints ==

:[[Xero Accounting Endpoint: Invoices|Invoices]] '''---''' [[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] '''---''' [[Xero Accounting Endpoint: InvoicesExpandedTable|InvoicesExpandedTable]]

== Related Topics ==

:[[Xero Accounting Models]]
:[[Xero Accounting Endpoints]]

Xero Accounting Endpoint: GetInvoiceUrl - Revision history

Nic: Created page with "== Overview == The Xero '''GetInvoiceUrl''' endpoint provides a method to retrieve a url that can be used to send to your customers so they can..."