{"openapi":"3.1.0","info":{"title":"BankStatementXL API","description":"Convert bank and card statements to Excel, CSV, QuickBooks, Xero, Tally, OFX and more, with every row checked.\n\n**Errors.** Every error answers with `{\"error\": {\"code\": \"...\", \"message\": \"...\"}}` and the HTTP status that fits; some codes add fields (`param`, `details`, `banks`, `pages_left`...). Each route lists the codes it can answer with. Match on `code`, not `message`. `429` and `409 statement_not_ready` carry `Retry-After`.","version":"1.0.0"},"paths":{"/v1/health":{"get":{"tags":["Account"],"summary":"Is the API up? (no key needed)","operationId":"health_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/account":{"get":{"tags":["Account"],"summary":"Your workspace, page balance and limits","description":"balance.pages and balance.scans are what you can use now: your balance minus what your statements of the last day hold (converted and not yet downloaded, or still converting), the same figure an upload is checked against. held_pages and held_scans are what those statements hold; a download uses it, a deletion releases it.","operationId":"account_v1_account_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/export-templates":{"get":{"tags":["Account"],"summary":"Your workspace's export templates","description":"The column layouts your workspace saved in Settings → Export templates on the website (the Business plan). Download a statement in one with format=tpl_<id>: one more format of the same download, so it uses no extra pages.","operationId":"list_export_templates_v1_export_templates_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `templates_not_in_plan`: The workspace's plan doesn't include export templates (`format=tpl_...`; they come with the Business plan).\n- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/statements":{"post":{"tags":["Statements"],"summary":"Upload a statement to convert","description":"One PDF, TIFF, CSV, Excel or OFX file, or a statement's page photos (JPG, PNG, HEIC) in order. Returns at once with status \"queued\"; poll the statement until it is \"ready\". Nothing is charged until the first download.","operationId":"create_statement_v1_statements_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Send the same key to retry safely: a repeat returns the first statement","title":"Idempotency-Key"},"description":"Send the same key to retry safely: a repeat returns the first statement"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_create_statement_v1_statements_post"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"- `invalid_request`: A value in the request isn't valid; `details` names each one.\n- `missing_file`: No `file` field in the upload.\n- `too_many_files`: More page photos than the limit for one statement.\n- `one_statement_per_upload`: Several files that aren't one statement's page photos or TIFF pages.\n- `empty_file`: The file is empty.\n- `invalid_pages`: `pages` isn't like `1-3,5`.\n- `pages_out_of_range`: `pages` asks for a page the file doesn't have.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"- `insufficient_balance`: The balance doesn't cover the statement. Upload: `pages_needed`, `pages_left`. Download: also `scans_needed`, `scans_left`; nothing is charged or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"413":{"description":"- `file_too_large`: Over the upload size limit for one statement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"415":{"description":"- `unsupported_file_type`: Not a file type we read.\n- `not_a_pdf`: A .pdf file that isn't a PDF.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"- `too_many_pages`: More pages than the limit for one statement: convert it in parts with `pages`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `too_many_conversions`: Too many statements converting at once. Wait `Retry-After` seconds.\n- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"get":{"tags":["Statements"],"summary":"Your recent statements, newest first","operationId":"list_statements_v1_statements_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["queued","processing","ready","failed"],"type":"string"},{"type":"null"}],"title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"- `invalid_request`: A value in the request isn't valid; `details` names each one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/statements/{statement_id}":{"get":{"tags":["Statements"],"summary":"A statement: its status, and once ready, its pages and checks","operationId":"read_statement_v1_statements__statement_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"statement_id","in":"path","required":true,"schema":{"type":"string","title":"Statement Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"- `statement_not_found`: No statement with this ID in your workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"tags":["Statements"],"summary":"Delete a statement's files and results now","operationId":"delete_statement_v1_statements__statement_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"statement_id","in":"path","required":true,"schema":{"type":"string","title":"Statement Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"- `statement_not_found`: No statement with this ID in your workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/statements/{statement_id}/download":{"get":{"tags":["Statements"],"summary":"Download the converted statement","description":"One format returns its file; several (format=xlsx&format=csv, or format=xlsx,csv) return one ZIP. A statement with several accounts gives one file per account. The first download uses the statement's pages; later ones are free. Response headers: BSXL-Pages-Used, BSXL-Scans-Used, BSXL-Warnings (a JSON list).\n\nQBO and QFX: ask without intu_bid first and the answer (400 intu_bid_required) lists the statement's possible banks in banks; let your user choose theirs and ask again with its id as intu_bid. The first time for a bank, the answer is 409 bank_id_confirmation_required: record your user's confirmation (POST /v1/bank-id-confirmations), then download.\n\nExport templates (the Business plan): format=tpl_<id> gives your workspace's own column layout, saved in Settings → Export templates on the website (GET /v1/export-templates lists them). It is one more format of the same download: the same rows and the same pages.","operationId":"download_v1_statements__statement_id__download_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"statement_id","in":"path","required":true,"schema":{"type":"string","title":"Statement Id"}},{"name":"format","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"json, xlsx, csv, qbo-csv, xero, ofx, qbo-ofx, qbo, qfx, qif, iif, tally, sage, myob, netsuite, wave, zoho, freshbooks, or tpl_<id> (one of your export templates)","title":"Format"},"description":"json, xlsx, csv, qbo-csv, xero, ofx, qbo-ofx, qbo, qfx, qif, iif, tally, sage, myob, netsuite, wave, zoho, freshbooks, or tpl_<id> (one of your export templates)"},{"name":"date_format","in":"query","required":false,"schema":{"anyOf":[{"enum":["MM/DD/YYYY","DD/MM/YYYY","YYYY-MM-DD"],"type":"string"},{"type":"null"}],"title":"Date Format"}},{"name":"account_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["CHECKING","SAVINGS","CREDITCARD","CREDITLINE","MONEYMRKT"],"type":"string"},{"type":"null"}],"title":"Account Type"}},{"name":"currency","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[A-Za-z]{3}$"},{"type":"null"}],"title":"Currency"}},{"name":"intu_bid","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^\\d{1,10}$"},{"type":"null"}],"description":"QBO / QFX only: the bank's Intuit bank ID","title":"Intu Bid"},"description":"QBO / QFX only: the bank's Intuit bank ID"},{"name":"iif_account","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Iif Account"}},{"name":"iif_offset","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Iif Offset"}},{"name":"tally_bank","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Tally Bank"}},{"name":"tally_offset","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Tally Offset"}},{"name":"tally_cash","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Tally Cash"}},{"name":"tally_opening","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tally Opening"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"- `invalid_request`: A value in the request isn't valid; `details` names each one.\n- `unknown_format`: A `format` we don't make.\n- `intu_bid_required`: QBO or QFX without `intu_bid`. `banks` lists the statement's possible banks to choose from (empty: its bank isn't on Intuit's list, so use OFX or IIF).\n- `export_not_possible`: This statement can't be made into that format (the message says why).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"402":{"description":"- `insufficient_balance`: The balance doesn't cover the statement. Upload: `pages_needed`, `pages_left`. Download: also `scans_needed`, `scans_left`; nothing is charged or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `templates_not_in_plan`: The workspace's plan doesn't include export templates (`format=tpl_...`; they come with the Business plan).\n- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"- `statement_not_found`: No statement with this ID in your workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"- `statement_not_ready`: Still converting. Try again after `Retry-After` seconds.\n- `statement_failed`: The statement couldn't be converted; its `failure` says why.\n- `bank_id_confirmation_required`: Your user hasn't confirmed QBO / QFX files for this bank yet. Show them `notice`, get `confirmation`, then POST /v1/bank-id-confirmations. `bank` is the bank chosen.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"410":{"description":"- `statement_deleted`: Its results were deleted (after download, on request, or at expiry).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"- `bank_not_matched`: `intu_bid` isn't the Intuit ID of the bank named on the statement. `banks` lists its possible banks (empty: not on Intuit's list, so use OFX or IIF).\n- `nothing_to_export`: The statement has no transactions to export.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhook-endpoints":{"get":{"tags":["Webhooks"],"summary":"Your webhook addresses","description":"We POST a signed JSON event to each address when a statement you uploaded is ready (statement.ready) or has failed (statement.failed). Headers: BSXL-Event-Id (the same in every retry), BSXL-Event-Type, and BSXL-Signature: t=<Unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" keyed with the address's signing secret>. Answer with any 2xx. Otherwise we try again after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours. The event's data is the statement as GET /v1/statements/{id} shows it. Up to 20 addresses, https only.","operationId":"list_webhooks_v1_webhook_endpoints_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Webhooks"],"summary":"Add an address for events","description":"We POST a signed JSON event to each address when a statement you uploaded is ready (statement.ready) or has failed (statement.failed). Headers: BSXL-Event-Id (the same in every retry), BSXL-Event-Type, and BSXL-Signature: t=<Unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" keyed with the address's signing secret>. Answer with any 2xx. Otherwise we try again after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours. The event's data is the statement as GET /v1/statements/{id} shows it. Up to 20 addresses, https only. The signing secret is in this answer only: keep it.","operationId":"add_webhook_v1_webhook_endpoints_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"- `invalid_request`: A value in the request isn't valid; `details` names each one.\n- `invalid_url`: Not an https:// address, or it holds a user name or password.\n- `url_not_public`: The address is on a private network.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"- `too_many_endpoints`: Already the most webhook addresses a workspace can have.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/webhook-endpoints/{endpoint_id}":{"delete":{"tags":["Webhooks"],"summary":"Remove an address (its waiting events stop too)","operationId":"remove_webhook_v1_webhook_endpoints__endpoint_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"- `webhook_endpoint_not_found`: No webhook address with this ID in your workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhook-endpoints/{endpoint_id}/test":{"post":{"tags":["Webhooks"],"summary":"Send a ping event to an address now","description":"A signed event of type \"ping\", sent once and not retried. delivered is true when the address answered with a 2xx; status is its HTTP status (0: no answer).","operationId":"test_webhook_v1_webhook_endpoints__endpoint_id__test_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","title":"Endpoint Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"- `webhook_endpoint_not_found`: No webhook address with this ID in your workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/bank-id-confirmations":{"get":{"tags":["QBO and QFX"],"summary":"Banks your workspace has confirmed","operationId":"list_bank_ids_v1_bank_id_confirmations_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["QBO and QFX"],"summary":"Record the user's confirmation for a bank, before its QBO or QFX files","description":"Show your user this notice and get their confirmation first.\n\nNotice: When you choose a QBO or QFX file, you confirm that (a) the statement is for an account you own or are authorized to manage, and (b) your bank has its own Intuit bank ID. You are responsible for checking the file before you import it and for how you use it. Back up your QuickBooks company file before importing, because the import writes straight into it. We keep a record of your confirmation.\n\nConfirmation: \"I confirm my bank has its own Intuit bank ID, and this statement is for an account I own or am authorized to manage.\"\n\nAsked once per bank.","operationId":"confirm_bank_id_v1_bank_id_confirmations_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankIdConfirmationIn"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"- `invalid_request`: A value in the request isn't valid; `details` names each one.\n- `confirmation_required`: `confirm` must be true: your user confirmed the notice.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"- `missing_api_key`: No `Authorization: Bearer` key.\n- `invalid_api_key`: The key isn't valid, or it was revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"- `api_not_in_plan`: The workspace's plan doesn't include the API (it comes with Pro and Business).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"- `rate_limited`: Too many requests. Wait `Retry-After` seconds.","headers":{"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"- `server_error`: Something went wrong on our side. Retry (uploads: with the same `Idempotency-Key`).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"BankChoice":{"properties":{"id":{"type":"string","title":"Id","description":"The bank's Intuit bank ID: pass it as `intu_bid`."},"name":{"type":"string","title":"Name"},"site":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},"type":"object","required":["id","name"],"title":"BankChoice"},"BankIdConfirmationIn":{"properties":{"intu_bid":{"type":"string","pattern":"^\\d{1,10}$","title":"Intu Bid","description":"The bank's Intuit bank ID (digits)."},"confirm":{"type":"boolean","title":"Confirm","description":"true: the user confirmed: \"I confirm my bank has its own Intuit bank ID, and this statement is for an account I own or am authorized to manage.\""}},"type":"object","required":["intu_bid","confirm"],"title":"BankIdConfirmationIn"},"Body_create_statement_v1_statements_post":{"properties":{"file":{"items":{"type":"string","contentMediaType":"application/octet-stream"},"type":"array","title":"File","description":"The statement file, or its page photos in order"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password","description":"The PDF's password, if it has one. Used for this conversion only and never stored."},"pages":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pages","description":"Convert only these pages, e.g. 1-3,5"},"date_order":{"anyOf":[{"type":"string","enum":["DMY","MDY"]},{"type":"null"}],"title":"Date Order","description":"CSV and Excel files: day-first or month-first dates, when the file could be either"},"delete_after_download":{"type":"boolean","title":"Delete After Download","description":"Delete the results right after the first download (default). false keeps them until they expire.","default":true},"filename":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Filename","description":"The file's name with its extension, e.g. march.pdf, for a single file sent without a usable name (some automation tools send none). Used only to tell the file type; never stored."}},"type":"object","required":["file"],"title":"Body_create_statement_v1_statements_post"},"ErrorDetail":{"properties":{"code":{"type":"string","title":"Code","description":"A stable code: see each route's answers. Within v1 we may add codes, so treat an unknown one by its HTTP status."},"message":{"type":"string","title":"Message","description":"What happened, in plain words (it may change; match on `code`)."},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param","description":"The request field to fix, when there is one."},"details":{"anyOf":[{"items":{"$ref":"#/components/schemas/Problem"},"type":"array"},{"type":"null"}],"title":"Details","description":"invalid_request: each value that isn't valid."},"pages_needed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pages Needed","description":"insufficient_balance"},"pages_left":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pages Left","description":"insufficient_balance"},"scans_needed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Scans Needed","description":"insufficient_balance, at download"},"scans_left":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Scans Left","description":"insufficient_balance, at download"},"banks":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankChoice"},"type":"array"},{"type":"null"}],"title":"Banks","description":"intu_bid_required, bank_not_matched: the banks the statement's bank may be, best first."},"bank":{"anyOf":[{"$ref":"#/components/schemas/BankChoice"},{"type":"null"}],"description":"bank_id_confirmation_required: the bank to confirm."},"notice":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notice","description":"bank_id_confirmation_required: show this to your user."},"confirmation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Confirmation","description":"bank_id_confirmation_required: what your user confirms."}},"additionalProperties":true,"type":"object","required":["code","message"],"title":"ErrorDetail"},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ErrorDetail"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every error answers with this shape, with the HTTP status that fits."},"Problem":{"properties":{"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param","description":"The field, e.g. `pages` or `body.url`."},"problem":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Problem","description":"What's wrong with it."}},"type":"object","title":"Problem"},"WebhookEndpointIn":{"properties":{"url":{"type":"string","maxLength":2000,"title":"Url","description":"An https:// address on the public internet that accepts POST."}},"type":"object","required":["url"],"title":"WebhookEndpointIn"}},"securitySchemes":{"HTTPBearer":{"type":"http","description":"Your API key: Authorization: Bearer bsxl_live_...","scheme":"bearer"}}}}