{"openapi":"3.1.0","info":{"title":"Accend API","summary":"API for Accend","description":"\nAccend API helps you do awesome stuff with your KYC compliance and finanical spreading. 🚀\n\n\n## Authentication\n\nOnce you sign up for an account, and contact Accend team for API access, our team will enable the access for you. Then you will be able to authenticate with the Accend API.\n\nYou should use the `Authorization` header to authenticate your requests. You can get your token from the Accend dashboard. The API token is visible by Admin user in the Accend dashboard, under 'Account Settings'.\n\nThe API token should be included in the `Authorization` header as a Bearer token, like this:\n\n    Authorization: Bearer YOUR_API_TOKEN\n","version":"0.1.0"},"paths":{"/api/v1/kyc/cases":{"post":{"tags":["KYC"],"summary":"Create Kyc Case","operationId":"create_kyc_case_api_v1_kyc_cases_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCaseRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["KYC"],"summary":"Get Kyc Cases","operationId":"get_kyc_cases_api_v1_kyc_cases_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCasesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kyc/cases/{case_id}":{"get":{"tags":["KYC"],"summary":"Get Kyc Case","operationId":"get_kyc_case_api_v1_kyc_cases__case_id__get","parameters":[{"name":"case_id","in":"path","required":true,"schema":{"type":"string","title":"Case Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCaseResponse-Output"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["KYC"],"summary":"Update Kyc Case","operationId":"update_kyc_case_api_v1_kyc_cases__case_id__put","parameters":[{"name":"case_id","in":"path","required":true,"schema":{"type":"string","title":"Case Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCaseResponse-Output"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kyc/feedback":{"post":{"tags":["KYC"],"summary":"Submit KYC AI feedback","description":"Submit feedback for the AI analysis tied to a case.","operationId":"submit_feedback_api_v1_kyc_feedback_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitExternalFeedbackRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Submit Feedback Api V1 Kyc Feedback Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/kyc/cases/{case_id}/task":{"post":{"tags":["KYC"],"summary":"Create KYC case task","operationId":"create_case_task_api_v1_kyc_cases__case_id__task_post","parameters":[{"name":"case_id","in":"path","required":true,"schema":{"type":"string","title":"Case Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCaseTaskRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCaseTaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers":{"post":{"tags":["Financials","Financial Customers"],"summary":"Create a new financial spreading customer","operationId":"create_customer_api_v1_financials_customers_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CreateBusinessCustomerRequest"},{"$ref":"#/components/schemas/CreateIndividualCustomerRequest"}],"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BusinessCustomerResponse"},{"$ref":"#/components/schemas/IndividualCustomerResponse"}],"discriminator":{"propertyName":"customer_type","mapping":{"business":"#/components/schemas/BusinessCustomerResponse","individual":"#/components/schemas/IndividualCustomerResponse"}},"title":"Response Create Customer Api V1 Financials Customers Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Financials","Financial Customers"],"summary":"Update a financial spreading customer","description":"provide either `external_customer_id` or `customer_id` to update the customer","operationId":"update_customer_api_v1_financials_customers_put","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UpdateCustomerRequestExt"},{"$ref":"#/components/schemas/UpdateCustomerRequest"}],"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BusinessCustomerResponse"},{"$ref":"#/components/schemas/IndividualCustomerResponse"}],"discriminator":{"propertyName":"customer_type","mapping":{"business":"#/components/schemas/BusinessCustomerResponse","individual":"#/components/schemas/IndividualCustomerResponse"}},"title":"Response Update Customer Api V1 Financials Customers Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Financials","Financial Customers"],"summary":"Get a list of financial spreading customers","description":"Get a list of financial customers.","operationId":"get_customers_api_v1_financials_customers_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":10,"title":"Limit"},"description":"Pagination limit"},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter query string. Supported filters:\n\n  - eq(external_customer_id, \"{value}\")\n  - eq(customer_id, \"{value}\")\n  - eq(customer_legal_name, \"{value}\")\n  - contains_any(link_connections, \"{value}\") - value can be \"any\", \"none\", or a comma-separated list of link connection types(quickbooks_online, xero, netsuite, freshbooks, zoho_books)\n  ","title":"Filter"},"description":"Filter query string. Supported filters:\n\n  - eq(external_customer_id, \"{value}\")\n  - eq(customer_id, \"{value}\")\n  - eq(customer_legal_name, \"{value}\")\n  - contains_any(link_connections, \"{value}\") - value can be \"any\", \"none\", or a comma-separated list of link connection types(quickbooks_online, xero, netsuite, freshbooks, zoho_books)\n  "}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomersResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/{customer_id}":{"get":{"tags":["Financials","Financial Customers"],"summary":"Get a customer by Accend Customer ID","operationId":"get_fin_customer_by_customer_id_api_v1_financials_customers__customer_id__get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BusinessCustomerResponse"},{"$ref":"#/components/schemas/IndividualCustomerResponse"}],"discriminator":{"propertyName":"customer_type","mapping":{"business":"#/components/schemas/BusinessCustomerResponse","individual":"#/components/schemas/IndividualCustomerResponse"}},"title":"Response Get Fin Customer By Customer Id Api V1 Financials Customers  Customer Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Financials","Financial Customers"],"summary":"Delete a customer by Accend Customer ID","operationId":"delete_fin_customer_by_customer_id_api_v1_financials_customers__customer_id__delete","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/access_token":{"post":{"tags":["Financials","Financial Customers","Link"],"summary":"Create a new access token for a customer","operationId":"create_customer_access_token_api_v1_financials_customers_access_token_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CreateCustomerAccessTokenRequestExt"},{"$ref":"#/components/schemas/CreateCustomerAccessTokenRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerAccessTokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/financial_statements_search":{"post":{"tags":["Financials","Financial Customers"],"summary":"Search financial statements for a business customer","description":"Search financial statements for a business customer with 'general business' chart of accounts.\nIf you are looking for financial statements for an individual customer or asset, or other custom charts of accounts structure statements, please use the 'financial statements search' endpoint instead.\nProvide either `external_customer_id` or `customer_id` to search the business financial statements.","operationId":"search_customer_financials_api_v1_financials_customers_financial_statements_search_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SearchCustomerFinancialsRequestExt"},{"$ref":"#/components/schemas/SearchCustomerFinancialsRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCustomerFinancialsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/financial_statements_search/bulk":{"post":{"tags":["Financials","Financial Customers"],"summary":"Bulk search financial statements for multiple business customers","description":"Search financial statements for up to 220 business customers in a single request. Provide either customer_ids or external_customer_ids.","operationId":"bulk_search_customer_financials_api_v1_financials_customers_financial_statements_search_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSearchCustomerFinancialsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSearchCustomerFinancialsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/{customer_id}/documents/{document_id}":{"delete":{"tags":["Financials","Financial Customers"],"summary":"Delete a financial statement document","description":"Delete a financial statement document.","operationId":"delete_fin_stmt_document_api_v1_financials_customers__customer_id__documents__document_id__delete","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/{customer_id}/combined_financials":{"get":{"tags":["Financials","Financial Customers"],"summary":"Get a customer's combined financials setup","description":"Whether the customer's financials combine other customers', and the contributing customers with their shares.","operationId":"get_combined_financials_api_v1_financials_customers__customer_id__combined_financials_get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CombinedFinancialsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Financials","Financial Customers"],"summary":"Set a customer's combined financials setup","description":"Turn combined financials on or off and replace the contributing customers, as one change: nothing is saved if any contributing customer is refused.\n\nA contributing customer must be another of your customers, on the same financial template as this one, without combined financials of its own, and not already contributing to a different customer. Turning combined financials off clears the contributing customers; combined statements already created are kept.\n\nCreate combined statements with `POST /api/v1/financials/statements/combine`.","operationId":"set_combined_financials_api_v1_financials_customers__customer_id__combined_financials_put","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetCombinedFinancialsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CombinedFinancialsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/{customer_id}/debts":{"get":{"tags":["Financials","Financial Customers","Debts"],"summary":"Get Customer Debt Overview","description":"Get all debts for a customer.","operationId":"get_customer_debt_overview_api_v1_financials_customers__customer_id__debts_get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDebtOverviewsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Financials","Financial Customers","Debts"],"summary":"Create Customer Debt","description":"Create a new customer debt record.","operationId":"create_customer_debt_api_v1_financials_customers__customer_id__debts_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ExternalPersonalDebtCreationSchema"},{"$ref":"#/components/schemas/ExternalBusinessDebtCreationSchema"}],"title":"Request"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDebtSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/{customer_id}/debts/{debt_id}":{"get":{"tags":["Financials","Financial Customers","Debts"],"summary":"Get Customer Debt","description":"Get a specific customer debt by debt_id.","operationId":"get_customer_debt_api_v1_financials_customers__customer_id__debts__debt_id__get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"debt_id","in":"path","required":true,"schema":{"type":"string","title":"Debt Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDebtSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Financials","Financial Customers","Debts"],"summary":"Update Customer Debt","description":"Update a customer debt record.","operationId":"update_customer_debt_api_v1_financials_customers__customer_id__debts__debt_id__put","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"debt_id","in":"path","required":true,"schema":{"type":"string","title":"Debt Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ExternalPersonalDebtUpdateSchema"},{"$ref":"#/components/schemas/ExternalBusinessDebtUpdateSchema"}],"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDebtSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Financials","Financial Customers","Debts"],"summary":"Delete Customer Debt","description":"Delete a customer debt record.","operationId":"delete_customer_debt_api_v1_financials_customers__customer_id__debts__debt_id__delete","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"debt_id","in":"path","required":true,"schema":{"type":"string","title":"Debt Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/{customer_id}/debts/{debt_id}/loan_events":{"post":{"tags":["Financials","Financial Customers","Debts"],"summary":"Add Customer Debt Loan Events","description":"Add a new loan event to an existing customer debt.","operationId":"add_customer_debt_loan_events_api_v1_financials_customers__customer_id__debts__debt_id__loan_events_post","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"debt_id","in":"path","required":true,"schema":{"type":"string","title":"Debt Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtLoanEventCreationRequestSchema"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDebtSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/{customer_id}/debts/{debt_id}/loan_events/{loan_event_id}":{"put":{"tags":["Financials","Financial Customers","Debts"],"summary":"Update Customer Debt Loan Event","description":"Update a loan event for a customer debt.","operationId":"update_customer_debt_loan_event_api_v1_financials_customers__customer_id__debts__debt_id__loan_events__loan_event_id__put","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"debt_id","in":"path","required":true,"schema":{"type":"string","title":"Debt Id"}},{"name":"loan_event_id","in":"path","required":true,"schema":{"type":"string","title":"Loan Event Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/DebtLoanInitialEventCreationSchema"},{"$ref":"#/components/schemas/DebtLoanAdditionalEventCreationSchema"},{"$ref":"#/components/schemas/DebtLoanTerminationEventCreationSchema"}],"discriminator":{"propertyName":"loan_event_type","mapping":{"INITIAL":"#/components/schemas/DebtLoanInitialEventCreationSchema","ADDITIONAL":"#/components/schemas/DebtLoanAdditionalEventCreationSchema","TERMINATION":"#/components/schemas/DebtLoanTerminationEventCreationSchema"}},"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDebtSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Financials","Financial Customers","Debts"],"summary":"Delete Customer Debt Loan Event","description":"Delete a loan event from a customer debt.","operationId":"delete_customer_debt_loan_event_api_v1_financials_customers__customer_id__debts__debt_id__loan_events__loan_event_id__delete","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"debt_id","in":"path","required":true,"schema":{"type":"string","title":"Debt Id"}},{"name":"loan_event_id","in":"path","required":true,"schema":{"type":"string","title":"Loan Event Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtDeleteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/data_import/source_m":{"post":{"tags":["Financials","Financial Customers"],"summary":"Import financial data from source M","operationId":"import_financial_data_from_source_m_api_v1_financials_customers_data_import_source_m_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ImportFinancialDataFromSourceMRequestExt"},{"$ref":"#/components/schemas/ImportFinancialDataFromSourceMRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpreadingCaseResultSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/customers/data_import":{"post":{"tags":["Financials","Financial Customers"],"summary":"Import financial data for a customer","operationId":"import_financial_data_api_v1_financials_customers_data_import_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/FinancialDataImportsRequestExt"},{"$ref":"#/components/schemas/FinancialDataImportsRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpreadingCaseResultSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/deals":{"post":{"tags":["Financials","Deals"],"summary":"Create a deal","description":"Create a deal with its borrower, parties, contacts and loans. The\napplicant's application is started in Accend once the deal is ready.\n\nBorrower, parties and contacts may be linked by Accend id, linked by your\nown external id, or created inline; loans are always created. One\nidempotency_key per request makes retries safe.","operationId":"createDeal","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDealCommandRequest"}}}},"responses":{"201":{"description":"Deal created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDealResponse"}}}},"200":{"description":"Replay. Returned only when the same idempotency_key is retried with an equivalent payload: the body is the stored result of the original 201 with deduplicated=true.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDealResponse"}}}},"400":{"description":"The request cannot be applied as sent; fix the payload before retrying. Codes: unknown_program, program_disabled, invalid_stage, unknown_user, ambiguous_user (candidates lists the matching user ids), duplicate_party_role, duplicate_contact_reference, customer_template_missing, deprecated_field_conflict. request_id echoes the x-request-id header when one was sent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"401":{"description":"Missing or invalid API token. FastAPI's default envelope, shared by every /api/v1 route.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailErrorResponse"}}}},"404":{"description":"reference_not_found: a link or link_or_create reference resolved to nothing and cannot be created. Resolution is strict: borrower, parties, contacts and assignments all fail the request before any write.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"409":{"description":"The request is well-formed but conflicts with existing state. Codes: idempotency_key_payload_mismatch, idempotency_conflict (retry), duplicate_deal_candidates (candidates lists the open deal ids), external_deal_id_taken, external_loan_id_taken, flagged_entity_match, customer_identity_conflict, contact_identity_conflict, customer_create_conflict and deal_create_conflict (lost a race; retry). program_cannot_activate_parties: the program onboards its parties but its published policy set has no workflow step that activates them, so a customer created here could never leave onboarding — reference existing customers by id, or have the organization publish a policy set whose onboarding path activates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Financials","Deals"],"summary":"Get a list of deals","description":"Get a paginated list of deals with optional filters.\n\nSupported filters via query params:\n- `deal_status`: filter by deal status\n- `main_borrower_id`: filter by main borrower customer ID\n- `name`: fuzzy filter by deal name (min 5 characters)","operationId":"get_deals_api_v1_financials_deals_get","security":[{"bearerAuth":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"},{"name":"deal_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/OperationalStatus"},{"type":"null"}],"description":"Filter by operational status","title":"Deal Status"},"description":"Filter by operational status"},{"name":"deal_stage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by lifecycle stage","title":"Deal Stage"},"description":"Filter by lifecycle stage"},{"name":"main_borrower_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by main borrower ID","title":"Main Borrower Id"},"description":"Filter by main borrower ID"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Fuzzy filter by deal name (min 5 chars)","title":"Name"},"description":"Fuzzy filter by deal name (min 5 chars)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Financials","Deals"],"summary":"Update a deal","description":"Provide either `deal_id` or `external_deal_id` to identify the deal to update.","operationId":"update_deal_api_v1_financials_deals_put","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UpdateDealRequestExt"},{"$ref":"#/components/schemas/UpdateDealRequest"}],"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/deals/{deal_id}":{"get":{"tags":["Financials","Deals"],"summary":"Get a deal by Accend Deal ID","operationId":"get_deal_by_deal_id_api_v1_financials_deals__deal_id__get","security":[{"bearerAuth":[]}],"parameters":[{"name":"deal_id","in":"path","required":true,"schema":{"type":"string","title":"Deal Id"}},{"name":"include","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Use artifacts to expand supporting case/model references.","title":"Include"},"description":"Use artifacts to expand supporting case/model references."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/DealSchema"},{"$ref":"#/components/schemas/PartnerDeal"}],"title":"Response Get Deal By Deal Id Api V1 Financials Deals  Deal Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/info_requests/{information_request_id}/submit":{"post":{"tags":["Financials","Deal workflow"],"summary":"Post Submit","description":"Submit exactly the selected entity sets. All sets are authorized before any\nwrite. Pending checks may finish later. By default submission never satisfies\nthem; waive_all_reqs=true accepts every live document requirement as-is,\nrequiring the organization's integration API token and all active sets to be\nselected and open. Existing credit rules and\nhuman decisions still apply. Waivers, submission and receipt commit together.\nCorrections use this same operation with a new key after replacing evidence.","operationId":"submitInformationRequest","security":[{"bearerAuth":[]}],"parameters":[{"name":"information_request_id","in":"path","required":true,"schema":{"type":"string","title":"Information Request Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitInformationRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMutationReceipt"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Conflict"},"403":{"description":"Waiving requirements requires the organization's integration API token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"200":{"description":"Immutable receipt replay; GET the information request for current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMutationReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/info_requests/{information_request_id}/documents":{"post":{"tags":["Financials","Deal workflow"],"summary":"Post Documents","description":"Attach existing customer uploads without submitting them. Automatic mode\nclassifies against the live checklist. Strict mode retains the supplied\nrequirement IDs while checking type/period compatibility. Replacements use\nexplicit old/new document pairs; omission never removes evidence. The entire\nbatch is authorized before any write. Validation runs asynchronously.","operationId":"attachInformationRequestDocuments","security":[{"bearerAuth":[]}],"parameters":[{"name":"information_request_id","in":"path","required":true,"schema":{"type":"string","title":"Information Request Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AutoAttachRequest"},{"$ref":"#/components/schemas/StrictAttachRequest"}],"discriminator":{"propertyName":"mode","mapping":{"auto_classify":"#/components/schemas/AutoAttachRequest","strict":"#/components/schemas/StrictAttachRequest"}},"title":"Request"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMutationReceipt"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Conflict"},"200":{"description":"Immutable receipt replay; a changed payload with the same key conflicts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMutationReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/info_requests/{information_request_id}":{"get":{"tags":["Financials","Deal workflow"],"summary":"Get Information Request","operationId":"getInformationRequest","security":[{"bearerAuth":[]}],"parameters":[{"name":"information_request_id","in":"path","required":true,"schema":{"type":"string","title":"Information Request Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerInformationRequest"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Conflict"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/deals/{deal_id}/events":{"get":{"tags":["Financials","Deal workflow"],"summary":"List Events","operationId":"listDealEvents","security":[{"bearerAuth":[]}],"parameters":[{"name":"deal_id","in":"path","required":true,"schema":{"type":"string","title":"Deal Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerEvents"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Conflict"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Financials","Deal workflow"],"summary":"Post Event","description":"Start permitted onboarding/manual work. Retries return the original receipt;\nuse GET for current state. Checklist materialization may still be processing.","operationId":"startDealEvent","security":[{"bearerAuth":[]}],"parameters":[{"name":"deal_id","in":"path","required":true,"schema":{"type":"string","title":"Deal Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventReceipt"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Conflict"},"200":{"description":"Immutable receipt replay, even if the event has progressed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/deals/{deal_id}/events/{event_instance_id}":{"get":{"tags":["Financials","Deal workflow"],"summary":"Get Event","operationId":"getDealEvent","security":[{"bearerAuth":[]}],"parameters":[{"name":"deal_id","in":"path","required":true,"schema":{"type":"string","title":"Deal Id"}},{"name":"event_instance_id","in":"path","required":true,"schema":{"type":"string","title":"Event Instance Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerEvent"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}},"description":"Conflict"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/record_sources":{"get":{"tags":["Financials","Record Sources"],"summary":"List Record Sources","operationId":"list_record_sources_api_v1_financials_record_sources_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceListResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Financials","Record Sources"],"summary":"Register Record Source","description":"Register a source, or restore one that was deleted.\n\nRestoring rather than refusing is forced by the key having to keep meaning\none thing: published documents and duplicate links name a source by key, so\nit is never freed for something else. A restore brings the records back with\nit and does not demand a fresh full import.","operationId":"register_record_source_api_v1_financials_record_sources_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterSourceRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"bearerAuth":[]}]}},"/api/v1/financials/record_sources/{source_key}":{"delete":{"tags":["Financials","Record Sources"],"summary":"Delete Record Source","description":"Soft-delete the source and its records together, in one transaction.\n\nReversible: POST the same key to bring both back. Nothing is purged, because\na duplicate link may still name a record here and must keep resolving.","operationId":"delete_record_source_api_v1_financials_record_sources__source_key__delete","security":[{"bearerAuth":[]}],"parameters":[{"name":"source_key","in":"path","required":true,"schema":{"type":"string","title":"Source Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/record_sources/{source_key}/imports":{"post":{"tags":["Financials","Record Sources"],"summary":"Start Import","description":"Open a batch. The source stops being searched until it completes.\n\nIdempotent: an import already open is returned rather than refused, so a\nclient retrying a request whose response it never saw resumes its batch\ninstead of opening a second feed into one dataset.","operationId":"start_import_api_v1_financials_record_sources__source_key__imports_post","security":[{"bearerAuth":[]}],"parameters":[{"name":"source_key","in":"path","required":true,"schema":{"type":"string","title":"Source Key"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/record_sources/{source_key}/imports/{import_id}/records":{"put":{"tags":["Financials","Record Sources"],"summary":"Put Records","description":"Apply one request's worth of records to the source.\n\nApplied immediately and authoritatively -- there is no staging area, which\nis exactly why the source is unsearchable until the import completes. Each\nrecord REPLACES what is stored: a field left out is cleared. All or nothing\nper request: one rejected row fails the request naming its index, so a batch\nnever lands half-applied without the caller knowing which row stopped it.","operationId":"put_records_api_v1_financials_record_sources__source_key__imports__import_id__records_put","security":[{"bearerAuth":[]}],"parameters":[{"name":"source_key","in":"path","required":true,"schema":{"type":"string","title":"Source Key"}},{"name":"import_id","in":"path","required":true,"schema":{"type":"string","title":"Import Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRecordsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyRecordsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/record_sources/{source_key}/imports/{import_id}/complete":{"post":{"tags":["Financials","Record Sources"],"summary":"Finish Import","description":"Close the batch and make everything it wrote searchable at once.","operationId":"finish_import_api_v1_financials_record_sources__source_key__imports__import_id__complete_post","security":[{"bearerAuth":[]}],"parameters":[{"name":"source_key","in":"path","required":true,"schema":{"type":"string","title":"Source Key"}},{"name":"import_id","in":"path","required":true,"schema":{"type":"string","title":"Import Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/record_sources/{source_key}/imports/{import_id}/abandon":{"post":{"tags":["Financials","Record Sources"],"summary":"Give Up On Import","description":"Give up on the batch.\n\nIt does NOT roll back: rows already applied stay applied, because the feed\nis incremental and there is no prior copy to restore. The source reports\n`incomplete` -- honest about a dataset that is neither coherent nor absent --\nand stays unsearchable until a later import completes. A source whose first\nimport never finished simply returns to `uninitialized`.","operationId":"give_up_on_import_api_v1_financials_record_sources__source_key__imports__import_id__abandon_post","security":[{"bearerAuth":[]}],"parameters":[{"name":"source_key","in":"path","required":true,"schema":{"type":"string","title":"Source Key"}},{"name":"import_id","in":"path","required":true,"schema":{"type":"string","title":"Import Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/record_sources/{source_key}/records":{"get":{"tags":["Financials","Record Sources"],"summary":"List Records","description":"Read the source back, for reconciliation against your own system.\n\nKeyset paging on `external_id` rather than an offset: an import running\nagainst the same source would shift every offset under the reader.","operationId":"list_records_api_v1_financials_record_sources__source_key__records_get","security":[{"bearerAuth":[]}],"parameters":[{"name":"source_key","in":"path","required":true,"schema":{"type":"string","title":"Source Key"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}},{"name":"after_external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After External Id"}},{"name":"include_invalidated","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Invalidated"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/record_sources/{source_key}/records/{external_id}":{"get":{"tags":["Financials","Record Sources"],"summary":"Get Record","operationId":"get_record_api_v1_financials_record_sources__source_key__records__external_id__get","security":[{"bearerAuth":[]}],"parameters":[{"name":"source_key","in":"path","required":true,"schema":{"type":"string","title":"Source Key"}},{"name":"external_id","in":"path","required":true,"schema":{"type":"string","title":"External Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecordSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/loans":{"post":{"tags":["Financials","Loans"],"summary":"Create a new loan","operationId":"create_loan_api_v1_financials_loans_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoanSchema"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Financials","Loans"],"summary":"Get a list of loans","description":"Get a paginated list of loans with optional filters.\n\nSupported filters via query params:\n- `loan_status`: filter by loan status\n- `deal_id`: filter by deal ID","operationId":"get_loans_api_v1_financials_loans_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"},{"name":"loan_status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/OperationalStatus"},{"type":"null"}],"description":"Filter by operational status","title":"Loan Status"},"description":"Filter by operational status"},{"name":"loan_stage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by lifecycle stage","title":"Loan Stage"},"description":"Filter by lifecycle stage"},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by deal ID","title":"Deal Id"},"description":"Filter by deal ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Financials","Loans"],"summary":"Update a loan","description":"Provide either `loan_id` or `external_loan_id` to identify the loan to update.","operationId":"update_loan_api_v1_financials_loans_put","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UpdateLoanRequestExt"},{"$ref":"#/components/schemas/UpdateLoanRequest"}],"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/loans/{loan_id}":{"get":{"tags":["Financials","Loans"],"summary":"Get a loan by Accend Loan ID","operationId":"get_loan_by_loan_id_api_v1_financials_loans__loan_id__get","parameters":[{"name":"loan_id","in":"path","required":true,"schema":{"type":"string","title":"Loan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoanSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/properties":{"get":{"tags":["Financials","Financial Properties"],"summary":"Get a list of properties","description":"Get a list of properties with optional filters.\n\n    - **offset**: Pagination offset (default: 0)\n    - **limit**: Maximum number of properties to return (default: 50)\n    - **property_type**: Filter by property type\n    - **address_filter**: Filter by address (fuzzy search)\n    - **customer_id**: Filter by owner customer_id","operationId":"get_properties_external_api_v1_financials_properties_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"},{"name":"property_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/PropertyType"},{"type":"null"}],"title":"Property Type"}},{"name":"address_filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Filter"}},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertiesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Financials","Financial Properties"],"summary":"Create a new property","description":"Create a new property asset.","operationId":"create_property_external_api_v1_financials_properties_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/properties/{asset_id}":{"get":{"tags":["Financials","Financial Properties"],"summary":"Get a specific property","description":"Get a specific property by asset_id.","operationId":"get_property_external_api_v1_financials_properties__asset_id__get","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","title":"Asset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Financials","Financial Properties"],"summary":"Update a property","description":"Update an existing property.","operationId":"update_property_external_api_v1_financials_properties__asset_id__put","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","title":"Asset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Property"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Financials","Financial Properties"],"summary":"Delete a property","description":"Delete a property","operationId":"delete_property_external_api_v1_financials_properties__asset_id__delete","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","title":"Asset Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/properties/{asset_id}/documents/{document_id}":{"delete":{"tags":["Financials","Financial Properties"],"summary":"Delete a financial statement document","description":"Delete a financial statement document for a property.","operationId":"delete_fin_stmt_document_property_api_v1_financials_properties__asset_id__documents__document_id__delete","parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","title":"Asset Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/upload":{"post":{"tags":["Financials","Financial Docs"],"summary":"Upload a financial statement document","description":"for each file to be uploaded, the user must provide an external customer id in the request headers.\n\n\n`x-accend-external-customer-Id`: the external customer id for the customer the file belongs to\n\n`x-accend-customer-Id`: the customer id in our system for the customer the file belongs to\n\n`x-accend-asset-Id`: the asset id in our system for the asset the file belongs to\n\none of `x-accend-external-customer-Id` or `x-accend-customer-id` or `x-accend-asset-id` must be provided in the headers.\n\nIf multiple are provided, `x-accend-external-customer-id` will be used, then `x-accend-customer-id`, then `x-accend-asset-id`.\n\n**Supported formats:** PDF, XLSX, and legacy XLS. CSV is not currently accepted on this endpoint and will return `400 Invalid file format`. XLS files are converted to XLSX before storage.\n\n**Extensions and content types:** The filename must end in `.pdf`, `.xlsx`, or `.xls` (case insensitive). Set the multipart part's `Content-Type` to the matching standard value:\n\n- PDF: `application/pdf`\n- XLSX: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`\n- XLS: `application/vnd.ms-excel`\n\n`application/octet-stream` also works; we fall back to the extension. Avoid non-standard types such as `application/x-pdf`, and don't label an `.xlsx` file as `application/vnd.ms-excel`.\n\n**Other requirements:** The request must be under 150MB. Password-protected PDFs need the password in the `x-accend-pdf-password` header.","operationId":"upload_fin_stmt_documents_api_v1_financials_upload_post","parameters":[{"name":"headers","in":"header","required":true,"schema":{"$ref":"#/components/schemas/UploadFinStmtDocumentHeaders"}},{"name":"content-length","in":"header","required":true,"schema":{"type":"integer","exclusiveMaximum":157286400,"title":"Content-Length"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_fin_stmt_documents_api_v1_financials_upload_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/upload/presigned":{"post":{"tags":["Financials","Financial Docs"],"summary":"Upload a financial statement document from an S3 presigned URL","description":"Upload a financial statement document from an S3 presigned URL.\nFile name will be extracted from the content-disposition header or the presigned URL.\nCurrently, only PDF, XLSX, and XLS files are supported. XLS files are converted to XLSX before storage. The maximum file size is 150MB.","operationId":"upload_fin_stmt_documents_through_s3_api_v1_financials_upload_presigned_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UploadS3DocumentRequestExt"},{"$ref":"#/components/schemas/UploadS3DocumentRequest"},{"$ref":"#/components/schemas/UploadS3DocumentRequestProperty"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadDocumentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/documents/{document_id}":{"get":{"tags":["Financials","Financial Docs"],"summary":"Read financial document metadata","description":"Read metadata for a previously uploaded financial document by its document_id.","operationId":"get_fin_stmt_document_metadata_api_v1_financials_documents__document_id__get","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialDocMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/documents":{"get":{"tags":["Financials","Financial Docs"],"summary":"List financial document metadata","description":"List document metadata for a customer/entity and/or a deal. Provide `entity_id` or `external_entity_id` and/or `deal_id` or `external_deal_id`. When both an entity and a deal are given, returns documents linked to the deal that are also owned by that entity.","operationId":"list_fin_stmt_documents_metadata_api_v1_financials_documents_get","parameters":[{"name":"entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Id"}},{"name":"external_entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Entity Id"}},{"name":"deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"}},{"name":"external_deal_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Deal Id"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialDocsMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cases":{"post":{"tags":["Financials","Financial Cases"],"summary":"Create a new financial spreading case","description":"Provide either `external_customer_id` or `customer_id` to create the case.\nThe limit for number of documents in a case is 30.\nThis endpoint is rate-limited to 30 transactions per minute (TPM) per organization by default.\nIf you require a higher rate limit, please contact Accend Support.\nIf the idempotency key matches an existing case for the same customer, the case will be returned and no new case will be created. If existing case is cancelled, the case will be reopened.\n\nIn the STAGING environment, the 'X-Accend-Test' header flag enables the creation of test cases that are automatically closed with a mock result.\nIn production, the header is only allowed for designated test orgs.","operationId":"create_fin_stmt_spreading_case_api_v1_financials_cases_post","parameters":[{"name":"x-accend-test","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Test flag for the case creation, if set, the case will be closed with mock result. Only available in STAGING environment.","title":"X Accend Test"},"description":"Test flag for the case creation, if set, the case will be closed with mock result. Only available in STAGING environment."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CreateFinStmtSpreadingCaseRequestExt"},{"$ref":"#/components/schemas/CreateFinStmtSpreadingCaseRequest"},{"$ref":"#/components/schemas/CreateFinStmtSpreadingCaseRequestProperty"}],"title":"Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinStmtSpreadingCaseOverviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Financials","Financial Cases"],"summary":"Get a list of financial spreading cases","description":"Get a list of financial spreading cases, cases spreading details will NOT be included.","operationId":"get_fin_stmt_spreading_cases_api_v1_financials_cases_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":10,"title":"Limit"},"description":"Pagination limit"},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter query string. Supported filters:\n\n  - eq(external_customer_id, \"{value}\")\n  - eq(customer_id, \"{value}\")\n  - eq(case_id, \"{value}\")","title":"Filter"},"description":"Filter query string. Supported filters:\n\n  - eq(external_customer_id, \"{value}\")\n  - eq(customer_id, \"{value}\")\n  - eq(case_id, \"{value}\")"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinStmtSpreadingCasesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cases/{case_id}":{"put":{"tags":["Financials","Financial Cases"],"summary":"Update a financial spreading case","description":"This endpoint is used to submit a new set of documents for an existing case. Assosicated documents can be only updated for cases in `waiting_on_client` status.","operationId":"update_fin_stmt_spreading_case_api_v1_financials_cases__case_id__put","parameters":[{"name":"case_id","in":"path","required":true,"schema":{"type":"string","title":"Case Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFinStmtSpreadingCaseRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinStmtSpreadingCaseOverviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Financials","Financial Cases"],"summary":"Get a financial spreading case details","operationId":"get_fin_stmt_spreading_case_api_v1_financials_cases__case_id__get","parameters":[{"name":"case_id","in":"path","required":true,"schema":{"type":"string","title":"Case Id"}},{"name":"target_currency","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency"}},{"name":"include","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CaseResultInclude"},"default":[],"title":"Include"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinStmtSpreadingCaseDetailsResponse-Output"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cases/{case_id}/cancel":{"put":{"tags":["Financials","Financial Cases"],"summary":"Cancel a financial spreading case","description":"Cancel a spreading case.","operationId":"cancel_fin_stmt_spreading_case_api_v1_financials_cases__case_id__cancel_put","parameters":[{"name":"case_id","in":"path","required":true,"schema":{"type":"string","title":"Case Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinStmtSpreadingCaseOverviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/link/customers/{customer_id}/link_connections":{"get":{"tags":["Financials","Link"],"summary":"Get a list of link connections for a customer","operationId":"get_link_connections_api_v1_financials_link_customers__customer_id__link_connections_get","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkConnectionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/signals":{"post":{"tags":["Financials","Financial Cases"],"summary":"Run financial signals on a case or a set of statements","operationId":"run_financial_signals_api_v1_financials_signals_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/FinancialSignalsRequestOnCase"},{"$ref":"#/components/schemas/FinancialSignalsRequestOnStatements"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/link/customers/{customer_id}/link_connections/{link_connection_id}/pass_through":{"post":{"tags":["Financials","Link"],"summary":"Pass through a request to the link integration","description":"This endpoint is used to pass through a request to the link integration. It will refresh the link connection if it is expired.\n    For Quickbooks Online, the request should be a POST request to the https://quickbooks.api.intuit.com/v3/company/{realm_id}/{endpoint} endpoint.\n    For Netsuite, the request should be a POST request to the https://{account_id}.suitetalk.api.netsuite.com/services/rest/{endpoint} endpoint.\n    For Xero, the request should be a POST request to the https://api.xero.com/api.xro/2.0/{endpoint} endpoint.\n    For Freshbooks, the request should be a POST request to the https://api.freshbooks.com/accounting/{endpoint} endpoint.\n    For Zoho Books, the request should be a POST request to the https://www.zohoapis.com/books/v3/{endpoint} endpoint.\n\n    Where {endpoint} is the endpoint field from the request.","operationId":"pass_through_request_api_v1_financials_link_customers__customer_id__link_connections__link_connection_id__pass_through_post","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"link_connection_id","in":"path","required":true,"schema":{"type":"string","title":"Link Connection Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkPassThroughRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkPassThroughResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/link/customers/{customer_id}/link_connections/{link_connection_id}/disconnect":{"post":{"tags":["Financials","Link"],"summary":"Disconnect a link connection for a customer","operationId":"disconnect_link_connection_api_api_v1_financials_link_customers__customer_id__link_connections__link_connection_id__disconnect_post","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"link_connection_id","in":"path","required":true,"schema":{"type":"string","title":"Link Connection Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/aggregates":{"post":{"tags":["Financials","Banking"],"summary":"Aggregate a borrower's banking over one or more windows","description":"Returns bucketed banking figures for each requested source family. Families are returned side by side and are NEVER combined: an entity with both a Plaid link and uploaded statements holds two independent records of the same months, and summing them roughly doubles every flow.\n\nEvery metric is present in the response even when null. `null` means the evidence was not available; `0` means it was and the figure is zero. A fully covered month in which nothing happened reports zero.","operationId":"searchBankingAggregates","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BankingAggregatesRequestExt"},{"$ref":"#/components/schemas/BankingAggregatesRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankingAggregatesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/accounts":{"get":{"tags":["Financials","Banking"],"summary":"List a borrower's bank accounts and what each one covers","description":"Discovery, so a caller can choose a sensible window before calling /aggregates. Every account is returned, including ones whose balances do not count as cash -- otherwise the excluded counts on an aggregate response cannot be explained.\n\nThe same real account may appear twice, once per source family, because the two ingest paths create separate rows. `account_number_last4` is what identifies them as the same account; nothing in the data model joins them, and their figures must not be added together.","operationId":"listBankingAccounts","parameters":[{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"}},{"name":"external_customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BankSourceFamily"},{"type":"null"}],"description":"Limit to one record. Omit to list every family; each row names its own.","title":"Source"},"description":"Limit to one record. Omit to list every family; each row names its own."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankingAccountsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/transactions":{"get":{"tags":["Financials","Banking"],"summary":"List a borrower's bank transactions","description":"A best-effort live listing. The underlying set changes as syncs land, so a single walk may skip or repeat rows. Deduplicating on (bank_account_id, txn_id) handles the repeats; a caller needing a guaranteed-complete set should re-read the window once it is quiet.\n\nPending and withdrawn transactions are excluded, so a summed ledger reconciles against the same window on /aggregates.\n\n`amount` is positive for money into the account and negative for money out. Rows come back in the account's own currency unless `target_currency` is passed, in which case they are converted at the same single rate /aggregates uses, so a summed ledger still reconciles. Each row's `currency` says which it is in.","operationId":"listBankingTransactions","parameters":[{"name":"start_period","in":"query","required":true,"schema":{"type":"string","format":"date","description":"First day of the window, inclusive.","title":"Start Period"},"description":"First day of the window, inclusive."},{"name":"end_period","in":"query","required":true,"schema":{"type":"string","format":"date","description":"Last day of the window, inclusive.","title":"End Period"},"description":"Last day of the window, inclusive."},{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"}},{"name":"external_customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/BankSourceFamily"},{"type":"null"}],"description":"Limit to one record. Omit to read every family; each row names its own, the same way GET /banking/accounts does. **Group by `source` before summing.** An entity with both a Plaid link and uploaded statements holds two independent records of the same months, so a total taken across an unfiltered ledger double-counts. To reconcile against POST /banking/aggregates, pass a single family.","title":"Source"},"description":"Limit to one record. Omit to read every family; each row names its own, the same way GET /banking/accounts does. **Group by `source` before summing.** An entity with both a Plaid link and uploaded statements holds two independent records of the same months, so a total taken across an unfiltered ledger double-counts. To reconcile against POST /banking/aggregates, pass a single family."},{"name":"bank_account_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Limit to one account, from GET /banking/accounts.","title":"Bank Account Id"},"description":"Limit to one account, from GET /banking/accounts."},{"name":"target_currency","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":3,"maxLength":3},{"type":"null"}],"description":"Convert `amount` and `running_balance` to this currency, at one rate for the whole window -- the same conversion POST /banking/aggregates does, so a summed ledger still reconciles to the converted totals. Omit it to get each row in its account's own currency, which is what the customer's statement shows.","title":"Target Currency"},"description":"Convert `amount` and `running_balance` to this currency, at one rate for the whole window -- the same conversion POST /banking/aggregates does, so a summed ledger still reconciles to the converted totals. Omit it to get each row in its account's own currency, which is what the customer's statement shows."},{"name":"include_ineligible_accounts","in":"query","required":false,"schema":{"type":"boolean","description":"Rows from accounts whose balances are not cash. True by default: a credit-card transaction is real activity even though its balance does not count toward a cash total. Set false to reconcile a ledger against an /aggregates figure.","default":true,"title":"Include Ineligible Accounts"},"description":"Rows from accounts whose balances are not cash. True by default: a credit-card transaction is real activity even though its balance does not count toward a cash total. Set false to reconcile a ledger against an /aggregates figure."},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankingTransactionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/imports":{"post":{"tags":["Financials","Banking"],"summary":"Open an import job for one borrower","description":"Returns `201` with the job, status `open`, or `200` with the same job (`deduplicated: true`) for a retried idempotency_key. A borrower has at most one open job: a second is `409 import_already_open`, naming it.","operationId":"openBankingImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportOpenRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportJobWriteResponse"}}}},"409":{"description":"Conflicts with a job, batch or account already stored; resending unchanged fails again. Codes: idempotency_key_payload_mismatch, import_already_open, import_closed, batch_payload_mismatch, completion_mismatch, account_identity_conflict, account_format_mismatch, account_currency_changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/imports/{import_id}/batches/{sequence}/plaid":{"put":{"tags":["Financials","Banking"],"summary":"Add a batch: a Plaid /transactions/get or /transactions/sync body","description":"The body is a Plaid response, unchanged: `accounts` with `transactions`, or with `added`, `modified` and `removed`. Plaid's sign convention applies (positive = money out); we flip it. Returns `201` with the receipt, or `200` with the original receipt for a retry of the same sequence. Categorization runs in the background; nothing is visible until the job publishes.","operationId":"putBankingImportPlaidBatch","parameters":[{"name":"import_id","in":"path","required":true,"schema":{"type":"string","maxLength":64,"title":"Import Id"}},{"name":"sequence","in":"path","required":true,"schema":{"type":"integer","maximum":2147483647,"minimum":1,"description":"Your number for this batch, unique within the job.","title":"Sequence"},"description":"Your number for this batch, unique within the job."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaidBatchRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportBatchReceipt"}}}},"409":{"description":"Conflicts with a job, batch or account already stored; resending unchanged fails again. Codes: idempotency_key_payload_mismatch, import_already_open, import_closed, batch_payload_mismatch, completion_mismatch, account_identity_conflict, account_format_mismatch, account_currency_changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/imports/{import_id}/batches/{sequence}/generic":{"put":{"tags":["Financials","Banking"],"summary":"Add a batch: the generic shape","description":"`amount` is positive for money INTO the account. Every transaction names an account listed in `accounts`; `removed` may also name an account already published. Returns `201` with the receipt, or `200` with the original receipt for a retry of the same sequence.","operationId":"putBankingImportGenericBatch","parameters":[{"name":"import_id","in":"path","required":true,"schema":{"type":"string","maxLength":64,"title":"Import Id"}},{"name":"sequence","in":"path","required":true,"schema":{"type":"integer","maximum":2147483647,"minimum":1,"description":"Your number for this batch, unique within the job.","title":"Sequence"},"description":"Your number for this batch, unique within the job."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericBatchRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportBatchReceipt"}}}},"409":{"description":"Conflicts with a job, batch or account already stored; resending unchanged fails again. Codes: idempotency_key_payload_mismatch, import_already_open, import_closed, batch_payload_mismatch, completion_mismatch, account_identity_conflict, account_format_mismatch, account_currency_changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/imports/{import_id}/complete":{"post":{"tags":["Financials","Banking"],"summary":"Close the job, declare coverage and closing balances, and publish","description":"Lists every batch sequence sent, and optionally the accounts to delete or reset and the coverage to declare or retract, and `balances`: a covered account's closing balance at the end of its last covered day once this job applies, owed whenever the job moves that day or resets the account. Months of a deposit account are then given balances rolled back from it, labelled `reconstructed`. Returns `202` with the job, status `publishing`; it becomes `completed` once published. A retry with the same body returns `200`.","operationId":"completeBankingImport","parameters":[{"name":"import_id","in":"path","required":true,"schema":{"type":"string","maxLength":64,"title":"Import Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportCompleteRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportJobWriteResponse"}}}},"409":{"description":"Conflicts with a job, batch or account already stored; resending unchanged fails again. Codes: idempotency_key_payload_mismatch, import_already_open, import_closed, batch_payload_mismatch, completion_mismatch, account_identity_conflict, account_format_mismatch, account_currency_changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"422":{"description":"A rule the request breaks. Codes: sequences_mismatch (with missing_sequences and unexpected_sequences), account_unknown, account_listed_twice, coverage_range_invalid, deleted_account_in_use, balance_required, balance_date_mismatch, balance_without_coverage. A malformed body is FastAPI's own 422.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportCompleteErrorResponse"}}}}}}},"/api/v1/financials/banking/imports/{import_id}/cancel":{"post":{"tags":["Financials","Banking"],"summary":"Abandon an open job","description":"Discards everything the job staged; published data is untouched. Cancelling a cancelled job returns it again; a job past `complete` is `409 import_closed`.","operationId":"cancelBankingImport","parameters":[{"name":"import_id","in":"path","required":true,"schema":{"type":"string","maxLength":64,"title":"Import Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportJobWriteResponse"}}}},"409":{"description":"Conflicts with a job, batch or account already stored; resending unchanged fails again. Codes: idempotency_key_payload_mismatch, import_already_open, import_closed, batch_payload_mismatch, completion_mismatch, account_identity_conflict, account_format_mismatch, account_currency_changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructuredErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/banking/imports/{import_id}":{"get":{"tags":["Financials","Banking"],"summary":"Get an import job","operationId":"getBankingImport","parameters":[{"name":"import_id","in":"path","required":true,"schema":{"type":"string","maxLength":64,"title":"Import Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankImportJob"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_reports/imports/quickbooks_online":{"post":{"tags":["Financials","Financial Reports"],"summary":"Import monthly reports from QuickBooks Online responses","description":"`chart_of_accounts` is the Account query response; each report is a one-month BalanceSheet or ProfitAndLoss response with two columns. The accounting basis comes from each report's Header.ReportBasis. Validates, converts and stores every report before responding. Returns `201` with the receipt, or `200` with the original receipt (`deduplicated: true`) when the idempotency_key was already used for the same reports. Rule failures are a `422`, and conflicts with stored data a `409`, both with a `{code, message, field, candidates}` body.","operationId":"createFinReportQuickBooksImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickBooksImportRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinReportImportReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_reports/imports/xero":{"post":{"tags":["Financials","Financial Reports"],"summary":"Import monthly reports from Xero responses","description":"`chart_of_accounts` is the /Accounts response; each report is a one-month ProfitAndLoss or BalanceSheet response, with its period. Validates, converts and stores every report before responding. Returns `201` with the receipt, or `200` with the original receipt (`deduplicated: true`) when the idempotency_key was already used for the same reports. Rule failures are a `422`, and conflicts with stored data a `409`, both with a `{code, message, field, candidates}` body.","operationId":"createFinReportXeroImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/XeroImportRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinReportImportReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_reports/imports/zoho_books":{"post":{"tags":["Financials","Financial Reports"],"summary":"Import monthly reports from Zoho Books responses","description":"`chart_of_accounts` is the chartofaccounts response; each report is a one-month profitandloss or balancesheet response, with its period. Validates, converts and stores every report before responding. Returns `201` with the receipt, or `200` with the original receipt (`deduplicated: true`) when the idempotency_key was already used for the same reports. Rule failures are a `422`, and conflicts with stored data a `409`, both with a `{code, message, field, candidates}` body.","operationId":"createFinReportZohoBooksImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZohoBooksImportRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinReportImportReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_reports/imports/freshbooks":{"post":{"tags":["Financials","Financial Reports"],"summary":"Import monthly reports from FreshBooks responses","description":"Each report is the result object of a profit_and_loss or balance_sheet response. A monthly-resolution profit and loss is split into its months. Validates, converts and stores every report before responding. Returns `201` with the receipt, or `200` with the original receipt (`deduplicated: true`) when the idempotency_key was already used for the same reports. Rule failures are a `422`, and conflicts with stored data a `409`, both with a `{code, message, field, candidates}` body.","operationId":"createFinReportFreshBooksImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FreshBooksImportRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinReportImportReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_reports/imports":{"post":{"tags":["Financials","Financial Reports"],"summary":"Import monthly reports as debit/credit ledger balances","description":"For any ERP without a provider route. Amounts are ledger balances, debits positive and credits negative; liability, equity and income rows are negated into statement sign. Validates, converts and stores every report before responding. Returns `201` with the receipt, or `200` with the original receipt (`deduplicated: true`) when the idempotency_key was already used for the same reports. Rule failures are a `422`, and conflicts with stored data a `409`, both with a `{code, message, field, candidates}` body.","operationId":"createFinReportImport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericImportRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinReportImportReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_reports/imports/{import_id}":{"get":{"tags":["Financials","Financial Reports"],"summary":"Get an import's receipt","operationId":"getFinReportImport","parameters":[{"name":"import_id","in":"path","required":true,"schema":{"type":"string","title":"Import Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinReportImportReceipt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_reports":{"get":{"tags":["Financials","Financial Reports"],"summary":"List a borrower's stored monthly reports","description":"Every month triage can read for the borrower, from imports (`source: import`) and Accend Link connections (`source: link`), newest first, in the currency each was stored in. Cash flow statements are not listed; cases derive them.","operationId":"listFinReports","parameters":[{"name":"customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"}},{"name":"external_customer_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"}},{"name":"statement_type","in":"query","required":false,"schema":{"anyOf":[{"enum":["balance_sheet","income_statement"],"type":"string"},{"type":"null"}],"title":"Statement Type"}},{"name":"start_period","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Period"}},{"name":"end_period","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Period"}},{"name":"include_rows","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Rows"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFinReportsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/search":{"post":{"tags":["Financials","Financial Statements"],"summary":"Search financial statements","description":"The endpoint supports searching for Accend charts of accounts structure statements.\n    If you are looking for financial statements business, individual or asset financials, or custom charts of accounts structure statements, this is the endpoint to use.","operationId":"search_statements_api_v1_financials_statements_search_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/SearchCustomerFinancialsRequestExt"},{"$ref":"#/components/schemas/SearchCustomerFinancialsRequest"},{"$ref":"#/components/schemas/SearchAssetFinancialsRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchStatementsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/search/bulk":{"post":{"tags":["Financials","Financial Statements"],"summary":"Bulk search financial statements for multiple entities","description":"Search financial statements for up to 220 entities in a single request. Provide either customer_ids or external_customer_ids.","operationId":"bulk_search_statements_api_v1_financials_statements_search_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSearchStatementsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSearchStatementsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/bulk_get":{"post":{"tags":["Financials","Financial Statements"],"summary":"Bulk get financial statements by IDs","description":"Get multiple financial statements by their statement IDs.\n    This endpoint retrieves specific statements for a customer or asset.","operationId":"bulk_get_statements_api_v1_financials_statements_bulk_get_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/BulkGetCustomerFinancialsRequestExt"},{"$ref":"#/components/schemas/BulkGetCustomerFinancialsRequest"},{"$ref":"#/components/schemas/BulkGetAssetFinancialsRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoaStatementsWithChartOfAccountsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/combine":{"post":{"tags":["Financials","Financial Statements"],"summary":"Combine contributing customers' financial statements","description":"Create or update a customer's combined financial statements from its contributing customers' statements.\n\nSet up the contributing customers and their shares first, with `PUT /api/v1/financials/customers/{customer_id}/combined_financials`. Each entry of `statements` gives a period and one statement of that period from each contributing customer; each statement's amounts are weighted by its customer's share, converted into the main customer's currency, and summed. A combined statement is recalculated when one of its contributing statements changes.","operationId":"combine_statements_api_v1_financials_statements_combine_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CombineStatementsRequestExt"},{"$ref":"#/components/schemas/CombineStatementsRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoaStatementsWithChartOfAccountsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/line_item_notes/bulk_get":{"post":{"tags":["Financials","Financial Statements"],"summary":"Bulk get statements' line item notes by statement IDs","description":"Bulk get statements' line item notes by their statement IDs.\n    This endpoint retrieves line item notes for multiple statements belonging to the same entity.","operationId":"bulk_get_statements_line_item_notes_api_v1_financials_statements_line_item_notes_bulk_get_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLineItemNotesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemNotesExternalResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/reclassify":{"post":{"tags":["Financials","Financial Statements"],"summary":"Reclassify financial statements","description":"Reclassify source line items in financial statements by updating their account mappings.\n    This endpoint allows you to change how line items are classified to different accounts.","operationId":"reclassify_statements_api_v1_financials_statements_reclassify_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ReclassifyStatementsRequestExt"},{"$ref":"#/components/schemas/ReclassifyStatementsRequest"},{"$ref":"#/components/schemas/ReclassifyStatementsRequestAsset"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoaStatementsWithChartOfAccountsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/account_overrides/bulk_upsert":{"post":{"tags":["Financials","Financial Statements"],"summary":"Bulk upsert account overrides for statements","description":"Bulk upsert account overriden values for statements.\n    This endpoint upserts account overriden values for multiple statements belonging to the same entity.","operationId":"bulk_upsert_account_overrides_api_v1_financials_statements_account_overrides_bulk_upsert_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkAccountOverrideUpsertRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoaStatementsWithChartOfAccountsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/statements/gen_rolling_statements":{"post":{"tags":["Financials","Financial Statements"],"summary":"Generate rolling or annualized financial statements","description":"Generate a rolling (trailing-twelve-month) or annualized financial statement\n    for a customer or asset. The result is a single calculated statement that is persisted (upsert, no merge).","operationId":"gen_rolling_statements_api_v1_financials_statements_gen_rolling_statements_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GenAnnualizedStatementsRequestExt"},{"$ref":"#/components/schemas/GenAnnualizedStatementsRequest"},{"$ref":"#/components/schemas/GenAnnualizedStatementsAssetRequest"},{"$ref":"#/components/schemas/GenRollingStatementsRequestExt"},{"$ref":"#/components/schemas/GenRollingStatementsRequest"},{"$ref":"#/components/schemas/GenRollingStatementsAssetRequest"}],"title":"Request"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoaStatementWithSourcesSchema-Output"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/templates/financial_templates":{"get":{"tags":["Financials","Financial Templates"],"summary":"Get Financial Templates","description":"Get all financial templates overview.","operationId":"get_financial_templates_api_v1_financials_templates_financial_templates_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllFinTmplOverviewResponse"}}}}}}},"/api/v1/financials/templates/financial_templates/{fin_tmpl_key}":{"get":{"tags":["Financials","Financial Templates"],"summary":"Get Financial Template","description":"Get a specific financial template with full details.","operationId":"get_financial_template_api_v1_financials_templates_financial_templates__fin_tmpl_key__get","parameters":[{"name":"fin_tmpl_key","in":"path","required":true,"schema":{"type":"string","title":"Fin Tmpl Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialTemplateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cash_flow_scenarios/spread/cash_flow_scenarios":{"post":{"tags":["Financials","Global Cash Flow Scenarios"],"summary":"Create Cash Flow Scenario","description":"Create a new cash flow scenario.","operationId":"create_cash_flow_scenario_api_v1_financials_cash_flow_scenarios_spread_cash_flow_scenarios_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/CustomerCashFlowScenarioCreationSchema"},{"$ref":"#/components/schemas/PropertyCashFlowScenarioCreationSchema"}],"title":"Request"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowScenarioSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cash_flow_scenarios/spread/cash_flow_scenarios/{scenario_id}/setting":{"put":{"tags":["Financials","Global Cash Flow Scenarios"],"summary":"Update Cash Flow Scenario Setting","description":"Update cash flow scenario settings.","operationId":"update_cash_flow_scenario_setting_api_v1_financials_cash_flow_scenarios_spread_cash_flow_scenarios__scenario_id__setting_put","parameters":[{"name":"scenario_id","in":"path","required":true,"schema":{"type":"string","title":"Scenario Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowScenarioUpdateSettingSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowScenarioSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cash_flow_scenarios":{"get":{"tags":["Financials","Global Cash Flow Scenarios"],"summary":"Get Cash Flow Scenarios","description":"Get a list of cash flow scenarios.","operationId":"get_cash_flow_scenarios_api_v1_financials_cash_flow_scenarios_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"Pagination limit","default":10,"title":"Limit"},"description":"Pagination limit"},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter query string. Supported filters:\n  - eq(customer_id, \"{value}\")\n  - eq(property_id, \"{value}\")\n  ","title":"Filter"},"description":"Filter query string. Supported filters:\n  - eq(customer_id, \"{value}\")\n  - eq(property_id, \"{value}\")\n  "}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowScenarioListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cash_flow_scenarios/{scenario_id}":{"get":{"tags":["Financials","Global Cash Flow Scenarios"],"summary":"Get Cash Flow Scenario","description":"Get a specific cash flow scenario with full details.","operationId":"get_cash_flow_scenario_api_v1_financials_cash_flow_scenarios__scenario_id__get","parameters":[{"name":"scenario_id","in":"path","required":true,"schema":{"type":"string","title":"Scenario Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowScenarioSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/cash_flow_scenarios/{scenario_id}/refresh":{"post":{"tags":["Financials","Global Cash Flow Scenarios"],"summary":"Refresh Cash Flow Scenario","description":"Refresh a cash flow scenario by fetching the latest data from the source statements and regenerating cash flow scenario data.","operationId":"refresh_cash_flow_scenario_api_v1_financials_cash_flow_scenarios__scenario_id__refresh_post","parameters":[{"name":"scenario_id","in":"path","required":true,"schema":{"type":"string","title":"Scenario Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashFlowScenarioSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_model/results":{"get":{"tags":["Financials","Financial Models"],"summary":"Query financial model results","description":"Query completed financial model run results for a template.\n\nSupported filters via query params:\n- `fin_model_template_key`: required template key\n- `created_after`: only include runs created at or after this datetime\n- `created_before`: only include runs created at or before this datetime\n- `filters`: output filters in format `key:operator:value` comma-separated\n- `entity_id`: filter by entity ID\n- `external_entity_id`: filter by external entity(customer) ID","operationId":"query_fin_model_results_api_v1_financials_fin_model_results_get","parameters":[{"name":"fin_model_template_key","in":"query","required":true,"schema":{"type":"string","description":"Financial model template key","title":"Fin Model Template Key"},"description":"Financial model template key"},{"name":"created_after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created after this datetime","title":"Created After"},"description":"Filter runs created after this datetime"},{"name":"created_before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter runs created before this datetime","title":"Created Before"},"description":"Filter runs created before this datetime"},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Output filters in format 'key:op:value' comma-separated. Ops: eq,neq,gt,lt,gte,lte,btw.","title":"Filters"},"description":"Output filters in format 'key:op:value' comma-separated. Ops: eq,neq,gt,lt,gte,lte,btw."},{"name":"entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by entity ID","title":"Entity Id"},"description":"Filter by entity ID"},{"name":"external_entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by external entity(customer) ID","title":"External Entity Id"},"description":"Filter by external entity(customer) ID"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalFinModelRunResultListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_model/runs":{"get":{"tags":["Financials","Financial Models"],"summary":"List financial model runs","description":"Get a paginated list of financial model runs with optional filters.\n\nSupported filters via query params:\n- `status`: filter by run status\n- `entity_id`: filter by entity ID\n- `external_entity_id`: filter by external entity(customer) ID","operationId":"list_fin_model_runs_api_v1_financials_fin_model_runs_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FinModelRunStatus"},{"type":"null"}],"description":"Filter by status","title":"Status"},"description":"Filter by status"},{"name":"entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by entity ID","title":"Entity Id"},"description":"Filter by entity ID"},{"name":"external_entity_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by external customer ID","title":"External Entity Id"},"description":"Filter by external customer ID"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinModelRunListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Financials","Financial Models"],"summary":"Create a financial model run","operationId":"create_fin_model_run_api_v1_financials_fin_model_runs_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCreateFinModelRunRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinModelRunOverviewSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_model/runs/{fin_model_run_id}":{"get":{"tags":["Financials","Financial Models"],"summary":"Get a financial model run","operationId":"get_fin_model_run_api_v1_financials_fin_model_runs__fin_model_run_id__get","parameters":[{"name":"fin_model_run_id","in":"path","required":true,"schema":{"type":"string","title":"Fin Model Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalFinModelRunSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Financials","Financial Models"],"summary":"Delete a financial model run","operationId":"delete_fin_model_run_api_v1_financials_fin_model_runs__fin_model_run_id__delete","parameters":[{"name":"fin_model_run_id","in":"path","required":true,"schema":{"type":"string","title":"Fin Model Run Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_model/runs/{fin_model_run_id}/execute":{"post":{"tags":["Financials","Financial Models"],"summary":"Execute a financial model run","operationId":"execute_fin_model_run_api_v1_financials_fin_model_runs__fin_model_run_id__execute_post","parameters":[{"name":"fin_model_run_id","in":"path","required":true,"schema":{"type":"string","title":"Fin Model Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalFinModelRunSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/fin_model/templates":{"get":{"tags":["Financials","Financial Models"],"summary":"List financial model templates","operationId":"list_fin_model_templates_api_v1_financials_fin_model_templates_get","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"Pagination offset","default":0,"title":"Offset"},"description":"Pagination offset"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Pagination limit","default":50,"title":"Limit"},"description":"Pagination limit"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinModelTemplateListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/financials/data_room/applicant_events":{"get":{"tags":["Financials","Data Room"],"summary":"Pull applicant-portal action events","description":"Cursor-paginated pull feed of applicant actions in the data-room portal (request opened, application submitted, document uploaded, ...), for ingestion into your own analytics platform.\n\nEvents are append-only with strictly-increasing integer `id`s. Persist the response's `next_since_id` and pass it back as `since_id` on the next call; repeat while `has_more` is true. Replays are idempotent by `id`.\n\nEach event maps 1:1 onto an analytics `track` call: `event` is the track name (lowercase snake_case), `timestamp` the event time, `deal_id` / `deal_info_req_id` / `contact_id` / `contact_email` the identities, and `properties` the event-specific payload. Contact fields are only set for email-verified portal sessions; anonymous link sessions carry none by design.","operationId":"pull_applicant_events_api_v1_financials_data_room_applicant_events_get","parameters":[{"name":"since_id","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Since Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":500,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicantEventsFeedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"webhooks":{"case-event":{"post":{"tags":["KYC"],"summary":"Case Process Completion Event","description":"HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers:\n\n`x-accend-signature-256`: This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key.\n\n`x-accend-event-type`: This header will contain the type of event that triggered the delivery.\n\n`x-accend-idempotency-key`: This header will contain the idempotency key of the request.","operationId":"case_process_completion_eventcase_event_post","parameters":[{"description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key.","required":true,"schema":{"type":"string","title":"X-Accend-Signature-256","description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key."},"name":"x-accend-signature-256","in":"header"},{"description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events","required":true,"schema":{"type":"string","title":"X-Accend-Event-Type","description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events"},"name":"x-accend-event-type","in":"header"},{"description":"This header will contain the idempotency key of the request.","required":true,"schema":{"type":"string","title":"X-Accend-Idempotency-Key","description":"This header will contain the idempotency key of the request."},"name":"x-accend-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalCaseResponse-Input"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"financial_statement_cases_event":{"post":{"tags":["Financials"],"summary":"Financial statement case process completion event","description":"HTTP POST payloads that are delivered to your webhook's configured URL endpoint.","operationId":"financial_statement_case_process_completion_eventfinancial_statement_cases_event_post","parameters":[{"description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key.","required":true,"schema":{"type":"string","title":"X-Accend-Signature-256","description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key."},"name":"x-accend-signature-256","in":"header"},{"description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events","required":true,"schema":{"type":"string","title":"X-Accend-Event-Type","description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events"},"name":"x-accend-event-type","in":"header"},{"description":"This header will contain the idempotency key of the request.","required":true,"schema":{"type":"string","title":"X-Accend-Idempotency-Key","description":"This header will contain the idempotency key of the request."},"name":"x-accend-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinStmtSpreadingCaseDetailsResponse-Input"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"link_sync_completion_event":{"post":{"tags":["Financials","Link"],"summary":"Link connection completed event","description":"HTTP POST payloads that are delivered to your webhook's configured URL endpoint.","operationId":"link_connection_completed_eventlink_sync_completion_event_post","parameters":[{"description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key.","required":true,"schema":{"type":"string","title":"X-Accend-Signature-256","description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key."},"name":"x-accend-signature-256","in":"header"},{"description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events","required":true,"schema":{"type":"string","title":"X-Accend-Event-Type","description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events"},"name":"x-accend-event-type","in":"header"},{"description":"This header will contain the idempotency key of the request.","required":true,"schema":{"type":"string","title":"X-Accend-Idempotency-Key","description":"This header will contain the idempotency key of the request."},"name":"x-accend-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSyncCompletionEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"link_sync_error_event":{"post":{"tags":["Financials","Link"],"summary":"Link connection error event","description":"HTTP POST payloads that are delivered to your webhook's configured URL endpoint.","operationId":"link_connection_error_eventlink_sync_error_event_post","parameters":[{"description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key.","required":true,"schema":{"type":"string","title":"X-Accend-Signature-256","description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key."},"name":"x-accend-signature-256","in":"header"},{"description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events","required":true,"schema":{"type":"string","title":"X-Accend-Event-Type","description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events"},"name":"x-accend-event-type","in":"header"},{"description":"This header will contain the idempotency key of the request.","required":true,"schema":{"type":"string","title":"X-Accend-Idempotency-Key","description":"This header will contain the idempotency key of the request."},"name":"x-accend-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSyncErrorEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"automation_run_completion_event":{"post":{"tags":["Automations"],"summary":"Automation run completion event","description":"HTTP POST payloads that are delivered to your webhook's configured URL endpoint.","operationId":"automation_run_completion_eventautomation_run_completion_event_post","parameters":[{"description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key.","required":true,"schema":{"type":"string","title":"X-Accend-Signature-256","description":"This is the HMAC hex digest of the request body, and is generated using the SHA-256 hash function and your `api token` as the HMAC key."},"name":"x-accend-signature-256","in":"header"},{"description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events","required":true,"schema":{"type":"string","title":"X-Accend-Event-Type","description":"This header will contain the type of event that triggered the delivery. supported values: 'case-event' for KYC cases completion, 'financial_statement_cases_event' for financial statement cases completion, 'link_sync_completion_event' for link sync completion events, 'automation_run_completion_event' for automation run completion events"},"name":"x-accend-event-type","in":"header"},{"description":"This header will contain the idempotency key of the request.","required":true,"schema":{"type":"string","title":"X-Accend-Idempotency-Key","description":"This header will contain the idempotency key of the request."},"name":"x-accend-idempotency-key","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationRunCompletionEvent"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AccountGroupingSchema":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"account_keys":{"items":{"type":"string"},"type":"array","title":"Account Keys"}},"type":"object","required":["key","name","account_keys"],"title":"AccountGroupingSchema"},"AccountOverride":{"properties":{"coa_account_key":{"type":"string","title":"Coa Account Key"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"string_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"String Value"},"boolean_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Boolean Value"},"date_value":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date Value"}},"type":"object","required":["coa_account_key"],"title":"AccountOverride"},"AccountTypeGroupingSchema":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"fin_tmpl_account_class_key":{"type":"string","title":"Fin Tmpl Account Class Key"},"account_keys":{"items":{"type":"string"},"type":"array","title":"Account Keys"}},"type":"object","required":["key","name","fin_tmpl_account_class_key","account_keys"],"title":"AccountTypeGroupingSchema"},"AdditionalPartyRole":{"type":"string","enum":["co_borrower","guarantor","sponsor","party"],"title":"AdditionalPartyRole","description":"DealPartyRole minus ``borrower``.\n\n``parties`` is defined as everyone except the main borrower, which is\nappended automatically with that role, so accepting it here would be\ncontradictory."},"AddressVerificationResult":{"properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"region_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region Code"},"lat_long":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lat Long"},"address_type":{"anyOf":[{"type":"string","enum":["BUSINESS","RESIDENTIAL","PO_BOX","CMRA","REGISTERED_AGENT"]},{"type":"null"}],"title":"Address Type","description":"The type of the address."},"is_restricted_region":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Restricted Region","description":"Whether the address is in a restricted region."}},"type":"object","title":"AddressVerificationResult"},"AggregateBalanceBasis":{"type":"string","enum":["stated","reconstructed","mixed"],"title":"AggregateBalanceBasis","description":"What the balances in a bucket rest on: a figure printed on a statement,\none rolled back from a point-in-time reading, or both within one bucket."},"AllFinTmplOverviewResponse":{"properties":{"fin_templates":{"items":{"$ref":"#/components/schemas/FinTmplOverviewResponse"},"type":"array","title":"Fin Templates"}},"type":"object","required":["fin_templates"],"title":"AllFinTmplOverviewResponse"},"ApiSource":{"properties":{"external_id":{"type":"string","maxLength":255,"minLength":1,"title":"External Id","description":"Your stable id for the books, for example `qbo:realm-9130354`"},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name"}},"additionalProperties":false,"type":"object","required":["external_id"],"title":"ApiSource"},"ApplicantEventSchema":{"properties":{"id":{"type":"integer","title":"Id"},"event":{"type":"string","title":"Event"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"org_id":{"type":"string","title":"Org Id"},"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"},"deal_info_req_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Info Req Id"},"request_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Name"},"actor_kind":{"type":"string","title":"Actor Kind"},"contact_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Id"},"contact_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contact Email"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties"}},"type":"object","required":["id","event","timestamp","org_id","actor_kind"],"title":"ApplicantEventSchema","description":"Segment-track-friendly event shape: ``event`` is the track name,\n``properties`` passes through, ids/contact fields map to identities."},"ApplicantEventsFeedResponse":{"properties":{"events":{"items":{"$ref":"#/components/schemas/ApplicantEventSchema"},"type":"array","title":"Events"},"next_since_id":{"type":"integer","title":"Next Since Id"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["events","next_since_id","has_more"],"title":"ApplicantEventsFeedResponse","description":"Cursor page of the external pull feed. Consumers persist\n``next_since_id`` and pass it back; ids are strictly increasing, so\nreplays are idempotent by id."},"ApplicationExtended":{"properties":{"legal_name":{"type":"string","title":"Legal Name","description":"The company's legal name"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dba Name","description":"The company's DBA name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"The company's complete address, example: 123 Main St, Austin, TX 78701, USA"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"The company's website"},"business_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Description","description":"The company's business description"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Number","description":"The company's registration number"},"ein":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ein","description":"The company's EIN"},"industry_codes":{"anyOf":[{"items":{"$ref":"#/components/schemas/models__models__IndustryCode"},"type":"array"},{"type":"null"}],"title":"Industry Codes","description":"The company's industry codes"},"phone_numbers":{"anyOf":[{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array"},{"type":"null"}],"title":"Phone Numbers","description":"The company's phone numbers"},"main_applicant":{"$ref":"#/components/schemas/ApplicationPerson","description":"The company's main applicant"},"beneficial_owners":{"items":{"$ref":"#/components/schemas/ApplicationPerson"},"type":"array","title":"Beneficial Owners","description":"The company's beneficial owners","default":[]},"controlling_officers":{"items":{"$ref":"#/components/schemas/ApplicationPerson"},"type":"array","title":"Controlling Officers","description":"The company's controlling officers","default":[]},"ownership_info":{"anyOf":[{"$ref":"#/components/schemas/OwnershipInformation-Input"},{"type":"null"}]}},"type":"object","required":["legal_name","main_applicant"],"title":"ApplicationExtended"},"ApplicationPerson":{"properties":{"name":{"type":"string","title":"Name","description":"The person's legal name"},"dob":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dob","description":"The person's date of birth. in MM/DD/YYYY format"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The person's email used to register"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"The person's address"},"national_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"National Id","description":"The person's national id"}},"type":"object","required":["name"],"title":"ApplicationPerson","description":"Identifying information about a person."},"ApplyRecordsRequest":{"properties":{"records":{"items":{"$ref":"#/components/schemas/RecordUpsert"},"type":"array","maxItems":500,"minItems":1,"title":"Records"}},"type":"object","required":["records"],"title":"ApplyRecordsRequest"},"ApplyRecordsResponse":{"properties":{"import_id":{"type":"string","title":"Import Id"},"applied":{"type":"integer","title":"Applied","description":"Records created, updated or invalidated."}},"type":"object","required":["import_id","applied"],"title":"ApplyRecordsResponse"},"AssetValuation":{"properties":{"asset_id":{"type":"string","title":"Asset Id"},"valuation_id":{"type":"string","title":"Valuation Id"},"valuation_date":{"type":"string","format":"date-time","title":"Valuation Date"},"valuation_type":{"$ref":"#/components/schemas/AssetValuationType"},"valuation_amount":{"type":"number","title":"Valuation Amount"},"discount_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Discount Rate"}},"type":"object","required":["asset_id","valuation_id","valuation_date","valuation_type","valuation_amount"],"title":"AssetValuation"},"AssetValuationCreate":{"properties":{"valuation_date":{"type":"string","format":"date","title":"Valuation Date"},"valuation_amount":{"type":"number","title":"Valuation Amount"},"discount_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Discount Rate"},"valuation_type":{"$ref":"#/components/schemas/AssetValuationType"}},"type":"object","required":["valuation_date","valuation_amount","valuation_type"],"title":"AssetValuationCreate"},"AssetValuationType":{"type":"string","enum":["appraised","market","other"],"title":"AssetValuationType"},"Assignments":{"properties":{"analyst":{"anyOf":[{"$ref":"#/components/schemas/UserRef"},{"type":"null"}]},"secondary_analyst":{"anyOf":[{"$ref":"#/components/schemas/UserRef"},{"type":"null"}]},"sales_rep":{"anyOf":[{"$ref":"#/components/schemas/UserRef"},{"type":"null"}]}},"type":"object","title":"Assignments","description":"The deal's three assignable roles, each optional and independent.\n\nAnything left out is decided the way it would be without this call: the\npolicy workflow routes unfilled analyst slots after commit. An explicitly\nnamed user is not overwritten by that routing."},"AutoAttachRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"mode":{"type":"string","const":"auto_classify","title":"Mode"},"document_sets":{"items":{"$ref":"#/components/schemas/AutoDocumentSet"},"type":"array","maxItems":50,"minItems":1,"title":"Document Sets"}},"additionalProperties":false,"type":"object","required":["idempotency_key","mode","document_sets"],"title":"AutoAttachRequest","examples":[{"document_sets":[{"document_ids":["doc_456"],"entity_id":"sp_cust_demo"}],"idempotency_key":"attach-001","mode":"auto_classify"}]},"AutoDocumentSet":{"properties":{"entity_id":{"type":"string","maxLength":255,"minLength":1,"title":"Entity Id"},"document_ids":{"items":{"type":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Document Ids"},"replacements":{"items":{"$ref":"#/components/schemas/EvidenceReplacement"},"type":"array","maxItems":100,"title":"Replacements"}},"additionalProperties":false,"type":"object","required":["entity_id","document_ids"],"title":"AutoDocumentSet"},"AutomationRunCaseCompletionTrigger":{"properties":{"trigger_event_type":{"type":"string","const":"case_complete","title":"Trigger Event Type"},"case_id":{"type":"string","title":"Case Id"},"entity_id":{"type":"string","title":"Entity Id"}},"type":"object","required":["trigger_event_type","case_id","entity_id"],"title":"AutomationRunCaseCompletionTrigger"},"AutomationRunCompletionEvent":{"properties":{"automation_id":{"type":"string","title":"Automation Id"},"run_id":{"type":"string","title":"Run Id"},"completed_at":{"type":"string","format":"date-time","title":"Completed At"},"trigger":{"oneOf":[{"$ref":"#/components/schemas/AutomationRunCaseCompletionTrigger"},{"$ref":"#/components/schemas/AutomationRunScheduledTrigger"},{"$ref":"#/components/schemas/AutomationRunOnDemandTrigger"}],"title":"Trigger","discriminator":{"propertyName":"trigger_event_type","mapping":{"case_complete":"#/components/schemas/AutomationRunCaseCompletionTrigger","on_demand":"#/components/schemas/AutomationRunOnDemandTrigger","scheduled":"#/components/schemas/AutomationRunScheduledTrigger"}}}},"type":"object","required":["automation_id","run_id","completed_at","trigger"],"title":"AutomationRunCompletionEvent"},"AutomationRunOnDemandTrigger":{"properties":{"trigger_event_type":{"type":"string","const":"on_demand","title":"Trigger Event Type"},"target_type":{"type":"string","enum":["entity","deal"],"title":"Target Type"},"entity_id":{"type":"string","title":"Entity Id"},"deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Id"},"event_instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Instance Id"}},"type":"object","required":["trigger_event_type","target_type","entity_id"],"title":"AutomationRunOnDemandTrigger"},"AutomationRunScheduledTrigger":{"properties":{"trigger_event_type":{"type":"string","const":"scheduled","title":"Trigger Event Type"}},"type":"object","required":["trigger_event_type"],"title":"AutomationRunScheduledTrigger"},"BalanceSheetAssetsImport":{"properties":{"cash_and_cash_equivalents":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"restricted_cash":{"$ref":"#/components/schemas/LineItemSchema","description":"Restricted cash is the cash and cash equivalents that are restricted by the company","default":{"amount":0.0}},"accounts_receivable":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"allowance_for_bad_debts":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"inventory":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"related_parties_assets_cp":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"operating_lease_assets_cp":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"marketable_securities":{"$ref":"#/components/schemas/LineItemSchema","description":"Marketable securities are short-term investments that are easily convertible to cash","default":{"amount":0.0}},"time_deposits":{"$ref":"#/components/schemas/LineItemSchema","description":"Time deposit is a short-term investment that is held for a period of time","default":{"amount":0.0}},"other_short_term_investments":{"$ref":"#/components/schemas/LineItemSchema","description":"Other short-term investments are short-term investments that are not easily convertible to cash","default":{"amount":0.0}},"notes_receivable_cp":{"$ref":"#/components/schemas/LineItemSchema","description":"Notes receivable are a type of asset that are not easily convertible to cash","default":{"amount":0.0}},"prepaid_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_current_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"land":{"$ref":"#/components/schemas/LineItemSchema","description":"Land is a fixed asset that is not easily convertible to cash","default":{"amount":0.0}},"buildings":{"$ref":"#/components/schemas/LineItemSchema","description":"Buildings are fixed assets that are not easily convertible to cash","default":{"amount":0.0}},"equipment_and_machinery":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_fixed_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"accumulated_depreciation":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"finite_lived_intangible_assets":{"$ref":"#/components/schemas/LineItemSchema","description":"Finite life intangible assets are intangible assets that have a finite life","default":{"amount":0.0}},"indefinite_lived_intangible_assets":{"$ref":"#/components/schemas/LineItemSchema","description":"Indefinite life intangible assets are intangible assets that have an indefinite life","default":{"amount":0.0}},"accumulated_amortization":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"related_parties_assets_lt":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"operating_lease_assets_lt":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"restricted_cash_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Restricted Cash LT is the long term portion of the restricted cash","default":{"amount":0.0}},"long_term_investments":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"notes_receivable_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Notes receivable are a type of asset that are not easily convertible to cash","default":{"amount":0.0}},"deferred_tax_asset":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_non_current_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}}},"type":"object","title":"BalanceSheetAssetsImport"},"BalanceSheetAssetsSchema":{"properties":{"cash_and_cash_equivalents":{"$ref":"#/components/schemas/LineItemSchema"},"restricted_cash":{"$ref":"#/components/schemas/LineItemSchema","description":"Restricted cash is the current portion of the cash and cash equivalents that are restricted by the company","default":{"amount":0.0}},"net_accounts_receivable":{"$ref":"#/components/schemas/LineItemSchema"},"accounts_receivable":{"$ref":"#/components/schemas/LineItemSchema"},"allowance_for_bad_debts":{"$ref":"#/components/schemas/LineItemSchema"},"inventory":{"$ref":"#/components/schemas/LineItemSchema"},"related_parties_assets_cp":{"$ref":"#/components/schemas/LineItemSchema"},"operating_lease_assets_cp":{"$ref":"#/components/schemas/LineItemSchema"},"short_term_investments":{"$ref":"#/components/schemas/LineItemSchema"},"marketable_securities":{"$ref":"#/components/schemas/LineItemSchema","description":"Marketable securities are short-term investments that are easily convertible to cash","default":{"amount":0.0}},"time_deposits":{"$ref":"#/components/schemas/LineItemSchema","description":"Time deposit is a short-term investment that is held for a period of time","default":{"amount":0.0}},"other_short_term_investments":{"$ref":"#/components/schemas/LineItemSchema","description":"Other short-term investments are short-term investments that are not easily convertible to cash","default":{"amount":0.0}},"notes_receivable_cp":{"$ref":"#/components/schemas/LineItemSchema","description":"Notes receivable are a type of asset that are not easily convertible to cash","default":{"amount":0.0}},"prepaid_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"other_current_assets":{"$ref":"#/components/schemas/LineItemSchema"},"total_current_assets":{"$ref":"#/components/schemas/LineItemSchema"},"net_fixed_assets":{"$ref":"#/components/schemas/LineItemSchema"},"land_and_buildings":{"$ref":"#/components/schemas/LineItemSchema"},"land":{"$ref":"#/components/schemas/LineItemSchema","description":"Land is a fixed asset that is not easily convertible to cash","default":{"amount":0.0}},"buildings":{"$ref":"#/components/schemas/LineItemSchema","description":"Buildings are fixed assets that are not easily convertible to cash","default":{"amount":0.0}},"equipment_and_machinery":{"$ref":"#/components/schemas/LineItemSchema"},"other_fixed_assets":{"$ref":"#/components/schemas/LineItemSchema"},"accumulated_depreciation":{"$ref":"#/components/schemas/LineItemSchema"},"net_intangible_assets":{"$ref":"#/components/schemas/LineItemSchema"},"intangible_assets":{"$ref":"#/components/schemas/LineItemSchema"},"finite_lived_intangible_assets":{"$ref":"#/components/schemas/LineItemSchema","description":"Finite life intangible assets are intangible assets that have a finite life","default":{"amount":0.0}},"indefinite_lived_intangible_assets":{"$ref":"#/components/schemas/LineItemSchema","description":"Indefinite life intangible assets are intangible assets that have an indefinite life","default":{"amount":0.0}},"accumulated_amortization":{"$ref":"#/components/schemas/LineItemSchema"},"restricted_cash_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Restricted Cash LT is the long term portion of the restricted cash","default":{"amount":0.0}},"related_parties_assets_lt":{"$ref":"#/components/schemas/LineItemSchema"},"operating_lease_assets_lt":{"$ref":"#/components/schemas/LineItemSchema"},"long_term_investments":{"$ref":"#/components/schemas/LineItemSchema"},"notes_receivable_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Notes receivable are a type of asset that are not easily convertible to cash","default":{"amount":0.0}},"deferred_tax_asset":{"$ref":"#/components/schemas/LineItemSchema"},"other_non_current_assets":{"$ref":"#/components/schemas/LineItemSchema"},"total_non_current_assets":{"$ref":"#/components/schemas/LineItemSchema"},"total_assets":{"$ref":"#/components/schemas/LineItemSchema"}},"type":"object","required":["cash_and_cash_equivalents","net_accounts_receivable","accounts_receivable","allowance_for_bad_debts","inventory","related_parties_assets_cp","operating_lease_assets_cp","short_term_investments","prepaid_expenses","other_current_assets","total_current_assets","net_fixed_assets","land_and_buildings","equipment_and_machinery","other_fixed_assets","accumulated_depreciation","net_intangible_assets","intangible_assets","accumulated_amortization","related_parties_assets_lt","operating_lease_assets_lt","long_term_investments","deferred_tax_asset","other_non_current_assets","total_non_current_assets","total_assets"],"title":"BalanceSheetAssetsSchema"},"BalanceSheetGroupingStructureSchema-Input":{"properties":{"assets":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Input"},"type":"array","title":"Assets","default":[]},"liabilities_and_equity":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Input"},"type":"array","title":"Liabilities And Equity","default":[]}},"type":"object","title":"BalanceSheetGroupingStructureSchema"},"BalanceSheetGroupingStructureSchema-Output":{"properties":{"assets":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Output"},"type":"array","title":"Assets","default":[]},"liabilities_and_equity":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Output"},"type":"array","title":"Liabilities And Equity","default":[]}},"type":"object","title":"BalanceSheetGroupingStructureSchema"},"BalanceSheetImport":{"properties":{"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, date in isoformat"},"assets_line_items":{"$ref":"#/components/schemas/BalanceSheetAssetsImport"},"liabilities_and_equity_line_items":{"$ref":"#/components/schemas/BalanceSheetLiabilitiesImport"},"other_items":{"$ref":"#/components/schemas/BalanceSheetOthersImport"}},"type":"object","required":["end_period","assets_line_items","liabilities_and_equity_line_items","other_items"],"title":"BalanceSheetImport","description":"The balance sheet import schema\nAll the total line items are calculated from the line items through summation.\nThere is no subtraction in the total line item calculation.\nFor example, total assets = current assets + non-current assets."},"BalanceSheetLiabilitiesImport":{"properties":{"accounts_payable":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"overdrafts":{"$ref":"#/components/schemas/LineItemSchema","description":"Overdrafts are short-term loans from a bank or other financial institution","default":{"amount":0.0}},"short_term_borrowings":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"current_portion_of_lt_debt":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"finance_lease_liabilities_cp":{"$ref":"#/components/schemas/LineItemSchema","description":"Finance lease liabilities are a type of liability that are used to account for the lease of a capital asset","default":{"amount":0.0}},"subordinated_debt_cp":{"$ref":"#/components/schemas/LineItemSchema","description":"Subordinated debt is a type of liability that is subordinate to other debt obligations","default":{"amount":0.0}},"related_parties_liabilities_cp":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"operating_lease_liabilities_cp":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"deferred_revenue":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"accrued_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"long_term_portion_of_lt_debt":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"finance_lease_liabilities_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Finance lease liabilities are a type of liability that are used to account for the lease of a capital asset","default":{"amount":0.0}},"subordinated_debt_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Subordinated debt is a type of liability that is subordinate to other debt obligations","default":{"amount":0.0}},"related_parties_liabilities_lt":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"operating_lease_liabilities_lt":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"deferred_revenue_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Deferred revenue LT is a type of liability that is deferred revenue that is not yet due","default":{"amount":0.0}},"deferred_financing":{"$ref":"#/components/schemas/LineItemSchema","description":"Deferred financing is deferred debt and interest that is not yet due","default":{"amount":0.0}},"deferred_tax_liability":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_non_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"share_capital":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"additional_paid_in_capital":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"retained_earnings":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_equity":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"non_liabilities_or_equity_accounts":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}}},"type":"object","title":"BalanceSheetLiabilitiesImport"},"BalanceSheetLiabilitiesSchema":{"properties":{"accounts_payable":{"$ref":"#/components/schemas/LineItemSchema"},"overdrafts":{"$ref":"#/components/schemas/LineItemSchema","description":"Overdrafts are short-term loans from a bank or other financial institution","default":{"amount":0.0}},"short_term_borrowings":{"$ref":"#/components/schemas/LineItemSchema"},"current_portion_of_lt_debt":{"$ref":"#/components/schemas/LineItemSchema"},"finance_lease_liabilities_cp":{"$ref":"#/components/schemas/LineItemSchema","description":"Finance lease liabilities are a type of liability that are used to account for the lease of a capital asset","default":{"amount":0.0}},"subordinated_debt_cp":{"$ref":"#/components/schemas/LineItemSchema","description":"Subordinated debt is a type of liability that is subordinate to other debt obligations","default":{"amount":0.0}},"related_parties_liabilities_cp":{"$ref":"#/components/schemas/LineItemSchema"},"operating_lease_liabilities_cp":{"$ref":"#/components/schemas/LineItemSchema"},"deferred_revenue":{"$ref":"#/components/schemas/LineItemSchema"},"accrued_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"other_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema"},"total_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema"},"long_term_portion_of_lt_debt":{"$ref":"#/components/schemas/LineItemSchema"},"finance_lease_liabilities_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Finance lease liabilities are a type of liability that are used to account for the lease of a capital asset","default":{"amount":0.0}},"subordinated_debt_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Subordinated debt is a type of liability that is subordinate to other debt obligations","default":{"amount":0.0}},"related_parties_liabilities_lt":{"$ref":"#/components/schemas/LineItemSchema"},"operating_lease_liabilities_lt":{"$ref":"#/components/schemas/LineItemSchema"},"deferred_revenue_lt":{"$ref":"#/components/schemas/LineItemSchema","description":"Deferred revenue LT is a type oßf liability that is deferred revenue that is not yet due","default":{"amount":0.0}},"deferred_financing":{"$ref":"#/components/schemas/LineItemSchema","description":"Deferred financing is deferred debt and interest that is not yet due","default":{"amount":0.0}},"deferred_tax_liability":{"$ref":"#/components/schemas/LineItemSchema"},"other_non_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema"},"total_non_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema"},"total_liabilities":{"$ref":"#/components/schemas/LineItemSchema"},"share_capital":{"$ref":"#/components/schemas/LineItemSchema"},"additional_paid_in_capital":{"$ref":"#/components/schemas/LineItemSchema"},"retained_earnings":{"$ref":"#/components/schemas/LineItemSchema"},"other_equity":{"$ref":"#/components/schemas/LineItemSchema"},"total_equity":{"$ref":"#/components/schemas/LineItemSchema"},"non_liabilities_or_equity_accounts":{"$ref":"#/components/schemas/LineItemSchema","description":"Non-liability or equity accounts are accounts that are not liabilities or equity","default":{"amount":0.0}},"total_liabilities_and_total_equity":{"$ref":"#/components/schemas/LineItemSchema"}},"type":"object","required":["accounts_payable","short_term_borrowings","current_portion_of_lt_debt","related_parties_liabilities_cp","operating_lease_liabilities_cp","deferred_revenue","accrued_expenses","other_current_liabilities","total_current_liabilities","long_term_portion_of_lt_debt","related_parties_liabilities_lt","operating_lease_liabilities_lt","deferred_tax_liability","other_non_current_liabilities","total_non_current_liabilities","total_liabilities","share_capital","additional_paid_in_capital","retained_earnings","other_equity","total_equity","total_liabilities_and_total_equity"],"title":"BalanceSheetLiabilitiesSchema"},"BalanceSheetOthersImport":{"properties":{"total_line_of_credit":{"anyOf":[{"$ref":"#/components/schemas/LineItemSchema"},{"type":"null"}]},"undrawn_line_of_credit":{"anyOf":[{"$ref":"#/components/schemas/LineItemSchema"},{"type":"null"}]}},"type":"object","title":"BalanceSheetOthersImport"},"BalanceSheetOthersSchema":{"properties":{"total_line_of_credit":{"anyOf":[{"$ref":"#/components/schemas/LineItemSchema"},{"type":"null"}]},"undrawn_line_of_credit":{"anyOf":[{"$ref":"#/components/schemas/LineItemSchema"},{"type":"null"}]}},"type":"object","title":"BalanceSheetOthersSchema"},"BalanceSheetSchema-Input":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"The unique identifier of the balance sheet period within the case"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"custom_account_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Account Group Key"},"assets_line_items":{"$ref":"#/components/schemas/BalanceSheetAssetsSchema"},"liabilities_and_equity_line_items":{"$ref":"#/components/schemas/BalanceSheetLiabilitiesSchema"},"other_items":{"$ref":"#/components/schemas/BalanceSheetOthersSchema","default":{}},"custom_line_items":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/LineItemSchema"},"type":"object"},{"type":"null"}],"title":"Custom Line Items","description":"The account grouping line items"}},"type":"object","required":["statement_id","end_period","assets_line_items","liabilities_and_equity_line_items"],"title":"BalanceSheetSchema"},"BalanceSheetSchema-Output":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"The unique identifier of the balance sheet period within the case"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"custom_account_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Account Group Key"},"assets_line_items":{"$ref":"#/components/schemas/BalanceSheetAssetsSchema"},"liabilities_and_equity_line_items":{"$ref":"#/components/schemas/BalanceSheetLiabilitiesSchema"},"other_items":{"$ref":"#/components/schemas/BalanceSheetOthersSchema","default":{}},"custom_line_items":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/LineItemSchema"},"type":"object"},{"type":"null"}],"title":"Custom Line Items","description":"The account grouping line items"}},"type":"object","required":["statement_id","end_period","assets_line_items","liabilities_and_equity_line_items"],"title":"BalanceSheetSchema"},"BankAccount":{"properties":{"bank_account_id":{"type":"string","title":"Bank Account Id"},"bank_name":{"type":"string","title":"Bank Name"},"account_holder_name":{"type":"string","title":"Account Holder Name"},"account_number":{"type":"string","title":"Account Number"},"holder_address":{"type":"string","title":"Holder Address"},"account_type":{"type":"string","title":"Account Type"},"account_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Category"},"currency":{"type":"string","title":"Currency","default":"USD"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency"},"periods":{"items":{"$ref":"#/components/schemas/BankStatementPeriod"},"type":"array","title":"Periods","default":[]}},"type":"object","required":["bank_account_id","bank_name","account_holder_name","account_number","holder_address","account_type"],"title":"BankAccount"},"BankAccountSubtype":{"type":"string","enum":["checking","savings","money_market","cash_management","hsa","cd","prepaid","paypal","ebt","other"]},"BankAccountType":{"type":"string","enum":["depository","credit","loan","investment","brokerage","other"]},"BankBalanceBasis":{"type":"string","enum":["stated","reconstructed"],"title":"BankBalanceBasis","description":"What a balance series rests on.\n\n`stated` is a figure a bank printed on a statement. `reconstructed` is a\npoint-in-time balance rolled backward to reach a day nobody reported: a real\nnumber, but any error in the anchor shifts the whole series by a constant and\nnothing in the series reveals it."},"BankImportAccountBalance":{"properties":{"outcome":{"type":"string","enum":["applied","no_full_month","no_balance","not_depository"],"title":"Outcome"},"balanced_months":{"anyOf":[{"$ref":"#/components/schemas/BankImportBalancedMonths"},{"type":"null"}]},"anchor":{"anyOf":[{"$ref":"#/components/schemas/BankImportBalanceAnchor"},{"type":"null"}]}},"type":"object","required":["outcome"],"title":"BankImportAccountBalance","description":"What balances the months this job covers, once it published.\n\n`applied`: the whole months in `balanced_months` carry balances rolled back\nfrom `anchor`. `no_full_month`: `anchor` balances the stretch, but no whole\nmonth of it ends by its day yet. `no_balance`: no closing balance is dated\nin the unbroken stretch this job's coverage falls in, for example a backfill\nwith a gap before the anchored months, so its months keep flows only.\n`not_depository`: balances are only rebuilt for deposit accounts."},"BankImportBalanceAnchor":{"properties":{"as_of":{"type":"string","format":"date","title":"As Of"},"import_id":{"type":"string","title":"Import Id"}},"type":"object","required":["as_of","import_id"],"title":"BankImportBalanceAnchor","description":"The declared closing balance a stretch is rolled back from: its day,\nand the job that sent it (this one, or an earlier one for a backfill)."},"BankImportBalancedMonths":{"properties":{"start_period":{"type":"string","format":"date","title":"Start Period"},"end_period":{"type":"string","format":"date","title":"End Period"}},"type":"object","required":["start_period","end_period"],"title":"BankImportBalancedMonths"},"BankImportBatchReceipt":{"properties":{"import_id":{"type":"string","title":"Import Id"},"batch_id":{"type":"string","title":"Batch Id"},"sequence":{"type":"integer","title":"Sequence"},"format":{"$ref":"#/components/schemas/BankImportFormat"},"payload_sha256":{"type":"string","title":"Payload Sha256"},"accepted_at":{"type":"string","format":"date-time","title":"Accepted At"},"deduplicated":{"type":"boolean","title":"Deduplicated"},"status":{"$ref":"#/components/schemas/BankImportBatchStatus"},"transactions_received":{"type":"integer","title":"Transactions Received"},"staged_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Staged At"}},"type":"object","required":["import_id","batch_id","sequence","format","payload_sha256","accepted_at","deduplicated","status","transactions_received","staged_at"],"title":"BankImportBatchReceipt","description":"The response to a batch PUT."},"BankImportBatchStatus":{"type":"string","enum":["pending","staging","staged","failed"],"title":"BankImportBatchStatus","description":"Where one batch is. A `staged` batch is categorized and waiting for its\njob to publish; nothing in it is visible on the read endpoints."},"BankImportBatchSummary":{"properties":{"batch_id":{"type":"string","title":"Batch Id"},"sequence":{"type":"integer","title":"Sequence"},"format":{"$ref":"#/components/schemas/BankImportFormat"},"payload_sha256":{"type":"string","title":"Payload Sha256"},"status":{"$ref":"#/components/schemas/BankImportBatchStatus"},"transactions_received":{"type":"integer","title":"Transactions Received"},"accepted_at":{"type":"string","format":"date-time","title":"Accepted At"},"staged_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Staged At"}},"type":"object","required":["batch_id","sequence","format","payload_sha256","status","transactions_received","accepted_at","staged_at"],"title":"BankImportBatchSummary"},"BankImportCompleteErrorResponse":{"properties":{"code":{"type":"string","title":"Code","description":"Stable machine-readable identifier. Branch on this, never on message."},"message":{"type":"string","title":"Message"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field","description":"JSON path to the offending field, e.g. loans[1].external_id, when the error is about one."},"candidates":{"items":{"type":"string"},"type":"array","title":"Candidates","description":"Ids the caller can choose between, on duplicate_deal_candidates, ambiguous_user, external_deal_id_taken and the identity conflicts. Empty otherwise."},"request_id":{"type":"string","title":"Request Id","description":"For support correlation. Echoes the request's x-request-id header when one was sent, else a fresh id."},"missing_sequences":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Missing Sequences","description":"Accepted, but not listed in `sequences`."},"unexpected_sequences":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Unexpected Sequences","description":"Listed in `sequences`, but never accepted."}},"type":"object","required":["code","message","request_id"],"title":"BankImportCompleteErrorResponse","description":"`complete`'s rule failures. Only `sequences_mismatch` sets the two\nsequence lists."},"BankImportCompleteRequest":{"properties":{"sequences":{"items":{"type":"integer","maximum":2147483647.0,"minimum":1.0},"type":"array","title":"Sequences","description":"Every batch sequence you sent. Must equal the accepted set."},"delete_accounts":{"items":{"type":"string"},"type":"array","title":"Delete Accounts"},"reset_accounts":{"items":{"type":"string"},"type":"array","title":"Reset Accounts"},"remove_coverage":{"items":{"$ref":"#/components/schemas/CoverageRange"},"type":"array","title":"Remove Coverage"},"coverage":{"items":{"$ref":"#/components/schemas/CoverageRange"},"type":"array","title":"Coverage"},"balances":{"items":{"$ref":"#/components/schemas/ImportAccountBalance"},"type":"array","title":"Balances","description":"Closing balances for accounts in `coverage`; see `ImportAccountBalance` for when one is owed."}},"additionalProperties":false,"type":"object","required":["sequences"],"title":"BankImportCompleteRequest"},"BankImportFailureCode":{"type":"string","enum":["batch_staging_failed","publish_failed"],"title":"BankImportFailureCode","description":"Why a job failed. `batch_staging_failed`: a batch could not be\ncategorized and staged. `publish_failed`: publishing could not finish."},"BankImportFormat":{"type":"string","enum":["plaid","generic"],"title":"BankImportFormat","description":"The shape a batch was sent in, and so an imported account's format:\nPlaid's own JSON (`plaid`), or the generic shape (`generic`)."},"BankImportJob":{"properties":{"import_id":{"type":"string","title":"Import Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"status":{"$ref":"#/components/schemas/BankImportStatus"},"closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closed At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"accounts":{"items":{"$ref":"#/components/schemas/BankImportJobAccount"},"type":"array","title":"Accounts"},"batches":{"items":{"$ref":"#/components/schemas/BankImportBatchSummary"},"type":"array","title":"Batches"},"completion":{"anyOf":[{"$ref":"#/components/schemas/BankImportCompleteRequest"},{"type":"null"}]},"published":{"anyOf":[{"$ref":"#/components/schemas/BankImportPublished"},{"type":"null"}]},"failure_code":{"anyOf":[{"$ref":"#/components/schemas/BankImportFailureCode"},{"type":"null"}]},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"}},"type":"object","required":["import_id","idempotency_key","customer_id","external_customer_id","status","closed_at","expires_at","accounts","batches","completion","published","failure_code","failure_reason","created_at","finished_at"],"title":"BankImportJob","description":"An import job. GET and webhook events return this; the write calls\nreturn `BankImportJobWriteResponse`, which adds `deduplicated`."},"BankImportJobAccount":{"properties":{"account_key":{"type":"string","title":"Account Key"},"known_ids":{"items":{"type":"string"},"type":"array","title":"Known Ids"},"bank_account_id":{"type":"string","title":"Bank Account Id"},"import_format":{"$ref":"#/components/schemas/BankImportFormat"},"affected_by":{"items":{"type":"string","enum":["batches","removed","reset","deleted","coverage","remove_coverage"]},"type":"array","title":"Affected By"},"balance":{"anyOf":[{"$ref":"#/components/schemas/BankImportAccountBalance"},{"type":"null"}],"description":"Set once the job publishes, for each account it declares coverage for."}},"type":"object","required":["account_key","known_ids","bank_account_id","import_format","affected_by"],"title":"BankImportJobAccount"},"BankImportJobWriteResponse":{"properties":{"import_id":{"type":"string","title":"Import Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"status":{"$ref":"#/components/schemas/BankImportStatus"},"closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closed At"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At"},"accounts":{"items":{"$ref":"#/components/schemas/BankImportJobAccount"},"type":"array","title":"Accounts"},"batches":{"items":{"$ref":"#/components/schemas/BankImportBatchSummary"},"type":"array","title":"Batches"},"completion":{"anyOf":[{"$ref":"#/components/schemas/BankImportCompleteRequest"},{"type":"null"}]},"published":{"anyOf":[{"$ref":"#/components/schemas/BankImportPublished"},{"type":"null"}]},"failure_code":{"anyOf":[{"$ref":"#/components/schemas/BankImportFailureCode"},{"type":"null"}]},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"deduplicated":{"type":"boolean","title":"Deduplicated","description":"Whether this request was a replay of an earlier one."}},"type":"object","required":["import_id","idempotency_key","customer_id","external_customer_id","status","closed_at","expires_at","accounts","batches","completion","published","failure_code","failure_reason","created_at","finished_at","deduplicated"],"title":"BankImportJobWriteResponse"},"BankImportOpenRequest":{"properties":{"customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id","description":"Your id for the borrower. Send exactly one of this or customer_id."},"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key","description":"Unique per org. Retrying with the same key returns the same job; a new job, including after an abandoned one, needs a new key."}},"additionalProperties":false,"type":"object","required":["idempotency_key"],"title":"BankImportOpenRequest"},"BankImportPublished":{"properties":{"accounts_reset":{"type":"integer","title":"Accounts Reset"},"accounts_deleted":{"type":"integer","title":"Accounts Deleted"},"transactions_inserted":{"type":"integer","title":"Transactions Inserted"},"transactions_updated":{"type":"integer","title":"Transactions Updated"},"transactions_removed":{"type":"integer","title":"Transactions Removed"},"accounts_balanced":{"type":"integer","title":"Accounts Balanced","default":0},"published_at":{"type":"string","format":"date-time","title":"Published At"}},"type":"object","required":["accounts_reset","accounts_deleted","transactions_inserted","transactions_updated","transactions_removed","published_at"],"title":"BankImportPublished"},"BankImportStatus":{"type":"string","enum":["open","publishing","completed","failed","cancelled","expired"],"title":"BankImportStatus","description":"Where an import job is. `open` accepts batches; `publishing` means\n`complete` was accepted and the job is being published; the other four are\nfinal."},"BankSourceFamily":{"type":"string","enum":["plaid","document","manual","import"],"title":"BankSourceFamily","description":"How a bank figure was obtained: a live connection to the bank\n(`plaid`), a document somebody uploaded (`document`), a figure entered by\nhand or imported from a spreadsheet (`manual`), or transactions a partner\nposted through `/banking/imports` (`import`).\n\nFigures from different families are never mixed. An entity with both a Plaid\nlink and uploaded statements holds two independent records of the same\nmonths, so summing across families double-counts."},"BankStatementAnalysis":{"properties":{"bank_account_id":{"type":"string","title":"Bank Account Id"},"total_deposits":{"type":"integer","title":"Total Deposits"},"total_withdrawals":{"type":"integer","title":"Total Withdrawals"},"total_deposit_amount":{"type":"number","title":"Total Deposit Amount"},"total_withdrawal_amount":{"type":"number","title":"Total Withdrawal Amount"},"average_daily_balance":{"type":"number","title":"Average Daily Balance"},"days_of_negative_balance":{"type":"integer","title":"Days Of Negative Balance"},"average_transaction_amount":{"type":"number","title":"Average Transaction Amount"},"daily_running_balance":{"items":{"$ref":"#/components/schemas/BankStatementDailyRunningBalance"},"type":"array","title":"Daily Running Balance","default":[]}},"type":"object","required":["bank_account_id","total_deposits","total_withdrawals","total_deposit_amount","total_withdrawal_amount","average_daily_balance","days_of_negative_balance","average_transaction_amount"],"title":"BankStatementAnalysis"},"BankStatementCategories":{"properties":{"credit_categories":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["non_card_sales","card_sales","e_commerce_platform_deposits","payment_processor_deposits","card_reward_deposits","benefits_deposits","wage_deposits","self_employment_deposits","pension_deposits","social_security_deposits","unemployment_deposits","dividend_and_interest_deposits","rental_income_deposits","support_and_alimony_deposits","insurance_deposits","state_tax_deposits","federal_tax_deposits","payroll_tax_deposits","deposits_from_reversals","fintech_loan_deposits","bank_loan_deposits","sba_deposits","auto_finance_deposits","mortgage_deposits","debt_consolidator_deposits","other_loan_deposits","merchant_cash_advance_deposits","bank_cash_advance_deposits","internal_transfer_deposits","investment_deposits","outside_source_deposits","miscellaneous_deposits"]},"type":"object","title":"Credit Categories"},"credit_category_groups":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["revenue_and_income","personal_income","reimbursements_and_refunds","loans_and_advances","miscellaneous_deposits"]},"type":"object","title":"Credit Category Groups"},"credit_category_subgroups":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["sales_revenue","rewards_and_benefits","wages_and_salary","government_and_retirement","investment_and_rental_income","insurance_refunds","tax_refunds","transaction_reversals","unsecured_loan_proceeds","secured_loan_proceeds","other_loan_proceeds","cash_advances","miscellaneous_deposits"]},"type":"object","title":"Credit Category Subgroups"},"credit_deposit_channels":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["cash_app_deposits_venmo_zelle","paypal_deposits","other_online_payment_deposits","atm_deposits","bank_branch_deposits","check_deposits","ach_credit_deposits","wire_transfer_deposits","crypto_deposits","other_deposit_channels"]},"type":"object","title":"Credit Deposit Channels"},"credit_deposit_channel_groups":{"additionalProperties":{"type":"integer"},"propertyNames":{"const":"deposit_channels"},"type":"object","title":"Credit Deposit Channel Groups"},"credit_deposit_channel_subgroups":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["mobile_and_online_payment_deposits","bank_deposits","wire_transfers","cryptocurrency_deposits","other_deposit_channels"]},"type":"object","title":"Credit Deposit Channel Subgroups"},"debit_categories":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["vendor_payments","payroll_payments","benefits_payments","insurance_payments","rent_payments","leasing_payments","travel_expenses_airlines","travel_expenses_car_rental","travel_expenses_hotels","travel_expenses_others","utility_expenses_internet","utility_expenses_power","utility_expenses_tv","utility_expenses_telephone","utility_expenses_water","utility_expenses_others","card_processor_fees","chargebacks","nsf_fees","overdraft_fees","other_fees","household_payments","groceries_payments","childcare_payments","support_and_alimony_payments","charitable_payments","transportation_payments","healthcare_payments","education_payments","dining_payments","personal_care_payments","entertainment_payments","fintech_loan_payments","bank_loan_payments","sba_payments","auto_finance_payments","mortgage_payments","other_loan_payments","debt_consolidator_payments","credit_card_payments","fintech_mca_payments","bank_cash_advance_payments","state_tax_payments","federal_tax_payments","payroll_tax_payments","internal_transfer_withdrawals","investment_withdrawals","merchant_service_transfer_withdrawals","deposited_check_returns","miscellaneous_withdrawals"]},"type":"object","title":"Debit Categories"},"debit_category_groups":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["business_expenses","personal_expenses","loans_and_advances","tax_payments","miscellaneous_withdrawals"]},"type":"object","title":"Debit Category Groups"},"debit_category_subgroups":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["vendor_and_supplier_payments","payroll_and_benefits","insurance","rent","travel_expenses","utility_expenses","fees_and_charges","housing_and_utilities","living_expenses","transportation","healthcare_and_education","discretionary","unsecured_loan_repayments","secured_loan_repayments","other_loan_repayments","cash_advance_repayments","tax_payments","miscellaneous_withdrawals"]},"type":"object","title":"Debit Category Subgroups"},"debit_payment_channels":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["debit_card_payments","credit_card_payments","cash_app_payments_venmo_zelle","paypal_payments","other_online_payments","ach_debit_withdrawals","atm_withdrawals","bank_branch_withdrawals","check_payments","wire_transfer_withdrawals","crypto_payments","other_payment_channels"]},"type":"object","title":"Debit Payment Channels"},"debit_payment_channel_groups":{"additionalProperties":{"type":"integer"},"propertyNames":{"const":"payment_channels"},"type":"object","title":"Debit Payment Channel Groups"},"debit_payment_channel_subgroups":{"additionalProperties":{"type":"integer"},"propertyNames":{"enum":["card_payments","mobile_and_online_payments","bank_withdrawals","wire_transfers","cryptocurrency_payments","other_payment_channels"]},"type":"object","title":"Debit Payment Channel Subgroups"}},"type":"object","required":["credit_categories","credit_category_groups","credit_category_subgroups","credit_deposit_channels","credit_deposit_channel_groups","credit_deposit_channel_subgroups","debit_categories","debit_category_groups","debit_category_subgroups","debit_payment_channels","debit_payment_channel_groups","debit_payment_channel_subgroups"],"title":"BankStatementCategories"},"BankStatementDailyRunningBalance":{"properties":{"date":{"type":"string","format":"date-time","title":"Date","description":"Date of the running balance, return as date in isoformat"},"opening_balance":{"type":"number","title":"Opening Balance"},"closing_balance":{"type":"number","title":"Closing Balance"},"credits":{"type":"number","title":"Credits"},"debits":{"type":"number","title":"Debits"}},"type":"object","required":["date","opening_balance","closing_balance","credits","debits"],"title":"BankStatementDailyRunningBalance"},"BankStatementPeriod":{"properties":{"period_id":{"type":"string","title":"Period Id","default":""},"start_date":{"type":"string","format":"date-time","title":"Start Date","description":"Period start date, return as date in isoformat"},"end_date":{"type":"string","format":"date-time","title":"End Date","description":"Period end date, return as date in isoformat"},"opening_balance":{"type":"number","title":"Opening Balance"},"closing_balance":{"type":"number","title":"Closing Balance"},"total_deposits":{"type":"integer","title":"Total Deposits"},"total_withdrawals":{"type":"integer","title":"Total Withdrawals"},"total_deposit_amount":{"type":"number","title":"Total Deposit Amount"},"total_withdrawal_amount":{"type":"number","title":"Total Withdrawal Amount"},"average_daily_balance":{"type":"number","title":"Average Daily Balance"},"days_of_negative_balance":{"type":"integer","title":"Days Of Negative Balance"},"average_transaction_amount":{"type":"number","title":"Average Transaction Amount"},"reconciliation_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reconciliation Error"}},"type":"object","required":["start_date","end_date","opening_balance","closing_balance","total_deposits","total_withdrawals","total_deposit_amount","total_withdrawal_amount","average_daily_balance","days_of_negative_balance","average_transaction_amount"],"title":"BankStatementPeriod"},"BankStatementTransaction":{"properties":{"bank_account_id":{"type":"string","title":"Bank Account Id"},"period_id":{"type":"string","title":"Period Id"},"txn_id":{"type":"string","title":"Txn Id"},"date":{"type":"string","format":"date-time","title":"Date","description":"Transaction date, return as date in isoformat"},"description":{"type":"string","title":"Description"},"amount":{"type":"number","title":"Amount"},"type":{"$ref":"#/components/schemas/TransactionType"},"category":{"anyOf":[{"type":"string","enum":["non_card_sales","card_sales","e_commerce_platform_deposits","payment_processor_deposits","card_reward_deposits","benefits_deposits","wage_deposits","self_employment_deposits","pension_deposits","social_security_deposits","unemployment_deposits","dividend_and_interest_deposits","rental_income_deposits","support_and_alimony_deposits","insurance_deposits","state_tax_deposits","federal_tax_deposits","payroll_tax_deposits","deposits_from_reversals","fintech_loan_deposits","bank_loan_deposits","sba_deposits","auto_finance_deposits","mortgage_deposits","debt_consolidator_deposits","other_loan_deposits","merchant_cash_advance_deposits","bank_cash_advance_deposits","internal_transfer_deposits","investment_deposits","outside_source_deposits","miscellaneous_deposits"]},{"type":"string","enum":["vendor_payments","payroll_payments","benefits_payments","insurance_payments","rent_payments","leasing_payments","travel_expenses_airlines","travel_expenses_car_rental","travel_expenses_hotels","travel_expenses_others","utility_expenses_internet","utility_expenses_power","utility_expenses_tv","utility_expenses_telephone","utility_expenses_water","utility_expenses_others","card_processor_fees","chargebacks","nsf_fees","overdraft_fees","other_fees","household_payments","groceries_payments","childcare_payments","support_and_alimony_payments","charitable_payments","transportation_payments","healthcare_payments","education_payments","dining_payments","personal_care_payments","entertainment_payments","fintech_loan_payments","bank_loan_payments","sba_payments","auto_finance_payments","mortgage_payments","other_loan_payments","debt_consolidator_payments","credit_card_payments","fintech_mca_payments","bank_cash_advance_payments","state_tax_payments","federal_tax_payments","payroll_tax_payments","internal_transfer_withdrawals","investment_withdrawals","merchant_service_transfer_withdrawals","deposited_check_returns","miscellaneous_withdrawals"]}],"title":"Category"},"category_group":{"anyOf":[{"type":"string","enum":["revenue_and_income","personal_income","reimbursements_and_refunds","loans_and_advances","miscellaneous_deposits"]},{"type":"string","enum":["business_expenses","personal_expenses","loans_and_advances","tax_payments","miscellaneous_withdrawals"]}],"title":"Category Group"},"category_subgroup":{"anyOf":[{"type":"string","enum":["sales_revenue","rewards_and_benefits","wages_and_salary","government_and_retirement","investment_and_rental_income","insurance_refunds","tax_refunds","transaction_reversals","unsecured_loan_proceeds","secured_loan_proceeds","other_loan_proceeds","cash_advances","miscellaneous_deposits"]},{"type":"string","enum":["vendor_and_supplier_payments","payroll_and_benefits","insurance","rent","travel_expenses","utility_expenses","fees_and_charges","housing_and_utilities","living_expenses","transportation","healthcare_and_education","discretionary","unsecured_loan_repayments","secured_loan_repayments","other_loan_repayments","cash_advance_repayments","tax_payments","miscellaneous_withdrawals"]}],"title":"Category Subgroup"},"channel":{"anyOf":[{"type":"string","enum":["cash_app_deposits_venmo_zelle","paypal_deposits","other_online_payment_deposits","atm_deposits","bank_branch_deposits","check_deposits","ach_credit_deposits","wire_transfer_deposits","crypto_deposits","other_deposit_channels"]},{"type":"string","enum":["debit_card_payments","credit_card_payments","cash_app_payments_venmo_zelle","paypal_payments","other_online_payments","ach_debit_withdrawals","atm_withdrawals","bank_branch_withdrawals","check_payments","wire_transfer_withdrawals","crypto_payments","other_payment_channels"]}],"title":"Channel"},"channel_group":{"anyOf":[{"type":"string","const":"deposit_channels"},{"type":"string","const":"payment_channels"}],"title":"Channel Group"},"channel_subgroup":{"anyOf":[{"type":"string","enum":["mobile_and_online_payment_deposits","bank_deposits","wire_transfers","cryptocurrency_deposits","other_deposit_channels"]},{"type":"string","enum":["card_payments","mobile_and_online_payments","bank_withdrawals","wire_transfers","cryptocurrency_payments","other_payment_channels"]}],"title":"Channel Subgroup"}},"type":"object","required":["bank_account_id","period_id","txn_id","date","description","amount","type","category","category_group","category_subgroup","channel","channel_group","channel_subgroup"],"title":"BankStatementTransaction"},"BankStatementsDeliverables-Input":{"properties":{"bank_accounts":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array","title":"Bank Accounts","default":[]},"transactions":{"items":{"$ref":"#/components/schemas/BankStatementTransaction"},"type":"array","title":"Transactions","default":[]},"analysis":{"items":{"$ref":"#/components/schemas/BankStatementAnalysis"},"type":"array","title":"Analysis","default":[]},"categorization":{"$ref":"#/components/schemas/BankStatementCategories","default":{"credit_categories":{},"credit_category_groups":{},"credit_category_subgroups":{},"credit_deposit_channels":{},"credit_deposit_channel_groups":{},"credit_deposit_channel_subgroups":{},"debit_categories":{},"debit_category_groups":{},"debit_category_subgroups":{},"debit_payment_channels":{},"debit_payment_channel_groups":{},"debit_payment_channel_subgroups":{}}}},"type":"object","title":"BankStatementsDeliverables"},"BankStatementsDeliverables-Output":{"properties":{"bank_accounts":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array","title":"Bank Accounts","default":[]},"transactions":{"items":{"$ref":"#/components/schemas/BankStatementTransaction"},"type":"array","title":"Transactions","default":[]},"analysis":{"items":{"$ref":"#/components/schemas/BankStatementAnalysis"},"type":"array","title":"Analysis","default":[]},"categorization":{"$ref":"#/components/schemas/BankStatementCategories","default":{"credit_categories":{},"credit_category_groups":{},"credit_category_subgroups":{},"credit_deposit_channels":{},"credit_deposit_channel_groups":{},"credit_deposit_channel_subgroups":{},"debit_categories":{},"debit_category_groups":{},"debit_category_subgroups":{},"debit_payment_channels":{},"debit_payment_channel_groups":{},"debit_payment_channel_subgroups":{}}}},"type":"object","title":"BankStatementsDeliverables"},"BankingAccountAggregate":{"properties":{"bank_account_id":{"type":"string","title":"Bank Account Id"},"source":{"$ref":"#/components/schemas/BankSourceFamily"},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Name"},"account_number_last4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number Last4"},"account_holder_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Holder Name"},"account_type":{"anyOf":[{"$ref":"#/components/schemas/BankAccountType"},{"type":"null"}]},"account_subtype":{"anyOf":[{"$ref":"#/components/schemas/BankAccountSubtype"},{"type":"null"}]},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"ISO 4217 three-letter code, case-insensitive. This account's own native currency."},"status":{"type":"string","const":"ACTIVE","title":"Status"},"is_eligible":{"type":"boolean","title":"Is Eligible","description":"Whether this account's balances count as cash. Ineligible accounts are still listed, because otherwise the excluded counts on an aggregate response cannot be explained."},"link_connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Connection Id"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At"},"periods":{"items":{"$ref":"#/components/schemas/BankingAccountBucket"},"type":"array","title":"Periods"}},"type":"object","required":["bank_account_id","source","bank_name","account_number_last4","account_holder_name","account_type","account_subtype","currency","status","is_eligible","link_connection_id","last_synced_at"],"title":"BankingAccountAggregate","description":"/aggregates with include_accounts=true -- the same identity /accounts\nreturns, carrying this account's own figures.\n\nThis is what makes a household total auditable: the summed balance is the\nsum of these, and an account excluded as ineligible or unclassified appears\nhere by name with its type, so the excluded counts stop being bare numbers."},"BankingAccountBucket":{"properties":{"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"total_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Deposits"},"total_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Withdrawals"},"net_cash_flow":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Cash Flow"},"traditional_debt_service_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Traditional Debt Service Amount","description":"Debits routed to term debt service -- bank and fintech loans, SBA, debt consolidation."},"mca_debit_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mca Debit Amount","description":"Debits routed to merchant cash advance repayment."},"secured_asset_debt_service_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Secured Asset Debt Service Amount","description":"Debits routed to debt secured on an asset -- vehicle finance and mortgages. Note this does NOT isolate equipment finance: the taxonomy has no equipment leaf, so financed equipment is counted in `traditional_debt_service_amount`."},"third_party_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Third Party Deposits","description":"`total_deposits` less money that came from the borrower's own other accounts or from its related parties (owners, affiliates, other parties on its deals): what came in from everyone else."},"third_party_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Third Party Withdrawals","description":"`total_withdrawals` less money sent to the borrower's own other accounts or to its related parties."},"inter_party_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Inter Party Deposits","description":"Deposits from the borrower's related parties."},"inter_party_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Inter Party Withdrawals","description":"Withdrawals to the borrower's related parties."},"own_account_transfer_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Own Account Transfer Deposits","description":"Deposits moved in from the borrower's own other accounts."},"own_account_transfer_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Own Account Transfer Withdrawals","description":"Withdrawals moved out to the borrower's own other accounts."},"opening_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Opening Balance"},"closing_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Closing Balance"},"avg_daily_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Daily Balance"},"min_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Balance"},"max_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Balance"},"balance_basis":{"anyOf":[{"$ref":"#/components/schemas/AggregateBalanceBasis"},{"type":"null"}]},"deposit_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Deposit Count"},"withdrawal_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Withdrawal Count"},"transaction_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transaction Count"},"average_transaction_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Average Transaction Amount"},"days_negative_balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Days Negative Balance"},"nsf_returned_item_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Nsf Returned Item Count"},"returned_deposit_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Returned Deposit Count"},"failed_ach_debit_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failed Ach Debit Count"},"nsf_fee_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Nsf Fee Count"},"overdraft_fee_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Overdraft Fee Count"},"months_requested":{"type":"integer","title":"Months Requested"},"months_covered":{"type":"integer","title":"Months Covered"},"coverage_complete":{"type":"boolean","title":"Coverage Complete"},"incomplete_reasons":{"items":{"$ref":"#/components/schemas/BucketIncompleteReason"},"type":"array","title":"Incomplete Reasons"},"shape_notes":{"items":{"$ref":"#/components/schemas/BucketShapeNote"},"type":"array","title":"Shape Notes"}},"type":"object","required":["period_start","period_end","total_deposits","total_withdrawals","net_cash_flow","traditional_debt_service_amount","mca_debit_amount","secured_asset_debt_service_amount","opening_balance","closing_balance","avg_daily_balance","min_balance","max_balance","balance_basis","deposit_count","withdrawal_count","transaction_count","average_transaction_amount","days_negative_balance","nsf_returned_item_count","returned_deposit_count","failed_ach_debit_count","nsf_fee_count","overdraft_fee_count","months_requested","months_covered","coverage_complete"],"title":"BankingAccountBucket","description":"One account's own bucket. Carries no account counts: they would be 1 and\n1, and a field that exists only to be degenerate gets read as meaningful."},"BankingAccountPeriod":{"properties":{"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"balance_basis":{"anyOf":[{"$ref":"#/components/schemas/BankBalanceBasis"},{"type":"null"}]},"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id"},"tamper_checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tamper Checked"},"tamper_risk_signal_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tamper Risk Signal Count"},"tamper_risk_identifiers":{"items":{"$ref":"#/components/schemas/TamperRiskKind"},"type":"array","title":"Tamper Risk Identifiers","description":"Which findings, in Accend's vocabulary rather than an analysis supplier's. Empty when nothing was found AND when nothing was checked -- `tamper_checked` separates those. Shorter than `tamper_risk_signal_count` when two findings share a kind: the count is how many findings, this is which kinds."},"reconciliation_error":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Reconciliation Error"}},"type":"object","required":["period_start","period_end","balance_basis","cust_doc_id","tamper_checked","tamper_risk_signal_count","reconciliation_error"],"title":"BankingAccountPeriod","description":"One statement period, as discovery -- its range and where it came from,\nnot its figures. Figures come from POST /banking/aggregates with\nperiod_length=1."},"BankingAccountRow":{"properties":{"bank_account_id":{"type":"string","title":"Bank Account Id"},"source":{"$ref":"#/components/schemas/BankSourceFamily"},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Name"},"account_number_last4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number Last4"},"account_holder_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Holder Name"},"account_type":{"anyOf":[{"$ref":"#/components/schemas/BankAccountType"},{"type":"null"}]},"account_subtype":{"anyOf":[{"$ref":"#/components/schemas/BankAccountSubtype"},{"type":"null"}]},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"ISO 4217 three-letter code, case-insensitive. This account's own native currency."},"status":{"type":"string","const":"ACTIVE","title":"Status"},"is_eligible":{"type":"boolean","title":"Is Eligible","description":"Whether this account's balances count as cash. Ineligible accounts are still listed, because otherwise the excluded counts on an aggregate response cannot be explained."},"link_connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Connection Id"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At"},"statement_periods":{"items":{"$ref":"#/components/schemas/BankingAccountPeriod"},"type":"array","title":"Statement Periods"},"has_coverage_gaps":{"type":"boolean","title":"Has Coverage Gaps"},"import_format":{"anyOf":[{"$ref":"#/components/schemas/BankImportFormat"},{"type":"null"}],"description":"For a `source: import` account, the shape it was sent in: `plaid` or `generic`. Null for every other family."},"account_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Key","description":"For an imported account, the key it was created under: Plaid's persistent_account_id when there was one, else the account_id you first sent. Null for every other family."},"known_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Known Ids","description":"For an imported account, every id you have used for it."}},"type":"object","required":["bank_account_id","source","bank_name","account_number_last4","account_holder_name","account_type","account_subtype","currency","status","is_eligible","link_connection_id","last_synced_at","has_coverage_gaps"],"title":"BankingAccountRow","description":"/accounts -- identity plus what this account actually covers."},"BankingAccountsResponse":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"accounts":{"items":{"$ref":"#/components/schemas/BankingAccountRow"},"type":"array","title":"Accounts"},"total":{"type":"integer","title":"Total"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["customer_id","accounts","total"],"title":"BankingAccountsResponse"},"BankingAggregateResult":{"properties":{"search_id":{"type":"string","title":"Search Id"},"by_source":{"items":{"$ref":"#/components/schemas/BankingSourceResult"},"type":"array","title":"By Source"}},"type":"object","required":["search_id","by_source"],"title":"BankingAggregateResult"},"BankingAggregatesRequest":{"properties":{"searches":{"items":{"$ref":"#/components/schemas/BankingSearchCriteria"},"type":"array","maxItems":20,"minItems":1,"title":"Searches"},"sources":{"items":{"$ref":"#/components/schemas/BankSourceFamily"},"type":"array","title":"Sources","description":"Which records to read. Omit to read every family. Each is returned separately and never combined. Note `document` means statements processed by an analyser and does NOT include CSV imports, which appear under `manual` -- so `[\"document\"]` is narrower than \"everything from a file\".","default":["plaid","document","manual","import"]},"include_accounts":{"type":"boolean","title":"Include Accounts","description":"Return every account behind these figures, with its own buckets. Excluded accounts appear too, with `is_eligible: false` -- that is what makes the household total auditable and the excluded counts explainable.","default":false},"include_breakdowns":{"type":"boolean","title":"Include Breakdowns","description":"Return category and channel rollups of the window's transactions.","default":false},"target_currency":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Target Currency","description":"ISO 4217 three-letter code, case-insensitive. Convert every money field to this currency, the same way `target_currency` works on GET /cases/{case_id}. One rate is applied to the whole result. Omit it to get the figures in the currency the accounts are already denominated in. Counts are not money and are never scaled. Accounts in different currencies still refuse -- one rate cannot convert two source currencies."},"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Accend customer id."}},"type":"object","required":["searches","customer_id"],"title":"BankingAggregatesRequest"},"BankingAggregatesRequestExt":{"properties":{"searches":{"items":{"$ref":"#/components/schemas/BankingSearchCriteria"},"type":"array","maxItems":20,"minItems":1,"title":"Searches"},"sources":{"items":{"$ref":"#/components/schemas/BankSourceFamily"},"type":"array","title":"Sources","description":"Which records to read. Omit to read every family. Each is returned separately and never combined. Note `document` means statements processed by an analyser and does NOT include CSV imports, which appear under `manual` -- so `[\"document\"]` is narrower than \"everything from a file\".","default":["plaid","document","manual","import"]},"include_accounts":{"type":"boolean","title":"Include Accounts","description":"Return every account behind these figures, with its own buckets. Excluded accounts appear too, with `is_eligible: false` -- that is what makes the household total auditable and the excluded counts explainable.","default":false},"include_breakdowns":{"type":"boolean","title":"Include Breakdowns","description":"Return category and channel rollups of the window's transactions.","default":false},"target_currency":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Target Currency","description":"ISO 4217 three-letter code, case-insensitive. Convert every money field to this currency, the same way `target_currency` works on GET /cases/{case_id}. One rate is applied to the whole result. Omit it to get the figures in the currency the accounts are already denominated in. Counts are not money and are never scaled. Accounts in different currencies still refuse -- one rate cannot convert two source currencies."},"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"Your own customer id."}},"type":"object","required":["searches","external_customer_id"],"title":"BankingAggregatesRequestExt"},"BankingAggregatesResponse":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"results":{"items":{"$ref":"#/components/schemas/BankingAggregateResult"},"type":"array","title":"Results"}},"type":"object","required":["customer_id","results"],"title":"BankingAggregatesResponse"},"BankingBreakdownNode-Input":{"properties":{"key":{"type":"string","title":"Key"},"label":{"type":"string","title":"Label"},"count":{"type":"integer","title":"Count"},"amount":{"type":"number","title":"Amount"},"subgroups":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Input"},"type":"array","title":"Subgroups"},"leaves":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Input"},"type":"array","title":"Leaves"}},"type":"object","required":["key","label","count","amount"],"title":"BankingBreakdownNode","description":"One node of the category tree. `amount` is signed like the ledger:\ncredits positive, debits negative."},"BankingBreakdownNode-Output":{"properties":{"key":{"type":"string","title":"Key"},"label":{"type":"string","title":"Label"},"count":{"type":"integer","title":"Count"},"amount":{"type":"number","title":"Amount"},"subgroups":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Output"},"type":"array","title":"Subgroups"},"leaves":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Output"},"type":"array","title":"Leaves"}},"type":"object","required":["key","label","count","amount"],"title":"BankingBreakdownNode","description":"One node of the category tree. `amount` is signed like the ledger:\ncredits positive, debits negative."},"BankingBreakdowns-Input":{"properties":{"credit":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Input"},"type":"array","title":"Credit"},"debit":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Input"},"type":"array","title":"Debit"},"credit_channels":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Input"},"type":"array","title":"Credit Channels"},"debit_channels":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Input"},"type":"array","title":"Debit Channels"}},"type":"object","title":"BankingBreakdowns","description":"Two rollups of the same transactions: `credit`/`debit` say what the money\nwas FOR, `credit_channels`/`debit_channels` say how it MOVED."},"BankingBreakdowns-Output":{"properties":{"credit":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Output"},"type":"array","title":"Credit"},"debit":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Output"},"type":"array","title":"Debit"},"credit_channels":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Output"},"type":"array","title":"Credit Channels"},"debit_channels":{"items":{"$ref":"#/components/schemas/BankingBreakdownNode-Output"},"type":"array","title":"Debit Channels"}},"type":"object","title":"BankingBreakdowns","description":"Two rollups of the same transactions: `credit`/`debit` say what the money\nwas FOR, `credit_channels`/`debit_channels` say how it MOVED."},"BankingCoverageNote":{"type":"string","enum":["partial_coverage","mixed_currency_no_fx","no_eligible_accounts","balances_unavailable","uneven_account_coverage"],"title":"BankingCoverageNote","description":"Caveats about a whole source result. Machine-readable so a caller can\nbranch, rather than inferring meaning from a null."},"BankingDocumentAuthenticity":{"properties":{"checked":{"type":"boolean","title":"Checked"},"documents_checked":{"type":"integer","title":"Documents Checked"},"documents_total":{"type":"integer","title":"Documents Total"},"risk_signal_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Risk Signal Count"},"risk_identifiers":{"items":{"$ref":"#/components/schemas/TamperRiskKind"},"type":"array","title":"Risk Identifiers","description":"Which kinds of finding this set carries, in Accend's vocabulary. Empty when `checked` is false -- nothing was examined, so there is nothing to report rather than nothing to find."}},"type":"object","required":["checked","documents_checked","documents_total","risk_signal_count"],"title":"BankingDocumentAuthenticity","description":"Tamper findings for the documents behind a document-family result.\n\nRISK findings only. The document analyser attaches informational signals to\nnearly every document, so a raw signal count would flag most clean statements\nfor looking normal. Allowlist, never denylist: an unrecognised future signal\ntype must not read as risk."},"BankingPeriodAggregate":{"properties":{"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"total_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Deposits"},"total_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Withdrawals"},"net_cash_flow":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Net Cash Flow"},"traditional_debt_service_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Traditional Debt Service Amount","description":"Debits routed to term debt service -- bank and fintech loans, SBA, debt consolidation."},"mca_debit_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mca Debit Amount","description":"Debits routed to merchant cash advance repayment."},"secured_asset_debt_service_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Secured Asset Debt Service Amount","description":"Debits routed to debt secured on an asset -- vehicle finance and mortgages. Note this does NOT isolate equipment finance: the taxonomy has no equipment leaf, so financed equipment is counted in `traditional_debt_service_amount`."},"third_party_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Third Party Deposits","description":"`total_deposits` less money that came from the borrower's own other accounts or from its related parties (owners, affiliates, other parties on its deals): what came in from everyone else."},"third_party_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Third Party Withdrawals","description":"`total_withdrawals` less money sent to the borrower's own other accounts or to its related parties."},"inter_party_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Inter Party Deposits","description":"Deposits from the borrower's related parties."},"inter_party_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Inter Party Withdrawals","description":"Withdrawals to the borrower's related parties."},"own_account_transfer_deposits":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Own Account Transfer Deposits","description":"Deposits moved in from the borrower's own other accounts."},"own_account_transfer_withdrawals":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Own Account Transfer Withdrawals","description":"Withdrawals moved out to the borrower's own other accounts."},"opening_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Opening Balance"},"closing_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Closing Balance"},"avg_daily_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Daily Balance"},"min_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Balance"},"max_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Balance"},"balance_basis":{"anyOf":[{"$ref":"#/components/schemas/AggregateBalanceBasis"},{"type":"null"}]},"deposit_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Deposit Count"},"withdrawal_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Withdrawal Count"},"transaction_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Transaction Count"},"average_transaction_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Average Transaction Amount"},"days_negative_balance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Days Negative Balance"},"nsf_returned_item_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Nsf Returned Item Count"},"returned_deposit_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Returned Deposit Count"},"failed_ach_debit_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failed Ach Debit Count"},"nsf_fee_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Nsf Fee Count"},"overdraft_fee_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Overdraft Fee Count"},"months_requested":{"type":"integer","title":"Months Requested"},"months_covered":{"type":"integer","title":"Months Covered"},"coverage_complete":{"type":"boolean","title":"Coverage Complete"},"incomplete_reasons":{"items":{"$ref":"#/components/schemas/BucketIncompleteReason"},"type":"array","title":"Incomplete Reasons"},"shape_notes":{"items":{"$ref":"#/components/schemas/BucketShapeNote"},"type":"array","title":"Shape Notes"},"accounts_reporting":{"type":"integer","title":"Accounts Reporting"},"accounts_expected":{"type":"integer","title":"Accounts Expected"}},"type":"object","required":["period_start","period_end","total_deposits","total_withdrawals","net_cash_flow","traditional_debt_service_amount","mca_debit_amount","secured_asset_debt_service_amount","opening_balance","closing_balance","avg_daily_balance","min_balance","max_balance","balance_basis","deposit_count","withdrawal_count","transaction_count","average_transaction_amount","days_negative_balance","nsf_returned_item_count","returned_deposit_count","failed_ach_debit_count","nsf_fee_count","overdraft_fee_count","months_requested","months_covered","coverage_complete","accounts_reporting","accounts_expected"],"title":"BankingPeriodAggregate","description":"A household bucket, summed across the family's eligible accounts."},"BankingSearchCriteria":{"properties":{"search_id":{"type":"string","title":"Search Id","description":"Caller-supplied id, echoed back on the matching result."},"start_period":{"type":"string","format":"date","title":"Start Period","description":"First day of the window. Must be the first day of a month."},"end_period":{"type":"string","format":"date","title":"End Period","description":"Last day of the window. Must be the last day of a month."},"period_length":{"anyOf":[{"type":"integer","maximum":120.0,"minimum":1.0},{"type":"null"}],"title":"Period Length","description":"Months per returned bucket: 1 monthly, 3 quarterly, 12 annual. Omit for a single bucket spanning the whole window. Buckets are anchored to start_period, not to calendar quarters, and an uneven window ends in a shorter bucket. Note this SHAPES the result rather than filtering it, unlike the identically-named field on /financials/statements/search: a bank statement period is always about a month, so filtering by length would match everything or nothing."}},"type":"object","required":["search_id","start_period","end_period"],"title":"BankingSearchCriteria","description":"One window, and how to cut it up."},"BankingSourceResult":{"properties":{"source":{"$ref":"#/components/schemas/BankSourceFamily"},"authenticity":{"anyOf":[{"$ref":"#/components/schemas/BankingDocumentAuthenticity"},{"type":"null"}]},"reporting_currency":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Reporting Currency","description":"ISO 4217 three-letter code, case-insensitive. The currency every money field here is expressed in. Null when `notes` carries `mixed_currency_no_fx`, in which case every money field is null too, and on a case result that carries no figures at all -- there is then no money to denominate. Never null beside a populated figure."},"account_count":{"type":"integer","title":"Account Count"},"ineligible_account_count":{"type":"integer","title":"Ineligible Account Count","description":"Accounts known not to hold cash -- a credit card, a loan, a mortgage. Excluded from every figure here. To reconcile a ledger against these figures, pass `include_ineligible_accounts=false` to GET /banking/transactions, which drops the same accounts."},"earliest_period_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Earliest Period Start"},"latest_period_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Latest Period End"},"period_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Period Length"},"periods":{"items":{"$ref":"#/components/schemas/BankingPeriodAggregate"},"type":"array","title":"Periods"},"by_account":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankingAccountAggregate"},"type":"array"},{"type":"null"}],"title":"By Account"},"breakdowns":{"anyOf":[{"$ref":"#/components/schemas/BankingBreakdowns-Output"},{"type":"null"}]},"notes":{"items":{"$ref":"#/components/schemas/BankingCoverageNote"},"type":"array","title":"Notes"}},"type":"object","required":["source","reporting_currency","account_count","ineligible_account_count","earliest_period_start","latest_period_end","period_length"],"title":"BankingSourceResult","description":"One source family's answer. Never combined with another's."},"BankingTransactionRow":{"properties":{"txn_id":{"type":"string","title":"Txn Id"},"bank_account_id":{"type":"string","title":"Bank Account Id"},"posted_date":{"type":"string","format":"date","title":"Posted Date"},"amount":{"type":"number","title":"Amount","description":"How much moved. **Positive is money into the account** (a deposit, a refund, an incoming transfer); **negative is money out** (a payment, a withdrawal, a fee). In the account's own currency unless `target_currency` was passed; `currency` on this row says which it is in."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"merchant_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Name"},"category_group":{"anyOf":[{"type":"string","enum":["revenue_and_income","personal_income","reimbursements_and_refunds","loans_and_advances","miscellaneous_deposits"]},{"type":"string","enum":["business_expenses","personal_expenses","loans_and_advances","tax_payments","miscellaneous_withdrawals"]},{"type":"null"}],"title":"Category Group","description":"What the money was FOR, at the coarsest level. Null when the transaction was not categorised, or was categorised into a value this version does not publish."},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"The specific leaf beneath `category_group`, e.g. `card_sales`. Open rather than a fixed list: the vocabulary grows, and older rows keep the leaf they were given. Use `category_group` to branch on, and `include_breakdowns` for the full tree."},"channel":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel","description":"HOW the money moved, e.g. `wire_transfer_deposits`. Open for the same reason as `category`."},"channel_group":{"anyOf":[{"type":"string","const":"deposit_channels"},{"type":"string","const":"payment_channels"},{"type":"null"}],"title":"Channel Group","description":"The direction the channel belongs to. Two values, so this separates in from out rather than telling you the method -- `channel` is the useful half."},"running_balance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Running Balance","description":"The account's balance immediately AFTER this transaction, in the account's own currency. Walking the rows in date order, each one is the previous balance plus this row's `amount`. Null when the source did not report a balance for the row -- it is not recomputed, so a null here is a gap in the record rather than a zero balance."},"source":{"anyOf":[{"$ref":"#/components/schemas/BankSourceFamily"},{"type":"null"}]},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"ISO 4217 three-letter code, case-insensitive."},"transfer_kind":{"anyOf":[{"type":"string","enum":["own_account","inter_party"]},{"type":"null"}],"title":"Transfer Kind","description":"Set when this row moved money between the borrower's own accounts (`own_account`) or to or from one of its related parties (`inter_party`). Null for every other row. Rows with a value add up to the bucket's `own_account_transfer_*` and `inter_party_*` figures."},"import_format":{"anyOf":[{"$ref":"#/components/schemas/BankImportFormat"},{"type":"null"}],"description":"For a row of an imported account, `plaid` or `generic`; `txn_id` is then the id you sent. Null for every other family."}},"type":"object","required":["txn_id","bank_account_id","posted_date","amount","description","merchant_name","category_group","category","channel","channel_group","running_balance","source","currency"],"title":"BankingTransactionRow","description":"One ledger row. Carries no provenance field -- `bank_account_id` is the\njoin key, and provenance lives on /accounts for both families: `cust_doc_id`\nper statement period for documents, `link_connection_id` per account for\nplaid."},"BankingTransactionsResponse":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"source":{"anyOf":[{"$ref":"#/components/schemas/BankSourceFamily"},{"type":"null"}]},"transactions":{"items":{"$ref":"#/components/schemas/BankingTransactionRow"},"type":"array","title":"Transactions"},"total":{"type":"integer","title":"Total"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["customer_id","transactions","total"],"title":"BankingTransactionsResponse"},"BestEffortSpreadingRequest":{"properties":{"included_statements":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestStatementType"},"type":"array"},{"type":"null"}],"title":"Included Statements","description":"Financial statements to include"},"included_tax_returns":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestTaxFormType"},"type":"array"},{"type":"null"}],"title":"Included Tax Returns","description":"Tax document types to include. `tax_return` refers to the entity's primary return (e.g., 1040 for individuals, 1120/1065 for businesses)."},"included_rent_rolls":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestRentRollType"},"type":"array"},{"type":"null"}],"title":"Included Rent Rolls","description":"Rent roll types to include"}},"type":"object","title":"BestEffortSpreadingRequest"},"Body_upload_fin_stmt_documents_api_v1_financials_upload_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_upload_fin_stmt_documents_api_v1_financials_upload_post"},"BucketIncompleteReason":{"type":"string","enum":["no_data","partial_months","partial_days","account_missing"],"title":"BucketIncompleteReason","description":"Why one bucket's coverage fell short of the months it was asked for."},"BucketShapeNote":{"type":"string","enum":["short_final_bucket","future_period"],"title":"BucketShapeNote","description":"How this bucket's shape differs from a full period. Both are incomplete,\nand neither is a gap anyone can fill."},"BulkAccountOverrideUpsertRequest":{"properties":{"statement_overrides":{"items":{"$ref":"#/components/schemas/StatementAccountOverrideUpsert"},"type":"array","title":"Statement Overrides","description":"Batch of statement-level overrides, has to belong to the same entity"}},"type":"object","required":["statement_overrides"],"title":"BulkAccountOverrideUpsertRequest"},"BulkCustomerFinancialsResultItem":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"basic_info":{"anyOf":[{"$ref":"#/components/schemas/SpreadingCustomerBasicInfoSchema"},{"type":"null"}]},"search_results":{"items":{"$ref":"#/components/schemas/SpreadingCustomerFinancialsSearchResultSchema"},"type":"array","title":"Search Results","default":[]},"http_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Http Code"},"error_msg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Msg"}},"type":"object","required":["customer_id"],"title":"BulkCustomerFinancialsResultItem"},"BulkGetAssetFinancialsRequest":{"properties":{"asset_id":{"type":"string","maxLength":255,"title":"Asset Id","description":"Asset ID in our system for the asset the case belongs to"},"statement_ids":{"items":{"type":"string"},"type":"array","title":"Statement Ids","description":"List of statement IDs to get"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency to convert the financials to. If not provided, the financials will be returned in the asset's currency."}},"type":"object","required":["asset_id","statement_ids"],"title":"BulkGetAssetFinancialsRequest"},"BulkGetCustomerFinancialsRequest":{"properties":{"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"statement_ids":{"items":{"type":"string"},"type":"array","title":"Statement Ids","description":"List of statement IDs to get"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency to convert the financials to. If not provided, the financials will be returned in the customer's currency."}},"type":"object","required":["customer_id","statement_ids"],"title":"BulkGetCustomerFinancialsRequest"},"BulkGetCustomerFinancialsRequestExt":{"properties":{"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"external customer id for the customer the financials belongs to"},"statement_ids":{"items":{"type":"string"},"type":"array","title":"Statement Ids","description":"List of statement IDs to get"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency to convert the financials to. If not provided, the financials will be returned in the customer's currency."}},"type":"object","required":["external_customer_id","statement_ids"],"title":"BulkGetCustomerFinancialsRequestExt"},"BulkSearchCustomerFinancialsRequest":{"properties":{"customer_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":220},{"type":"null"}],"title":"Customer Ids","description":"List of internal customer IDs (max 220)"},"external_customer_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":220},{"type":"null"}],"title":"External Customer Ids","description":"List of external customer IDs (max 220)"},"searches":{"items":{"$ref":"#/components/schemas/CustomerFinancialsSearchCriteria"},"type":"array","minItems":1,"title":"Searches","description":"Search criteria applied to all customers"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency for conversion"},"full_history":{"type":"boolean","title":"Full History","description":"Return every statement instead of the entity's main collection, which holds one statement per period.","default":false}},"type":"object","required":["searches"],"title":"BulkSearchCustomerFinancialsRequest"},"BulkSearchCustomerFinancialsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BulkCustomerFinancialsResultItem"},"type":"array","title":"Results"}},"type":"object","required":["results"],"title":"BulkSearchCustomerFinancialsResponse"},"BulkSearchStatementsRequest":{"properties":{"customer_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":220},{"type":"null"}],"title":"Customer Ids","description":"List of internal customer IDs (max 220)"},"external_customer_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":220},{"type":"null"}],"title":"External Customer Ids","description":"List of external customer IDs (max 220)"},"searches":{"items":{"$ref":"#/components/schemas/CustomerFinancialsSearchCriteria"},"type":"array","minItems":1,"title":"Searches","description":"Search criteria applied to all entities"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency for conversion"},"full_history":{"type":"boolean","title":"Full History","description":"Return every statement instead of each entity's main collection, which holds one statement per period. Each statement then carries its `collection_ids`, and each entity its `main_collection_id`.","default":false}},"type":"object","required":["searches"],"title":"BulkSearchStatementsRequest"},"BulkSearchStatementsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BulkSearchStatementsResultItem"},"type":"array","title":"Results"}},"type":"object","required":["results"],"title":"BulkSearchStatementsResponse"},"BulkSearchStatementsResultItem":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"search_results":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array","title":"Search Results","default":[]},"main_collection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Collection Id"},"http_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Http Code"},"error_msg":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Msg"}},"type":"object","required":["entity_id"],"title":"BulkSearchStatementsResultItem"},"BusinessCreate":{"properties":{"legal_name":{"type":"string","maxLength":255,"minLength":1,"title":"Legal Name"},"dba_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Dba Name"},"website":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Website"},"address":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Address"},"fiscal_year_start_month":{"anyOf":[{"$ref":"#/components/schemas/MonthType"},{"type":"null"}]},"legal_structure":{"anyOf":[{"$ref":"#/components/schemas/LegalStructure"},{"type":"null"}]},"formation_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Formation Date"},"registration_number":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Registration Number"},"registration_country":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Registration Country","description":"ISO 3166-1 alpha-2 country code, e.g. US."},"ticker":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Ticker"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"}},"type":"object","required":["legal_name"],"title":"BusinessCreate"},"BusinessCustomerResponse":{"properties":{"customer_id":{"type":"string","title":"Customer Id","description":"Customer ID in our system"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"External Customer ID"},"fin_template_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Template Key","description":"Financial template key in our system"},"customer_type":{"type":"string","const":"business","title":"Customer Type","default":"business"},"legal_name":{"type":"string","title":"Legal Name","description":"Company Legal name of the customer"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dba Name","description":"Company Doing Business As name"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker","description":"Public company ticker, e.g. AAPL"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Company website"},"industry_codes":{"anyOf":[{"items":{"$ref":"#/components/schemas/IndustryCode-Output"},"type":"array"},{"type":"null"}],"title":"Industry Codes","description":"The company's industry codes"},"link_connections":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinkConnectionMetadata"},"type":"array"},{"type":"null"}],"title":"Link Connections","description":"The company's link connections"},"fiscal_year_start_month":{"$ref":"#/components/schemas/MonthType","description":"The start month of the fiscal year"},"enabled_combined_financials":{"type":"boolean","title":"Enabled Combined Financials","description":"Whether the company's financials are enabled for combined financials","default":false},"legal_structure":{"anyOf":[{"$ref":"#/components/schemas/LegalStructure"},{"type":"null"}],"description":"Legal structure. One of: `c_corp`: C Corporation; `s_corp`: S Corporation; `close_corp`: Close Corporation; `professional_corp`: Professional Corporation (PC); `benefit_corp`: Benefit Corporation / Public Benefit Corporation (For-Profit); `publicly_traded_corp`: Publicly Traded Corporation; `alien_corp`: Alien Corporation; `cooperative`: Cooperative (Incorporated); `partnership`: General Partnership (GP); `limited_partnership`: Limited Partnership (LP); `llp`: Limited Liability Partnership (LLP); `lllp`: Limited Liability Limited Partnership (LLLP); `llc`: Limited Liability Company (LLC); `pllc`: Professional Limited Liability Company (PLLC); `sole_prop`: Sole Proprietorship; `non_profit`: Nonprofit / Not-for-Profit Organization; `private_school`: Private School; `public_school`: Public School / School District; `government`: Government Entity; `public_authority`: Public Authority / Quasi-Public Corporation; `trust`: Trust; `unincorporated_association`: Unincorporated Association; `other`: Other."},"formation_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Formation Date","description":"Date the business entity was formed"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Number","description":"Business registration number (US: EIN/TIN)"},"registration_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Country","description":"ISO 3166-1 alpha-2 country of registration"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Company address"},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line1","description":"Verified address line 1"},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line2","description":"Verified address line 2"},"address_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Postal Code","description":"Verified postal code"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Customer creation time in ISO format"},"currency":{"type":"string","title":"Currency","description":"Currency code"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Org-defined custom attributes"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"Customer status (active, inactive, onboarding, suspended)"}},"type":"object","required":["customer_id","external_customer_id","legal_name","fiscal_year_start_month","created_at","currency","status"],"title":"BusinessCustomerResponse"},"BusinessDescriptionResult":{"properties":{"description_consistency":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Description Consistency"},"business_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Description"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"inconsistent_references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inconsistent References"}},"type":"object","required":["description_consistency","business_description","reason","inconsistent_references"],"title":"BusinessDescriptionResult"},"BusinessPartyRef":{"properties":{"kind":{"type":"string","const":"business","title":"Kind"},"mode":{"$ref":"#/components/schemas/ResolutionMode"},"id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Id"},"external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id"},"obj":{"anyOf":[{"$ref":"#/components/schemas/BusinessCreate"},{"type":"null"}]},"role":{"$ref":"#/components/schemas/AdditionalPartyRole"}},"type":"object","required":["kind","mode","role"],"title":"BusinessPartyRef"},"BusinessRef":{"properties":{"kind":{"type":"string","const":"business","title":"Kind"},"mode":{"$ref":"#/components/schemas/ResolutionMode"},"id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Id"},"external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id"},"obj":{"anyOf":[{"$ref":"#/components/schemas/BusinessCreate"},{"type":"null"}]}},"type":"object","required":["kind","mode"],"title":"BusinessRef","description":"A company.\n\n``mode: create``, and ``link_or_create`` when the external id is unknown,\nfirst look for an existing business in your organization with the same\nlegal name (case-insensitive) and link it (``resolution: linked``) rather\nthan creating a duplicate; under ``link_or_create`` the external id is then\nstamped on it, unless it already carries a different one, which is a 409\ncustomer_identity_conflict. A match that carries a fraud disposition is\nrefused with 409 flagged_entity_match; link it explicitly by ``id`` or\n``external_id`` if that is intended."},"BusinessVerificationResult-Input":{"properties":{"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"website_presence":{"anyOf":[{"$ref":"#/components/schemas/WebsitePresenceResult"},{"type":"null"}]},"linkedin_presence":{"anyOf":[{"$ref":"#/components/schemas/LinkedinPresenceResult"},{"type":"null"}]},"confidence":{"anyOf":[{"type":"string","enum":["LOW","MEDIUM","HIGH"]},{"type":"null"}],"title":"Confidence"},"references":{"items":{"$ref":"#/components/schemas/Reference"},"type":"array","title":"References"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["business_name","confidence","references","reason"],"title":"BusinessVerificationResult"},"BusinessVerificationResult-Output":{"properties":{"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"website_presence":{"anyOf":[{"$ref":"#/components/schemas/WebsitePresenceResult"},{"type":"null"}]},"linkedin_presence":{"anyOf":[{"$ref":"#/components/schemas/LinkedinPresenceResult"},{"type":"null"}]},"confidence":{"anyOf":[{"type":"string","enum":["LOW","MEDIUM","HIGH"]},{"type":"null"}],"title":"Confidence"},"references":{"items":{"$ref":"#/components/schemas/Reference"},"type":"array","title":"References"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["business_name","confidence","references","reason"],"title":"BusinessVerificationResult"},"CFSInvolvedCustomerCreationSchema":{"properties":{"customer_id":{"type":"string","title":"Customer Id","description":"Customer ID"},"contribution":{"type":"number","title":"Contribution","description":"Contribution should be between 0 and 1"}},"type":"object","required":["customer_id","contribution"],"title":"CFSInvolvedCustomerCreationSchema"},"CFSInvolvedCustomerSchema":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"legal_name":{"type":"string","title":"Legal Name"},"customer_type":{"$ref":"#/components/schemas/CustomerType"},"contribution":{"type":"number","title":"Contribution"}},"type":"object","required":["customer_id","legal_name","customer_type","contribution"],"title":"CFSInvolvedCustomerSchema"},"CFSInvolvedPropertyCreationSchema":{"properties":{"property_id":{"type":"string","title":"Property Id","description":"Property ID"},"contribution":{"type":"number","title":"Contribution","description":"Contribution should be between 0 and 1"}},"type":"object","required":["property_id","contribution"],"title":"CFSInvolvedPropertyCreationSchema"},"CFSInvolvedPropertySchema":{"properties":{"property_id":{"type":"string","title":"Property Id"},"legal_name":{"type":"string","title":"Legal Name"},"contribution":{"type":"number","title":"Contribution"}},"type":"object","required":["property_id","legal_name","contribution"],"title":"CFSInvolvedPropertySchema"},"CFSPeriodColumnCustomCreationSchema":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Id","description":"Selected statement id for this customer for this period. If omitted, the column is generated as a 0-fill placeholder."},"sort_order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sort Order"}},"type":"object","required":["customer_id"],"title":"CFSPeriodColumnCustomCreationSchema"},"CFSPeriodColumnLineItemSchema":{"properties":{"coa_account_key":{"type":"string","title":"Coa Account Key"},"formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formula"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"str_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Str Value"},"bool_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bool Value"},"date_value":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date Value"},"is_overridden_value":{"type":"boolean","title":"Is Overridden Value","default":false}},"type":"object","required":["coa_account_key"],"title":"CFSPeriodColumnLineItemSchema","description":"Schema for COA statement line item"},"CFSPeriodColumnPropertyCreationSchema":{"properties":{"property_id":{"type":"string","title":"Property Id"},"statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Id","description":"Selected statement id for this property for this period. If omitted, the column is generated as a 0-fill placeholder."},"sort_order":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sort Order"}},"type":"object","required":["property_id"],"title":"CFSPeriodColumnPropertyCreationSchema"},"CFSPeriodColumnSchema":{"properties":{"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"property_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"},"statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Id"},"used_statement_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Used Statement Updated At"},"latest_statement_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Latest Statement Updated At"},"customer_type":{"anyOf":[{"$ref":"#/components/schemas/CustomerType"},{"type":"null"}]},"column_type":{"$ref":"#/components/schemas/CashFlowScenarioColumnType"},"start_period":{"type":"string","title":"Start Period"},"end_period":{"type":"string","title":"End Period"},"period_length":{"type":"integer","title":"Period Length"},"sort_order":{"type":"integer","title":"Sort Order"},"line_items":{"items":{"$ref":"#/components/schemas/CFSPeriodColumnLineItemSchema"},"type":"array","title":"Line Items"}},"type":"object","required":["column_type","start_period","end_period","period_length","sort_order","line_items"],"title":"CFSPeriodColumnSchema"},"CFSPeriodCreationSchema":{"properties":{"start_period":{"type":"string","format":"date","title":"Start Period","description":"Start period in ISO format date string"},"end_period":{"type":"string","format":"date","title":"End Period","description":"End period in ISO format date string"},"selected_party_periods":{"items":{"anyOf":[{"$ref":"#/components/schemas/CFSPeriodColumnCustomCreationSchema"},{"$ref":"#/components/schemas/CFSPeriodColumnPropertyCreationSchema"}]},"type":"array","title":"Selected Party Periods"}},"type":"object","required":["start_period","end_period","selected_party_periods"],"title":"CFSPeriodCreationSchema"},"CFSPeriodSchema":{"properties":{"start_period":{"type":"string","title":"Start Period"},"end_period":{"type":"string","title":"End Period"},"period_length":{"type":"integer","title":"Period Length"},"scenario_period_id":{"type":"string","title":"Scenario Period Id"},"selected_party_periods":{"items":{"$ref":"#/components/schemas/CFSPeriodColumnSchema"},"type":"array","title":"Selected Party Periods"}},"type":"object","required":["start_period","end_period","period_length","scenario_period_id","selected_party_periods"],"title":"CFSPeriodSchema"},"CaseBankingAccount-Input":{"properties":{"bank_account_id":{"type":"string","title":"Bank Account Id"},"source":{"$ref":"#/components/schemas/BankSourceFamily"},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Name"},"account_number_last4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number Last4"},"account_holder_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Holder Name"},"account_type":{"anyOf":[{"$ref":"#/components/schemas/BankAccountType"},{"type":"null"}]},"account_subtype":{"anyOf":[{"$ref":"#/components/schemas/BankAccountSubtype"},{"type":"null"}]},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"ISO 4217 three-letter code, case-insensitive. This account's own native currency."},"status":{"type":"string","const":"ACTIVE","title":"Status"},"is_eligible":{"type":"boolean","title":"Is Eligible","description":"Whether this account's balances count as cash. Ineligible accounts are still listed, because otherwise the excluded counts on an aggregate response cannot be explained."},"link_connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Connection Id"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At"},"periods":{"items":{"$ref":"#/components/schemas/BankingAccountBucket"},"type":"array","title":"Periods"},"statement_periods":{"items":{"$ref":"#/components/schemas/BankingAccountPeriod"},"type":"array","title":"Statement Periods"},"has_coverage_gaps":{"type":"boolean","title":"Has Coverage Gaps"},"import_format":{"anyOf":[{"$ref":"#/components/schemas/BankImportFormat"},{"type":"null"}],"description":"For a `source: import` account, the shape it was sent in: `plaid` or `generic`. Null for every other family."},"account_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Key","description":"For an imported account, the key it was created under: Plaid's persistent_account_id when there was one, else the account_id you first sent. Null for every other family."},"known_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Known Ids","description":"For an imported account, every id you have used for it."},"daily_balances":{"items":{"$ref":"#/components/schemas/DailyBalancePoint"},"type":"array","title":"Daily Balances"}},"type":"object","required":["bank_account_id","source","bank_name","account_number_last4","account_holder_name","account_type","account_subtype","currency","status","is_eligible","link_connection_id","last_synced_at","has_coverage_gaps"],"title":"CaseBankingAccount","description":"One account, fully described: identity, coverage and figures together.\n\nThe API splits these across `/accounts` and `/aggregates`; a snapshot has no\nsecond call to make, so it carries both."},"CaseBankingAccount-Output":{"properties":{"bank_account_id":{"type":"string","title":"Bank Account Id"},"source":{"$ref":"#/components/schemas/BankSourceFamily"},"bank_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bank Name"},"account_number_last4":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number Last4"},"account_holder_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Holder Name"},"account_type":{"anyOf":[{"$ref":"#/components/schemas/BankAccountType"},{"type":"null"}]},"account_subtype":{"anyOf":[{"$ref":"#/components/schemas/BankAccountSubtype"},{"type":"null"}]},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"ISO 4217 three-letter code, case-insensitive. This account's own native currency."},"status":{"type":"string","const":"ACTIVE","title":"Status"},"is_eligible":{"type":"boolean","title":"Is Eligible","description":"Whether this account's balances count as cash. Ineligible accounts are still listed, because otherwise the excluded counts on an aggregate response cannot be explained."},"link_connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Connection Id"},"last_synced_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Synced At"},"periods":{"items":{"$ref":"#/components/schemas/BankingAccountBucket"},"type":"array","title":"Periods"},"statement_periods":{"items":{"$ref":"#/components/schemas/BankingAccountPeriod"},"type":"array","title":"Statement Periods"},"has_coverage_gaps":{"type":"boolean","title":"Has Coverage Gaps"},"import_format":{"anyOf":[{"$ref":"#/components/schemas/BankImportFormat"},{"type":"null"}],"description":"For a `source: import` account, the shape it was sent in: `plaid` or `generic`. Null for every other family."},"account_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Key","description":"For an imported account, the key it was created under: Plaid's persistent_account_id when there was one, else the account_id you first sent. Null for every other family."},"known_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Known Ids","description":"For an imported account, every id you have used for it."},"daily_balances":{"items":{"$ref":"#/components/schemas/DailyBalancePoint"},"type":"array","title":"Daily Balances"}},"type":"object","required":["bank_account_id","source","bank_name","account_number_last4","account_holder_name","account_type","account_subtype","currency","status","is_eligible","link_connection_id","last_synced_at","has_coverage_gaps"],"title":"CaseBankingAccount","description":"One account, fully described: identity, coverage and figures together.\n\nThe API splits these across `/accounts` and `/aggregates`; a snapshot has no\nsecond call to make, so it carries both."},"CaseBankingDocument":{"properties":{"cust_doc_id":{"type":"string","title":"Cust Doc Id"},"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name"},"period_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period Start"},"period_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Period End"},"tamper_checked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tamper Checked"},"tamper_risk_signal_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tamper Risk Signal Count"},"tamper_risk_identifiers":{"items":{"$ref":"#/components/schemas/TamperRiskKind"},"type":"array","title":"Tamper Risk Identifiers"},"status":{"anyOf":[{"$ref":"#/components/schemas/CaseBankingDocumentStatus"},{"type":"null"}]},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"}},"type":"object","required":["cust_doc_id"],"title":"CaseBankingDocument","description":"One document in the case's cohort, and whether it survived analysis.\n\nThe entity API answers \"which statement is suspect\" from GET\n/banking/accounts. A case has no such companion call -- it is meant to be a\nself-contained record of what was decided on -- so the per-document detail\nlives in the payload itself."},"CaseBankingDocumentResult-Input":{"properties":{"source":{"type":"string","const":"document","title":"Source","default":"document"},"authenticity":{"anyOf":[{"$ref":"#/components/schemas/BankingDocumentAuthenticity"},{"type":"null"}]},"reporting_currency":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Reporting Currency","description":"ISO 4217 three-letter code, case-insensitive. The currency every money field here is expressed in. Null when `notes` carries `mixed_currency_no_fx`, in which case every money field is null too, and on a case result that carries no figures at all -- there is then no money to denominate. Never null beside a populated figure."},"account_count":{"type":"integer","title":"Account Count"},"ineligible_account_count":{"type":"integer","title":"Ineligible Account Count","description":"Accounts known not to hold cash -- a credit card, a loan, a mortgage. Excluded from every figure here. To reconcile a ledger against these figures, pass `include_ineligible_accounts=false` to GET /banking/transactions, which drops the same accounts."},"earliest_period_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Earliest Period Start"},"latest_period_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Latest Period End"},"period_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Period Length"},"periods":{"items":{"$ref":"#/components/schemas/BankingPeriodAggregate"},"type":"array","title":"Periods"},"by_account":{"items":{"$ref":"#/components/schemas/CaseBankingAccount-Input"},"type":"array","title":"By Account"},"breakdowns":{"$ref":"#/components/schemas/BankingBreakdowns-Input"},"notes":{"items":{"$ref":"#/components/schemas/BankingCoverageNote"},"type":"array","title":"Notes"},"documents":{"items":{"$ref":"#/components/schemas/CaseBankingDocument"},"type":"array","minItems":1,"title":"Documents"}},"type":"object","required":["reporting_currency","account_count","ineligible_account_count","earliest_period_start","latest_period_end","period_length","by_account","breakdowns","documents"],"title":"CaseBankingDocumentResult","description":"A case's banking, in the published schema as well as at runtime.\n\nThe subclass matters for the SCHEMA: a bare `BankingSourceResult` types\n`source` as the full family enum, so the OpenAPI document would say a case\nmay carry `source: \"plaid\"` even though nothing ever writes one. Pinning the\nLiteral makes a generated client unable to express it either."},"CaseBankingDocumentResult-Output":{"properties":{"source":{"type":"string","const":"document","title":"Source","default":"document"},"authenticity":{"anyOf":[{"$ref":"#/components/schemas/BankingDocumentAuthenticity"},{"type":"null"}]},"reporting_currency":{"anyOf":[{"type":"string","maxLength":3,"minLength":3},{"type":"null"}],"title":"Reporting Currency","description":"ISO 4217 three-letter code, case-insensitive. The currency every money field here is expressed in. Null when `notes` carries `mixed_currency_no_fx`, in which case every money field is null too, and on a case result that carries no figures at all -- there is then no money to denominate. Never null beside a populated figure."},"account_count":{"type":"integer","title":"Account Count"},"ineligible_account_count":{"type":"integer","title":"Ineligible Account Count","description":"Accounts known not to hold cash -- a credit card, a loan, a mortgage. Excluded from every figure here. To reconcile a ledger against these figures, pass `include_ineligible_accounts=false` to GET /banking/transactions, which drops the same accounts."},"earliest_period_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Earliest Period Start"},"latest_period_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Latest Period End"},"period_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Period Length"},"periods":{"items":{"$ref":"#/components/schemas/BankingPeriodAggregate"},"type":"array","title":"Periods"},"by_account":{"items":{"$ref":"#/components/schemas/CaseBankingAccount-Output"},"type":"array","title":"By Account"},"breakdowns":{"$ref":"#/components/schemas/BankingBreakdowns-Output"},"notes":{"items":{"$ref":"#/components/schemas/BankingCoverageNote"},"type":"array","title":"Notes"},"documents":{"items":{"$ref":"#/components/schemas/CaseBankingDocument"},"type":"array","minItems":1,"title":"Documents"}},"type":"object","required":["reporting_currency","account_count","ineligible_account_count","earliest_period_start","latest_period_end","period_length","by_account","breakdowns","documents"],"title":"CaseBankingDocumentResult","description":"A case's banking, in the published schema as well as at runtime.\n\nThe subclass matters for the SCHEMA: a bare `BankingSourceResult` types\n`source` as the full family enum, so the OpenAPI document would say a case\nmay carry `source: \"plaid\"` even though nothing ever writes one. Pinning the\nLiteral makes a generated client unable to express it either."},"CaseBankingDocumentStatus":{"type":"string","enum":["processed","failed"],"title":"CaseBankingDocumentStatus","description":"What became of one document the case waited on."},"CaseBankingResult-Input":{"properties":{"schema_version":{"type":"integer","const":1,"title":"Schema Version","default":1},"status":{"$ref":"#/components/schemas/CaseBankingStatus"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"computed_at":{"type":"string","format":"date-time","title":"Computed At"},"completion_version":{"type":"string","title":"Completion Version"},"window_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Window Start"},"window_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Window End"},"document":{"anyOf":[{"$ref":"#/components/schemas/CaseBankingDocumentResult-Input"},{"type":"null"}]},"transaction_count":{"type":"integer","title":"Transaction Count","default":0},"transactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankingTransactionRow"},"type":"array"},{"type":"null"}],"title":"Transactions"}},"type":"object","required":["status","computed_at","completion_version"],"title":"CaseBankingResult","description":"The banking half of a completed case, overlaid onto the case result."},"CaseBankingResult-Output":{"properties":{"schema_version":{"type":"integer","const":1,"title":"Schema Version","default":1},"status":{"$ref":"#/components/schemas/CaseBankingStatus"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Reason"},"computed_at":{"type":"string","format":"date-time","title":"Computed At"},"completion_version":{"type":"string","title":"Completion Version"},"window_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Window Start"},"window_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Window End"},"document":{"anyOf":[{"$ref":"#/components/schemas/CaseBankingDocumentResult-Output"},{"type":"null"}]},"transaction_count":{"type":"integer","title":"Transaction Count","default":0},"transactions":{"anyOf":[{"items":{"$ref":"#/components/schemas/BankingTransactionRow"},"type":"array"},{"type":"null"}],"title":"Transactions"}},"type":"object","required":["status","computed_at","completion_version"],"title":"CaseBankingResult","description":"The banking half of a completed case, overlaid onto the case result."},"CaseBankingStatus":{"type":"string","enum":["ok","failed","not_applicable"],"title":"CaseBankingStatus"},"CaseCreatorResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Stable Accend identifier for the creator. Use this to match the same person across cases -- name and email are display fields and can change."},"type":{"type":"string","enum":["user","api","system"],"title":"Type","description":"`user` -- a person, named by `name`/`email`. `api` -- created through an organization integration token, which is not tied to an individual. `system` -- created automatically by Accend, e.g. the recurring monitoring that opens cases on a schedule rather than on request."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Current display name. Null if the profile has no name set."},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"Current email. Display field only -- not a unique key and not stable: more than one user can share an address, and an address can change."}},"type":"object","required":["id","type"],"title":"CaseCreatorResponse","description":"Who caused a spreading case to be created. NOT the assigned analyst."},"CaseEventResponse":{"properties":{"action":{"type":"string","title":"Action"},"action_by":{"type":"string","title":"Action By"},"action_at":{"type":"string","title":"Action At"},"action_detail":{"type":"string","title":"Action Detail"}},"type":"object","required":["action","action_by","action_at","action_detail"],"title":"CaseEventResponse"},"CaseProcessResult-Input":{"properties":{"compliance_review":{"anyOf":[{"$ref":"#/components/schemas/ComplianceReview-Input"},{"type":"null"}]}},"type":"object","title":"CaseProcessResult"},"CaseProcessResult-Output":{"properties":{"compliance_review":{"anyOf":[{"$ref":"#/components/schemas/ComplianceReview-Output"},{"type":"null"}]}},"type":"object","title":"CaseProcessResult"},"CaseResponse":{"properties":{"case_id":{"type":"string","title":"Case Id"},"case_title":{"type":"string","title":"Case Title"},"company_name":{"type":"string","title":"Company Name"},"creator":{"$ref":"#/components/schemas/UserInfo"},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id"},"assignee_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Name"},"priority":{"$ref":"#/components/schemas/PriorityLevel"},"status":{"$ref":"#/components/schemas/CaseStatus"},"created_at":{"type":"string","title":"Created At"},"completed":{"type":"boolean","title":"Completed","description":"Whether the case analysis is completed"},"report":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Report","description":"The KYB report"},"case_type":{"anyOf":[{"type":"string","enum":["Onboarding","Periodic","Ad Hoc"]},{"type":"null"}],"title":"Case Type","default":"Onboarding"},"case_events":{"anyOf":[{"items":{"$ref":"#/components/schemas/CaseEventResponse"},"type":"array"},{"type":"null"}],"title":"Case Events"},"ai_suggestion_tag":{"anyOf":[{"type":"string","enum":["pending","human_oversight"]},{"type":"null"}],"title":"Ai Suggestion Tag"}},"type":"object","required":["case_id","case_title","company_name","creator","priority","status","created_at"],"title":"CaseResponse"},"CaseResultInclude":{"type":"string","enum":["banking_transactions"],"title":"CaseResultInclude","description":"Opt-in sections of a case result, requested as `?include=`.\n\nAn enum rather than a bare string so an unknown value is a 422 naming the\nparameter instead of a silently-ignored typo that costs the caller the\nsection they asked for.\n\nOnly the transaction array so far. It is opt-in because the aggregates are\nwhat nearly every reader wants and the ledger can run to thousands of rows\nfor one case -- and because it lives in its own column, so the default path\ndoes not read it at all. That is a real cost saving, not just a smaller\nresponse."},"CaseSpreadingRequest":{"properties":{"request":{"anyOf":[{"$ref":"#/components/schemas/SimplifiedPeriodSpreadingRequest-Output"},{"$ref":"#/components/schemas/PrecisePeriodSpreadingRequest-Output"},{"$ref":"#/components/schemas/FinancialReviewTemplateBasedSpreadingRequest-Output"},{"$ref":"#/components/schemas/BestEffortSpreadingRequest"}],"title":"Request"}},"type":"object","required":["request"],"title":"CaseSpreadingRequest"},"CaseSpreadingRequestExternal":{"properties":{"request":{"anyOf":[{"$ref":"#/components/schemas/SimplifiedPeriodSpreadingRequest-Input"},{"$ref":"#/components/schemas/PrecisePeriodSpreadingRequest-Input"},{"$ref":"#/components/schemas/FinancialReviewTemplateBasedSpreadingRequest-Input"},{"$ref":"#/components/schemas/BestEffortSpreadingRequest"}],"title":"Request","description":"Spreading request for the case.\nWe accept the following request types:\n\n**SimplifiedPeriodSpreadingRequest**:\n\n- Simplified period are more readable by humans, it's supported fiscal year period, trailing period, and calendar year month.\n\n- most_recent_period: The most recent period included in the spreading request. This is used for TTM and YTD calculations.\n\n**PrecisePeriodSpreadingRequest**:\n\n- This is the most flexible request type, it's supported precise period from any start and end date. The periods provided should be adjusted based on the customer's fiscal year start month.\n\n**FinancialReviewTemplateBasedSpreadingRequest**:\n\n- This request type is used for financial review template based spreading.\n\n- fin_review_tmpl_id: The ID of the financial review template.\n\n- most_recent_period: The most recent period included in the request that overwrites the value in the template. This is used for TTM and YTD calculations.\n\n**BestEffortSpreadingRequest**:\n\n- This request type is used for best effort spreading.\n"}},"type":"object","required":["request"],"title":"CaseSpreadingRequestExternal"},"CaseStatus":{"type":"string","enum":["Open","Closed","Approved","In Progress","Awaiting Information","Declined"],"title":"CaseStatus"},"CaseTaskInputs":{"properties":{"task_types":{"items":{"type":"string","const":"ownership_structure_analysis"},"type":"array","title":"Task Types","description":"List of task types. task types can be 'ownership_structure_analysis'","default":[]},"ownership_structure_analysis_input":{"anyOf":[{"$ref":"#/components/schemas/OwnershipInformation-Input"},{"type":"null"}]}},"type":"object","title":"CaseTaskInputs"},"CaseUpdateRequest":{"properties":{"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id"},"priority":{"anyOf":[{"$ref":"#/components/schemas/PriorityLevel"},{"type":"null"}]},"status":{"anyOf":[{"$ref":"#/components/schemas/CaseStatus"},{"type":"null"}]}},"type":"object","title":"CaseUpdateRequest"},"CashFlowScenarioColumnType":{"type":"string","enum":["involved_party","adjustments","global"],"title":"CashFlowScenarioColumnType"},"CashFlowScenarioListOverviewSchema":{"properties":{"org_id":{"type":"string","title":"Org Id"},"scenario_id":{"type":"string","title":"Scenario Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"property_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Created at"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Updated at"},"num_periods":{"type":"integer","title":"Num Periods","description":"Number of periods"},"num_involved_parties":{"type":"integer","title":"Num Involved Parties","description":"Number of involved parties"}},"type":"object","required":["org_id","scenario_id","name","created_at","updated_at","num_periods","num_involved_parties"],"title":"CashFlowScenarioListOverviewSchema"},"CashFlowScenarioListResponse":{"properties":{"scenarios":{"items":{"$ref":"#/components/schemas/CashFlowScenarioListOverviewSchema"},"type":"array","title":"Scenarios"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["scenarios","total"],"title":"CashFlowScenarioListResponse"},"CashFlowScenarioSchema":{"properties":{"org_id":{"type":"string","title":"Org Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"property_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Property Id"},"scenario_id":{"type":"string","title":"Scenario Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"involved_parties":{"items":{"anyOf":[{"$ref":"#/components/schemas/CFSInvolvedCustomerSchema"},{"$ref":"#/components/schemas/CFSInvolvedPropertySchema"}]},"type":"array","title":"Involved Parties"},"periods":{"items":{"$ref":"#/components/schemas/CFSPeriodSchema"},"type":"array","title":"Periods"},"chart_of_accounts":{"$ref":"#/components/schemas/ChartOfAccountsSchema-Output"}},"type":"object","required":["org_id","scenario_id","name","involved_parties","periods","chart_of_accounts"],"title":"CashFlowScenarioSchema"},"CashFlowScenarioUpdateSettingSchema":{"properties":{"scenario_id":{"type":"string","title":"Scenario Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"involved_parties":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/CFSInvolvedCustomerCreationSchema"},{"$ref":"#/components/schemas/CFSInvolvedPropertyCreationSchema"}]},"type":"array"},{"type":"null"}],"title":"Involved Parties"},"periods":{"anyOf":[{"items":{"$ref":"#/components/schemas/CFSPeriodCreationSchema"},"type":"array"},{"type":"null"}],"title":"Periods"}},"type":"object","required":["scenario_id"],"title":"CashFlowScenarioUpdateSettingSchema"},"CashFlowStatementImport":{"properties":{"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"line_items":{"$ref":"#/components/schemas/CashFlowStatementLineItemsImport"}},"type":"object","required":["start_period","end_period","line_items"],"title":"CashFlowStatementImport","description":"The cash flow statement import schema\nAll the total line items are calculated from the line items through summation.\nThere is no subtraction in the total line item calculation."},"CashFlowStatementLineItemsImport":{"properties":{"total_cash_at_beginning_of_period":{"$ref":"#/components/schemas/LineItemSchema","description":"Total cash at the beginning of the period","default":{"amount":0.0}},"net_income_or_loss":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"depreciation_and_amortization":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"gain_or_loss_on_asset_sales":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_non_cash_items":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"change_in_net_accounts_receivable":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"change_in_inventory":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"change_in_other_current_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"change_in_accounts_payable":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"change_in_other_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"change_in_other_non_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"change_in_other_non_current_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"capital_expenditures_purchase_of_fixed_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"proceeds_from_sale_of_fixed_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"purchase_of_investment_securities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"sale_of_investment_securities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_investing_activities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"external_borrowings_debt_or_loc_or_mortgages_or_other_loans":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"repayments_of_borrowings_debt_or_loc_or_mortgages_or_other_loans":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"dividends_paid":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"changes_in_equity":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_financing_activities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"effect_of_fx_and_other_cash_flow_adjustments":{"$ref":"#/components/schemas/LineItemSchema","description":"Effect of foreign exchange and other cash flow adjustments","default":{"amount":0.0}}},"type":"object","title":"CashFlowStatementLineItemsImport"},"CashFlowStatementLineItemsSchema":{"properties":{"net_income_or_loss":{"$ref":"#/components/schemas/LineItemSchema"},"depreciation_and_amortization":{"$ref":"#/components/schemas/LineItemSchema"},"gain_or_loss_on_asset_sales":{"$ref":"#/components/schemas/LineItemSchema"},"other_non_cash_items":{"$ref":"#/components/schemas/LineItemSchema"},"change_in_net_accounts_receivable":{"$ref":"#/components/schemas/LineItemSchema"},"change_in_inventory":{"$ref":"#/components/schemas/LineItemSchema"},"change_in_other_current_assets":{"$ref":"#/components/schemas/LineItemSchema"},"change_in_accounts_payable":{"$ref":"#/components/schemas/LineItemSchema"},"change_in_other_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema"},"net_cash_provided_by_used_in_operating_activities":{"$ref":"#/components/schemas/LineItemSchema"},"capital_expenditures_purchase_of_fixed_assets":{"$ref":"#/components/schemas/LineItemSchema"},"proceeds_from_sale_of_fixed_assets":{"$ref":"#/components/schemas/LineItemSchema"},"purchase_of_investment_securities":{"$ref":"#/components/schemas/LineItemSchema"},"sale_of_investment_securities":{"$ref":"#/components/schemas/LineItemSchema"},"other_investing_activities":{"$ref":"#/components/schemas/LineItemSchema"},"change_in_other_non_current_assets":{"$ref":"#/components/schemas/LineItemSchema"},"net_cash_provided_by_used_in_investing_activities":{"$ref":"#/components/schemas/LineItemSchema"},"external_borrowings_debt_or_loc_or_mortgages_or_other_loans":{"$ref":"#/components/schemas/LineItemSchema"},"repayments_of_borrowings_debt_or_loc_or_mortgages_or_other_loans":{"$ref":"#/components/schemas/LineItemSchema"},"dividends_paid":{"$ref":"#/components/schemas/LineItemSchema"},"changes_in_equity":{"$ref":"#/components/schemas/LineItemSchema"},"other_financing_activities":{"$ref":"#/components/schemas/LineItemSchema"},"change_in_other_non_current_liabilities":{"$ref":"#/components/schemas/LineItemSchema"},"net_cash_provided_by_used_in_financing_activities":{"$ref":"#/components/schemas/LineItemSchema"},"effect_of_fx_and_other_cash_flow_adjustments":{"$ref":"#/components/schemas/LineItemSchema","description":"Effect of foreign exchange and other cash flow adjustments","default":{"amount":0.0}},"net_increase_or_decrease_in_total_cash":{"$ref":"#/components/schemas/LineItemSchema","description":"Net increase or decrease in cash and cash equivalents, restricted from the beginning of the period to the end of the period","default":{"amount":0.0}},"total_cash_at_beginning_of_period":{"$ref":"#/components/schemas/LineItemSchema","description":"Total cash at the beginning of the period","default":{"amount":0.0}},"total_cash_at_end_of_period":{"$ref":"#/components/schemas/LineItemSchema","description":"Total cash at the end of the period","default":{"amount":0.0}},"net_increase_or_decrease_in_cash_and_cash_equivalents":{"$ref":"#/components/schemas/LineItemSchema","description":"Should be net_increase_or_decrease_in_total_cash, this is used in 2.x.x version of the schema and will be deprecated in 3.x.x","default":{"amount":0.0}},"cash_and_cash_equivalents_at_beginning_of_period":{"$ref":"#/components/schemas/LineItemSchema","description":"Should be total_cash_at_beginning_of_period, this is used in 2.x.x version of the schema and will be deprecated in 3.x.x","default":{"amount":0.0}},"cash_and_cash_equivalents_at_end_of_period":{"$ref":"#/components/schemas/LineItemSchema","description":"Should be total_cash_at_end_of_period, this is used in 2.x.x version of the schema and will be deprecated in 3.x.x","default":{"amount":0.0}}},"type":"object","required":["net_income_or_loss","depreciation_and_amortization","gain_or_loss_on_asset_sales","other_non_cash_items","change_in_net_accounts_receivable","change_in_inventory","change_in_other_current_assets","change_in_accounts_payable","change_in_other_current_liabilities","net_cash_provided_by_used_in_operating_activities","capital_expenditures_purchase_of_fixed_assets","proceeds_from_sale_of_fixed_assets","purchase_of_investment_securities","sale_of_investment_securities","other_investing_activities","change_in_other_non_current_assets","net_cash_provided_by_used_in_investing_activities","external_borrowings_debt_or_loc_or_mortgages_or_other_loans","repayments_of_borrowings_debt_or_loc_or_mortgages_or_other_loans","dividends_paid","changes_in_equity","other_financing_activities","change_in_other_non_current_liabilities","net_cash_provided_by_used_in_financing_activities"],"title":"CashFlowStatementLineItemsSchema"},"CashFlowStatementSchema-Input":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"The unique identifier of the cash flow statement period within the case"},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"period_length":{"type":"integer","title":"Period Length"},"is_derived":{"type":"boolean","title":"Is Derived","default":false},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"derivation_is_references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Derivation Is References","description":"The reference periods of income statements for derivation"},"derivation_bs_start_period_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Derivation Bs Start Period Reference","description":"The reference start period of balance sheet for derivation"},"derivation_bs_end_period_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Derivation Bs End Period Reference","description":"The reference end period of balance sheet for derivation"},"line_items":{"$ref":"#/components/schemas/CashFlowStatementLineItemsSchema"}},"type":"object","required":["statement_id","start_period","end_period","period_length","line_items"],"title":"CashFlowStatementSchema"},"CashFlowStatementSchema-Output":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"The unique identifier of the cash flow statement period within the case"},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"period_length":{"type":"integer","title":"Period Length"},"is_derived":{"type":"boolean","title":"Is Derived","default":false},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"derivation_is_references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Derivation Is References","description":"The reference periods of income statements for derivation"},"derivation_bs_start_period_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Derivation Bs Start Period Reference","description":"The reference start period of balance sheet for derivation"},"derivation_bs_end_period_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Derivation Bs End Period Reference","description":"The reference end period of balance sheet for derivation"},"line_items":{"$ref":"#/components/schemas/CashFlowStatementLineItemsSchema"}},"type":"object","required":["statement_id","start_period","end_period","period_length","line_items"],"title":"CashFlowStatementSchema"},"ChartOfAccountsSchema-Input":{"properties":{"org_id":{"type":"string","title":"Org Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id"},"fin_tmpl_key":{"type":"string","title":"Fin Tmpl Key"},"custom_ratio_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Ratio Group Key"},"entity_type":{"$ref":"#/components/schemas/FinTemplateEntityType","default":"business"},"classes":{"items":{"$ref":"#/components/schemas/CoaClassSchema"},"type":"array","title":"Classes"},"accounts":{"items":{"$ref":"#/components/schemas/CoaAccountSchema"},"type":"array","title":"Accounts"},"source_key_total_account_keys":{"items":{"type":"string"},"type":"array","title":"Source Key Total Account Keys"},"groupings":{"$ref":"#/components/schemas/FinancialTemplateGroupings"}},"type":"object","required":["org_id","fin_tmpl_key","groupings"],"title":"ChartOfAccountsSchema"},"ChartOfAccountsSchema-Output":{"properties":{"org_id":{"type":"string","title":"Org Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id"},"fin_tmpl_key":{"type":"string","title":"Fin Tmpl Key"},"custom_ratio_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Ratio Group Key"},"entity_type":{"$ref":"#/components/schemas/FinTemplateEntityType","default":"business"},"classes":{"items":{"$ref":"#/components/schemas/CoaClassSchema"},"type":"array","title":"Classes"},"accounts":{"items":{"$ref":"#/components/schemas/CoaAccountSchema"},"type":"array","title":"Accounts"},"source_key_total_account_keys":{"items":{"type":"string"},"type":"array","title":"Source Key Total Account Keys"},"groupings":{"$ref":"#/components/schemas/FinancialTemplateGroupings"}},"type":"object","required":["org_id","fin_tmpl_key","groupings"],"title":"ChartOfAccountsSchema"},"ClassGroupingSchema":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"class_keys":{"items":{"type":"string"},"type":"array","title":"Class Keys"}},"type":"object","required":["key","name","class_keys"],"title":"ClassGroupingSchema"},"CoaAccountSchema":{"properties":{"id":{"type":"integer","title":"Id"},"coa_class_key":{"type":"string","title":"Coa Class Key"},"fin_tmpl_account_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Tmpl Account Key"},"fin_tmpl_account_type_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Tmpl Account Type Key"},"fin_tmpl_account_flow_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Tmpl Account Flow Key"},"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"sort_order":{"type":"integer","title":"Sort Order"},"should_flip_sign_from_source":{"type":"boolean","title":"Should Flip Sign From Source","default":false},"calculation_type":{"$ref":"#/components/schemas/FinTmplAccountCalculationType","default":"financial"},"origin_type":{"$ref":"#/components/schemas/FinTmplAccountOriginType","default":"primitive"},"rolling_stmt_calculation_type":{"$ref":"#/components/schemas/FinTmplAccountRollingStmtCalculationType","default":"as_unset"},"formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formula"},"value_data_type":{"$ref":"#/components/schemas/ValueDataType","default":"float"}},"type":"object","required":["id","coa_class_key","key","name","sort_order"],"title":"CoaAccountSchema","description":"Schema for COA account"},"CoaClassSchema":{"properties":{"fin_tmpl_account_class_key":{"type":"string","title":"Fin Tmpl Account Class Key"},"fin_tmpl_account_class_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Tmpl Account Class Group Key"},"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"match_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Match Name"},"statement_type":{"anyOf":[{"$ref":"#/components/schemas/StatementType"},{"type":"null"}]},"sort_order":{"type":"integer","title":"Sort Order"},"hidden":{"type":"boolean","title":"Hidden","default":false}},"type":"object","required":["fin_tmpl_account_class_key","key","name","sort_order"],"title":"CoaClassSchema","description":"Schema for COA class"},"CoaStatementCalculatorSourceSchema":{"properties":{"coa_account_key":{"type":"string","title":"Coa Account Key"},"calculator_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Calculator Config"}},"type":"object","required":["coa_account_key"],"title":"CoaStatementCalculatorSourceSchema","description":"Schema for COA statement calculator source"},"CoaStatementLineItemNoteExternalSchema":{"properties":{"statement_id":{"type":"string","title":"Statement Id"},"coa_account_key":{"type":"string","title":"Coa Account Key"},"creator_name":{"type":"string","title":"Creator Name"},"creator_email":{"type":"string","title":"Creator Email"},"note":{"type":"string","title":"Note"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["statement_id","coa_account_key","creator_name","creator_email","note","created_at"],"title":"CoaStatementLineItemNoteExternalSchema","description":"Schema for creating/updating COA statement line item note"},"CoaStatementLineItemSchema":{"properties":{"coa_account_key":{"type":"string","title":"Coa Account Key"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formula"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"str_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Str Value"},"bool_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bool Value"},"date_value":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date Value"},"override_origin_type":{"anyOf":[{"$ref":"#/components/schemas/FinTmplAccountOriginType"},{"type":"null"}]},"is_overridden_value":{"type":"boolean","title":"Is Overridden Value","default":false}},"type":"object","required":["coa_account_key"],"title":"CoaStatementLineItemSchema","description":"Schema for COA statement line item"},"CoaStatementSchema-Input":{"properties":{"org_id":{"type":"string","title":"Org Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id"},"statement_id":{"type":"string","title":"Statement Id","description":"Unique identifier for the statement"},"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"Start date of the period"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"End date of the period"},"period_length":{"type":"integer","title":"Period Length","description":"Length of the period in months"},"is_calculated":{"type":"boolean","title":"Is Calculated","description":"Whether the statement is calculated from other statements"},"calculation_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculation Method"},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string","enum":["audited_financial_statements","unaudited_financial_statements","sec_filings","tax_form","personal_financial_statements","accounting_system"]},{"type":"null"}],"title":"Statement From"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the statement"},"status":{"$ref":"#/components/schemas/StatementStatus","default":"active"},"anchor_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To"},"compare_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To"},"appraised_valuation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appraised Valuation Id","description":"Appraised valuation id"},"market_valuation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Valuation Id","description":"Market valuation id"},"line_items":{"items":{"$ref":"#/components/schemas/CoaStatementLineItemSchema"},"type":"array","title":"Line Items","description":"Line items for this statement"},"is_combined_financial":{"type":"boolean","title":"Is Combined Financial","description":"Whether this statement is a combined financial","default":false},"contributing_statement_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contributing Statement Ids","description":"List of contributing statement ids"},"collection_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Collection Ids","description":"Ids of the collections holding this statement. The statement is in the entity's main collection when the list holds the response's `main_collection_id`."}},"type":"object","required":["org_id","statement_id","start_period","end_period","period_length","is_calculated"],"title":"CoaStatementSchema","description":"Schema for COA statement"},"CoaStatementSchema-Output":{"properties":{"org_id":{"type":"string","title":"Org Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id"},"statement_id":{"type":"string","title":"Statement Id","description":"Unique identifier for the statement"},"start_period":{"type":"string","title":"Start Period","description":"Start date of the period"},"end_period":{"type":"string","title":"End Period","description":"End date of the period"},"period_length":{"type":"integer","title":"Period Length","description":"Length of the period in months"},"is_calculated":{"type":"boolean","title":"Is Calculated","description":"Whether the statement is calculated from other statements"},"calculation_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculation Method"},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string","enum":["audited_financial_statements","unaudited_financial_statements","sec_filings","tax_form","personal_financial_statements","accounting_system"]},{"type":"null"}],"title":"Statement From"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Currency of the statement"},"status":{"$ref":"#/components/schemas/StatementStatus","default":"active"},"anchor_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To"},"compare_to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To"},"appraised_valuation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appraised Valuation Id","description":"Appraised valuation id"},"market_valuation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Valuation Id","description":"Market valuation id"},"line_items":{"items":{"$ref":"#/components/schemas/CoaStatementLineItemSchema"},"type":"array","title":"Line Items","description":"Line items for this statement"},"is_combined_financial":{"type":"boolean","title":"Is Combined Financial","description":"Whether this statement is a combined financial","default":false},"contributing_statement_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contributing Statement Ids","description":"List of contributing statement ids"},"collection_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Collection Ids","description":"Ids of the collections holding this statement. The statement is in the entity's main collection when the list holds the response's `main_collection_id`."}},"type":"object","required":["org_id","statement_id","start_period","end_period","period_length","is_calculated"],"title":"CoaStatementSchema","description":"Schema for COA statement"},"CoaStatementSourceKeyTotalSchema":{"properties":{"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id"},"page_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Index"},"coa_account_key":{"type":"string","title":"Coa Account Key"},"particular":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Particular"},"original_particular":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Particular"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"}},"type":"object","required":["coa_account_key"],"title":"CoaStatementSourceKeyTotalSchema","description":"Schema for COA statement data source"},"CoaStatementSourceLineItemSchema":{"properties":{"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id"},"page_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Index"},"coa_account_key":{"type":"string","title":"Coa Account Key"},"particular":{"type":"string","title":"Particular"},"original_particular":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Particular","description":"Original particular"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"contribution":{"type":"number","title":"Contribution","description":"Contribution of the line item","default":1},"str_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Str Value"},"bool_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bool Value","description":"Boolean value"},"date_value":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date Value","description":"Date value"},"original_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Category","description":"Original category"},"original_sub_category_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 1","description":"Original sub-category 1"},"original_sub_category_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 2","description":"Original sub-category 2"},"original_sub_category_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 3","description":"Original sub-category 3"},"is_non_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Non Recurring","description":"Whether the line item is non-recurring"}},"type":"object","required":["coa_account_key","particular"],"title":"CoaStatementSourceLineItemSchema","description":"Schema for COA statement source line item"},"CoaStatementWithSourcesSchema-Input":{"properties":{"statement":{"$ref":"#/components/schemas/CoaStatementSchema-Input"},"calculator_sources":{"items":{"$ref":"#/components/schemas/CoaStatementCalculatorSourceSchema"},"type":"array","title":"Calculator Sources","description":"Calculator sources for this statement"},"source_key_totals":{"items":{"$ref":"#/components/schemas/CoaStatementSourceKeyTotalSchema"},"type":"array","title":"Source Key Totals","description":"Source key totals for this statement"},"source_line_items":{"items":{"$ref":"#/components/schemas/CoaStatementSourceLineItemSchema"},"type":"array","title":"Source Line Items","description":"Source line items for this statement"}},"type":"object","required":["statement"],"title":"CoaStatementWithSourcesSchema","description":"Schema for COA statement with sources"},"CoaStatementWithSourcesSchema-Output":{"properties":{"statement":{"$ref":"#/components/schemas/CoaStatementSchema-Output"},"calculator_sources":{"items":{"$ref":"#/components/schemas/CoaStatementCalculatorSourceSchema"},"type":"array","title":"Calculator Sources","description":"Calculator sources for this statement"},"source_key_totals":{"items":{"$ref":"#/components/schemas/CoaStatementSourceKeyTotalSchema"},"type":"array","title":"Source Key Totals","description":"Source key totals for this statement"},"source_line_items":{"items":{"$ref":"#/components/schemas/CoaStatementSourceLineItemSchema"},"type":"array","title":"Source Line Items","description":"Source line items for this statement"}},"type":"object","required":["statement"],"title":"CoaStatementWithSourcesSchema","description":"Schema for COA statement with sources"},"CoaStatementsWithChartOfAccountsSchema":{"properties":{"chart_of_accounts":{"$ref":"#/components/schemas/ChartOfAccountsSchema-Output"},"statements":{"items":{"$ref":"#/components/schemas/CoaStatementWithSourcesSchema-Output"},"type":"array","title":"Statements","description":"Statements for this chart of accounts"},"main_collection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Collection Id","description":"Id of the entity's main collection"}},"type":"object","required":["chart_of_accounts"],"title":"CoaStatementsWithChartOfAccountsSchema","description":"Schema for COA statements"},"CoaStatementsWithChartOfAccountsWithDeliverablesSchema-Input":{"properties":{"chart_of_accounts":{"$ref":"#/components/schemas/ChartOfAccountsSchema-Input"},"statements":{"items":{"$ref":"#/components/schemas/CoaStatementWithSourcesSchema-Input"},"type":"array","title":"Statements","description":"Statements for this chart of accounts"},"main_collection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Collection Id","description":"Id of the entity's main collection"},"deliverable_ids":{"items":{"type":"string"},"type":"array","title":"Deliverable Ids","description":"Deliverable ids for this chart of accounts"}},"type":"object","required":["chart_of_accounts"],"title":"CoaStatementsWithChartOfAccountsWithDeliverablesSchema"},"CoaStatementsWithChartOfAccountsWithDeliverablesSchema-Output":{"properties":{"chart_of_accounts":{"$ref":"#/components/schemas/ChartOfAccountsSchema-Output"},"statements":{"items":{"$ref":"#/components/schemas/CoaStatementWithSourcesSchema-Output"},"type":"array","title":"Statements","description":"Statements for this chart of accounts"},"main_collection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Collection Id","description":"Id of the entity's main collection"},"deliverable_ids":{"items":{"type":"string"},"type":"array","title":"Deliverable Ids","description":"Deliverable ids for this chart of accounts"}},"type":"object","required":["chart_of_accounts"],"title":"CoaStatementsWithChartOfAccountsWithDeliverablesSchema"},"CollateralCategory":{"type":"string","enum":["corporate_guarantee","personal_guarantee","real_estate","equipment","receivables","inventory","cash_securities","other"],"title":"CollateralCategory","description":"Top of the 2-layer collateral taxonomy; the granular leaf is\n``CollateralType``. Stored as String(64) on Collateral so the vocab can\ngrow without a PG ENUM ALTER. Guarantee categories are backed by a\nFinCustomer guarantor; asset categories by a FinAsset (value via\nFinAssetValuation)."},"CollateralLoanAllocationSchema":{"properties":{"loan_id":{"type":"string","title":"Loan Id"},"lien_position":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Lien Position","description":"Lien priority (1 = first lien, 2 = second, ...)"},"allocated_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Allocated Amount","description":"Portion of the collateral value pledged to this loan"}},"type":"object","required":["loan_id"],"title":"CollateralLoanAllocationSchema","description":"A lien: allocation of a collateral to a specific loan."},"CollateralSchema":{"properties":{"collateral_id":{"type":"string","title":"Collateral Id"},"external_collateral_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Collateral Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"deal_id":{"type":"string","title":"Deal Id"},"entity_id":{"type":"string","title":"Entity Id"},"entity_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Name"},"entity_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Kind"},"customer_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Type"},"collateral_category":{"$ref":"#/components/schemas/CollateralCategory"},"collateral_type":{"$ref":"#/components/schemas/CollateralType"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"pledged_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pledged Amount"},"currency":{"type":"string","title":"Currency","default":"USD"},"relative_weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Relative Weight"},"effective_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Effective Date"},"expiration_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Expiration Date"},"status":{"$ref":"#/components/schemas/CollateralStatus"},"loan_allocations":{"items":{"$ref":"#/components/schemas/CollateralLoanAllocationSchema"},"type":"array","title":"Loan Allocations"},"doc_ids":{"items":{"type":"string"},"type":"array","title":"Doc Ids"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"created_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By User Id"},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name"},"created_by_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Email"}},"type":"object","required":["collateral_id","idempotency_key","deal_id","entity_id","collateral_category","collateral_type","status","created_at","updated_at"],"title":"CollateralSchema"},"CollateralStatus":{"type":"string","enum":["pending","perfected","released","expired"],"title":"CollateralStatus","description":"Lien/collateral lifecycle status. String-backed on Collateral."},"CollateralType":{"type":"string","enum":["inter_corporate_guarantee","third_party_guarantee","corporate_guaranty","personal_guaranty","commercial_real_estate","residential_real_estate","equipment","accounts_receivable","inventory","cash_deposit","marketable_securities","other"],"title":"CollateralType","description":"Granular collateral leaf (mirrors the collateral-entry UI's \"Collateral\nType\" dropdown). String-backed on Collateral."},"CombineStatementsRequest":{"properties":{"statements":{"items":{"$ref":"#/components/schemas/OneCombineCoaStatementRequest"},"type":"array","minItems":1,"title":"Statements","description":"One combined statement per entry: the period, and one statement of that period from each contributing customer to combine."},"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Accend customer id of the main customer."}},"type":"object","required":["statements","customer_id"],"title":"CombineStatementsRequest"},"CombineStatementsRequestExt":{"properties":{"statements":{"items":{"$ref":"#/components/schemas/OneCombineCoaStatementRequest"},"type":"array","minItems":1,"title":"Statements","description":"One combined statement per entry: the period, and one statement of that period from each contributing customer to combine."},"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"Your own customer id of the main customer."}},"type":"object","required":["statements","external_customer_id"],"title":"CombineStatementsRequestExt"},"CombinedFinancialsResponse":{"properties":{"customer_id":{"type":"string","title":"Customer Id","description":"Accend customer id of the main customer."},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"Your own customer id of the main customer, if set."},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the customer's financials combine its contributing customers'."},"contributing_entities":{"items":{"$ref":"#/components/schemas/ContributingEntity"},"type":"array","title":"Contributing Entities","description":"The customers whose financials roll up into this customer's, in the order they were set."}},"type":"object","required":["customer_id","external_customer_id","enabled","contributing_entities"],"title":"CombinedFinancialsResponse"},"ComplianceReview-Input":{"properties":{"company":{"$ref":"#/components/schemas/ComplianceReviewCompanyResult-Input"},"people":{"items":{"$ref":"#/components/schemas/ComplianceReviewPersonResult"},"type":"array","title":"People","default":[]},"reports":{"$ref":"#/components/schemas/ComplianceReviewReportResult-Input"}},"type":"object","required":["company","reports"],"title":"ComplianceReview"},"ComplianceReview-Output":{"properties":{"company":{"$ref":"#/components/schemas/ComplianceReviewCompanyResult-Output"},"people":{"items":{"$ref":"#/components/schemas/ComplianceReviewPersonResult"},"type":"array","title":"People","default":[]},"reports":{"$ref":"#/components/schemas/ComplianceReviewReportResult-Output"}},"type":"object","required":["company","reports"],"title":"ComplianceReview"},"ComplianceReviewCompanyResult-Input":{"properties":{"business_verification":{"$ref":"#/components/schemas/BusinessVerificationResult-Input"},"business_description":{"$ref":"#/components/schemas/BusinessDescriptionResult"},"ownership_info":{"anyOf":[{"$ref":"#/components/schemas/OwnershipInformation-Input"},{"type":"null"}]},"address_verification":{"anyOf":[{"$ref":"#/components/schemas/AddressVerificationResult"},{"type":"null"}]},"industry_classification":{"items":{"$ref":"#/components/schemas/IndustryClassificationResult"},"type":"array","title":"Industry Classification"}},"type":"object","required":["business_verification","business_description","industry_classification"],"title":"ComplianceReviewCompanyResult"},"ComplianceReviewCompanyResult-Output":{"properties":{"business_verification":{"$ref":"#/components/schemas/BusinessVerificationResult-Output"},"business_description":{"$ref":"#/components/schemas/BusinessDescriptionResult"},"ownership_info":{"anyOf":[{"$ref":"#/components/schemas/OwnershipInformation-Output"},{"type":"null"}]},"address_verification":{"anyOf":[{"$ref":"#/components/schemas/AddressVerificationResult"},{"type":"null"}]},"industry_classification":{"items":{"$ref":"#/components/schemas/IndustryClassificationResult"},"type":"array","title":"Industry Classification"}},"type":"object","required":["business_verification","business_description","industry_classification"],"title":"ComplianceReviewCompanyResult"},"ComplianceReviewPersonResult":{"properties":{"name":{"type":"string","title":"Name"},"linkedin_profile":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Linkedin Profile"}},"type":"object","required":["name"],"title":"ComplianceReviewPersonResult"},"ComplianceReviewReportResult-Input":{"properties":{"industry_risk_report":{"anyOf":[{"$ref":"#/components/schemas/IndustryRiskReport"},{"type":"null"}],"description":"Industry risk report on proof of business."},"ownership_risk_report":{"anyOf":[{"$ref":"#/components/schemas/OwnershipRiskReport"},{"type":"null"}],"description":"Industry risk report on ownership."},"kyc_report":{"anyOf":[{"$ref":"#/components/schemas/KYCReport"},{"type":"null"}],"description":"KYC/KYB report for the whole case."}},"type":"object","title":"ComplianceReviewReportResult"},"ComplianceReviewReportResult-Output":{"properties":{"industry_risk_report":{"anyOf":[{"$ref":"#/components/schemas/IndustryRiskReport"},{"type":"null"}],"description":"Industry risk report on proof of business."},"ownership_risk_report":{"anyOf":[{"$ref":"#/components/schemas/OwnershipRiskReport"},{"type":"null"}],"description":"Industry risk report on ownership."},"kyc_report":{"anyOf":[{"$ref":"#/components/schemas/KYCReport"},{"type":"null"}],"description":"KYC/KYB report for the whole case."}},"type":"object","title":"ComplianceReviewReportResult"},"ConnectionDetails":{"properties":{"authorized_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Authorized At","description":"When the borrower last authorized this connection, not its last sync."},"realm_id":{"type":"string","title":"Realm Id","description":"The realm ID(quickbooks online) for the link integration.","default":""},"tenant_id":{"type":"string","title":"Tenant Id","description":"The tenant ID(xero) for the link integration.","default":""},"business_uuid":{"type":"string","title":"Business Uuid","description":"The business UUID(freshbooks) for the link integration.","default":""},"organization_id":{"type":"string","title":"Organization Id","description":"The organization ID(zoho books) for the link integration.","default":""},"account_id":{"type":"string","title":"Account Id","description":"The account ID(netsuite) for the link integration.","default":""},"access_token":{"type":"string","title":"Access Token","description":"The access token for the link integration.","default":""},"refresh_token":{"type":"string","title":"Refresh Token","description":"The refresh token for the link integration.","default":""},"refresh_token_expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Refresh Token Expires At","description":"The date and time the refresh token expires."},"consumer_key":{"type":"string","title":"Consumer Key","description":"The consumer key for the link integration.","default":""},"consumer_secret":{"type":"string","title":"Consumer Secret","description":"The consumer secret for the link integration.","default":""},"token_id":{"type":"string","title":"Token Id","description":"The token ID for the link integration.","default":""},"token_secret":{"type":"string","title":"Token Secret","description":"The token secret for the link integration.","default":""},"plaid_item_id":{"type":"string","title":"Plaid Item Id","description":"The Plaid item ID identifying the linked institution login.","default":""},"plaid_access_token":{"type":"string","title":"Plaid Access Token","description":"The Plaid access token for the linked item.","default":""},"plaid_cursor":{"type":"string","title":"Plaid Cursor","description":"The Plaid /transactions/sync cursor for incremental fetches.","default":""},"plaid_environment":{"type":"string","title":"Plaid Environment","description":"The Plaid environment (sandbox/development/production).","default":""},"source_system":{"type":"string","title":"Source System","description":"The ERP an imported source's reports come from: the provider route name, or the generic import's `system`.","default":""},"source_display_name":{"type":"string","title":"Source Display Name","description":"The partner's display name for an imported source.","default":""},"plaid_transactions_update_status":{"type":"string","title":"Plaid Transactions Update Status","description":"Plaid's `transactions_update_status` from /transactions/sync. A different claim from the cursor beside it: the cursor says how far we have read what Plaid holds, this says whether Plaid has finished pulling the institution's history at all, since the initial backfill is asynchronous. Until it reads HISTORICAL_UPDATE_COMPLETE, months before our earliest transaction are uncovered rather than empty.","default":""}},"type":"object","title":"ConnectionDetails","description":"Connection details for a link integration."},"ContactCreate":{"properties":{"first_name":{"type":"string","maxLength":255,"minLength":1,"title":"First Name"},"last_name":{"type":"string","maxLength":255,"minLength":1,"title":"Last Name"},"email":{"type":"string","format":"email","title":"Email","description":"Unique within your organization, compared case-insensitively after trimming."},"display_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Display Name","description":"Derived as 'first last' when omitted."},"middle_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Middle Name"},"title":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Title"},"phone":{"anyOf":[{"type":"string","format":"phone"},{"type":"null"}],"title":"Phone","description":"E.164 with the country code, e.g. +14155552671. Internal spaces are accepted; a national-format number with no leading + is rejected, since there is no default region to read it against."}},"type":"object","required":["first_name","last_name","email"],"title":"ContactCreate"},"ContactRef":{"properties":{"mode":{"$ref":"#/components/schemas/ResolutionMode"},"id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Id"},"external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id","description":"Your own id for the contact, resolved within your organization and stamped on a contact created through link_or_create."},"obj":{"anyOf":[{"$ref":"#/components/schemas/ContactCreate"},{"type":"null"}]},"primary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Primary","description":"Exactly one contact is effectively primary. When no entry sets it the first is primary; when any entry sets it true, exactly one may."}},"type":"object","required":["mode"],"title":"ContactRef","description":"A contact: linked by Accend contact id or by your own id, or created\nfrom ``obj``. The primary contact is the deal's applicant until an\napplication names one."},"ContributingEntity":{"properties":{"customer_id":{"type":"string","title":"Customer Id","description":"Accend customer id of the contributing customer."},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"Your own customer id of the contributing customer, if set."},"contribution":{"type":"number","title":"Contribution","description":"Share of the contributing customer's financials that rolls up into the main customer's, such as the main customer's ownership stake: greater than 0 and at most 1, kept to four decimal places. Shares need not sum to 1; two wholly owned subsidiaries both contribute 1."}},"type":"object","required":["customer_id","external_customer_id","contribution"],"title":"ContributingEntity"},"ContributingEntityInput":{"properties":{"customer_id":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Customer Id","description":"Accend customer id of the contributing customer."},"external_customer_id":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"External Customer Id","description":"Your own customer id of the contributing customer."},"contribution":{"type":"number","title":"Contribution","description":"Share of the contributing customer's financials that rolls up into the main customer's, such as the main customer's ownership stake: greater than 0 and at most 1, kept to four decimal places. Shares need not sum to 1; two wholly owned subsidiaries both contribute 1."}},"type":"object","required":["contribution"],"title":"ContributingEntityInput"},"CoverageRange":{"properties":{"account_id":{"type":"string","maxLength":255,"minLength":1,"title":"Account Id","description":"The account's `account_key`, any id known for it, or its `bank_account_id`."},"start_period":{"type":"string","format":"date","title":"Start Period"},"end_period":{"type":"string","format":"date","title":"End Period"}},"additionalProperties":false,"type":"object","required":["account_id","start_period","end_period"],"title":"CoverageRange"},"CreateBusinessCustomerRequest":{"properties":{"legal_name":{"type":"string","title":"Legal Name","description":"Company Legal name of the customer"},"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dba Name","description":"Company Doing Business As name"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"Customer ID from your system or customer ID you want to use to identify the customer in our system"},"website":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website","description":"Company website"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Company address"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker","description":"Public company ticker, e.g. AAPL"},"fiscal_year_start_month":{"anyOf":[{"$ref":"#/components/schemas/MonthType"},{"type":"null"}],"description":"The start month of the fiscal year"},"industry_codes":{"anyOf":[{"items":{"$ref":"#/components/schemas/app_spread__schemas__commons__IndustryCode"},"type":"array"},{"type":"null"}],"title":"Industry Codes","description":"The company's industry codes"},"legal_structure":{"anyOf":[{"$ref":"#/components/schemas/LegalStructure"},{"type":"null"}],"description":"Legal structure. One of: `c_corp`: C Corporation; `s_corp`: S Corporation; `close_corp`: Close Corporation; `professional_corp`: Professional Corporation (PC); `benefit_corp`: Benefit Corporation / Public Benefit Corporation (For-Profit); `publicly_traded_corp`: Publicly Traded Corporation; `alien_corp`: Alien Corporation; `cooperative`: Cooperative (Incorporated); `partnership`: General Partnership (GP); `limited_partnership`: Limited Partnership (LP); `llp`: Limited Liability Partnership (LLP); `lllp`: Limited Liability Limited Partnership (LLLP); `llc`: Limited Liability Company (LLC); `pllc`: Professional Limited Liability Company (PLLC); `sole_prop`: Sole Proprietorship; `non_profit`: Nonprofit / Not-for-Profit Organization; `private_school`: Private School; `public_school`: Public School / School District; `government`: Government Entity; `public_authority`: Public Authority / Quasi-Public Corporation; `trust`: Trust; `unincorporated_association`: Unincorporated Association; `other`: Other."},"formation_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Formation Date","description":"Date the business entity was formed"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Number","description":"Business registration number (US: EIN/TIN)"},"registration_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Country","description":"ISO 3166-1 alpha-2 country of registration"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Org-defined custom attributes"},"status":{"anyOf":[{"$ref":"#/components/schemas/EntityStatus"},{"type":"null"}],"description":"Customer status (active, inactive, onboarding, suspended). Defaults to active.","default":"active"}},"type":"object","required":["legal_name","idempotency_key"],"title":"CreateBusinessCustomerRequest"},"CreateCaseDocumentRequestPayload":{"properties":{"request_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Request Title","default":"Document Request"},"receiver_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receiver Email","description":"The email address of the receiver, if not provided, will be set to the case main applicant email"},"receiver_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Receiver Name","description":"The email address of the receiver, if not provided, will be set to the case main applicant name"},"opt_out_email_notification":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Opt Out Email Notification","description":"Whether to opt out email notification to receiver email, if not provided, will be set to false","default":false},"documents_to_request":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestForInformationDocumentRequest"},"type":"array"},{"type":"null"}],"title":"Documents To Request"},"flagged_documents_to_revise":{"anyOf":[{"items":{"$ref":"#/components/schemas/FlaggedDocumentRequest"},"type":"array"},{"type":"null"}],"title":"Flagged Documents To Revise"},"email_reminder_setting":{"anyOf":[{"$ref":"#/components/schemas/EmailReminderSetting"},{"type":"null"}]}},"type":"object","title":"CreateCaseDocumentRequestPayload"},"CreateCaseDocumentRequestResponsePayload":{"properties":{"request_id":{"type":"string","title":"Request Id"},"request_link":{"type":"string","title":"Request Link"},"documents":{"items":{"$ref":"#/components/schemas/RequestForInformationDocumentBase"},"type":"array","title":"Documents"}},"type":"object","required":["request_id","request_link","documents"],"title":"CreateCaseDocumentRequestResponsePayload"},"CreateCaseRequest":{"properties":{"external_case_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Case Id","description":"The external case id"},"idempotency_key":{"type":"string","title":"Idempotency Key","description":"The idempotency key for this request"},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id","description":"The assignee user id for this case"},"application":{"anyOf":[{"$ref":"#/components/schemas/ApplicationExtended"},{"type":"null"}],"description":"The application for this case, required for onboarding case"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"The customer id for this case"},"case_type":{"anyOf":[{"type":"string","enum":["Onboarding","Periodic","Ad Hoc"]},{"type":"null"}],"title":"Case Type","default":"Onboarding"},"case_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Case Title","default":"Onboarding Review"},"document_request":{"anyOf":[{"$ref":"#/components/schemas/CreateCaseDocumentRequestPayload"},{"type":"null"}]},"include_complaince_report":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Include Complaince Report","default":true},"external_sync_info":{"anyOf":[{"$ref":"#/components/schemas/ExternalSyncInfo"},{"type":"null"}]}},"type":"object","required":["idempotency_key"],"title":"CreateCaseRequest"},"CreateCaseResponse":{"properties":{"case_id":{"type":"string","title":"Case Id"},"document_request":{"anyOf":[{"$ref":"#/components/schemas/CreateCaseDocumentRequestResponsePayload"},{"type":"null"}]}},"type":"object","required":["case_id"],"title":"CreateCaseResponse"},"CreateCaseTaskRequest":{"properties":{"idempotency_key":{"type":"string","title":"Idempotency Key","description":"The Unique key to ensure idempotency for this request"},"case_task_inputs":{"$ref":"#/components/schemas/CaseTaskInputs"}},"type":"object","required":["idempotency_key","case_task_inputs"],"title":"CreateCaseTaskRequest","description":"Create Case Task schema"},"CreateCaseTaskResponse":{"properties":{"case_id":{"type":"string","title":"Case Id"},"task_id":{"type":"string","title":"Task Id"}},"type":"object","required":["case_id","task_id"],"title":"CreateCaseTaskResponse","description":"Create Case Task response schema"},"CreateCustomerAccessTokenRequest":{"properties":{"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"info_req_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Info Req Id","description":"Information request ID in our system for the information request the case belongs to. This can be none if you are not creating an information request and just want to create a customer access token for accounting software linking."},"expires_in":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires In","description":"Expires in seconds, default is 24 hours which is 86400 seconds.  maximum allowed is 4 months in seconds."}},"type":"object","required":["customer_id"],"title":"CreateCustomerAccessTokenRequest"},"CreateCustomerAccessTokenRequestExt":{"properties":{"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"External customer ID for the customer"},"info_req_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Info Req Id","description":"Information request ID in our system for the information request the case belongs to. This can be none if you are not creating an information request and just want to create a customer access token for accounting software linking."},"expires_in":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires In","description":"Expires in seconds, default is 24 hours which is 86400 seconds, maximum allowed is 4 months in seconds."}},"type":"object","required":["external_customer_id"],"title":"CreateCustomerAccessTokenRequestExt"},"CreateCustomerAccessTokenResponse":{"properties":{"customer_access_token":{"type":"string","title":"Customer Access Token","description":"Access token"},"expires_in":{"type":"integer","title":"Expires In","description":"Expires in seconds"},"link_url":{"type":"string","title":"Link Url","description":"Link URL"}},"type":"object","required":["customer_access_token","expires_in","link_url"],"title":"CreateCustomerAccessTokenResponse"},"CreateDealCommandRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key","description":"Stable per-request key, unique within your organization; a Salesforce caller uses the Opportunity id. A retry with the same key and an equivalent payload returns the original result (200, deduplicated=true). The same key with a different payload is 409 idempotency_key_payload_mismatch."},"external_deal_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Deal Id","description":"Your own id for the deal, unique within your organization: a second deal with the same value is 409 external_deal_id_taken."},"program":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Program","description":"Program key from your organization's catalog. Selects the credit policy, the workflow, the intake template and the document set the applicant is asked for. Omit for the organization's default program. Unknown key: 400 unknown_program; retired key: 400 program_disabled."},"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"initial_stage":{"anyOf":[{"type":"string","enum":["draft","intake"]},{"type":"null"}],"title":"Initial Stage","description":"Where the deal starts; normally omitted, which starts it at the program's first stage (normally draft). Only these two entry points are accepted; later stages are reached through the workflow."},"origination":{"anyOf":[{"$ref":"#/components/schemas/OriginationChannel"},{"type":"null"}]},"allow_link":{"type":"boolean","title":"Allow Link","default":false},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Base currency for the deal's rollups and the default for any loan below that omits one; defaults to the borrower's currency, then USD. ISO 4217, case-insensitive; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, FOK, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XCG, XDR, XOF, XPF, YER, ZAR, ZMW, ZWL."},"requested_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Requested Limit","description":"Total credit requested for the deal, in the deal's currency. The loans below are the product slices of that line."},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"info_req_email_templates":{"anyOf":[{"$ref":"#/components/schemas/DealEmailTemplatesSchema"},{"type":"null"}],"description":"Templates for the deal's information requests. Falls back to the org's defaults when omitted, as legacy deal creation does."},"borrower":{"oneOf":[{"$ref":"#/components/schemas/BusinessRef"},{"$ref":"#/components/schemas/IndividualRef"}],"title":"Borrower","description":"The applicant. A property cannot be the main borrower.","discriminator":{"propertyName":"kind","mapping":{"business":"#/components/schemas/BusinessRef","individual":"#/components/schemas/IndividualRef"}}},"parties":{"items":{"oneOf":[{"$ref":"#/components/schemas/BusinessPartyRef"},{"$ref":"#/components/schemas/IndividualPartyRef"},{"$ref":"#/components/schemas/PropertyPartyRef"}],"discriminator":{"propertyName":"kind","mapping":{"business":"#/components/schemas/BusinessPartyRef","individual":"#/components/schemas/IndividualPartyRef","property":"#/components/schemas/PropertyPartyRef"}}},"type":"array","maxItems":50,"title":"Parties","description":"Parties other than the main borrower, which is added automatically with role borrower."},"contacts":{"items":{"$ref":"#/components/schemas/ContactRef"},"type":"array","maxItems":25,"title":"Contacts"},"loans":{"items":{"$ref":"#/components/schemas/NestedLoanCreate"},"type":"array","maxItems":25,"title":"Loans","description":"Create-only product slices of the requested line, returned in request order."},"assignments":{"anyOf":[{"$ref":"#/components/schemas/Assignments"},{"type":"null"}]}},"type":"object","required":["idempotency_key","name","borrower"],"title":"CreateDealCommandRequest","description":"Create a deal with its borrower, parties, contacts and loans. The\napplicant's application is started in Accend once the deal is ready.\n\nUnrecognised fields are ignored rather than rejected, so a misspelled\noptional field is silently absent from the created deal. The one exception\nis ``application``, which this endpoint no longer accepts."},"CreateDealResponse":{"properties":{"discovery":{"anyOf":[{"$ref":"#/components/schemas/DealDiscovery"},{"type":"null"}]},"deal":{"$ref":"#/components/schemas/DealSummary"},"borrower":{"$ref":"#/components/schemas/ResolvedRef"},"parties":{"items":{"$ref":"#/components/schemas/ResolvedPartyRef"},"type":"array","title":"Parties"},"contacts":{"items":{"$ref":"#/components/schemas/ResolvedContactRef"},"type":"array","title":"Contacts"},"loans":{"items":{"$ref":"#/components/schemas/ResolvedRef"},"type":"array","title":"Loans"},"assignments":{"$ref":"#/components/schemas/ResolvedAssignments"},"deduplicated":{"type":"boolean","title":"Deduplicated","description":"True when a stored result was replayed for a repeated idempotency_key instead of a new deal being created.","default":false},"warnings":{"items":{"$ref":"#/components/schemas/CreateDealWarning"},"type":"array","title":"Warnings","description":"Non-fatal notices. Reserved and currently always empty: every reference failure aborts the request before any write."}},"type":"object","required":["deal","borrower"],"title":"CreateDealResponse"},"CreateDealWarning":{"properties":{"field":{"type":"string","title":"Field"},"code":{"type":"string","title":"Code"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"candidate_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Candidate Id"}},"type":"object","required":["field","code"],"title":"CreateDealWarning","description":"Reserved. Always empty today: every reference failure aborts the request\nbefore any write, so there is nothing non-fatal to report yet."},"CreateFinStmtSpreadingCaseRequest":{"properties":{"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids","description":"List of document IDs for the case."},"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"case_name":{"type":"string","maxLength":255,"minLength":1,"title":"Case Name","description":"Case name"},"case_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Priority","description":"Case priority"},"review_type":{"anyOf":[{"type":"string","enum":["initiation","monthly","quarterly","semi_annually","annually","ad-hoc"]},{"type":"null"}],"title":"Review Type"},"spreading_request":{"anyOf":[{"$ref":"#/components/schemas/CaseSpreadingRequestExternal"},{"type":"null"}]}},"type":"object","required":["document_ids","customer_id","idempotency_key","case_name"],"title":"CreateFinStmtSpreadingCaseRequest"},"CreateFinStmtSpreadingCaseRequestExt":{"properties":{"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids","description":"List of document IDs for the case."},"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"external customer id for the customer the case belongs to"},"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"case_name":{"type":"string","maxLength":255,"minLength":1,"title":"Case Name","description":"Case name"},"case_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Priority","description":"Case priority"},"review_type":{"anyOf":[{"type":"string","enum":["initiation","monthly","quarterly","semi_annually","annually","ad-hoc"]},{"type":"null"}],"title":"Review Type"},"spreading_request":{"anyOf":[{"$ref":"#/components/schemas/CaseSpreadingRequestExternal"},{"type":"null"}]}},"type":"object","required":["document_ids","external_customer_id","idempotency_key","case_name"],"title":"CreateFinStmtSpreadingCaseRequestExt"},"CreateFinStmtSpreadingCaseRequestProperty":{"properties":{"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids","description":"List of document IDs for the case."},"asset_id":{"type":"string","maxLength":255,"title":"Asset Id","description":"Asset ID in our system for the asset the case belongs to"},"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"case_name":{"type":"string","maxLength":255,"minLength":1,"title":"Case Name","description":"Case name"},"case_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Priority","description":"Case priority"},"review_type":{"anyOf":[{"type":"string","enum":["initiation","monthly","quarterly","semi_annually","annually","ad-hoc"]},{"type":"null"}],"title":"Review Type"},"spreading_request":{"anyOf":[{"$ref":"#/components/schemas/CaseSpreadingRequestExternal"},{"type":"null"}]}},"type":"object","required":["document_ids","asset_id","idempotency_key","case_name"],"title":"CreateFinStmtSpreadingCaseRequestProperty"},"CreateIndividualCustomerRequest":{"properties":{"first_name":{"type":"string","title":"First Name","description":"Individual's first name"},"last_name":{"type":"string","title":"Last Name","description":"Individual's last name"},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name","description":"Individual's middle name"},"spouse_first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spouse First Name","description":"Individual's spouse's first name"},"spouse_last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spouse Last Name","description":"Individual's spouse's last name"},"spouse_middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spouse Middle Name","description":"Individual's spouse's middle name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Individual's address"},"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"Customer ID from your system or customer ID you want to use to identify the customer in our system"},"fiscal_year_start_month":{"anyOf":[{"$ref":"#/components/schemas/MonthType"},{"type":"null"}],"description":"The start month of the fiscal year"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Org-defined custom attributes"},"status":{"anyOf":[{"$ref":"#/components/schemas/EntityStatus"},{"type":"null"}],"description":"Customer status (active, inactive, onboarding, suspended). Defaults to active.","default":"active"}},"type":"object","required":["first_name","last_name","idempotency_key"],"title":"CreateIndividualCustomerRequest"},"CreateLoanSchema":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"external_loan_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Loan Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"deal_id":{"type":"string","title":"Deal Id"},"initial_stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Initial Stage","description":"Initial loan lifecycle stage; defaults to the program's first stage"},"product_type":{"$ref":"#/components/schemas/LoanProductType"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"The currency of the loan; defaults to the deal's currency"},"limit_amount":{"type":"number","title":"Limit Amount"},"interest_type":{"$ref":"#/components/schemas/LoanInterestType"},"interest_rate":{"type":"number","title":"Interest Rate","description":"The interest rate of the loan (e.g. 5.25 for 5.25%)","default":0.0},"interest_benchmark":{"anyOf":[{"$ref":"#/components/schemas/LoanInterestBenchmark"},{"type":"null"}],"description":"Benchmark index for floating-rate pricing (e.g. sofr, prime)"},"interest_spread":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Spread","description":"Percent over the benchmark (e.g. 2.75 for benchmark + 2.75%)"},"repayment_type":{"$ref":"#/components/schemas/LoanRepaymentType"},"amortization_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amortization Months","description":"Amortization period in months; a balloon is implied when longer than the term"},"balloon_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Balloon Amount","description":"Scheduled final lump-sum (balloon) payment amount"},"billing_cycle":{"anyOf":[{"$ref":"#/components/schemas/LoanBillingCycle"},{"type":"null"}],"description":"Statement/payment cadence (e.g. weekly for fuel cards, monthly)"},"purpose":{"$ref":"#/components/schemas/LoanPurpose"},"seniority":{"anyOf":[{"$ref":"#/components/schemas/LoanSeniority"},{"type":"null"}]},"prepayment_penalty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prepayment Penalty","description":"Prepayment penalty terms, e.g. '3-2-1 step-down'"},"unused_fee_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unused Fee Rate","description":"Annual percent charged on the undrawn commitment (e.g. 0.25)"},"start_date":{"type":"string","format":"date","title":"Start Date","description":"The start date of the loan in ISO 8601 date format"},"maturity_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Maturity Date","description":"The maturity date of the loan in ISO 8601 date format"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"}},"type":"object","required":["name","idempotency_key","deal_id","product_type","limit_amount","interest_type","repayment_type","purpose","start_date"],"title":"CreateLoanSchema"},"CurrentEvent":{"properties":{"event_instance_id":{"type":"string","title":"Event Instance Id"},"event_type":{"type":"string","title":"Event Type"},"status":{"type":"string","enum":["open","closed","cancelled"],"title":"Status"}},"type":"object","required":["event_instance_id","event_type","status"],"title":"CurrentEvent"},"CustomRatioFormulaSchema":{"properties":{"formula":{"type":"string","title":"Formula"},"unit":{"type":"string","enum":["ratio","dollars","months","percent","days"],"title":"Unit","default":"ratio"},"group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Key","description":"The ratio group key"},"group_version_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Version Hash","description":"The version hash of the ratio group"},"key":{"type":"string","title":"Key","description":"The ratio key"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"order_index":{"type":"integer","title":"Order Index"}},"type":"object","required":["formula","key","name","order_index"],"title":"CustomRatioFormulaSchema"},"CustomerCashFlowScenarioCreationSchema":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"involved_parties":{"items":{"anyOf":[{"$ref":"#/components/schemas/CFSInvolvedCustomerCreationSchema"},{"$ref":"#/components/schemas/CFSInvolvedPropertyCreationSchema"}]},"type":"array","title":"Involved Parties"},"periods":{"items":{"$ref":"#/components/schemas/CFSPeriodCreationSchema"},"type":"array","title":"Periods"}},"type":"object","required":["customer_id","name","involved_parties","periods"],"title":"CustomerCashFlowScenarioCreationSchema"},"CustomerFinancialsSearchCriteria":{"properties":{"search_id":{"type":"string","title":"Search Id","description":"Search ID that is specified by the caller to identify the search results"},"start_period":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Period","description":"Filter financal statements to include only those with a start_period greater than or equal to the specified start period date."},"end_period":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Period","description":"Filter financal statements to include only those with an end_period less than or equal to the specified end period date."},"period_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Period Length","description":"Filter financal statements to include only those with a period length equal to the specified period length. The value is in months."}},"type":"object","required":["search_id"],"title":"CustomerFinancialsSearchCriteria"},"CustomerType":{"type":"string","enum":["individual","business"],"title":"CustomerType"},"CustomersResponse":{"properties":{"customers":{"items":{"oneOf":[{"$ref":"#/components/schemas/BusinessCustomerResponse"},{"$ref":"#/components/schemas/IndividualCustomerResponse"}],"discriminator":{"propertyName":"customer_type","mapping":{"business":"#/components/schemas/BusinessCustomerResponse","individual":"#/components/schemas/IndividualCustomerResponse"}}},"type":"array","title":"Customers","description":"List of customers"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Next offset for pagination"},"total":{"type":"integer","title":"Total","description":"Total number of customers"}},"type":"object","required":["customers","total"],"title":"CustomersResponse"},"DailyBalancePoint":{"properties":{"on":{"type":"string","format":"date","title":"On"},"balance":{"type":"number","title":"Balance"}},"type":"object","required":["on","balance"],"title":"DailyBalancePoint","description":"v1's `BankStatementDailyRunningBalance`.\n\nKept because a daily series cannot be reconstructed from monthly buckets,\nand it is what `UnderwritingBankStatementsBalanceHistoryGraph` renders. Case\nonly: a daily series over a 24-month window is ~730 points per account, which\nbelongs behind its own endpoint if the API ever wants it."},"DataSourceStatementType":{"type":"string","enum":["income_statement","balance_sheet","cash_flow_statement"],"title":"DataSourceStatementType"},"DealDiscovery":{"properties":{"events_url":{"type":"string","title":"Events Url"},"events":{"items":{"$ref":"#/components/schemas/PartnerEvent"},"type":"array","title":"Events"}},"type":"object","required":["events_url"],"title":"DealDiscovery"},"DealEmailTemplatesSchema":{"properties":{"request_email_template_key":{"type":"string","title":"Request Email Template Key"},"reminder_email_template_key":{"type":"string","title":"Reminder Email Template Key"},"follow_up_email_template_key":{"type":"string","title":"Follow Up Email Template Key"}},"type":"object","required":["request_email_template_key","reminder_email_template_key","follow_up_email_template_key"],"title":"DealEmailTemplatesSchema"},"DealListResponse":{"properties":{"deals":{"items":{"$ref":"#/components/schemas/DealOverviewSchema"},"type":"array","title":"Deals"},"total":{"type":"integer","title":"Total"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["deals","total"],"title":"DealListResponse"},"DealOverviewSchema":{"properties":{"deal_id":{"type":"string","title":"Deal Id"},"external_deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Deal Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"main_borrower_id":{"type":"string","title":"Main Borrower Id"},"main_borrower_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Borrower Name"},"stage":{"type":"string","title":"Stage"},"status":{"$ref":"#/components/schemas/OperationalStatus"},"program":{"type":"string","title":"Program"},"monitoring_status":{"anyOf":[{"$ref":"#/components/schemas/MonitoringStatus"},{"type":"null"}]},"allow_link":{"type":"boolean","title":"Allow Link","default":false},"involved_parties":{"items":{"anyOf":[{"$ref":"#/components/schemas/InvolvedCustomerSchema"},{"$ref":"#/components/schemas/InvolvedPropertySchema"}]},"type":"array","title":"Involved Parties"},"currency":{"type":"string","title":"Currency","default":"USD"},"requested_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Requested Limit"},"approved_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Approved Limit"},"allocated_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Allocated Limit","default":0},"allocated_limit_is_converted":{"type":"boolean","title":"Allocated Limit Is Converted","default":false},"loan_count":{"type":"integer","title":"Loan Count","default":0},"open_blocking_check_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Open Blocking Check Count"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["deal_id","name","main_borrower_id","stage","status","program","involved_parties","created_at","updated_at"],"title":"DealOverviewSchema"},"DealPartyRole":{"type":"string","enum":["borrower","co_borrower","guarantor","sponsor","party"],"title":"DealPartyRole"},"DealSchema":{"properties":{"deal_id":{"type":"string","title":"Deal Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"main_borrower_id":{"type":"string","title":"Main Borrower Id"},"stage":{"type":"string","title":"Stage"},"status":{"$ref":"#/components/schemas/OperationalStatus"},"program":{"type":"string","title":"Program"},"monitoring_status":{"anyOf":[{"$ref":"#/components/schemas/MonitoringStatus"},{"type":"null"}]},"origination":{"anyOf":[{"$ref":"#/components/schemas/OriginationChannel"},{"type":"null"}]},"allow_link":{"type":"boolean","title":"Allow Link","default":false},"currency":{"type":"string","title":"Currency","default":"USD"},"analyst_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analyst User Id"},"secondary_analyst_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secondary Analyst User Id"},"sales_rep_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sales Rep User Id"},"analyst":{"anyOf":[{"$ref":"#/components/schemas/TaskUserSchema"},{"type":"null"}]},"secondary_analyst":{"anyOf":[{"$ref":"#/components/schemas/TaskUserSchema"},{"type":"null"}]},"sales_rep":{"anyOf":[{"$ref":"#/components/schemas/TaskUserSchema"},{"type":"null"}]},"involved_parties":{"items":{"anyOf":[{"$ref":"#/components/schemas/InvolvedCustomerSchema"},{"$ref":"#/components/schemas/InvolvedPropertySchema"}]},"type":"array","title":"Involved Parties"},"loans":{"items":{"$ref":"#/components/schemas/LoanSchema"},"type":"array","title":"Loans"},"requested_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Requested Limit"},"approved_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Approved Limit"},"allocated_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Allocated Limit","default":0},"allocated_limit_is_converted":{"type":"boolean","title":"Allocated Limit Is Converted","default":false},"collaterals":{"items":{"$ref":"#/components/schemas/CollateralSchema"},"type":"array","title":"Collaterals"},"info_req_email_templates":{"anyOf":[{"$ref":"#/components/schemas/DealEmailTemplatesSchema"},{"type":"null"}]},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["deal_id","name","main_borrower_id","stage","status","program","involved_parties","loans","created_at","updated_at"],"title":"DealSchema"},"DealSummary":{"properties":{"deal_id":{"type":"string","title":"Deal Id"},"external_deal_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Deal Id"},"name":{"type":"string","title":"Name"},"program":{"type":"string","title":"Program"},"stage":{"type":"string","title":"Stage"},"status":{"$ref":"#/components/schemas/OperationalStatus"}},"type":"object","required":["deal_id","name","program","stage","status"],"title":"DealSummary","description":"The created deal, abridged. Read the deal back for the full record."},"DebtCalculationMethod":{"type":"string","enum":["periodic","daily_accrual_365","daily_accrual_360"],"title":"DebtCalculationMethod"},"DebtDeleteResponse":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"DebtDeleteResponse"},"DebtLoanAdditionalEventCreationSchema":{"properties":{"loan_event_type":{"type":"string","const":"ADDITIONAL","title":"Loan Event Type","default":"ADDITIONAL"},"effective_date":{"type":"string","format":"date","title":"Effective Date"},"lump_sum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lump Sum Amount"},"annual_percentage_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Annual Percentage Rate","description":"Annual percentage rate in %"},"term_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Term Months"},"payments_per_year":{"anyOf":[{"type":"integer","enum":[1,2,4,12]},{"type":"null"}],"title":"Payments Per Year"},"payment_type":{"anyOf":[{"$ref":"#/components/schemas/DebtPaymentType"},{"type":"null"}]},"final_lump_sum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Lump Sum Amount"},"hold_payment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hold Payment"}},"type":"object","required":["effective_date"],"title":"DebtLoanAdditionalEventCreationSchema"},"DebtLoanEventCreationRequestSchema":{"properties":{"events":{"items":{"oneOf":[{"$ref":"#/components/schemas/DebtLoanInitialEventCreationSchema"},{"$ref":"#/components/schemas/DebtLoanAdditionalEventCreationSchema"},{"$ref":"#/components/schemas/DebtLoanTerminationEventCreationSchema"}],"discriminator":{"propertyName":"loan_event_type","mapping":{"ADDITIONAL":"#/components/schemas/DebtLoanAdditionalEventCreationSchema","INITIAL":"#/components/schemas/DebtLoanInitialEventCreationSchema","TERMINATION":"#/components/schemas/DebtLoanTerminationEventCreationSchema"}}},"type":"array","title":"Events"}},"type":"object","required":["events"],"title":"DebtLoanEventCreationRequestSchema"},"DebtLoanEventSchema":{"properties":{"effective_date":{"type":"string","format":"date","title":"Effective Date"},"lump_sum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lump Sum Amount"},"annual_percentage_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Annual Percentage Rate"},"term_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Term Months"},"payments_per_year":{"anyOf":[{"type":"integer","enum":[1,2,4,12]},{"type":"null"}],"title":"Payments Per Year"},"payment_type":{"anyOf":[{"$ref":"#/components/schemas/DebtPaymentType"},{"type":"null"}]},"final_lump_sum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Lump Sum Amount"},"calculation_method":{"anyOf":[{"$ref":"#/components/schemas/DebtCalculationMethod"},{"type":"null"}]},"hold_payment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hold Payment"},"debt_event_id":{"type":"string","title":"Debt Event Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"loan_event_type":{"$ref":"#/components/schemas/DebtLoanEventType"}},"type":"object","required":["effective_date","debt_event_id","created_at","loan_event_type"],"title":"DebtLoanEventSchema"},"DebtLoanEventType":{"type":"string","enum":["INITIAL","ADDITIONAL","TERMINATION"],"title":"DebtLoanEventType"},"DebtLoanInitialEventCreationSchema":{"properties":{"loan_event_type":{"type":"string","const":"INITIAL","title":"Loan Event Type","default":"INITIAL"},"effective_date":{"type":"string","format":"date","title":"Effective Date"},"annual_percentage_rate":{"type":"number","title":"Annual Percentage Rate","description":"Annual percentage rate in %"},"payments_per_year":{"type":"integer","enum":[1,2,4,12],"title":"Payments Per Year"},"term_months":{"type":"integer","title":"Term Months"},"payment_type":{"$ref":"#/components/schemas/DebtPaymentType"},"calculation_method":{"$ref":"#/components/schemas/DebtCalculationMethod"},"final_lump_sum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Lump Sum Amount"},"last_payment_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Last Payment Date"}},"type":"object","required":["effective_date","annual_percentage_rate","payments_per_year","term_months","payment_type","calculation_method"],"title":"DebtLoanInitialEventCreationSchema"},"DebtLoanTerminationEventCreationSchema":{"properties":{"loan_event_type":{"type":"string","const":"TERMINATION","title":"Loan Event Type","default":"TERMINATION"},"effective_date":{"type":"string","format":"date","title":"Effective Date"}},"type":"object","required":["effective_date"],"title":"DebtLoanTerminationEventCreationSchema"},"DebtOverviewSchema":{"properties":{"debt_id":{"type":"string","title":"Debt Id"},"external_debt_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Debt Id"},"name":{"type":"string","title":"Name"},"lender_name":{"type":"string","title":"Lender Name"},"coa_account_key":{"type":"string","title":"Coa Account Key"},"loan_amount":{"type":"number","title":"Loan Amount"},"annual_percentage_rate":{"type":"number","title":"Annual Percentage Rate"},"payments_per_year":{"type":"integer","enum":[1,2,4,12],"title":"Payments Per Year"},"current_monthly_payment_amount":{"type":"number","title":"Current Monthly Payment Amount"},"current_annual_payment_amount":{"type":"number","title":"Current Annual Payment Amount"},"term_months":{"type":"integer","title":"Term Months"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"first_payment_date":{"type":"string","title":"First Payment Date"},"last_payment_date":{"type":"string","title":"Last Payment Date"},"termination_payment_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Termination Payment Date"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"customer_legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Legal Name"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id"},"asset_legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Legal Name"}},"type":"object","required":["debt_id","name","lender_name","coa_account_key","loan_amount","annual_percentage_rate","payments_per_year","current_monthly_payment_amount","current_annual_payment_amount","term_months","created_at","updated_at","first_payment_date","last_payment_date"],"title":"DebtOverviewSchema"},"DebtPaymentType":{"type":"string","enum":["principal_and_interest","interest_only"],"title":"DebtPaymentType"},"DetailErrorResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"DetailErrorResponse","description":"FastAPI's default error envelope.\n\nUsed by the authentication dependency every ``/api/v1`` route shares, so a\n401 carries this shape rather than ``StructuredErrorResponse``."},"DirectInputMoney-Input":{"properties":{"amount":{"anyOf":[{"type":"number"},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"}],"title":"Amount","description":"The amount, as a decimal string or a number."},"currency":{"type":"string","title":"Currency","description":"ISO 4217 code the amount is in."}},"additionalProperties":false,"type":"object","required":["amount","currency"],"title":"DirectInputMoney","description":"A Money direct-input value: the exact amount, in the currency it was\nentered in. A run keeps it as entered and converts it into the version's\ncurrency before the model calculates."},"DirectInputMoney-Output":{"properties":{"amount":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)","title":"Amount","description":"The amount, as a decimal string or a number."},"currency":{"type":"string","title":"Currency","description":"ISO 4217 code the amount is in."}},"additionalProperties":false,"type":"object","required":["amount","currency"],"title":"DirectInputMoney","description":"A Money direct-input value: the exact amount, in the currency it was\nentered in. A run keeps it as entered and converts it into the version's\ncurrency before the model calculates."},"DirectInputValue-Input":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"$ref":"#/components/schemas/DirectInputMoney-Input"},{"type":"null"}]},"DirectInputValue-Output":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"$ref":"#/components/schemas/DirectInputMoney-Output"},{"type":"null"}]},"DocumentCategory":{"type":"string","enum":["financial_statement","tax_return","legal","identity","collateral","credit","loan_doc","other"],"title":"DocumentCategory","description":"Top of the 2-layer catalog taxonomy. The granular leaf is\n``FinCustomerDocumentType``. Stored as String on FinCustomerDoc so the\nvocabulary can grow without a PG ENUM ALTER."},"DocumentMutationReceipt":{"properties":{"idempotency_key":{"type":"string","title":"Idempotency Key"},"information_request_id":{"type":"string","title":"Information Request Id"},"entity_ids":{"items":{"type":"string"},"type":"array","title":"Entity Ids"},"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids"},"status":{"type":"string","enum":["accepted","submitted"],"title":"Status"},"request_url":{"type":"string","title":"Request Url"}},"type":"object","required":["idempotency_key","information_request_id","entity_ids","document_ids","status","request_url"],"title":"DocumentMutationReceipt"},"DocumentType":{"type":"string","enum":["Passport","Driver License","Proof of Address","Certificate of Incorporation","Tax Document","Ownership Structure","Source of Funds","Regulatory Licence","Banking Statement","Financial Statement","Supporting Document"],"title":"DocumentType"},"EmailReminderSetting":{"properties":{"interval":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Interval","description":"Number of days","default":5},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Number of total times","default":2}},"type":"object","title":"EmailReminderSetting"},"EnableConfig":{"properties":{"enable":{"type":"boolean","title":"Enable","description":"Enable the validation","default":true}},"type":"object","title":"EnableConfig"},"EntityStatus":{"type":"string","enum":["active","inactive","onboarding","suspended"],"title":"EntityStatus"},"EvidenceReplacement":{"properties":{"replaces_document_id":{"type":"string","maxLength":255,"minLength":1,"title":"Replaces Document Id"},"document_id":{"type":"string","maxLength":255,"minLength":1,"title":"Document Id"}},"additionalProperties":false,"type":"object","required":["replaces_document_id","document_id"],"title":"EvidenceReplacement"},"ExtendedDualUseAssessment":{"properties":{"classification":{"anyOf":[{"type":"string","enum":["MILITARY","DUAL_USE","NON_MDUG"]},{"type":"null"}],"title":"Classification","description":"Verdict of the export-controls assessment against the Military List and dual-use Annex I. Null on assessments recorded before the verdict was reported apart from the review. It does not decide risk_label or risk_score, which stay results of the industry classification."},"assessment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assessment","description":"The review the verdict was drawn from."}},"type":"object","title":"ExtendedDualUseAssessment"},"ExternalBusinessDebtCreationSchema":{"properties":{"customer_id":{"type":"string","maxLength":255,"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Asset Id"},"external_debt_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Debt Id"},"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"name":{"type":"string","maxLength":255,"title":"Name"},"coa_account_key":{"type":"string","enum":["business_credit_card","business_line_of_credit","commercial_mortgage","term_loan","sba_loan","equipment_asset_financing","financial_lease_liabilities","subordinated_debt","related_parties_liabilities","other_debt_payments","refinanced_debt"],"title":"Coa Account Key"},"lender_name":{"type":"string","maxLength":255,"title":"Lender Name"},"loan_amount":{"type":"number","title":"Loan Amount"},"initial_event":{"$ref":"#/components/schemas/DebtLoanInitialEventCreationSchema"},"additional_events":{"anyOf":[{"items":{"$ref":"#/components/schemas/DebtLoanAdditionalEventCreationSchema"},"type":"array"},{"type":"null"}],"title":"Additional Events"},"termination_event":{"anyOf":[{"$ref":"#/components/schemas/DebtLoanTerminationEventCreationSchema"},{"type":"null"}]}},"type":"object","required":["customer_id","idempotency_key","name","coa_account_key","lender_name","loan_amount","initial_event"],"title":"ExternalBusinessDebtCreationSchema"},"ExternalBusinessDebtUpdateSchema":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"name":{"type":"string","maxLength":255,"title":"Name"},"coa_account_key":{"type":"string","enum":["business_credit_card","business_line_of_credit","commercial_mortgage","term_loan","sba_loan","equipment_asset_financing","financial_lease_liabilities","subordinated_debt","related_parties_liabilities","other_debt_payments","refinanced_debt"],"title":"Coa Account Key"},"lender_name":{"type":"string","maxLength":255,"title":"Lender Name"},"loan_amount":{"type":"number","title":"Loan Amount"},"asset_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Asset Id"},"external_debt_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Debt Id"}},"type":"object","required":["idempotency_key","name","coa_account_key","lender_name","loan_amount"],"title":"ExternalBusinessDebtUpdateSchema"},"ExternalCaseDocumentRequest-Input":{"properties":{"request_id":{"type":"string","title":"Request Id"},"request_link":{"type":"string","title":"Request Link"},"status":{"type":"string","enum":["Pending","Received"],"title":"Status"},"documents":{"items":{"$ref":"#/components/schemas/RequestForInformationDocumentBase"},"type":"array","title":"Documents"}},"type":"object","required":["request_id","request_link","status","documents"],"title":"ExternalCaseDocumentRequest"},"ExternalCaseDocumentRequest-Output":{"properties":{"request_id":{"type":"string","title":"Request Id"},"request_link":{"type":"string","title":"Request Link"},"status":{"type":"string","enum":["Pending","Received"],"title":"Status"},"documents":{"items":{"$ref":"#/components/schemas/RequestForInformationDocumentBase"},"type":"array","title":"Documents"}},"type":"object","required":["request_id","request_link","status","documents"],"title":"ExternalCaseDocumentRequest"},"ExternalCaseResponse-Input":{"properties":{"case_id":{"type":"string","title":"Case Id"},"case_title":{"type":"string","title":"Case Title"},"company_legal_name":{"type":"string","title":"Company Legal Name"},"company_name":{"type":"string","title":"Company Name"},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id"},"assignee_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Name"},"priority":{"$ref":"#/components/schemas/PriorityLevel"},"status":{"$ref":"#/components/schemas/CaseStatus"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"},"completed":{"type":"boolean","title":"Completed","description":"Whether the case analysis is completed"},"process_results":{"anyOf":[{"$ref":"#/components/schemas/CaseProcessResult-Input"},{"type":"null"}],"description":"The case process results"},"case_type":{"anyOf":[{"type":"string","enum":["Onboarding","Periodic","Ad Hoc"]},{"type":"null"}],"title":"Case Type","default":"Onboarding"},"case_events":{"anyOf":[{"items":{"$ref":"#/components/schemas/CaseEventResponse"},"type":"array"},{"type":"null"}],"title":"Case Events"},"document_requests":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalCaseDocumentRequest-Input"},"type":"array"},{"type":"null"}],"title":"Document Requests"}},"type":"object","required":["case_id","case_title","company_legal_name","company_name","priority","status","created_at","updated_at"],"title":"ExternalCaseResponse"},"ExternalCaseResponse-Output":{"properties":{"case_id":{"type":"string","title":"Case Id"},"case_title":{"type":"string","title":"Case Title"},"company_legal_name":{"type":"string","title":"Company Legal Name"},"company_name":{"type":"string","title":"Company Name"},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Id"},"assignee_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignee Name"},"priority":{"$ref":"#/components/schemas/PriorityLevel"},"status":{"$ref":"#/components/schemas/CaseStatus"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"},"completed":{"type":"boolean","title":"Completed","description":"Whether the case analysis is completed"},"process_results":{"anyOf":[{"$ref":"#/components/schemas/CaseProcessResult-Output"},{"type":"null"}],"description":"The case process results"},"case_type":{"anyOf":[{"type":"string","enum":["Onboarding","Periodic","Ad Hoc"]},{"type":"null"}],"title":"Case Type","default":"Onboarding"},"case_events":{"anyOf":[{"items":{"$ref":"#/components/schemas/CaseEventResponse"},"type":"array"},{"type":"null"}],"title":"Case Events"},"document_requests":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalCaseDocumentRequest-Output"},"type":"array"},{"type":"null"}],"title":"Document Requests"}},"type":"object","required":["case_id","case_title","company_legal_name","company_name","priority","status","created_at","updated_at"],"title":"ExternalCaseResponse"},"ExternalCreateFinModelRunRequest":{"properties":{"fin_model_template_key":{"type":"string","title":"Fin Model Template Key","description":"Key of the template to base the run on."},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version","description":"Template version to use. If omitted, the default version is used."},"name":{"type":"string","title":"Name","description":"Display name for the run."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description."},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Id","description":"Entity ID to associate with this run."},"statement_inputs":{"items":{"$ref":"#/components/schemas/FinModelRunInputBindingRequest"},"type":"array","title":"Statement Inputs","description":"Statement or scenario bindings for the template's input slots.","default":[]},"direct_inputs":{"items":{"$ref":"#/components/schemas/FinModelRunDirectInputBindingRequest"},"type":"array","title":"Direct Inputs","description":"Values for the template's direct input slots.","default":[]},"deal_inputs":{"items":{"$ref":"#/components/schemas/FinModelRunDealInputBindingRequest"},"type":"array","title":"Deal Inputs","description":"Deal bindings for the template's deal input slots.","default":[]},"loan_inputs":{"items":{"$ref":"#/components/schemas/FinModelRunLoanInputBindingRequest"},"type":"array","title":"Loan Inputs","description":"Loan bindings for the template's loan input slots.","default":[]},"bank_inputs":{"items":{"$ref":"#/components/schemas/FinModelRunBankInputBindingRequest"},"type":"array","title":"Bank Inputs","description":"Bank bindings (entity + window) for the template's bank input slots.","default":[]}},"type":"object","required":["fin_model_template_key","name"],"title":"ExternalCreateFinModelRunRequest","description":"Create a new financial model run from a template."},"ExternalDebtOverviewsSchema":{"properties":{"debts":{"items":{"$ref":"#/components/schemas/DebtOverviewSchema"},"type":"array","title":"Debts"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"total":{"type":"integer","title":"Total","description":"Total number of debts"}},"type":"object","required":["debts","total"],"title":"ExternalDebtOverviewsSchema"},"ExternalDebtSchema":{"properties":{"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id"},"debt_id":{"type":"string","title":"Debt Id"},"external_debt_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Debt Id"},"name":{"type":"string","title":"Name"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"coa_account_key":{"type":"string","title":"Coa Account Key"},"lender_name":{"type":"string","title":"Lender Name"},"loan_amount":{"type":"number","title":"Loan Amount"},"annual_percentage_rate":{"type":"number","title":"Annual Percentage Rate"},"payments_per_year":{"type":"integer","enum":[1,2,4,12],"title":"Payments Per Year"},"term_months":{"type":"integer","title":"Term Months"},"first_payment_date":{"type":"string","format":"date-time","title":"First Payment Date"},"last_payment_date":{"type":"string","format":"date-time","title":"Last Payment Date"},"termination_payment_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Termination Payment Date"},"payment_type":{"$ref":"#/components/schemas/DebtPaymentType"},"calculation_method":{"$ref":"#/components/schemas/DebtCalculationMethod"},"final_lump_sum_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Final Lump Sum Amount"},"current_monthly_payment_amount":{"type":"number","title":"Current Monthly Payment Amount"},"loan_events":{"items":{"$ref":"#/components/schemas/DebtLoanEventSchema"},"type":"array","title":"Loan Events"}},"type":"object","required":["debt_id","name","created_at","updated_at","coa_account_key","lender_name","loan_amount","annual_percentage_rate","payments_per_year","term_months","first_payment_date","last_payment_date","payment_type","calculation_method","current_monthly_payment_amount","loan_events"],"title":"ExternalDebtSchema"},"ExternalFinModelRunDirectInputSchema":{"properties":{"key":{"type":"string","title":"Key","description":"Input key matching the template direct input definition."},"name":{"type":"string","title":"Name","description":"Display name of the direct input."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description."},"value_data_type":{"anyOf":[{"$ref":"#/components/schemas/ValueDataType"},{"type":"null"}],"description":"null for a number or text, `money` for an amount with its currency, `boolean` for yes/no."},"value":{"$ref":"#/components/schemas/DirectInputValue-Output","description":"The value provided for this input, as supplied: a Money value keeps the currency it was entered in. Null means it was left out."}},"type":"object","required":["key","name"],"title":"ExternalFinModelRunDirectInputSchema","description":"A direct input value bound to a run."},"ExternalFinModelRunInputDetailSchema":{"properties":{"statement_inputs":{"items":{"$ref":"#/components/schemas/ExternalFinModelRunStmtInputSchema"},"type":"array","title":"Statement Inputs","description":"Statement-based inputs bound to the run.","default":[]},"direct_inputs":{"items":{"$ref":"#/components/schemas/ExternalFinModelRunDirectInputSchema"},"type":"array","title":"Direct Inputs","description":"Direct inputs bound to the run.","default":[]}},"type":"object","title":"ExternalFinModelRunInputDetailSchema","description":"All inputs bound to a run."},"ExternalFinModelRunModelSchema":{"properties":{"key":{"type":"string","title":"Key","description":"Template key."},"name":{"type":"string","title":"Name","description":"Template name."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Template description."},"version":{"type":"integer","title":"Version","description":"Template version used for this run."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When this template version was created."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When this template version was last updated."}},"type":"object","required":["key","name","version","created_at","updated_at"],"title":"ExternalFinModelRunModelSchema","description":"Simplified template info attached to a run (no grid or template-level I/O definitions)."},"ExternalFinModelRunResultListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ExternalFinModelRunResultOverviewSchema"},"type":"array","title":"Items","description":"List of matching completed run results.","default":[]},"total":{"type":"integer","title":"Total","description":"Total number of matching results."},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Offset to pass for the next page. Null when there are no more results."}},"type":"object","required":["total"],"title":"ExternalFinModelRunResultListResponse","description":"Paginated response for external financial model result queries."},"ExternalFinModelRunResultOverviewSchema":{"properties":{"fin_model_run_id":{"type":"string","title":"Fin Model Run Id","description":"Unique identifier of the run."},"name":{"type":"string","title":"Name","description":"Display name of the run."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description."},"status":{"$ref":"#/components/schemas/FinModelRunStatus","description":"Current status of the run (e.g. draft, running, completed, failed)."},"fin_model_template_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Model Template Key","description":"Key of the template this run is based on."},"fin_model_template_version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fin Model Template Version","description":"Version of the template used."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the run was created."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when the run was last updated."},"entity_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Id","description":"Entity ID linked to this run."},"entity_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity External Id","description":"External ID of the linked entity."},"outputs":{"items":{"$ref":"#/components/schemas/FinModelRunOutputSchema"},"type":"array","title":"Outputs","description":"Computed output values.","default":[]}},"type":"object","required":["fin_model_run_id","name","status","created_at","updated_at"],"title":"ExternalFinModelRunResultOverviewSchema","description":"External run overview with computed outputs for result queries."},"ExternalFinModelRunSchema":{"properties":{"fin_model_run_id":{"type":"string","title":"Fin Model Run Id","description":"Unique identifier of the run."},"name":{"type":"string","title":"Name","description":"Display name of the run."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description."},"status":{"$ref":"#/components/schemas/FinModelRunStatus","description":"Current status of the run."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the run was created."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"When the run was last updated."},"model":{"$ref":"#/components/schemas/ExternalFinModelRunModelSchema","description":"Template information for this run."},"inputs":{"$ref":"#/components/schemas/ExternalFinModelRunInputDetailSchema","description":"Inputs bound to this run."},"outputs":{"items":{"$ref":"#/components/schemas/FinModelRunOutputSchema"},"type":"array","title":"Outputs","description":"Computed output values after execution.","default":[]}},"type":"object","required":["fin_model_run_id","name","status","created_at","updated_at","model","inputs"],"title":"ExternalFinModelRunSchema","description":"Full detail of a financial model run for external consumers."},"ExternalFinModelRunStmtInputSchema":{"properties":{"key":{"type":"string","title":"Key","description":"Input key matching the template input definition."},"name":{"type":"string","title":"Name","description":"Display name of the input."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description."},"statement_id":{"type":"string","title":"Statement Id","description":"ID of the bound financial statement."}},"type":"object","required":["key","name","statement_id"],"title":"ExternalFinModelRunStmtInputSchema","description":"A statement input bound to a run (without full statement data)."},"ExternalPersonalDebtCreationSchema":{"properties":{"customer_id":{"type":"string","maxLength":255,"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Asset Id"},"external_debt_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Debt Id"},"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"name":{"type":"string","maxLength":255,"title":"Name"},"coa_account_key":{"type":"string","enum":["home_mortgage_rent","second_home_mortgage_rent","real_estate_taxes_fire_insurance","installment_debt","revolving_credit","debt_on_schedule_c","debt_on_schedule_e","debt_on_schedule_f","other_debt_payments","refinanced_debt"],"title":"Coa Account Key"},"lender_name":{"type":"string","maxLength":255,"title":"Lender Name"},"loan_amount":{"type":"number","title":"Loan Amount"},"initial_event":{"$ref":"#/components/schemas/DebtLoanInitialEventCreationSchema"},"additional_events":{"anyOf":[{"items":{"$ref":"#/components/schemas/DebtLoanAdditionalEventCreationSchema"},"type":"array"},{"type":"null"}],"title":"Additional Events"},"termination_event":{"anyOf":[{"$ref":"#/components/schemas/DebtLoanTerminationEventCreationSchema"},{"type":"null"}]}},"type":"object","required":["customer_id","idempotency_key","name","coa_account_key","lender_name","loan_amount","initial_event"],"title":"ExternalPersonalDebtCreationSchema"},"ExternalPersonalDebtUpdateSchema":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"name":{"type":"string","maxLength":255,"title":"Name"},"coa_account_key":{"type":"string","enum":["home_mortgage_rent","second_home_mortgage_rent","real_estate_taxes_fire_insurance","installment_debt","revolving_credit","debt_on_schedule_c","debt_on_schedule_e","debt_on_schedule_f","other_debt_payments","refinanced_debt"],"title":"Coa Account Key"},"lender_name":{"type":"string","maxLength":255,"title":"Lender Name"},"loan_amount":{"type":"number","title":"Loan Amount"},"asset_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Asset Id"},"external_debt_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Debt Id"}},"type":"object","required":["idempotency_key","name","coa_account_key","lender_name","loan_amount"],"title":"ExternalPersonalDebtUpdateSchema"},"ExternalSyncInfo":{"properties":{"salesforce_case_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Salesforce Case Id"}},"type":"object","title":"ExternalSyncInfo"},"FinCustomerDocProcessingStatusType":{"type":"string","enum":["pending","processing","processed","error"],"title":"FinCustomerDocProcessingStatusType"},"FinCustomerDocumentType":{"type":"string","enum":["audited_financial_statements","unaudited_financial_statements","us_tax_document_1120","us_tax_document_1120s","us_tax_document_1065","us_tax_document_1120c","us_tax_document_1040","us_tax_document_990","bank_statement","other","sec_filings","rent_roll","personal_financial_statements","revenue_projection","debt_schedule","credit_bureau_report","borrowing_base_certificate","compliance_certificate","competitor_statement","brokerage_statement","appraisal","insurance_certificate","lease_agreement","property_tax_bill","environmental_report","title_report","ar_aging_report","ap_aging_report","inventory_report","schedule_of_real_estate_owned","loan_agreement","promissory_note","term_sheet","commitment_letter","loan_application","guaranty","credit_application","personal_credit_authorization","operating_agreement","articles_of_incorporation","bylaws","regulatory_license","drivers_license","passport","ein_letter","organizational_chart","ownership_structure","proof_of_address"],"title":"FinCustomerDocumentType","description":"Granular leaf of the 2-layer doc catalog. Each value maps to a\nDocumentCategory via CATEGORY_BY_DOC_TYPE below. Stored as String on\nFinCustomerDoc so we can grow this vocab without a PG ENUM ALTER.\n\nW-2 / 1099 / Schedule K-1 supplements are intentionally NOT separate\nleaves -- triage classifies them under their parent return."},"FinModelRunBankInputBindingRequest":{"properties":{"input_key":{"type":"string","title":"Input Key","description":"Key of the template bank input to bind."},"entity_id":{"type":"string","title":"Entity Id","description":"Entity whose bank data to aggregate."},"start_period":{"type":"string","format":"date","title":"Start Period","description":"Inclusive start of the aggregation window."},"end_period":{"type":"string","format":"date","title":"End Period","description":"Inclusive end of the aggregation window."}},"type":"object","required":["input_key","entity_id","start_period","end_period"],"title":"FinModelRunBankInputBindingRequest","description":"Bind an entity + date window to a template bank input slot.\n\nBank metrics will be aggregated over all of the entity's bank accounts\nwithin [start_period, end_period] and exposed via FM.BANK in formulas."},"FinModelRunDealInputBindingRequest":{"properties":{"input_key":{"type":"string","title":"Input Key","description":"Key of the template deal input to bind."},"deal_id":{"type":"string","title":"Deal Id","description":"ID of the deal to bind."}},"type":"object","required":["input_key","deal_id"],"title":"FinModelRunDealInputBindingRequest","description":"Bind a deal to a template deal input slot."},"FinModelRunDirectInputBindingRequest":{"properties":{"input_key":{"type":"string","title":"Input Key","description":"Key of the template direct input to bind."},"value":{"$ref":"#/components/schemas/DirectInputValue-Input","description":"The value to supply, matching the slot's type: a number or text for an untyped slot, `{amount, currency}` for a money slot, `true`/`false` for a boolean slot. Null leaves the input out."}},"type":"object","required":["input_key"],"title":"FinModelRunDirectInputBindingRequest","description":"Provide a value for a template direct input slot."},"FinModelRunInputBindingRequest":{"properties":{"input_key":{"type":"string","title":"Input Key","description":"Key of the template input to bind."},"statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Id","description":"ID of the financial statement to use as input. Mutually exclusive with scenario_period_id."},"scenario_period_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scenario Period Id","description":"ID of the cash-flow scenario period to use as input. Mutually exclusive with statement_id."}},"type":"object","required":["input_key"],"title":"FinModelRunInputBindingRequest","description":"Bind a statement or cash-flow scenario period to a template input slot. Exactly one of statement_id or scenario_period_id must be provided."},"FinModelRunListResponse":{"properties":{"runs":{"items":{"$ref":"#/components/schemas/FinModelRunOverviewSchema"},"type":"array","title":"Runs","description":"List of financial model run summaries."},"total":{"type":"integer","title":"Total","description":"Total number of runs matching the query."},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Offset to pass for the next page. Null when there are no more results."}},"type":"object","required":["runs","total"],"title":"FinModelRunListResponse","description":"Paginated list of financial model runs."},"FinModelRunLoanInputBindingRequest":{"properties":{"input_key":{"type":"string","title":"Input Key","description":"Key of the template loan input to bind."},"loan_id":{"type":"string","title":"Loan Id","description":"ID of the loan to bind."}},"type":"object","required":["input_key","loan_id"],"title":"FinModelRunLoanInputBindingRequest","description":"Bind a loan to a template loan input slot."},"FinModelRunOutputSchema":{"properties":{"key":{"type":"string","title":"Key","description":"Output key matching the template output definition."},"name":{"type":"string","title":"Name","description":"Display name of the output."},"sheet_name":{"type":"string","title":"Sheet Name","description":"Sheet containing the output cell."},"cell_ref":{"type":"string","title":"Cell Ref","description":"Cell reference (e.g. 'B10')."},"value_data_type":{"$ref":"#/components/schemas/ValueDataType","description":"Data type of the output value."},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount","description":"Numeric value, if the output is money, a decimal, or another number."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"ISO 4217 currency of `amount` when the output is money: the model version's currency. Null for every other type."},"str_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Str Value","description":"String value, if the output is text."},"bool_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bool Value","description":"Boolean value, if the output is a boolean."},"date_value":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date Value","description":"Date value, if the output is a date."}},"type":"object","required":["key","name","sheet_name","cell_ref","value_data_type"],"title":"FinModelRunOutputSchema","description":"A computed output value from an executed financial model run."},"FinModelRunOverviewSchema":{"properties":{"fin_model_run_id":{"type":"string","title":"Fin Model Run Id","description":"Unique identifier of the run."},"name":{"type":"string","title":"Name","description":"Display name of the run."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description."},"status":{"$ref":"#/components/schemas/FinModelRunStatus","description":"Current status of the run (e.g. draft, running, completed, failed)."},"fin_model_template_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Model Template Key","description":"Key of the template this run is based on."},"fin_model_template_version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fin Model Template Version","description":"Version of the template used."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the run was created."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when the run was last updated."}},"type":"object","required":["fin_model_run_id","name","status","created_at","updated_at"],"title":"FinModelRunOverviewSchema","description":"Summary of a financial model run (without full input/output detail)."},"FinModelRunStatus":{"type":"string","enum":["pending","running","completed","failed"],"title":"FinModelRunStatus"},"FinModelTemplateListResponse":{"properties":{"templates":{"items":{"$ref":"#/components/schemas/FinModelTemplateSchema"},"type":"array","title":"Templates","description":"List of financial model templates."},"total":{"type":"integer","title":"Total","description":"Total number of templates in the organization."},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Offset to pass for the next page. Null when there are no more results."}},"type":"object","required":["templates","total"],"title":"FinModelTemplateListResponse","description":"Paginated list of financial model templates."},"FinModelTemplateSchema":{"properties":{"key":{"type":"string","title":"Key","description":"Unique key identifying this template."},"org_id":{"type":"string","title":"Org Id","description":"Organization ID that owns this template."},"name":{"type":"string","title":"Name","description":"Display name of the template."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description of the template."},"usage":{"$ref":"#/components/schemas/FinModelTemplateUsage","description":"Who runs this model: `standalone` (people, the API, batches and calculators) or `workflow` (a policy's financial-model step; its versions lock once they have runs).","default":"standalone"},"default_version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Default Version","description":"The default version number used when no version is specified."},"versions":{"items":{"$ref":"#/components/schemas/VersionedFinModelTemplateSummary"},"type":"array","title":"Versions","description":"All available versions of this template.","default":[]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when the template was created."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when the template was last updated."}},"type":"object","required":["key","org_id","name","created_at","updated_at"],"title":"FinModelTemplateSchema","description":"A financial model template with its list of versions."},"FinModelTemplateUsage":{"type":"string","enum":["standalone","workflow"]},"FinReportImportFormat":{"type":"string","enum":["quickbooks_online","xero","zoho_books","freshbooks","generic"],"title":"FinReportImportFormat","description":"The route an import was posted to."},"FinReportImportReceipt":{"properties":{"import_id":{"type":"string","title":"Import Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"format":{"$ref":"#/components/schemas/FinReportImportFormat"},"accounting_basis":{"type":"string","enum":["accrual","cash"],"title":"Accounting Basis"},"source":{"type":"string","const":"import","title":"Source","default":"import"},"system":{"type":"string","title":"System"},"api_source":{"$ref":"#/components/schemas/ApiSource"},"payload_sha256":{"type":"string","title":"Payload Sha256"},"link_connection_id":{"type":"string","title":"Link Connection Id"},"reports":{"items":{"$ref":"#/components/schemas/FinReportImportReportResult"},"type":"array","title":"Reports"},"reports_created":{"type":"integer","title":"Reports Created"},"reports_replaced":{"type":"integer","title":"Reports Replaced"},"reports_unchanged":{"type":"integer","title":"Reports Unchanged"},"accounts_unmatched":{"type":"integer","title":"Accounts Unmatched"},"accepted_at":{"type":"string","format":"date-time","title":"Accepted At"},"deduplicated":{"type":"boolean","title":"Deduplicated","default":false}},"type":"object","required":["import_id","idempotency_key","customer_id","format","accounting_basis","system","api_source","payload_sha256","link_connection_id","reports","reports_created","reports_replaced","reports_unchanged","accounts_unmatched","accepted_at"],"title":"FinReportImportReceipt"},"FinReportImportReportResult":{"properties":{"report_id":{"type":"string","title":"Report Id"},"statement_type":{"type":"string","enum":["balance_sheet","income_statement"],"title":"Statement Type"},"start_period":{"type":"string","format":"date","title":"Start Period"},"end_period":{"type":"string","format":"date","title":"End Period"},"currency":{"type":"string","title":"Currency"},"content_sha256":{"type":"string","title":"Content Sha256"},"result":{"type":"string","enum":["created","replaced","unchanged"],"title":"Result"}},"type":"object","required":["report_id","statement_type","start_period","end_period","currency","content_sha256","result"],"title":"FinReportImportReportResult"},"FinReportListItem":{"properties":{"report_id":{"type":"string","title":"Report Id"},"statement_type":{"type":"string","enum":["balance_sheet","income_statement"],"title":"Statement Type"},"start_period":{"type":"string","format":"date","title":"Start Period"},"end_period":{"type":"string","format":"date","title":"End Period"},"currency":{"type":"string","title":"Currency"},"accounting_basis":{"anyOf":[{"type":"string","enum":["accrual","cash"]},{"type":"null"}],"title":"Accounting Basis"},"source":{"type":"string","enum":["import","link"],"title":"Source"},"system":{"type":"string","title":"System"},"api_source":{"anyOf":[{"$ref":"#/components/schemas/ApiSource"},{"type":"null"}]},"content_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Sha256"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"rows":{"anyOf":[{"items":{"$ref":"#/components/schemas/FinReportRow"},"type":"array"},{"type":"null"}],"title":"Rows"}},"type":"object","required":["report_id","statement_type","start_period","end_period","currency","source","system","updated_at"],"title":"FinReportListItem"},"FinReportRow":{"properties":{"particular":{"type":"string","title":"Particular"},"amount":{"type":"number","title":"Amount"},"group_path":{"items":{"type":"string"},"type":"array","title":"Group Path"},"row_type":{"type":"string","enum":["transaction_line","calculated_line"],"title":"Row Type"},"account_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Type"}},"type":"object","required":["particular","amount","group_path","row_type"],"title":"FinReportRow"},"FinStmtSpreadCalendarYearPeriod":{"properties":{"id":{"type":"string","title":"Id"},"year":{"type":"integer","maximum":9000.0,"minimum":1000.0,"title":"Year"},"period":{"$ref":"#/components/schemas/MonthType"}},"type":"object","required":["year","period"],"title":"FinStmtSpreadCalendarYearPeriod"},"FinStmtSpreadFiscalYTDPeriod":{"properties":{"id":{"type":"string","title":"Id"},"fiscal_year":{"type":"integer","maximum":9000.0,"minimum":1000.0,"title":"Fiscal Year"}},"type":"object","required":["fiscal_year"],"title":"FinStmtSpreadFiscalYTDPeriod"},"FinStmtSpreadFiscalYearPeriod":{"properties":{"id":{"type":"string","title":"Id"},"fiscal_year":{"type":"integer","maximum":9000.0,"minimum":1000.0,"title":"Fiscal Year"},"period":{"$ref":"#/components/schemas/FiscalPeriodType"}},"type":"object","required":["fiscal_year","period"],"title":"FinStmtSpreadFiscalYearPeriod"},"FinStmtSpreadPrecisePeriod":{"properties":{"id":{"type":"string","title":"Id"},"start_year":{"type":"integer","maximum":9999.0,"minimum":1.0,"title":"Start Year"},"start_month":{"$ref":"#/components/schemas/MonthType"},"end_year":{"type":"integer","maximum":9999.0,"minimum":1.0,"title":"End Year"},"end_month":{"$ref":"#/components/schemas/MonthType"}},"type":"object","required":["start_year","start_month","end_year","end_month"],"title":"FinStmtSpreadPrecisePeriod"},"FinStmtSpreadTrailingPeriod":{"properties":{"id":{"type":"string","title":"Id"},"trailing_months":{"type":"integer","maximum":1200.0,"minimum":1.0,"title":"Trailing Months"}},"type":"object","required":["trailing_months"],"title":"FinStmtSpreadTrailingPeriod"},"FinStmtSpreadingCaseDetailsResponse-Input":{"properties":{"case_id":{"type":"string","title":"Case Id","description":"Case ID in our system"},"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids","description":"List of document IDs for the case"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id","description":"Asset ID in our system for the asset the case belongs to"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"external customer id for the customer the case belongs to"},"case_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Case Name","description":"Case name"},"case_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Priority","description":"Case priority"},"case_status":{"type":"string","enum":["pending","processing","waiting_on_client","completed","cancelled","waiting_on_end_customer"],"title":"Case Status","description":"Case status"},"review_type":{"anyOf":[{"type":"string","enum":["initiation","monthly","quarterly","semi_annually","annually","ad-hoc"]},{"type":"null"}],"title":"Review Type"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Case creation time"},"case_messages":{"anyOf":[{"items":{"$ref":"#/components/schemas/FinStmtSpreadingCaseMessage"},"type":"array"},{"type":"null"}],"title":"Case Messages","description":"message to Accend's client about the case"},"case_results":{"anyOf":[{"$ref":"#/components/schemas/SpreadingCaseResultWithCoaSchema-Input"},{"type":"null"}],"description":"Case results data in JSON format"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CaseCreatorResponse"},{"type":"null"}],"description":"Who caused this case to be created -- the acting user, the organization integration token, or an automated process. This is NOT the assigned analyst. Null for cases created before this field existed, and for any actor we cannot identify."}},"type":"object","required":["case_id","document_ids","case_status","created_at"],"title":"FinStmtSpreadingCaseDetailsResponse"},"FinStmtSpreadingCaseDetailsResponse-Output":{"properties":{"case_id":{"type":"string","title":"Case Id","description":"Case ID in our system"},"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids","description":"List of document IDs for the case"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id","description":"Asset ID in our system for the asset the case belongs to"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"external customer id for the customer the case belongs to"},"case_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Case Name","description":"Case name"},"case_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Priority","description":"Case priority"},"case_status":{"type":"string","enum":["pending","processing","waiting_on_client","completed","cancelled","waiting_on_end_customer"],"title":"Case Status","description":"Case status"},"review_type":{"anyOf":[{"type":"string","enum":["initiation","monthly","quarterly","semi_annually","annually","ad-hoc"]},{"type":"null"}],"title":"Review Type"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Case creation time"},"case_messages":{"anyOf":[{"items":{"$ref":"#/components/schemas/FinStmtSpreadingCaseMessage"},"type":"array"},{"type":"null"}],"title":"Case Messages","description":"message to Accend's client about the case"},"case_results":{"anyOf":[{"$ref":"#/components/schemas/SpreadingCaseResultWithCoaSchema-Output"},{"type":"null"}],"description":"Case results data in JSON format"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CaseCreatorResponse"},{"type":"null"}],"description":"Who caused this case to be created -- the acting user, the organization integration token, or an automated process. This is NOT the assigned analyst. Null for cases created before this field existed, and for any actor we cannot identify."}},"type":"object","required":["case_id","document_ids","case_status","created_at"],"title":"FinStmtSpreadingCaseDetailsResponse"},"FinStmtSpreadingCaseMessage":{"properties":{"message":{"type":"string","title":"Message","description":"Message to Accend's client about the case"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Message creation time in ISO format"},"rejected_reasons":{"items":{"$ref":"#/components/schemas/FinStmtSpreadingCaseRejectedReason"},"type":"array","title":"Rejected Reasons","description":"List of reasons for rejection"}},"type":"object","required":["message","created_at","rejected_reasons"],"title":"FinStmtSpreadingCaseMessage"},"FinStmtSpreadingCaseOverviewResponse":{"properties":{"case_id":{"type":"string","title":"Case Id","description":"Case ID in our system"},"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids","description":"List of document IDs for the case"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"external customer id for the customer the case belongs to"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id","description":"Asset ID in our system for the asset the case belongs to"},"case_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Case Name","description":"Case name"},"case_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Priority","description":"Case priority"},"prepare_by":{"$ref":"#/components/schemas/UnderwritingCasePrepareBy","title":"Prepare by","default":"accend"},"case_status":{"type":"string","enum":["pending","processing","waiting_on_client","completed","cancelled","waiting_on_end_customer"],"title":"Case Status","description":"Case status"},"review_type":{"anyOf":[{"type":"string","enum":["initiation","monthly","quarterly","semi_annually","annually","ad-hoc"]},{"type":"null"}],"title":"Review Type"},"spreading_request":{"anyOf":[{"$ref":"#/components/schemas/CaseSpreadingRequest"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Case creation time in ISO format"},"created_by":{"anyOf":[{"$ref":"#/components/schemas/CaseCreatorResponse"},{"type":"null"}],"description":"Who caused this case to be created -- the acting user, the organization integration token, or an automated process. This is NOT the assigned analyst. Null for cases created before this field existed, and for any actor we cannot identify."}},"type":"object","required":["case_id","document_ids","customer_id","case_status","created_at"],"title":"FinStmtSpreadingCaseOverviewResponse"},"FinStmtSpreadingCaseRejectedReason":{"properties":{"description":{"type":"string","title":"Description","description":"Reason for rejection"},"reason_type":{"type":"string","title":"Reason Type","description":"Type of rejection"},"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id","description":"Document ID in our system"}},"type":"object","required":["description","reason_type"],"title":"FinStmtSpreadingCaseRejectedReason"},"FinStmtSpreadingCasesResponse":{"properties":{"cases":{"items":{"$ref":"#/components/schemas/FinStmtSpreadingCaseOverviewResponse"},"type":"array","title":"Cases","description":"List of financial statement spreading cases"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Next offset for pagination"},"total":{"type":"integer","title":"Total","description":"Total number of cases"}},"type":"object","required":["cases","total"],"title":"FinStmtSpreadingCasesResponse"},"FinTemplateEntityType":{"type":"string","enum":["individual","business","property","other"],"title":"FinTemplateEntityType"},"FinTmplAccountCalculationType":{"type":"string","enum":["financial","operating","other"],"title":"FinTmplAccountCalculationType"},"FinTmplAccountOriginType":{"type":"string","enum":["primitive","calculated","primitive_or_calculated"],"title":"FinTmplAccountOriginType"},"FinTmplAccountRollingStmtCalculationType":{"type":"string","enum":["as_aggregated","as_period_end","as_period_start","as_unset","as_calculated"],"title":"FinTmplAccountRollingStmtCalculationType"},"FinTmplOverviewResponse":{"properties":{"fin_tmpl_key":{"type":"string","title":"Fin Tmpl Key"},"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Id"}},"type":"object","required":["fin_tmpl_key","key","name"],"title":"FinTmplOverviewResponse"},"FinancialDataImports":{"properties":{"financial_statements":{"anyOf":[{"$ref":"#/components/schemas/FinancialStatementImports"},{"type":"null"}]}},"type":"object","title":"FinancialDataImports"},"FinancialDataImportsFromSourceM":{"properties":{"reporting_start_date":{"type":"string","format":"date-time","title":"Reporting Start Date","description":"The start date of the period, date in isoformat"},"reporting_end_date":{"type":"string","format":"date-time","title":"Reporting End Date","description":"The end date of the period, date in isoformat"},"period_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Type"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}],"description":"The type of data"},"line_items":{"$ref":"#/components/schemas/SourceMLineItemsSchema","description":"The line items of the financial data"}},"type":"object","required":["reporting_start_date","reporting_end_date","line_items"],"title":"FinancialDataImportsFromSourceM"},"FinancialDataImportsRequest":{"properties":{"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"data_imports":{"$ref":"#/components/schemas/FinancialDataImports"}},"type":"object","required":["customer_id","data_imports"],"title":"FinancialDataImportsRequest"},"FinancialDataImportsRequestExt":{"properties":{"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"external customer id for the customer"},"data_imports":{"$ref":"#/components/schemas/FinancialDataImports"}},"type":"object","required":["external_customer_id","data_imports"],"title":"FinancialDataImportsRequestExt"},"FinancialDocMetadataResponse":{"properties":{"document_id":{"type":"string","title":"Document Id","description":"Document ID in our system"},"idempotency_key":{"type":"string","title":"Idempotency Key","description":"Idempotency key for the document (max 255 characters)"},"file_name":{"type":"string","title":"File Name","description":"As-uploaded file name of the document"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type","description":"Original content type (MIME) of the uploaded file"},"document_category":{"anyOf":[{"type":"string","enum":["financial_statement","tax_return","legal","identity","collateral","credit","loan_doc","other"]},{"type":"null"}],"description":"Top-level document category"},"document_type":{"anyOf":[{"type":"string","enum":["audited_financial_statements","unaudited_financial_statements","us_tax_document_1120","us_tax_document_1120s","us_tax_document_1065","us_tax_document_1120c","us_tax_document_1040","us_tax_document_990","bank_statement","other","sec_filings","rent_roll","personal_financial_statements","revenue_projection","debt_schedule","credit_bureau_report","borrowing_base_certificate","compliance_certificate","competitor_statement","brokerage_statement","appraisal","insurance_certificate","lease_agreement","property_tax_bill","environmental_report","title_report","ar_aging_report","ap_aging_report","inventory_report","schedule_of_real_estate_owned","loan_agreement","promissory_note","term_sheet","commitment_letter","loan_application","guaranty","credit_application","personal_credit_authorization","operating_agreement","articles_of_incorporation","bylaws","regulatory_license","drivers_license","passport","ein_letter","organizational_chart","ownership_structure","proof_of_address"]},{"type":"null"}],"description":"Granular document type"},"process_status":{"anyOf":[{"$ref":"#/components/schemas/FinCustomerDocProcessingStatusType"},{"type":"null"}],"description":"Processing status of the document"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"When the document was uploaded"}},"type":"object","required":["document_id","idempotency_key","file_name","created_at"],"title":"FinancialDocMetadataResponse"},"FinancialDocsMetadataResponse":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/FinancialDocMetadataResponse"},"type":"array","title":"Documents","description":"List of document metadata"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Next offset for pagination"},"total":{"type":"integer","title":"Total","description":"Total number of documents"}},"type":"object","required":["documents","total"],"title":"FinancialDocsMetadataResponse"},"FinancialReviewTemplateBasedSpreadingRequest-Input":{"properties":{"fin_review_tmpl_id":{"$ref":"#/components/schemas/TemplateVersionedID","description":"Financial review template ID to be used for spreading. If no default template is available, spread would be best effort."},"most_recent_period":{"anyOf":[{"$ref":"#/components/schemas/FinStmtSpreadCalendarYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYearPeriod"},{"type":"null"}],"title":"Most Recent Period","description":"Most recent period included in the request that overwrites the value in the template. This is used for TTM and YTD calculations. If not provided, the most recent period will be calculated based on the current UTC date and most_recent_period_offset defined in the template."}},"type":"object","required":["fin_review_tmpl_id"],"title":"FinancialReviewTemplateBasedSpreadingRequest"},"FinancialReviewTemplateBasedSpreadingRequest-Output":{"properties":{"fin_review_tmpl_id":{"$ref":"#/components/schemas/TemplateVersionedID","description":"Financial review template ID to be used for spreading. If no default template is available, spread would be best effort."},"most_recent_period":{"anyOf":[{"$ref":"#/components/schemas/FinStmtSpreadCalendarYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYearPeriod"},{"type":"null"}],"title":"Most Recent Period","description":"Most recent period included in the request that overwrites the value in the template. This is used for TTM and YTD calculations. If not provided, the most recent period will be calculated based on the current UTC date and most_recent_period_offset defined in the template."}},"type":"object","required":["fin_review_tmpl_id"],"title":"FinancialReviewTemplateBasedSpreadingRequest"},"FinancialSignalsRequestOnCase":{"properties":{"case_id":{"type":"string","title":"Case Id","description":"Case ID in our system for the case the financial signals belongs to"},"validations":{"anyOf":[{"$ref":"#/components/schemas/FinancialSignalsRequestValidationEngineConfig"},{"type":"null"}],"description":"Validation config for the financial signals","default":{"config":{"impairment_without_impairable_assets":{"primary":{"enable":true}},"minimal_accounts_payable":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_accounts_receivable":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_amortization":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_depreciation":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_interest_expense":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"negative_and_zero_cash":{"primary":{"enable":true}},"negative_and_zero_revenue":{"primary":{"enable":true}},"reconciliation_discrepancy":{"secondary":{"threshold":0.1}},"unexpected_negative_balance_sheet_items":{"secondary":{"enable":true}}}}}},"type":"object","required":["case_id"],"title":"FinancialSignalsRequestOnCase"},"FinancialSignalsRequestOnStatements":{"properties":{"statement_ids":{"items":{"type":"string"},"type":"array","title":"Statement Ids","description":"List of COA statement IDs in our system belongs to the same customer"},"validations":{"anyOf":[{"$ref":"#/components/schemas/FinancialSignalsRequestValidationEngineConfig"},{"type":"null"}],"description":"Validation config for the financial signals","default":{"config":{"impairment_without_impairable_assets":{"primary":{"enable":true}},"minimal_accounts_payable":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_accounts_receivable":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_amortization":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_depreciation":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_interest_expense":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"negative_and_zero_cash":{"primary":{"enable":true}},"negative_and_zero_revenue":{"primary":{"enable":true}},"reconciliation_discrepancy":{"secondary":{"threshold":0.1}},"unexpected_negative_balance_sheet_items":{"secondary":{"enable":true}}}}}},"type":"object","required":["statement_ids"],"title":"FinancialSignalsRequestOnStatements"},"FinancialSignalsRequestValidationEngineConfig":{"properties":{"config":{"anyOf":[{"$ref":"#/components/schemas/ValidationEngineConfig"},{"type":"null"}],"description":"Validation config for the financial signals","default":{"minimal_interest_expense":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_depreciation":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_amortization":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"impairment_without_impairable_assets":{"primary":{"enable":true}},"minimal_accounts_receivable":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"minimal_accounts_payable":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}},"reconciliation_discrepancy":{"secondary":{"threshold":0.1}},"negative_and_zero_revenue":{"primary":{"enable":true}},"unexpected_negative_balance_sheet_items":{"secondary":{"enable":true}},"negative_and_zero_cash":{"primary":{"enable":true}}}}},"type":"object","title":"FinancialSignalsRequestValidationEngineConfig"},"FinancialStatementImports":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/IncomeStatementImport"},"type":"array","title":"Income Statements","description":"\nThe income statement import schema\nAll the total line items are calculated from the line items through summation.\nThere is no subtraction in the total line item calculation.\nFor example, gross profit = total operating revenue + cost of goods sold.\nTherefore, expenses(including cost of goods sold) line items usually have negative amounts.\n","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/BalanceSheetImport"},"type":"array","title":"Balance Sheets","description":"\nThe balance sheet import schema\nAll the total line items are calculated from the line items through summation.\nThere is no subtraction in the total line item calculation.\nFor example, total assets = current assets + non-current assets.\n","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/CashFlowStatementImport"},"type":"array","title":"Cash Flow Statements","description":"\nThe cash flow statement import schema\nAll the total line items are calculated from the line items through summation.\nThere is no subtraction in the total line item calculation.\n","default":[]}},"type":"object","title":"FinancialStatementImports"},"FinancialTemplateAccount":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"fin_tmpl_account_class_key":{"type":"string","title":"Fin Tmpl Account Class Key"},"fin_tmpl_account_type_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Tmpl Account Type Key"},"fin_tmpl_account_flow_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Tmpl Account Flow Key"},"prompt_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"sort_order":{"type":"integer","title":"Sort Order"},"should_flip_sign_from_source":{"type":"boolean","title":"Should Flip Sign From Source"},"calculation_type":{"$ref":"#/components/schemas/FinTmplAccountCalculationType"},"origin_type":{"$ref":"#/components/schemas/FinTmplAccountOriginType"},"rolling_stmt_calculation_type":{"$ref":"#/components/schemas/FinTmplAccountRollingStmtCalculationType"},"formula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Formula"},"value_data_type":{"$ref":"#/components/schemas/ValueDataType"}},"type":"object","required":["key","name","fin_tmpl_account_class_key","fin_tmpl_account_type_key","fin_tmpl_account_flow_key","prompt_name","description","sort_order","should_flip_sign_from_source","calculation_type","origin_type","rolling_stmt_calculation_type","formula","value_data_type"],"title":"FinancialTemplateAccount"},"FinancialTemplateClass":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"statement_type":{"anyOf":[{"$ref":"#/components/schemas/StatementType"},{"type":"null"}]},"sort_order":{"type":"integer","title":"Sort Order"}},"type":"object","required":["key","name","statement_type","sort_order"],"title":"FinancialTemplateClass"},"FinancialTemplateGroupings":{"properties":{"account_classes":{"items":{"$ref":"#/components/schemas/AccountTypeGroupingSchema"},"type":"array","title":"Account Classes"},"account_types":{"items":{"$ref":"#/components/schemas/AccountTypeGroupingSchema"},"type":"array","title":"Account Types"},"account_flows":{"items":{"$ref":"#/components/schemas/AccountGroupingSchema"},"type":"array","title":"Account Flows"},"class_groups":{"items":{"$ref":"#/components/schemas/ClassGroupingSchema"},"type":"array","title":"Class Groups"},"statement_classes":{"items":{"$ref":"#/components/schemas/StatementClassGroupingSchema"},"type":"array","title":"Statement Classes"}},"type":"object","required":["account_classes","account_types","account_flows","class_groups","statement_classes"],"title":"FinancialTemplateGroupings"},"FinancialTemplateResponse":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Id"},"entity_type":{"$ref":"#/components/schemas/FinTemplateEntityType"},"accounts":{"items":{"$ref":"#/components/schemas/FinancialTemplateAccount"},"type":"array","title":"Accounts"},"classes":{"items":{"$ref":"#/components/schemas/FinancialTemplateClass"},"type":"array","title":"Classes"},"source_key_total_account_keys":{"items":{"type":"string"},"type":"array","title":"Source Key Total Account Keys"},"groupings":{"$ref":"#/components/schemas/FinancialTemplateGroupings"}},"type":"object","required":["key","name","description","org_id","entity_type","accounts","classes","groupings"],"title":"FinancialTemplateResponse"},"FiscalPeriodType":{"type":"string","enum":["q1","q2","q3","q4","h1","h2","fy"],"title":"FiscalPeriodType"},"FlaggedDocumentRequest":{"properties":{"doc_id":{"type":"string","title":"Doc Id","description":"The document id for the document that is flagged and re-request from the client."},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"The internal notes set to the flagged document."},"notes_to_client":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes To Client","description":"The detailed notes to the client, explaining why this document is requested"}},"type":"object","required":["doc_id"],"title":"FlaggedDocumentRequest"},"FreshBooksImportRequest":{"properties":{"customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"},"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"api_source":{"$ref":"#/components/schemas/ApiSource"},"accounting_basis":{"type":"string","enum":["accrual","cash"],"title":"Accounting Basis"},"reports":{"items":{"$ref":"#/components/schemas/ProviderReport"},"type":"array","maxItems":120,"minItems":1,"title":"Reports"}},"additionalProperties":false,"type":"object","required":["idempotency_key","api_source","accounting_basis","reports"],"title":"FreshBooksImportRequest"},"FulfillmentApiSource":{"properties":{"external_id":{"type":"string","title":"External Id"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"}},"type":"object","required":["external_id"],"title":"FulfillmentApiSource","description":"A partner's own id and name for an imported source."},"GenAnnualizedStatementsAssetRequest":{"properties":{"rolling_type":{"type":"string","const":"annualized","title":"Rolling Type","default":"annualized"},"base_statement_id":{"type":"string","title":"Base Statement Id","description":"Statement to use as the base for annualization. Its income/expense line items are scaled by (target period length / base period length)."},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type","description":"Period type to set on the resulting statement. If not provided, defaults to 'Rolling Stmt'."},"start_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_START) are copied into the result as the opening snapshot. If not provided, the system finds the closest statement to start_period automatically."},"end_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_END) are copied into the result as the closing snapshot. If not provided, the system finds the closest statement to end_period automatically; if still not found, base_statement is used."},"anchor_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To Statement Id"},"compare_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To Statement Id"},"asset_id":{"type":"string","title":"Asset Id"}},"type":"object","required":["base_statement_id","start_period","end_period","asset_id"],"title":"GenAnnualizedStatementsAssetRequest"},"GenAnnualizedStatementsRequest":{"properties":{"rolling_type":{"type":"string","const":"annualized","title":"Rolling Type","default":"annualized"},"base_statement_id":{"type":"string","title":"Base Statement Id","description":"Statement to use as the base for annualization. Its income/expense line items are scaled by (target period length / base period length)."},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type","description":"Period type to set on the resulting statement. If not provided, defaults to 'Rolling Stmt'."},"start_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_START) are copied into the result as the opening snapshot. If not provided, the system finds the closest statement to start_period automatically."},"end_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_END) are copied into the result as the closing snapshot. If not provided, the system finds the closest statement to end_period automatically; if still not found, base_statement is used."},"anchor_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To Statement Id"},"compare_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To Statement Id"},"customer_id":{"type":"string","title":"Customer Id"}},"type":"object","required":["base_statement_id","start_period","end_period","customer_id"],"title":"GenAnnualizedStatementsRequest"},"GenAnnualizedStatementsRequestExt":{"properties":{"rolling_type":{"type":"string","const":"annualized","title":"Rolling Type","default":"annualized"},"base_statement_id":{"type":"string","title":"Base Statement Id","description":"Statement to use as the base for annualization. Its income/expense line items are scaled by (target period length / base period length)."},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type","description":"Period type to set on the resulting statement. If not provided, defaults to 'Rolling Stmt'."},"start_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_START) are copied into the result as the opening snapshot. If not provided, the system finds the closest statement to start_period automatically."},"end_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_END) are copied into the result as the closing snapshot. If not provided, the system finds the closest statement to end_period automatically; if still not found, base_statement is used."},"anchor_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To Statement Id"},"compare_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To Statement Id"},"external_customer_id":{"type":"string","title":"External Customer Id"}},"type":"object","required":["base_statement_id","start_period","end_period","external_customer_id"],"title":"GenAnnualizedStatementsRequestExt"},"GenRollingStatementsAssetRequest":{"properties":{"rolling_type":{"type":"string","const":"rolling","title":"Rolling Type","default":"rolling"},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"aggregate_statement_ids":{"items":{"type":"string"},"type":"array","title":"Aggregate Statement Ids","description":"Statements whose income/expense line items (AS_AGGREGATED accounts) are summed together to form the rolling total."},"subtract_statement_ids":{"items":{"type":"string"},"type":"array","title":"Subtract Statement Ids","description":"Statements whose income/expense line items (AS_AGGREGATED accounts) are subtracted from the rolling total. Use this to remove an overlapping period when building a trailing-twelve-month view."},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type","description":"Period type to set on the resulting statement. If not provided, defaults to 'Rolling Stmt'."},"start_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_START) are copied into the result as the opening snapshot. If not provided, the system finds the closest statement to start_period automatically."},"end_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_END) are copied into the result as the closing snapshot. If not provided, the system finds the closest statement to end_period automatically."},"anchor_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To Statement Id"},"compare_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To Statement Id"},"asset_id":{"type":"string","title":"Asset Id"}},"type":"object","required":["start_period","end_period","asset_id"],"title":"GenRollingStatementsAssetRequest"},"GenRollingStatementsRequest":{"properties":{"rolling_type":{"type":"string","const":"rolling","title":"Rolling Type","default":"rolling"},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"aggregate_statement_ids":{"items":{"type":"string"},"type":"array","title":"Aggregate Statement Ids","description":"Statements whose income/expense line items (AS_AGGREGATED accounts) are summed together to form the rolling total."},"subtract_statement_ids":{"items":{"type":"string"},"type":"array","title":"Subtract Statement Ids","description":"Statements whose income/expense line items (AS_AGGREGATED accounts) are subtracted from the rolling total. Use this to remove an overlapping period when building a trailing-twelve-month view."},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type","description":"Period type to set on the resulting statement. If not provided, defaults to 'Rolling Stmt'."},"start_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_START) are copied into the result as the opening snapshot. If not provided, the system finds the closest statement to start_period automatically."},"end_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_END) are copied into the result as the closing snapshot. If not provided, the system finds the closest statement to end_period automatically."},"anchor_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To Statement Id"},"compare_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To Statement Id"},"customer_id":{"type":"string","title":"Customer Id"}},"type":"object","required":["start_period","end_period","customer_id"],"title":"GenRollingStatementsRequest"},"GenRollingStatementsRequestExt":{"properties":{"rolling_type":{"type":"string","const":"rolling","title":"Rolling Type","default":"rolling"},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"},"aggregate_statement_ids":{"items":{"type":"string"},"type":"array","title":"Aggregate Statement Ids","description":"Statements whose income/expense line items (AS_AGGREGATED accounts) are summed together to form the rolling total."},"subtract_statement_ids":{"items":{"type":"string"},"type":"array","title":"Subtract Statement Ids","description":"Statements whose income/expense line items (AS_AGGREGATED accounts) are subtracted from the rolling total. Use this to remove an overlapping period when building a trailing-twelve-month view."},"period_type":{"anyOf":[{"type":"string","enum":["Monthly","Quarterly","Semi-Annual","Annual","YTD","Rolling Stmt"]},{"type":"null"}],"title":"Period Type","description":"Period type to set on the resulting statement. If not provided, defaults to 'Rolling Stmt'."},"start_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_START) are copied into the result as the opening snapshot. If not provided, the system finds the closest statement to start_period automatically."},"end_period_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Period Statement Id","description":"Statement whose balance-sheet / point-in-time accounts (AS_PERIOD_END) are copied into the result as the closing snapshot. If not provided, the system finds the closest statement to end_period automatically."},"anchor_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Anchor To Statement Id"},"compare_to_statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compare To Statement Id"},"external_customer_id":{"type":"string","title":"External Customer Id"}},"type":"object","required":["start_period","end_period","external_customer_id"],"title":"GenRollingStatementsRequestExt"},"GenericAccount":{"properties":{"account_id":{"type":"string","maxLength":128,"minLength":1,"title":"Account Id","description":"Your id for the account."},"bank_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Bank Name"},"account_number_last4":{"anyOf":[{"type":"string","maxLength":4},{"type":"null"}],"title":"Account Number Last4"},"account_holder_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Account Holder Name"},"account_type":{"anyOf":[{"$ref":"#/components/schemas/BankAccountType"},{"type":"null"}],"description":"Omit when unknown. An account without a type never counts as cash."},"account_subtype":{"anyOf":[{"$ref":"#/components/schemas/BankAccountSubtype"},{"type":"null"}]},"currency":{"type":"string","title":"Currency","default":"USD"}},"additionalProperties":false,"type":"object","required":["account_id"],"title":"GenericAccount"},"GenericBatchRequest":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/GenericAccount"},"type":"array","minItems":1,"title":"Accounts"},"transactions":{"items":{"$ref":"#/components/schemas/GenericTransaction"},"type":"array","title":"Transactions"},"removed":{"items":{"$ref":"#/components/schemas/GenericRemoval"},"type":"array","title":"Removed"}},"additionalProperties":false,"type":"object","required":["accounts"],"title":"GenericBatchRequest"},"GenericImportRequest":{"properties":{"customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"},"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"api_source":{"$ref":"#/components/schemas/ApiSource"},"system":{"type":"string","maxLength":64,"minLength":1,"title":"System","description":"The ERP, for example sage_intacct"},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency"},"accounting_basis":{"type":"string","enum":["accrual","cash"],"title":"Accounting Basis"},"reports":{"items":{"$ref":"#/components/schemas/GenericReport"},"type":"array","maxItems":120,"minItems":1,"title":"Reports"}},"additionalProperties":false,"type":"object","required":["idempotency_key","api_source","system","currency","accounting_basis","reports"],"title":"GenericImportRequest"},"GenericRemoval":{"properties":{"account_id":{"type":"string","maxLength":128,"minLength":1,"title":"Account Id"},"txn_id":{"type":"string","maxLength":128,"minLength":1,"title":"Txn Id"}},"additionalProperties":false,"type":"object","required":["account_id","txn_id"],"title":"GenericRemoval"},"GenericReport":{"properties":{"statement_type":{"type":"string","enum":["balance_sheet","income_statement"],"title":"Statement Type"},"start_period":{"type":"string","format":"date","title":"Start Period"},"end_period":{"type":"string","format":"date","title":"End Period"},"rows":{"items":{"$ref":"#/components/schemas/GenericRow"},"type":"array","title":"Rows"}},"additionalProperties":false,"type":"object","required":["statement_type","start_period","end_period","rows"],"title":"GenericReport"},"GenericRow":{"properties":{"particular":{"type":"string","maxLength":255,"minLength":1,"title":"Particular"},"amount":{"type":"number","title":"Amount","description":"Debit positive, credit negative"},"account_type":{"type":"string","enum":["assets","liabilities","equity","income","expenses"],"title":"Account Type"},"group_path":{"items":{"type":"string"},"type":"array","maxItems":32,"title":"Group Path"},"row_type":{"type":"string","enum":["transaction_line","calculated_line"],"title":"Row Type","description":"Only accounts are accepted; a calculated_line is rejected","default":"transaction_line"}},"additionalProperties":false,"type":"object","required":["particular","amount","account_type"],"title":"GenericRow"},"GenericTransaction":{"properties":{"txn_id":{"type":"string","maxLength":128,"minLength":1,"title":"Txn Id","description":"Your id for the transaction, unique within its account. Re-sending it updates the transaction. Returned unchanged as `txn_id` on GET /banking/transactions."},"account_id":{"type":"string","maxLength":128,"minLength":1,"title":"Account Id"},"posted_date":{"type":"string","format":"date","title":"Posted Date"},"amount":{"type":"number","title":"Amount"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Must match the account's currency when given."},"description":{"type":"string","maxLength":2000,"minLength":1,"title":"Description"},"merchant_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Merchant Name"},"pending":{"type":"boolean","title":"Pending","default":false}},"additionalProperties":false,"type":"object","required":["txn_id","account_id","posted_date","amount","description"],"title":"GenericTransaction","description":"One transaction. `amount` is positive for money INTO the account."},"GetCasesResponse":{"properties":{"cases":{"items":{"$ref":"#/components/schemas/CaseResponse"},"type":"array","title":"Cases"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"The next offset"},"total":{"type":"integer","title":"Total","description":"The total number of records"}},"type":"object","required":["cases","total"],"title":"GetCasesResponse"},"GetLineItemNotesRequest":{"properties":{"statement_ids":{"items":{"type":"string"},"type":"array","title":"Statement Ids","description":"List of statement IDs"}},"type":"object","required":["statement_ids"],"title":"GetLineItemNotesRequest","description":"Request schema for getting line item notes"},"GroupingStructureGroupSchema-Input":{"properties":{"group_line_item_key":{"type":"string","title":"Group Line Item Key","description":"The key of the line item that is used to group the line items in the group, for example: 'total_operating_revenues' for income statement, 'net_fixed_assets' for balance sheet, etc."},"sub_line_item_keys":{"items":{"type":"string"},"type":"array","title":"Sub Line Item Keys","description":"The keys of the line items that are in the group, for example: ['business_revenue', 'other_revenues', 'revenue_adjustments'] are under 'total_operating_revenues'"},"sub_groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Input"},"type":"array"},{"type":"null"}],"title":"Sub Groups"}},"type":"object","required":["group_line_item_key","sub_line_item_keys"],"title":"GroupingStructureGroupSchema"},"GroupingStructureGroupSchema-Output":{"properties":{"group_line_item_key":{"type":"string","title":"Group Line Item Key","description":"The key of the line item that is used to group the line items in the group, for example: 'total_operating_revenues' for income statement, 'net_fixed_assets' for balance sheet, etc."},"sub_line_item_keys":{"items":{"type":"string"},"type":"array","title":"Sub Line Item Keys","description":"The keys of the line items that are in the group, for example: ['business_revenue', 'other_revenues', 'revenue_adjustments'] are under 'total_operating_revenues'"},"sub_groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Output"},"type":"array"},{"type":"null"}],"title":"Sub Groups"}},"type":"object","required":["group_line_item_key","sub_line_item_keys"],"title":"GroupingStructureGroupSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImportAccountBalance":{"properties":{"account_id":{"type":"string","maxLength":255,"minLength":1,"title":"Account Id","description":"The account's `account_key`, any id known for it, or its `bank_account_id`."},"as_of":{"type":"string","format":"date","title":"As Of","description":"The day the balance is true at the END of, after every posted transaction dated on or before it. Pending ones are left out."},"closing_balance":{"type":"number","title":"Closing Balance","description":"In the account's currency, as the provider reports it: negative when a deposit account is overdrawn; the amount owed on a credit card or loan."}},"additionalProperties":false,"type":"object","required":["account_id","as_of","closing_balance"],"title":"ImportAccountBalance","description":"An account's balance at the end of the dates you declared complete.\n\n`as_of` must be the account's last covered day once this job applies. One\nis owed when the job moves that day, resets the account, or no earlier job\ndeclared a balance for it; a backfill of older months owes none. Plaid's\n`balances.current` means exactly this when coverage runs through the day\nyou pulled it."},"ImportAccountingSourceRef":{"properties":{"source":{"type":"string","const":"import","title":"Source"},"family":{"type":"string","const":"accounting","title":"Family"},"system":{"type":"string","title":"System"},"api_source":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentApiSource"},{"type":"null"}]},"report_ids":{"items":{"type":"string"},"type":"array","title":"Report Ids"}},"type":"object","required":["source","family","system","report_ids"],"title":"ImportAccountingSourceRef"},"ImportBankingSourceRef":{"properties":{"source":{"type":"string","const":"import","title":"Source"},"family":{"type":"string","const":"banking","title":"Family"},"import_ids":{"items":{"type":"string"},"type":"array","title":"Import Ids"},"bank_account_ids":{"items":{"type":"string"},"type":"array","title":"Bank Account Ids"}},"type":"object","required":["source","family","import_ids","bank_account_ids"],"title":"ImportBankingSourceRef"},"ImportFinancialDataFromSourceMRequest":{"properties":{"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"spreads":{"items":{"$ref":"#/components/schemas/FinancialDataImportsFromSourceM"},"type":"array","title":"Spreads"}},"type":"object","required":["customer_id","spreads"],"title":"ImportFinancialDataFromSourceMRequest"},"ImportFinancialDataFromSourceMRequestExt":{"properties":{"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"external customer ID for the customer the case belongs to"},"spreads":{"items":{"$ref":"#/components/schemas/FinancialDataImportsFromSourceM"},"type":"array","title":"Spreads"}},"type":"object","required":["external_customer_id","spreads"],"title":"ImportFinancialDataFromSourceMRequestExt"},"ImportSchema":{"properties":{"import_id":{"type":"string","title":"Import Id"},"source_key":{"type":"string","title":"Source Key"},"state":{"type":"string","title":"State"},"record_count":{"type":"integer","title":"Record Count"},"started_at":{"type":"string","format":"date-time","title":"Started At"},"settled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Settled At"}},"type":"object","required":["import_id","source_key","state","record_count","started_at"],"title":"ImportSchema"},"IncomeStatementDataType":{"type":"string","enum":["actual","estimated","projected"],"title":"IncomeStatementDataType"},"IncomeStatementImport":{"properties":{"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, date in isoformat"},"period_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Type","description":"The type of period"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}],"description":"The type of data"},"line_items":{"$ref":"#/components/schemas/IncomeStatementLineItemsImport"}},"type":"object","required":["start_period","end_period","line_items"],"title":"IncomeStatementImport","description":"The income statement import schema\nAll the total line items are calculated from the line items through summation.\nThere is no subtraction in the total line item calculation.\nFor example, gross profit = total operating revenue + cost of goods sold.\nTherefore, expenses(including cost of goods sold) line items usually have negative amounts."},"IncomeStatementLineItemsImport":{"properties":{"business_revenue":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_revenues":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"revenue_adjustments":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"cogs_excluding_d_and_a_and_impairment":{"$ref":"#/components/schemas/LineItemSchema","description":"Cost of goods sold excluding depreciation and amortization and impairment","default":{"amount":0.0}},"cogs_depreciation":{"$ref":"#/components/schemas/LineItemSchema","description":"Depreciation portion of the cost of goods sold","default":{"amount":0.0}},"cogs_amortization":{"$ref":"#/components/schemas/LineItemSchema","description":"Amortization portion of the cost of goods sold","default":{"amount":0.0}},"cogs_impairment":{"$ref":"#/components/schemas/LineItemSchema","description":"Impairment portion of the cost of goods sold","default":{"amount":0.0}},"selling_and_marketing_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"research_and_development_expense":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"salaries_and_wages":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"retirement_benefits":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_personnel_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"bad_debt_expense":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"utilities":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_general_and_administrative_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"depreciation":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"amortization":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"impairment_expense":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"building_rent":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"equipment_rental_and_lease_expense":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_rent_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"interest_income":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"interest_expense":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_income":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"other_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"non_cash_income_or_expenses":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"gain_or_loss_on_sale_of_assets":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"investment_income_associates_and_joint_ventures":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"minority_interest":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"extraordinary_income_or_expense":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}},"taxes_or_benefit":{"$ref":"#/components/schemas/LineItemSchema","default":{"amount":0.0}}},"type":"object","title":"IncomeStatementLineItemsImport"},"IncomeStatementLineItemsSchema":{"properties":{"total_operating_revenues":{"$ref":"#/components/schemas/LineItemSchema"},"business_revenue":{"$ref":"#/components/schemas/LineItemSchema"},"other_revenues":{"$ref":"#/components/schemas/LineItemSchema"},"revenue_adjustments":{"$ref":"#/components/schemas/LineItemSchema"},"cost_of_goods_sold":{"$ref":"#/components/schemas/LineItemSchema","description":"Total cost of goods sold"},"cogs_excluding_d_and_a_and_impairment":{"$ref":"#/components/schemas/LineItemSchema","description":"Cost of goods sold excluding depreciation and amortization and impairment","default":{"amount":0.0}},"cogs_depreciation":{"$ref":"#/components/schemas/LineItemSchema","description":"Depreciation portion of the cost of goods sold","default":{"amount":0.0}},"cogs_amortization":{"$ref":"#/components/schemas/LineItemSchema","description":"Amortization portion of the cost of goods sold","default":{"amount":0.0}},"cogs_impairment":{"$ref":"#/components/schemas/LineItemSchema","description":"Impairment portion of the cost of goods sold","default":{"amount":0.0}},"gross_profit":{"$ref":"#/components/schemas/LineItemSchema"},"selling_and_marketing_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"research_and_development_expense":{"$ref":"#/components/schemas/LineItemSchema"},"personal_expenses":{"$ref":"#/components/schemas/LineItemSchema","description":"Should be personnel expenses, this is used in 2.x.x version of the schema and will be deprecated in 3.x.x","default":{"amount":0.0}},"personnel_expenses":{"$ref":"#/components/schemas/LineItemSchema","description":"This is used in 3.x.x version of the schema and will replace the personal_expenses field in 2.x.x","default":{"amount":0.0}},"salaries_and_wages":{"$ref":"#/components/schemas/LineItemSchema"},"retirement_benefits":{"$ref":"#/components/schemas/LineItemSchema"},"other_personal_costs":{"$ref":"#/components/schemas/LineItemSchema","description":"This is used in 2.x.x version of the schema and will be deprecated in 3.x.x","default":{"amount":0.0}},"other_personnel_expenses":{"$ref":"#/components/schemas/LineItemSchema","description":"This is used in 3.x.x version of the schema and will replace the other_personal_costs field in 2.x.x","default":{"amount":0.0}},"general_and_administrative_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"bad_debt_expense":{"$ref":"#/components/schemas/LineItemSchema"},"utilities":{"$ref":"#/components/schemas/LineItemSchema"},"other_general_and_administrative_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"depreciation_and_amortization":{"$ref":"#/components/schemas/LineItemSchema"},"depreciation":{"$ref":"#/components/schemas/LineItemSchema"},"amortization":{"$ref":"#/components/schemas/LineItemSchema"},"impairment_expense":{"$ref":"#/components/schemas/LineItemSchema"},"rent":{"$ref":"#/components/schemas/LineItemSchema"},"building_rent":{"$ref":"#/components/schemas/LineItemSchema"},"equipment_rental_and_lease_expense":{"$ref":"#/components/schemas/LineItemSchema"},"other_rent_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"total_operating_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"operating_profit_or_loss":{"$ref":"#/components/schemas/LineItemSchema"},"interest_income":{"$ref":"#/components/schemas/LineItemSchema"},"interest_expense":{"$ref":"#/components/schemas/LineItemSchema"},"other_income":{"$ref":"#/components/schemas/LineItemSchema"},"other_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"non_cash_income_or_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"gain_or_loss_on_sale_of_assets":{"$ref":"#/components/schemas/LineItemSchema"},"investment_income_associates_and_joint_ventures":{"$ref":"#/components/schemas/LineItemSchema"},"total_non_operating_revenue_or_expenses":{"$ref":"#/components/schemas/LineItemSchema"},"profit_or_loss_before_taxes":{"$ref":"#/components/schemas/LineItemSchema"},"minority_interest":{"$ref":"#/components/schemas/LineItemSchema"},"extraordinary_income_or_expense":{"$ref":"#/components/schemas/LineItemSchema"},"taxes_or_benefit":{"$ref":"#/components/schemas/LineItemSchema"},"net_income_or_loss":{"$ref":"#/components/schemas/LineItemSchema"}},"type":"object","required":["total_operating_revenues","business_revenue","other_revenues","revenue_adjustments","cost_of_goods_sold","gross_profit","selling_and_marketing_expenses","research_and_development_expense","salaries_and_wages","retirement_benefits","general_and_administrative_expenses","bad_debt_expense","utilities","other_general_and_administrative_expenses","depreciation_and_amortization","depreciation","amortization","impairment_expense","rent","building_rent","equipment_rental_and_lease_expense","other_rent_expenses","total_operating_expenses","operating_profit_or_loss","interest_income","interest_expense","other_income","other_expenses","non_cash_income_or_expenses","gain_or_loss_on_sale_of_assets","investment_income_associates_and_joint_ventures","total_non_operating_revenue_or_expenses","profit_or_loss_before_taxes","minority_interest","extraordinary_income_or_expense","taxes_or_benefit","net_income_or_loss"],"title":"IncomeStatementLineItemsSchema"},"IncomeStatementSchema-Input":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"The unique identifier of the income statement period within the case"},"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, return as date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"period_length":{"type":"integer","title":"Period Length"},"is_calculated":{"type":"boolean","title":"Is Calculated","description":"The flag to indicate if the income statement is calculated based on other statements"},"period_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Type"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"status":{"$ref":"#/components/schemas/StatementStatus","default":"active"},"custom_account_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Account Group Key"},"calculation_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculation Method"},"calculation_references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Calculation References","description":"The reference IS periods for normalization"},"line_items":{"$ref":"#/components/schemas/IncomeStatementLineItemsSchema"},"custom_line_items":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/LineItemSchema"},"type":"object"},{"type":"null"}],"title":"Custom Line Items","description":"The custom account group line items"}},"type":"object","required":["statement_id","start_period","end_period","period_length","is_calculated","line_items"],"title":"IncomeStatementSchema","description":"The income statement schema"},"IncomeStatementSchema-Output":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"The unique identifier of the income statement period within the case"},"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, return as date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"period_length":{"type":"integer","title":"Period Length"},"is_calculated":{"type":"boolean","title":"Is Calculated","description":"The flag to indicate if the income statement is calculated based on other statements"},"period_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Type"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"status":{"$ref":"#/components/schemas/StatementStatus","default":"active"},"custom_account_group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Account Group Key"},"calculation_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculation Method"},"calculation_references":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Calculation References","description":"The reference IS periods for normalization"},"line_items":{"$ref":"#/components/schemas/IncomeStatementLineItemsSchema"},"custom_line_items":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/LineItemSchema"},"type":"object"},{"type":"null"}],"title":"Custom Line Items","description":"The custom account group line items"}},"type":"object","required":["statement_id","start_period","end_period","period_length","is_calculated","line_items"],"title":"IncomeStatementSchema","description":"The income statement schema"},"IndividualCreate":{"properties":{"first_name":{"type":"string","maxLength":255,"minLength":1,"title":"First Name"},"last_name":{"type":"string","maxLength":255,"minLength":1,"title":"Last Name"},"middle_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Middle Name"},"address":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Address"},"spouse_first_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Spouse First Name"},"spouse_middle_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Spouse Middle Name"},"spouse_last_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Spouse Last Name"},"fiscal_year_start_month":{"anyOf":[{"$ref":"#/components/schemas/MonthType"},{"type":"null"}]},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"}},"type":"object","required":["first_name","last_name"],"title":"IndividualCreate","description":"A natural person, created from name parts.\n\nThe record's legal name is composed as first, middle, last; the three\ntogether must fit in 255 characters."},"IndividualCustomerResponse":{"properties":{"customer_id":{"type":"string","title":"Customer Id","description":"Customer ID in our system"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id","description":"External Customer ID"},"fin_template_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fin Template Key","description":"Financial template key in our system"},"customer_type":{"type":"string","const":"individual","title":"Customer Type","default":"individual"},"legal_name":{"type":"string","title":"Legal Name","description":"Individual's legal full name"},"first_name":{"type":"string","title":"First Name","description":"Individual's first name"},"last_name":{"type":"string","title":"Last Name","description":"Individual's last name"},"middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Middle Name","description":"Individual's middle name"},"spouse_first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spouse First Name","description":"Individual's spouse's first name"},"spouse_last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spouse Last Name","description":"Individual's spouse's last name"},"spouse_middle_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spouse Middle Name","description":"Individual's spouse's middle name"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Company address"},"address_line1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line1","description":"Verified address line 1"},"address_line2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line2","description":"Verified address line 2"},"address_postal_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Postal Code","description":"Verified postal code"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Customer creation time in ISO format"},"currency":{"type":"string","title":"Currency","description":"Currency code"},"fiscal_year_start_month":{"$ref":"#/components/schemas/MonthType","description":"The start month of the fiscal year"},"enabled_combined_financials":{"type":"boolean","title":"Enabled Combined Financials","description":"Whether the individual's financials are enabled for combined financials"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Org-defined custom attributes"},"status":{"$ref":"#/components/schemas/EntityStatus","description":"Customer status (active, inactive, onboarding, suspended)"}},"type":"object","required":["customer_id","external_customer_id","legal_name","first_name","last_name","created_at","currency","fiscal_year_start_month","enabled_combined_financials","status"],"title":"IndividualCustomerResponse"},"IndividualPartyRef":{"properties":{"kind":{"type":"string","const":"individual","title":"Kind"},"mode":{"$ref":"#/components/schemas/ResolutionMode"},"id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Id"},"external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id"},"obj":{"anyOf":[{"$ref":"#/components/schemas/IndividualCreate"},{"type":"null"}]},"role":{"$ref":"#/components/schemas/AdditionalPartyRole"}},"type":"object","required":["kind","mode","role"],"title":"IndividualPartyRef"},"IndividualRef":{"properties":{"kind":{"type":"string","const":"individual","title":"Kind"},"mode":{"$ref":"#/components/schemas/ResolutionMode"},"id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Id"},"external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id"},"obj":{"anyOf":[{"$ref":"#/components/schemas/IndividualCreate"},{"type":"null"}]}},"type":"object","required":["kind","mode"],"title":"IndividualRef","description":"A natural person, matched on ``external_id`` alone.\n\nUnlike a business, ``mode: create`` always makes a new record: a person's\nname does not identify a person, so there is no name match, and two\n``mode: create`` entries describing the same person produce two records.\nSend ``link_or_create`` with an ``external_id`` to converge on one."},"IndustryClassificationResult":{"properties":{"industries":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Industries"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"list_type":{"anyOf":[{"type":"string","enum":["NACE","NAICS","MCC","COMMON_INDUSTRIES","UNKNOWN"]},{"type":"null"}],"title":"List Type"}},"type":"object","required":["industries","reason","list_type"],"title":"IndustryClassificationResult"},"IndustryCode-Output":{"properties":{"industries":{"items":{"type":"string"},"type":"array","title":"Industries","description":"The industry codes of the company"},"list_type":{"type":"string","enum":["NACE","NAICS","MCC"],"title":"List Type","description":"The type of industry code"}},"type":"object","required":["industries","list_type"],"title":"IndustryCode"},"IndustryRiskReport":{"properties":{"confidence":{"anyOf":[{"type":"string","enum":["LOW","MEDIUM","HIGH"]},{"type":"null"}],"title":"Confidence","description":"Confidence level of the report, can be HIGH, MEDIUM, LOW, or null. It's null when no web presence is found about the company."},"risk_score":{"anyOf":[{"type":"string","enum":["PROHIBITED","RESTRICTED","HIGH","MEDIUM","LOW"]},{"type":"null"}],"title":"Risk Score","description":"Risk score of the report for company industry risk, can be PROHIBITED, RESTRICTED, HIGH, MEDIUM, LOW, or null. It's null when no web presence is found about the company."},"risk_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Risk Label","description":"Industry risk label of the company."},"application_industry_codes_validation":{"anyOf":[{"type":"string","enum":["MATCH","MISMATCH","INVALID"]},{"type":"null"}],"title":"Application Industry Codes Validation","description":"Validation result of the application industry codes."},"narrative":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Narrative","description":"Narrative of the report."},"extended_dual_use_assessment":{"anyOf":[{"$ref":"#/components/schemas/ExtendedDualUseAssessment"},{"type":"null"}],"description":"Extended MDUG and export-controls assessment for defence or dual-use industry classifications."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason","description":"Reason for the risk score."}},"type":"object","required":["confidence","risk_score","narrative"],"title":"IndustryRiskReport"},"InformationRequestReference":{"properties":{"information_request_id":{"type":"string","title":"Information Request Id"},"url":{"type":"string","title":"Url"}},"type":"object","required":["information_request_id","url"],"title":"InformationRequestReference"},"InvolvedCustomerSchema":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"legal_name":{"type":"string","title":"Legal Name"},"customer_type":{"$ref":"#/components/schemas/CustomerType"},"fiscal_year_start_month":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Year Start Month"},"party_role":{"$ref":"#/components/schemas/DealPartyRole","default":"party"}},"type":"object","required":["customer_id","legal_name","customer_type"],"title":"InvolvedCustomerSchema"},"InvolvedPropertySchema":{"properties":{"property_id":{"type":"string","title":"Property Id"},"legal_name":{"type":"string","title":"Legal Name"},"party_role":{"$ref":"#/components/schemas/DealPartyRole","default":"party"}},"type":"object","required":["property_id","legal_name"],"title":"InvolvedPropertySchema"},"JsonScalar":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"JsonValue-Input":{"anyOf":[{"$ref":"#/components/schemas/JsonScalar"},{"items":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"array"},{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"}]},"JsonValue-Output":{"anyOf":[{"$ref":"#/components/schemas/JsonScalar"},{"items":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"array"},{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"}]},"KYCReport":{"properties":{"risk_score":{"anyOf":[{"type":"string","enum":["PROHIBITED","RESTRICTED","HIGH","MEDIUM","LOW"]},{"type":"null"}],"title":"Risk Score","description":"The overall risk score of the KYC report for the company."},"onboarding_recommendation":{"anyOf":[{"type":"string","enum":["YES","NO"]},{"type":"null"}],"title":"Onboarding Recommendation","description":"The recommendation for onboarding the company."},"narrative":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Narrative","description":"Narrative of the report."}},"type":"object","title":"KYCReport"},"LegalStructure":{"type":"string","enum":["c_corp","s_corp","close_corp","professional_corp","benefit_corp","publicly_traded_corp","alien_corp","cooperative","partnership","limited_partnership","llp","lllp","llc","pllc","sole_prop","non_profit","private_school","public_school","government","public_authority","trust","unincorporated_association","other"]},"LineItemNotesExternalResponse":{"properties":{"notes":{"items":{"$ref":"#/components/schemas/CoaStatementLineItemNoteExternalSchema"},"type":"array","title":"Notes","description":"List of line item notes"}},"type":"object","required":["notes"],"title":"LineItemNotesExternalResponse","description":"Response schema for line item notes"},"LineItemSchema":{"properties":{"amount":{"type":"number","title":"Amount"}},"type":"object","required":["amount"],"title":"LineItemSchema"},"LinkAccountingSourceRef":{"properties":{"source":{"type":"string","const":"link","title":"Source"},"family":{"type":"string","const":"accounting","title":"Family"},"link_connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Connection Id","description":"The connection that supplied the data; null only when that connection no longer exists"},"report_ids":{"items":{"type":"string"},"type":"array","title":"Report Ids"}},"type":"object","required":["source","family","link_connection_id","report_ids"],"title":"LinkAccountingSourceRef","description":"An accounting connection: the reports its syncs stored."},"LinkBankingSourceRef":{"properties":{"source":{"type":"string","const":"link","title":"Source"},"family":{"type":"string","const":"banking","title":"Family"},"link_connection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link Connection Id","description":"The connection that supplied the data; null only when that connection no longer exists"},"bank_account_ids":{"items":{"type":"string"},"type":"array","title":"Bank Account Ids"}},"type":"object","required":["source","family","link_connection_id","bank_account_ids"],"title":"LinkBankingSourceRef","description":"Plaid: one connection's accounts."},"LinkConnection":{"properties":{"link_integration_type":{"$ref":"#/components/schemas/LinkIntegrationType"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"last_synced_at":{"type":"string","format":"date-time","title":"Last Synced At"},"status":{"$ref":"#/components/schemas/LinkConnectionStatus"},"org_id":{"type":"string","title":"Org Id"},"customer_id":{"type":"string","title":"Customer Id"},"connection_details":{"$ref":"#/components/schemas/ConnectionDetails"},"link_connection_id":{"type":"string","title":"Link Connection Id"},"external_id":{"type":"string","title":"External Id"}},"type":"object","required":["link_integration_type","created_at","updated_at","last_synced_at","status","org_id","customer_id","connection_details","link_connection_id","external_id"],"title":"LinkConnection"},"LinkConnectionMetadata":{"properties":{"link_integration_type":{"$ref":"#/components/schemas/LinkIntegrationType"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"last_synced_at":{"type":"string","format":"date-time","title":"Last Synced At"},"status":{"$ref":"#/components/schemas/LinkConnectionStatus"}},"type":"object","required":["link_integration_type","created_at","updated_at","last_synced_at","status"],"title":"LinkConnectionMetadata"},"LinkConnectionStatus":{"type":"string","enum":["pending","connected","disconnected","deauthorized","error"],"title":"LinkConnectionStatus"},"LinkConnectionsResponse":{"properties":{"link_connections":{"items":{"$ref":"#/components/schemas/LinkConnection"},"type":"array","title":"Link Connections","description":"List of link connections"}},"type":"object","required":["link_connections"],"title":"LinkConnectionsResponse"},"LinkIntegrationType":{"type":"string","enum":["quickbooks_online","netsuite","xero","freshbooks","zoho_books","plaid","api"],"title":"LinkIntegrationType"},"LinkPassThroughRequest":{"properties":{"endpoint":{"type":"string","title":"Endpoint"},"method":{"type":"string","enum":["GET","POST","PUT","DELETE"],"title":"Method"},"body":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Body"},"query":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Query"},"extra_headers":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extra Headers"}},"type":"object","required":["endpoint","method"],"title":"LinkPassThroughRequest"},"LinkPassThroughResponse":{"properties":{"request":{"$ref":"#/components/schemas/LinkPassThroughRequest"},"headers":{"additionalProperties":true,"type":"object","title":"Headers"},"status_code":{"type":"integer","title":"Status Code"},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"type":"object","required":["request","headers","status_code","data"],"title":"LinkPassThroughResponse"},"LinkSource":{"type":"string","enum":["banking","accounting"]},"LinkSyncCompletionEvent":{"properties":{"org_id":{"type":"string","title":"Org Id"},"customer_id":{"type":"string","title":"Customer Id"},"link_connection_id":{"type":"string","title":"Link Connection Id"},"link_integration_type":{"$ref":"#/components/schemas/LinkIntegrationType"},"sync_type":{"$ref":"#/components/schemas/LinkSyncJobType"},"sync_status":{"$ref":"#/components/schemas/LinkSyncJobStatus"},"import_metadata":{"items":{"$ref":"#/components/schemas/LinkSyncImportMetadata"},"type":"array","title":"Import Metadata"}},"type":"object","required":["org_id","customer_id","link_connection_id","link_integration_type","sync_type","sync_status","import_metadata"],"title":"LinkSyncCompletionEvent"},"LinkSyncErrorEvent":{"properties":{"org_id":{"type":"string","title":"Org Id"},"customer_id":{"type":"string","title":"Customer Id"},"link_connection_id":{"type":"string","title":"Link Connection Id"},"link_integration_type":{"$ref":"#/components/schemas/LinkIntegrationType"},"sync_type":{"$ref":"#/components/schemas/LinkSyncJobType"},"sync_status":{"$ref":"#/components/schemas/LinkSyncJobStatus"},"error":{"type":"string","title":"Error"}},"type":"object","required":["org_id","customer_id","link_connection_id","link_integration_type","sync_type","sync_status","error"],"title":"LinkSyncErrorEvent"},"LinkSyncImportMetadata":{"properties":{"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, return as date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"period_length":{"type":"integer","title":"Period Length","description":"The length of the period in months"},"statement_type":{"$ref":"#/components/schemas/DataSourceStatementType"}},"type":"object","required":["start_period","end_period","period_length","statement_type"],"title":"LinkSyncImportMetadata"},"LinkSyncJobStatus":{"type":"string","enum":["pending","syncing","completed","error"],"title":"LinkSyncJobStatus"},"LinkSyncJobType":{"type":"string","enum":["initial","recurring","manual"],"title":"LinkSyncJobType"},"LinkedinPresenceResult":{"properties":{"employee_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Employee Count","description":"The number of employees of the company."}},"type":"object","title":"LinkedinPresenceResult"},"ListFinReportsResponse":{"properties":{"reports":{"items":{"$ref":"#/components/schemas/FinReportListItem"},"type":"array","title":"Reports"},"total":{"type":"integer","title":"Total"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["reports","total"],"title":"ListFinReportsResponse"},"LoanBillingCycle":{"type":"string","enum":["daily","weekly","bi_weekly","semi_monthly","monthly","quarterly","semi_annual","annual","other"],"title":"LoanBillingCycle"},"LoanInterestBenchmark":{"type":"string","enum":["sofr","prime","fed_funds","treasury","other"]},"LoanInterestType":{"type":"string","enum":["fixed","floating","other"]},"LoanListResponse":{"properties":{"loans":{"items":{"$ref":"#/components/schemas/LoanSchema"},"type":"array","title":"Loans"},"total":{"type":"integer","title":"Total"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["loans","total"],"title":"LoanListResponse"},"LoanProductType":{"type":"string","enum":["term_loan","revolver","overdraft","guarantee","other"]},"LoanPurpose":{"type":"string","enum":["working_capital","capital_expenditure","refinancing","real_estate_purchase","growth_capital","acquisition","equipment_purchase","other"]},"LoanRepaymentType":{"type":"string","enum":["amortizing","bullet","interest_only","revolving","other"]},"LoanSchema":{"properties":{"loan_id":{"type":"string","title":"Loan Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"external_loan_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Loan Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"deal_id":{"type":"string","title":"Deal Id"},"product_type":{"$ref":"#/components/schemas/LoanProductType"},"currency":{"type":"string","title":"Currency","description":"The currency of the loan","default":"USD"},"limit_amount":{"type":"number","title":"Limit Amount"},"interest_type":{"$ref":"#/components/schemas/LoanInterestType"},"interest_rate":{"type":"number","title":"Interest Rate","default":0.0},"interest_benchmark":{"anyOf":[{"$ref":"#/components/schemas/LoanInterestBenchmark"},{"type":"null"}]},"interest_spread":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Spread"},"repayment_type":{"$ref":"#/components/schemas/LoanRepaymentType"},"amortization_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amortization Months"},"balloon_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Balloon Amount"},"billing_cycle":{"anyOf":[{"$ref":"#/components/schemas/LoanBillingCycle"},{"type":"null"}]},"purpose":{"$ref":"#/components/schemas/LoanPurpose"},"seniority":{"anyOf":[{"$ref":"#/components/schemas/LoanSeniority"},{"type":"null"}]},"prepayment_penalty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prepayment Penalty"},"unused_fee_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unused Fee Rate"},"stage":{"type":"string","title":"Stage"},"status":{"$ref":"#/components/schemas/OperationalStatus"},"start_date":{"type":"string","format":"date","title":"Start Date"},"maturity_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Maturity Date"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["loan_id","name","idempotency_key","deal_id","product_type","limit_amount","interest_type","repayment_type","purpose","stage","status","start_date","created_at","updated_at"],"title":"LoanSchema"},"LoanSeniority":{"type":"string","enum":["senior_secured","senior_unsecured","subordinated","mezzanine","other"]},"MonitoringStatus":{"type":"string","enum":["performing","watch","workout"],"title":"MonitoringStatus","description":"Deal-level health sub-state, only meaningful while ``stage == active``.\nA coarse operational bucketing of credit health; a finer risk_rating rolls\nup into it. Reviews/covenant breaches move this; they never move ``stage``."},"MonthType":{"type":"string","enum":["january","february","march","april","may","june","july","august","september","october","november","december"],"title":"MonthType"},"NestedLoanCreate":{"properties":{"external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Id","description":"Your own id for the loan, for correlation only; returned in loans[].external_id. Unique within your organization (409 external_loan_id_taken)."},"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"product_type":{"$ref":"#/components/schemas/LoanProductType"},"limit_amount":{"type":"number","minimum":0.0,"title":"Limit Amount","description":"Requested limit in the loan's currency, two decimal places. 0 is accepted: a product slice with no line yet."},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Defaults to the deal's currency. ISO 4217, case-insensitive; one of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, FOK, GBP, GEL, GGP, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IMP, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TVD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XCG, XDR, XOF, XPF, YER, ZAR, ZMW, ZWL."},"interest_type":{"$ref":"#/components/schemas/LoanInterestType"},"interest_rate":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Interest Rate","description":"Percent, e.g. 5.25. Zero when not yet priced.","default":0.0},"interest_benchmark":{"anyOf":[{"$ref":"#/components/schemas/LoanInterestBenchmark"},{"type":"null"}],"description":"Required when interest_type is floating; rejected otherwise."},"interest_spread":{"anyOf":[{"type":"number","maximum":100.0,"minimum":-100.0},{"type":"null"}],"title":"Interest Spread","description":"Percent over the benchmark."},"repayment_type":{"$ref":"#/components/schemas/LoanRepaymentType"},"purpose":{"$ref":"#/components/schemas/LoanPurpose"},"start_date":{"type":"string","format":"date","title":"Start Date"},"maturity_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Maturity Date","description":"Must be after start_date."},"billing_cycle":{"anyOf":[{"$ref":"#/components/schemas/LoanBillingCycle"},{"type":"null"}]},"amortization_months":{"anyOf":[{"type":"integer","maximum":600.0,"minimum":1.0},{"type":"null"}],"title":"Amortization Months"},"balloon_amount":{"anyOf":[{"type":"number","minimum":0.0},{"type":"null"}],"title":"Balloon Amount"},"seniority":{"anyOf":[{"$ref":"#/components/schemas/LoanSeniority"},{"type":"null"}]},"prepayment_penalty":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Prepayment Penalty"},"unused_fee_rate":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Unused Fee Rate"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"}},"type":"object","required":["name","product_type","limit_amount","interest_type","repayment_type","purpose","start_date"],"title":"NestedLoanCreate","description":"A loan created with its deal: the requested structure, not approved terms.\n\nCreate-only; an existing loan cannot be attached to a new deal. Cross-field\nrules: ``maturity_date`` must be after ``start_date``, and\n``interest_benchmark`` is required when ``interest_type`` is floating and\nrejected otherwise."},"OneCombineCoaStatementRequest":{"properties":{"contributing_statement_ids":{"items":{"type":"string"},"type":"array","title":"Contributing Statement Ids","description":"The list of contributing statement ids"},"start_period":{"type":"string","format":"date-time","title":"Start Period"},"end_period":{"type":"string","format":"date-time","title":"End Period"}},"type":"object","required":["contributing_statement_ids","start_period","end_period"],"title":"OneCombineCoaStatementRequest"},"OperationalStatus":{"type":"string","enum":["in_progress","on_hold","withdrawn","cancelled","rejected","duplicate"],"title":"OperationalStatus","description":"Universal operational state for deals and loans — the \"what's happening\nright now?\" axis, independent of product. Lifecycle position lives in the\nper-program ``stage`` column. There is no positive terminal here; \"done\nwell\" is expressed by ``stage`` reaching active/closed_out. The four\nnegative terminals freeze the stage wherever it was."},"OriginationChannel":{"type":"string","enum":["intake","outreach"]},"OwnershipEntity-Input":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"type":{"type":"string","enum":["COMPANY","PERSON","UNKNOWN"],"title":"Type"},"name":{"type":"string","title":"Name"},"dob":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dob","description":"Apply for person type only, format: MM/DD/YYYY"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction","description":"Apply for company type only, format: ISO 3166-1 alpha-2"},"nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nationality","description":"Apply for person type only, format: ISO 3166-1 alpha-2"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Number","description":"Apply for company type only"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"owned_entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/OwnershipRelationship"},"type":"array"},{"type":"null"}],"title":"Owned Entities","default":[]}},"type":"object","required":["entity_id","type","name"],"title":"OwnershipEntity"},"OwnershipEntity-Output":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"type":{"type":"string","enum":["COMPANY","PERSON","UNKNOWN"],"title":"Type"},"name":{"type":"string","title":"Name"},"dob":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dob","description":"Apply for person type only, format: MM/DD/YYYY"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"jurisdiction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jurisdiction","description":"Apply for company type only, format: ISO 3166-1 alpha-2"},"nationality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nationality","description":"Apply for person type only, format: ISO 3166-1 alpha-2"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Number","description":"Apply for company type only"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"owned_entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/OwnershipRelationship"},"type":"array"},{"type":"null"}],"title":"Owned Entities","default":[]}},"type":"object","required":["entity_id","type","name"],"title":"OwnershipEntity"},"OwnershipInformation-Input":{"properties":{"entity_id":{"type":"string","title":"Entity Id","description":"The entity id of the assessing company"},"all_entities":{"items":{"$ref":"#/components/schemas/OwnershipEntity-Input"},"type":"array","title":"All Entities","default":[]}},"type":"object","required":["entity_id"],"title":"OwnershipInformation"},"OwnershipInformation-Output":{"properties":{"entity_id":{"type":"string","title":"Entity Id","description":"The entity id of the assessing company"},"all_entities":{"items":{"$ref":"#/components/schemas/OwnershipEntity-Output"},"type":"array","title":"All Entities","default":[]}},"type":"object","required":["entity_id"],"title":"OwnershipInformation"},"OwnershipRelationship":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"ownership":{"items":{"$ref":"#/components/schemas/OwnershipShare"},"type":"array","title":"Ownership","default":[]}},"type":"object","required":["entity_id"],"title":"OwnershipRelationship"},"OwnershipRiskReport":{"properties":{"risk_score":{"anyOf":[{"type":"string","enum":["PROHIBITED","HIGH","MEDIUM","LOW"]},{"type":"null"}],"title":"Risk Score","description":"Risk score of the report for company ownership risk."},"tags":{"anyOf":[{"items":{"type":"string","enum":["owned_by_trust","owned_by_stak","owned_by_foundation_association_cooperative","owned_by_nominees_company","owned_by_med_risk_country","owned_by_high_risk_country","owned_in_prohibited_risk_country","has_complex_ownership","missing_ownership_data","hidden_ubo"]},"type":"array"},{"type":"null"}],"title":"Tags","description":"Tags of the report. Could contains following values: owned_by_trust, owned_by_foundation_association_cooperative, owned_by_nominees_company, owned_by_med_risk_country, owned_by_high_risk_country, owned_in_prohibited_risk_country, has_complex_ownership, missing_ownership_data."}},"type":"object","title":"OwnershipRiskReport"},"OwnershipShare":{"properties":{"maximum":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Maximum"},"minimum":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Minimum"},"type":{"type":"string","enum":["SHARE_HOLDING","VOTING_RIGHTS","OTHER","UNKNOWN"],"title":"Type"}},"type":"object","required":["type"],"title":"OwnershipShare"},"PartnerArtifacts":{"properties":{"cases":{"items":{"$ref":"#/components/schemas/PartnerCaseArtifact"},"type":"array","title":"Cases"},"financial_models":{"items":{"$ref":"#/components/schemas/PartnerModelArtifact"},"type":"array","title":"Financial Models"}},"type":"object","title":"PartnerArtifacts"},"PartnerCaseArtifact":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"case_id":{"type":"string","title":"Case Id"}},"type":"object","required":["entity_id","case_id"],"title":"PartnerCaseArtifact"},"PartnerCollectionProgress":{"properties":{"information_request_id":{"type":"string","title":"Information Request Id"},"entity_id":{"type":"string","title":"Entity Id"},"submitted":{"type":"boolean","title":"Submitted"},"requirements":{"items":{"$ref":"#/components/schemas/PartnerRequirement"},"type":"array","title":"Requirements"},"issues":{"items":{"$ref":"#/components/schemas/PartnerIssue"},"type":"array","title":"Issues"}},"type":"object","required":["information_request_id","entity_id","submitted","requirements","issues"],"title":"PartnerCollectionProgress"},"PartnerDeal":{"properties":{"collection_progress":{"items":{"$ref":"#/components/schemas/PartnerCollectionProgress"},"type":"array","title":"Collection Progress"},"current_event":{"anyOf":[{"$ref":"#/components/schemas/CurrentEvent"},{"type":"null"}]},"assessment_status":{"type":"string","enum":["not_started","waiting_for_information","processing","review_required","completed","failed","cancelled"],"title":"Assessment Status","default":"not_started"},"reviews":{"items":{"$ref":"#/components/schemas/PartnerReviewTask"},"type":"array","title":"Reviews"},"next_actions":{"items":{"$ref":"#/components/schemas/SubmitInformationAction"},"type":"array","title":"Next Actions"},"decision":{"$ref":"#/components/schemas/PartnerDecision"},"artifacts":{"anyOf":[{"$ref":"#/components/schemas/PartnerArtifacts"},{"type":"null"}]},"events":{"items":{"$ref":"#/components/schemas/PartnerEvent"},"type":"array","title":"Events"},"deal_id":{"type":"string","title":"Deal Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"main_borrower_id":{"type":"string","title":"Main Borrower Id"},"stage":{"type":"string","title":"Stage"},"status":{"$ref":"#/components/schemas/OperationalStatus"},"program":{"type":"string","title":"Program"},"monitoring_status":{"anyOf":[{"$ref":"#/components/schemas/MonitoringStatus"},{"type":"null"}]},"origination":{"anyOf":[{"$ref":"#/components/schemas/OriginationChannel"},{"type":"null"}]},"allow_link":{"type":"boolean","title":"Allow Link","default":false},"currency":{"type":"string","title":"Currency","default":"USD"},"analyst_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analyst User Id"},"secondary_analyst_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secondary Analyst User Id"},"sales_rep_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sales Rep User Id"},"analyst":{"anyOf":[{"$ref":"#/components/schemas/TaskUserSchema"},{"type":"null"}]},"secondary_analyst":{"anyOf":[{"$ref":"#/components/schemas/TaskUserSchema"},{"type":"null"}]},"sales_rep":{"anyOf":[{"$ref":"#/components/schemas/TaskUserSchema"},{"type":"null"}]},"involved_parties":{"items":{"anyOf":[{"$ref":"#/components/schemas/InvolvedCustomerSchema"},{"$ref":"#/components/schemas/InvolvedPropertySchema"}]},"type":"array","title":"Involved Parties"},"loans":{"items":{"$ref":"#/components/schemas/LoanSchema"},"type":"array","title":"Loans"},"requested_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Requested Limit"},"approved_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Approved Limit"},"allocated_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Allocated Limit","default":0},"allocated_limit_is_converted":{"type":"boolean","title":"Allocated Limit Is Converted","default":false},"collaterals":{"items":{"$ref":"#/components/schemas/CollateralSchema"},"type":"array","title":"Collaterals"},"info_req_email_templates":{"anyOf":[{"$ref":"#/components/schemas/DealEmailTemplatesSchema"},{"type":"null"}]},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["deal_id","name","main_borrower_id","stage","status","program","involved_parties","loans","created_at","updated_at"],"title":"PartnerDeal"},"PartnerDecision":{"properties":{"outcome":{"anyOf":[{"type":"string","enum":["approved","declined"]},{"type":"null"}],"title":"Outcome"},"reason_codes":{"items":{"type":"string"},"type":"array","title":"Reason Codes"},"proposed_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Proposed Limit"}},"type":"object","title":"PartnerDecision"},"PartnerDocument":{"properties":{"document_id":{"type":"string","title":"Document Id"},"file_name":{"type":"string","title":"File Name"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type"},"processing_status":{"type":"string","enum":["processing","failed","unmatched","processed"],"title":"Processing Status"},"requirement_ids":{"items":{"type":"string"},"type":"array","title":"Requirement Ids"},"assignment_mode":{"type":"string","enum":["auto_classify","strict"],"title":"Assignment Mode","default":"auto_classify"},"assigned_requirement_ids":{"items":{"type":"string"},"type":"array","title":"Assigned Requirement Ids"}},"type":"object","required":["document_id","file_name","processing_status"],"title":"PartnerDocument"},"PartnerDocumentSet":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"submitted":{"type":"boolean","title":"Submitted"},"mutable":{"type":"boolean","title":"Mutable"},"complete":{"type":"boolean","title":"Complete","default":false},"requirements":{"items":{"$ref":"#/components/schemas/PartnerRequirement"},"type":"array","title":"Requirements"},"documents":{"items":{"$ref":"#/components/schemas/PartnerDocument"},"type":"array","title":"Documents"},"issues":{"items":{"$ref":"#/components/schemas/PartnerIssue"},"type":"array","title":"Issues"},"replacements":{"items":{"$ref":"#/components/schemas/EvidenceReplacement"},"type":"array","title":"Replacements"}},"type":"object","required":["entity_id","submitted","mutable"],"title":"PartnerDocumentSet"},"PartnerEvent":{"properties":{"event_instance_id":{"type":"string","title":"Event Instance Id"},"event_type":{"type":"string","title":"Event Type"},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period"},"status":{"type":"string","enum":["open","closed","cancelled"],"title":"Status"},"checklist_status":{"type":"string","enum":["processing","available","not_applicable"],"title":"Checklist Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"information_requests":{"items":{"$ref":"#/components/schemas/InformationRequestReference"},"type":"array","title":"Information Requests"}},"type":"object","required":["event_instance_id","event_type","status","checklist_status","created_at"],"title":"PartnerEvent"},"PartnerEvents":{"properties":{"events":{"items":{"$ref":"#/components/schemas/PartnerEvent"},"type":"array","title":"Events"}},"type":"object","required":["events"],"title":"PartnerEvents"},"PartnerFulfillment":{"properties":{"sources":{"items":{"oneOf":[{"$ref":"#/components/schemas/UploadSourceRef"},{"$ref":"#/components/schemas/LinkAccountingSourceRef"},{"$ref":"#/components/schemas/LinkBankingSourceRef"},{"$ref":"#/components/schemas/ImportAccountingSourceRef"},{"$ref":"#/components/schemas/ImportBankingSourceRef"}]},"type":"array","title":"Sources"}},"type":"object","title":"PartnerFulfillment","description":"What fulfils the requirement, one reference per source (#6255): its\nuploads, or the connected or imported data that stands in for them --\n``link`` (a connection) or ``import`` (a partner import), each with its\n``family``, ``accounting`` or ``banking``."},"PartnerInformationRequest":{"properties":{"information_request_id":{"type":"string","title":"Information Request Id"},"deal_id":{"type":"string","title":"Deal Id"},"event_instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Instance Id"},"status":{"type":"string","enum":["pending","submitted","cancelled"],"title":"Status"},"document_sets":{"items":{"$ref":"#/components/schemas/PartnerDocumentSet"},"type":"array","title":"Document Sets"},"next_actions":{"items":{"$ref":"#/components/schemas/SubmitInformationAction"},"type":"array","title":"Next Actions"},"complete":{"type":"boolean","title":"Complete","default":false}},"type":"object","required":["information_request_id","deal_id","event_instance_id","status","document_sets","next_actions"],"title":"PartnerInformationRequest"},"PartnerIssue":{"properties":{"reason_code":{"type":"string","title":"Reason Code"},"check_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Check Key"},"message":{"type":"string","title":"Message"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id"},"severity":{"type":"string","enum":["error","warning"],"title":"Severity","default":"error"},"missing_periods":{"items":{"$ref":"#/components/schemas/PartnerPeriod"},"type":"array","title":"Missing Periods"}},"type":"object","required":["reason_code","message"],"title":"PartnerIssue"},"PartnerModelArtifact":{"properties":{"entity_id":{"type":"string","title":"Entity Id"},"model_run_id":{"type":"string","title":"Model Run Id"}},"type":"object","required":["entity_id","model_run_id"],"title":"PartnerModelArtifact"},"PartnerPeriod":{"properties":{"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date"},"months":{"type":"integer","exclusiveMinimum":0.0,"title":"Months"}},"type":"object","required":["months"],"title":"PartnerPeriod"},"PartnerRequirement":{"properties":{"requirement_id":{"type":"string","title":"Requirement Id"},"category":{"type":"string","title":"Category"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type"},"instruction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instruction"},"periods":{"items":{"$ref":"#/components/schemas/PartnerPeriod"},"type":"array","title":"Periods"},"optional":{"type":"boolean","title":"Optional"},"waived":{"type":"boolean","title":"Waived"},"status":{"type":"string","enum":["missing","processing","issues","satisfied","waived"],"title":"Status"},"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids"},"issues":{"items":{"$ref":"#/components/schemas/PartnerIssue"},"type":"array","title":"Issues"},"fulfillment":{"$ref":"#/components/schemas/PartnerFulfillment"},"accepted_families":{"items":{"$ref":"#/components/schemas/LinkSource"},"type":"array","title":"Accepted Families"}},"type":"object","required":["requirement_id","category","optional","waived","status"],"title":"PartnerRequirement"},"PartnerReviewTask":{"properties":{"task_id":{"type":"string","title":"Task Id"},"event_instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Instance Id"},"message":{"type":"string","title":"Message"},"action_url":{"type":"string","title":"Action Url"}},"type":"object","required":["task_id","message","action_url"],"title":"PartnerReviewTask"},"PhoneNumber":{"properties":{"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"The country code"},"number":{"type":"string","title":"Number","description":"The phone number"}},"type":"object","required":["number"],"title":"PhoneNumber"},"PlaidAccount":{"properties":{"account_id":{"type":"string","maxLength":128,"minLength":1,"title":"Account Id"},"persistent_account_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Persistent Account Id"},"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name"},"official_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Official Name"},"mask":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Mask"},"type":{"type":"string","maxLength":64,"title":"Type"},"subtype":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Subtype"},"balances":{"anyOf":[{"$ref":"#/components/schemas/PlaidBalances"},{"type":"null"}]}},"type":"object","required":["account_id","type"],"title":"PlaidAccount","description":"One entry of Plaid's `accounts` array."},"PlaidBalances":{"properties":{"current":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Current"},"available":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Available"},"iso_currency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iso Currency Code"}},"type":"object","title":"PlaidBalances"},"PlaidBatchRequest":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/PlaidAccount"},"type":"array","minItems":1,"title":"Accounts"},"transactions":{"items":{"$ref":"#/components/schemas/PlaidTransaction"},"type":"array","title":"Transactions"},"added":{"items":{"$ref":"#/components/schemas/PlaidTransaction"},"type":"array","title":"Added"},"modified":{"items":{"$ref":"#/components/schemas/PlaidTransaction"},"type":"array","title":"Modified"},"removed":{"items":{"$ref":"#/components/schemas/PlaidRemovedTransaction"},"type":"array","title":"Removed"}},"type":"object","required":["accounts"],"title":"PlaidBatchRequest","description":"A Plaid `/transactions/get` or `/transactions/sync` response body,\nunchanged. Fields we don't read (`item`, `next_cursor`, `request_id`, ...)\nare accepted and ignored."},"PlaidPersonalFinanceCategory":{"properties":{"primary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary"},"detailed":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detailed"}},"type":"object","title":"PlaidPersonalFinanceCategory"},"PlaidRemovedTransaction":{"properties":{"transaction_id":{"type":"string","maxLength":128,"minLength":1,"title":"Transaction Id"},"account_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Account Id"}},"type":"object","required":["transaction_id"],"title":"PlaidRemovedTransaction"},"PlaidTransaction":{"properties":{"transaction_id":{"type":"string","maxLength":128,"minLength":1,"title":"Transaction Id"},"account_id":{"type":"string","maxLength":128,"minLength":1,"title":"Account Id"},"date":{"type":"string","format":"date","title":"Date"},"amount":{"type":"number","title":"Amount"},"iso_currency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iso Currency Code"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"merchant_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Merchant Name"},"pending":{"type":"boolean","title":"Pending","default":false},"personal_finance_category":{"anyOf":[{"$ref":"#/components/schemas/PlaidPersonalFinanceCategory"},{"type":"null"}]}},"type":"object","required":["transaction_id","account_id","date","amount"],"title":"PlaidTransaction","description":"One Plaid transaction. `amount` is in Plaid's convention: positive is\nmoney OUT of the account. We flip it when storing."},"PrecisePeriodSpreadingRequest-Input":{"properties":{"included_statements":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestStatementType"},"type":"array"},{"type":"null"}],"title":"Included Statements","description":"Financial statements to include"},"included_tax_returns":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestTaxFormType"},"type":"array"},{"type":"null"}],"title":"Included Tax Returns","description":"Tax document types to include. `tax_return` refers to the entity's primary return (e.g., 1040 for individuals, 1120/1065 for businesses)."},"included_rent_rolls":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestRentRollType"},"type":"array"},{"type":"null"}],"title":"Included Rent Rolls","description":"Rent roll types to include"},"fin_stmt_request_periods":{"items":{"$ref":"#/components/schemas/FinStmtSpreadPrecisePeriod"},"type":"array","title":"Fin Stmt Request Periods"}},"type":"object","required":["fin_stmt_request_periods"],"title":"PrecisePeriodSpreadingRequest"},"PrecisePeriodSpreadingRequest-Output":{"properties":{"included_statements":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestStatementType"},"type":"array"},{"type":"null"}],"title":"Included Statements","description":"Financial statements to include"},"included_tax_returns":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestTaxFormType"},"type":"array"},{"type":"null"}],"title":"Included Tax Returns","description":"Tax document types to include. `tax_return` refers to the entity's primary return (e.g., 1040 for individuals, 1120/1065 for businesses)."},"included_rent_rolls":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestRentRollType"},"type":"array"},{"type":"null"}],"title":"Included Rent Rolls","description":"Rent roll types to include"},"fin_stmt_request_periods":{"items":{"$ref":"#/components/schemas/FinStmtSpreadPrecisePeriod"},"type":"array","title":"Fin Stmt Request Periods"}},"type":"object","required":["fin_stmt_request_periods"],"title":"PrecisePeriodSpreadingRequest"},"PriorityLevel":{"type":"string","enum":["High","Medium","Low"],"title":"PriorityLevel"},"PropertiesResponse":{"properties":{"properties":{"items":{"$ref":"#/components/schemas/PropertyOverview"},"type":"array","title":"Properties","description":"List of properties"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset","description":"Next offset for pagination"},"total":{"type":"integer","title":"Total","description":"Total number of properties"}},"type":"object","required":["properties","total"],"title":"PropertiesResponse"},"Property":{"properties":{"asset_id":{"type":"string","title":"Asset Id"},"legal_name":{"type":"string","title":"Legal Name"},"fiscal_year_start_month":{"$ref":"#/components/schemas/MonthType"},"full_address":{"type":"string","title":"Full Address"},"property_type":{"$ref":"#/components/schemas/PropertyType"},"address_line_1":{"type":"string","title":"Address Line 1"},"address_line_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line 2"},"address_city":{"type":"string","title":"Address City"},"address_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address State"},"address_zip":{"type":"string","title":"Address Zip"},"address_country":{"type":"string","title":"Address Country"},"latitude":{"type":"number","title":"Latitude"},"longitude":{"type":"number","title":"Longitude"},"number_of_units":{"type":"integer","title":"Number Of Units"},"floor_area":{"type":"number","title":"Floor Area"},"measure_unit":{"$ref":"#/components/schemas/PropertyAreaMeasureUnit"},"currency":{"type":"string","title":"Currency"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"status":{"$ref":"#/components/schemas/EntityStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"ownerships":{"items":{"$ref":"#/components/schemas/PropertyOwnership"},"type":"array","title":"Ownerships","default":[]},"valuations":{"items":{"$ref":"#/components/schemas/AssetValuation"},"type":"array","title":"Valuations","default":[]}},"type":"object","required":["asset_id","legal_name","fiscal_year_start_month","full_address","property_type","address_line_1","address_city","address_zip","address_country","latitude","longitude","number_of_units","floor_area","measure_unit","currency","status","created_at"],"title":"Property"},"PropertyAreaMeasureUnit":{"type":"string","enum":["square_feet","square_meters"],"title":"PropertyAreaMeasureUnit"},"PropertyCashFlowScenarioCreationSchema":{"properties":{"property_id":{"type":"string","title":"Property Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"involved_parties":{"items":{"anyOf":[{"$ref":"#/components/schemas/CFSInvolvedCustomerCreationSchema"},{"$ref":"#/components/schemas/CFSInvolvedPropertyCreationSchema"}]},"type":"array","title":"Involved Parties"},"periods":{"items":{"$ref":"#/components/schemas/CFSPeriodCreationSchema"},"type":"array","title":"Periods"}},"type":"object","required":["property_id","name","involved_parties","periods"],"title":"PropertyCashFlowScenarioCreationSchema"},"PropertyCreate":{"properties":{"property_type":{"$ref":"#/components/schemas/PropertyType"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"fiscal_year_start_month":{"anyOf":[{"$ref":"#/components/schemas/MonthType"},{"type":"null"}],"default":"january"},"address_line_1":{"type":"string","title":"Address Line 1"},"address_line_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line 2"},"address_city":{"type":"string","title":"Address City"},"address_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address State"},"address_zip":{"type":"string","title":"Address Zip"},"address_country":{"type":"string","title":"Address Country"},"number_of_units":{"type":"integer","title":"Number Of Units"},"floor_area":{"type":"number","title":"Floor Area"},"measure_unit":{"$ref":"#/components/schemas/PropertyAreaMeasureUnit"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","default":"USD"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"status":{"anyOf":[{"$ref":"#/components/schemas/EntityStatus"},{"type":"null"}]},"ownerships":{"items":{"$ref":"#/components/schemas/PropertyOwnershipCreate"},"type":"array","title":"Ownerships"},"valuations":{"items":{"$ref":"#/components/schemas/AssetValuationCreate"},"type":"array","title":"Valuations"}},"type":"object","required":["property_type","idempotency_key","address_line_1","address_city","address_zip","address_country","number_of_units","floor_area","measure_unit"],"title":"PropertyCreate"},"PropertyOverview":{"properties":{"asset_id":{"type":"string","title":"Asset Id"},"legal_name":{"type":"string","title":"Legal Name"},"full_address":{"type":"string","title":"Full Address"},"address_line_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line 1"},"address_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address City"},"address_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address State"},"address_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Zip"},"property_type":{"$ref":"#/components/schemas/PropertyType"},"fiscal_year_start_month":{"$ref":"#/components/schemas/MonthType"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Output"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"status":{"$ref":"#/components/schemas/EntityStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"number_of_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Of Units"},"floor_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floor Area"},"market_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Market Value"},"appraised_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Appraised Value"},"ownership_percentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ownership Percentage"},"owner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Name"}},"type":"object","required":["asset_id","legal_name","full_address","property_type","fiscal_year_start_month","status","created_at","updated_at"],"title":"PropertyOverview"},"PropertyOwnership":{"properties":{"asset_id":{"type":"string","title":"Asset Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"owner_name":{"type":"string","title":"Owner Name"},"ownership_percentage":{"type":"number","title":"Ownership Percentage"},"ownership_start_date":{"type":"string","format":"date-time","title":"Ownership Start Date"},"ownership_end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ownership End Date"}},"type":"object","required":["asset_id","owner_name","ownership_percentage","ownership_start_date"],"title":"PropertyOwnership"},"PropertyOwnershipCreate":{"properties":{"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"owner_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner Name"},"ownership_percentage":{"type":"number","title":"Ownership Percentage"},"ownership_start_date":{"type":"string","format":"date-time","title":"Ownership Start Date"},"ownership_end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Ownership End Date"}},"type":"object","required":["ownership_percentage","ownership_start_date"],"title":"PropertyOwnershipCreate"},"PropertyPartyRef":{"properties":{"kind":{"type":"string","const":"property","title":"Kind"},"mode":{"type":"string","const":"link","title":"Mode","default":"link"},"id":{"type":"string","maxLength":255,"title":"Id"},"role":{"$ref":"#/components/schemas/AdditionalPartyRole"}},"type":"object","required":["kind","id","role"],"title":"PropertyPartyRef"},"PropertyType":{"type":"string","enum":["multi_family","retail","office","industrial_or_warehouse","land","personal_residence","single_family","condo_or_townhouse","apartment","other","single_family_residence"],"title":"PropertyType"},"PropertyUpdate":{"properties":{"fiscal_year_start_month":{"anyOf":[{"$ref":"#/components/schemas/MonthType"},{"type":"null"}]},"property_type":{"anyOf":[{"$ref":"#/components/schemas/PropertyType"},{"type":"null"}]},"address_line_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line 1"},"address_line_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Line 2"},"address_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address City"},"address_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address State"},"address_zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Zip"},"address_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address Country"},"number_of_units":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Of Units"},"floor_area":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Floor Area"},"measure_unit":{"anyOf":[{"$ref":"#/components/schemas/PropertyAreaMeasureUnit"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","default":"USD"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"},"status":{"anyOf":[{"$ref":"#/components/schemas/EntityStatus"},{"type":"null"}]},"ownerships":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOwnership"},"type":"array"},{"type":"null"}],"title":"Ownerships"}},"type":"object","title":"PropertyUpdate"},"ProviderPeriodReport":{"properties":{"statement_type":{"type":"string","enum":["balance_sheet","income_statement"],"title":"Statement Type"},"report":{"additionalProperties":true,"type":"object","title":"Report","description":"The provider's report response"},"start_period":{"type":"string","format":"date","title":"Start Period"},"end_period":{"type":"string","format":"date","title":"End Period"}},"additionalProperties":false,"type":"object","required":["statement_type","report","start_period","end_period"],"title":"ProviderPeriodReport"},"ProviderReport":{"properties":{"statement_type":{"type":"string","enum":["balance_sheet","income_statement"],"title":"Statement Type"},"report":{"additionalProperties":true,"type":"object","title":"Report","description":"The provider's report response"}},"additionalProperties":false,"type":"object","required":["statement_type","report"],"title":"ProviderReport"},"QuickBooksImportRequest":{"properties":{"customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"},"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"api_source":{"$ref":"#/components/schemas/ApiSource"},"accounting_basis":{"anyOf":[{"type":"string","enum":["accrual","cash"]},{"type":"null"}],"title":"Accounting Basis","description":"Optional; each report's Header.ReportBasis is used and must agree"},"chart_of_accounts":{"additionalProperties":true,"type":"object","title":"Chart Of Accounts","description":"The Account query response"},"reports":{"items":{"$ref":"#/components/schemas/ProviderReport"},"type":"array","maxItems":120,"minItems":1,"title":"Reports"}},"additionalProperties":false,"type":"object","required":["idempotency_key","api_source","chart_of_accounts","reports"],"title":"QuickBooksImportRequest"},"RatioAnalysisCustomItemSchema":{"properties":{"group_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Key","description":"The ratio group key"},"key":{"type":"string","title":"Key","description":"The ratio key"},"name":{"type":"string","title":"Name","description":"The name of the ratio"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Value","description":"The value of the ratio. For specific values, it's a number. For theoretical values like 'Infinity' or '-Infinity', it's a string. If the value is not available, it's null."},"unit":{"type":"string","enum":["ratio","dollars","months","percent","days"],"title":"Unit","default":"ratio"}},"type":"object","required":["key","name"],"title":"RatioAnalysisCustomItemSchema"},"RatioAnalysisItemSchema":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"null"}],"title":"Value","description":"The value of the ratio. For specific values, it's a number. For theoretical values like 'Infinity' or '-Infinity', it's a string. If the value is not available, it's null."},"unit":{"type":"string","enum":["ratio","dollars","months","percent","days"],"title":"Unit"},"formula":{"type":"string","title":"Formula"}},"type":"object","required":["unit","formula"],"title":"RatioAnalysisItemSchema"},"RatioAnalysisRatiosSchema":{"properties":{"working_capital":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"change_in_working_capital":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"working_capital_turnover_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"quick_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"current_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"runway":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"total_debt":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"net_debt":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"total_equity":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"tangible_equity":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"debt_to_equity_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"debt_to_tangible_equity_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"net_debt_to_equity_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"debt_to_ebitda_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"net_debt_to_ebitda_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"total_liabilities_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"equity_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ebitda":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ebit":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"funds_from_operations_ffo":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ebitda_interest_coverage_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ebit_interest_coverage_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ffo_interest_coverage_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"debt_service_coverage_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ffo_to_current_debt_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"fixed_charge_coverage_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"gross_margin":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"operating_profit_margin":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"net_profit_margin":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ebitda_margin":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"return_on_equity_roe":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"return_on_assets_roa":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"total_asset_turnover_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"equity_multiplier":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"effective_interest_rate":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"depreciation_to_fixed_assets_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"amortization_to_intangible_assets_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"dividend_payout_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"effective_tax_rate":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"days_sales_outstanding_dso":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"days_inventory_outstanding_dio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"days_payable_outstanding_dpo":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"cash_conversion_cycle_ccc":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"revenue":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"equity_turnover_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"fixed_asset_turnover_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"accounts_receivable_turnover_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"inventory_turnover_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"accounts_payable_turnover_ratio":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"revenue_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"gross_profit_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"operating_profit_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"net_income_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"ebitda_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"total_assets_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"total_liabilities_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"total_equity_growth":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"cash_flow_from_operations_cfo":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"capital_expenditures_capex":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"},"free_cash_flow_fcf":{"$ref":"#/components/schemas/RatioAnalysisItemSchema"}},"type":"object","required":["working_capital","change_in_working_capital","working_capital_turnover_ratio","quick_ratio","current_ratio","runway","total_debt","net_debt","total_equity","tangible_equity","debt_to_equity_ratio","debt_to_tangible_equity_ratio","net_debt_to_equity_ratio","debt_to_ebitda_ratio","net_debt_to_ebitda_ratio","total_liabilities_ratio","equity_ratio","ebitda","ebit","funds_from_operations_ffo","ebitda_interest_coverage_ratio","ebit_interest_coverage_ratio","ffo_interest_coverage_ratio","debt_service_coverage_ratio","ffo_to_current_debt_ratio","fixed_charge_coverage_ratio","gross_margin","operating_profit_margin","net_profit_margin","ebitda_margin","return_on_equity_roe","return_on_assets_roa","total_asset_turnover_ratio","equity_multiplier","effective_interest_rate","depreciation_to_fixed_assets_ratio","amortization_to_intangible_assets_ratio","dividend_payout_ratio","effective_tax_rate","days_sales_outstanding_dso","days_inventory_outstanding_dio","days_payable_outstanding_dpo","cash_conversion_cycle_ccc","revenue","equity_turnover_ratio","fixed_asset_turnover_ratio","accounts_receivable_turnover_ratio","inventory_turnover_ratio","accounts_payable_turnover_ratio","revenue_growth","gross_profit_growth","operating_profit_growth","net_income_growth","ebitda_growth","total_assets_growth","total_liabilities_growth","total_equity_growth","cash_flow_from_operations_cfo","capital_expenditures_capex","free_cash_flow_fcf"],"title":"RatioAnalysisRatiosSchema"},"RatioAnalysisSchema-Input":{"properties":{"statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Id"},"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, return as date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"period_length":{"type":"integer","title":"Period Length"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"is_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Is Reference"},"bs_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bs Reference"},"cf_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cf Reference"},"prev_is_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Is Reference"},"prev_bs_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Bs Reference"},"prev_cf_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Cf Reference"},"ratios":{"$ref":"#/components/schemas/RatioAnalysisRatiosSchema"},"custom_ratios":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/RatioAnalysisCustomItemSchema"},"type":"object"},{"type":"null"}],"title":"Custom Ratios","description":"The custom ratios that are not in the standard ratios list. The key is the ratio key, the value is the ratio item"}},"type":"object","required":["start_period","end_period","period_length","ratios"],"title":"RatioAnalysisSchema"},"RatioAnalysisSchema-Output":{"properties":{"statement_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Id"},"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, return as date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"period_length":{"type":"integer","title":"Period Length"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"is_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Is Reference"},"bs_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bs Reference"},"cf_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cf Reference"},"prev_is_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Is Reference"},"prev_bs_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Bs Reference"},"prev_cf_reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Cf Reference"},"ratios":{"$ref":"#/components/schemas/RatioAnalysisRatiosSchema"},"custom_ratios":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/RatioAnalysisCustomItemSchema"},"type":"object"},{"type":"null"}],"title":"Custom Ratios","description":"The custom ratios that are not in the standard ratios list. The key is the ratio key, the value is the ratio item"}},"type":"object","required":["start_period","end_period","period_length","ratios"],"title":"RatioAnalysisSchema"},"ReclassifySourceLineItemRequest":{"properties":{"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id"},"page_index":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Index"},"coa_account_key":{"type":"string","title":"Coa Account Key"},"particular":{"type":"string","title":"Particular"},"original_particular":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Particular"},"amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amount"},"contribution":{"type":"number","title":"Contribution","default":1.0},"str_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Str Value"},"bool_value":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Bool Value"},"date_value":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date Value"},"original_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Category"},"original_sub_category_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 1"},"original_sub_category_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 2"},"original_sub_category_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 3"},"is_non_recurring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Non Recurring"}},"type":"object","required":["coa_account_key","particular"],"title":"ReclassifySourceLineItemRequest","description":"Source line item for reclassification with account key."},"ReclassifyStatementRequest":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"Statement ID to reclassify"},"source_line_items":{"items":{"$ref":"#/components/schemas/ReclassifySourceLineItemRequest"},"type":"array","title":"Source Line Items","description":"List of ALL source line items for the statement with new account keys"}},"type":"object","required":["statement_id","source_line_items"],"title":"ReclassifyStatementRequest"},"ReclassifyStatementsRequest":{"properties":{"statements":{"items":{"$ref":"#/components/schemas/ReclassifyStatementRequest"},"type":"array","title":"Statements","description":"List of statements to reclassify"},"customer_id":{"type":"string","title":"Customer Id","description":"Customer ID in our system"}},"type":"object","required":["statements","customer_id"],"title":"ReclassifyStatementsRequest"},"ReclassifyStatementsRequestAsset":{"properties":{"statements":{"items":{"$ref":"#/components/schemas/ReclassifyStatementRequest"},"type":"array","title":"Statements","description":"List of statements to reclassify"},"asset_id":{"type":"string","title":"Asset Id","description":"Asset ID in our system"}},"type":"object","required":["statements","asset_id"],"title":"ReclassifyStatementsRequestAsset"},"ReclassifyStatementsRequestExt":{"properties":{"statements":{"items":{"$ref":"#/components/schemas/ReclassifyStatementRequest"},"type":"array","title":"Statements","description":"List of statements to reclassify"},"external_customer_id":{"type":"string","title":"External Customer Id","description":"External customer ID"}},"type":"object","required":["statements","external_customer_id"],"title":"ReclassifyStatementsRequestExt"},"RecordListResponse":{"properties":{"source_key":{"type":"string","title":"Source Key"},"records":{"items":{"$ref":"#/components/schemas/RecordSchema"},"type":"array","title":"Records"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"}},"type":"object","required":["source_key","records"],"title":"RecordListResponse"},"RecordSchema":{"properties":{"external_id":{"type":"string","title":"External Id"},"record_kind":{"type":"string","title":"Record Kind"},"standing":{"type":"string","title":"Standing"},"record_state":{"type":"string","title":"Record State"},"status_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Label"},"parent_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent External Id"},"metadata":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string","maxLength":512},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"type":"object"},{"type":"null"}],"title":"Metadata"},"legal_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Legal Name"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dba Name"},"registration_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Number","description":"As stored: normalized to digits, under an explicit country."},"registration_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registration Country"},"website_host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Website Host"},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address"},"searchable_address":{"type":"boolean","title":"Searchable Address","description":"Whether the address carries enough signal to be compared. A short one is kept but never matched on.","default":false},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"dob":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Dob"},"last_import_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Import Id"},"invalidated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Invalidated At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["external_id","record_kind","standing","record_state","updated_at"],"title":"RecordSchema"},"RecordUpsert":{"properties":{"external_id":{"type":"string","maxLength":255,"minLength":1,"title":"External Id"},"record_kind":{"anyOf":[{"type":"string","enum":["business","owner"]},{"type":"null"}],"title":"Record Kind","description":"Required unless record_state is 'invalidated'."},"record_state":{"type":"string","enum":["valid","invalidated"],"title":"Record State","default":"valid"},"standing":{"type":"string","enum":["active","closed","blocked"],"title":"Standing","description":"Your relationship with this record. All three are searchable: 'closed' still marks a duplicate, and 'blocked' is what makes a source a negative file.","default":"active"},"status_label":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Status Label"},"parent_external_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Parent External Id"},"metadata":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string","maxLength":512},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"propertyNames":{"maxLength":64,"minLength":1},"type":"object","maxProperties":25},{"type":"null"}],"title":"Metadata","description":"Anything else you want shown beside a match, in your words: the relationship manager, the portfolio, your case number. Flat key/value pairs with text, number or boolean values -- nothing nested, because the whole bag is rendered to a reviewer. It is never compared, never indexed, and never makes a record matchable. Replaced whole on each upsert, like every other field. Do not put a social security number here; keys that spell one are refused, and the bag is not the place for anything you would not want read on screen."},"legal_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Legal Name"},"dba_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Dba Name"},"registration_number":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Registration Number"},"registration_country":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Registration Country","description":"ISO-3166 alpha-2. Required with registration_number."},"website":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Website"},"address":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Address"},"first_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Last Name"},"email":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Email"},"dob":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Dob"}},"type":"object","required":["external_id"],"title":"RecordUpsert","description":"One record, as the org's system holds it.\n\nEvery identity field is REPLACED on write: one you leave out is cleared, not\nkept. That is what makes the feed say what your book currently says -- an\nEIN removed upstream has to stop matching here too.\n\nThe exception is ``record_state: invalidated``, which needs nothing but the\nexternal id, keeps the stored values for audit, and stops the record being\ncompared until a later upsert restores it."},"Reference":{"properties":{"source_type":{"type":"string","title":"Source Type"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"timestamp":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timestamp","description":" ISO 8601 format Timestamp when the research of the source was concluded."},"screenshots":{"anyOf":[{"items":{"$ref":"#/components/schemas/Screenshot"},"type":"array"},{"type":"null"}],"title":"Screenshots","description":"List of screenshots of the source. This is only available for website sources."}},"type":"object","required":["source_type","url","summary"],"title":"Reference"},"RegisterSourceRequest":{"properties":{"source_key":{"type":"string","maxLength":64,"minLength":1,"pattern":"^[a-z][a-z0-9_]*$","title":"Source Key","description":"The name a policy document points at: lower-case letters, digits and underscores, starting with a letter. Pinned forever by the first published document that names it, so it cannot be renamed."},"label":{"type":"string","maxLength":255,"minLength":1,"title":"Label"},"external_ids_are_customer_ids":{"type":"boolean","title":"External Ids Are Customer Ids","description":"True only if this source's external ids are the SAME ids sent as external_customer_id when creating customers. When true the search can recognise and exclude an applicant's own record; when false it cannot, so matches from this source are always reviewed by a person rather than acted on automatically.","default":false}},"type":"object","required":["source_key","label"],"title":"RegisterSourceRequest"},"RequestForInformationDocumentBase":{"properties":{"doc_id":{"type":"string","title":"Doc Id"},"doc_type":{"$ref":"#/components/schemas/DocumentType"},"description":{"type":"string","title":"Description","description":"Description of the document requested, e.g. `John Smith's Passport`."},"notes_to_client":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes To Client","description":"Additional notes to the client about the document, usually for re-request of a document, e.g. `Please provide a clear scan of the passport`."},"doc_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Name","description":"File name of the document file, e.g. `passport.jpg`."},"storage_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Storage Url","description":"The storage URL of the document file."},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"optional":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Optional","default":false}},"type":"object","required":["doc_id","doc_type","description"],"title":"RequestForInformationDocumentBase"},"RequestForInformationDocumentRequest":{"properties":{"doc_type":{"type":"string","enum":["Passport","Driver License","Proof of Address","Certificate of Incorporation","Tax Document","Banking Statement","Financial Statement"],"title":"Doc Type"},"description":{"type":"string","title":"Description","description":"The description of the document to request. Give the applicant right information to upload the document.\nFor example a passport document request description can be: 'Passport for John Walker'.\nThis will be showed to the receiver.\n"},"notes_to_client":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes To Client","description":"The detailed notes to the client, explaining why this document is requested"},"internal_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Notes","description":"The internal notes set to the flagged document."},"optional":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Optional","description":"Whether this document is optional or not for client to upload","default":false}},"type":"object","required":["doc_type","description"],"title":"RequestForInformationDocumentRequest"},"RequestRentRollType":{"type":"string","enum":["rent_roll"],"title":"RequestRentRollType"},"RequestStatementType":{"type":"string","enum":["income_statement","balance_sheet","cash_flow_statement"],"title":"RequestStatementType"},"RequestTaxFormType":{"type":"string","enum":["tax_return","k1_tax_return"],"title":"RequestTaxFormType"},"ResolutionMode":{"type":"string","enum":["link","create","link_or_create"],"title":"ResolutionMode","description":"How a reference resolves. Each mode fixes which selector keys are legal.\n\n``link``: an existing record, by ``id`` or ``external_id`` (one, not both);\n``obj`` is not accepted, and a reference that matches nothing fails the\nrequest with 404 reference_not_found.\n``create``: create from ``obj``; ``id`` and ``external_id`` are not\naccepted. For a business, an existing record in your organization with the\nsame legal name (case-insensitive) is linked instead of duplicated and\nreported as ``linked``; individuals are always created.\n``link_or_create``: resolve by ``external_id``; when nothing matches,\nproceed as ``create`` (business name match included) and stamp the external\nid on the resulting record; ``id`` is not accepted. The mode a CRM wants,\nsince it knows its own ids but not whether Accend has seen them."},"ResolutionOutcome":{"type":"string","enum":["created","linked","linked_flagged"],"title":"ResolutionOutcome","description":"How a reference actually resolved, reported back per object.\n\n``created``: a new record was made. ``linked``: an existing record was\nmatched. ``linked_flagged``: matched, and the entity carries a fraud\ndisposition; reachable only through an explicit ``id`` or ``external_id``,\nand linking never clears the disposition."},"ResolvedAssignments":{"properties":{"analyst":{"anyOf":[{"$ref":"#/components/schemas/ResolvedRef"},{"type":"null"}]},"secondary_analyst":{"anyOf":[{"$ref":"#/components/schemas/ResolvedRef"},{"type":"null"}]},"sales_rep":{"anyOf":[{"$ref":"#/components/schemas/ResolvedRef"},{"type":"null"}]}},"type":"object","title":"ResolvedAssignments","description":"Only what this call assigned.\n\nA slot the caller left empty is absent even though policy routing may fill\nit moments later — routing runs after the snapshot is written, so reporting\nit here would mean guessing at its outcome."},"ResolvedContactRef":{"properties":{"id":{"type":"string","title":"Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"resolution":{"$ref":"#/components/schemas/ResolutionOutcome"},"primary":{"type":"boolean","title":"Primary","default":false}},"type":"object","required":["id","resolution"],"title":"ResolvedContactRef"},"ResolvedPartyRef":{"properties":{"id":{"type":"string","title":"Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"resolution":{"$ref":"#/components/schemas/ResolutionOutcome"},"role":{"$ref":"#/components/schemas/AdditionalPartyRole"}},"type":"object","required":["id","resolution","role"],"title":"ResolvedPartyRef"},"ResolvedRef":{"properties":{"id":{"type":"string","title":"Id"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"resolution":{"$ref":"#/components/schemas/ResolutionOutcome"}},"type":"object","required":["id","resolution"],"title":"ResolvedRef"},"Screenshot":{"properties":{"source_url":{"type":"string","title":"Source Url"},"storage_url":{"type":"string","title":"Storage Url"}},"type":"object","required":["source_url","storage_url"],"title":"Screenshot"},"SearchAssetFinancialsRequest":{"properties":{"asset_id":{"type":"string","maxLength":255,"title":"Asset Id","description":"Asset ID in our system for the asset the case belongs to"},"searches":{"items":{"$ref":"#/components/schemas/CustomerFinancialsSearchCriteria"},"type":"array","title":"Searches","description":"Search criteria for the asset financials"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency to convert the financials to. If not provided, the financials will be returned in the asset's currency."},"full_history":{"type":"boolean","title":"Full History","description":"Return every statement instead of the entity's main collection, which holds one statement per period. In the chart-of-accounts search, each statement then lists its `collection_ids` and the response gives the entity's `main_collection_id`.","default":false}},"type":"object","required":["asset_id","searches"],"title":"SearchAssetFinancialsRequest"},"SearchCustomerFinancialsRequest":{"properties":{"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"searches":{"items":{"$ref":"#/components/schemas/CustomerFinancialsSearchCriteria"},"type":"array","title":"Searches","description":"Search criteria for the customer financials"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency to convert the financials to. If not provided, the financials will be returned in the customer's currency."},"full_history":{"type":"boolean","title":"Full History","description":"Return every statement instead of the entity's main collection, which holds one statement per period. In the chart-of-accounts search, each statement then lists its `collection_ids` and the response gives the entity's `main_collection_id`.","default":false}},"type":"object","required":["customer_id","searches"],"title":"SearchCustomerFinancialsRequest"},"SearchCustomerFinancialsRequestExt":{"properties":{"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"external customer id for the customer the financials belongs to"},"searches":{"items":{"$ref":"#/components/schemas/CustomerFinancialsSearchCriteria"},"type":"array","title":"Searches","description":"Search criteria for the customer financials"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"Target currency to convert the financials to. If not provided, the financials will be returned in the customer's currency."},"full_history":{"type":"boolean","title":"Full History","description":"Return every statement instead of the entity's main collection, which holds one statement per period. In the chart-of-accounts search, each statement then lists its `collection_ids` and the response gives the entity's `main_collection_id`.","default":false}},"type":"object","required":["external_customer_id","searches"],"title":"SearchCustomerFinancialsRequestExt"},"SearchCustomerFinancialsResponse":{"properties":{"basic_info":{"$ref":"#/components/schemas/SpreadingCustomerBasicInfoSchema"},"search_results":{"items":{"$ref":"#/components/schemas/SpreadingCustomerFinancialsSearchResultSchema"},"type":"array","title":"Search Results"}},"type":"object","required":["basic_info","search_results"],"title":"SearchCustomerFinancialsResponse"},"SearchResult":{"properties":{"search_id":{"type":"string","title":"Search Id","description":"Search ID"},"statements":{"items":{"$ref":"#/components/schemas/CoaStatementWithSourcesSchema-Output"},"type":"array","title":"Statements","description":"List of financial statements"}},"type":"object","required":["search_id","statements"],"title":"SearchResult"},"SearchStatementsResponse":{"properties":{"search_results":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array","title":"Search Results","description":"List of financial statements"},"chart_of_accounts":{"$ref":"#/components/schemas/ChartOfAccountsSchema-Output","description":"Chart of accounts"},"main_collection_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Collection Id","description":"Id of the entity's main collection. Set with `full_history`: a statement is in the main collection when its `collection_ids` holds this id."}},"type":"object","required":["search_results","chart_of_accounts"],"title":"SearchStatementsResponse"},"SetCombinedFinancialsRequest":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Whether the customer's financials combine its contributing customers'."},"contributing_entities":{"items":{"$ref":"#/components/schemas/ContributingEntityInput"},"type":"array","title":"Contributing Entities","description":"The customers whose financials roll up into this customer's, each listed once. Replaces the current list. Must be empty when `enabled` is false, which clears the list."}},"type":"object","required":["enabled"],"title":"SetCombinedFinancialsRequest"},"SignalDataType":{"type":"string","enum":["string","float","boolean","integer"],"title":"SignalDataType"},"SignalLevel":{"type":"string","enum":["primary","secondary"],"title":"SignalLevel"},"SignalLocation":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"The unique identifier of the statement"},"statement_type":{"type":"string","title":"Statement Type","description":"The type of statement (income_statement, balance_sheet, cash_flow_statement, ratio_analysis)"}},"type":"object","required":["statement_id","statement_type"],"title":"SignalLocation"},"SignalSupportingData":{"properties":{"key":{"type":"string","title":"Key","description":"The key identifier for the supporting data"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"integer"}],"title":"Value","description":"The actual value of the supporting data"},"data_type":{"$ref":"#/components/schemas/SignalDataType","description":"The data type of the value"}},"type":"object","required":["key","value","data_type"],"title":"SignalSupportingData"},"SimplifiedPeriodSpreadingRequest-Input":{"properties":{"included_statements":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestStatementType"},"type":"array"},{"type":"null"}],"title":"Included Statements","description":"Financial statements to include"},"included_tax_returns":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestTaxFormType"},"type":"array"},{"type":"null"}],"title":"Included Tax Returns","description":"Tax document types to include. `tax_return` refers to the entity's primary return (e.g., 1040 for individuals, 1120/1065 for businesses)."},"included_rent_rolls":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestRentRollType"},"type":"array"},{"type":"null"}],"title":"Included Rent Rolls","description":"Rent roll types to include"},"fin_stmt_request_periods":{"items":{"anyOf":[{"$ref":"#/components/schemas/FinStmtSpreadCalendarYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadTrailingPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYTDPeriod"}]},"type":"array","title":"Fin Stmt Request Periods"},"most_recent_period":{"anyOf":[{"$ref":"#/components/schemas/FinStmtSpreadCalendarYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYearPeriod"}],"title":"Most Recent Period"}},"type":"object","required":["fin_stmt_request_periods","most_recent_period"],"title":"SimplifiedPeriodSpreadingRequest"},"SimplifiedPeriodSpreadingRequest-Output":{"properties":{"included_statements":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestStatementType"},"type":"array"},{"type":"null"}],"title":"Included Statements","description":"Financial statements to include"},"included_tax_returns":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestTaxFormType"},"type":"array"},{"type":"null"}],"title":"Included Tax Returns","description":"Tax document types to include. `tax_return` refers to the entity's primary return (e.g., 1040 for individuals, 1120/1065 for businesses)."},"included_rent_rolls":{"anyOf":[{"items":{"$ref":"#/components/schemas/RequestRentRollType"},"type":"array"},{"type":"null"}],"title":"Included Rent Rolls","description":"Rent roll types to include"},"fin_stmt_request_periods":{"items":{"anyOf":[{"$ref":"#/components/schemas/FinStmtSpreadCalendarYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadTrailingPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYTDPeriod"}]},"type":"array","title":"Fin Stmt Request Periods"},"most_recent_period":{"anyOf":[{"$ref":"#/components/schemas/FinStmtSpreadCalendarYearPeriod"},{"$ref":"#/components/schemas/FinStmtSpreadFiscalYearPeriod"}],"title":"Most Recent Period"}},"type":"object","required":["fin_stmt_request_periods","most_recent_period"],"title":"SimplifiedPeriodSpreadingRequest"},"SourceListResponse":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/SourceSchema"},"type":"array","title":"Sources"}},"type":"object","required":["sources"],"title":"SourceListResponse"},"SourceMLineItemSchema":{"properties":{"value":{"$ref":"#/components/schemas/SourceMLineItemValueSchema"}},"type":"object","required":["value"],"title":"SourceMLineItemSchema"},"SourceMLineItemValueSchema":{"properties":{"value":{"type":"number","title":"Value","description":"The amount of the line item"},"currency":{"type":"string","title":"Currency","description":"The currency of the line item"}},"type":"object","required":["value","currency"],"title":"SourceMLineItemValueSchema"},"SourceMLineItemsSchema":{"properties":{"account":{"additionalProperties":{"$ref":"#/components/schemas/SourceMLineItemSchema"},"type":"object","title":"Account","description":"The line items of the financial data"}},"type":"object","required":["account"],"title":"SourceMLineItemsSchema"},"SourceSchema":{"properties":{"source_key":{"type":"string","title":"Source Key"},"label":{"type":"string","title":"Label"},"state":{"type":"string","title":"State","description":"uninitialized | importing | ready | incomplete. Only 'ready' is searched: a source mid-import or left partially loaded is reported as unusable to the workflow rather than read as 'no matches'."},"external_ids_are_customer_ids":{"type":"boolean","title":"External Ids Are Customer Ids"},"open_import_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Open Import Id"},"record_count":{"type":"integer","title":"Record Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["source_key","label","state","external_ids_are_customer_ids","created_at","updated_at"],"title":"SourceSchema"},"SpreadingCaseAllPeriodsSchema-Input":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/IncomeStatementSchema-Input"},"type":"array","title":"Income Statements","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/BalanceSheetSchema-Input"},"type":"array","title":"Balance Sheets","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/CashFlowStatementSchema-Input"},"type":"array","title":"Cash Flow Statements","default":[]}},"type":"object","title":"SpreadingCaseAllPeriodsSchema","description":"The deliverable of a Spread case"},"SpreadingCaseAllPeriodsSchema-Output":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/IncomeStatementSchema-Output"},"type":"array","title":"Income Statements","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/BalanceSheetSchema-Output"},"type":"array","title":"Balance Sheets","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/CashFlowStatementSchema-Output"},"type":"array","title":"Cash Flow Statements","default":[]}},"type":"object","title":"SpreadingCaseAllPeriodsSchema","description":"The deliverable of a Spread case"},"SpreadingCaseBasicInfoSchema":{"properties":{"case_id":{"type":"string","title":"Case Id"},"customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Id"},"asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Asset Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"legal_name":{"type":"string","title":"Legal Name"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dba Name"},"fiscal_year_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Fiscal Year Start","description":"[Deprecated]The start date of the fiscal year, return as date in isoformat","deprecated":true},"fiscal_year_start_month":{"$ref":"#/components/schemas/MonthType","description":"The start month of the fiscal year","default":"january"},"currency":{"type":"string","title":"Currency","description":"The original currency of the financial statements","default":"USD"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency","description":"The target converted currency of the financial statements"},"currency_units":{"type":"number","title":"Currency Units","default":1}},"type":"object","required":["case_id","legal_name"],"title":"SpreadingCaseBasicInfoSchema"},"SpreadingCaseDeliverablesSchema-Input":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/IncomeStatementSchema-Input"},"type":"array","title":"Income Statements","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/BalanceSheetSchema-Input"},"type":"array","title":"Balance Sheets","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/CashFlowStatementSchema-Input"},"type":"array","title":"Cash Flow Statements","default":[]},"ratio_analysis":{"items":{"$ref":"#/components/schemas/RatioAnalysisSchema-Input"},"type":"array","title":"Ratio Analysis","default":[]}},"type":"object","title":"SpreadingCaseDeliverablesSchema","description":"The deliverable of a Spread case"},"SpreadingCaseDeliverablesSchema-Output":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/IncomeStatementSchema-Output"},"type":"array","title":"Income Statements","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/BalanceSheetSchema-Output"},"type":"array","title":"Balance Sheets","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/CashFlowStatementSchema-Output"},"type":"array","title":"Cash Flow Statements","default":[]},"ratio_analysis":{"items":{"$ref":"#/components/schemas/RatioAnalysisSchema-Output"},"type":"array","title":"Ratio Analysis","default":[]}},"type":"object","title":"SpreadingCaseDeliverablesSchema","description":"The deliverable of a Spread case"},"SpreadingCaseFinancialStatementsResultSchema-Input":{"properties":{"deliverables":{"$ref":"#/components/schemas/SpreadingCaseDeliverablesSchema-Input","description":"The deliverables of the case","default":{"income_statements":[],"balance_sheets":[],"cash_flow_statements":[],"ratio_analysis":[]}},"all_periods":{"$ref":"#/components/schemas/SpreadingCaseAllPeriodsSchema-Input","default":{"income_statements":[],"balance_sheets":[],"cash_flow_statements":[]}},"grouping_suggestions":{"$ref":"#/components/schemas/SpreadingCaseGroupingStructureSchema-Input","description":"The suggested groupings for financial statements line items","default":{"income_statement":[],"balance_sheet":{"assets":[],"liabilities_and_equity":[]},"cash_flow_statement":[]}},"source_data":{"$ref":"#/components/schemas/SpreadingCaseSourceDataSchema-Input","description":"The source data of the case","default":{"income_statements":[],"balance_sheets":[],"cash_flow_statements":[]}},"rolling_statements_source_data":{"anyOf":[{"$ref":"#/components/schemas/SpreadingCaseRollingStatementsSourceDataSchema-Input"},{"type":"null"}],"description":"The source data of the rolling statements"},"custom_ratios_formulae":{"anyOf":[{"items":{"$ref":"#/components/schemas/CustomRatioFormulaSchema"},"type":"array"},{"type":"null"}],"title":"Custom Ratios Formulae"}},"type":"object","title":"SpreadingCaseFinancialStatementsResultSchema"},"SpreadingCaseFinancialStatementsResultSchema-Output":{"properties":{"deliverables":{"$ref":"#/components/schemas/SpreadingCaseDeliverablesSchema-Output","description":"The deliverables of the case","default":{"income_statements":[],"balance_sheets":[],"cash_flow_statements":[],"ratio_analysis":[]}},"all_periods":{"$ref":"#/components/schemas/SpreadingCaseAllPeriodsSchema-Output","default":{"income_statements":[],"balance_sheets":[],"cash_flow_statements":[]}},"grouping_suggestions":{"$ref":"#/components/schemas/SpreadingCaseGroupingStructureSchema-Output","description":"The suggested groupings for financial statements line items","default":{"income_statement":[],"balance_sheet":{"assets":[],"liabilities_and_equity":[]},"cash_flow_statement":[]}},"source_data":{"$ref":"#/components/schemas/SpreadingCaseSourceDataSchema-Output","description":"The source data of the case","default":{"income_statements":[],"balance_sheets":[],"cash_flow_statements":[]}},"rolling_statements_source_data":{"anyOf":[{"$ref":"#/components/schemas/SpreadingCaseRollingStatementsSourceDataSchema-Output"},{"type":"null"}],"description":"The source data of the rolling statements"},"custom_ratios_formulae":{"anyOf":[{"items":{"$ref":"#/components/schemas/CustomRatioFormulaSchema"},"type":"array"},{"type":"null"}],"title":"Custom Ratios Formulae"}},"type":"object","title":"SpreadingCaseFinancialStatementsResultSchema"},"SpreadingCaseGroupingStructureSchema-Input":{"properties":{"income_statement":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Input"},"type":"array","title":"Income Statement","default":[]},"balance_sheet":{"$ref":"#/components/schemas/BalanceSheetGroupingStructureSchema-Input","default":{"assets":[],"liabilities_and_equity":[]}},"cash_flow_statement":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Input"},"type":"array","title":"Cash Flow Statement","default":[]}},"type":"object","title":"SpreadingCaseGroupingStructureSchema","description":"Our recommended groupings for financial statements organizes line items into groups for improved analysis and visualization."},"SpreadingCaseGroupingStructureSchema-Output":{"properties":{"income_statement":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Output"},"type":"array","title":"Income Statement","default":[]},"balance_sheet":{"$ref":"#/components/schemas/BalanceSheetGroupingStructureSchema-Output","default":{"assets":[],"liabilities_and_equity":[]}},"cash_flow_statement":{"items":{"$ref":"#/components/schemas/GroupingStructureGroupSchema-Output"},"type":"array","title":"Cash Flow Statement","default":[]}},"type":"object","title":"SpreadingCaseGroupingStructureSchema","description":"Our recommended groupings for financial statements organizes line items into groups for improved analysis and visualization."},"SpreadingCaseResultSchema":{"properties":{"version":{"type":"string","title":"Version","description":"The version of the spreading result schema"},"basic_info":{"$ref":"#/components/schemas/SpreadingCaseBasicInfoSchema"},"financial_statements":{"$ref":"#/components/schemas/SpreadingCaseFinancialStatementsResultSchema-Output","description":"The financial statements data of the case","default":{"deliverables":{"balance_sheets":[],"cash_flow_statements":[],"income_statements":[],"ratio_analysis":[]},"all_periods":{"balance_sheets":[],"cash_flow_statements":[],"income_statements":[]},"grouping_suggestions":{"balance_sheet":{"assets":[],"liabilities_and_equity":[]},"cash_flow_statement":[],"income_statement":[]},"source_data":{"balance_sheets":[],"cash_flow_statements":[],"income_statements":[]}}},"bank_statements":{"anyOf":[{"$ref":"#/components/schemas/BankStatementsDeliverables-Output"},{"type":"null"}]}},"type":"object","required":["version","basic_info"],"title":"SpreadingCaseResultSchema"},"SpreadingCaseResultWithCoaSchema-Input":{"properties":{"version":{"type":"string","title":"Version","description":"The version of the spreading result schema"},"banking":{"anyOf":[{"$ref":"#/components/schemas/CaseBankingResult-Input"},{"type":"null"}],"description":"Banking derived from the bank records this case waited on, scoped to its own documents. Present on completed cases."},"basic_info":{"$ref":"#/components/schemas/SpreadingCaseBasicInfoSchema"},"financial_statements":{"anyOf":[{"$ref":"#/components/schemas/SpreadingCaseFinancialStatementsResultSchema-Input"},{"type":"null"}],"description":"Standard financial statements for customers using the 'general business' template. You can use this data if you only use 'general business' financial template.Accend recommends using this data field over coa_statements for more flexibility and future supports."},"bank_statements":{"anyOf":[{"$ref":"#/components/schemas/BankStatementsDeliverables-Input"},{"type":"null"}],"description":"**Deprecated — use `banking`.** Produced by an earlier extraction path, and therefore empty for any case whose statements went through the current one. `banking` answers the same question from the bank records the case actually waited on.\n\nStill populated for existing consumers, and removed once they migrate. Do not build anything new on it.","deprecated":true},"coa_statements":{"anyOf":[{"$ref":"#/components/schemas/CoaStatementsWithChartOfAccountsWithDeliverablesSchema-Input"},{"type":"null"}],"description":"Financial statements using Accend's chart of accounts structure. You should use this format for cases that go beyond the 'general business' template—such as individual, property, asset, or custom CoA-based financials.Accend recommends using this data field over financial_statements."}},"type":"object","required":["version","basic_info"],"title":"SpreadingCaseResultWithCoaSchema"},"SpreadingCaseResultWithCoaSchema-Output":{"properties":{"version":{"type":"string","title":"Version","description":"The version of the spreading result schema"},"banking":{"anyOf":[{"$ref":"#/components/schemas/CaseBankingResult-Output"},{"type":"null"}],"description":"Banking derived from the bank records this case waited on, scoped to its own documents. Present on completed cases."},"basic_info":{"$ref":"#/components/schemas/SpreadingCaseBasicInfoSchema"},"financial_statements":{"anyOf":[{"$ref":"#/components/schemas/SpreadingCaseFinancialStatementsResultSchema-Output"},{"type":"null"}],"description":"Standard financial statements for customers using the 'general business' template. You can use this data if you only use 'general business' financial template.Accend recommends using this data field over coa_statements for more flexibility and future supports."},"bank_statements":{"anyOf":[{"$ref":"#/components/schemas/BankStatementsDeliverables-Output"},{"type":"null"}],"description":"**Deprecated — use `banking`.** Produced by an earlier extraction path, and therefore empty for any case whose statements went through the current one. `banking` answers the same question from the bank records the case actually waited on.\n\nStill populated for existing consumers, and removed once they migrate. Do not build anything new on it.","deprecated":true},"coa_statements":{"anyOf":[{"$ref":"#/components/schemas/CoaStatementsWithChartOfAccountsWithDeliverablesSchema-Output"},{"type":"null"}],"description":"Financial statements using Accend's chart of accounts structure. You should use this format for cases that go beyond the 'general business' template—such as individual, property, asset, or custom CoA-based financials.Accend recommends using this data field over financial_statements."}},"type":"object","required":["version","basic_info"],"title":"SpreadingCaseResultWithCoaSchema"},"SpreadingCaseRollingStatementsSourceDataSchema-Input":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataIncomeStatementSchema"},"type":"array","title":"Income Statements","default":[]}},"type":"object","title":"SpreadingCaseRollingStatementsSourceDataSchema","description":"The source data of a spreading case. The ones with 'cleaned' prefix are the cleaned data after the data cleaning process."},"SpreadingCaseRollingStatementsSourceDataSchema-Output":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataIncomeStatementSchema"},"type":"array","title":"Income Statements","default":[]}},"type":"object","title":"SpreadingCaseRollingStatementsSourceDataSchema","description":"The source data of a spreading case. The ones with 'cleaned' prefix are the cleaned data after the data cleaning process."},"SpreadingCaseSourceDataBalanceSheetSchema":{"properties":{"statement_id":{"type":"string","title":"Statement Id"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"document_type":{"type":"string","title":"Document Type"},"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"assets_cleaned_line_items":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemSchema"},"type":"array","title":"Assets Cleaned Line Items"},"liabilities_and_equity_cleaned_line_items":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemSchema"},"type":"array","title":"Liabilities And Equity Cleaned Line Items"},"other_cleaned_line_items":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemSchema"},"type":"array","title":"Other Cleaned Line Items","description":"The cleaned line items that are not in the assets or liabilities and equity","default":[]},"reported_key_totals":{"anyOf":[{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemKeyTotalSchema"},"type":"array"},{"type":"null"}],"title":"Reported Key Totals"}},"type":"object","required":["statement_id","end_period","document_type","assets_cleaned_line_items","liabilities_and_equity_cleaned_line_items"],"title":"SpreadingCaseSourceDataBalanceSheetSchema"},"SpreadingCaseSourceDataCashFlowStatementSchema":{"properties":{"statement_id":{"type":"string","title":"Statement Id"},"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, return as date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"period_length":{"type":"integer","title":"Period Length"},"document_type":{"type":"string","title":"Document Type","description":"The statement type: Audited, Unaudited, Tax Form 1065, etc."},"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"cleaned_line_items":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemSchema"},"type":"array","title":"Cleaned Line Items"},"reported_key_totals":{"anyOf":[{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemKeyTotalSchema"},"type":"array"},{"type":"null"}],"title":"Reported Key Totals"}},"type":"object","required":["statement_id","start_period","end_period","period_length","document_type","cleaned_line_items"],"title":"SpreadingCaseSourceDataCashFlowStatementSchema"},"SpreadingCaseSourceDataIncomeStatementSchema":{"properties":{"statement_id":{"type":"string","title":"Statement Id"},"start_period":{"type":"string","format":"date-time","title":"Start Period","description":"The start date of the period, return as date in isoformat"},"end_period":{"type":"string","format":"date-time","title":"End Period","description":"The end date of the period, return as date in isoformat"},"period_length":{"type":"integer","title":"Period Length"},"document_type":{"type":"string","title":"Document Type"},"cust_doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cust Doc Id"},"data_type":{"anyOf":[{"$ref":"#/components/schemas/IncomeStatementDataType"},{"type":"null"}]},"statement_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement From"},"cleaned_line_items":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemSchema"},"type":"array","title":"Cleaned Line Items"},"reported_key_totals":{"anyOf":[{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceItemKeyTotalSchema"},"type":"array"},{"type":"null"}],"title":"Reported Key Totals"}},"type":"object","required":["statement_id","start_period","end_period","period_length","document_type","cleaned_line_items"],"title":"SpreadingCaseSourceDataIncomeStatementSchema"},"SpreadingCaseSourceDataSchema-Input":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataIncomeStatementSchema"},"type":"array","title":"Income Statements","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataBalanceSheetSchema"},"type":"array","title":"Balance Sheets","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataCashFlowStatementSchema"},"type":"array","title":"Cash Flow Statements","default":[]}},"type":"object","title":"SpreadingCaseSourceDataSchema","description":"The source data of a spreading case. The ones with 'cleaned' prefix are the cleaned data after the data cleaning process."},"SpreadingCaseSourceDataSchema-Output":{"properties":{"income_statements":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataIncomeStatementSchema"},"type":"array","title":"Income Statements","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataBalanceSheetSchema"},"type":"array","title":"Balance Sheets","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/SpreadingCaseSourceDataCashFlowStatementSchema"},"type":"array","title":"Cash Flow Statements","default":[]}},"type":"object","title":"SpreadingCaseSourceDataSchema","description":"The source data of a spreading case. The ones with 'cleaned' prefix are the cleaned data after the data cleaning process."},"SpreadingCaseSourceItemKeyTotalSchema":{"properties":{"particular":{"type":"string","title":"Particular"},"amount":{"type":"number","title":"Amount"}},"type":"object","required":["particular","amount"],"title":"SpreadingCaseSourceItemKeyTotalSchema"},"SpreadingCaseSourceItemSchema":{"properties":{"particular":{"type":"string","title":"Particular"},"original_particular":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Particular","description":"The original particular of the line item from the raw data. The data could not be accurate, it's used for reference only, not for analysis"},"statement_mapping":{"type":"string","title":"Statement Mapping","description":"The standard statement mapping of the line item"},"custom_account_mapping":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Custom Account Mapping","description":"The custom account mapping of the line item if custom account group is used"},"amount":{"type":"number","title":"Amount"},"original_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Category","description":"The original category of the line item from the raw data. The data could not be accurate, it's used for reference only, not for analysis"},"original_sub_category_1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 1","description":"The original sub-category 1 of the line item from the raw data. The data could not be accurate, it's used for reference only, not for analysis"},"original_sub_category_2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 2","description":"The original sub-category 2 of the line item from the raw data. The data could not be accurate, it's used for reference only, not for analysis"},"original_sub_category_3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Sub Category 3","description":"The original sub-category 3 of the line item from the raw data. The data could not be accurate, it's used for reference only, not for analysis"}},"type":"object","required":["particular","statement_mapping","amount"],"title":"SpreadingCaseSourceItemSchema"},"SpreadingCustomerBasicInfoSchema":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Customer Id"},"legal_name":{"type":"string","title":"Legal Name"},"dba_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dba Name"},"fiscal_year_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Fiscal Year Start","description":"[Deprecated] The start date of the fiscal year, return as date in isoformat","deprecated":true},"fiscal_year_start_month":{"$ref":"#/components/schemas/MonthType","description":"The start month of the fiscal year"},"currency":{"type":"string","title":"Currency"},"target_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Currency"},"currency_units":{"type":"number","title":"Currency Units","default":1}},"type":"object","required":["customer_id","legal_name","fiscal_year_start_month","currency"],"title":"SpreadingCustomerBasicInfoSchema"},"SpreadingCustomerFinancialsSearchResultSchema":{"properties":{"search_id":{"type":"string","title":"Search Id"},"income_statements":{"items":{"$ref":"#/components/schemas/IncomeStatementSchema-Output"},"type":"array","title":"Income Statements","default":[]},"balance_sheets":{"items":{"$ref":"#/components/schemas/BalanceSheetSchema-Output"},"type":"array","title":"Balance Sheets","default":[]},"cash_flow_statements":{"items":{"$ref":"#/components/schemas/CashFlowStatementSchema-Output"},"type":"array","title":"Cash Flow Statements","default":[]},"ratio_analysis":{"items":{"$ref":"#/components/schemas/RatioAnalysisSchema-Output"},"type":"array","title":"Ratio Analysis","default":[]}},"type":"object","required":["search_id"],"title":"SpreadingCustomerFinancialsSearchResultSchema","description":"The deliverable of a Spread case"},"StartEventReceipt":{"properties":{"idempotency_key":{"type":"string","title":"Idempotency Key"},"event":{"$ref":"#/components/schemas/PartnerEvent"},"event_url":{"type":"string","title":"Event Url"}},"type":"object","required":["idempotency_key","event","event_url"],"title":"StartEventReceipt"},"StartEventRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"event_type":{"type":"string","enum":["onboarding","periodic_review","credit_line_increase"],"title":"Event Type"},"period":{"anyOf":[{"type":"string","maxLength":16,"minLength":1},{"type":"null"}],"title":"Period"}},"additionalProperties":false,"type":"object","required":["idempotency_key","event_type"],"title":"StartEventRequest","examples":[{"event_type":"onboarding","idempotency_key":"start-001"}]},"StatementAccountOverrideUpsert":{"properties":{"statement_id":{"type":"string","title":"Statement Id","description":"Statement ID to apply account overrides to"},"account_overrides":{"items":{"$ref":"#/components/schemas/AccountOverride"},"type":"array","title":"Account Overrides","description":"List of account-level overrides to upsert, provided value's data type has to match the account data type"}},"type":"object","required":["statement_id","account_overrides"],"title":"StatementAccountOverrideUpsert"},"StatementClassGroupingSchema":{"properties":{"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"class_keys":{"items":{"type":"string"},"type":"array","title":"Class Keys"}},"type":"object","required":["key","name","class_keys"],"title":"StatementClassGroupingSchema"},"StatementStatus":{"type":"string","enum":["active","archived"],"title":"StatementStatus"},"StatementType":{"type":"string","enum":["income_statement","balance_sheet_assets","balance_sheet_liabilities_and_equity","balance_sheet_other_items","cash_flow_statement","income_statement_other_items","ratios_analysis"],"title":"StatementType"},"StrictAttachRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"mode":{"type":"string","const":"strict","title":"Mode"},"document_sets":{"items":{"$ref":"#/components/schemas/StrictDocumentSet"},"type":"array","maxItems":50,"minItems":1,"title":"Document Sets"}},"additionalProperties":false,"type":"object","required":["idempotency_key","mode","document_sets"],"title":"StrictAttachRequest","examples":[{"document_sets":[{"entity_id":"sp_cust_demo","replacements":[{"document_id":"doc_new","replaces_document_id":"doc_old"}],"requirements":[{"document_ids":["doc_new"],"requirement_id":"requirement_789"}]}],"idempotency_key":"replace-002","mode":"strict"}]},"StrictDocumentSet":{"properties":{"entity_id":{"type":"string","maxLength":255,"minLength":1,"title":"Entity Id"},"requirements":{"items":{"$ref":"#/components/schemas/StrictRequirementAttachment"},"type":"array","maxItems":100,"minItems":1,"title":"Requirements"},"replacements":{"items":{"$ref":"#/components/schemas/EvidenceReplacement"},"type":"array","maxItems":100,"title":"Replacements"}},"additionalProperties":false,"type":"object","required":["entity_id","requirements"],"title":"StrictDocumentSet"},"StrictRequirementAttachment":{"properties":{"requirement_id":{"type":"string","maxLength":255,"minLength":1,"title":"Requirement Id"},"document_ids":{"items":{"type":"string"},"type":"array","maxItems":100,"minItems":1,"title":"Document Ids"}},"additionalProperties":false,"type":"object","required":["requirement_id","document_ids"],"title":"StrictRequirementAttachment"},"StructuredErrorResponse":{"properties":{"code":{"type":"string","title":"Code","description":"Stable machine-readable identifier. Branch on this, never on message."},"message":{"type":"string","title":"Message"},"field":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Field","description":"JSON path to the offending field, e.g. loans[1].external_id, when the error is about one."},"candidates":{"items":{"type":"string"},"type":"array","title":"Candidates","description":"Ids the caller can choose between, on duplicate_deal_candidates, ambiguous_user, external_deal_id_taken and the identity conflicts. Empty otherwise."},"request_id":{"type":"string","title":"Request Id","description":"For support correlation. Echoes the request's x-request-id header when one was sent, else a fresh id."}},"type":"object","required":["code","message","request_id"],"title":"StructuredErrorResponse","description":"The body of every structured error, as the handler in ``app.py`` emits it.\n\nExists for the OpenAPI document only -- the handler builds the dict itself,\nso this is what an SDK is generated from and the two must stay in step."},"SubmitExternalFeedbackRequest":{"properties":{"case_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Case Id","description":"The case id tied to this feedback"},"idempotency_key":{"type":"string","title":"Idempotency Key","description":"The idempotency key for this request."},"feedback":{"type":"string","title":"Feedback","description":"The feedback for the AI analysis for this section of the case."},"section_type":{"type":"string","enum":["industry_classification","industry_risk_report","ownership_risk_classification","ownership_beneficial_owner_match"],"title":"Section Type"}},"type":"object","required":["idempotency_key","feedback","section_type"],"title":"SubmitExternalFeedbackRequest"},"SubmitInformationAction":{"properties":{"type":{"type":"string","const":"submit_information","title":"Type","default":"submit_information"},"method":{"type":"string","const":"POST","title":"Method","default":"POST"},"information_request_id":{"type":"string","title":"Information Request Id"},"url":{"type":"string","title":"Url"},"document_sets":{"items":{"$ref":"#/components/schemas/PartnerDocumentSet"},"type":"array","title":"Document Sets"}},"type":"object","required":["information_request_id","url","document_sets"],"title":"SubmitInformationAction"},"SubmitInformationRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"entity_ids":{"items":{"type":"string"},"type":"array","maxItems":50,"minItems":1,"title":"Entity Ids"},"waive_all_reqs":{"type":"boolean","title":"Waive All Reqs","description":"Waive every live document requirement on this information request as part of submission. Requires all active entity sets to be selected and open, and an organization integration token. Survives classification; reopening the set or changing the requirement invalidates it. Does not waive hosted forms, credit rules or human decisions.","default":false}},"additionalProperties":false,"type":"object","required":["idempotency_key","entity_ids"],"title":"SubmitInformationRequest","examples":[{"entity_ids":["sp_cust_demo"],"idempotency_key":"submit-003","waive_all_reqs":false}]},"TamperRiskKind":{"type":"string","enum":["content_altered","file_modified","sample_content","known_fraud_template","other"],"title":"TamperRiskKind","description":"What a tamper finding says, in our vocabulary rather than a supplier's."},"TaskUserSchema":{"properties":{"user_id":{"type":"string","title":"User Id"},"name":{"type":"string","title":"Name"},"email":{"type":"string","title":"Email"},"picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Picture"}},"type":"object","required":["user_id","name","email"],"title":"TaskUserSchema"},"TemplateVersionedID":{"properties":{"template_id":{"type":"string","title":"Template Id","description":"ID of the template. If not provided, the key will be used.","default":""},"template_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Key","description":"Key of the template. If not provided, the template ID will be used."},"version_hash":{"type":"string","title":"Version Hash","description":"Hash of the template version. If not provided, the current pinned version will be used.","default":""}},"type":"object","title":"TemplateVersionedID"},"ThresholdConfig":{"properties":{"threshold":{"type":"number","title":"Threshold","description":"Primary threshold in percentage","default":0.1}},"type":"object","title":"ThresholdConfig"},"TransactionType":{"type":"string","enum":["CREDITS","DEBITS"],"title":"TransactionType"},"UnderwritingCasePrepareBy":{"type":"string","enum":["accend","self_prepared"],"title":"UnderwritingCasePrepareBy"},"UpdateCustomerRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system"},"update_fields":{"$ref":"#/components/schemas/UpdateCustomerRequestUpdateFields"}},"type":"object","required":["idempotency_key","customer_id","update_fields"],"title":"UpdateCustomerRequest"},"UpdateCustomerRequestExt":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"Customer ID from your system or customer ID you want to use to identify the customer in our system"},"update_fields":{"$ref":"#/components/schemas/UpdateCustomerRequestUpdateFields"}},"type":"object","required":["idempotency_key","external_customer_id","update_fields"],"title":"UpdateCustomerRequestExt"},"UpdateCustomerRequestUpdateFields":{"properties":{"external_customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id","description":"Customer ID from your system or customer ID you want to use to identify the customer in our system"},"legal_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Legal Name","description":"Company Legal name of the customer"},"dba_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Dba Name","description":"Company Doing Business As name"},"website":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Website","description":"Company website"},"address":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Address","description":"Company address"},"fiscal_year_start_month":{"anyOf":[{"$ref":"#/components/schemas/MonthType"},{"type":"null"}]},"enabled_combined_financials":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled Combined Financials","description":"Whether the company's financials are enabled for combined financials. To set the contributing customers too, use `PUT /api/v1/financials/customers/{customer_id}/combined_financials`."},"ticker":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Ticker","description":"Public company ticker, e.g. AAPL"},"legal_structure":{"anyOf":[{"$ref":"#/components/schemas/LegalStructure"},{"type":"null"}],"description":"Legal structure. One of: `c_corp`: C Corporation; `s_corp`: S Corporation; `close_corp`: Close Corporation; `professional_corp`: Professional Corporation (PC); `benefit_corp`: Benefit Corporation / Public Benefit Corporation (For-Profit); `publicly_traded_corp`: Publicly Traded Corporation; `alien_corp`: Alien Corporation; `cooperative`: Cooperative (Incorporated); `partnership`: General Partnership (GP); `limited_partnership`: Limited Partnership (LP); `llp`: Limited Liability Partnership (LLP); `lllp`: Limited Liability Limited Partnership (LLLP); `llc`: Limited Liability Company (LLC); `pllc`: Professional Limited Liability Company (PLLC); `sole_prop`: Sole Proprietorship; `non_profit`: Nonprofit / Not-for-Profit Organization; `private_school`: Private School; `public_school`: Public School / School District; `government`: Government Entity; `public_authority`: Public Authority / Quasi-Public Corporation; `trust`: Trust; `unincorporated_association`: Unincorporated Association; `other`: Other."},"formation_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Formation Date","description":"Date the business entity was formed"},"registration_number":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Registration Number","description":"Business registration number (US: EIN/TIN)"},"registration_country":{"anyOf":[{"type":"string","maxLength":2},{"type":"null"}],"title":"Registration Country","description":"ISO 3166-1 alpha-2 country of registration"},"currency":{"anyOf":[{"type":"string","maxLength":8},{"type":"null"}],"title":"Currency","description":"Currency code. Editing the currency only updates the entity’s currency unit; it does not recalculate the financials from the current currency unit to the newly set one."},"industry_codes":{"anyOf":[{"items":{"$ref":"#/components/schemas/app_spread__schemas__commons__IndustryCode"},"type":"array"},{"type":"null"}],"title":"Industry Codes","description":"The company's industry codes"},"first_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"First Name","description":"Individual's first name"},"last_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Last Name","description":"Individual's last name"},"middle_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Middle Name","description":"Individual's middle name"},"spouse_first_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Spouse First Name","description":"Individual's spouse's first name"},"spouse_last_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Spouse Last Name","description":"Individual's spouse's last name"},"spouse_middle_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Spouse Middle Name","description":"Individual's spouse's middle name"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes","description":"Org-defined custom attributes"},"status":{"anyOf":[{"$ref":"#/components/schemas/EntityStatus"},{"type":"null"}],"description":"Customer status (active, inactive, onboarding, suspended)"}},"type":"object","title":"UpdateCustomerRequestUpdateFields"},"UpdateDealRequest":{"properties":{"deal_id":{"type":"string","title":"Deal Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"update_fields":{"$ref":"#/components/schemas/UpdateDealSchema"}},"type":"object","required":["deal_id","idempotency_key","update_fields"],"title":"UpdateDealRequest","description":"Update deal identified by internal deal_id."},"UpdateDealRequestExt":{"properties":{"external_deal_id":{"type":"string","title":"External Deal Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"update_fields":{"$ref":"#/components/schemas/UpdateDealSchema"}},"type":"object","required":["external_deal_id","idempotency_key","update_fields"],"title":"UpdateDealRequestExt","description":"Update deal identified by caller-supplied external_deal_id."},"UpdateDealSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"$ref":"#/components/schemas/OperationalStatus"},{"type":"null"}]},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"allow_link":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allow Link"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"requested_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Requested Limit"},"approved_limit":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Approved Limit"},"main_borrower_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Main Borrower Id"},"analyst_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Analyst User Id"},"secondary_analyst_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secondary Analyst User Id"},"sales_rep_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sales Rep User Id"},"involved_parties":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/InvolvedCustomerSchema"},{"$ref":"#/components/schemas/InvolvedPropertySchema"}]},"type":"array"},{"type":"null"}],"title":"Involved Parties"},"info_req_email_templates":{"anyOf":[{"$ref":"#/components/schemas/DealEmailTemplatesSchema"},{"type":"null"}]},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"}},"type":"object","title":"UpdateDealSchema"},"UpdateFinStmtSpreadingCaseRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"document_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Document Ids","description":"List of document IDs for the case. documents need to belongs to the same customer. Can only be updated if the case is in `waiting_on_client` status"},"case_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Case Name","description":"Case name"},"case_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Case Priority","description":"Case priority"},"review_type":{"anyOf":[{"type":"string","enum":["initiation","monthly","quarterly","semi_annually","annually","ad-hoc"]},{"type":"null"}],"title":"Review Type"},"spreading_request":{"anyOf":[{"$ref":"#/components/schemas/CaseSpreadingRequestExternal"},{"type":"null"}]}},"type":"object","required":["idempotency_key","document_ids"],"title":"UpdateFinStmtSpreadingCaseRequest"},"UpdateLoanRequest":{"properties":{"loan_id":{"type":"string","title":"Loan Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"update_fields":{"$ref":"#/components/schemas/UpdateLoanSchema"}},"type":"object","required":["loan_id","idempotency_key","update_fields"],"title":"UpdateLoanRequest","description":"Update loan identified by internal loan_id."},"UpdateLoanRequestExt":{"properties":{"external_loan_id":{"type":"string","title":"External Loan Id"},"idempotency_key":{"type":"string","title":"Idempotency Key"},"update_fields":{"$ref":"#/components/schemas/UpdateLoanSchema"}},"type":"object","required":["external_loan_id","idempotency_key","update_fields"],"title":"UpdateLoanRequestExt","description":"Update loan identified by caller-supplied external_loan_id."},"UpdateLoanSchema":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"$ref":"#/components/schemas/OperationalStatus"},{"type":"null"}]},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stage"},"limit_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Limit Amount"},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date"},"maturity_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Maturity Date"},"product_type":{"anyOf":[{"$ref":"#/components/schemas/LoanProductType"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"interest_type":{"anyOf":[{"$ref":"#/components/schemas/LoanInterestType"},{"type":"null"}]},"interest_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Rate"},"interest_benchmark":{"anyOf":[{"$ref":"#/components/schemas/LoanInterestBenchmark"},{"type":"null"}]},"interest_spread":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Interest Spread"},"repayment_type":{"anyOf":[{"$ref":"#/components/schemas/LoanRepaymentType"},{"type":"null"}]},"amortization_months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amortization Months"},"balloon_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Balloon Amount"},"billing_cycle":{"anyOf":[{"$ref":"#/components/schemas/LoanBillingCycle"},{"type":"null"}]},"purpose":{"anyOf":[{"$ref":"#/components/schemas/LoanPurpose"},{"type":"null"}]},"seniority":{"anyOf":[{"$ref":"#/components/schemas/LoanSeniority"},{"type":"null"}]},"prepayment_penalty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prepayment Penalty"},"unused_fee_rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Unused Fee Rate"},"custom_attributes":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/JsonValue-Input"},"type":"object"},{"type":"null"}],"title":"Custom Attributes"}},"type":"object","title":"UpdateLoanSchema"},"UploadDocumentResponse":{"properties":{"document_id":{"type":"string","title":"Document Id","description":"Document ID in our system"},"file_name":{"type":"string","title":"File Name","description":"File name of the document"},"idempotency_key":{"type":"string","title":"Idempotency Key","description":"Idempotency key for the document (max 255 characters)"}},"type":"object","required":["document_id","file_name","idempotency_key"],"title":"UploadDocumentResponse"},"UploadFinStmtDocumentHeaders":{"properties":{"x_accend_idempotency_key":{"type":"string","title":"X Accend Idempotency Key","description":"Idempotency key for the document (max 255 characters)"},"x_accend_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X Accend Customer Id","description":"Customer ID in our system for the customer the case belongs to, one of customer_id or external_customer_id or asset_id is required"},"x_accend_asset_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X Accend Asset Id","description":"Asset ID in our system for the asset the case belongs to, one of asset_id or external_customer_id or customer_id is required"},"x_accend_external_customer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X Accend External Customer Id","description":"external customer id for the customer the case belongs to, one of customer_id or external_customer_id or asset_id is required"},"x_accend_pdf_password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X Accend Pdf Password","description":"Password to unlock the PDF document"}},"type":"object","required":["x_accend_idempotency_key"],"title":"UploadFinStmtDocumentHeaders"},"UploadS3DocumentRequest":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"customer_id":{"type":"string","maxLength":255,"title":"Customer Id","description":"Customer ID in our system for the customer the case belongs to"},"presigned_url":{"type":"string","title":"Presigned Url","description":"S3 presigned url of the document"},"pdf_password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf Password","description":"Password to unlock the PDF document"}},"type":"object","required":["idempotency_key","customer_id","presigned_url"],"title":"UploadS3DocumentRequest"},"UploadS3DocumentRequestExt":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"external_customer_id":{"type":"string","maxLength":255,"title":"External Customer Id","description":"external customer id for the customer the case belongs to"},"presigned_url":{"type":"string","title":"Presigned Url","description":"S3 presigned url of the document"},"pdf_password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf Password","description":"Password to unlock the PDF document"}},"type":"object","required":["idempotency_key","external_customer_id","presigned_url"],"title":"UploadS3DocumentRequestExt"},"UploadS3DocumentRequestProperty":{"properties":{"idempotency_key":{"type":"string","maxLength":255,"title":"Idempotency Key","description":"Unique key to ensure idempotency for this request (max 255 characters)"},"asset_id":{"type":"string","maxLength":255,"title":"Asset Id","description":"Asset ID in our system for the asset the case belongs to"},"presigned_url":{"type":"string","title":"Presigned Url","description":"S3 presigned url of the document"},"pdf_password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf Password","description":"Password to unlock the PDF document"}},"type":"object","required":["idempotency_key","asset_id","presigned_url"],"title":"UploadS3DocumentRequestProperty"},"UploadSourceRef":{"properties":{"source":{"type":"string","const":"upload","title":"Source"},"document_ids":{"items":{"type":"string"},"type":"array","title":"Document Ids"}},"type":"object","required":["source","document_ids"],"title":"UploadSourceRef"},"UserInfo":{"properties":{"user_id":{"type":"string","title":"User Id"},"name":{"type":"string","title":"Name"},"email":{"type":"string","title":"Email"},"picture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Picture"}},"type":"object","required":["user_id","name","email"],"title":"UserInfo"},"UserRef":{"properties":{"id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Id"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"}},"type":"object","title":"UserRef","description":"An Accend user, named either way round.\n\n``email`` is what a CRM has to hand; ``id`` is what Accend returned last\ntime, and is the stable one — an employee's address can change. Exactly one\nis required, so there is no precedence rule to guess at and no way to send\ntwo selectors that disagree."},"ValidationEngineConfig":{"properties":{"minimal_interest_expense":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ThresholdConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Minimal Interest Expense","description":"Minimal interest expense config, threshold is in percentage","default":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}}},"minimal_depreciation":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ThresholdConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Minimal Depreciation","description":"Minimal depreciation config, threshold is in percentage","default":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}}},"minimal_amortization":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ThresholdConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Minimal Amortization","description":"Minimal amortization config, threshold is in percentage","default":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}}},"impairment_without_impairable_assets":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/EnableConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Impairment Without Impairable Assets","description":"Impairment orphan config: flags reported impairment expense when no impairable assets exist on the balance sheet","default":{"primary":{"enable":true}}},"positive_depreciation_amortization_impairment":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/EnableConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Positive Depreciation Amortization Impairment","description":"Positive D&A and impairment config. Disabled by default; intended for the delivered-period underwriting QA tool."},"depreciation_amortization_is_cf_inconsistency":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/EnableConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Depreciation Amortization Is Cf Inconsistency","description":"Flags periods where the cash flow statement reports non-zero depreciation_and_amortization but the matching income statement's combined D&A (depreciation + amortization + cogs_depreciation + cogs_amortization) is zero. Disabled by default."},"minimal_accounts_receivable":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ThresholdConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Minimal Accounts Receivable","description":"Minimal accounts receivable config","default":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}}},"minimal_accounts_payable":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ThresholdConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Minimal Accounts Payable","description":"Minimal accounts payable config, threshold is in percentage","default":{"primary":{"threshold":0.1},"secondary":{"threshold":2.0}}},"reconciliation_discrepancy":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ThresholdConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Reconciliation Discrepancy","description":"Reconciliation config, tolerance threshold is in percentage","default":{"secondary":{"threshold":0.1}}},"negative_and_zero_revenue":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/EnableConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Negative And Zero Revenue","description":"Negative and zero revenue config, enable the validation","default":{"primary":{"enable":true}}},"unexpected_negative_balance_sheet_items":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/EnableConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Unexpected Negative Balance Sheet Items","description":"Negative balance sheet items config, enable the validation","default":{"secondary":{"enable":true}}},"negative_and_zero_cash":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/EnableConfig"},"propertyNames":{"$ref":"#/components/schemas/SignalLevel"},"type":"object"},{"type":"null"}],"title":"Negative And Zero Cash","description":"Negative and zero cash config, enable the validation","default":{"primary":{"enable":true}}}},"type":"object","title":"ValidationEngineConfig"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"ValidationResult":{"properties":{"signals":{"items":{"$ref":"#/components/schemas/ValidationSignal"},"type":"array","title":"Signals","description":"List of validation signals/flags raised","default":[]},"passed":{"type":"boolean","title":"Passed","description":"Whether all validations passed"},"total_checks":{"type":"integer","title":"Total Checks","description":"Total number of checks performed"},"failed_checks":{"type":"integer","title":"Failed Checks","description":"Number of checks that failed"},"executed_checks":{"items":{"type":"string"},"type":"array","title":"Executed Checks","description":"List of validator names (signal_keys) that were executed","default":[]}},"type":"object","required":["passed","total_checks","failed_checks"],"title":"ValidationResult"},"ValidationSignal":{"properties":{"signal_key":{"type":"string","title":"Signal Key","description":"The main category/type of the signal"},"signal_sub_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signal Sub Key","description":"The specific sub-category or identifier within the signal type"},"signal_level":{"$ref":"#/components/schemas/SignalLevel","description":"The priority level of the signal (primary for critical issues, secondary for less critical)","default":"primary"},"locations":{"items":{"$ref":"#/components/schemas/SignalLocation"},"type":"array","title":"Locations","description":"List of statement locations where this signal was detected","default":[]},"supporting_data":{"items":{"$ref":"#/components/schemas/SignalSupportingData"},"type":"array","title":"Supporting Data","description":"Additional data supporting this signal","default":[]}},"type":"object","required":["signal_key"],"title":"ValidationSignal"},"ValueDataType":{"type":"string","enum":["string","float","money","integer","boolean","date","address","ratio","percent","months","days"],"title":"ValueDataType"},"VersionedFinModelTemplateSummary":{"properties":{"version":{"type":"integer","title":"Version","description":"Version number."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp when this version was created."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Timestamp when this version was last updated."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional version description."}},"type":"object","required":["version","created_at","updated_at"],"title":"VersionedFinModelTemplateSummary","description":"Summary of a single version of a financial model template."},"WebsiteEstimatedVisits":{"properties":{"date":{"type":"string","title":"Date"},"visits":{"type":"integer","title":"Visits"}},"type":"object","required":["date","visits"],"title":"WebsiteEstimatedVisits"},"WebsiteLinks":{"properties":{"urls":{"items":{"type":"string"},"type":"array","title":"Urls","default":[]},"link_type":{"type":"string","title":"Link Type"}},"type":"object","required":["link_type"],"title":"WebsiteLinks"},"WebsitePresenceResult":{"properties":{"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At","description":"ISO 8601 format Timestamp when the website was first discovered."},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At","description":"ISO 8601 format Timestamp when the website was last updated."},"monthly_estimated_visits":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebsiteEstimatedVisits"},"type":"array"},{"type":"null"}],"title":"Monthly Estimated Visits","description":"Estimated number of monthly visits to the website."},"contains_malware":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contains Malware","description":"Whether the website contains malware."},"contains_social_engineering":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contains Social Engineering","description":"Whether the website contains social engineering."},"important_links":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebsiteLinks"},"type":"array"},{"type":"null"}],"title":"Important Links","description":"List of important links of the source."},"screenshots":{"anyOf":[{"items":{"$ref":"#/components/schemas/Screenshot"},"type":"array"},{"type":"null"}],"title":"Screenshots","description":"List of screenshots of the source. This is only available for website sources."},"flagged_keywords":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Flagged Keywords","description":"List of flagged keywords found on the website content."},"contains_placeholder_text":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contains Placeholder Text","description":"Whether the website contains placeholder text."}},"type":"object","title":"WebsitePresenceResult"},"XeroImportRequest":{"properties":{"customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"},"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"api_source":{"$ref":"#/components/schemas/ApiSource"},"accounting_basis":{"type":"string","enum":["accrual","cash"],"title":"Accounting Basis"},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency"},"chart_of_accounts":{"additionalProperties":true,"type":"object","title":"Chart Of Accounts","description":"The /Accounts response"},"reports":{"items":{"$ref":"#/components/schemas/ProviderPeriodReport"},"type":"array","maxItems":120,"minItems":1,"title":"Reports"}},"additionalProperties":false,"type":"object","required":["idempotency_key","api_source","accounting_basis","currency","chart_of_accounts","reports"],"title":"XeroImportRequest"},"ZohoBooksImportRequest":{"properties":{"customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Id"},"external_customer_id":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"External Customer Id"},"idempotency_key":{"type":"string","maxLength":255,"minLength":1,"title":"Idempotency Key"},"api_source":{"$ref":"#/components/schemas/ApiSource"},"accounting_basis":{"type":"string","enum":["accrual","cash"],"title":"Accounting Basis"},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency"},"chart_of_accounts":{"additionalProperties":true,"type":"object","title":"Chart Of Accounts","description":"The chartofaccounts response"},"reports":{"items":{"$ref":"#/components/schemas/ProviderPeriodReport"},"type":"array","maxItems":120,"minItems":1,"title":"Reports"}},"additionalProperties":false,"type":"object","required":["idempotency_key","api_source","accounting_basis","currency","chart_of_accounts","reports"],"title":"ZohoBooksImportRequest"},"app_spread__schemas__commons__IndustryCode":{"properties":{"industries":{"items":{"type":"string"},"type":"array","title":"Industries","description":"The industry codes of the company"},"list_type":{"type":"string","enum":["NACE","NAICS","MCC"],"title":"List Type","description":"The type of industry code"}},"type":"object","required":["industries","list_type"],"title":"IndustryCode"},"models__models__IndustryCode":{"properties":{"industries":{"items":{"type":"string"},"type":"array","title":"Industries","description":"The industry codes of the company"},"list_type":{"type":"string","enum":["NACE","NAICS"],"title":"List Type","description":"The type of industry code"}},"type":"object","required":["industries","list_type"],"title":"IndustryCode"}},"securitySchemes":{"bearerAuth":{"type":"http","description":"Accend organization API token.","scheme":"bearer"}}},"tags":[{"name":"KYC","description":"You will be able to:\n\n* **Create KYC cases**.\n* **Read KYC cases**."},{"name":"Financials"}]}