Skip to main content

Perform an API call in Xero

Perform an API call in Xero.

API doc: https://developer.xero.com/documentation/api/accounting/overview

Application

  • Xero

Inputs (what you have)

NameDescriptionData TypeRequired?Example
EndpointThe URL of the API endpoint to accessText (Long)Yes
MethodThe HTTP method to be used for the requestText (Short)Yes
Request headersAdditional headers to include in the request in JSON formatText (Long)No
Request bodyThe data to be included in the request bodyText (Long)No
FileA file to be included in the requestFileNo
Output response as a file?Select this as true when your API call returns a file as an outputTrue/FalseNo
Tenant nameThe name of your Xero account. If blank, it will choose the first connection.Text (Short)NoWrk

Outputs (what you get)

NameDescriptionData TypeRequired?Example
Response status codeThe HTTP status code returned in the responseNumberNo
Response headersAdditional information provided in the response headersText (Long)No
Response bodyThe main content of the responseText (Long)No
FileFileNo

Outcomes

NameDescription
SuccessThis status is selected if the job has successfully completed.
UnsuccessfulThis status is selected if the job has completed unsuccessfully.
Impossible to CompleteThis status is selected if the job has encountered an error and has not completed.

Requirements

  • N/A