{"openapi":"3.1.0","info":{"title":"HelloLedger Public API","description":"Assistant API for Muse, ChatGPT, Claude, and Gemini (Bearer API key). GET /v1/guide explains which route answers which question. POST /ask-agent is the logged-in product assistant and does not accept this key. journals:write remains the developer daily-revenue scope. Developer keys can also write receivables by your own ids (customers:write, invoices:write, payments:write; see /developers/docs).","version":"1.0.0"},"servers":[{"url":"https://api.helloledger.ai"}],"paths":{"/v1/companies":{"get":{"tags":["Assistant API"],"summary":"List Companies For This Api Key","operationId":"list_companies","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DeveloperCompanyProfile"},"type":"array","title":"Response List Companies"}}}}},"security":[{"HTTPBasic":[]}]}},"/v1/companies/{company_id}":{"get":{"tags":["Assistant API"],"summary":"Get Company Profile","operationId":"get_company","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCompanyProfile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/chart-of-accounts":{"get":{"tags":["Assistant API"],"summary":"Read Chart Of Accounts (Alias)","operationId":"get_chart_of_accounts_alias","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperCOAAccount"},"title":"Response Get Chart Of Accounts Alias"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/coa":{"get":{"tags":["Assistant API"],"summary":"Read Chart Of Accounts","operationId":"get_chart_of_accounts","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperCOAAccount"},"title":"Response Get Chart Of Accounts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/accounts/search":{"get":{"tags":["Assistant API"],"summary":"Search Chart Of Accounts","operationId":"search_accounts","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"title":"Q"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperCOAAccount"},"title":"Response Search Accounts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/coa/summary":{"get":{"tags":["Assistant API"],"summary":"Coa Summary By Account Type","operationId":"get_coa_summary","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCOASummary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/trial-balance":{"get":{"tags":["Assistant API"],"summary":"Trial Balance","operationId":"get_trial_balance","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"as_of","in":"query","required":true,"schema":{"type":"string","description":"As-of date YYYY-MM-DD","title":"As Of"},"description":"As-of date YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/profit-and-loss":{"get":{"tags":["Assistant API"],"summary":"Profit And Loss","operationId":"get_profit_and_loss","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","description":"Start date YYYY-MM-DD","title":"From"},"description":"Start date YYYY-MM-DD"},{"name":"to","in":"query","required":true,"schema":{"type":"string","description":"End date YYYY-MM-DD","title":"To"},"description":"End date YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/balance-sheet":{"get":{"tags":["Assistant API"],"summary":"Balance Sheet","description":"Balance sheet as of a date.\n\nIncludes a computed Current Year Profit equity line when that profit is\nnot already posted. Use ``balance_check`` to see whether assets equal\nliabilities plus equity. Do not sum only the posted equity accounts.","operationId":"get_balance_sheet","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"as_of","in":"query","required":true,"schema":{"type":"string","description":"As-of date YYYY-MM-DD","title":"As Of"},"description":"As-of date YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/cash-flow":{"get":{"tags":["Assistant API"],"summary":"Cash Flow Statement","operationId":"get_cash_flow","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/net-income":{"get":{"tags":["Assistant API"],"summary":"Net Income","operationId":"get_net_income","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/kpis/dashboard":{"get":{"tags":["Assistant API"],"summary":"Financial Dashboard Kpis","description":"Lightweight KPI snapshot from balance sheet + P&L as of a date.","operationId":"get_kpi_dashboard","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"as_of","in":"query","required":true,"schema":{"type":"string","title":"As Of"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/transactions":{"get":{"tags":["Assistant API"],"summary":"List Transactions (Paginated)","operationId":"list_transactions","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","title":"To"}},{"name":"account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Q"}},{"name":"reviewed","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reviewed"}},{"name":"review_ready","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Ready"}},{"name":"excluded","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Excluded"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/transactions/summary":{"get":{"tags":["Assistant API"],"summary":"Transaction Summary Statistics","operationId":"get_transaction_summary","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/transactions/{txn_id}":{"get":{"tags":["Assistant API"],"summary":"Get One Transaction","operationId":"get_transaction","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"txn_id","in":"path","required":true,"schema":{"type":"string","title":"Txn Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperTransaction"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/journal-entries":{"get":{"tags":["Assistant API"],"summary":"List Journal Entries","operationId":"list_journal_entries","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Developer Write"],"summary":"Create A Journal Entry","operationId":"create_journal_entry","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperJournalEntryInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperJournalEntryRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/journal-entries/{je_id}":{"get":{"tags":["Assistant API"],"summary":"Get Journal Entry","operationId":"get_journal_entry","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"je_id","in":"path","required":true,"schema":{"type":"string","title":"Je Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperJournalEntry"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/general-ledger":{"get":{"tags":["Assistant API"],"summary":"General Ledger (Paginated)","operationId":"get_general_ledger","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","title":"To"}},{"name":"account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reconciliations/summary":{"get":{"tags":["Assistant API"],"summary":"Reconciliation Summary","description":"Bank and card coverage through as_of.\n\n``actionable`` accounts have activity and are not reconciled through that\ndate. ``inactive_or_zero`` are chart leftovers with no activity in the month.","operationId":"get_reconciliation_summary","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reconciliations":{"get":{"tags":["Assistant API"],"summary":"List Latest Reconciliations","operationId":"list_reconciliations","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Assistant API"],"summary":"Create Reconciliation From Statement Figures","description":"Create a bank or credit card reconciliation. The caller supplies statement dates and balances.","operationId":"create_reconciliation","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperReconciliationWrite"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reconciliations/{reconcile_id}":{"get":{"tags":["Assistant API"],"summary":"Get Reconciliation","operationId":"get_reconciliation","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"reconcile_id","in":"path","required":true,"schema":{"type":"string","title":"Reconcile Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Assistant API"],"summary":"Update An Unreconciled Reconciliation","operationId":"update_reconciliation","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"reconcile_id","in":"path","required":true,"schema":{"type":"string","title":"Reconcile Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperReconciliationWrite"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/exceptions":{"get":{"tags":["Assistant API"],"summary":"Open Exceptions / Anomalies","operationId":"list_exceptions","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","default":"open","title":"Status"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperExceptionItem"},"title":"Response List Exceptions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/linked-institutions":{"get":{"tags":["Assistant API"],"summary":"Linked Institutions (Db Status)","operationId":"list_linked_institutions","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperLinkedInstitution"},"title":"Response List Linked Institutions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/plaid-sync-status":{"get":{"tags":["Assistant API"],"summary":"Plaid Sync Status (Latest Per Account)","description":"One row per linked account: institution, account name, and last sync time.","operationId":"get_bank_sync_status","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperPlaidSyncStatus"},"title":"Response Get Bank Sync Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/bank-balances":{"get":{"tags":["Assistant API"],"summary":"Bank And Credit Card Balances","description":"Book balance plus the last Plaid balance stored when the account was linked.\n\nPlaid amounts are not refreshed on transaction sync. ``book_balance`` is\nthe HelloLedger balance.","operationId":"get_bank_balances","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeveloperBankBalance"},"title":"Response Get Bank Balances"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/journals/daily-revenue":{"put":{"tags":["Developer Write"],"summary":"Create Or Replace Daily Revenue","operationId":"put_daily_revenue","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperDailyRevenueRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperDailyRevenueResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/next-step":{"get":{"tags":["Assistant API"],"summary":"Suggested Next Bookkeeping Step","description":"Home-page next action: one ranked bookkeeping step.\n\nUse this for \"what should I do next?\", including when no month-end close\nhas been started. ``close-status`` is only the latest autoclose checklist\nand can stay on an old period. Snoozes are per user and are ignored for\nAPI keys.","operationId":"get_next_step","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/close-status":{"get":{"tags":["Assistant API"],"summary":"Latest Month-End Close Checklist","description":"Latest autoclose checklist.\n\n``stale`` is true when a run is still ``running`` and has not been\nupdated for 14 days. For the next bookkeeping action, use ``next-step``.","operationId":"get_close_status","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/equity-activity":{"get":{"tags":["Assistant API"],"summary":"Equity Account Activity","description":"Beginning, period movement, and ending balance for each equity account.\n\nNet income for the window is returned separately.\n``net_income_allocated`` is always false: profit is not split across\nowners. It does not mean profit was closed to retained earnings.","operationId":"get_equity_activity","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reports/hotel-pnl":{"get":{"tags":["Assistant API"],"summary":"Hotel Profit And Loss (Usali)","operationId":"get_hotel_pnl","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"as_of","in":"query","required":true,"schema":{"type":"string","title":"As Of"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reports/hotel-ttm":{"get":{"tags":["Assistant API"],"summary":"Hotel Trailing Twelve Month Operating Statement (Usali)","operationId":"get_hotel_ttm","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"as_of","in":"query","required":true,"schema":{"type":"string","title":"As Of"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reports/ar-aging":{"get":{"tags":["Assistant API"],"summary":"Accounts Receivable Aging","operationId":"get_ar_aging","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/invoices":{"get":{"tags":["Assistant API"],"summary":"List Invoices (Read Only)","description":"Customer invoices with balance due and days past due. from/to filter date_issued.","operationId":"list_invoices","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},{"name":"open_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Open Only"}},{"name":"overdue_only","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Overdue Only"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Developer Write"],"summary":"Create An Invoice","operationId":"create_invoice","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoiceCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/invoices/{invoice_id}":{"get":{"tags":["Assistant API"],"summary":"Get One Invoice With Lines And Payments (Read Only)","description":"Lines, totals, balance due, and the payments, credit memos and bank deposits applied.","operationId":"get_invoice","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Developer Write"],"summary":"Update An Invoice","operationId":"update_invoice","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoiceUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Developer Write"],"summary":"Delete A Draft Invoice","operationId":"delete_invoice","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-payments":{"get":{"tags":["Assistant API"],"summary":"List Customer Payments Received (Read Only)","description":"Payments received from customers and the invoices they were applied to. from/to filter payment_date.","operationId":"list_customer_payments","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-credits":{"get":{"tags":["Assistant API"],"summary":"List Customer Credit Memos (Read Only)","description":"Credit memos issued to customers and the invoices they were applied to. from/to filter credit_date.","operationId":"list_customer_credits","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/ready-to-review":{"get":{"tags":["Assistant API"],"summary":"Ready-To-Review Queue Summary","description":"Count of transactions waiting to be confirmed. Not the wider review_ready filter.","operationId":"get_ready_to_review_summary","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/ready-to-review/transactions":{"get":{"tags":["Assistant API"],"summary":"Ready-To-Review Transactions","operationId":"list_ready_to_review","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/ready-to-review/approve":{"post":{"tags":["Assistant API"],"summary":"Confirm Ready-To-Review Transactions","description":"Mark queued transactions reviewed and post them to the ledger.","operationId":"approve_ready_to_review","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperReadyToReviewApprove"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reconciliations/{reconcile_id}/transactions":{"get":{"tags":["Assistant API"],"summary":"Transactions In A Reconciliation Period","operationId":"list_reconciliation_transactions","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"reconcile_id","in":"path","required":true,"schema":{"type":"string","title":"Reconcile Id"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reconciliations/{reconcile_id}/validate":{"post":{"tags":["Assistant API"],"summary":"Explain A Reconciliation Difference","description":"Recalculate the difference and return action items. Does not mark the row reconciled.","operationId":"validate_reconciliation","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"reconcile_id","in":"path","required":true,"schema":{"type":"string","title":"Reconcile Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/guide":{"get":{"tags":["Assistant API"],"summary":"Assistant Usage Guide","description":"How to choose a /v1 route. Pass q for how-to help articles. Schemas are on /v1/openapi.json.","operationId":"get_assistant_guide","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"description":"Optional how-to question; adds matching help articles as help_results.","title":"Q"},"description":"Optional how-to question; adds matching help articles as help_results."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[]}},"/v1/help/search":{"get":{"tags":["Assistant API"],"summary":"Search Helloledger How-To Articles","description":"How to use HelloLedger: setup, screens, connecting banks or assistants, plans. Returns steps and limits.","operationId":"search_help_articles","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":200,"description":"The user's how-to question","title":"Q"},"description":"The user's how-to question"},{"name":"category","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Category"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":10,"minimum":1,"default":5,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/help/articles/{slug}":{"get":{"tags":["Assistant API"],"summary":"Get A Helloledger How-To Article","description":"Full how-to article by slug from search_help_articles.","operationId":"get_help_article","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/briefing":{"get":{"tags":["Assistant API"],"summary":"Briefings For Every Company On This Key","description":"Call on the user's first business message and for \"what's new\". One briefing per company: headline, up to 5 insights with severity, stats, and 3-5 suggested_actions to show as a numbered list.","operationId":"get_briefings_all_companies","security":[{"HTTPBasic":[]}],"parameters":[{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"last_week (default), this_week, or last_month","title":"Period"},"description":"last_week (default), this_week, or last_month"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/briefing":{"get":{"tags":["Assistant API"],"summary":"Briefing For One Company","description":"What is interesting this period for one company: headline, up to 5 insights (ACTION, WATCH, INFO), stats, and 3-5 suggested_actions. Insights the key cannot read are left out.","operationId":"get_briefing","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"period","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"last_week (default), this_week, or last_month","title":"Period"},"description":"last_week (default), this_week, or last_month"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/suggestions":{"get":{"tags":["Assistant API"],"summary":"Suggested Next Actions For A Topic","description":"3-5 one-line suggested actions for the current topic: questions, dashboards (with a recipe from the guide), or links into HelloLedger. Show them as a numbered list.","operationId":"get_suggestions","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Conversation topic: cash, revenue, expenses, receivables, reconciliation, review, hotel, or general (default)","title":"After"},"description":"Conversation topic: cash, revenue, expenses, receivables, reconciliation, review, hotel, or general (default)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/whoami":{"get":{"tags":["Developer API"],"summary":"Describe The Calling Api Key","operationId":"get_whoami","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperWhoAmI"}}}}},"security":[{"HTTPBasic":[]}]}},"/v1/companies/{company_id}/items":{"get":{"tags":["Developer API"],"summary":"List Products And Services","operationId":"list_items","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"active_only","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Active Only"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Q"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperItemList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customers/by-external-id/{external_id}":{"put":{"tags":["Developer Write"],"summary":"Create Or Update A Customer","operationId":"put_customer","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomer"}}}},"201":{"description":"Customer created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomer"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Developer API"],"summary":"Get A Customer By External Id","operationId":"get_customer","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomer"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/invoices/by-external-id/{external_id}":{"put":{"tags":["Developer Write"],"summary":"Create Or Replace An Invoice","operationId":"put_invoice","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoiceInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"201":{"description":"Invoice created and posted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Developer API"],"summary":"Get An Invoice By External Id","operationId":"get_invoice_by_external_id","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/invoices/by-external-id/{external_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void An Invoice","operationId":"void_invoice","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperInvoiceVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-payments/by-external-id/{external_id}":{"put":{"tags":["Developer Write"],"summary":"Record A Customer Payment","operationId":"put_customer_payment","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerPaymentInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerPayment"}}}},"201":{"description":"Payment recorded and applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerPayment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Developer API"],"summary":"Get A Customer Payment By External Id","operationId":"get_customer_payment","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerPayment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-payments/by-external-id/{external_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Customer Payment","operationId":"void_customer_payment","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperPaymentVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerPayment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-credits/by-external-id/{external_id}":{"put":{"tags":["Developer Write"],"summary":"Record A Customer Credit","operationId":"put_customer_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerCreditInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerCredit"}}}},"201":{"description":"Credit recorded and applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Developer API"],"summary":"Get A Customer Credit By External Id","operationId":"get_customer_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-credits/by-external-id/{external_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Customer Credit","operationId":"void_customer_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperCreditVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-refunds/by-external-id/{external_id}":{"put":{"tags":["Developer Write"],"summary":"Record A Customer Refund","operationId":"put_customer_refund","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerRefundInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerRefund"}}}},"201":{"description":"Refund recorded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerRefund"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Developer API"],"summary":"Get A Customer Refund By External Id","operationId":"get_customer_refund","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerRefund"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/customer-refunds/by-external-id/{external_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Customer Refund","operationId":"void_customer_refund","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperRefundVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCustomerRefund"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/payouts/by-external-id/{external_id}":{"put":{"tags":["Developer Write"],"summary":"Record A Processor Payout And Its Fees","operationId":"put_payout","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperPayoutInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperPayout"}}}},"201":{"description":"Payout recorded and fees posted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperPayout"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Developer API"],"summary":"Get A Payout By External Id","operationId":"get_payout","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperPayout"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/payouts/by-external-id/{external_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Payout","operationId":"void_payout","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","description":"Your id for this record (e.g. student or charge id).","title":"External Id"},"description":"Your id for this record (e.g. student or charge id)."}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperPayoutVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperPayout"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/vendors":{"get":{"tags":["Developer API"],"summary":"List Vendors","operationId":"list_vendors","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"description":"Name contains (case-insensitive).","title":"Q"},"description":"Name contains (case-insensitive)."},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(active|inactive|archived)$"},{"type":"null"}],"title":"Status"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Developer Write"],"summary":"Create A Vendor","operationId":"create_vendor","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendor"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/vendors/{vendor_id}":{"get":{"tags":["Developer API"],"summary":"Get A Vendor","operationId":"get_vendor","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"vendor_id","in":"path","required":true,"schema":{"type":"string","title":"Vendor Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendor"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Developer Write"],"summary":"Update A Vendor","operationId":"update_vendor","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"vendor_id","in":"path","required":true,"schema":{"type":"string","title":"Vendor Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendor"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/bills":{"get":{"tags":["Developer API"],"summary":"List Bills","operationId":"list_bills","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Status"}},{"name":"vendor_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Vendor Id"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBillList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Developer Write"],"summary":"Create A Bill","operationId":"create_bill","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBillInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBill"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/bills/{bill_id}":{"get":{"tags":["Developer API"],"summary":"Get A Bill","operationId":"get_bill","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"bill_id","in":"path","required":true,"schema":{"type":"string","title":"Bill Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBill"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Developer Write"],"summary":"Update A Bill","operationId":"update_bill","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"bill_id","in":"path","required":true,"schema":{"type":"string","title":"Bill Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBillUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBill"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Developer Write"],"summary":"Delete A Draft Bill","operationId":"delete_bill","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"bill_id","in":"path","required":true,"schema":{"type":"string","title":"Bill Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/bills/{bill_id}/post":{"post":{"tags":["Developer Write"],"summary":"Post A Draft Bill","operationId":"post_bill","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"bill_id","in":"path","required":true,"schema":{"type":"string","title":"Bill Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBill"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/bills/{bill_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Bill","operationId":"void_bill","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"bill_id","in":"path","required":true,"schema":{"type":"string","title":"Bill Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperBill"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/expenses":{"get":{"tags":["Developer API"],"summary":"List Expenses","operationId":"list_expenses","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Status"}},{"name":"vendor_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Vendor Id"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpenseList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Developer Write"],"summary":"Create A Company-Paid Expense","operationId":"create_expense","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpenseInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpense"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/expenses/{expense_id}":{"get":{"tags":["Developer API"],"summary":"Get An Expense","operationId":"get_expense","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"expense_id","in":"path","required":true,"schema":{"type":"string","title":"Expense Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpense"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Developer Write"],"summary":"Update An Expense","operationId":"update_expense","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"expense_id","in":"path","required":true,"schema":{"type":"string","title":"Expense Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpenseUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpense"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Developer Write"],"summary":"Delete A Draft Expense","operationId":"delete_expense","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"expense_id","in":"path","required":true,"schema":{"type":"string","title":"Expense Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/expenses/{expense_id}/post":{"post":{"tags":["Developer Write"],"summary":"Post A Draft Expense","operationId":"post_expense","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"expense_id","in":"path","required":true,"schema":{"type":"string","title":"Expense Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpense"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/expenses/{expense_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void An Expense","operationId":"void_expense","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"expense_id","in":"path","required":true,"schema":{"type":"string","title":"Expense Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperExpense"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/journal-entries/{journal_id}":{"patch":{"tags":["Developer Write"],"summary":"Update A Journal Entry","operationId":"update_journal_entry","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"journal_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperJournalEntryUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperJournalEntryRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Developer Write"],"summary":"Delete A Draft Journal Entry","operationId":"delete_journal_entry","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"journal_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/journal-entries/{journal_id}/post":{"post":{"tags":["Developer Write"],"summary":"Post A Draft Journal Entry","operationId":"post_journal_entry","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"journal_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperJournalEntryRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/journal-entries/{journal_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Journal Entry","operationId":"void_journal_entry","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"journal_id","in":"path","required":true,"schema":{"type":"string","title":"Journal Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperJournalEntryRecord"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/invoices/{invoice_id}/post":{"post":{"tags":["Developer Write"],"summary":"Post A Draft Invoice","operationId":"post_invoice","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/invoices/{invoice_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void An Invoice By Id","operationId":"void_invoice_by_id","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","title":"Invoice Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperInvoice"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/room-statistics":{"get":{"tags":["Developer API"],"summary":"List Daily Room Statistics","operationId":"list_room_statistics","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRoomStatsList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Developer Write"],"summary":"Set Room Statistics For Many Days","operationId":"put_room_statistics_batch","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRoomStatsBatchInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRoomStatsBatchResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/room-statistics/{stat_date}":{"get":{"tags":["Developer API"],"summary":"Get Room Statistics For A Day","operationId":"get_room_statistics","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"stat_date","in":"path","required":true,"schema":{"type":"string","format":"date","title":"Stat Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRoomStats"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Developer Write"],"summary":"Set Room Statistics For A Day","operationId":"put_room_statistics","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"stat_date","in":"path","required":true,"schema":{"type":"string","format":"date","title":"Stat Date"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRoomStatsInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperRoomStats"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Developer Write"],"summary":"Delete Room Statistics For A Day","operationId":"delete_room_statistics","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"stat_date","in":"path","required":true,"schema":{"type":"string","format":"date","title":"Stat Date"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/reports/hotel-kpis":{"get":{"tags":["Developer API"],"summary":"Hotel Kpis: Occupancy, Adr, Revpar","operationId":"get_hotel_kpis","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"from","in":"query","required":true,"schema":{"type":"string","format":"date","title":"From"}},{"name":"to","in":"query","required":true,"schema":{"type":"string","format":"date","title":"To"}},{"name":"granularity","in":"query","required":false,"schema":{"enum":["day","month"],"type":"string","default":"month","title":"Granularity"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperHotelKpis"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/vendor-credits":{"get":{"tags":["Developer API"],"summary":"List Vendor Credits","operationId":"list_vendor_credits","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"vendor_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Vendor Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(open|partial|applied|voided)$"},{"type":"null"}],"title":"Status"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCreditList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Developer Write"],"summary":"Create A Vendor Credit","operationId":"create_vendor_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCreditInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/vendor-credits/{credit_id}":{"get":{"tags":["Developer API"],"summary":"Get A Vendor Credit","operationId":"get_vendor_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/vendor-credits/{credit_id}/apply":{"post":{"tags":["Developer Write"],"summary":"Apply A Vendor Credit To Bills","operationId":"apply_vendor_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCreditApplyInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/vendor-credits/{credit_id}/refund":{"post":{"tags":["Developer Write"],"summary":"Record A Vendor'S Cash Refund Of A Credit","operationId":"refund_vendor_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCreditRefundInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/vendor-credits/{credit_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Vendor Credit","operationId":"void_vendor_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperVendorCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/card-credits":{"get":{"tags":["Developer API"],"summary":"List Card Credits","operationId":"list_card_credits","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"enum":["refund","statement_credit"],"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(draft|posted|voided)$"},{"type":"null"}],"title":"Status"}},{"name":"card_account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Card Account Id"}},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCreditList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Developer Write"],"summary":"Create A Card Credit","operationId":"create_card_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"description":"Optional. A retried create with the same key and body returns the first record.","title":"Idempotency-Key"},"description":"Optional. A retried create with the same key and body returns the first record."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCreditInput"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/card-credits/{credit_id}":{"get":{"tags":["Developer API"],"summary":"Get A Card Credit","operationId":"get_card_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Developer Write"],"summary":"Update A Card Credit","operationId":"update_card_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCreditUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Developer Write"],"summary":"Delete A Draft Card Credit","operationId":"delete_card_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/card-credits/{credit_id}/post":{"post":{"tags":["Developer Write"],"summary":"Post A Draft Card Credit","operationId":"post_card_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/card-credits/{credit_id}/void":{"post":{"tags":["Developer Write"],"summary":"Void A Card Credit","operationId":"void_card_credit","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"credit_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVoidInput"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperCardCredit"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/companies/{company_id}/review-queue":{"get":{"tags":["Developer API"],"summary":"Transactions Waiting For Review","operationId":"list_review_queue","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}},{"name":"status","in":"query","required":false,"schema":{"enum":["needs_review","uncategorized","pending_approval"],"type":"string","default":"needs_review","title":"Status"}},{"name":"account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Account Id"}},{"name":"account_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["credit_card","bank"],"type":"string"},{"type":"null"}],"title":"Account Type"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeveloperReviewQueue"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/oauth/token":{"post":{"tags":["Partners"],"summary":"Exchange a Connect HelloLedger code for an API key","description":"Partner server only. Send application/x-www-form-urlencoded with grant_type=authorization_code, the code and redirect_uri from the callback, and billing (partner or self). Authenticate with HTTP Basic client_id:client_secret. Returns an ordinary developer API key for the approved company. A code works once and expires after 10 minutes.","operationId":"oauth_token_v1_oauth_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_oauth_token_v1_oauth_token_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerTokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBasic":[]}]}},"/v1/partner/companies":{"get":{"tags":["Partners"],"summary":"List companies linked to your partner account","description":"Partner server only (HTTP Basic client_id:client_secret). Billing is partner or self; connected is true while an approved Connect key is active.","operationId":"partner_companies_v1_partner_companies_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerCompanyList"}}}}},"security":[{"HTTPBasic":[]}]}},"/v1/partner/companies/{company_id}/billing":{"post":{"tags":["Partners"],"summary":"Set who pays for a linked company","description":"partner: you pay HelloLedger and the company sees no HelloLedger bill. self: the company pays HelloLedger directly and has 30 days to subscribe.","operationId":"partner_company_billing_v1_partner_companies__company_id__billing_post","security":[{"HTTPBasic":[]}],"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"integer","title":"Company Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBillingRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBillingResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_oauth_token_v1_oauth_token_post":{"properties":{"grant_type":{"type":"string","title":"Grant Type"},"code":{"type":"string","title":"Code"},"redirect_uri":{"type":"string","title":"Redirect Uri"},"billing":{"type":"string","enum":["partner","self"],"title":"Billing","default":"self"},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Secret"}},"type":"object","required":["grant_type","code","redirect_uri"],"title":"Body_oauth_token_v1_oauth_token_post"},"DeveloperBankBalance":{"properties":{"account_id":{"type":"string","title":"Account Id"},"account_name":{"type":"string","title":"Account Name"},"account_type":{"type":"string","title":"Account Type"},"account_mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Mask"},"institution_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institution Name"},"book_balance":{"type":"string","title":"Book Balance"},"plaid_current_balance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plaid Current Balance"},"plaid_available_balance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plaid Available Balance"},"plaid_balance_as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plaid Balance As Of"},"currency":{"type":"string","title":"Currency","default":"USD"}},"type":"object","required":["account_id","account_name","account_type","book_balance"],"title":"DeveloperBankBalance"},"DeveloperBill":{"properties":{"bill_id":{"type":"string","title":"Bill Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"vendor_id":{"type":"string","title":"Vendor Id"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name"},"vendor_created":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vendor Created"},"bill_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bill Number"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"status":{"type":"string","title":"Status"},"posted":{"type":"boolean","title":"Posted"},"total_amount":{"type":"string","title":"Total Amount"},"amount_paid":{"type":"string","title":"Amount Paid"},"amount_credited":{"type":"string","title":"Amount Credited"},"balance_due":{"type":"string","title":"Balance Due"},"currency":{"type":"string","title":"Currency","default":"USD"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"ap_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ap Account Id"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperBillLine"},"type":"array","title":"Lines"},"posted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Posted At"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"void_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Void Reason"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["bill_id","vendor_id","status","posted","total_amount","amount_paid","amount_credited","balance_due"],"title":"DeveloperBill"},"DeveloperBillApplicationInput":{"properties":{"bill_id":{"type":"string","title":"Bill Id"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"}},"additionalProperties":false,"type":"object","required":["bill_id","amount"],"title":"DeveloperBillApplicationInput"},"DeveloperBillInput":{"properties":{"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id","description":"HelloLedger vendor id."},"vendor":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVendorInput"},{"type":"null"}],"description":"Vendor details instead of vendor_id. Matched to an existing vendor by name (case-insensitive); created when there is no match."},"bill_number":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Bill Number"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"ap_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ap Account Id","description":"Accounts Payable account. Defaults to the company's A/P account."},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this bill, stored for reference."},"date":{"type":"string","format":"date","title":"Date"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperBillLineInput"},"type":"array","maxItems":100,"minItems":1,"title":"Lines"},"post":{"type":"boolean","title":"Post","description":"true posts to the ledger now. false (default) saves a draft you can post later.","default":false}},"additionalProperties":false,"type":"object","required":["date","lines"],"title":"DeveloperBillInput"},"DeveloperBillLine":{"properties":{"account_id":{"type":"string","title":"Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity"},"unit_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Price"},"amount":{"type":"string","title":"Amount"}},"type":"object","required":["account_id","amount"],"title":"DeveloperBillLine"},"DeveloperBillLineInput":{"properties":{"account_id":{"type":"string","title":"Account Id","description":"Expense (or asset) account id from the chart of accounts."},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"},{"type":"null"}],"title":"Quantity"},"unit_price":{"anyOf":[{"type":"number","minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Unit Price"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"}},"additionalProperties":false,"type":"object","required":["account_id","amount"],"title":"DeveloperBillLineInput"},"DeveloperBillList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperBill"},"type":"array","title":"Data"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["data","limit","offset"],"title":"DeveloperBillList"},"DeveloperBillUpdate":{"properties":{"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id","description":"HelloLedger vendor id."},"vendor":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVendorInput"},{"type":"null"}],"description":"Vendor details instead of vendor_id. Matched to an existing vendor by name (case-insensitive); created when there is no match."},"bill_number":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Bill Number"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"ap_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ap Account Id","description":"Accounts Payable account. Defaults to the company's A/P account."},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this bill, stored for reference."},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/DeveloperBillLineInput"},"type":"array","maxItems":100,"minItems":1},{"type":"null"}],"title":"Lines"},"post":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Post","description":"true also posts a draft after the update."}},"additionalProperties":false,"type":"object","title":"DeveloperBillUpdate"},"DeveloperCOAAccount":{"properties":{"account_id":{"type":"string","title":"Account Id"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"account_name":{"type":"string","title":"Account Name"},"account_type":{"type":"string","title":"Account Type"},"group_name":{"type":"string","title":"Group Name"},"start_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"}},"type":"object","required":["account_id","account_name","account_type","group_name"],"title":"DeveloperCOAAccount","description":"Stable public representation of one chart-of-accounts row."},"DeveloperCOASummary":{"properties":{"account_count":{"type":"integer","title":"Account Count"},"by_account_type":{"additionalProperties":{"type":"integer"},"type":"object","title":"By Account Type"}},"type":"object","required":["account_count","by_account_type"],"title":"DeveloperCOASummary"},"DeveloperCardCredit":{"properties":{"card_credit_id":{"type":"string","title":"Card Credit Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"kind":{"type":"string","title":"Kind"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"status":{"type":"string","title":"Status","description":"draft, posted, or voided."},"posted":{"type":"boolean","title":"Posted"},"card_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Account Id"},"card_account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Account Name"},"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name"},"vendor_created":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vendor Created"},"expense_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expense Id"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference"},"total_amount":{"type":"string","title":"Total Amount"},"currency":{"type":"string","title":"Currency","default":"USD"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"lines":{"items":{"$ref":"#/components/schemas/api__developer_v1_contract__DeveloperCreditLine__2"},"type":"array","title":"Lines"},"posted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Posted At"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"void_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Void Reason"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["card_credit_id","kind","status","posted","total_amount"],"title":"DeveloperCardCredit"},"DeveloperCardCreditInput":{"properties":{"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id","description":"HelloLedger vendor (merchant) id."},"vendor":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVendorInput"},{"type":"null"}],"description":"Merchant details instead of vendor_id. Matched by name or created."},"expense_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expense Id","description":"The expense this refund reverses, for reference."},"reference":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Reference"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this credit, stored for reference."},"kind":{"type":"string","enum":["refund","statement_credit"],"title":"Kind","description":"refund: a merchant refunded a charge. statement_credit: cashback, dispute, or goodwill credit."},"date":{"type":"string","format":"date","title":"Date"},"card_account_id":{"type":"string","title":"Card Account Id","description":"Credit card (or bank) account the credit landed on."},"lines":{"items":{"$ref":"#/components/schemas/api__developer_v1_contract__DeveloperCreditLineInput__2"},"type":"array","maxItems":100,"minItems":1,"title":"Lines"},"post":{"type":"boolean","title":"Post","description":"true posts to the ledger now. false (default) saves a draft you can post later.","default":false}},"additionalProperties":false,"type":"object","required":["kind","date","card_account_id","lines"],"title":"DeveloperCardCreditInput"},"DeveloperCardCreditList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperCardCredit"},"type":"array","title":"Data"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["data","limit","offset"],"title":"DeveloperCardCreditList"},"DeveloperCardCreditUpdate":{"properties":{"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id","description":"HelloLedger vendor (merchant) id."},"vendor":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVendorInput"},{"type":"null"}],"description":"Merchant details instead of vendor_id. Matched by name or created."},"expense_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expense Id","description":"The expense this refund reverses, for reference."},"reference":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Reference"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this credit, stored for reference."},"kind":{"anyOf":[{"type":"string","enum":["refund","statement_credit"]},{"type":"null"}],"title":"Kind"},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"card_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Account Id"},"lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/api__developer_v1_contract__DeveloperCreditLineInput__2"},"type":"array","maxItems":100,"minItems":1},{"type":"null"}],"title":"Lines"},"post":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Post","description":"true also posts a draft after the update."}},"additionalProperties":false,"type":"object","title":"DeveloperCardCreditUpdate"},"DeveloperCompanyProfile":{"properties":{"company_id":{"type":"string","title":"Company Id"},"company_name":{"type":"string","title":"Company Name"},"business_currency":{"type":"string","title":"Business Currency","default":"USD"},"business_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Type"},"company_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Type"},"fiscal_year_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Year End"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"}},"type":"object","required":["company_id","company_name"],"title":"DeveloperCompanyProfile"},"DeveloperCreditApplication":{"properties":{"bill_id":{"type":"string","title":"Bill Id"},"amount":{"type":"string","title":"Amount"},"applied_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Applied At"}},"type":"object","required":["bill_id","amount"],"title":"DeveloperCreditApplication"},"DeveloperCreditLine-Input":{"properties":{"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"type":"string","title":"Amount"}},"type":"object","required":["amount"],"title":"DeveloperCreditLine"},"DeveloperCreditRefund":{"properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"amount":{"type":"string","title":"Amount"},"deposit_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deposit Account Id"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"}},"type":"object","required":["amount"],"title":"DeveloperCreditRefund"},"DeveloperCreditVoidInput":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","title":"DeveloperCreditVoidInput"},"DeveloperCustomer":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"external_id":{"type":"string","title":"External Id"},"name":{"type":"string","title":"Name"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"billing_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["customer_id","external_id","name"],"title":"DeveloperCustomer"},"DeveloperCustomerCredit":{"properties":{"credit_id":{"type":"string","title":"Credit Id"},"external_id":{"type":"string","title":"External Id"},"customer_id":{"type":"string","title":"Customer Id"},"customer_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer External Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"credit_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Number"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"total_amount":{"type":"string","title":"Total Amount"},"amount_applied":{"type":"string","title":"Amount Applied"},"refunded_amount":{"type":"string","title":"Refunded Amount"},"unapplied_amount":{"type":"string","title":"Unapplied Amount"},"status":{"type":"string","title":"Status"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperCreditLine-Input"},"type":"array","title":"Lines"},"applications":{"items":{"$ref":"#/components/schemas/DeveloperPaymentApplication"},"type":"array","title":"Applications"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["credit_id","external_id","customer_id","total_amount","amount_applied","refunded_amount","unapplied_amount","status"],"title":"DeveloperCustomerCredit"},"DeveloperCustomerCreditInput":{"properties":{"customer_external_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","title":"Customer External Id"},"date":{"type":"string","format":"date","title":"Date"},"reason":{"type":"string","enum":["concession","write_off","deposit_applied","other"],"title":"Reason"},"credit_number":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Credit Number"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"lines":{"items":{"$ref":"#/components/schemas/api__developer_v1_contract__DeveloperCreditLineInput__1"},"type":"array","maxItems":50,"minItems":1,"title":"Lines"},"applications":{"items":{"$ref":"#/components/schemas/DeveloperPaymentApplicationInput"},"type":"array","maxItems":100,"title":"Applications"}},"additionalProperties":false,"type":"object","required":["customer_external_id","date","reason","lines"],"title":"DeveloperCustomerCreditInput"},"DeveloperCustomerInput":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name"},"email":{"anyOf":[{"type":"string","maxLength":254},{"type":"null"}],"title":"Email"},"billing_email":{"anyOf":[{"type":"string","maxLength":254},{"type":"null"}],"title":"Billing Email"},"phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Phone"},"address_line1":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Address Line1"},"address_line2":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Address Line2"},"city":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"State"},"zip":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Zip"},"country":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Country"},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"Up to 20 string key/value pairs, e.g. unit or lease id."},"status":{"anyOf":[{"type":"string","enum":["active","inactive"]},{"type":"null"}],"title":"Status","description":"Set inactive when the resident moves out. Omit to leave it unchanged."}},"additionalProperties":false,"type":"object","required":["name"],"title":"DeveloperCustomerInput"},"DeveloperCustomerPayment":{"properties":{"payment_id":{"type":"string","title":"Payment Id"},"external_id":{"type":"string","title":"External Id"},"customer_id":{"type":"string","title":"Customer Id"},"customer_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer External Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"amount":{"type":"string","title":"Amount"},"amount_applied":{"type":"string","title":"Amount Applied"},"unapplied_amount":{"type":"string","title":"Unapplied Amount"},"refunded_amount":{"type":"string","title":"Refunded Amount","default":"0.00"},"deposit_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deposit Account Id"},"method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Method"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference"},"status":{"type":"string","title":"Status"},"applications":{"items":{"$ref":"#/components/schemas/DeveloperPaymentApplication"},"type":"array","title":"Applications"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["payment_id","external_id","customer_id","amount","amount_applied","unapplied_amount","status"],"title":"DeveloperCustomerPayment"},"DeveloperCustomerPaymentInput":{"properties":{"customer_external_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","title":"Customer External Id"},"date":{"type":"string","format":"date","title":"Date"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"},"deposit_account_id":{"type":"string","title":"Deposit Account Id","description":"Chart-of-accounts id the money lands in: the bank account, or a clearing account (e.g. Undeposited Funds) when the processor pays out in batches."},"method":{"type":"string","enum":["ach","card","check","cash","bank","other"],"title":"Method","default":"bank"},"reference":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Reference"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"applications":{"items":{"$ref":"#/components/schemas/DeveloperPaymentApplicationInput"},"type":"array","maxItems":100,"title":"Applications"}},"additionalProperties":false,"type":"object","required":["customer_external_id","date","amount","deposit_account_id"],"title":"DeveloperCustomerPaymentInput"},"DeveloperCustomerRefund":{"properties":{"refund_id":{"type":"string","title":"Refund Id"},"external_id":{"type":"string","title":"External Id"},"customer_id":{"type":"string","title":"Customer Id"},"customer_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer External Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"amount":{"type":"string","title":"Amount"},"source":{"type":"string","title":"Source"},"paid_from_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid From Account Id"},"deposit_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deposit Account Id"},"payment_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment External Id"},"credit_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit External Id"},"method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Method"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"status":{"type":"string","title":"Status"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["refund_id","external_id","customer_id","amount","source","status"],"title":"DeveloperCustomerRefund"},"DeveloperCustomerRefundInput":{"properties":{"customer_external_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","title":"Customer External Id"},"date":{"type":"string","format":"date","title":"Date"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"},"paid_from_account_id":{"type":"string","title":"Paid From Account Id","description":"Bank or clearing account the money leaves from."},"source":{"type":"string","enum":["deposit","payment","credit"],"title":"Source","description":"deposit: return a security deposit (needs deposit_account_id). payment: refund the unapplied part of a payment (needs payment_external_id). credit: pay out the unapplied part of a credit (needs credit_external_id)."},"deposit_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deposit Account Id","description":"Security-deposit liability account, for source=deposit."},"payment_external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"Payment External Id"},"credit_external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"Credit External Id"},"method":{"type":"string","enum":["ach","card","check","cash","bank","other"],"title":"Method","default":"bank"},"reference":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Reference"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"}},"additionalProperties":false,"type":"object","required":["customer_external_id","date","amount","paid_from_account_id","source"],"title":"DeveloperCustomerRefundInput"},"DeveloperDailyRevenueRequest":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"memo":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Memo"},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperJournalLine-Input"},"type":"array","maxItems":200,"minItems":2,"title":"Lines"}},"type":"object","required":["date","lines"],"title":"DeveloperDailyRevenueRequest"},"DeveloperDailyRevenueResponse":{"properties":{"status":{"type":"string","const":"success","title":"Status"},"action":{"type":"string","enum":["created","replaced"],"title":"Action"},"journal_id":{"type":"integer","title":"Journal Id"},"date":{"type":"string","title":"Date"}},"type":"object","required":["status","action","journal_id","date"],"title":"DeveloperDailyRevenueResponse"},"DeveloperExceptionItem":{"properties":{"exception_id":{"type":"string","title":"Exception Id"},"type":{"type":"string","title":"Type"},"status":{"type":"string","title":"Status","default":"open"},"title":{"type":"string","title":"Title"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"by_month":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"By Month"},"by_account":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"By Account"}},"type":"object","required":["exception_id","type","title"],"title":"DeveloperExceptionItem"},"DeveloperExpense":{"properties":{"expense_id":{"type":"string","title":"Expense Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name"},"vendor_created":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vendor Created"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"status":{"type":"string","title":"Status"},"posted":{"type":"boolean","title":"Posted"},"payment_source":{"type":"string","title":"Payment Source"},"paid_from_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid From Account Id"},"total_amount":{"type":"string","title":"Total Amount"},"currency":{"type":"string","title":"Currency","default":"USD"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperExpenseLine"},"type":"array","title":"Lines"},"posted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Posted At"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"void_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Void Reason"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["expense_id","status","posted","payment_source","total_amount"],"title":"DeveloperExpense"},"DeveloperExpenseInput":{"properties":{"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id","description":"HelloLedger vendor (merchant) id."},"vendor":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVendorInput"},{"type":"null"}],"description":"Merchant details instead of vendor_id. Matched to an existing vendor by name (case-insensitive); created when there is no match."},"reference":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Reference","description":"Receipt or reference number."},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"payment_source":{"type":"string","enum":["bank","card","cash"],"title":"Payment Source","default":"bank"},"paid_from_account_id":{"type":"string","title":"Paid From Account Id","description":"Bank, credit card, or cash account the money left from."},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this expense, stored for reference."},"date":{"type":"string","format":"date","title":"Date"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperExpenseLineInput"},"type":"array","maxItems":100,"minItems":1,"title":"Lines"},"post":{"type":"boolean","title":"Post","description":"true posts to the ledger now. false (default) saves a draft you can post later.","default":false}},"additionalProperties":false,"type":"object","required":["paid_from_account_id","date","lines"],"title":"DeveloperExpenseInput"},"DeveloperExpenseLine":{"properties":{"account_id":{"type":"string","title":"Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"type":"string","title":"Amount"}},"type":"object","required":["account_id","amount"],"title":"DeveloperExpenseLine"},"DeveloperExpenseLineInput":{"properties":{"account_id":{"type":"string","title":"Account Id","description":"Expense account id from the chart of accounts."},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"}},"additionalProperties":false,"type":"object","required":["account_id","amount"],"title":"DeveloperExpenseLineInput"},"DeveloperExpenseList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperExpense"},"type":"array","title":"Data"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["data","limit","offset"],"title":"DeveloperExpenseList"},"DeveloperExpenseUpdate":{"properties":{"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id","description":"HelloLedger vendor (merchant) id."},"vendor":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVendorInput"},{"type":"null"}],"description":"Merchant details instead of vendor_id. Matched to an existing vendor by name (case-insensitive); created when there is no match."},"reference":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Reference","description":"Receipt or reference number."},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"payment_source":{"anyOf":[{"type":"string","enum":["bank","card","cash"]},{"type":"null"}],"title":"Payment Source"},"paid_from_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paid From Account Id","description":"Bank, credit card, or cash account the money left from."},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this expense, stored for reference."},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/DeveloperExpenseLineInput"},"type":"array","maxItems":100,"minItems":1},{"type":"null"}],"title":"Lines"},"post":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Post","description":"true also posts a draft after the update."}},"additionalProperties":false,"type":"object","title":"DeveloperExpenseUpdate"},"DeveloperHotelKpiPeriod":{"properties":{"period":{"type":"string","title":"Period","description":"YYYY-MM-DD for daily rows, YYYY-MM for monthly rows, or 'total'."},"days_reported":{"type":"integer","title":"Days Reported","description":"Days in the period that have room statistics."},"rooms_available":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rooms Available"},"rooms_sold":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rooms Sold"},"occupancy_pct":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occupancy Pct"},"rooms_revenue":{"type":"string","title":"Rooms Revenue"},"adr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Adr","description":"Average daily rate: rooms revenue ÷ rooms sold."},"revpar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revpar","description":"Revenue per available room: rooms revenue ÷ rooms available."}},"type":"object","required":["period","days_reported","rooms_revenue"],"title":"DeveloperHotelKpiPeriod"},"DeveloperHotelKpis":{"properties":{"company_id":{"type":"string","title":"Company Id"},"currency":{"type":"string","title":"Currency","default":"USD"},"from":{"type":"string","title":"From"},"to":{"type":"string","title":"To"},"granularity":{"type":"string","enum":["day","month"],"title":"Granularity"},"data":{"items":{"$ref":"#/components/schemas/DeveloperHotelKpiPeriod"},"type":"array","title":"Data"},"total":{"$ref":"#/components/schemas/DeveloperHotelKpiPeriod"}},"type":"object","required":["company_id","from","to","granularity","data","total"],"title":"DeveloperHotelKpis"},"DeveloperInvoice":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"version":{"type":"integer","title":"Version"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number"},"customer_id":{"type":"string","title":"Customer Id"},"customer_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer External Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"status":{"type":"string","title":"Status"},"total_amount":{"type":"string","title":"Total Amount"},"amount_paid":{"type":"string","title":"Amount Paid"},"balance_due":{"type":"string","title":"Balance Due"},"tax_amount":{"type":"string","title":"Tax Amount"},"currency":{"type":"string","title":"Currency","default":"USD"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperInvoiceLine"},"type":"array","title":"Lines"},"replaced_invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replaced Invoice Id"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"customer_created":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Customer Created"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["invoice_id","version","customer_id","status","total_amount","amount_paid","balance_due","tax_amount"],"title":"DeveloperInvoice"},"DeveloperInvoiceCreate":{"properties":{"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"HelloLedger customer id."},"customer":{"anyOf":[{"$ref":"#/components/schemas/DeveloperCustomerInput"},{"type":"null"}],"description":"Customer details instead of customer_id. Matched to an existing customer by name (case-insensitive); created when there is no match."},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date"},"terms":{"anyOf":[{"type":"string","enum":["due_on_receipt","net_15","net_30","net_45","net_60"]},{"type":"null"}],"title":"Terms"},"invoice_number":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Invoice Number"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"tax_rate":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Tax Rate"},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this invoice, stored for reference."},"date":{"type":"string","format":"date","title":"Date"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperInvoiceLineInput"},"type":"array","maxItems":100,"minItems":1,"title":"Lines"},"post":{"type":"boolean","title":"Post","description":"true posts to the ledger now. false (default) saves a draft you can post later.","default":false}},"additionalProperties":false,"type":"object","required":["date","lines"],"title":"DeveloperInvoiceCreate"},"DeveloperInvoiceInput":{"properties":{"customer_external_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","title":"Customer External Id"},"customer":{"anyOf":[{"$ref":"#/components/schemas/DeveloperCustomerInput"},{"type":"null"}],"description":"Creates the customer when customer_external_id is new. Ignored for customers that already exist; update them with PUT /customers."},"date":{"type":"string","format":"date","title":"Date"},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date"},"terms":{"anyOf":[{"type":"string","enum":["due_on_receipt","net_15","net_30","net_45","net_60"]},{"type":"null"}],"title":"Terms"},"invoice_number":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Invoice Number"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"tax_rate":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Tax Rate"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperInvoiceLineInput"},"type":"array","maxItems":100,"minItems":1,"title":"Lines"}},"additionalProperties":false,"type":"object","required":["customer_external_id","date","lines"],"title":"DeveloperInvoiceInput"},"DeveloperInvoiceLine":{"properties":{"item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Id"},"item_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Name"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity"},"unit_price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit Price"},"amount":{"type":"string","title":"Amount"},"taxable":{"type":"boolean","title":"Taxable","default":false}},"type":"object","required":["amount"],"title":"DeveloperInvoiceLine"},"DeveloperInvoiceLineInput":{"properties":{"item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Id","description":"Product/service id from GET /items. Its income account is used."},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id","description":"Income account id from the chart of accounts, when no item is used."},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"},"quantity":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"},{"type":"null"}],"title":"Quantity"},"unit_price":{"anyOf":[{"type":"number","minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Unit Price"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"},"taxable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Taxable","description":"Defaults to the item's taxable flag, or false for account lines."}},"additionalProperties":false,"type":"object","required":["amount"],"title":"DeveloperInvoiceLineInput"},"DeveloperInvoiceUpdate":{"properties":{"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"HelloLedger customer id."},"customer":{"anyOf":[{"$ref":"#/components/schemas/DeveloperCustomerInput"},{"type":"null"}],"description":"Customer details instead of customer_id. Matched to an existing customer by name (case-insensitive); created when there is no match."},"due_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due Date"},"terms":{"anyOf":[{"type":"string","enum":["due_on_receipt","net_15","net_30","net_45","net_60"]},{"type":"null"}],"title":"Terms"},"invoice_number":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Invoice Number"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"tax_rate":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Tax Rate"},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this invoice, stored for reference."},"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/DeveloperInvoiceLineInput"},"type":"array","maxItems":100,"minItems":1},{"type":"null"}],"title":"Lines"},"post":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Post","description":"true also posts a draft after the update."}},"additionalProperties":false,"type":"object","title":"DeveloperInvoiceUpdate"},"DeveloperInvoiceVoidInput":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","title":"DeveloperInvoiceVoidInput"},"DeveloperItem":{"properties":{"item_id":{"type":"string","title":"Item Id"},"name":{"type":"string","title":"Name"},"item_type":{"type":"string","title":"Item Type","default":"service"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"default_rate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Rate"},"income_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Income Account Id"},"income_account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Income Account Name"},"taxable":{"type":"boolean","title":"Taxable","default":false},"active":{"type":"boolean","title":"Active","default":true},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku"}},"type":"object","required":["item_id","name"],"title":"DeveloperItem"},"DeveloperItemList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperItem"},"type":"array","title":"Data"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["data","limit","offset"],"title":"DeveloperItemList"},"DeveloperJournalEntry":{"properties":{"journal_id":{"type":"string","title":"Journal Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"lines":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Lines"}},"type":"object","required":["journal_id"],"title":"DeveloperJournalEntry"},"DeveloperJournalEntryInput":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperJournalLineInput"},"type":"array","maxItems":200,"minItems":2,"title":"Lines"},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this entry, stored for reference."},"post":{"type":"boolean","title":"Post","description":"true posts to the ledger now. false (default) saves a draft you can post later.","default":false}},"additionalProperties":false,"type":"object","required":["date","lines"],"title":"DeveloperJournalEntryInput"},"DeveloperJournalEntryRecord":{"properties":{"journal_id":{"type":"string","title":"Journal Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"status":{"type":"string","title":"Status"},"posted":{"type":"boolean","title":"Posted"},"total":{"type":"string","title":"Total"},"lines":{"items":{"$ref":"#/components/schemas/DeveloperJournalLine-Output"},"type":"array","title":"Lines"},"posted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Posted At"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"void_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Void Reason"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["journal_id","status","posted","total"],"title":"DeveloperJournalEntryRecord"},"DeveloperJournalEntryUpdate":{"properties":{"date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"lines":{"anyOf":[{"items":{"$ref":"#/components/schemas/DeveloperJournalLineInput"},"type":"array","maxItems":200,"minItems":2},{"type":"null"}],"title":"Lines"},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id"},"post":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Post","description":"true also posts a draft after the update."}},"additionalProperties":false,"type":"object","title":"DeveloperJournalEntryUpdate"},"DeveloperJournalLine-Input":{"properties":{"account_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","title":"Account Id"},"debit":{"type":"number","minimum":0.0,"title":"Debit","default":0},"credit":{"type":"number","minimum":0.0,"title":"Credit","default":0},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"}},"type":"object","required":["account_id"],"title":"DeveloperJournalLine"},"DeveloperJournalLine-Output":{"properties":{"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"debit":{"type":"string","title":"Debit"},"credit":{"type":"string","title":"Credit"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["debit","credit"],"title":"DeveloperJournalLine"},"DeveloperJournalLineInput":{"properties":{"account_id":{"type":"string","title":"Account Id","description":"Account id from the chart of accounts."},"debit":{"anyOf":[{"type":"number","minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Debit"},"credit":{"anyOf":[{"type":"number","minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Credit"},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"}},"additionalProperties":false,"type":"object","required":["account_id"],"title":"DeveloperJournalLineInput"},"DeveloperLinkedInstitution":{"properties":{"item_id":{"type":"string","title":"Item Id"},"institution_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institution Name"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","required":["item_id"],"title":"DeveloperLinkedInstitution"},"DeveloperPaymentApplication":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id"},"invoice_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice External Id"},"amount":{"type":"string","title":"Amount"}},"type":"object","required":["invoice_id","amount"],"title":"DeveloperPaymentApplication"},"DeveloperPaymentApplicationInput":{"properties":{"invoice_external_id":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$","title":"Invoice External Id"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"}},"additionalProperties":false,"type":"object","required":["invoice_external_id","amount"],"title":"DeveloperPaymentApplicationInput"},"DeveloperPaymentVoidInput":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","title":"DeveloperPaymentVoidInput"},"DeveloperPayout":{"properties":{"payout_id":{"type":"string","title":"Payout Id"},"external_id":{"type":"string","title":"External Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"clearing_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clearing Account Id"},"bank_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account Id"},"fee_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fee Account Id"},"gross":{"type":"string","title":"Gross"},"fee":{"type":"string","title":"Fee"},"net":{"type":"string","title":"Net"},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"payment_external_ids":{"items":{"type":"string"},"type":"array","title":"Payment External Ids"},"status":{"type":"string","title":"Status"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["payout_id","external_id","gross","fee","net","status"],"title":"DeveloperPayout"},"DeveloperPayoutInput":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"clearing_account_id":{"type":"string","title":"Clearing Account Id","description":"Clearing account the card/ACH payments were recorded to."},"gross":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Gross","description":"Payments covered by the payout, before fees."},"fee":{"anyOf":[{"type":"number","minimum":0.0},{"type":"string"}],"title":"Fee","description":"Processor fees deducted from the payout."},"net":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Net","description":"Amount deposited to the bank (gross minus fee)."},"fee_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fee Account Id","description":"Expense account for the fees. Required when fee is above zero."},"bank_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Account Id","description":"Bank account the payout landed in (for reference; not posted)."},"reference":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Reference"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"payment_external_ids":{"items":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},"type":"array","maxItems":500,"title":"Payment External Ids"}},"additionalProperties":false,"type":"object","required":["date","clearing_account_id","gross","fee","net"],"title":"DeveloperPayoutInput"},"DeveloperPayoutVoidInput":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","title":"DeveloperPayoutVoidInput"},"DeveloperPlaidSyncStatus":{"properties":{"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"item_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Id"},"institution_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Institution Name"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"account_mask":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Mask"},"last_sync_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Sync At"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","title":"DeveloperPlaidSyncStatus"},"DeveloperReadyToReviewApprove":{"properties":{"transaction_ids":{"items":{"type":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Transaction Ids"}},"type":"object","required":["transaction_ids"],"title":"DeveloperReadyToReviewApprove"},"DeveloperReconciliationWrite":{"properties":{"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"},"ending_date":{"type":"string","title":"Ending Date"},"ending_balance":{"type":"number","title":"Ending Balance"},"last_statement_ending_date":{"type":"string","title":"Last Statement Ending Date"},"beginning_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Beginning Balance"}},"type":"object","required":["ending_date","ending_balance","last_statement_ending_date"],"title":"DeveloperReconciliationWrite"},"DeveloperRefundVoidInput":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","title":"DeveloperRefundVoidInput"},"DeveloperReviewItem":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"merchant_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Name"},"amount":{"type":"string","title":"Amount"},"currency":{"type":"string","title":"Currency","default":"USD"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"},"review_status":{"type":"string","enum":["uncategorized","pending_approval"],"title":"Review Status","description":"uncategorized: needs a category. pending_approval: categorized, waiting for approval."},"suggested_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Suggested Category","description":"Account name HelloLedger or a user picked. Null for transfers and splits."},"suggested_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Suggested Account Id"},"categorized_by":{"anyOf":[{"type":"string","enum":["helloledger","user"]},{"type":"null"}],"title":"Categorized By"},"is_transfer":{"type":"boolean","title":"Is Transfer","default":false},"is_split":{"type":"boolean","title":"Is Split","default":false}},"type":"object","required":["transaction_id","amount","review_status"],"title":"DeveloperReviewItem"},"DeveloperReviewQueue":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperReviewItem"},"type":"array","title":"Data"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["data","limit","offset"],"title":"DeveloperReviewQueue"},"DeveloperRoomStats":{"properties":{"date":{"type":"string","title":"Date"},"rooms_available":{"type":"integer","title":"Rooms Available"},"rooms_sold":{"type":"integer","title":"Rooms Sold"},"occupancy_pct":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Occupancy Pct","description":"Rooms sold ÷ rooms available × 100, 2 decimals."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["date","rooms_available","rooms_sold"],"title":"DeveloperRoomStats"},"DeveloperRoomStatsBatchInput":{"properties":{"days":{"items":{"$ref":"#/components/schemas/DeveloperRoomStatsDayInput"},"type":"array","maxItems":366,"minItems":1,"title":"Days"}},"additionalProperties":false,"type":"object","required":["days"],"title":"DeveloperRoomStatsBatchInput"},"DeveloperRoomStatsBatchResult":{"properties":{"company_id":{"type":"string","title":"Company Id"},"created":{"type":"integer","title":"Created"},"updated":{"type":"integer","title":"Updated"},"unchanged":{"type":"integer","title":"Unchanged"},"data":{"items":{"$ref":"#/components/schemas/DeveloperRoomStats"},"type":"array","title":"Data"}},"type":"object","required":["company_id","created","updated","unchanged","data"],"title":"DeveloperRoomStatsBatchResult"},"DeveloperRoomStatsDayInput":{"properties":{"rooms_available":{"type":"integer","maximum":1000000.0,"minimum":0.0,"title":"Rooms Available","description":"Rooms available to sell that day."},"rooms_sold":{"type":"integer","maximum":1000000.0,"minimum":0.0,"title":"Rooms Sold","description":"Rooms sold (occupied) that day."},"date":{"type":"string","format":"date","title":"Date"}},"additionalProperties":false,"type":"object","required":["rooms_available","rooms_sold","date"],"title":"DeveloperRoomStatsDayInput"},"DeveloperRoomStatsInput":{"properties":{"rooms_available":{"type":"integer","maximum":1000000.0,"minimum":0.0,"title":"Rooms Available","description":"Rooms available to sell that day."},"rooms_sold":{"type":"integer","maximum":1000000.0,"minimum":0.0,"title":"Rooms Sold","description":"Rooms sold (occupied) that day."}},"additionalProperties":false,"type":"object","required":["rooms_available","rooms_sold"],"title":"DeveloperRoomStatsInput"},"DeveloperRoomStatsList":{"properties":{"company_id":{"type":"string","title":"Company Id"},"from":{"type":"string","title":"From"},"to":{"type":"string","title":"To"},"data":{"items":{"$ref":"#/components/schemas/DeveloperRoomStats"},"type":"array","title":"Data"}},"type":"object","required":["company_id","from","to","data"],"title":"DeveloperRoomStatsList"},"DeveloperTransaction":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"type":"string","title":"Amount"},"currency":{"type":"string","title":"Currency","default":"USD"},"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"reviewed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Reviewed"},"excluded":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Excluded"},"review_ready":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Review Ready"},"transfer_matched_with":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transfer Matched With"},"matched_check_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Matched Check Id"},"matched_invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Matched Invoice Id"},"matched_bill_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Matched Bill Id"}},"type":"object","required":["transaction_id","amount"],"title":"DeveloperTransaction"},"DeveloperVendor":{"properties":{"vendor_id":{"type":"string","title":"Vendor Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"name":{"type":"string","title":"Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line1"},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line2"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"},"zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"tax_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tax Id"},"payment_terms":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Terms"},"vendor_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Type"},"is_1099_eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is 1099 Eligible"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"needs_review":{"type":"boolean","title":"Needs Review","description":"True for vendors HelloLedger created automatically from a bill or expense.","default":false},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["vendor_id","name"],"title":"DeveloperVendor"},"DeveloperVendorCredit":{"properties":{"vendor_credit_id":{"type":"string","title":"Vendor Credit Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"vendor_id":{"type":"string","title":"Vendor Id"},"vendor_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Name"},"vendor_created":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Vendor Created"},"credit_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Number"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"status":{"type":"string","title":"Status","description":"open, partial, applied, or voided."},"total_amount":{"type":"string","title":"Total Amount"},"amount_applied":{"type":"string","title":"Amount Applied"},"refunded_amount":{"type":"string","title":"Refunded Amount"},"unapplied_amount":{"type":"string","title":"Unapplied Amount"},"currency":{"type":"string","title":"Currency","default":"USD"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"ap_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ap Account Id"},"lines":{"items":{"$ref":"#/components/schemas/api__developer_v1_contract__DeveloperCreditLine__2"},"type":"array","title":"Lines"},"applications":{"items":{"$ref":"#/components/schemas/DeveloperCreditApplication"},"type":"array","title":"Applications"},"refunds":{"items":{"$ref":"#/components/schemas/DeveloperCreditRefund"},"type":"array","title":"Refunds"},"voided_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Voided At"},"void_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Void Reason"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"result":{"anyOf":[{"type":"string","enum":["created","updated","replaced","unchanged","voided","posted"]},{"type":"null"}],"title":"Result"}},"type":"object","required":["vendor_credit_id","vendor_id","status","total_amount","amount_applied","refunded_amount","unapplied_amount"],"title":"DeveloperVendorCredit"},"DeveloperVendorCreditApplyInput":{"properties":{"applications":{"items":{"$ref":"#/components/schemas/DeveloperBillApplicationInput"},"type":"array","maxItems":100,"minItems":1,"title":"Applications"}},"additionalProperties":false,"type":"object","required":["applications"],"title":"DeveloperVendorCreditApplyInput"},"DeveloperVendorCreditInput":{"properties":{"vendor_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vendor Id","description":"HelloLedger vendor id."},"vendor":{"anyOf":[{"$ref":"#/components/schemas/DeveloperVendorInput"},{"type":"null"}],"description":"Vendor details instead of vendor_id. Matched by name or created."},"date":{"type":"string","format":"date","title":"Date"},"credit_number":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Credit Number","description":"The vendor's credit memo number."},"reason":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Reason"},"memo":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"title":"Memo"},"ap_account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ap Account Id","description":"Defaults to the company's A/P account."},"lines":{"items":{"$ref":"#/components/schemas/api__developer_v1_contract__DeveloperCreditLineInput__2"},"type":"array","maxItems":100,"minItems":1,"title":"Lines"},"applications":{"anyOf":[{"items":{"$ref":"#/components/schemas/DeveloperBillApplicationInput"},"type":"array","maxItems":100},{"type":"null"}],"title":"Applications","description":"Bills to apply the credit to right away."},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this credit, stored for reference."}},"additionalProperties":false,"type":"object","required":["date","lines"],"title":"DeveloperVendorCreditInput"},"DeveloperVendorCreditList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperVendorCredit"},"type":"array","title":"Data"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["data","limit","offset"],"title":"DeveloperVendorCreditList"},"DeveloperVendorCreditRefundInput":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"},"deposit_account_id":{"type":"string","title":"Deposit Account Id","description":"Bank or cash account the vendor's refund went into."},"memo":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Memo"}},"additionalProperties":false,"type":"object","required":["date","amount","deposit_account_id"],"title":"DeveloperVendorCreditRefundInput"},"DeveloperVendorInput":{"properties":{"email":{"anyOf":[{"type":"string","maxLength":254},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Phone"},"address_line1":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Address Line1"},"address_line2":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Address Line2"},"city":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"State"},"zip":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Zip"},"country":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Country"},"tax_id":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Tax Id"},"payment_terms":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Payment Terms"},"vendor_type":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"title":"Vendor Type"},"is_1099_eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is 1099 Eligible"},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"Up to 20 string key/value pairs."},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this vendor, stored for reference."},"status":{"anyOf":[{"type":"string","enum":["active","inactive"]},{"type":"null"}],"title":"Status"},"name":{"type":"string","maxLength":200,"minLength":1,"title":"Name"}},"additionalProperties":false,"type":"object","required":["name"],"title":"DeveloperVendorInput"},"DeveloperVendorList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperVendor"},"type":"array","title":"Data"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["data","limit","offset"],"title":"DeveloperVendorList"},"DeveloperVendorUpdate":{"properties":{"email":{"anyOf":[{"type":"string","maxLength":254},{"type":"null"}],"title":"Email"},"phone":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Phone"},"address_line1":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Address Line1"},"address_line2":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Address Line2"},"city":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"City"},"state":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"State"},"zip":{"anyOf":[{"type":"string","maxLength":20},{"type":"null"}],"title":"Zip"},"country":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Country"},"tax_id":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Tax Id"},"payment_terms":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Payment Terms"},"vendor_type":{"anyOf":[{"type":"string","maxLength":60},{"type":"null"}],"title":"Vendor Type"},"is_1099_eligible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is 1099 Eligible"},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"Up to 20 string key/value pairs."},"external_id":{"anyOf":[{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:\\-]{0,127}$"},{"type":"null"}],"title":"External Id","description":"Your id for this vendor, stored for reference."},"status":{"anyOf":[{"type":"string","enum":["active","inactive"]},{"type":"null"}],"title":"Status"},"name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"title":"Name"}},"additionalProperties":false,"type":"object","title":"DeveloperVendorUpdate"},"DeveloperVoidInput":{"properties":{"reason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Reason"}},"additionalProperties":false,"type":"object","title":"DeveloperVoidInput"},"DeveloperWhoAmI":{"properties":{"client_id":{"type":"string","title":"Client Id"},"purpose":{"type":"string","title":"Purpose"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"companies":{"items":{"$ref":"#/components/schemas/DeveloperWhoAmICompany"},"type":"array","title":"Companies"},"requests_per_minute":{"type":"integer","title":"Requests Per Minute"},"requests_per_day":{"type":"integer","title":"Requests Per Day"},"client_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Ip","description":"Your address as HelloLedger sees it. Use it for the key's allowed IPs."},"allowed_ips":{"items":{"type":"string"},"type":"array","title":"Allowed Ips"}},"type":"object","required":["client_id","purpose","scopes","companies","requests_per_minute","requests_per_day"],"title":"DeveloperWhoAmI"},"DeveloperWhoAmICompany":{"properties":{"company_id":{"type":"string","title":"Company Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"}},"type":"object","required":["company_id"],"title":"DeveloperWhoAmICompany"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PaginatedResponse":{"properties":{"data":{"items":{},"type":"array","title":"Data"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"limit":{"type":"integer","title":"Limit","default":50}},"type":"object","required":["data"],"title":"PaginatedResponse"},"PartnerBillingRequest":{"properties":{"billing":{"type":"string","enum":["partner","self"],"title":"Billing"}},"type":"object","required":["billing"],"title":"PartnerBillingRequest"},"PartnerBillingResponse":{"properties":{"company_id":{"type":"integer","title":"Company Id"},"billing":{"type":"string","title":"Billing"}},"type":"object","required":["company_id","billing"],"title":"PartnerBillingResponse"},"PartnerCompany":{"properties":{"company_id":{"type":"integer","title":"Company Id"},"company_name":{"type":"string","title":"Company Name"},"billing":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Billing"},"connected":{"type":"boolean","title":"Connected"},"linked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linked At"},"archived":{"type":"boolean","title":"Archived","default":false}},"type":"object","required":["company_id","company_name","connected"],"title":"PartnerCompany"},"PartnerCompanyList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PartnerCompany"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"PartnerCompanyList"},"PartnerTokenResponse":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type","default":"bearer"},"company_id":{"type":"integer","title":"Company Id"},"company_name":{"type":"string","title":"Company Name"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes"},"partner_billing":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Partner Billing"}},"type":"object","required":["access_token","company_id","company_name","scopes"],"title":"PartnerTokenResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"api__developer_v1_contract__DeveloperCreditLineInput__1":{"properties":{"account_id":{"type":"string","title":"Account Id","description":"Account the credit is charged to: an income account (e.g. Rent Concessions) for specials, Bad Debt for write-offs, or the security-deposit liability when a deposit is kept."},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"}},"additionalProperties":false,"type":"object","required":["account_id","amount"],"title":"DeveloperCreditLineInput"},"api__developer_v1_contract__DeveloperCreditLineInput__2":{"properties":{"account_id":{"type":"string","title":"Account Id","description":"Account the credit reduces, usually the expense account billed."},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"},"amount":{"anyOf":[{"type":"number","exclusiveMinimum":0.0},{"type":"string"}],"title":"Amount"}},"additionalProperties":false,"type":"object","required":["account_id","amount"],"title":"DeveloperCreditLineInput"},"api__developer_v1_contract__DeveloperCreditLine__1":{"properties":{"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"type":"string","title":"Amount"}},"type":"object","required":["amount"],"title":"DeveloperCreditLine"},"api__developer_v1_contract__DeveloperCreditLine__2":{"properties":{"account_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Id"},"account_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"type":"string","title":"Amount"}},"type":"object","required":["amount"],"title":"DeveloperCreditLine"}},"securitySchemes":{"ApiKeyBearer":{"type":"http","scheme":"bearer","bearerFormat":"hl_live_…","description":"Paste the secret from Settings → API keys"},"ApiKeyBasic":{"type":"http","scheme":"basic","description":"Legacy: client_id as username, secret as password"}}},"security":[{"ApiKeyBearer":[]}]}