Skip to content
Bottle

Run the sync now

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

What the clock does every few minutes, on demand: pull customers from Xero, push customers to it, push invoices and payments. Running it twice sends nothing twice.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

What was done

Media typeapplication/json
object
customersPulled
required
integer
customersPushed
required
integer
invoicesPushed
required
integer
paymentsPulled
required
integer
paymentsPushed
required
integer
problems
required
Array<string>

Example generated

{
  "customersPulled": 1,
  "customersPushed": 1,
  "invoicesPushed": 1,
  "paymentsPulled": 1,
  "paymentsPushed": 1,
  "problems": [
    "example"
  ]
}

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"
}

404

Section titled “404”

Not connected

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"
    }
  ]
}

503

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