{"openapi":"3.1.0","info":{"title":"LinqLedger \u2014 Integration API","version":"1.0.0","summary":"Public, machine-to-machine API for pushing transactions into and pulling data from QuickBooks Online via the platform.","description":"The Integration API is the supported, versioned surface external systems (POS, e-commerce, ERP, expense apps) use to integrate with QuickBooks through the platform.\n\n- **Auth:** `Authorization: Bearer <api_key>` (issue keys in the admin console).\n- **Idempotency:** every write accepts an `Idempotency-Key` header. Replays are safe.\n- **External IDs:** every entity carries an integrator-controlled `external_id`. The platform persists `external_id \u2194 qb_id` mappings so you never need to track QB ids.\n- **Async writes:** `POST \/ingest\/{entity}` returns `202` with a tracking id; poll `\/ingest\/events\/{id}` for status.\n- **Outbound webhooks:** subscribe to `<entity>.synced`, `<entity>.failed`, `<entity>.updated_in_qb`, etc. \u2014 admin console.\n","contact":{"name":"Support","email":"support@linqledger.com"},"license":{"name":"Proprietary"}},"servers":[{"url":"https:\/\/api.linqledger.com\/api\/v1","description":"Configured server"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Ingest","description":"Asynchronous writes (202 with event id)"},{"name":"Ingest events","description":"Track status, inspect failures, retry"},{"name":"Attachments","description":"Multipart receipt\/PDF uploads linked to transactions"},{"name":"Reads","description":"List & get for every entity, scoped to your client"},{"name":"Reference data","description":"Chart of accounts, classes, tax codes, currencies, etc."},{"name":"Reports","description":"All standard QuickBooks reports"},{"name":"Query","description":"QBO-SQL passthrough for advanced filtering"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API key (qb_<env>_<40 hex chars>)","description":"Issue keys in the admin console (`\/api\/admin\/api-keys`). Each key is bound to either a single client or the whole organization, and carries a list of scopes (e.g. `invoices:write`)."}},"schemas":{"Error":{"type":"object","required":["message"],"properties":{"message":{"type":"string","example":"Payload validation failed."},"errors":{"type":"object","description":"Field-keyed validation errors (only present on 422).","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"IngestEvent":{"type":"object","properties":{"id":{"type":"integer","example":12345},"organization_id":{"type":"integer"},"client_id":{"type":"integer"},"entity_type":{"type":"string","example":"invoice"},"external_id":{"type":["string","null"],"example":"POS-INV-100"},"idempotency_key":{"type":["string","null"]},"operation":{"type":"string","enum":["create","update","delete"]},"payload":{"type":"object"},"status":{"type":"string","enum":["received","queued","synced","failed","skipped"]},"qb_entity_id":{"type":["string","null"]},"error":{"type":["string","null"]},"retry_count":{"type":"integer"},"synced_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"IngestEventReceipt":{"type":"object","description":"Returned from POST\/PUT \/ingest\/{entity} \u2014 async receipt. Poll \/ingest\/events\/{event_id} for terminal status.","properties":{"event_id":{"type":"integer"},"status":{"type":"string","example":"queued"},"entity_type":{"type":"string"},"external_id":{"type":["string","null"]}}},"CursorMeta":{"type":"object","properties":{"limit":{"type":"integer","example":50},"next_cursor":{"type":["string","null"],"description":"Opaque cursor; pass back as `?cursor=` for the next page."},"has_more":{"type":"boolean"}}},"CursorPage":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"meta":{"$ref":"#\/components\/schemas\/CursorMeta"}}},"Attachment":{"type":"object","properties":{"id":{"type":"integer"},"external_id":{"type":"string"},"qb_attachable_id":{"type":["string","null"]},"attached_to_entity_type":{"type":["string","null"]},"attached_to_external_id":{"type":["string","null"]},"file_name":{"type":"string"},"mime_type":{"type":"string"},"size_bytes":{"type":"integer"},"status":{"type":"string","enum":["received","synced","failed"]},"synced_at":{"type":["string","null"],"format":"date-time"}}},"IngestCustomerRequest":{"type":"object","required":["external_id","DisplayName"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"CUSTOMER-001"},"DisplayName":{"type":"string"},"PrimaryEmailAddr":{"type":"array","items":{"type":"object"}},"CompanyName":{"type":"string"},"GivenName":{"type":"string"},"FamilyName":{"type":"string"}},"description":"Ingest payload for `customer`. Body fields mirror the QuickBooks Customer resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestInvoiceRequest":{"type":"object","required":["external_id","CustomerRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"INVOICE-001"},"CustomerRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}},"TxnDate":{"type":"string"},"DueDate":{"type":"string"},"CurrencyRef":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `invoice`. Body fields mirror the QuickBooks Invoice resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestSalesReceiptRequest":{"type":"object","required":["external_id","CustomerRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"SALES_RECEIPT-001"},"CustomerRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}},"TxnDate":{"type":"string"}},"description":"Ingest payload for `sales_receipt`. Body fields mirror the QuickBooks SalesReceipt resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestEstimateRequest":{"type":"object","required":["external_id","CustomerRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"ESTIMATE-001"},"CustomerRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `estimate`. Body fields mirror the QuickBooks Estimate resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestCreditMemoRequest":{"type":"object","required":["external_id","CustomerRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"CREDIT_MEMO-001"},"CustomerRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `credit_memo`. Body fields mirror the QuickBooks CreditMemo resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestRefundReceiptRequest":{"type":"object","required":["external_id","CustomerRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"REFUND_RECEIPT-001"},"CustomerRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `refund_receipt`. Body fields mirror the QuickBooks RefundReceipt resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestPaymentRequest":{"type":"object","required":["external_id","CustomerRef","TotalAmt"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"PAYMENT-001"},"CustomerRef":{"type":"array","items":{"type":"object"}},"TotalAmt":{"type":"number"},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `payment`. Body fields mirror the QuickBooks Payment resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestVendorRequest":{"type":"object","required":["external_id","DisplayName"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"VENDOR-001"},"DisplayName":{"type":"string"},"CompanyName":{"type":"string"},"PrimaryEmailAddr":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `vendor`. Body fields mirror the QuickBooks Vendor resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestBillRequest":{"type":"object","required":["external_id","VendorRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"BILL-001"},"VendorRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}},"TxnDate":{"type":"string"},"DueDate":{"type":"string"}},"description":"Ingest payload for `bill`. Body fields mirror the QuickBooks Bill resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestBillPaymentRequest":{"type":"object","required":["external_id","VendorRef","TotalAmt","PayType","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"BILL_PAYMENT-001"},"VendorRef":{"type":"array","items":{"type":"object"}},"TotalAmt":{"type":"number"},"PayType":{"type":"string"},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `bill_payment`. Body fields mirror the QuickBooks BillPayment resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestVendorCreditRequest":{"type":"object","required":["external_id","VendorRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"VENDOR_CREDIT-001"},"VendorRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `vendor_credit`. Body fields mirror the QuickBooks VendorCredit resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestPurchaseOrderRequest":{"type":"object","required":["external_id","VendorRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"PURCHASE_ORDER-001"},"VendorRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `purchase_order`. Body fields mirror the QuickBooks PurchaseOrder resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestPurchaseRequest":{"type":"object","required":["external_id","PaymentType","AccountRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"PURCHASE-001"},"PaymentType":{"type":"string"},"AccountRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}},"EntityRef":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `purchase`. Body fields mirror the QuickBooks Purchase resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestItemRequest":{"type":"object","required":["external_id","Name","Type"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"ITEM-001"},"Name":{"type":"string"},"Type":{"type":"string"},"UnitPrice":{"type":"number"},"IncomeAccountRef":{"type":"array","items":{"type":"object"}},"ExpenseAccountRef":{"type":"array","items":{"type":"object"}},"AssetAccountRef":{"type":"array","items":{"type":"object"}},"Sku":{"type":"string"},"Description":{"type":"string"}},"description":"Ingest payload for `item`. Body fields mirror the QuickBooks Item resource shape; the platform forwards them after applying field mappings and resolving external_ids."},"IngestInventoryAdjustmentRequest":{"type":"object","required":["external_id","AdjustAccountRef","Line"],"properties":{"external_id":{"type":"string","maxLength":128,"description":"Caller-controlled stable id. First write creates a mapping; subsequent writes update.","example":"INVENTORY_ADJUSTMENT-001"},"AdjustAccountRef":{"type":"array","items":{"type":"object"}},"Line":{"type":"array","items":{"type":"object"}}},"description":"Ingest payload for `inventory_adjustment`. Body fields mirror the QuickBooks InventoryAdjustment resource shape; the platform forwards them after applying field mappings and resolving external_ids."}},"responses":{"UnauthorizedError":{"description":"Missing or invalid API key.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"ForbiddenError":{"description":"API key lacks the required scope.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"NotFoundError":{"description":"Resource not found.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"ValidationError":{"description":"Payload validation failed.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"ConflictError":{"description":"Idempotency-Key reused with a different payload, or operation conflicts with current state.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"RateLimitError":{"description":"Per-tenant rate limit exceeded.","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait before retrying."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"parameters":{"IdempotencyKey":{"name":"Idempotency-Key","in":"header","required":false,"description":"Caller-supplied key; replays return the cached response with `Idempotent-Replay: true`.","schema":{"type":"string","maxLength":128}},"XClientId":{"name":"X-Client-Id","in":"header","required":false,"description":"Required when the API key is org-wide rather than client-bound.","schema":{"type":"integer"}},"CursorParam":{"name":"cursor","in":"query","required":false,"schema":{"type":"string"},"description":"Opaque cursor from a previous `meta.next_cursor`."},"LimitParam":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},"ModifiedSinceParam":{"name":"modifiedSince","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"ISO 8601 timestamp; returns only entities whose `MetaData.LastUpdatedTime` is after this."},"ClientIdQueryParam":{"name":"client_id","in":"query","required":false,"schema":{"type":"integer"},"description":"Required when the API key is org-wide."}}},"paths":{"\/accounts":{"get":{"tags":["Reference data"],"summary":"Read `accounts` reference data","operationId":"listAccountsReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"accounts:read"}},"\/attachments\/{id}":{"get":{"tags":["Attachments"],"summary":"Get attachment status","operationId":"getAttachment","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Attachment"}}}}}}},"x-required-scope":"attachments:read"}},"\/bill":{"get":{"tags":["Reads"],"summary":"List `bill` records","operationId":"listBill","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"bills:read"}},"\/bill\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `bill` by external_id","operationId":"getBill","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"bills:read"}},"\/bill_payment":{"get":{"tags":["Reads"],"summary":"List `bill_payment` records","operationId":"listBillPayment","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"bill_payments:read"}},"\/bill_payment\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `bill_payment` by external_id","operationId":"getBillPayment","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"bill_payments:read"}},"\/classes":{"get":{"tags":["Reference data"],"summary":"Read `classes` reference data","operationId":"listClassesReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"classes:read"}},"\/company-info":{"get":{"tags":["Reference data"],"summary":"Read `company-info` reference data","operationId":"listCompanyInfoReference","parameters":[{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"company_info:read"}},"\/credit_memo":{"get":{"tags":["Reads"],"summary":"List `credit_memo` records","operationId":"listCreditMemo","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"credit_memos:read"}},"\/credit_memo\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `credit_memo` by external_id","operationId":"getCreditMemo","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"credit_memos:read"}},"\/currencies":{"get":{"tags":["Reference data"],"summary":"Read `currencies` reference data","operationId":"listCurrenciesReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"currencies:read"}},"\/customer":{"get":{"tags":["Reads"],"summary":"List `customer` records","operationId":"listCustomer","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"customers:read"}},"\/customer\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `customer` by external_id","operationId":"getCustomer","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"customers:read"}},"\/departments":{"get":{"tags":["Reference data"],"summary":"Read `departments` reference data","operationId":"listDepartmentsReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"departments:read"}},"\/estimate":{"get":{"tags":["Reads"],"summary":"List `estimate` records","operationId":"listEstimate","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"estimates:read"}},"\/estimate\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `estimate` by external_id","operationId":"getEstimate","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"estimates:read"}},"\/exchange-rates":{"get":{"tags":["Reference data"],"summary":"Read `exchange-rates` reference data","operationId":"listExchangeRatesReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"exchange_rates:read"}},"\/ingest\/attachments":{"post":{"tags":["Attachments"],"summary":"Upload a file attachment (multipart)","operationId":"ingestAttachment","requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"type":"object","required":["file","external_id"],"properties":{"file":{"type":"string","format":"binary"},"external_id":{"type":"string"},"attached_to_entity_type":{"type":"string"},"attached_to_external_id":{"type":"string"}}}}}},"responses":{"202":{"description":"Accepted; uploading to QuickBooks asynchronously."},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"attachments:write"}},"\/ingest\/bill":{"post":{"tags":["Ingest"],"summary":"Ingest a `bill` (create)","operationId":"ingestBill","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestBillRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"bills:write"}},"\/ingest\/bill\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `bill` by external_id","operationId":"upsertBill","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestBillRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"bills:write"}},"\/ingest\/bill_payment":{"post":{"tags":["Ingest"],"summary":"Ingest a `bill_payment` (create)","operationId":"ingestBillPayment","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestBillPaymentRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"bill_payments:write"}},"\/ingest\/bill_payment\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `bill_payment` by external_id","operationId":"upsertBillPayment","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestBillPaymentRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"bill_payments:write"}},"\/ingest\/credit_memo":{"post":{"tags":["Ingest"],"summary":"Ingest a `credit_memo` (create)","operationId":"ingestCreditMemo","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestCreditMemoRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"credit_memos:write"}},"\/ingest\/credit_memo\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `credit_memo` by external_id","operationId":"upsertCreditMemo","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestCreditMemoRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"credit_memos:write"}},"\/ingest\/customer":{"post":{"tags":["Ingest"],"summary":"Ingest a `customer` (create)","operationId":"ingestCustomer","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestCustomerRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"customers:write"}},"\/ingest\/customer\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `customer` by external_id","operationId":"upsertCustomer","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestCustomerRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"customers:write"}},"\/ingest\/estimate":{"post":{"tags":["Ingest"],"summary":"Ingest a `estimate` (create)","operationId":"ingestEstimate","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEstimateRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"estimates:write"}},"\/ingest\/estimate\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `estimate` by external_id","operationId":"upsertEstimate","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEstimateRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"estimates:write"}},"\/ingest\/events":{"get":{"tags":["Ingest events"],"summary":"List ingest events","operationId":"listIngestEvents","parameters":[{"name":"status","in":"query","schema":{"type":"string","enum":["received","queued","synced","failed","skipped"]}},{"name":"entity","in":"query","schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"}],"responses":{"200":{"description":"OK."}}}},"\/ingest\/events\/{id}":{"get":{"tags":["Ingest events"],"summary":"Get an ingest event","operationId":"getIngestEvent","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/IngestEvent"}}}}}},"404":{"$ref":"#\/components\/responses\/NotFoundError"}}}},"\/ingest\/events\/{id}\/retry":{"post":{"tags":["Ingest events"],"summary":"Retry a failed ingest event","operationId":"retryIngestEvent","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"202":{"description":"Retry dispatched."},"409":{"description":"Event already synced."}}}},"\/ingest\/inventory_adjustment":{"post":{"tags":["Ingest"],"summary":"Ingest a `inventory_adjustment` (create)","operationId":"ingestInventoryAdjustment","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestInventoryAdjustmentRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"inventory_adjustments:write"}},"\/ingest\/inventory_adjustment\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `inventory_adjustment` by external_id","operationId":"upsertInventoryAdjustment","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestInventoryAdjustmentRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"inventory_adjustments:write"}},"\/ingest\/invoice":{"post":{"tags":["Ingest"],"summary":"Ingest a `invoice` (create)","operationId":"ingestInvoice","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestInvoiceRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"invoices:write"}},"\/ingest\/invoice\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `invoice` by external_id","operationId":"upsertInvoice","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestInvoiceRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"invoices:write"}},"\/ingest\/item":{"post":{"tags":["Ingest"],"summary":"Ingest a `item` (create)","operationId":"ingestItem","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestItemRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"items:write"}},"\/ingest\/item\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `item` by external_id","operationId":"upsertItem","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestItemRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"items:write"}},"\/ingest\/payment":{"post":{"tags":["Ingest"],"summary":"Ingest a `payment` (create)","operationId":"ingestPayment","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestPaymentRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"payments:write"}},"\/ingest\/payment\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `payment` by external_id","operationId":"upsertPayment","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestPaymentRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"payments:write"}},"\/ingest\/purchase":{"post":{"tags":["Ingest"],"summary":"Ingest a `purchase` (create)","operationId":"ingestPurchase","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestPurchaseRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"purchases:write"}},"\/ingest\/purchase\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `purchase` by external_id","operationId":"upsertPurchase","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestPurchaseRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"purchases:write"}},"\/ingest\/purchase_order":{"post":{"tags":["Ingest"],"summary":"Ingest a `purchase_order` (create)","operationId":"ingestPurchaseOrder","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestPurchaseOrderRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"purchase_orders:write"}},"\/ingest\/purchase_order\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `purchase_order` by external_id","operationId":"upsertPurchaseOrder","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestPurchaseOrderRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"purchase_orders:write"}},"\/ingest\/refund_receipt":{"post":{"tags":["Ingest"],"summary":"Ingest a `refund_receipt` (create)","operationId":"ingestRefundReceipt","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestRefundReceiptRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"refund_receipts:write"}},"\/ingest\/refund_receipt\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `refund_receipt` by external_id","operationId":"upsertRefundReceipt","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestRefundReceiptRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"refund_receipts:write"}},"\/ingest\/sales_receipt":{"post":{"tags":["Ingest"],"summary":"Ingest a `sales_receipt` (create)","operationId":"ingestSalesReceipt","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestSalesReceiptRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"sales_receipts:write"}},"\/ingest\/sales_receipt\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `sales_receipt` by external_id","operationId":"upsertSalesReceipt","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestSalesReceiptRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"sales_receipts:write"}},"\/ingest\/vendor":{"post":{"tags":["Ingest"],"summary":"Ingest a `vendor` (create)","operationId":"ingestVendor","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestVendorRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"vendors:write"}},"\/ingest\/vendor\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `vendor` by external_id","operationId":"upsertVendor","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestVendorRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"vendors:write"}},"\/ingest\/vendor_credit":{"post":{"tags":["Ingest"],"summary":"Ingest a `vendor_credit` (create)","operationId":"ingestVendorCredit","parameters":[{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"},{"$ref":"#\/components\/parameters\/XClientId"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestVendorCreditRequest"}}}},"responses":{"202":{"description":"Accepted; processing asynchronously.","headers":{"Location":{"schema":{"type":"string"},"description":"URL to poll for status."}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"},"409":{"$ref":"#\/components\/responses\/ConflictError"},"429":{"$ref":"#\/components\/responses\/RateLimitError"}},"security":[{"bearerAuth":[]}],"x-required-scope":"vendor_credits:write"}},"\/ingest\/vendor_credit\/{external_id}":{"put":{"tags":["Ingest"],"summary":"Upsert a `vendor_credit` by external_id","operationId":"upsertVendorCredit","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/IdempotencyKey"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestVendorCreditRequest"}}}},"responses":{"202":{"description":"Accepted.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IngestEventReceipt"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"vendor_credits:write"}},"\/inventory_adjustment":{"get":{"tags":["Reads"],"summary":"List `inventory_adjustment` records","operationId":"listInventoryAdjustment","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"inventory_adjustments:read"}},"\/inventory_adjustment\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `inventory_adjustment` by external_id","operationId":"getInventoryAdjustment","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"inventory_adjustments:read"}},"\/invoice":{"get":{"tags":["Reads"],"summary":"List `invoice` records","operationId":"listInvoice","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"invoices:read"}},"\/invoice\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `invoice` by external_id","operationId":"getInvoice","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"invoices:read"}},"\/item":{"get":{"tags":["Reads"],"summary":"List `item` records","operationId":"listItem","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"items:read"}},"\/item\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `item` by external_id","operationId":"getItem","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"items:read"}},"\/payment":{"get":{"tags":["Reads"],"summary":"List `payment` records","operationId":"listPayment","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"payments:read"}},"\/payment-methods":{"get":{"tags":["Reference data"],"summary":"Read `payment-methods` reference data","operationId":"listPaymentMethodsReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"payment_methods:read"}},"\/payment\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `payment` by external_id","operationId":"getPayment","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"payments:read"}},"\/preferences":{"get":{"tags":["Reference data"],"summary":"Read `preferences` reference data","operationId":"listPreferencesReference","parameters":[{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"preferences:read"}},"\/purchase":{"get":{"tags":["Reads"],"summary":"List `purchase` records","operationId":"listPurchase","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"purchases:read"}},"\/purchase\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `purchase` by external_id","operationId":"getPurchase","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"purchases:read"}},"\/purchase_order":{"get":{"tags":["Reads"],"summary":"List `purchase_order` records","operationId":"listPurchaseOrder","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"purchase_orders:read"}},"\/purchase_order\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `purchase_order` by external_id","operationId":"getPurchaseOrder","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"purchase_orders:read"}},"\/query":{"get":{"tags":["Query"],"summary":"QBO-SQL passthrough","description":"Execute a QuickBooks Query Language SELECT against your client realm. SELECT-only, no semicolons, hard cap of MAXRESULTS 1000.","operationId":"runQuery","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","maxLength":4000},"example":"SELECT * FROM Invoice WHERE TotalAmt > '100'"},{"name":"refresh","in":"query","schema":{"type":"boolean"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"Query result."},"422":{"$ref":"#\/components\/responses\/ValidationError"}},"x-required-scope":"query:read"}},"\/refund_receipt":{"get":{"tags":["Reads"],"summary":"List `refund_receipt` records","operationId":"listRefundReceipt","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"refund_receipts:read"}},"\/refund_receipt\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `refund_receipt` by external_id","operationId":"getRefundReceipt","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"refund_receipts:read"}},"\/reports":{"get":{"tags":["Reports"],"summary":"List supported report names","operationId":"listReports","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"type":"object","properties":{"reports":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"string"}}}}}}}}}},"\/reports\/{report_name}":{"get":{"tags":["Reports"],"summary":"Run a QuickBooks report","operationId":"getReport","parameters":[{"name":"report_name","in":"path","required":true,"schema":{"type":"string","enum":["profit-and-loss","profit-and-loss-detail","balance-sheet","balance-sheet-detail","cash-flow","trial-balance","general-ledger","transaction-list","transaction-list-by-date","transaction-list-by-vendor","transaction-list-by-customer","transaction-detail-by-account","aged-receivables","aged-receivables-detail","aged-payables","aged-payables-detail","customer-balance","customer-balance-detail","vendor-balance","vendor-balance-detail","customer-income","vendor-expenses","sales-by-customer","sales-by-customer-detail","sales-by-product","sales-by-product-detail","sales-by-class","sales-by-class-detail","sales-by-location","sales-by-location-detail","inventory-valuation-summary","inventory-valuation-detail","expenses-by-vendor-summary","account-list","journal","taxable-sales-summary","taxable-sales-detail","transaction-list-with-splits"]}},{"name":"start_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","schema":{"type":"string","format":"date"}},{"name":"accounting_method","in":"query","schema":{"type":"string","enum":["Accrual","Cash"]}},{"name":"summarize_by","in":"query","schema":{"type":"string"}},{"name":"class_id","in":"query","schema":{"type":"string"}},{"name":"department_id","in":"query","schema":{"type":"string"}},{"name":"customer_id","in":"query","schema":{"type":"string"}},{"name":"vendor_id","in":"query","schema":{"type":"string"}},{"name":"item_id","in":"query","schema":{"type":"string"}},{"name":"refresh","in":"query","schema":{"type":"boolean"},"description":"Bust the 5-minute cache."},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"Report payload (shape varies by report)."},"404":{"description":"Unknown report name.","content":{"application\/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"available_reports":{"type":"array","items":{"type":"string"}}}}}}}},"x-required-scope":"reports:read"}},"\/sales_receipt":{"get":{"tags":["Reads"],"summary":"List `sales_receipt` records","operationId":"listSalesReceipt","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"sales_receipts:read"}},"\/sales_receipt\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `sales_receipt` by external_id","operationId":"getSalesReceipt","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"sales_receipts:read"}},"\/tax-codes":{"get":{"tags":["Reference data"],"summary":"Read `tax-codes` reference data","operationId":"listTaxCodesReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"tax_codes:read"}},"\/tax-rates":{"get":{"tags":["Reference data"],"summary":"Read `tax-rates` reference data","operationId":"listTaxRatesReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"tax_rates:read"}},"\/terms":{"get":{"tags":["Reference data"],"summary":"Read `terms` reference data","operationId":"listTermsReference","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."}},"x-required-scope":"terms:read"}},"\/vendor":{"get":{"tags":["Reads"],"summary":"List `vendor` records","operationId":"listVendor","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"vendors:read"}},"\/vendor\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `vendor` by external_id","operationId":"getVendor","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"vendors:read"}},"\/vendor_credit":{"get":{"tags":["Reads"],"summary":"List `vendor_credit` records","operationId":"listVendorCredit","parameters":[{"$ref":"#\/components\/parameters\/CursorParam"},{"$ref":"#\/components\/parameters\/LimitParam"},{"$ref":"#\/components\/parameters\/ModifiedSinceParam"},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CursorPage"}}}},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"},"409":{"description":"Client is not connected to QuickBooks."}},"x-required-scope":"vendor_credits:read"}},"\/vendor_credit\/{external_id}":{"get":{"tags":["Reads"],"summary":"Get a single `vendor_credit` by external_id","operationId":"getVendorCredit","parameters":[{"name":"external_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#\/components\/parameters\/ClientIdQueryParam"}],"responses":{"200":{"description":"OK."},"404":{"description":"No mapping exists for this external_id."},"401":{"$ref":"#\/components\/responses\/UnauthorizedError"},"403":{"$ref":"#\/components\/responses\/ForbiddenError"}},"x-required-scope":"vendor_credits:read"}}}}