Skip to content
Bottle

Where the business stands with Xero

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

Whether Xero is on for this installation, whether this business has connected an organisation, the accounts chosen, which jobs run, and what the last sync said.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The connection

Media typeapplication/json
object
status
required
string
Allowed values: off disconnected connected
orgName
required
string | null
connectedBy
required
string | null
salesAccountCode
required
string | null
cashAccountCode
required
string | null
cardAccountCode
required
string | null
transferAccountCode
required
string | null
pullCustomers
required
boolean
pushCustomers
required
boolean
pushInvoices
required
boolean
invoicesFrom
required
string | null format: date
pushOutstanding
required
boolean
pushEmails
required
boolean
xeroRemindersOn
required
boolean | null
ready
required
boolean
lastSyncAt
required
string | null format: date-time
lastError
required
string | null
linked
required
object
customers
required
integer
invoices
required
integer
Example
{
  "status": "off"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “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

Section titled “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"
    }
  ]
}