Skip to content
Bottle

Confirm which Xero organisation to connect before syncing

POST
/xero/selection
curl --request POST \
  --url https://example.com/xero/selection \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "organisationId": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
organisationId
required
string
>= 1 characters <= 100 characters

Example generated

{
  "organisationId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The confirmed 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
rentAccountCode
required
string | null
depositAccountCode
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
retryAt
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”

Sign in first

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

An owner or admin session is required

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

The selection expired, is invalid, or another organisation is connected

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

Choose an organisation

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

Section titled “503”

Xero is not configured

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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