Start connecting Xero

POST

/xero/connect

curl --request POST \
  --url https://example.com/xero/connect \
  --cookie bottle.session_token=<bottle.session_token>

Answers with the Xero page to send the browser to. Xero sends it back to /xero/callback, which finishes the connection and returns the browser to the accounting settings.

Authorizations

• sessionCookie
  accounting:write
• apiKey
  accounting:write

Responses

200

Where to go

Media typeapplication/json

object

url

required

string format: uri

Example^generated

{
  "url": "https://example.com"
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

Media typeapplication/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}

503

Xero is not configured on this installation

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}