View source for Xero Accounting Endpoint: GetImage

== Overview ==

The Xero '''GetImage''' [[Xero Accounting Endpoints|endpoint]] provides a method to download logos. It is restricted to only work for specific servers used by Xero.

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


== Parameters ==

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

;URL
:A [[Field Type: Text|text field]] that accepts the URL of where the image is located.
:Only the following servers are supported at this stage.
:* '''https://in.xero.com'''

== Fields ==

The following fields are available for the GetImage endpoint.

;URL
:A [[Field Type: Text|text field]] that provides the URL received as parameter.

;ImageType
:A [[Field Type: Text|text field]] that provides the type of image. It follows the MIME type convention.

;Image
:A [[Field Type: Text|text field]] that provides the image as a BASE64 encoded URI.


== Xero API ==

:None


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Accounting Endpoint: BrandingThemes|BrandingThemes]]


== Related Topics ==

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