Sync Bank Transactions from Xero

POST 
/api/xero/bank-transactions/download

Dispatch a tracked background sync that pulls bank transactions from Xero's BankTransactions API into the local cache (paged 100/request, upserted by BankTransactionID).

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Authentication: Requires Bearer token.

Body (all optional, nullable dates Y-m-d):

• date_from — only transactions dated on/after (builds the Xero OData Date >= DateTime(...) filter)
• date_to — only transactions dated on/before
• modified_after — incremental: only records changed since (If-Modified-Since)

All null = full pull. Returns the tracked-job id so the UI can follow progress via the tracked job log endpoints.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.