Xero Accounting Endpoint: GetInvoiceUrl
Overview
The Xero GetInvoiceUrl 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 5000 calls daily limit.
It is a function that accepts a series of parameters.
Parameters
The GetInvoiceUrl is a function that accepts the following parameters.
- DataFile (for GetInvoiceUrlDataFile only)
- A text field that accepts the data file id, name or code.
- InvoiceID
- A GUID field that accepts the id of the invoice.
Fields
The following fields are available for the GetHistoryInvoice endpoint.
- DataFileID
- A GUID field representing the internal id of the data file within OdataLink. This field can be used to link to the data files endpoints.
- DataFileName
- A text field used as the data file name.
- DataFileCode
- A text field used as the data file code.
- InvoiceID
- A guid field that provides the id of the invoice.
- OnlineInvoiceUrl
- A text field that provides the url to view the invoice.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
- None
Related Endpoints