{"openapi":"3.0.3","info":{"title":"Wealthtech API","description":"RESTful API for controlling and interacting with Atlas data","version":"2.6.0"},"servers":[{"url":"https://api.bridgeft.com/v2"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true,"samples-enabled":true},"paths":{"/account-management/accounts":{"get":{"tags":["Accounts"],"summary":"List all Accounts","description":"Return an enveloped list of Accounts accessible to your application","operationId":"getAccounts","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An envelope of accounts","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Accounts"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Accounts"],"summary":"Update Accounts","description":"Provide a list of accounts to update. Then entire account object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `benchmarks_ids`\n- `fee_structures_ids`\n- `billing_splits_ids`\n- `notes`\n- `nickname`\n- `household_id` To remove an account from a household, provide `null` in this field.\n- `target_allocation_id`\n- `first_performance_date`\n- `payment_source`\n- `first_billable_date`\n- `investment_model_id`\n- `required_cash`\n- `unsupervised_securities_ids`\n- `buy_securities_ids`\n- `sell_securities_ids`\n- `do_not_buy_securities_ids`\n- `do_not_sell_securities_ids`\n- `required_cash_frequency`\n","operationId":"readUpdatedAccounts","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounts"}}}},"responses":{"200":{"description":"An envelope of accounts","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Accounts"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/accounts/{id}":{"get":{"tags":["Accounts"],"summary":"Retrieve an Account","description":"Returns an account based on a single ID","operationId":"getAccount","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Accounts"],"summary":"Update an Account","description":"Provide an account to update. Then entire account object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `benchmark_ids`\n- `fee_structure_ids`\n- `billing_split_ids`\n- `notes`\n- `nickname`\n- `household_id` To remove an account from a household, provide `null` in this field.\n- `target_allocation_id`\n- `first_performance_date`\n- `payment_source`\n- `first_billable_date`\n- `investment_model_id`\n- `required_cash`\n- `unsupervised_securities_ids`\n- `buy_securities_ids`\n- `sell_securities_ids`\n- `do_not_buy_securities_ids`\n- `do_not_sell_securities_ids`\n- `required_cash_frequency`\n","operationId":"readUpdatedAccount","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"responses":{"200":{"description":"The updated account record.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/accounts/filter":{"post":{"tags":["Accounts"],"summary":"Filter Account records","description":"Filter accounts","operationId":"filterAccounts","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this account object","type":"integer","example":216897},"name":{"description":"Populated from custodian data but can be modified by users","type":"string","example":"Violet Juns"},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"inception_date":{"description":"Date of account inception, if applicable. May differ from opening date.","type":"string","nullable":true,"format":"date","example":null},"close_date":{"description":"Date the account was closed, if applicable","type":"string","nullable":true,"format":"date","example":null},"status":{"description":"Status of the account object. It can be funded, papered, closed or slate. Funded account is considered active account, Papered or Closed account is inactive, and Stale is unknown","type":"string","enum":["funded","papered","closed","stale"],"example":"funded"},"number":{"description":"Account number","type":"string","example":"DEMO3577"},"custodian":{"description":"Custodian the account data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","EGB","MLT","TIA"],"example":"SWB"},"city":{"description":"City of the account-holder","type":"string","example":"New Irmachester"},"zip_code":{"description":"Zip code of the account-holder","type":"string","example":"90337"},"acct_type":{"description":"Type of account. Example, IRA Roth, 401k, etc.","type":"string","example":"401k"},"is_tax_deferred":{"description":"True if this account is tax deferrable. This data is typically provided by the financial institution","type":"boolean","nullable":true,"example":null},"is_taxable":{"description":"True if this account is taxable. This data is typically provided by the financial insitution","type":"boolean","nullable":true,"example":null},"payment_source":{"description":"C=billed at the custodian D=billed directly","type":"string","enum":["C","D"],"example":"C"},"advisor_code":{"description":"Advisor code for this account object","type":"string","example":"DEMO2"},"household_id":{"description":"Household Id this account belongs to","type":"integer","example":68778}}}}}},"responses":{"200":{"description":"An envelope of accounts","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Accounts"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/tax-id/{taxid}":{"post":{"tags":["Tokenized Tax IDs"],"summary":"Retrieve Single Tokenized Tax ID","description":"Exchange a single Tax ID for the tokenized representation.","operationId":"getTaxID","parameters":[{"name":"taxid","in":"path","description":"Tax ID","required":true,"schema":{"type":"string"},"example":"000-00-0000"}],"responses":{"200":{"description":"Tokenized Tax ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxId"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/tax-id":{"post":{"tags":["Tokenized Tax IDs"],"summary":"Retrieve Many Tokenized Tax IDs","description":"Exchange multiple Tax IDs for their tokenized representations.","operationId":"getTaxIDs","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxIds"}}}},"responses":{"200":{"description":"Tokenized list of provided Tax IDs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxIds"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/related-persons":{"get":{"tags":["Related Persons"],"summary":"List all Related Persons","description":"Returns a list of all related persons for accessible accounts.","operationId":"getRelatedPersons","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An envelope of related persons","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"type":"array","items":{"type":"object","properties":{"id":{"title":"Object ID","description":"Unique ID for this account object","type":"integer"},"account_id":{"title":"Account ID","description":"The unique ID for the account the person record is related to.","type":"integer"},"type":{"title":"Type","description":"The related person type provided by the custodian.","type":"string"},"first_name":{"title":"First Name","description":"The related person's first name.","type":"string"},"last_name":{"title":"Last Name","description":"The related person's last name.","type":"string"},"middle_initial":{"title":"Middle Initial","description":"The related person's middle initial.","type":"string"},"date_of_birth":{"title":"Date of Birth","description":"The date of birth of the related person.","type":"string","format":"date"},"entity_name":{"title":"Entity Name","description":"The related person's entity.","type":"string"},"email":{"title":"Email","description":"The related person's email.","type":"string"},"tax_id_token":{"title":"Tax ID Token","description":"Tokenized representation of the related person's Tax ID.","type":"string"},"phone_numbers":{"title":"Phone Numbers","description":"List of phone numbers for the related person. If they are provided by the custodian.","type":"array","items":{"type":"object","properties":{"phone_number":{"title":"Phone Number","description":"Phone number for the related person.","type":"string"},"type":{"title":"Type","description":"The type of phone number.","type":"string"}}}},"addresses":{"title":"Addresses","description":"List of addresses for the related person. If they are provided by the custodian.","type":"array","items":{"type":"object","properties":{"address_1":{"title":"Address 1","description":"Line one of the related person's address record.","type":"string"},"address_2":{"title":"Address 2","description":"Line two of the related person's address record.","type":"string"},"city":{"title":"City","description":"Address city","type":"string"},"state":{"title":"State","description":"Address state","type":"string"},"postal_code":{"title":"Postal Code","description":"Address postal code","type":"string"},"country":{"title":"Country","description":"Address county","type":"string"},"type":{"title":"Type","description":"Address type","type":"string"}}}},"created_at_utc":{"description":"Timestamp for when the record was created.","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated.","type":"string","format":"date-time"}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/related-persons/filter":{"post":{"tags":["Related Persons"],"summary":"Filter related persons","description":"Filter related persons","operationId":"filterRelatedPersons","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this account object","type":"integer","example":1234},"account_id":{"description":"The unique ID for the account the person record is related to.","type":"integer","example":12341234},"account_ids":{"description":"A list of account IDs to filter on.","type":"array","items":{"type":"integer"},"example":[12345,12346]},"type":{"description":"The related person type provided by the custodian.","type":"string","example":"Beneficiary"},"first_name":{"example":"John","description":"The related person's first name.","type":"string"},"last_name":{"example":"Doe","description":"The related person's last name.","type":"string"},"middle_initial":{"example":"H","description":"The related person's middle initial.","type":"string"},"date_of_birth":{"example":"1995-09-23","description":"The date of birth of the related person.","type":"string","format":"date"},"entity_name":{"example":"John Doe's Company","description":"The related person's entity.","type":"string"},"email":{"example":"john.doe@example.com","description":"The related person's email.","type":"string"},"tax_id_token":{"example":"tax_id_token","description":"Tokenized representation of the related person's Tax ID.","type":"string"}}}}}},"responses":{"200":{"description":"An envelope of filtered related persons","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/paths/~1account-management~1related-persons/get/responses/200/content/application~1json/schema/properties/data"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/tax-id/exchange/{tax_id_token}":{"post":{"tags":["Tokenized Tax IDs"],"summary":"Exchange Tax ID Token","description":"Exchange`tax_id_token` For Plain Text Value","operationId":"exchangeTaxIDToken","parameters":[{"name":"tax_id_token","in":"path","description":"Tax ID Token","required":true,"schema":{"type":"string"},"example":"account_tax_id_token"}],"responses":{"200":{"description":"Plain text value of the provided `tax_id_token`.","content":{"application/json":{"schema":{"type":"object","properties":{"tax_id_token":{"title":"Tax ID Token","description":"The Tax ID Token provided","type":"string"},"original_value":{"title":"Original Value","description":"The original value of the provided `tax_id_token`","type":"string"},"type":{"title":"Type","description":"The type of tax identifier. Can be a social security number or a tax ID.","type":"string","enum":["ssn","tax_id"]}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/tax-id/exchange":{"post":{"tags":["Tokenized Tax IDs"],"summary":"Exchange Tax ID Tokens","description":"Exchange list of `tax_id_tokens` For Their Plain Text Values","operationId":"exchangeTaxIDTokens","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"tax_id_tokens":{"description":"The list of `tax_id_tokens` to exchange for their original values.","type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"Plain text value of the provided `tax_id_token`.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1account-management~1tax-id~1exchange~1%7Btax_id_token%7D/post/responses/200/content/application~1json/schema"}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/tda-to-swb-migrations":{"get":{"deprecated":true,"tags":["TDA to Schwab Account Migration"],"summary":"List all TDA to Schwab Migrated Accounts","description":"Retrieve the list of all your TDA Accounts which are subjected to be migrated to Schwab.","operationId":"getSchwabTdaMappings","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Successful Schwab TDA Mapping Response","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"type":"array","items":{"type":"object","properties":{"account_id":{"title":"Account ID","description":"BridgeFT's internal ID of the account record this mapping pertains to.","type":"integer"},"schwab_master_number":{"title":"Schwab Master Number","description":"The master number that the new Schwab account falls under.","type":"string"},"schwab_account_number":{"title":"Schwab Account Number","description":"The new account number for the migrated TDA account.","type":"string"},"tda_rep_code":{"title":"TDA Rep Code","description":"The Rep code the TDA account was assigned to.","type":"string"},"tda_account_number":{"title":"TDA Account Number","description":"The account number from TDA.","type":"string"}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/account-management/tda-to-swb-migrations/filter":{"post":{"deprecated":true,"tags":["TDA to Schwab Account Migration"],"summary":"Filter TDA to Schwab Migrated Accounts","description":"Filter out to find particular TDA Account and its respective new Schwab account number.","operationId":"filterSchwabTdaMappings","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"description":"Provide an ID of an Account to filter.","type":"integer","example":216897},"account_ids":{"description":"Provide a list of Account IDs to filter.","type":"array","items":{"type":"integer"},"example":[216897,216898]},"tda_rep_code":{"description":"Provide a TDA Rep Code to filter.","type":"string","example":"TDAREPCODE1"},"tda_rep_codes":{"description":"Provide a list of TDA Rep Codes to filter.","type":"array","items":{"type":"string"},"example":["TDAREPCODE1","TDAREPCODE2"]},"tda_account_number":{"description":"Provide a TDA Account Number to filter.","type":"string","example":"TDAACCOUNT1"},"tda_account_numbers":{"description":"Provide a list of TDA Account Numbers to filter.","type":"array","items":{"type":"string"},"example":["TDAACCOUNT1","TDAACCOUNT2"]},"schwab_master_number":{"description":"Provide a Schwab Master Number to filter.","type":"string","example":"SWBMASTERNUMBER1"},"schwab_master_numbers":{"description":"Provide a list of Schwab Master Numbers to filter.","type":"array","items":{"type":"string"},"example":["SWBMASTERNUMBER1","SWBMASTERNUMBER2"]},"schwab_account_number":{"description":"Provide a Schwab Account Number to filter.","type":"string","example":"SWBACCOUNT1"},"schwab_account_numbers":{"description":"Provide a list of Schwab Account Numbers to filter.","type":"array","items":{"type":"string"},"example":["SWBACCOUNT1","SWBACCOUNT2"]}}}}}},"responses":{"200":{"description":"An enveloped list of Schwab TDA Mappings","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/paths/~1account-management~1tda-to-swb-migrations/get/responses/200/content/application~1json/schema/properties/data"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/org/advisor-codes":{"get":{"tags":["Advisor Codes"],"summary":"List Advisor Codes","description":"Returns a list of all of the advisor codes associated with the application.","operationId":"getAdvisorCodes","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Advisor Codes","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/paths/~1org~1advisor-codes~1create-many/post/responses/200/content/application~1json/schema"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Advisor Codes"],"summary":"Create an Advisor Code","description":"Returns the created Advisor Code, if successful.\n\n**Note for Advisor Code Mapping in Sandbox Applications**\nTo preserve the data integrity of sandbox applications, the advisor code mapping endpoints are read-only\nand requests for creation or deletion of advisor codes will not result in updates to advisor code mappings.\nSandbox applications can read advisor codes from the `/v2/org/advisor-codes` endpoint, but the changes will not\nbe reflected upon updates.\n\nFor production applications, full access is granted to the advisor code mapping endpoints. Creations and removals\nof advisor codes will be applied to the advisor codes mapped to the application.\n","operationId":"createAdvisorCode","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["firm_id","code","source"],"properties":{"firm_id":{"title":"Firm ID","description":"ID of the Firm that the Advisor Code belongs to. This is required to create the advisor code. Application Firm IDs can be found using the `GET /v2/org/firms endpoint`.","type":"integer","example":39},"code":{"title":"Code","description":"The advisor code. Eligible characters are limited to numbers 0-9, letters A-Z (upper and lowercase), and characters `-` and `_`. If your advisor code includes additional characters, please create a support ticket, so that our team can accommodate.","type":"string","example":"NEWCODE"},"source":{"title":"Source Custodian","description":"The custodian the advisor code belongs to. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","example":"APX","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","EGB","MLT","TIA"]}}}}}},"responses":{"200":{"description":"Created Advisor Code","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"title":"Object ID","description":"Unique ID for the Advisor Code Object","type":"integer"},"firm_id":{"title":"Firm ID","description":"ID of the Firm that the Advisor Code belongs to","type":"integer","example":39},"code":{"title":"Code","description":"The advisor code","type":"string"},"source":{"title":"Source Custodian","description":"The custodian the advisor code belongs to APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","EGB","FPR","IBK","MLT","NFS","PER","PTA","SWB","TIA"]},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/org/advisor-codes/{id}":{"delete":{"tags":["Advisor Codes"],"summary":"Remove an Advisor Code","description":"Returns the \"OK\" message and a json object with the id the advisor codes removed, if deletion was successful\n\n**Note for Advisor Code Mapping in Sandbox Applications**\nTo preserve the data integrity of sandbox applications, the advisor code mapping endpoints are read-only\nand requests for creation or deletion of advisor codes will not result in updates to advisor code mappings.\nSandbox applications can read advisor codes from the `/v2/org/advisor-codes` endpoint, but the changes will not\nbe reflected upon updates.\n\nFor production applications, full access is granted to the advisor code mapping endpoints. Creations and removals\nof advisor codes will be applied to the advisor codes mapped to the application.\n","operationId":"deleteAdvisorCode","parameters":[{"$ref":"#/components/parameters/id"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/org/advisor-codes/create-many":{"post":{"tags":["Advisor Codes"],"summary":"Create Multiple Advisor Codes","description":"Enables the ability create new advisor codes for your application\n\n**Note for Advisor Code Mapping in Sandbox Applications**\nTo preserve the data integrity of sandbox applications, the advisor code mapping endpoints are read-only\nand requests for creation or deletion of advisor codes will not result in updates to advisor code mappings.\nSandbox applications can read advisor codes from the `/v2/org/advisor-codes` endpoint, but the changes will not\nbe reflected upon updates.\n\nFor production applications, full access is granted to the advisor code mapping endpoints. Creations and removals\nof advisor codes will be applied to the advisor codes mapped to the application.\n","operationId":"createManyAdvisorCodes","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1org~1advisor-codes/post/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of Advisor Codes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1org~1advisor-codes/post/responses/200/content/application~1json/schema"}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/org/advisor-codes/delete-many":{"post":{"tags":["Advisor Codes"],"summary":"Delete multiple Advisor Codes","description":"Gives the ability to remove multiple advisor codes from your application by providing IDs. The `id`'s provided can be found from resources returned from the `GET /v2/org/advisor-codes` endpoint.\n\n**Note for Advisor Code Mapping in Sandbox Applications**\nTo preserve the data integrity of sandbox applications, the advisor code mapping endpoints are read-only\nand requests for creation or deletion of advisor codes will not result in updates to advisor code mappings.\nSandbox applications can read advisor codes from the `/v2/org/advisor-codes` endpoint, but the changes will not\nbe reflected upon updates.\n\nFor production applications, full access is granted to the advisor code mapping endpoints. Creations and removals\nof advisor codes will be applied to the advisor codes mapped to the application.\n","operationId":"deleteManyAdvisorCodes","requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/org/roi-requests/send-request":{"post":{"tags":["ROI Requests"],"summary":"Send ROI Request to Custodian","description":"Automatically generates and sends an email to selected Custodian in order to authorize Release of Information between Custodian and BridgeFT.","operationId":"sendRoiRequest","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["custodian","advisor_codes","owner_name","firm_name","sender_name","cc_emails","reply_to_emails"],"properties":{"custodian":{"title":"Financial institution data source","description":"Custodian from which the accounts data originates. PER=Pershing, MLT=MillenniumTrust, IBK=InteractiveBrokers, EGB=Eaglebrook Advisors. If you don’t see certain custodians in this list, it indicates that those custodians do not accept ROI requests via emails. As a result, this API does not support such cases","type":"string","enum":["PER","MLT","IBK","EGB"],"example":"MLT"},"advisor_codes":{"title":"Advisor code","description":"The advisor code associated with this ROI request","type":"array","items":{"type":"string"},"example":[85462,123456]},"owner_name":{"title":"Owner name","description":"The representative person (such as the Advisor) on whose behalf you are requesting data feed authorization","type":"string","example":"John Jonson"},"firm_name":{"title":"Firm Name","description":"BridgeFT Client Firm Name (this is your firm name), who sending an ROI request","type":"string","example":"Acme Financial"},"sender_name":{"title":"Sender Name","description":"BridgeFT Client representative who triggering this ROI request","type":"string","example":"Alex Alexen"},"cc_emails":{"title":"CC Emails","description":"Any persons who should be involved in the ROI process and receive a copy of the ROI request. These could include Advisor’s team contacts","type":"array","items":{"type":"string"}},"reply_to_emails":{"title":"Reply To Emails","description":"Email addresses of the Advisor or Advisor’s representatives. These email addresses will automatically receive responses from the custodian when they use the “Reply To” function in their email inbox","type":"array","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"ROI Request Info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoiRequest"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/groups":{"get":{"tags":["Billing Group"],"summary":"List all Billing Groups","description":"Retrieve the enveloped list of Billing Groups","operationId":"getBillingGroups","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of group","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroups"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Billing Group"],"summary":"Bulk Update Billing Groups","description":"Provide a list of billing groups to update. Then entire billing group object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `minimum_ids`\n- `household_id`\n- `assignments`\n","operationId":"updateBillingGroups","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroups"}}}},"responses":{"200":{"description":"An enveloped list of group","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroups"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Billing Group"],"summary":"Create a Billing Group","description":"Returns the created billing group","operationId":"createBillingGroups","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"John Thomas Household"},"slug":{"type":"string","example":"john-thomas-household"},"household_id":{"type":"integer","example":63618},"firm_id":{"type":"integer","example":39},"minimum_ids":{"type":"array","items":{"type":"integer","nullable":true},"example":[]},"assignments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"account_id":{"type":"integer"},"group_id":{"type":"integer"},"fee_location":{"type":"integer"},"fee_location_option":{"type":"string"}}},"example":[{"id":642504,"account_id":230805,"group_id":290599,"fee_location":0,"fee_location_option":"5"}]}}}}}},"responses":{"200":{"description":"An enveloped list of group","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroup"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/groups/{id}":{"get":{"tags":["Billing Group"],"summary":"Retrieve a Billing Group","description":"Returns a billing group record for a provided ID","operationId":"getBillingGroup","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of group","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroup"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Billing Group"],"summary":"Update a Billing Group","description":"Provide a billing group to update. Then entire billing group object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `minimum_ids`\n- `household_id`\n- `assignments`\n","operationId":"updateBillingGroup","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingGroup"}}}},"responses":{"200":{"description":"The updated group object","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroup"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Billing Group"],"summary":"Delete a Billing Group","description":"Deletes the billing group record for the provided ID.","operationId":"deteleBillingGroup","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/groups/create-many":{"post":{"tags":["Billing Group"],"summary":"Create Many Billing Groups","description":"Returns a list of created Billing Groups","operationId":"createManyBillingGroups","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1billing~1groups/post/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of group","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroups"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/groups/filter":{"post":{"tags":["Billing Group"],"summary":"Filter all Billing Groups","description":"Returns a filtered list of Billing Groups","operationId":"filterBillingGroups","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Billing Group","type":"integer","example":315948},"name":{"description":"The name of this Billing Group","type":"string","example":"Ezequiel Roberts Household"},"slug":{"description":"The sluggified name of this Billing Group","type":"string","example":"ezequiel-roberts-household"},"household_id":{"description":"The ID of the associated household for this Billing Group","type":"integer","example":63618},"firm_id":{"description":"The firm ID of the managing firm for this Billing Group","type":"integer","example":39}}}}}},"responses":{"200":{"description":"An enveloped list of group","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroups"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/groups/delete-many":{"post":{"tags":["Billing Group"],"summary":"Delete Many Billing Groups","description":"Removes billing group records for the provided `ids`\n","operationId":"deteleManyBillingGroups","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","properties":{"n":{"type":"integer"},"ids":{"type":"array","items":{"type":"integer"}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/groups/remove-assignment":{"post":{"deprecated":true,"tags":["Billing Group"],"summary":"Remove a Billing Group Assignment","description":"Delete a single assignment tied to a Billing Group","operationId":"removeAssignment","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","example":703866},"group_id":{"type":"integer","example":315948}}}}}},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/groups/create-from-households":{"post":{"deprecated":true,"tags":["Billing Group"],"summary":"Create Billing Groups from Households","description":"Deletes existing Billing Groups, and recreates for the accounts of each household managed by the firm","operationId":"createBillingGroupCreateFromHousehold","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of group","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingGroups"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/asset-adjustments":{"get":{"tags":["Asset Adjustment"],"summary":"List all Asset Adjustments","description":"Returns a list of Asset Adjustments within the data field","operationId":"getAssetAdjustments","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Asset Adjustment","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetAdjustments"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Asset Adjustment"],"summary":"Bulk Update Asset Adjustments","description":"Provide a list of asset adjustments to update. Then entire asset adjustment object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `adjustment_type`\n- `level`\n- `security_ids`\n- `weight`\n","operationId":"updateAssetAdjustments","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAdjustments"}}}},"responses":{"200":{"description":"An enveloped list of Asset Adjustment","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetAdjustments"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Asset Adjustment"],"summary":"Create an Asset Adjustment","description":"Returns a created Asset Adjustment","operationId":"createAssetAdjustments","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"The name of this Asset Adjustment","type":"string","example":"Exclude Apple"},"slug":{"description":"The sluggified name of this Asset Adjustment","type":"string","example":"exclude-apple"},"adjustment_type":{"description":"i for inclusion, e for exclusion","type":"string","enum":["i","e"],"example":"e"},"level":{"description":"f for firm-wide, a for the account level","type":"string","enum":["f","a"],"example":"a"},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"weight":{"description":"Weight of the adjusted asset","type":"integer","example":100}}}}}},"responses":{"200":{"description":"An enveloped list of Asset Adjustment","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetAdjustment"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/asset-adjustments/{id}":{"get":{"tags":["Asset Adjustment"],"summary":"Retrieve an Asset Adjustment","description":"Returns an Asset Adjustment based on a single ID","operationId":"getAssetAdjustment","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Asset Adjustment","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetAdjustment"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Asset Adjustment"],"summary":"Update an Asset Adjustment","description":"Provide an asset adjustment to update. Then entire asset adjustment object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `adjustment_type`\n- `level`\n- `security_ids`\n- `weight`\n","operationId":"updateAssetAdjustment","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAdjustment"}}}},"responses":{"200":{"description":"An enveloped list of Asset Adjustment","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetAdjustment"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Asset Adjustment"],"summary":"Delete an Asset Adjustment","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"deteleAssetAdjustment","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/asset-adjustments/create-many":{"post":{"tags":["Asset Adjustment"],"summary":"Create Many Asset Adjustments","description":"Returns the created Asset Adjustment","operationId":"createManyAssetAdjustments","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/AssetAdjustment"}}}}},"responses":{"200":{"description":"An enveloped list of Asset Adjustment","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetAdjustments"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/asset-adjustments/delete-many":{"post":{"tags":["Asset Adjustment"],"summary":"Delete many Asset Adjustments","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyAssetAdjustments","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/asset-adjustments/filter":{"post":{"tags":["Asset Adjustment"],"summary":"Filter all Asset Adjustment","description":"Returns a filtered list of Asset Adjustment","operationId":"filterBillingAssetAdjustment","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Asset Adjustment","type":"integer","example":60},"name":{"description":"The name of this Asset Adjustment","type":"string","example":"Exclude Apple"},"slug":{"description":"The sluggified name of this Asset Adjustment","type":"string","example":"exclude-apple"},"adjustment_type":{"description":"i for inclusion, e for exclusion","type":"string","enum":["i","e"],"example":"e"},"security_ids":{"description":"List of security ids associated with this asset adjustment","type":"array","items":{"type":"integer"},"example":[62]},"level":{"description":"f for firm-wide, a for the account level","type":"string","enum":["f","a"],"example":"a"},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39}}}}}},"responses":{"200":{"description":"An enveloped list of Asset Adjustment","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetAdjustments"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-upload-files":{"get":{"tags":["Fee Upload File"],"summary":"List all Fee Upload Files","description":"Return an enveloped list of fee upload files generated by your application.","operationId":"getFeeUploads","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of fee uploads","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeUploads"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-upload-files/{id}":{"get":{"tags":["Fee Upload File"],"summary":"Retrieve a Fee Upload File","description":"Returns the fee upload file record for the provided ID.","operationId":"getFeeUpload","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of fee upload","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeUpload"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-upload-files/filter":{"post":{"tags":["Fee Upload File"],"summary":"Filter all Fee Upload Files","description":"Returns a filtered list of Fee Upload Files","operationId":"filterFeeUpload","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Fee Upload File","type":"integer","example":33},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"end_date":{"description":"The date that this Fee Upload File ends","type":"string","format":"date-time","example":"2017-07-31T00:00:00Z"},"num_files":{"description":"The number of files for this Fee Upload File","type":"integer","example":6},"num_custodians":{"description":"The number of custodians for this Fee Upload File","type":"integer","example":3},"num_accounts":{"description":"The number of accounts for this Fee Upload File","type":"integer","example":15},"num_households":{"description":"The number of households for this Fee Upload File","type":"integer","nullable":true,"example":null},"total_annual_debit":{"description":"The total annual debit for this Fee Upload File","type":"number","nullable":true,"format":"float","example":null},"total_period_debit":{"description":"The total period debit for this Fee Upload File","type":"number","nullable":true,"format":"float","example":null}}}}}},"responses":{"200":{"description":"An enveloped list of fee upload","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeUploads"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-upload-files/download/{id}":{"post":{"tags":["Fee Upload File"],"summary":"Download the Fee Upload File","description":"Returns the fee upload file .zip archive for the specified ID.","operationId":"getFeeUploadDownload","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"The fee upload file .zip archive","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-structures":{"get":{"tags":["Fee Structure"],"summary":"List all Fee Structures","description":"Returns an enveloped list of Fee Structures.","operationId":"getFeeStructures","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of fee structure","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeStructures"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Fee Structure"],"summary":"Bulk Update Fee Structures","description":"Provide a list of fee structures to update. Then entire fee structure object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `calculation_type`\n- `collection_type`\n- `frequency`\n- `quarter_cycle`\n- `balance_type`\n- `flat_rate`\n- `flat_dollar_fee`\n- `semi_annual_cycle`\n- `annual_cycle`\n- `tiers`\n","operationId":"updateFeeStructures","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeStructures"}}}},"responses":{"200":{"description":"The updated list of fee structure objects.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeStructures"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Fee Structure"],"summary":"Create a Fee Structure","description":"Returns the created  Fee Structure","operationId":"createFeeStructures","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"created_by_user_id":{"description":"The user ID of the creator User","type":"integer","nullable":true,"example":null,"deprecated":true},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"name":{"description":"The name of this Fee Structure","type":"string","example":"Standard Tiered Rate"},"slug":{"description":"The slugified name of this Fee Structure","type":"string","example":"standard-tiered-rate"},"calculation_type":{"description":"R for Flat Rate, A for Flat Account Fee, G for Flat Group Fee, D for Drop Through, T for Tiered Fee, and F for Favor Fee","type":"string","enum":["R","A","G","D","T","F"],"example":"R"},"collection_type":{"description":"See Billing Collection Types","type":"string","example":"P"},"frequency":{"description":"See Frequency Codes","type":"string","enum":["M","Q"],"example":"Q"},"quarter_cycle":{"description":"See Billing Quarter Cycle Codes","type":"integer","example":1},"balance_type":{"description":"E for end of period balance, A for average daily balance, P for ending period balance w/ adjustment for flows, C for ending period balance w/adjustment for flows less cash","type":"string","enum":["E","A","P","C"],"example":"E"},"flat_rate":{"description":"The flat rate for this Fee Structure. Must be between 0 and 99 inclusive. Will be stored and converted to a Percentage. (i.e. 1 -> 1% and 0.25 -> 0.25%)","type":"number","format":"float","example":1},"flat_dollar_fee":{"description":"The flat dollar fee for this Fee Structure","type":"number","nullable":true,"format":"float","example":null},"tiers":{"description":"Tiers associated with the fee structure","type":"array","items":{"type":"object","properties":{"id":{"description":"Id associated with the tier object","type":"integer"},"min_balance":{"description":"Minimum balance for the tier","type":"number"},"max_balance":{"description":"Maximum balance for the tier","type":"number","nullable":true},"rate":{"description":"Rate for the tier","type":"number"},"fee_structure_id":{"description":"Fee structure id associated with this tier","type":"integer"}}},"example":[{"id":4249,"min_balance":0,"max_balance":1000000,"rate":0.9,"fee_structure_id":1290},{"id":4250,"min_balance":1000000.01,"max_balance":null,"rate":0.75,"fee_structure_id":1290}]}}}}}},"responses":{"200":{"description":"An enveloped list of fee structure","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeStructure"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-structures/{id}":{"get":{"tags":["Fee Structure"],"summary":"Retrieve a Fee Structure","description":"Returns the fee structure record for the provided ID","operationId":"getFeeStructure","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Fee Structure","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeStructure"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Fee Structure"],"summary":"Update a Fee Structure","description":"Provide a fee structure to update. Then entire fee structure object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `calculation_type`\n- `collection_type`\n- `frequency`\n- `quarter_cycle`\n- `balance_type`\n- `flat_rate`\n- `flat_dollar_fee`\n- `semi_annual_cycle`\n- `annual_cycle`\n- `tiers`\n","operationId":"updateFeeStructure","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeeStructure"}}}},"responses":{"200":{"description":"An enveloped list of Fee Structure","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeStructure"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Fee Structure"],"summary":"Delete a Fee Structure","description":"Deletes the record for the provided fee structure ID.","operationId":"deteleFeeStructure","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-structures/create-many":{"post":{"tags":["Fee Structure"],"summary":"Create Many Fee Structures","description":"Returns a list of created Fee Structures","operationId":"createManyFeeStructures","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","$ref":"#/paths/~1billing~1fee-structures/post/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of Fee Structure","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeStructures"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-structures/delete-many":{"post":{"tags":["Fee Structure"],"summary":"Delete Many Fee Structures","description":"Deletes the records for the provided Fee Structure `ids`\n","operationId":"deteleManyFeeStructures","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/fee-structures/filter":{"post":{"tags":["Fee Structure"],"summary":"Filter all Fee Structures","description":"Returns a filtered list of Fee Structure","operationId":"filterFeeStructures","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Fee Structure","type":"integer","example":1290},"created_by_user_id":{"description":"The user ID of the creator User","type":"integer","nullable":true,"example":null},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"name":{"description":"The name of this Fee Structure","type":"string","example":"Standard Tiered Rate"},"slug":{"description":"The slugified name of this Fee Structure","type":"string","example":"standard-tiered-rate"},"calculation_type":{"description":"R for Flat Rate, A for Flat Account Fee, G for Flat Group Fee, D for Drop Through, T for Tiered Fee, and F for Favor Fee","type":"string","enum":["R","A","G","D","T","F"],"example":"R"},"collection_type":{"description":"See Billing Collection Types","type":"string","example":"P"},"frequency":{"description":"See Frequency Codes","type":"string","enum":["M","Q"],"example":"Q"},"quarter_cycle":{"description":"See Billing Quarter Cycle Codes","type":"integer","example":1},"balance_type":{"description":"E for end of period balance, A for average daily balance, P for ending period balance w/ adjustment for flows, C for ending period balance w/adjustment for flows less cash","type":"string","enum":["E","A","P","C"],"example":"E"},"flat_rate":{"description":"The flat rate for this Fee Structure. Must be between 0 and 99 inclusive. Will be stored and converted to a Percentage. (i.e. 1 -> 1% and 0.25 -> 0.25%)","type":"number","format":"float","example":1},"flat_dollar_fee":{"description":"The flat dollar fee for this Fee Structure","type":"number","nullable":true,"format":"float","example":null}}}}}},"responses":{"200":{"description":"An enveloped list of Fee Structure","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/FeeStructures"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/invoices":{"get":{"tags":["Invoices"],"summary":"List all Invoices","description":"Returns an enveloped list of invoices generated from Billing Reports.","operationId":"getInvoices","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Invoices","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Invoices"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/invoices/{id}":{"get":{"tags":["Invoices"],"summary":"Retrieve an Invoice","description":"Returns an invoice detail object for the provided ID.","operationId":"getInvoice","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of invoice","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Invoice"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/invoices/filter":{"post":{"tags":["Invoices"],"summary":"Filter all Invoices","description":"Returns a filtered list of Invoices","operationId":"filterInvoices","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Invoice","type":"integer"},"firm_id":{"description":"The firm ID of the managing firm","type":"integer"},"billing_group_id":{"description":"The billing group ID for this Invoice","type":"integer"},"snapshot_date":{"description":"The snapshot date for this Invoice","type":"string","format":"date-time"},"billing_report_id":{"description":"The associated billing report ID for this Invoice","type":"integer"},"annual_fee":{"description":"The total fee and debited amount annualized just for this billing group","type":"number","format":"float"},"annual_debit":{"description":"The annual debit for this Invoice","type":"number","format":"float"},"total_balance":{"description":"The total group balance on the snapshot date","type":"number","format":"float"},"period_debit":{"description":"The total debited amount for the period just for this billing group on the snapshot date","type":"number","format":"float"},"direct_billed_period_debit":{"description":"The direct billed period debit for this Invoice.","type":"number","format":"float"},"custodian_billed_period_debit":{"description":"The custodian billed period debit for this Invoice","type":"number","format":"float"},"n_accounts":{"description":"The number of accounts in the report","type":"integer"},"n_fee_structures":{"description":"The number of fee structures in the report","type":"integer"},"due_date":{"description":"Invoice due date, calculated using firm settings at the time the invoice was generated","type":"string","format":"date-time"},"group_id":{"description":"Group Id of this invoice","type":"integer"}}}}}},"responses":{"200":{"description":"An enveloped list of Invoices","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Invoices"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/invoices/download/{id}":{"post":{"tags":["Invoices"],"summary":"Download a PDF Invoice","description":"Returns the binary data for a specified invoice. This endpoint allows you to download the PDF file corresponding to the provided invoice ID.\n","operationId":"getInvoiceDownloadStream","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Content-Type":{"description":"application/pdf","type":"string"},"Accept":{"description":"application/pdf","type":"string"}}}}}},"responses":{"200":{"description":"The PDF Invoice","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/invoices/download":{"post":{"tags":["Invoices"],"summary":"Bulk Download Billing Invoices","description":"Starts and returns a bulk download job","operationId":"filterInvoiceBulkDownload","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"A list of PDF Report ids that will be downloaded during the bulk download job."}}}}}},"responses":{"200":{"description":"An enveloped list of Jobs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Job"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/reports":{"get":{"tags":["Billing Reports"],"summary":"List all Billing Reports","description":"Returns a list of Billing Reports within the data field","operationId":"getBillingReports","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Billing Reports","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingReports"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Billing Reports"],"summary":"Start a Billing Job","description":"Starts a Billing Job with PDF Reporting and returns the created Background Job Instance","operationId":"startBillingReportStartPDF","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["firm_id","period_type","is_invoice_by_client","create_invoice"],"properties":{"firm_id":{"description":"Unique ID for the object","type":"integer","format":"int64","example":20},"billing_date":{"description":"The date to run a billing calculation on","type":"string","example":"2022-08-31"},"create_invoices":{"description":"Whether to create Invoice PDFs during the billing calculation job","type":"boolean","example":true},"is_invoice_by_client":{"description":"When this option is true, invoices will be created at the household level. Each household in the billing run will receive an invoice with billing details included for each individual account in that respective household. If accounts in the billing run do not belong to a household, each individual account will receive their own invoice. When this option is false, invoices will be generated for each billing group containing billing details for each account in the respective billing group.","type":"boolean","example":true},"email_notification":{"description":"If true, this sends an email notification to the user who created the job","type":"boolean","example":true},"period_type":{"description":"Whether to create an invoice using the standard (S) or exact (E) billing period","type":"string","enum":["S","E"],"example":"S"},"group_ids":{"description":"An array of billing group ids","type":"array","items":{"type":"integer"},"nullable":true,"example":null},"settings_overrides":{"type":"object","nullable":true,"description":"`settings_overrides` provides the ability to override default billing and invoice settings that are set by default in the `Firm` resource.\n","properties":{"logo_settings":{"type":"object","description":"Overrides the default `logo` on the generated PDF report.\n","properties":{"logo":{"type":"string","description":"Base64 encoded data of a PNG or a JPEG image to be placed on the generated PDF report."},"logo_mime_type":{"type":"string","description":"The mime type of the provided image. Accepted values are `image/png` and `image/jpeg`","enum":["image/png","image/jpeg"]}}},"billing_partition_option":{"type":"string","description":"How billing is partitioned for the billing run. (Daily, Weekly, Monthly, Quarterly, Yearly)","enum":["D","W","M","Q","Y"]},"invoice_header":{"type":"string","description":"HTML template for the invoice header"},"invoice_footer":{"type":"string","description":"HTML template for the invoice footer"},"invoice_from":{"type":"string","description":"The address of the firm"},"invoice_due_date_option":{"type":"string","description":"Option to use for calculating due date. Choices are 30 (30 days from the invoice date), E (end of next month), or the empty string.","enum":["30","E",""]},"invoice_include_fee_structures":{"type":"boolean","description":"Whether to include a description of the fee structures used in the billing"},"invoice_effective_rates":{"type":"boolean","description":"Whether to include effective rates (total billed divided by total assets) in the invoice"},"invoice_annualized_effective_rates":{"type":"boolean","description":"Whether to show the effective rate as an annual percentage"},"invoice_show_agreement":{"type":"boolean","description":"Whether to show the disclaimer agreement text, standard from V2 invoices"},"invoice_not_a_bill_explanation":{"type":"boolean","description":"If true and the invoice doesn't represent a bill (because it'll be withdrawn directly)"}}}}}}}},"responses":{"200":{"description":"An enveloped list of Jobs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Job"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/reports/{id}":{"get":{"tags":["Billing Reports"],"summary":"Retrieve a Billing Report","description":"Returns a Billing Report based on a single ID","operationId":"getBillingReport","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Billing Report","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingReport"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Billing Reports"],"summary":"Delete a Billing Report","description":"Deletes the billing report record for the provided ID.","operationId":"deteleBillingReport","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/reports/filter":{"post":{"tags":["Billing Reports"],"summary":"Filter all Billing Reports","description":"Returns a filtered list of Billing Reports","operationId":"filterBillingReports","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this billing report","type":"integer","example":18444},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"created_invoices":{"description":"True if invoices were created when the report was created","type":"boolean","example":true},"billing_date":{"description":"The input date to the billing report","type":"string","format":"date-time","example":"2022-09-30T00:00:00Z"},"snapshot_date":{"description":"The closest date available to the billing date for which there's data at the time of running the report","type":"string","format":"date-time","example":"2022-09-30T00:00:00Z"},"run_date":{"description":"The most recent market date corresponding to when the report date","type":"string","format":"date-time","example":"2022-08-12T00:00:00Z"},"created_date":{"description":"The calendar date on which the report was generated / created","type":"string","format":"date-time","example":"0001-01-01T00:00:00Z"},"annual_fee":{"description":"Total fee and debited amount annualized","type":"number","format":"float","example":86748.68},"annual_debit":{"description":"The annual debit amount for this billing report","type":"number","format":"float","example":86748.68},"total_balance":{"description":"Sum of all group balances on the billing date","type":"number","format":"float","example":8674867.56},"aum_on_billing_date":{"description":"All assets under management on the billing date","type":"number","format":"float","example":8674867.56},"period_debit":{"description":"Total debited amount for the period","type":"number","format":"float","example":7229.03},"direct_billed_period_debit":{"description":"The direct billed period debit for this billing report","type":"number","nullable":true,"format":"float","example":null},"custodian_billed_period_debit":{"description":"The custodian billed period debit for this billing report","type":"number","format":"float","example":7229.03},"split_payout":{"description":"Total payout of all splits for this period","type":"number","nullable":true,"format":"float","example":null},"split_payout_annualized":{"description":"Split payout on an annualized basis","type":"number","nullable":true,"format":"float","example":null},"firm_share":{"description":"The firm's share for the period. Equals period_debit - split_payout.","type":"number","format":"float","example":7229.03},"firm_share_annualized":{"description":"Firm's annualized share. Equals annual_debit - split_payout_annualized.","type":"number","format":"float","example":86748.68},"n_accounts":{"description":"The number of accounts for this billing report","type":"integer","example":4},"n_groups":{"description":"The number of groups for this billing report","type":"integer","example":1},"n_splits":{"description":"The number of billing splits for this billing report","type":"integer","example":16},"n_fee_structures":{"description":"The number of fee structures for this billing report","type":"integer","example":7},"fee_upload_file_id":{"description":"The corresponding fee upload file model instance","type":"integer","nullable":true,"example":null}}}}}},"responses":{"200":{"description":"An enveloped list of Billing Reports","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/BillingReports"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/reports/delete-many":{"post":{"tags":["Billing Reports"],"summary":"Delete many Billing Reports","description":"Deletes the corresponding billing report records for the provided list of `\"ids\"` in the request body.\n","operationId":"deteleManyBillingReports","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/minimums":{"get":{"tags":["Minimums"],"summary":"List all Minimums","description":"Returns an enveloped list of Billing Minimums.","operationId":"getMinimumsMany","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of minimums","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/MinimunsMany"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Minimums"],"summary":"Bulk Update Minimums","description":"Provide a list of billing minimums to update. Then entire billing minimum object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `value`\n- `value_type`\n","operationId":"updateMinimumsMany","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MinimunsMany"}}}},"responses":{"200":{"description":"An enveloped list of minimums","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/MinimunsMany"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Minimums"],"summary":"Create a Minimum","description":"Returns the created Minimums","operationId":"createMinimums","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"name":{"description":"The name of this Billing Minimum","type":"string","example":"Insurance Claim"},"value":{"description":"The value of this Billing Minimum","type":"number","format":"float","example":2500},"value_type":{"description":"F for flat amount, P for percentage","type":"string","enum":["F","P"],"example":"F"}}}}}},"responses":{"200":{"description":"An enveloped list of minimums","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Minimuns"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/minimums/{id}":{"get":{"tags":["Minimums"],"summary":"Retrieve a Minimum","description":"Returns a Billing Minimum record for the provided ID.","operationId":"getMinimums","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of minimums","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Minimuns"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Minimums"],"summary":"Update a Minimum","description":"Provide a billing minimum to update. Then entire billing minimum object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `value`\n- `value_type`\n","operationId":"updateMinimums","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Minimuns"}}}},"responses":{"200":{"description":"An enveloped list of minimums","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Minimuns"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Minimums"],"summary":"Delete a Minimum","description":"Deletes the billing minimum record for the provided ID.","operationId":"deteleMinimums","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/minimums/create-many":{"post":{"tags":["Minimums"],"summary":"Create Many Minimums","description":"Returns a list of created Minimums","operationId":"createManyMinimums","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1billing~1minimums/post/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of Minimums","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/MinimunsMany"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/minimums/delete-many":{"post":{"tags":["Minimums"],"summary":"Delete Many Minimums","description":"Deletes the corresponding billing minimum records for the provided IDs.","operationId":"deteleManyMinimumsMany","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/minimums/filter":{"post":{"tags":["Minimums"],"summary":"Filter Minimums","description":"Returns a filtered list of Minimums","operationId":"filterMinimums","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Billing Minimum","type":"integer","example":19},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"name":{"description":"The name of this Billing Minimum","type":"string","example":"Insurance Claim"},"value":{"description":"The value of this Billing Minimum","type":"number","format":"float","example":2500},"value_type":{"description":"F for flat amount, P for percentage","type":"string","enum":["F","P"],"example":"F"}}}}}},"responses":{"200":{"description":"An enveloped list of Minimums","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/MinimunsMany"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/splits":{"get":{"tags":["Billing Splits"],"summary":"List all Billing Splits","description":"Returns an enveloped list of Billing Split records","operationId":"getBillingSplits","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Split","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Split"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Billing Splits"],"summary":"Bulk Update Billing Splits","description":"Provide a list billing splits to update. Then entire billing split object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `percentage`\n- `splitter_name`\n","operationId":"updateBillingSplits","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Split"}}}},"responses":{"200":{"description":"The list of updated billing split records","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Split"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Billing Splits"],"summary":"Create a Billing Split","description":"Returns the created Billing Split","operationId":"createBillingSplits","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firm_id":{"description":"The ID of the managing firm for this billing split","type":"integer","example":39},"name":{"description":"The name of the billing split, auto-generated if not supplied","type":"string","example":"Advisor #2 Clients"},"splitter_name":{"description":"The name originally entered by the user","type":"string","example":"Kevin Orick"},"splitter_slug":{"description":"The sluggified version of the name field","type":"string","example":"kevin-orick"},"percentage":{"description":"The percentage of the split stored on the natural scale","type":"number","format":"float","example":10}}}}}},"responses":{"200":{"description":"An enveloped list of Split","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/paths/~1billing~1splits~1%7Bid%7D/put/requestBody/content/application~1json/schema"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/splits/{id}":{"get":{"tags":["Billing Splits"],"summary":"Retrieve a Billing Split","description":"Returns the Billing Split record for the provided ID","operationId":"getBillingSplit","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of split","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/paths/~1billing~1splits~1%7Bid%7D/put/requestBody/content/application~1json/schema"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Billing Splits"],"summary":"Update a Billing Split","description":"Provide a billing split to update. Then entire billing split object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `percentage`\n- `splitter_name`\n","operationId":"updateBillingSplit","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource ID for the billing split","type":"integer"},"firm_id":{"title":"Firm id","description":"The ID of the managing firm for this billing split","type":"integer"},"name":{"title":"Name","description":"The name of the billing split, auto-generated if not supplied","type":"string"},"splitter_name":{"title":"Splitter name","description":"The name originally entered by the user","type":"string"},"splitter_slug":{"title":"Splitter slug","description":"The sluggified version of the name field","type":"string"},"percentage":{"title":"Percentage","description":"The percentage of the split stored on the natural scale","type":"number","format":"float"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"The updated Billing Split record","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/paths/~1billing~1splits~1%7Bid%7D/put/requestBody/content/application~1json/schema"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Billing Splits"],"summary":"Delete a Billing Split","description":"Delete the billing split record for the provided ID\n","operationId":"deteleBillingSplit","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/splits/create-many":{"post":{"tags":["Billing Splits"],"summary":"Create Many Billing Splits","description":"Returns a list of created Billing Splits","operationId":"createManyBillingSplits","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","$ref":"#/paths/~1billing~1splits~1%7Bid%7D/put/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of Split","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Split"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/splits/delete-many":{"post":{"tags":["Billing Splits"],"summary":"Delete Many Billing Splits","description":"Delete billing split records for the provided `ids`\n","operationId":"deteleManyBillingSplits","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/billing/splits/filter":{"post":{"tags":["Billing Splits"],"summary":"Filter Billing Splits","description":"Returns a filtered list of Billing Splits","operationId":"filterBillingSplits","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for the billing split","type":"integer","example":722},"firm_id":{"description":"The ID of the managing firm for this billing split","type":"integer","example":39},"name":{"description":"The name of the billing split, auto-generated if not supplied","type":"string","example":"Advisor #1 Clients"},"splitter_name":{"description":"The name originally entered by the user","type":"string","example":"Kevin Orick"},"splitter_slug":{"description":"The sluggified version of the name field","type":"string","example":"kevin-orick"},"percentage":{"description":"The percentage of the split stored on the natural scale","type":"number","format":"float","example":10}}}}}},"responses":{"200":{"description":"An enveloped list of Splits","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Split"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/households":{"get":{"tags":["Households"],"summary":"List all Households","description":"Returns a list of households within the data field","operationId":"getHouseholds","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of households","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Households"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Households"],"summary":"Update Households","description":"Provide a list of Households to update. Then entire Household object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `benchmarks_ids`\n","operationId":"readUpdatedHouseholds","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Households"}}}},"responses":{"200":{"description":"An enveloped list of households","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Households"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Households"],"summary":"Create a Household","description":"Returns the created Household","operationId":"createHousehold","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"the name of the household","type":"string","example":"Joe and Rebecca Jones Household"},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39}}}}}},"responses":{"200":{"description":"An enveloped household","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Household"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/households/{id}":{"get":{"tags":["Households"],"summary":"Retrieve a Household","description":"Returns a household based on a single ID","operationId":"getHousehold","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped household","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Household"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Households"],"summary":"Update a Household","description":"Provide a Household to update. Then entire Household object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `benchmarks_ids`\n","operationId":"readUpdatedHousehold","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Household"}}}},"responses":{"200":{"description":"An enveloped household","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Household"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Households"],"summary":"Delete a Household","description":"Deletes the Household record for the provided ID.","operationId":"deteleHousehold","parameters":[{"$ref":"#/components/parameters/id"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/households/filter":{"post":{"tags":["Households"],"summary":"Filter all Households","description":"Return a filtered list of all Households","operationId":"filterHouseholds","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique household identifier","type":"integer","format":"int64","example":27585},"name":{"description":"Populated from custodian data but can be modified by users","type":"string","example":"Rachel and Alex Green-Smith Household"},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"entity_id":{"description":"See Entiti ID Prefixes","type":"string","example":"H-90A44DFF"},"opening_date":{"description":"Date the household was opened","type":"string","format":"date","example":"2021-12-31"},"inception_date":{"description":"Date of household inception, if applicable. May differ from opening date","type":"string","format":"date","example":"2004-05-14"},"close_date":{"description":"Date the household was closed, if applicable","type":"string","nullable":true,"format":"date","example":null},"status":{"description":"See Account and Household Status Codes.","type":"string","example":"110"},"short_name":{"description":"Short name for the household object","type":"string","example":"90A44DFF"}}}}}},"responses":{"200":{"description":"An enveloped list of households","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Households"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/households/create-many":{"post":{"tags":["Households"],"summary":"Create Many Households","description":"Returns a list of created Households","operationId":"createManyHouseholds","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1reporting~1households/post/requestBody/content/application~1json/schema"},"example":[{"name":"Joe and Rebecca Jones Household","firm_id":39},{"name":"Tim Blanco Household","firm_id":39}]}}}},"responses":{"200":{"description":"An enveloped list of households","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Households"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/households/remap":{"post":{"tags":["Households"],"summary":"Assign Accounts to Households","description":"Provide a map keyed on string `account_id` with value of the `household` the `account_id` should be mapped to.\n\n**Example Request Body:**\n\n```json\n{\n  \"123456\": 23,\n  \"123457\": 23,\n  \"123458\": 23,\n  \"123459\": 24,\n  \"123460\": 24,\n  \"123461\": 24\n}\n```\n\nThe above payload would assign account IDs `123456`, `123457`, and `123458` to `household_id` 23. While the following\naccounts are mapped to `household_id` 24.\n\n**NOTE:** The `/reporting/households/remap` endpoint does not support removing accounts from households, only mapping accounts to specific households\nor assigning an account from one household to another.\n\nAlternatively, accounts can be assigned/unassigned households by updating the `household_id` on account(s) records directly via `PUT` requests.\n\n[Update a single account](https://docs.bridgeft.com/reference/readupdatedaccount-1)\n[Update multiple accounts](https://docs.bridgeft.com/reference/readupdatedaccounts-1)\n","operationId":"updateAccountsWithHouseholds","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","example":{"216895":77458,"216919":77458}}}}},"responses":{"200":{"description":"An enveloped list of households","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/households/{id}/accounts":{"get":{"tags":["Households"],"summary":"Retrieve Accounts in a Household","description":"Returns the accounts that belong to the provided household","operationId":"getHouseholdAccounts","parameters":[{"$ref":"#/components/parameters/id"}],"responses":{"200":{"description":"A List of Accounts","content":{"application/json":{"schema":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/asset-classifications":{"get":{"tags":["Asset Classifications"],"summary":"List all Asset Classifications","description":"Returns a list of asset classifications within the data field","operationId":"getAssetClassifications","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of asset classifications","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetClassifications"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Asset Classifications"],"summary":"Bulk Update Asset Classifications","description":"Provide a list Asset Classifications to update. Then entire Asset Classification object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `security_id`\n- `class_tag_id`\n","operationId":"updateAssetClassifications","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetClassifications"}}}},"responses":{"200":{"description":"An enveloped list of asset classifications","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetClassification"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Asset Classifications"],"summary":"Create an Asset Classification","description":"Returns the created asset classification","operationId":"createAssetClassifications","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"security_id":{"description":"ID of the security being classified","type":"integer","example":332905},"created_by_user_id":{"description":"ID of the user that created the classification","type":"integer","example":265},"class_tag_id":{"description":"ID of the class tag for the classification","type":"integer","example":188}}}}}},"responses":{"200":{"description":"An enveloped list of asset classification","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetClassification"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/asset-classifications/{id}":{"get":{"tags":["Asset Classifications"],"summary":"Retrieve an Asset Classification","description":"Returns an asset classification based on a single ID","operationId":"getAssetClassification","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of asset classification","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetClassification"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Asset Classifications"],"summary":"Update an Asset Classification","description":"Provide an Asset Classification to update. Then entire Asset Classification object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `security_id`\n- `class_tag_id`\n","operationId":"updateAssetClassification","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetClassification"}}}},"responses":{"200":{"description":"An enveloped list of asset classification","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetClassification"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Asset Classifications"],"summary":"Delete an Asset Classification","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"deteleAssetClassification","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/asset-classifications/filter":{"post":{"tags":["Asset Classifications"],"summary":"Filter all Asset Classifications","description":"Returns a filtered list of Asset Classifications","operationId":"filterAssetClassifications","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this asset classification object","type":"integer","example":42788},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"security_id":{"description":"ID of the security being classified","type":"integer","example":322968},"created_by_user_id":{"description":"ID of the user that created the classification","type":"integer","example":265},"class_tag_id":{"description":"ID of the class tag for the classification","type":"integer","example":435}}}}}},"responses":{"200":{"description":"An enveloped list of asset classification","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetClassifications"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/asset-classifications/create-many":{"post":{"tags":["Asset Classifications"],"summary":"Create Many Asset Classifications","description":"Returns a list of created Asset Classifications","operationId":"createManyAssetClassifications","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"security_id":{"description":"ID of the security being classified","type":"integer","example":332905},"created_by_user_id":{"description":"ID of the user that created the classification","type":"integer","example":265},"class_tag_id":{"description":"ID of the class tag for the classification","type":"integer","example":188}}}}}}},"responses":{"200":{"description":"An enveloped list of asset classification","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/AssetClassifications"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/asset-classifications/delete-many":{"post":{"tags":["Asset Classifications"],"summary":"Delete many Asset Classifications","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyAssetClassifications","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/class-tags":{"get":{"tags":["Classification Tags"],"summary":"List all Classification Tags","description":"Returns a list of Classification Tags within the data field","operationId":"getClassificationTags","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of classification tags","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ClassificationTags"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Classification Tags"],"summary":"Bulk Update Classification Tags","description":"Provide a list of Classification Tags to update. Then entire Classification Tag object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n","operationId":"updateClassificationTags","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificationTags"}}}},"responses":{"200":{"description":"An enveloped list of classification tags","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ClassificationTags"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Classification Tags"],"summary":"Create a Classification Tag","description":"Returns the created classification tag","operationId":"createClassificationTags","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"name":{"description":"Class tag name","type":"string","example":"International"}}}}}},"responses":{"200":{"description":"An enveloped list of classification tags","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ClassificationTag"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/class-tags/{id}":{"get":{"tags":["Classification Tags"],"summary":"Retrieve a Classification Tag","description":"Returns a classification tag based on a single ID","operationId":"getClassificationTag","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of classification tag","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ClassificationTag"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Classification Tags"],"summary":"Update a Classification Tag","description":"Provide a Classification Tag to update. The entire Classification Tag object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n","operationId":"updateClassificationTag","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassificationTag"}}}},"responses":{"200":{"description":"An enveloped list of classification tag","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ClassificationTag"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Classification Tags"],"summary":"Delete a classification Tag","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"deteleClassificationTag","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/class-tags/filter":{"post":{"tags":["Classification Tags"],"summary":"Filter all Classification Tags","description":"Returns a filtered list of classification tags","operationId":"filterClassificationTags","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this class tag object","type":"integer","example":180},"name":{"description":"Class tag name","type":"string","example":"International"},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"created_dt_utc":{"description":"Created timestamp in UTC","type":"string","format":"date-time","example":"2017-12-27T16:47:11.253166Z"}}}}}},"responses":{"200":{"description":"An enveloped list of classification tags","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ClassificationTags"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/class-tags/create-many":{"post":{"tags":["Classification Tags"],"summary":"Create Many Classification Tags","description":"Returns a list of created Classification Tags","operationId":"createManyClassificationTags","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"name":{"description":"Class tag name","type":"string","example":"International"}}}}}}},"responses":{"200":{"description":"An enveloped list of classification tags","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ClassificationTags"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/class-tags/delete-many":{"post":{"tags":["Classification Tags"],"summary":"Delete many Classification Tags","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyClassificationTags","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/benchmarks":{"get":{"tags":["Benchmarks"],"summary":"List all Benchmarks","description":"Returns a list of Benchmarks within the data field","operationId":"getBenchmarks","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Benchmarks","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Benchmarks"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Benchmarks"],"summary":"Bulk Update Benchmarks","description":"Provide a list of Benchmarks to update. Then entire Benchmark object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `coefficients`\n","operationId":"updateBenchmarks","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Benchmarks"}}}},"responses":{"200":{"description":"An enveloped list of Benchmarks","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Benchmarks"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Benchmarks"],"summary":"Create a Benchmark","description":"Returns the created Benchmark","operationId":"createBenchmarks","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"name":{"description":"Benchmark name","type":"string","example":"Major Index"},"slug":{"description":"Slugified benchmark name","type":"string","example":"major-index"}}}}}},"responses":{"200":{"description":"An enveloped list of Benchmark","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Benchmark"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/benchmarks/{id}":{"get":{"tags":["Benchmarks"],"summary":"Retrieve a Benchmark","description":"Returns a Benchmark based on a single ID","operationId":"getBenchmark","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Benchmark","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Benchmark"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Benchmarks"],"summary":"Update a Benchmark","description":"Provide a Benchmark to update. Then entire Benchmark object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `coefficients`\n","operationId":"updateBenchmark","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Benchmark"}}}},"responses":{"200":{"description":"An enveloped list of Benchmark","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Benchmark"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Benchmarks"],"summary":"Delete a Benchmark","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"deteleBenchmark","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/benchmarks/filter":{"post":{"tags":["Benchmarks"],"summary":"Filter all Benchmarks","description":"Returns a filtered list of Benchmarks","operationId":"filterBenchmarks","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this benchmark object","type":"integer","example":11149},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"name":{"description":"Benchmark name","type":"string","example":"S&P 500"},"slug":{"description":"Slugified benchmark name","type":"string","example":"sandp-500"}}}}}},"responses":{"200":{"description":"An enveloped list of Benchmarks","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Benchmark"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/benchmarks/create-many":{"post":{"tags":["Benchmarks"],"summary":"Create Many Benchmarks","description":"Returns a list of created Benchmarks","operationId":"createManyBenchmarks","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1reporting~1benchmarks/post/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of benchmarks","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Benchmarks"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/benchmarks/delete-many":{"post":{"tags":["Benchmarks"],"summary":"Delete many Benchmarks","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyBenchmarks","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/target-allocations":{"get":{"tags":["Target Allocations"],"summary":"List all Target Allocations","description":"Returns a list of Target Allocations within the data field","operationId":"getTargetAllocations","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Target Allocations","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/TargetAllocations"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Target Allocations"],"summary":"Bulk Update Target Allocations","description":"Provide a list of Target Allocations to update. Then entire Target Allocation object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `coefficients`\n","operationId":"updateTargetAllocations","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetAllocations"}}}},"responses":{"200":{"description":"An enveloped list of Target Allocations","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/TargetAllocations"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Target Allocations"],"summary":"Create a Target Allocation","description":"Returns the created Target Allocation","operationId":"createTargetAllocations","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"name":{"description":"Name for the target allocation","type":"string","example":"Conservative"},"slug":{"description":"Slugified target allocation name","type":"string","example":"conservative"},"coefficients":{"description":"Target allocation coefficient","type":"array","items":{"type":"object","properties":{"mac":{"description":"Master asset class associated with this coefficient","type":"string"},"weight":{"description":"Weight of the coefficient","type":"number"},"class_tag_id":{"description":"Asset classification tag id associated with the coefficient","type":"integer","nullable":true},"negative_tolerance":{"description":"Value of negative tolerance","type":"number"},"positive_tolerance":{"description":"Value of positive tolerance","type":"number"}}},"example":[{"mac":"EQ","weight":40,"class_tag_id":null,"negative_tolerance":5,"positive_tolerance":5},{"mac":"DT","weight":50,"class_tag_id":null,"negative_tolerance":5,"positive_tolerance":5}]}}}}}},"responses":{"200":{"description":"An enveloped list of Target Allocation","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/TargetAllocation"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/target-allocations/{id}":{"get":{"tags":["Target Allocations"],"summary":"Retrieve a Target Allocation","description":"Returns a Target Allocation based on a single ID","operationId":"getTargetAllocation","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Target Allocation","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/TargetAllocation"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Target Allocations"],"summary":"Update a Target Allocation","description":"Provide a Target Allocation to update. Then entire Target Allocation object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `coefficients`\n","operationId":"updateTargetAllocation","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetAllocation"}}}},"responses":{"200":{"description":"An enveloped list of Target Allocation","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/TargetAllocation"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Target Allocations"],"summary":"Delete a Target Allocation","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"deteleTargetAllocation","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/target-allocations/filter":{"post":{"tags":["Target Allocations"],"summary":"Filter all Target Allocations","description":"Returns a filtered list of Target Allocations","operationId":"filterTargetAllocations","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this target allocation object","type":"integer","example":1},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"name":{"description":"Name for the target allocation","type":"string","example":"Conservative"},"slug":{"description":"Slugified target allocation name","type":"string","example":"conservative"}}}}}},"responses":{"200":{"description":"An enveloped list of Target Allocation","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/TargetAllocation"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/target-allocations/create-many":{"post":{"tags":["Target Allocations"],"summary":"Create Many Target Allocations","description":"Returns a list of created Target Allocations","operationId":"createManyTargetAllocations","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1reporting~1target-allocations/post/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of Target Allocations","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/TargetAllocations"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/target-allocations/delete-many":{"post":{"tags":["Target Allocations"],"summary":"Delete many Target Allocations","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyTargetAllocations","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/printable-reports":{"get":{"tags":["Printable Reports"],"summary":"List all Printable Reports","description":"Returns a list of Printable Reports within the data field","operationId":"getPrintableReports","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Printable Reports","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/PrintableReports"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/printable-reports/{id}":{"get":{"tags":["Printable Reports"],"summary":"Retrieve a Printable Report","description":"Returns a Printable Report based on a single ID","operationId":"getPrintableReport","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Printable Reports","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/PrintableReport"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Printable Reports"],"summary":"Delete a Printable Report","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"detelePrintableReport","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/printable-reports/filter":{"post":{"tags":["Printable Reports"],"summary":"Filter all Printable Reports","description":"Returns a filtered list of Printable Reports","operationId":"filterPrintableReports","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this printable report object","type":"integer","example":1290371},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"account_id":{"description":"ID of the account that the report is on. Null if household_id is non-null.","type":"integer","nullable":true,"example":null},"household_id":{"description":"ID of the household that the report is on. Null if account_id is non-null.","type":"integer","example":27585},"created_by_user_id":{"description":"ID of the user that created the report","type":"integer","example":8882},"report_date":{"description":"report date","type":"string","format":"date","example":"2022-08-31"},"frequency":{"description":"See Frequency Codes","type":"string","nullable":true,"example":null},"start_date":{"description":"start date","type":"string","format":"date","example":"2022-08-01"},"end_date":{"description":"end date","type":"string","format":"date","example":"2022-08-31"},"timestamp_utc":{"description":"Created/last updated timestamp in UTC","type":"integer","example":1660575976},"dt_utc":{"description":"Created/last updated timestamp in datetime UTC","type":"string","format":"date-time","example":"0001-01-01T00:00:00Z"},"size_bytes":{"description":"Size of the printable report in bytes","type":"integer","example":115805},"client_accessible":{"description":"If true, the report is accessible in the client portal","type":"boolean","example":false},"state":{"description":"0 if the report is generating, R if it's ready, and E if it's failed","type":"string","example":"0"},"error_message":{"description":"Error message if in error state E","type":"string","nullable":true,"example":null}}}}}},"responses":{"200":{"description":"An enveloped list of Printable Reports","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/PrintableReports"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/printable-reports/create":{"post":{"tags":["Printable Reports"],"summary":"Start a PDFReport Job","description":"Starts a Background Job for PDF Reporting and returns the created Background Job Instance\n\n**Available Sub Reports**\n   - `account_summary`\n   - `allocation_and_performance_summary`\n   - `appraisals`\n   - `appraisals_wo_cost_basis`\n   - `asset_allocation_top_holdings`\n   - `benchmark_perf_summary`\n   - `buy_sells`\n   - `consolidated_summary`\n   - `deposits_withdrawals`\n   - `household_performance_attribution`\n   - `income`\n   - `management_fees`\n   - `net_investment_chart`\n   - `performance_summary`\n   - `performance_chart`\n   - `portfolio_snapshot`\n   - `realized_gain_loss`\n   - `risk_return_chart`\n   - `security_performance`\n   - `target_vs_actual_allocation`\n","operationId":"filterPrintableReportStartPDF","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["start_date","end_date","sub_reports"],"properties":{"account_ids":{"type":"array","nullable":true,"items":{"type":"integer"},"description":"List of account ids to run a PDF Report for","example":[1,2,3]},"household_ids":{"type":"array","nullable":true,"items":{"type":"integer"},"description":"List of household ids to run a PDF Report for","example":[4,5,6]},"start_date":{"type":"string","description":"Date to start the PDF Report calculations for this job","example":"2022-08-01"},"end_date":{"type":"string","description":"Date to end the PDF Report calculations for this job","example":"2022-08-31"},"sub_reports":{"type":"array","items":{"type":"string"},"description":"The list of sub reports to create during PDF Report generation","example":["account_summary","consolidated_summary","performance_summary"]},"irr_performance":{"type":"boolean","description":"If true is passed, performance calculations will use IRR methodology instead of the default TWR"},"non_inception_performance_chart":{"type":"boolean","description":"If true is passed, the performance chart will be PTD instead of the default ITD"},"portrait_pdf_orientation":{"type":"boolean","description":"If true is passed, the pdf will be rendered in portrait orientation instead of the default landscape"},"exclude_portfolio_performance_summary":{"type":"boolean","description":"If true is passed, the Asset Allocation and Performance Summary Report will be exclude the Portfolio Performance Summary section.\nThe Portfolio Performance Summary includes calculates from the inception date of the account/household, so users may want to exclude the report\nto only show values for the reporting period.\n"},"settings_overrides":{"type":"object","description":"`settings_overrides` provides the ability to override default report settings that are set by default in the `Firm` resource.\n","properties":{"logo_settings":{"type":"object","description":"Overrides the default `logo` on the generated PDF report.\n","properties":{"logo":{"type":"string","description":"Base64 encoded data of a PNG or a JPEG image to be placed on the generated PDF report."},"logo_mime_type":{"type":"string","description":"The mime type of the provided image. Accepted values are `image/png` and `image/jpeg`","enum":["image/png","image/jpeg"]}}},"disclosures":{"type":"string","description":"Disclosure message to be placed at the end of the PDF report. HTML can be provided here to format the message on the PDF template accordingly.\n"}}}}}}}},"responses":{"200":{"description":"An enveloped list of Jobs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Job"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/printable-reports/download/{id}":{"post":{"tags":["Printable Reports"],"summary":"Download a Printable Report","description":"Returns the PDF for the provided printable report ID.","operationId":"getPrintableReportDownloadStream","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Content-Type":{"description":"application/pdf","type":"string"},"Accept":{"description":"application/pdf","type":"string"}}}}}},"responses":{"200":{"description":"A printable report PDF object","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/printable-reports/download":{"post":{"tags":["Printable Reports"],"summary":"Bulk Download Printable PDFs","description":"Starts and returns a bulk download job","operationId":"filterPrintableReportBulkDownload","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"A list of PDF Report ids that will be archived during the bulk download job."}}}}}},"responses":{"200":{"description":"An enveloped list of Jobs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Job"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/printable-reports/delete-many":{"post":{"tags":["Printable Reports"],"summary":"Delete many Printable Reports","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyPrintableReports","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/report-settings":{"get":{"deprecated":true,"tags":["Report Settings"],"summary":"List all Report Settings","description":"Returns a list of Report Settings within the data field","operationId":"getReportSettings","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Report Settings","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ReportSettings"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Report Settings"],"summary":"Bulk Update Report Settings","description":"Returns the updated Report Settings","operationId":"updateReportSettings","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Report Settings","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ReportSettings"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/report-settings/{id}":{"get":{"deprecated":true,"tags":["Report Settings"],"summary":"Retrieve Report Settings","description":"Returns report settings based on a single ID","operationId":"getReportSetting","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Report Settings","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ReportSetting"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Report Settings"],"summary":"Update Report Settings","description":"Returns the updated Report Settings","operationId":"updateReportSetting","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Report Settings","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ReportSetting"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/report-settings/filter":{"post":{"deprecated":true,"tags":["Report Settings"],"summary":"Filter all Report Settings","description":"Returns a filtered list of Report Settings","operationId":"filterReportSettings","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this report settings object","type":"integer","example":95},"firm_id":{"description":"ID of the owning firm","type":"integer","example":39},"user_id":{"description":"ID of the user concerned with creating the report. If null, applied settings will be firm-wide. Otherwise, the settings are specific to the given user","type":"integer","nullable":true,"example":null},"component":{"description":"Specifies to which area these settings apply (i.e., printable reports, the advisor's default settings, the client's default settings). Can either be printable, advisor_defaults, client_defaults, or user","type":"string","enum":["printable","advisor_defaults","client_defaults","user"],"example":"advisor_defaults"},"account_summary":{"description":"Include account summary?","type":"boolean","example":true},"consolidated_summary":{"description":"Include consolidated summary?","type":"boolean","example":true},"performance_summary":{"description":"Include performance summary?","type":"boolean","example":true},"benchmark_perf_summary":{"description":"Include benchmark performance summary?","type":"boolean","example":true},"performance_chart":{"description":"Include performance chart?","type":"boolean","example":true},"appraisals":{"description":"Include appraisals?","type":"boolean","example":true},"asset_allocation_top_holdings":{"description":"Include asset allocation top holdings?","type":"boolean","example":true},"buy_sells":{"description":"Include buys and sells?","type":"boolean","example":true},"deposits_withdrawals":{"description":"Include deposits and withdrawals?","type":"boolean","example":true},"income":{"description":"Include income?","type":"boolean","example":true},"realized_gain_loss":{"description":"Include realized gain loss?","type":"boolean","example":true},"management_fees":{"description":"Include management fees?","type":"boolean","example":true},"net_investment_chart":{"description":"Include net investment chart?","type":"boolean","example":true},"portfolio_snapshot":{"description":"Include portfolio snapshot?","type":"boolean","example":false}}}}}},"responses":{"200":{"description":"An enveloped list of Report Settings","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/ReportSettings"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/reporting/web-reports":{"post":{"tags":["Web Reports"],"summary":"Run a web report","description":"Runs a web report and returns the reporting output synchronously\n\n**Available Sub Reports**\n- `account_summary`\n- `allocation_and_performance_summary`\n- `appraisals`\n- `appraisals_wo_cost_basis`\n- `asset_allocation_top_holdings`\n- `benchmark_perf_summary`\n- `buy_sells`\n- `consolidated_summary`\n- `deposits_withdrawals`\n- `household_performance_attribution`\n- `income`\n- `management_fees`\n- `net_investment_chart`\n- `performance_summary`\n- `performance_chart`\n- `portfolio_snapshot`\n- `realized_gain_loss`\n- `risk_return_chart`\n- `security_performance`\n- `target_vs_actual_allocation`\n","operationId":"webReportStart","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["start","end","firm_id","sub_reports"],"properties":{"start":{"type":"string","nullable":false,"description":"The start date of the report data to be generated","example":"2022-08-01"},"end":{"type":"string","nullable":false,"description":"The end date of the report data to be generated","example":"2022-08-31"},"firm_id":{"type":"integer","nullable":true,"description":"The firm id for which report data will be generated","example":123},"account_id":{"type":"integer","nullable":true,"description":"The account id for which report data will be generated; null for a household report","example":123},"household_id":{"type":"integer","nullable":true,"description":"The household id for which report data will be generated; null for an account report","example":123},"irr_performance":{"type":"boolean","nullable":true,"description":"True for internal rate of return performance calculations; false for time weighted return performance calculations","example":false},"sub_reports":{"type":"array","items":{"type":"string"},"description":"The list of sub reports to generate data for","example":["account_summary","consolidated_summary","performance_summary"]}}}}}},"responses":{"200":{"description":"A json payload of report data","content":{"application/json":{"schema":{"type":"object","properties":{"input":{"description":"Relevant input data for the requested report invocation","type":"object","properties":{"standard_period_frequency":{"type":"integer","nullable":true,"deprecated":true},"standard_period_month":{"type":"integer","nullable":true,"deprecated":true},"standard_period_year":{"type":"integer","nullable":true,"deprecated":true},"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"},"account_id":{"type":"integer"},"household_id":{"type":"integer"},"sub_reports":{"type":"array","items":{"type":"string","enum":["account_summary","allocation_and_performance_summary","appraisals","appraisals_wo_cost_basis","asset_allocation_top_holdings","benchmark_perf_summary","buy_sells","consolidated_summary","deposits_withdrawals","household_performance_attribution","income","management_fees","net_investment_chart","performance_summary","performance_chart","portfolio_snapshot","realized_gain_loss","risk_return_chart","security_performance","target_vs_actual_allocation"]}},"firm_id":{"type":"integer"}}},"entity_info":{"title":"Entity info","description":"A collection of reporting-relevant data structures","type":"object","properties":{"account":{"$ref":"#/components/schemas/Account","nullable":true},"household":{"$ref":"#/components/schemas/Household","nullable":true},"accounts":{"$ref":"#/components/schemas/Accounts"},"manual_accounts":{"$ref":"#/components/schemas/Accounts","nullable":true},"account_by_id":{"title":"Accounts by id","description":"A map of all constituent accounts keyed by their ids","type":"object","additionalProperties":{"$ref":"#/components/schemas/Account"}},"manual_accounts_by_id":{"title":"Manual accounts by id","description":"A map of just the manual constituent accounts keyed by their ids","type":"object","additionalProperties":{"$ref":"#/components/schemas/Account"}},"account_ids":{"title":"Account ids","description":"An array of the constituent account ids","type":"array","items":{"type":"integer"}},"non_manual_account_ids":{"title":"Non-manual account ids","description":"An array of the ids of all non-manual consituent accounts","type":"array","items":{"type":"integer"}},"account_numbers":{"title":"Account numbers","description":"An array of the constituent account numbers","type":"array","items":{"type":"string"}},"account_numbers_by_account_id":{"title":"Account numbers by account id","description":"A map of all constituent account numbers keyed by their ids","type":"object","additionalProperties":{"type":"string"}},"firm":{"title":"Firm","description":"A json representation of the owning firm","$ref":"#/components/schemas/Firm"}}},"sub_report_data":{"title":"Sub report data","description":"A collection of data corresponding to the Atlas subreports that were requested","type":"object","properties":{"account_summary":{"description":"(will not be present if a household report was requested)","type":"object","properties":{"inception":{"description":"Top-level summary data since inception","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/portfolio_summary"},"period":{"description":"Top-level summary data for the requested report period","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/portfolio_summary"},"latest_performance":{"description":"Portfolio returns over a selection of standard reporting intervals ending on the requested end date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/latest_performance"},"performance":{"description":"An array of standard performance reporting intervals for each month-end in the portfolio time series","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/latest_performance"}},"benchmark_performance":{"description":"An array containing the latest_performance for benchmark associated with the household","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/benchmark_performance"}},"monthly_itd_chart":{"description":"Charting data on a monthly interval for inception to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"monthly_ptd_chart":{"description":"Charting data on a monthly interval for the period to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"daily_itd_chart":{"description":"Charting data on a daily interval for inception to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"daily_ptd_chart":{"description":"Charting data on a daily interval for the period to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"weekly_itd_chart":{"description":"Charting data on a weekly interval for inception to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"weekly_ptd_chart":{"description":"Charting data on a weekly interval for the period to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"period_has_data":{"description":"A boolean indicating if this subreport has data for the requested period","type":"boolean"}}},"allocation_and_performance_summary":{"type":"object","properties":{"allocations":{"type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/allocations/items"}},"allocations_total_value":{"type":"number"},"allocations_total_weight":{"type":"number"},"portfolio_summary":{"type":"object","properties":{"beginning_balance":{"description":"The balance value at the beginning of the applicable time interval","type":"number","format":"float"},"ending_balance":{"description":"The balance value at the end of the applicable time interval","type":"number","format":"float"},"beginning_balance_date":{"description":"The date that corresponds to beginning_balance","type":"string"},"ending_balance_date":{"description":"The date that corresponds to the ending_balance","type":"string"},"income":{"description":"Total income over the time interval","type":"number","format":"float"},"contributions":{"description":"Total contributions over the time interval","type":"number","format":"float"},"withdrawals":{"description":"Total withdrawals over the time interval","type":"number","format":"float"},"net_contributions":{"description":"Contributions minus withdrawals","type":"number","format":"float"},"net_appreciation":{"description":"Market apprecation net of contributions over the time interval","type":"number","format":"float"},"manual_account_outside_income":{"description":"Income from manual accounts","type":"number","format":"float"}}},"latest_performance":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/latest_performance"},"benchmark_performance":{"type":"object","properties":{"date":{"description":"The end of the reporting period","type":"string","example":"2022-08-31"},"benchmark_id":{"description":"Description of the entity the performance data pertains to","type":"string"},"ptd_return":{"description":"The performance return for the requested period to date, on the real scale","type":"number","format":"float","example":-12.75},"mtd_return":{"description":"The performance return for the month to date, on the real scale","type":"number","format":"float"},"qtd_return":{"description":"The performance return for the quarter to date, on the real scale","type":"number","format":"float"},"ytd_return":{"description":"The performance return for the year to date, on the real scale","type":"number","format":"float"},"itd_return":{"description":"The performance return from the entity inception to date, on the real scale","type":"number","format":"float"},"three_yr_return":{"description":"The performance return for the three-year period to date, on the real scale; null if not enough data history is present","type":"number","format":"float","nullable":true},"five_yr_return":{"description":"The performance return for the five-year period to date, on the real scale null if not enough data history is present","type":"number","format":"float","nullable":true},"ltm_return":{"description":"The performance return for the twelve-month period to day, on the real scale;","type":"number","format":"float"},"is_custom_period":{"description":"True if the period is non-standard","type":"boolean"}}}}},"appraisal":{"type":"object","properties":{"cash":{"description":"The cash appraisal","type":"object","properties":{"title":{"description":"The title of the asset class category","type":"string"},"currency":{"description":"The currency value as a dollar ammount","type":"number","format":"float"},"currency_weight":{"description":"The weight of the currency value out of the entire portfolio","type":"number","format":"float"},"subtotal":{"description":"The cash currency subtotals","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/portfolio_total"}}},"by_mac":{"description":"A map of appraisals keyed on master asset class","type":"object","properties":{"CA":{"description":"The cash appraisal table","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"},"DT":{"description":"The fixed income appraisal table","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"},"EQ":{"description":"The equity appraisal table","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"},"MX":{"description":"The \"other\" appraisal table","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"}}},"by_cac":{"description":"A map of appraisals keyed on custom asset classification, if there are any","type":"object","additionalProperties":{"type":"object","properties":{"title":{"description":"The title of the asset class category","type":"string"},"holdings":{"description":"The holdings in this asset class category","type":"array","items":{"type":"object","properties":{"date":{"description":"The date of the holding","type":"string"},"weight_percent":{"description":"The weight of this holding out of the entire portfolio","type":"number","format":"float"},"master_asset_class":{"description":"The master asset code of this holding's asset class category","type":"string"},"cac_tag_name":{"description":"The custom asset code of this holding's asset class category, if one applies","type":"string"},"abs_purchase_cost":{"description":"The absolute value of the purhcase cost of this holding","type":"number","format":"float"},"signed_purchase_cost":{"description":"The signed value of the purchase cost of this holding","type":"number","format":"float"},"purchase_date":{"description":"The purchase date of this holding","type":"string"},"unrealized_gain_loss":{"description":"The unrealized gain/loss of this holding","type":"number","format":"float"},"unrealized_return":{"description":"The unrealized return of this holding on the real scale","type":"number","format":"float","example":0.851},"market_unit_price":{"description":"The market unit price of this holding's security","type":"number","format":"float"},"purchase_cost_unit_price":{"description":"The unit cost of this holding's security at purchase","type":"number","format":"float"},"security_yield":{"description":"The yield of this holding's security, if known, on the real scale","type":"number","format":"float","example":0.851},"security_yield_percent":{"description":"The yield of this holding's security, if known, on the percent scale","type":"number","format":"float","example":85.1},"estimated_annual_income":{"description":"The estimated annual income of this holding","type":"number","format":"float"},"signed_units":{"description":"The signed quantity (shares) of this holding","type":"number","format":"float"},"security_description":{"description":"A description of this holding's security","type":"string"},"security_symbol":{"description":"The symbol of this holding's security","type":"string","example":"SPY"},"qty":{"description":"The absolute quantity (shares) of this holding","type":"number","format":"float"},"has_cost_basis":{"description":"A boolean to indicate if this holding has cost basis information","type":"boolean"}}}},"mac":{"description":"The master asset class code of the asset class category","type":"string"},"cac":{"description":"The custom asset class title the class category has been assigned, if applicable.","type":"string","nullable":true},"subtotal":{"description":"The subtotals of the asset class category","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/portfolio_total"},"ordered_holdings":{"description":"The holdings in this asset class category orderd by weight in ascending order","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/other_appraisal/properties/holdings/items"}}}}},"positions":{"description":"An array of all current positions","type":"array","items":{"$ref":"#/components/schemas/Position"}},"portfolio_total":{"description":"Weighted totals of all the appraisal categories, summing to the current state of the porfolio","type":"object","properties":{"value":{"description":"The total market value of the holdings in the given asset class category","type":"number","format":"float"},"cost":{"description":"The total cost basis of the holdings in the given asset class category","type":"number","format":"float"},"unrealized_gain_loss":{"description":"The total unrealized gain/loss of the holdings in the given asset class category","type":"number","format":"float"},"unrealized_return":{"description":"The total unrealized return as a percent of the holdings in the given asset class category","type":"number","format":"float"},"yield":{"description":"The total average yield of the holdings in the given asset class category","type":"number","format":"float"},"estimated_income":{"description":"The total estimated income of the holdings in the given asset class category","type":"number","format":"float"},"weight":{"description":"The total weight of the holdings in the given asset class category out of the entire portfolio.","type":"number","format":"float"}}},"equity_appraisal":{"description":"The equity appraisal table","nullable":true,"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"},"money_market_appraisal":{"description":"The money market appraisal table","nullable":true,"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"},"fixed_income_appraisal":{"description":"The fixed icome appraisal table","nullable":true,"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"},"other_appraisal":{"description":"The \"other\" appraisal table","nullable":true,"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/appraisal/properties/by_cac/additionalProperties"},"period_has_data":{"description":"A boolean to indicate if the report entity has appraisal data","type":"boolean"}}},"buysell":{"type":"object","properties":{"items":{"description":"An array of reporting buy sells objects","type":"array","items":{"type":"object","properties":{"luca_buy_sells":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/security_performance/properties/buy_sells_by_security_id/additionalProperties/items"},"security_description":{"description":"A description the the security","type":"string"}}}},"total":{"description":"The signed sum total of all buy sells","type":"number","format":"float"}}},"deposit_withdrawal":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"luca_deposits_withdrawals":{"type":"object","properties":{"transfer":{"$ref":"#/components/schemas/Transfer"},"security":{"$ref":"#/components/schemas/Security"}}},"security_description":{"description":"A description of the security","type":"string"}}}},"total":{"description":"The signed sum total of all deposits and withdrawals","type":"number","format":"float"}}},"drift":{"type":"object","properties":{"target_deviations":{"description":"An array of target deviations","type":"object","properties":{"classification_name":{"description":"The label of the given asset classification category","type":"string"},"mac":{"description":"The master asset class code","type":"string"},"cac":{"description":"The name of the custom asset classification category, if applicable","type":"string"},"positive_tolerance":{"description":"The amount the actual allocation is allowed to be above the target, by rule","type":"number","format":"float"},"negative_tolerance":{"description":"The amount the actual allocation is allowed to be below the target, by rule","type":"number","format":"float"},"target_weight":{"description":"The target allocation for the asset classification category","type":"number","format":"float"},"actual_weight":{"description":"The actual allocation for the asset classification category","type":"number","format":"float"},"target_value":{"description":"The calculated dollar value of the target wieght","type":"number","format":"float"},"actual_value":{"description":"The dollar value of the actual weight","type":"number","format":"float"},"percent_diff":{"description":"The target_weight minus the actual_weight","type":"number","format":"float"},"value_diff":{"description":"The target_value minus the actual_value","type":"number","format":"float"}}},"target_allocation_name":{"description":"The label of the target allocation","type":"string"}}},"gainloss":{"type":"object","properties":{"items":{"description":"An array of gain loss objects","type":"array","items":{"type":"object","properties":{"luca_gain_loss":{"$ref":"#/components/schemas/SourceRealizedGainLoss"},"security_id":{"description":"The id of the associated security","type":"integer"},"security_symbol":{"description":"The symbol of the associated security","type":"string"},"security_description":{"description":"The description of the associated security","type":"string"},"return":{"description":"The realized return on the real scale","example":51.55,"type":"number","format":"float"}}}},"total_cost":{"description":"The sum total of all gain loss object open values","type":"number","format":"float"},"total_proceeds":{"description":"The sum total of gain loss object close values","type":"number","format":"float"},"total_amount":{"description":"The sum total of gain loss object amount values","type":"number","format":"float"},"total_return_percent":{"description":"The realized return on the percent scale","type":"number","format":"float"}}},"household_summary":{"description":"(will not be present if an account report was requested)","type":"object","properties":{"inception":{"description":"Top-level summary data since inception","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/portfolio_summary"},"period":{"description":"Top-level summary data for the requested report period","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/portfolio_summary"},"latest_performance":{"description":"Portfolio returns over a selection of standard reporting intervals ending on the requested end date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/latest_performance"},"performance":{"description":"An array of standard performance reporting intervals for each month-end in the portfolio time series","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/latest_performance"}},"benchmark_performance":{"description":"An array containing the latest_performance for benchmark associated with the household","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/benchmark_performance"}},"monthly_itd_chart":{"description":"Charting data on a monthly interval for inception to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"monthly_ptd_chart":{"description":"Charting data on a monthly interval for the period to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"daily_itd_chart":{"description":"Charting data on a daily interval for inception to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"daily_ptd_chart":{"description":"Charting data on a daily interval for the period to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"weekly_itd_chart":{"description":"Charting data on a weekly interval for inception to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"weekly_ptd_chart":{"description":"Charting data on a weekly interval for the period to date","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart"},"account_summaries":{"description":"An array holding the summaries of all household accounts","type":"array","items":{"type":"object","properties":{"account":{"description":"The account representation","$ref":"#/components/schemas/Account"},"inception":{"description":"Top-level summary data for said account since inception","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/portfolio_summary"},"period":{"description":"Top-level summary data for said account for the requested report period","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/portfolio_summary"}}}},"account_performance":{"description":"An array holding the performance snapshots of all household accounts","type":"array","items":{"type":"object","properties":{"date":{"description":"The end of the reporting period","type":"string","example":"2022-08-31"},"series_id":{"description":"Description of the entity the performance data pertains to","type":"string"},"ptd_return":{"description":"The performance return for the requested period to date, on the real scale","type":"number","format":"float","example":-12.75},"mtd_return":{"description":"The performance return for the month to date, on the real scale","type":"number","format":"float"},"qtd_return":{"description":"The performance return for the quarter to date, on the real scale","type":"number","format":"float"},"ytd_return":{"description":"The performance return for the year to date, on the real scale","type":"number","format":"float"},"itd_return":{"description":"The performance return from the entity inception to date, on the real scale","type":"number","format":"float"},"three_yr_return":{"description":"The performance return for the three-year period to date, on the real scale; null if not enough data history is present","type":"number","format":"float","nullable":true},"five_yr_return":{"description":"The performance return for the five-year period to date, on the real scale null if not enough data history is present","type":"number","format":"float","nullable":true},"ltm_return":{"description":"The performance return for the twelve-month period to day, on the real scale;","type":"number","format":"float"},"is_custom_period":{"description":"True if the period is non-standard","type":"boolean"},"account":{"description":"A representation of this account","$ref":"#/components/schemas/Account"}}}},"account_valuations":{"description":"An array holding the account valuation summaries of all household accounts","type":"array","items":{"type":"object","properties":{"account":{"description":"A representation of the account","$ref":"#/components/schemas/Account"},"cash":{"description":"The cash value of the account balance","type":"number","format":"float"},"equity":{"description":"The equity value of the account balance","type":"number","format":"float"},"fixed_income":{"description":"The fixed income value of the account balance","type":"number","format":"float"},"other":{"description":"The unclassified value of the account balance","type":"number","format":"float"},"total":{"description":"The total value of the account balance","type":"number","format":"float"},"valuation_from_balance":{"description":"When true, the account breakdown by MAC is not available","type":"boolean"}}}},"heldaway_valuations":{"description":"An array holding the heldaway summaries for all household accounts","type":"array","items":{"type":"object","properties":{"name":{"description":"The heldaway account name","type":"string"},"institution_name":{"description":"The name of the heldaway institution","type":"string"},"account_mask":{"description":"The masked heldaway account identifier","type":"string"},"account_type":{"description":"The heldaway account type","type":"string"},"balance":{"description":"The heldaway account balance","type":"number","format":"float"}}}},"period_has_data":{"description":"A boolean indicating if this subreport has data for the requested period","type":"boolean"}}},"income_expense":{"type":"object","properties":{"items":{"description":"An array of all income expense transactions in the reporting period","type":"array","items":{"type":"object","properties":{"luca_income":{"type":"object","properties":{"income_expense":{"description":"An income/expense object","$ref":"#/components/schemas/IncomeExpense"},"security":{"description":"The security associated with the income/expense","$ref":"#/components/schemas/Security"}}},"security_description":{"description":"The security description of the income/expense","type":"string"},"transaction_type_display":{"description":"The classification of the income/expense transaction","type":"string","enum":["Dividend","Interest","Management Fee","Tax","Income","Expense","Other"]}}}},"total":{"description":"Signed total of all income expense transactions in the reporting period","type":"number","format":"float"}}},"management_fee":{"type":"object","properties":{"items":{"description":"An array of all the management fee transactions in the reporting period","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/income_expense/properties/items/items"}},"total":{"description":"The absolute value of management fee transactions in the report period","type":"number","format":"float"}}},"risk_return_chart":{"type":"object","properties":{"monthly_risk_return_data":{"description":"An array containing the risk return data for each account and benchmark series for the entity","type":"array","items":{"type":"object","properties":{"Name":{"description":"The name of the entity the risk data applies to","type":"string"},"Frequency":{"description":"The frequency interval being used for risk/return observation","type":"string"},"StartDate":{"description":"The start date of the risk return report range","type":"string"},"EndDate":{"description":"The end date of the risk return report range","type":"string"},"AvgReturn":{"description":"The average monthly return of the given entity, on the real scale","type":"number","format":"float"},"StdDev":{"description":"The standard deviation of monthly returns of the given entity, on the real scale","type":"number","format":"float"},"HighChartTuple":{"description":"An length-1 array holding a length-2 array which holds an [x,y] pair of [avgerage return, standard deviation] for the given entity","type":"array","items":{"type":"array","items":{"type":"number","format":"float"}}},"SharpeRatio":{"description":"The Sharpe Ratio calulated for the given entity","type":"number","format":"float"}}}},"inception_date":{"description":"The inception date of the reporting entity","type":"string"}}},"security_exclusions":{"deprecated":true,"type":"object","properties":{"excluded_assets_subtotal":{"description":"An array of excluded asset subtotals","type":"array","items":{"type":"object","properties":{"asset_class":{"description":"The name of the asset classification","type":"string"},"excluded_assets":{"description":"An array of excluded assets","type":"array","items":{"type":"object","properties":{"description":{"description":"A description of the excluded asset","type":"string"},"asset_class":{"description":"The asset classification of the excluded asset","type":"string"},"symbol":{"description":"The symbol of the excluded asset","type":"string"},"market_price":{"description":"The market price of the excluded asset","type":"number","format":"float"},"market_value":{"description":"The market value of the excluded asset","type":"number","format":"float"},"weight":{"description":"The weight of the excluded asset out of the entire portfolio","type":"number","format":"float"}}}},"subtotal":{"description":"The subtotal of excluded assets for the given asset class category","type":"object","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/security_exclusions/properties/total"}}}},"total":{"description":"The grand total of excluded assets","type":"object","properties":{"market_value":{"description":"The total of the excluded asset market values","type":"number","format":"float"},"weight":{"description":"The total of the excluded asset weights","type":"number","format":"float"}}},"security_exclusions":{"description":"An array of the applicable security exclusions","type":"array","items":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this security exclusion object","type":"integer"},"security_id":{"title":"Security id","description":"ID of the excluded security","type":"integer"},"firm_id":{"title":"Firm id","description":"ID of the owning firm","type":"integer"},"account_id":{"title":"Account id","description":"ID of the account the exclusions applies to, if applicable","type":"integer","nullable":true},"percent":{"title":"Percent","description":"A percentage value representation of the exclusions","type":"number","format":"float"},"value":{"title":"Value","description":"A dollar amount representation of the exclusion","type":"number","format":"float"},"units":{"title":"Units","description":"A share quantity representation of the exclusion","type":"number","format":"float"},"start_date":{"title":"Start date","description":"The start date of the optional exclusion applicability window","type":"string","nullable":true},"end_date":{"title":"End date","description":"The end date of the optional exclusion applicability window","type":"string","nullable":true},"created_at_utc":{"title":"Created time","description":"Timestamp of the record's creation","type":"string"},"updated_at_utc":{"title":"Updated time","description":"Timestamp of the record's last update","type":"string"},"security_description":{"title":"Security description","description":"The description of the excluded security","type":"string"},"security_symbol":{"title":"Security symbol","description":"The ticker/symbol of the excluded security","type":"string"},"security_cusip":{"title":"Security cusip","description":"The cusip of the excluded security","type":"string"}}}},"period_has_data":{"description":"A boolean to indicate if the report entity has appraisal data","type":"boolean"}}},"security_performance":{"type":"object","properties":{"performance":{"description":"An array containing a high-level performance summary of each security in the portfolio","type":"array","items":{"type":"object","properties":{"security_id":{"description":"The id of the security","type":"integer"},"symbol":{"description":"The symbol of the security","type":"string"},"cusip":{"description":"The cusip of the security","type":"string"},"description":{"description":"The description of the security","type":"string"},"beginning_market_value":{"description":"The beginning market value of the security's time series","type":"number","format":"float"},"net_additions":{"description":"Cumulative net additions in the security's time series","type":"number","format":"float"},"capital_gains":{"description":"The cumulative capital gains of the security","type":"number","format":"float"},"income":{"description":"The cumullative income of the security","type":"number","format":"float"},"ending_market_value":{"description":"The end market value of the securit's time series","type":"number","format":"float"},"total_return":{"description":"The total return of the security","type":"number","format":"float"},"projected_annual_income":{"description":"The estimated annual income of the security","type":"number","format":"float"}}}},"by_mac":{"description":"A map of security performance summaries keyed on master asset class","type":"object","properties":{"DT":{"description":"The fixed income security performance table","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/security_performance/properties/performance/items"},"EQ":{"description":"The equity security performance table","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/security_performance/properties/performance/items"},"MX":{"description":"The \"other\" security performance table","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/security_performance/properties/performance/items"}}},"by_cac":{"description":"A map of security performance summaries keyed on custom asset classification, if there are any","type":"object","additionalProperties":{"type":"object","properties":{"title":{"description":"The label of the given asset classification category","type":"string"},"rows":{"description":"An array containing all the summary records for securities in the given classification category","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/security_performance/properties/performance/items"}},"total":{"description":"The subtotals of the the given asset classification category","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/security_performance/properties/total"}}}},"total":{"description":"The grand totals of all security performance summaries","type":"object","properties":{"beginning_market_value":{"description":"The beginning market value of the security's time series","type":"number","format":"float"},"net_additions":{"description":"Cumulative net additions in the security's time series","type":"number","format":"float"},"capital_gains":{"description":"The cumulative capital gains of the security","type":"number","format":"float"},"income":{"description":"The cumullative income of the security","type":"number","format":"float"},"ending_market_value":{"description":"The end market value of the securit's time series","type":"number","format":"float"},"total_return":{"description":"The total return of the security","type":"number","format":"float"},"projected_annual_income":{"description":"The estimated annual income of the security","type":"number","format":"float"}}},"buy_sells_by_security_id":{"description":"A map of buy sells keyed on security id","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"buy_sell":{"$ref":"#/components/schemas/BuySell"},"security":{"$ref":"#/components/schemas/Security"}}}}},"transfers_by_security_id":{"description":"A map of transfers keyed on security id","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"transfer":{"$ref":"#/components/schemas/Transfer"},"security":{"$ref":"#/components/schemas/Security"}}}}}}},"snapshot":{"type":"object","properties":{"allocations":{"type":"array","items":{"type":"object","properties":{"master_asset_class":{"description":"Master asset classification","type":"string","enum":["EQ","DT","CA","CE","MX","MX","UC","ETF","CR"]},"cac":{"description":"Custom asset classification","type":"string"},"total_value":{"description":"Total value of the allocation","type":"number","format":"float"},"weight_percent":{"description":"Percent weight of the allocation out of the total portfolio value","type":"number","format":"float"}}}},"account_summary":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/account_summary","nullable":true},"household-summary":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/household_summary","nullable":true},"summary":{"type":"object","properties":{"qtd":{"type":"object","properties":{"beginning_value":{"type":"number"},"net_contribution":{"type":"number"},"net_appreciation":{"type":"number"},"total_income":{"type":"number"},"ending_value":{"type":"number"},"net_return":{"type":"number"},"manual_account_outside_income":{"type":"number"}}},"ytd":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/summary/properties/qtd"},"ltm":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/summary/properties/qtd"},"itd":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/summary/properties/qtd"}}},"show_5_yr":{"type":"boolean"},"show_3_yr":{"type":"boolean"},"latest_performance":{"type":"object","properties":{"date":{"description":"The end of the reporting period","type":"string","example":"2022-08-31"},"series_id":{"description":"Description of the entity the performance data pertains to","type":"string"},"ptd_return":{"description":"The performance return for the requested period to date, on the real scale","type":"number","format":"float","example":-12.75},"mtd_return":{"description":"The performance return for the month to date, on the real scale","type":"number","format":"float"},"qtd_return":{"description":"The performance return for the quarter to date, on the real scale","type":"number","format":"float"},"ytd_return":{"description":"The performance return for the year to date, on the real scale","type":"number","format":"float"},"itd_return":{"description":"The performance return from the entity inception to date, on the real scale","type":"number","format":"float"},"three_yr_return":{"description":"The performance return for the three-year period to date, on the real scale; null if not enough data history is present","type":"number","format":"float","nullable":true},"five_yr_return":{"description":"The performance return for the five-year period to date, on the real scale null if not enough data history is present","type":"number","format":"float","nullable":true},"ltm_return":{"description":"The performance return for the twelve-month period to day, on the real scale;","type":"number","format":"float"},"is_custom_period":{"description":"True if the period is non-standard","type":"boolean"}}},"is_household":{"type":"boolean"},"chart":{"type":"object","properties":{"frequency":{"description":"The interval frequency of the chart","type":"string","enum":["M","W","D"]},"beginning_date":{"description":"The beginning of the chart time series","type":"string","example":"2020-12-31"},"inception_return":{"description":"The charting points for portfolio performance since inception","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart/properties/benchmark_period_return/items"},"period_return":{"description":"The charting points for portfolio performance for the reporting period","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart/properties/benchmark_period_return/items"},"benchmark_inception_return":{"description":"An array containing the performance charting points for each benchmark associated with the portfolio, inception to date","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart/properties/benchmark_period_return/items"}},"benchmark_period_return":{"description":"An array containing the performance charting points for each benchmark associated with the portfolio, period to date","type":"array","items":{"type":"object","properties":{"id":{"description":"The id of the chart time series","type":"string"},"name":{"description":"The name of the chart time series","type":"string"},"points":{"description":"An array of chart points","type":"array","items":{"type":"object","properties":{"time":{"description":"The date of the chart point","type":"string","example":"2022-08-01"},"value":{"description":"The y value of the chart point","type":"number","format":"float"}}},"nullable":true}}}},"balance":{"description":"The charting points for the portfolio value time series since inception","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart/properties/benchmark_period_return/items"},"cumulative_contribution":{"description":"The charting points for the portfolio cumumulative net contribution time series since inception","$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/chart/properties/benchmark_period_return/items"}}},"benchmark_performance":{"type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/allocation_and_performance_summary/properties/benchmark_performance"}},"max_latest_date":{"type":"string"}}},"top_holding":{"type":"object","properties":{"allocations":{"description":"An array of asset allocations","type":"array","items":{"$ref":"#/paths/~1reporting~1web-reports/post/responses/200/content/application~1json/schema/properties/sub_report_data/properties/snapshot/properties/allocations/items"}},"holdings":{"description":"An array of the top ten latest holdings in the portfolio","type":"array","items":{"type":"object","properties":{"description":{"description":"The security description for the holding","type":"string"},"abs_units":{"description":"The number of shares of the security in the holding","type":"number","format":"float"},"signed_value":{"description":"The signed value of the holding","type":"number","format":"float"},"abs_value":{"description":"The absolute values of the holding","type":"number","format":"float"},"is_cash_or_equivalent":{"description":"True if the holding is cash or equivalent","type":"boolean"},"weight":{"description":"The weight of the holding out of the entire portfolio","type":"number","format":"float"}}}},"max_latest_date":{"description":"The date of the holdings","type":"string"},"has_data":{"description":"False if there is no report data","type":"boolean"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/aum":{"get":{"tags":["Assets Under Management"],"summary":"Firm-Wide AUM Records","description":"Returns a list of all firm-wide AUM records that have been calculated over-time. Firm-wide AUM is calculated by BridgeFT daily, stored as a resource and accessible over this API. This enables consumers to view firm AUM as a monthly or daily time-series.","operationId":"getAums","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"name":"firm_id","in":"query","description":"Filter by a specific `firm_id`","required":false,"schema":{"type":"integer"},"example":39},{"name":"as_of_date","in":"query","description":"Filter AUM on a specific `as_of_date`","required":false,"schema":{"type":"string","format":"date"},"example":"2023-07-26"},{"name":"frequency","in":"query","description":"Filter by Monthly or Daily AUM values (helpful for generating an AUM time-series)","required":false,"schema":{"type":"string","enum":["D","M"],"example":"D"}}],"responses":{"200":{"description":"An enveloped list of monthly and daily frequency firm-wide AUM values.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Aums"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/aum/{id}":{"get":{"tags":["Assets Under Management"],"summary":"Retrieve Firm-Wide Asset Under Management Values","description":"Returns values of assets under management Firm-wide by ID.","operationId":"getAum","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of AUM","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Aum"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/aum/get-aum":{"post":{"tags":["Assets Under Management"],"summary":"Get filtered AUM","description":"Returns a list of AUM, filtered by frequency and ordered by as_of_date","operationId":"getFilteredAums","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of AUMs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Aums"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/aum/filter":{"post":{"tags":["Assets Under Management"],"summary":"Filter Firm-Wide AUM","description":"Returns a list of all firm-wide AUM records that have been calculated over-time. Firm-wide AUM is calculated by BridgeFT daily, stored as a resource and accessible over this API. This endpoint enables consumers to view firm AUM filtered by various parameters (as of date, frequency and AUM value) provided in the request body.","operationId":"filterAums","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource ID for this AUM","type":"integer","example":294605515},"firm_id":{"description":"The firm ID of the managing firm","type":"integer","example":39},"as_of_date":{"description":"The current date of the AUM","type":"string","format":"date-time","example":"2004-05-14T00:00:00Z"},"frequency":{"description":"See Frequency Codes","type":"string","enum":["D","M"],"example":"D"},"total":{"description":"The total assets under management for the AUM","type":"number","format":"float","example":697658}}}}}},"responses":{"200":{"description":"An enveloped list of monthly and daily frequency firm-wide AUM values.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Aums"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/aum/by-account":{"post":{"tags":["Assets Under Management"],"summary":"Account AUM","description":"Returns AUM records for requested Account(s) on a selected date. Provide a list of `account_ids` and receive the assets under management value for each account.","operationId":"aumByAccount","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["as_of_date","account_ids"],"properties":{"as_of_date":{"title":"As Of Date","description":"The as of date for which account AUM is calculated.","type":"string","format":"date","example":"2023-07-26"},"account_ids":{"title":"Account IDs","description":"The list of `account_ids` to retrieve AUM values for.","type":"array","items":{"type":"integer"},"example":[383649,383912,383930]}}}}}},"responses":{"200":{"description":"Asset under management values for the provided `account_ids`","content":{"application/json":{"schema":{"type":"object","properties":{"as_of_date":{"title":"As of Date","description":"The as of date of the account AUM values.","type":"string","format":"date"},"values":{"title":"Individual Account AUM Values","description":"Individual AUM Values for the provided `account_ids`.","type":"array","items":{"type":"object","properties":{"account_id":{"title":"Account ID","description":"Unique ID of the provided Account.","type":"integer"},"aum":{"title":"Assets Under Management","description":"Total Assets Under Management for the Account.","type":"number","format":"float"}}}},"total_aum":{"title":"Total AUM","description":"The cumulative AUM of the provided `account_ids`.","type":"number","format":"float"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/aum/by-household":{"post":{"tags":["Assets Under Management"],"summary":"Household AUM","description":"Returns AUM records for requested Household(s) on a selected date. Provide a list of `household_ids` and receive the assets under management value for each household.","operationId":"aumByHousehold","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["household_ids"],"properties":{"as_of_date":{"title":"As Of Date","description":"The as of date for which household AUM is calculated.","type":"string","format":"date","example":"2023-07-26"},"household_ids":{"title":"Household IDs","description":"The list of `household_ids` to retrieve AUM values for.","type":"array","items":{"type":"integer"},"example":[91243,108660,48631]}}}}}},"responses":{"200":{"description":"Asset under management values for the provided `household_ids`","content":{"application/json":{"schema":{"type":"object","properties":{"as_of_date":{"title":"As of Date","description":"The as of date of the household AUM values.","type":"string","format":"date"},"values":{"title":"Individual Household AUM Values","description":"Individual AUM Values for the provided `household_ids`.","type":"array","items":{"type":"object","properties":{"household_id":{"title":"Household ID","description":"Unique ID of the provided Household.","type":"integer"},"aum":{"title":"Assets Under Management","description":"The Assets Under Management for the `household_id`. The value is the sum of the Assets Under Management for all funded accounts in the household.","type":"number","format":"float"}}}},"total_aum":{"title":"Total AUM","description":"The cumulative AUM of the provided `household_ids`.","type":"number","format":"float"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/account-performance":{"post":{"tags":["Account Performance"],"summary":"Account Performance Data","description":"Fetch Account Performance for a list of Account IDs","operationId":"getAccountPerformance","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["as_of_date","entity_ids"],"properties":{"entity_ids":{"title":"Entity Ids","description":"List of account Ids","type":"array","items":{"type":"integer"},"example":[27585,28028]},"as_of_date":{"title":"As of Date","description":"Date for which the account performance is calculated","type":"string","format":"date","example":"2022-07-31"}}}}}},"responses":{"200":{"description":"Performance for provided account IDs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"mtd":{"title":"MTD","description":"Month to date return, percentage scale","type":"object","properties":{"entity_id":{"title":"Entity ID","description":"Id of the account entity","type":"integer"},"net_return":{"title":"Net return","description":"Percentage net return of the account entity","type":"number","format":"float"},"current_balance":{"title":"Current balance","description":"Account's current balance","type":"number","format":"float"}}},"qtd":{"title":"QTD","description":"Quarter to date return, percentage scale","$ref":"#/paths/~1analytics~1account-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"ytd":{"title":"YTD","description":"Year to date return, percentage scale","$ref":"#/paths/~1analytics~1account-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"one":{"title":"One","description":"One year return, percentage scale","$ref":"#/paths/~1analytics~1account-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"three":{"title":"Three","description":"Three years return, percentage scale","$ref":"#/paths/~1analytics~1account-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"five":{"title":"Five","description":"Five years return, percentage scale","$ref":"#/paths/~1analytics~1account-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"itd":{"title":"ITD","description":"Inception to date return, percentage scale","$ref":"#/paths/~1analytics~1account-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"itda":{"title":"ITDA","description":"Inception to date annualized return, percentage scale","$ref":"#/paths/~1analytics~1account-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/household-performance":{"post":{"tags":["Household Performance"],"summary":"Household Performance data","description":"Fetch Household Performance for a list of Household IDs","operationId":"getHouseholdPerformance","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["entity_ids","as_of_date"],"properties":{"entity_ids":{"title":"Entity Ids","description":"List of household Ids","type":"array","items":{"type":"integer"},"example":[27585,28028]},"as_of_date":{"title":"As of Date","description":"Date for which the household performance is calculated","type":"string","format":"date","example":"2022-07-31"}}}}}},"responses":{"200":{"description":"Performance for provided household IDs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"mtd":{"title":"MTD","description":"Month to date return, percentage scale","type":"object","properties":{"entity_id":{"title":"Entity ID","description":"Id of the household entity","type":"integer"},"net_return":{"title":"Net return","description":"Percentage net return of the household entity","type":"number","format":"float"},"current_balance":{"title":"Current balance","description":"Household's current balance","type":"number","format":"float"}}},"qtd":{"title":"QTD","description":"Quarter to date return, percentage scale","$ref":"#/paths/~1analytics~1household-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"ytd":{"title":"YTD","description":"Year to date return, percentage scale","$ref":"#/paths/~1analytics~1household-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"one":{"title":"One","description":"One year return, percentage scale","$ref":"#/paths/~1analytics~1household-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"three":{"title":"Three","description":"Three years return, percentage scale","$ref":"#/paths/~1analytics~1household-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"five":{"title":"Five","description":"Five years return, percentage scale","$ref":"#/paths/~1analytics~1household-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"itd":{"title":"ITD","description":"Inception to date return, percentage scale","$ref":"#/paths/~1analytics~1household-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"},"itda":{"title":"ITDA","description":"Inception to date annualized return, percentage scale","$ref":"#/paths/~1analytics~1household-performance/post/responses/200/content/application~1json/schema/items/properties/mtd"}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/analytics/benchmark-performance":{"post":{"tags":["Benchmark Performance"],"summary":"Benchmark Performance data","description":"Fetch Benchmark Performance for a list of Benchmark IDs","operationId":"getBenchmarkPerformance","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["start_date","end_date","benchmark_ids"],"properties":{"benchmarks_ids":{"title":"Benchmark Ids","description":"List of benchmark Ids","type":"array","items":{"type":"integer"},"example":[11149,11150]},"start_date":{"title":"Start date","description":"Start date for the household performance calcuation","type":"string","format":"date","example":"2022-07-01"},"end_date":{"title":"End date","description":"End date for the household performance calcuation","type":"string","format":"date","example":"2022-07-31"}}}}}},"responses":{"200":{"description":"An enveloped list of AUMs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"title":"Name","description":"Name for the benchmark object","type":"string"},"benchmark_id":{"title":"Benchmark ID","description":"ID for the benchmark object","type":"integer"},"date":{"title":"Date","description":"Date for which the benchmark is calculated","type":"string","format":"date-time"},"mtd_return":{"title":"MTD return","description":"Benchmark month to date return, percentage scale","type":"number","format":"float"},"qtd_return":{"title":"QTD return","description":"Benchmark quarter to date return, percentage scale","type":"number","format":"float"},"ytd_return":{"title":"YTD return","description":"Benchmark year to date return, percentage scale","type":"number","format":"float"},"itd_return":{"title":"ITD return","description":"Benchmark inception to date return, percentage scale","type":"number","format":"float"},"itd_annual_return":{"title":"ITD annual return","description":"Benchmark inception to date annualized return, percentage scale","type":"number","format":"float"},"one_yr_return":{"title":"One year return","description":"Benchmark one year return, percentage scale","type":"number","format":"float"},"three_yr_return":{"title":"Three year return","description":"Benchmark three year return, percentage scale","type":"number","format":"float"},"five_yr_return":{"title":"Five year return","description":"Benchmark five year return, percentage scale","type":"number","format":"float"}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/jobs/":{"get":{"tags":["Jobs"],"summary":"List all Jobs","description":"Returns a list of jobs","operationId":"getJobs","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Jobs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Jobs"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/jobs/{id}":{"get":{"tags":["Jobs"],"summary":"Retrieve a Job","description":"Returns a Job based on a single ID","operationId":"getJob","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Job","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Job"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/jobs/filter":{"post":{"tags":["Jobs"],"summary":"Filter all Jobs","description":"Return a filtered list of all Jobs","operationId":"filterJobs","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this background job object","type":"integer"},"firm_id":{"description":"ID of the owning firm","type":"integer"},"job_type":{"description":"The type of this job. Currently either b for a billing report, pdfrp for a PDF report, or bd for a bulk download","type":"string","enum":["b","pdfrp","db"]},"created_dt_utc":{"description":"Create timestamp in UTC","type":"string","format":"date-time"},"last_updated_dt_utc":{"description":"The last date and time this Background Job was updated","type":"string","format":"date-time"},"queued_dt_utc":{"description":"The last date and time this Background Job was queued","type":"string","format":"date-time"},"started_dt_utc":{"description":"The last date and time this Background Job was started","type":"string","format":"date-time"},"finished_dt_utc":{"description":"The last date and time this Background Job was finished","type":"string","format":"date-time"},"failed_dt_utc":{"description":"The last date and time this Background Job was failed","type":"string","format":"date-time"},"created_by_id":{"description":"The user id for the user who created this Background Job","type":"integer"},"is_finished":{"description":"Returns true if the job is finished","type":"boolean"},"is_running":{"description":"Returns true if the job has been dequeued and is running","type":"boolean"},"is_failed":{"description":"Returns true if the job failed due to an exception","type":"boolean"},"is_revoked":{"description":"Returns true if the job was cancelled by the user","type":"boolean"},"num_steps":{"description":"The progress of a job. Note that the number of steps might not be known until the job is dequeued.","type":"integer"},"current_step":{"description":"Zero corresponds to the job waiting to be processed","type":"integer"},"email_notification":{"description":"If true, this sends an email notification to the user who created the job","type":"string","format":"date-time"},"email_notification_dt_utc":{"description":"The timestamp at which the email notification was sent. Only applies when email_notification is enabled","type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"An enveloped list of Jobs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Jobs"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/jobs/clear":{"post":{"tags":["Jobs"],"summary":"Clear a Job","description":"Deletes the Background Jobs associated with the user's profile","operationId":"clearJobs","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Jobs","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Delete"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/lots":{"get":{"tags":["Source Lots"],"summary":"List all lots records","description":"Returns a list of lots","operationId":"getSourceLots","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}},{"name":"reported_date","in":"query","description":"The reported date for the lots","required":true,"schema":{"type":"string","format":"date","example":"2022-08-28"}}],"responses":{"200":{"description":"An enveloped list of lots","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceLots"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/lots/{id}":{"get":{"tags":["Source Lots"],"summary":"Retrieve a lot record","description":"Returns a lot record based on its ID","operationId":"getSourceLot","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Lots","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceLot"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/lots/filter":{"post":{"tags":["Source Lots"],"summary":"Filter all lot records","description":"Returns a filtered list of lot records","operationId":"filterSourceLots","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1data~1source~1lots~1latest/get/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"An enveloped list of lots","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceLot"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/lots/latest":{"get":{"tags":["Source Lots"],"summary":"Latest Lots Records","description":"Returns a list of the most recent lot records as of the latest date reported by the custodian. Request body fields can be included in request body, or as query parameters for optional filtering.","operationId":"getSourceLotsLatest","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reported_date"],"properties":{"id":{"title":"Id","description":"The unique resource id for the lot","type":"integer"},"account_id":{"description":"The id of the Account associated with this lot","type":"integer"},"account_ids":{"description":"Provide a list of Account IDs to filter.","type":"array","items":{"type":"integer"},"example":[216897,216898]},"security_id":{"description":"The id of the Security associated with this lot","type":"integer"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"source":{"title":"Financial institution data source","description":"Custodian or source the lot data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this lot","type":"string"},"advisor_code":{"description":"The advisor code of the Account associated with this lot","type":"string"},"reported_date":{"description":"The date the custodian reports the lot","type":"string","format":"date-time"},"lot_identifier":{"description":"The custodian reported lot identifier if applicable","type":"string"},"abs_current_quantity":{"description":"The quantity of shares for the reported lot","type":"number","format":"float"},"abs_current_market_value":{"description":"The market value of the shares for the reported lot","type":"number","format":"float"},"abs_cost_basis":{"description":"The total cost of the shares for the reported lot","type":"number","format":"float"},"abs_adjusted_cost_basis":{"description":"The total adjusted cost of the shares for the reported lot","type":"number","format":"float"},"unrealized_gain_loss":{"description":"The current unrealized gains for the lot if reported","type":"number","format":"float"},"acquisition_date":{"description":"The date that the corresponding lot was initially opened (even outside of the current account)","type":"string","format":"date-time"},"abs_acquisition_quantity":{"description":"The original quantity of shares which opened the corresponding lot","type":"number","format":"float"},"direction":{"description":"Flag to indicate if lot is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"fully_known":{"description":"True if the cost basis for this lot is fully known","type":"boolean"},"wash_sale":{"description":"True if the lot is affected by a wash sale","type":"boolean"},"disallowed_loss_amount":{"description":"True if the lot amount is disallowed","type":"boolean"},"certified":{"description":"True if the cost basis is certified","type":"boolean"},"lot_selection_method":{"description":"The lot selection method of the lot if reported by the source","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"An enveloped list of lots","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceLots"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/positions":{"get":{"tags":["Source Positions"],"summary":"List all positions records","description":"Returns a list of positions","operationId":"getSourcePositions","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}},{"name":"reported_date","in":"query","description":"The reported date for the positions","required":true,"schema":{"type":"string","format":"date","example":"2022-08-28"}}],"responses":{"200":{"description":"An enveloped list of positions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourcePositions"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/positions/{id}":{"get":{"tags":["Source Positions"],"summary":"Retrieve a position record","description":"Returns a position record based on its ID","operationId":"getSourcePosition","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of positions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourcePosition"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/positions/filter":{"post":{"tags":["Source Positions"],"summary":"Filter all position records","description":"Returns a filtered list of position records","operationId":"filterSourcePosition","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1data~1source~1positions~1latest/get/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"An enveloped list of positions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourcePosition"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/positions/latest":{"get":{"tags":["Source Positions"],"summary":"Latest Position Records","description":"Returns a list of the most recent position records as of the latest date reported by the custodian. Request body fields can be included in request body, or as query parameters for optional filtering.","operationId":"getSourcePositionsLatest","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reported_date"],"properties":{"id":{"title":"Id","description":"The unique resource id for the position","type":"integer"},"account_id":{"description":"The id of the Account associated with this Position","type":"integer"},"account_ids":{"description":"Provide a list of Account IDs to filter.","type":"array","items":{"type":"integer"},"example":[216897,216898]},"security_id":{"description":"The id of the Security associated with this Position","type":"integer"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"source":{"title":"Financial institution data source","description":"Custodian or source the position data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k / 403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this Position","type":"string"},"advisor_code":{"description":"The advisor code of the Account associated with this Position","type":"string"},"reported_date":{"description":"The date the custodian reports the position","type":"string","format":"date-time"},"direction":{"description":"Flag to indicate if position is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"abs_units":{"description":"The quantity of shares for the reported position","type":"number","format":"float"},"abs_settled_units":{"description":"The quantity of settled shares for the reported position","type":"number","format":"float"},"market_value_unit_price":{"description":"The end of day price of the asset","type":"number","format":"float"},"abs_cost_basis":{"description":"The total cost basis value of the position as aggregated from reported open lots","type":"number","format":"float"},"cost_basis_fully_known":{"description":"True if the cost basis for all shares in this positions are fully known","type":"boolean"},"reported_unrealized_gain_loss":{"description":"The unrealized gains or losses of the position if reported by the source","type":"number","format":"float"},"calculated_unrealized_gain_loss":{"description":"The unrealized gains or losses of the position as calculated by comparing current market value to aggregated cost basis","type":"number","format":"float"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"An enveloped list of positions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourcePositions"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/realized-gain-loss":{"get":{"tags":["Source Realized Gain Loss"],"summary":"List all Realized Gain Losses records","description":"Returns a list of Realized Gain Losses","operationId":"getSourceRealizedGainLosses","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}},{"name":"reported_date","in":"query","description":"The reported date for Realized Gain Losses","required":true,"schema":{"type":"string","format":"date","example":"2022-08-28"}}],"responses":{"200":{"description":"An enveloped list of Realized Gain Loss","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceRealizedGainLosses"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/realized-gain-loss/{id}":{"get":{"tags":["Source Realized Gain Loss"],"summary":"Retrieve a Realized Gain Loss record","description":"Returns a Realized Gain Loss record based on its ID","operationId":"getSourceRealizedGainLoss","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Realized Gain Losses","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceRealizedGainLoss"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/realized-gain-loss/filter":{"post":{"tags":["Source Realized Gain Loss"],"summary":"Filter all Realized Gain Loss records","description":"Returns a filtered list of Realized Gain Loss records","operationId":"filterSourceRealizedGainLoss","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1data~1source~1realized-gain-loss~1latest/get/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"An enveloped list of Realized Gain Loss","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceRealizedGainLoss"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/realized-gain-loss/latest":{"get":{"tags":["Source Realized Gain Loss"],"summary":"Latest Realized Gain Loss Records","description":"Returns a list of the most recent realized gain loss records as of the latest date reported by the custodian. Request body fields can be included in request body, or as query parameters for optional filtering.","operationId":"getSourceRealizedGainLossesLatest","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reported_date"],"properties":{"id":{"title":"Id","description":"The unique resource id for the realized gain loss","type":"integer"},"account_id":{"description":"The id of the Account associated with this Realized gain loss","type":"integer"},"account_ids":{"description":"Provide a list of Account IDs to filter.","type":"array","items":{"type":"integer"},"example":[216897,216898]},"security_id":{"description":"The id of the Security associated with this Realized gain loss","type":"integer"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"source":{"title":"Financial institution data source","description":"Custodian or source the realized gain loss data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this Realized gain loss","type":"string"},"advisor_code":{"description":"The advisor code of the Account associated with this Realized gain loss","type":"string"},"reported_date":{"description":"The date the custodian reports the realized gain loss","type":"string","format":"date-time"},"direction":{"description":"Flag to indicate if lot is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"abs_closed_units":{"description":"The quantity of closed units","type":"number","format":"float"},"abs_closed_value":{"description":"The value of the closed units","type":"number","format":"float"},"close_date":{"description":"The date that the corresponding closed units were closed","type":"string","format":"date-time"},"settle_date":{"description":"The date that the corresponding closed units were settled","type":"string","format":"date-time"},"abs_opened_units":{"description":"The quantity of originally opened units for the corresponding lot","type":"number","format":"float"},"abs_opened_value":{"description":"The value of the originally opened units","type":"number","format":"float"},"open_date":{"description":"The date that the units were originally opened","type":"string","format":"date-time"},"amount":{"description":"The gain or loss from the closed units","type":"number","format":"float"},"amount_short_term":{"description":"The short term gain or loss from the closed units","type":"number","format":"float"},"amount_long_term":{"description":"The long term gain or loss from the closed units","type":"number","format":"float"},"lot_identifier":{"description":"The lot identifier closed if reported by the source","type":"string"},"lot_selection_method":{"description":"The lot selection method of the lot if reported by the source","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"An enveloped list of Realized Gain Loss","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceRealizedGainLosses"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/account-balances":{"get":{"tags":["Source Account Balances"],"summary":"List all account balances records","description":"Returns a list of account balances","operationId":"getSourceAccountBalances","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts"]}},{"name":"reported_date","in":"query","description":"The reported date of the balances","required":true,"schema":{"type":"string","format":"date","example":"2022-08-28"}}],"responses":{"200":{"description":"An enveloped list of account balances","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"type":"array","$ref":"#/components/schemas/SourceAccountBalances"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/account-balances/{id}":{"get":{"tags":["Source Account Balances"],"summary":"Retrieve an account balance record","description":"Returns an account balance record based on its ID","operationId":"getSourceAccountBalance","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of account balances","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceAccountBalance"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/account-balances/filter":{"post":{"tags":["Source Account Balances"],"summary":"Filter all account balance records","description":"Returns a filtered list of account balance records","operationId":"filterSourceAccountBalance","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1data~1source~1account-balances~1latest/get/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"An enveloped list of account balances","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceAccountBalance"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/account-balances/latest":{"get":{"tags":["Source Account Balances"],"summary":"Latest Account Balance Records","description":"Returns a list of the most recent account balance records as of the latest date reported by the custodian. Endpoint Supports optional filtering.","operationId":"getSourceAccountBalancesLatest","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reported_date"],"properties":{"id":{"title":"Id","description":"The unique resource id for the balance","type":"integer"},"account_id":{"description":"The id of the Account associated with this account balance","type":"integer"},"account_ids":{"description":"Provide a list of Account IDs to filter.","type":"array","items":{"type":"integer"},"example":[216897,216898]},"source":{"title":"Financial institution data source","description":"Custodian or source the account balance data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this account balance","type":"string"},"advisor_code":{"description":"The advisor code of the Account associated with this account balance","type":"string"},"reported_date":{"description":"The date the custodian reports the account balance","type":"string","format":"date-time"},"cash_value_reported":{"description":"The cash value as reported by the custodian","type":"number","format":"float"},"cash_value":{"description":"The cash value as aggregated by custodian holdings","type":"number","format":"float"},"securities_value_reported":{"description":"The securities value as reported by the custodian","type":"number","format":"float"},"securities_value":{"description":"The securities value as aggregated by custodian holdings","type":"number","format":"float"},"total_value_reported":{"description":"The total cash and security value as reported by the custodian","type":"number","format":"float"},"total_value":{"description":"The total cash and security value as aggregated by custodian holdings","type":"number","format":"float"},"original_data":{"description":"The raw data exactly as reported by the source with original field names","type":"object"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}}}}},"responses":{"200":{"description":"An enveloped list of account balances","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceAccountBalances"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/transactions":{"get":{"tags":["Source Transactions"],"summary":"List all transactions records","description":"Returns a list of transactions","operationId":"getSourceTransactions","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}},{"name":"reported_date","in":"query","description":"The reported date of the transactions","required":true,"schema":{"type":"string","format":"date","example":"2022-08-28"}}],"responses":{"200":{"description":"An enveloped list of transactions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceTransactions"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/transactions/{id}":{"get":{"tags":["Source Transactions"],"summary":"Retrieve a transaction record","description":"Returns a transaction record based on its ID","operationId":"getSourceTransaction","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of transactions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceTransaction"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/transactions/filter":{"post":{"tags":["Source Transactions"],"summary":"Filter all transaction records","description":"Returns a filtered list of transaction records","operationId":"filterSourceTransaction","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/related","schema":{"enum":["accounts","securities"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/paths/~1data~1source~1transactions~1latest/get/requestBody/content/application~1json/schema"}}}},"responses":{"200":{"description":"An enveloped list of transactions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceTransaction"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/source/transactions/latest":{"get":{"tags":["Source Transactions"],"summary":"Latest Transaction Records","description":"Returns a list of the most recent transaction records as of the latest date reported by the custodian. Request body fields can be included in request body, or as query parameters for optional filtering.","operationId":"getSourceTransactionsLatest","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["reported_date"],"properties":{"id":{"title":"Id","description":"The unique resource id for the transaction","type":"integer"},"account_id":{"description":"The id of the Account associated with this Transaction","type":"integer"},"account_ids":{"description":"Provide a list of Account IDs to filter.","type":"array","items":{"type":"integer"},"example":[216897,216898]},"security_id":{"description":"The id of the Security associated with this Transaction","type":"integer"},"reported_date":{"description":"The date the custodian reports the transaction","type":"string","format":"date-time"},"source":{"title":"Financial institution data source","description":"Custodian or source the realized gain loss data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this Transaction","type":"string"},"feed_code":{"description":"The feed code of the Account associated with this Transaction","type":"string"},"source_transaction_code":{"description":"The custodian reported transaction code for the transaction","type":"string"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"category":{"description":"BridgeFT transaction categorization. Used in conjunction with classification to classify transaction type. trd = Trade, xfr = Transfer, inc = Income/Expense, crp = Corporate Action, oth = Other","type":"string","enum":["trd","xfr","inc","crp","oth"]},"classification":{"description":"BridgeFT transaction categorization. Used in conjunction with classification to classify transaction type. bto = Buy to Open, stc = Sell to Close, btc = Buy to Close, sto = Sell to Open, dvr = Dividend Reinvestment, inc = Other Income, exp = Other Expense, div = Dividend, int = Interest, mfe = Management Fee, tax = Tax, dep = Deposit, wth = Withdrawal, rec = Shares Received, del = Shares Delivered, spl = Split, chg = Symbol Change, jnl = Journal, oth = Other","type":"string","enum":["bto","stc","btc","sto","dvr","inc","exp","div","int","mfe","tax","dep","wth","rec","del","spl","chg","jnl","oth"]},"transaction_date":{"description":"The date of the transaction. May be different from the reported date.","type":"string","format":"date-time"},"trade_settle_ind":{"description":"Indicator to declare if the trade records provided by the custodian is coming from a trade date or settlement date based system of record. T = Trade Date Based, S = Settlement Date Based, and empty values are for non-trade activity or data is not provided by the custodian.","type":"string","enum":["T","S",""]}}}}}},"responses":{"200":{"description":"An enveloped list of transactions","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/SourceTransactions"},"related":{"type":"object","properties":{"accounts":{"type":"object","properties":{"account_id":{"$ref":"#/components/schemas/Account"}}},"securities":{"type":"object","properties":{"security_id":{"$ref":"#/components/schemas/Security"}}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities":{"get":{"tags":["Securities"],"summary":"List all Securities","description":"Returns a list of securities","operationId":"getSecurities","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Securities","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Securities"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/{id}":{"get":{"tags":["Securities"],"summary":"Retrieve a Security","description":"Returns a single  security based on an ID","operationId":"getSecurity","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped Security","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Security"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/filter":{"post":{"tags":["Securities"],"summary":"Filter all Securities","description":"Returns a filtered list of Securities","operationId":"filterSecurities","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource id for the Security","type":"integer"},"cusip":{"description":"A unique nine-character code for the security","type":"string"},"symbol":{"description":"The symbol used to represent the Security","type":"string"},"description":{"description":"The description of the Security","type":"string"},"master_asset_class":{"description":"Asset class associated with the security. EQ for Equity Asset Class, DT for Fixed Income Asset Class, CA for Cash Asset Class, CE for Cash Equivalent Asset Class, MX for Mixed Asset Class or Other Class, UC for Unclassified Asset Class, ETF for ETF Asset Class, CR for Crypto Asset Class, and empty string for Unknown Asset Class","type":"string","enum":["EQ","DT","CA","CE","MX","UC","ETF","CR"]},"broad_code":{"description":"The broad code of the Security","type":"string","deprecated":true},"sic_code":{"description":"The sic code of the security","type":"string"},"issue_code":{"description":"An internal mapping of the Security's issue code","type":"string"}}}}}},"responses":{"200":{"description":"An enveloped list of Securities","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Securities"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/get-usd":{"get":{"tags":["Securities"],"summary":"Get Security with USD","description":"Returns the first security object where the issue_type_code is 1","operationId":"getSecurityUSD","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped Security","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Security"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/search/{q}":{"get":{"tags":["Securities"],"summary":"Search for Securities","description":"Returns modified representations of Securities based on input parameters used for filtering","operationId":"getSecuritySearch","parameters":[{"name":"q","in":"path","description":"The symbol or description of a Security to filter by","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Securities","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Security"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/get-compressed":{"get":{"tags":["Securities"],"summary":"Get Compressed Securities","description":"Returns compressed and modified representations of all Securities that are being tracked","operationId":"getSecurityCompressed","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"The results from this endpoint are encoded as base64.","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/fetch":{"post":{"tags":["Securities"],"summary":"Fetch Securities","description":"Returns a list of securities based on the ids passed in","operationId":"getSecurityFetch","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"description":"List of security ids to be fetched","type":"array","items":{"type":"integer"}}}}}}},"responses":{"200":{"description":"List of securities fetched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Securities"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/managed":{"get":{"tags":["Securities"],"summary":"Get Managed Securities","description":"Returns a list of security ids that belong to the user's household and firm","operationId":"getSecurityManaged","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped Security","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/custodian/securities/reference":{"post":{"tags":["Security Reference"],"summary":"List all Security Reference Records","description":"Returns a list of normalized custodian reported securities enriched with Intrinio Market data for a provided `reported_date`\n\n**Example Records**\n\nBelow is an example of two security records reported by Schwab, the first is a standard `AAPL` stock and below that\nis an AAPL option. Option records will have additional data points populated that provided specific information about\nthe option as reported by the custodian.\n\n```json\n[\n  {\n    \"reported_date\": \"2024-07-10\",\n    \"source\": \"SWB\",\n    \"cusip\": \"037833100\",\n    \"symbol\": \"AAPL\",\n    \"description\": \"APPLE INC \",\n    \"security_type\": \"COM\",\n    \"security_type_description\": \"COMMON STOCK\",\n    \"option_root_symbol\": \"\",\n    \"option_expiration_date\": \"\",\n    \"option_code\": \"\",\n    \"strike_price_amount\": 0,\n    \"market_data\": {\n        \"symbol\": \"AAPL\",\n        \"description\": \"Apple Inc\",\n        \"figi\": \"BBG000B9Y5X2\",\n        \"composite_figi\": \"BBG000B9XRY4\",\n        \"security_type\": \"Ordinary Shares\",\n        \"security_code\": \"EQS\",\n        \"security_code_description\": \"Equity Shares\"\n    }\n  },\n  {\n    \"reported_date\": \"2024-07-10\",\n    \"source\": \"SWB\",\n    \"cusip\": \"\",\n    \"symbol\": \"AAPL\",\n    \"description\": \"CALL APPLE INC $195        EXP 09/19/25\",\n    \"security_type\": \"OEQ\",\n    \"security_type_description\": \"EQUITY OPTION\",\n    \"option_root_symbol\": \"AAPL\",\n    \"option_expiration_date\": \"2025-09-19\",\n    \"option_code\": \"C\",\n    \"strike_price_amount\": 195,\n    \"market_data\": {\n        \"symbol\": \"AAPL\",\n        \"description\": \"Apple Inc\",\n        \"figi\": \"BBG000B9Y5X2\",\n        \"composite_figi\": \"BBG000B9XRY4\",\n        \"security_type\": \"Ordinary Shares\",\n        \"security_code\": \"EQS\",\n        \"security_code_description\": \"Equity Shares\"\n    }\n  }\n]\n```\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reported_date":{"description":"The reported date of custodian provided securities. This field is required.","type":"string","format":"date"}},"required":["reported_date"]}}}},"operationId":"getSecuritiesReference","responses":{"200":{"description":"List of Security Reference objects","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"reported_date":{"description":"The date the custodian reported the security record.","type":"string","format":"date"},"source":{"description":"The custodian code that reported the security.","type":"string","enum":["APX","AXO","DST","EGB","FPR","IBK","MLT","NFS","PER","PTA","SWB","TIA"]},"cusip":{"description":"A unique nine-character code for the security reported by the custodian.","type":"string"},"symbol":{"description":"The symbol used to represent the Security reported by the custodian.","type":"string"},"description":{"description":"The description of the Security as reported by the custodian.","type":"string"},"security_type":{"description":"The security type as reported by the custodian.","type":"string"},"security_type_description":{"description":"A human readable description of the security_type that was provided by the custodian.","type":"string"},"option_root_symbol":{"description":"Populated only for options, this is the underlying symbol of the traded option as reported by the custodian.","type":"string"},"option_expiration_date":{"description":"Populated only for options, this is the expiration date of the option as reported by the custodian.","type":"string"},"option_code":{"description":"Populated only for options, this is the option type as reported by the custodian.","type":"string"},"strike_price_amount":{"description":"Populated only for options, this is the strike price of the option as reported by the custodian.","type":"number"},"market_data":{"description":"Intrinio Market Data for the custodian reported security","type":"object","properties":{"symbol":{"description":"Symbol as reported by Intrinio Market Data","type":"string"},"description":{"description":"Security Description provided by Intrinio Market Data","type":"string"},"figi":{"description":"Figi of the security provided by Intrinio Market Data","type":"string"},"composite_figi":{"description":"Composite Figi of the security provided by Intrinio Market Data","type":"string"},"security_type":{"description":"Security Type provided by Intrinio Market Data","type":"string"},"security_code":{"description":"Security Code provided by Intrinio Market Data","type":"string"},"security_code_description":{"description":"Enriched description of the Security Code provided by Intrinio Market Data","type":"string"}}}}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/idc/indexes":{"get":{"tags":["Index Data"],"summary":"List all List all IDC Indexes","description":"Returns a list of List all IDC Indexes","operationId":"getIndexes","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of Indexes","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Indexes"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/idc/indexes/{id}":{"get":{"tags":["Index Data"],"summary":"Retrieve an IDC Index","description":"Returns an idc index based on a single ID","operationId":"getIndex","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of IDC Index","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Index"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/data/idc/indexes/filter":{"post":{"tags":["Index Data"],"summary":"Filter all IDC Indexes","description":"Return a filtered list of all IDC indexes","operationId":"filterIndex","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The unique resource id of the Index.","type":"integer"},"internal_name":{"description":"Our internal name for the index.","type":"string"},"vendor_name":{"description":"Vendor's name of the index.","type":"string"},"cusip":{"description":"Cusip associated with the index","type":"string"},"symbol":{"description":"Symbol associated with the index","type":"string"},"issuer_cusip":{"description":"Issuer cusip associated with the index","type":"string"},"name":{"description":"Name for the index","type":"string"}}}}}},"responses":{"200":{"description":"An enveloped list of Indexes","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Indexes"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/oauth2/token":{"post":{"tags":["Token"],"summary":"Get an Auth Token","description":"Exchange your application's `client_id` and `client_secret` for a secure JWT Token. Please note that the encoded `username:password` in the Basic Auth request corresponds to `client_id:client_secret`.","operationId":"getToken","security":[{"basicAuth":[]}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["grant_type"],"properties":{"grant_type":{"description":"Grant type","type":"string","example":"client_credentials"}}}}}},"responses":{"200":{"description":"OAuth Token Object","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Oauth"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/models":{"get":{"tags":["Models"],"summary":"List all Models","description":"Returns a list of models within the data field","operationId":"getModels","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of model","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Models"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Models"],"summary":"Bulk Update Models","description":"Provide a list of Investment Models update. Then entire Investment Model object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `strategy_allocations`\n","operationId":"updateModels","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Models"}}}},"responses":{"200":{"description":"An enveloped list of model","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Models"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Models"],"summary":"Create a Model","description":"Returns the created model","operationId":"createModels","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Name for the model","type":"string","example":"Fidelity Mixed"},"firm_id":{"description":"Id of the firm this model is associated with","type":"integer","example":39},"strategy_allocations":{"description":"Strategy allocation associated with this model","type":"array","items":{"type":"object","properties":{"strategy_id":{"description":"Strategy ID for this strategy allocation","type":"integer"},"weight":{"description":"Weight of the strategy allocation associated to the investment model","type":"number"}}},"example":[{"model_id":2,"strategy_id":6,"weight":20},{"model_id":2,"strategy_id":5,"weight":60},{"model_id":2,"strategy_id":3,"weight":10},{"model_id":2,"strategy_id":23,"weight":10}]}}}}}},"responses":{"200":{"description":"An enveloped list of model","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Model"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/models/{id}":{"get":{"tags":["Models"],"summary":"Retrieve a Model","description":"Returns a model based on a single ID","operationId":"getModel","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of model","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Model"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Models"],"summary":"Update a Model","description":"Provide an Investment Model update. Then entire Investment Model object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `strategy_allocations`\n","operationId":"updateModel","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model"}}}},"responses":{"200":{"description":"An enveloped list of model","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Model"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Models"],"summary":"Delete a Model","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"deteleModel","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/models/filter":{"post":{"tags":["Models"],"summary":"Filter all Models","description":"Returns a filtered list of Model","operationId":"filterModels","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this model object","type":"integer","example":2},"name":{"description":"Name for the model","type":"string","example":"Fidelity Mixed"},"firm_id":{"description":"Id of the firm this model is associated with","type":"integer","example":39},"created_at_utc":{"description":"The date the model was created","type":"string","format":"date-time","example":"2021-08-18T14:37:26.31346Z"},"updated_at_utc":{"description":"The date the model was created","type":"string","format":"date-time","example":"2022-06-28T19:24:38.807279Z"}}}}}},"responses":{"200":{"description":"An enveloped list of model","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Models"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/models/delete-many":{"post":{"tags":["Models"],"summary":"Delete many Models","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyModels","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/strategies":{"get":{"tags":["Strategies"],"summary":"List all Strategies","description":"Returns a list of strategies within the data field","operationId":"getStrategies","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of strategy","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Strategies"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Strategies"],"summary":"Bulk Update Strategies","description":"Provide a list of Investment Strategies to update. Then entire Investment Strategy object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `description`\n- `provider`\n- `investment_minimum`\n- `fee`\n- `security_allocations`\n","operationId":"updateStrategies","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Strategies"}}}},"responses":{"200":{"description":"An enveloped list of strategy","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Strategies"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"post":{"tags":["Strategies"],"summary":"Create a Strategy","description":"Returns the created strategy","operationId":"createStrategies","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Name for the strategy","type":"string","example":"Demo Strategy - Fidelity Aggressive Equity"},"firm_id":{"description":"Id of the firm this strategy is associated with","type":"integer","example":39},"security_allocations":{"type":"array","items":{"type":"object","properties":{"security_id":{"description":"Security Id associated with the strategy","type":"integer"},"weight":{"description":"Weight of the security allocation associated with the strategy","type":"number"}}},"example":[{"security_id":236,"weight":80},{"security_id":78,"weight":20}]}}}}}},"responses":{"200":{"description":"An enveloped list of strategy","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Strategy"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/strategies/{id}":{"get":{"tags":["Strategies"],"summary":"Retrieve a Strategy","description":"Returns a strategy based on a single ID","operationId":"getStrategy","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"description":"An enveloped list of strategy","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Strategy"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"put":{"tags":["Strategies"],"summary":"Update a Strategy","description":"Provide an Investment Strategy update. Then entire Investment Strategy object **must** be provided to the `PUT` request.\n\n**Editable Fields:**\n- `name`\n- `description`\n- `provider`\n- `investment_minimum`\n- `fee`\n- `security_allocations`\n","operationId":"updateStrategy","parameters":[{"$ref":"#/components/parameters/id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Strategy"}}}},"responses":{"200":{"description":"An enveloped list of strategy","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Strategy"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}},"delete":{"tags":["Strategies"],"summary":"Delete a Strategy","description":"Returns the \"OK\" message and a json object with the id  of item deleted, if deletion was successful","operationId":"deteleStrategy","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1%7Bid%7D/delete/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/strategies/create-many":{"post":{"tags":["Strategies"],"summary":"Create Many Strategies","description":"Returns a list of created strategies","operationId":"createManyStrategies","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/paths/~1investment-management~1strategies/post/requestBody/content/application~1json/schema"}}}}},"responses":{"200":{"description":"An enveloped list of strategy","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Strategies"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/strategies/filter":{"post":{"tags":["Strategies"],"summary":"Filter all Strategies","description":"Returns a filtered list of Strategy","operationId":"filterStrategies","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"Unique ID for this strategy object","type":"integer","example":3},"name":{"description":"Name for the strategy","type":"string","example":"Demo Strategy - Fidelity Aggressive Equity"},"firm_id":{"description":"Id of the firm this strategy is associated with","type":"integer","example":39},"description":{"description":"Description of the strategy","type":"string","example":"This is a model that focuses on capital appreciation."},"investment_minimum":{"description":"Investment minimum","type":"number","example":100000},"provider":{"description":"Provider of the strategy","type":"string","example":"Fidelity"},"fee":{"description":"Fee reported on the strategy","type":"number","example":1000},"benchmark_id":{"description":"Id of the benchmark associated with this strategy","type":"integer","example":11149},"strategy_type":{"description":"Type of the strategy.","type":"string","enum":["Core","Satellite","Income","Alternatives"],"example":"Core"},"tax_managed":{"description":"Is the tax managed?","type":"boolean","example":false},"risk_category":{"description":"Risk category of the strategy. CP for Capital Preservation, CO for Conservative, MC for Moderate Conservative, MO for Moderate, MG for Moderate Growth, GR for Growth, AG for Aggressive Growth","type":"string","enum":["CP","CO","MC","MO","MG","GR","AG"],"example":"AG"},"asset_type":{"description":"Asset type of the strategy","type":"string","example":"EQ"},"created_at_utc":{"description":"The date the model was created","type":"string","format":"date-time","example":"2021-08-18T14:27:44.144798Z"},"updated_at_utc":{"description":"The date the model was created","type":"string","format":"date-time","example":"2021-10-13T11:34:37.614577Z"}}}}}},"responses":{"200":{"description":"An enveloped list of strategy","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","example":"list"},"has_next":{"type":"boolean"},"has_previous":{"type":"boolean"},"current_page":{"type":"integer","example":2},"total_pages":{"type":"integer","example":5},"page_size_limit":{"type":"integer","example":10000},"total_items":{"type":"integer","example":50},"data":{"$ref":"#/components/schemas/Strategies"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/investment-management/strategies/delete-many":{"post":{"tags":["Strategies"],"summary":"Delete many Strategies","description":"Returns the \"OK\" message and a json object with the number of items deleted, if deletion was successful","operationId":"deteleManyStrategies","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"}],"requestBody":{"$ref":"#/components/requestBodies/delete-many"},"responses":{"200":{"$ref":"#/paths/~1billing~1groups~1delete-many/post/responses/200"},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/status/account-summary":{"get":{"deprecated":true,"tags":["Account Summary"],"summary":"Account Meta Status Summary","description":"Fetch account meta status summary for all the source data accross the firm","operationId":"getAccountStatusSummary","parameters":[{"name":"reported_date","in":"query","description":"Date for the account status summary","required":false,"schema":{"type":"string","format":"date"},"example":"2023-01-01"}],"responses":{"200":{"description":"Account meta status summary","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSummary"}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/status/source-data":{"post":{"tags":["Source Data Status"],"summary":"Source Data Status","description":"Status of source data ingestion. TDA availability status is applicable prior to Sept. 2, 2023.","operationId":"getSourceDataStatus","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"as_of_date":{"title":"As of Date","description":"Reported date for which to retrieve source data status","type":"string","format":"date","example":"2006-01-02"}}}}}},"responses":{"200":{"description":"Source data normalization status for the given date. Only relevant sources are included in response.","content":{"application/json":{"schema":{"type":"object","properties":{"APX":{"type":"object","properties":{"balances":{"title":"Balances","description":"Availability status for balance type source data","type":"object","properties":{"available":{"title":"Available","description":"Flag whether all accessible balance data is processed and available","type":"boolean"}}},"lots":{"title":"Lots","description":"Availability status for lot type source data","type":"object","properties":{"available":{"title":"Available","description":"Flag whether all accessible lot data is processed and available","type":"boolean"}}},"positions":{"title":"Positions","description":"Availability status for position type source data","type":"object","properties":{"available":{"title":"Available","description":"Flag whether all accessible position data is processed and available","type":"boolean"}}},"realized_gain_losses":{"title":"Realized Gain Losses","description":"Availability status for realized gain loss type source data","type":"object","properties":{"available":{"title":"Available","description":"Flag whether all accessible realized gain loss data is processed and available","type":"boolean"}}},"transactions":{"title":"Transactions","description":"Availability status for transaction type source data","type":"object","properties":{"available":{"title":"Available","description":"Flag whether all accessible transaction data is processed and available","type":"boolean"}}}}},"AXO":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"DST":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"EGB":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"FPR":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"IBK":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"MLT":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"NFS":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"PER":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"PTA":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"SWB":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"},"TDA (Available prior to Sept. 2, 2023)":{"$ref":"#/paths/~1status~1source-data/post/responses/200/content/application~1json/schema/properties/APX"}}}}}},"400":{"$ref":"#/paths/~1jobs~1/get/responses/400"}}}},"/market-data/intrinio/{intrinioEndpoint}":{"get":{"tags":["Intrinio Market Data"],"summary":"Get Intrinio Market Data","description":"Endpoint to access market data from Intrinio. Sign up for an API Key [here](https://docs.intrinio.com/documentation/api_v2/getting_started). The endpoint response varies depending on the Intrinio endpoint provided.","operationId":"getIntrinioMarketData","parameters":[{"name":"intrinioEndpoint","in":"path","description":"Intrinio endpoint to call (See [Intrinio API Endpoints](https://docs.intrinio.com/documentation/api_v2/getting_started))","required":true,"schema":{"type":"string"},"example":"filings"},{"name":"x-Intrinio-Api-Key","in":"header","description":"Your API Key used for API Access from Intrinio.","schema":{"type":"string"},"example":"INTRINIO_API_KEY","required":true},{"name":"next_page","in":"query","description":"Intrinio pagination parameter (See [Intrinio Paging Documentation](https://docs.intrinio.com/documentation/api_v2/paging))","schema":{"type":"string"},"example":"MjAxOC0wNi0xNHw4NTM1MTc5MjQ0"}],"responses":{"200":{"description":"Successful Intrinio Response","content":{"application/json":{"schema":{"type":"object"}}}}}}}},"components":{"parameters":{"limit":{"name":"pager.limit","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"integer"},"example":10000},"page":{"name":"pager.page","in":"query","description":"Current page number","required":false,"schema":{"type":"integer"},"example":1},"id":{"name":"id","in":"path","description":"Unique ID for the object","required":true,"schema":{"type":"integer"},"example":1},"related":{"name":"related","in":"query","description":"Select data related to identifiers in the response data. When a related query parameter is selected, a new json field\nwill be populated in the response with a map of the relevant related data.\n\n** Example **\n\nGET `https://api.bridgeft.com/v2/{selectedResource}?related=accounts`\n\nResponse:\n\n```\n{\n  \"object\": \"object\"\n  \"has_next\": true,\n  \"has_previous\": false,\n  \"current_page\": 1,\n  \"total_pages\": 10,\n  \"page_size_limit\": 100,\n  \"has_next\": true,\n  \"data\": [\n    {\n      id: 1,\n      account_id\": \"SOMEACCOUNTID1\",\n      ...\n    },\n    {\n      id: 1,\n      account_id\": \"SOMEACCOUNTID2\",\n      ...\n    }\n  ]\n  \"accounts\": {\n    \"SOMEACCOUNTID1\": {\n      id: \"SOMEACCOUNTID1\",\n      ...\n    },\n    \"SOMEACCOUNTID2\": {\n      id: \"SOMEACCOUNTID2\",\n      ...\n    }\n  }\n}\n```\n\nPopulating the related query parameter will pull additional information in the request for supported related data without reaching out to an additional endpoint.\n\nSee dropdown for the supported related fields for the resource.\n","required":false,"schema":{"type":"string","example":"securities"}}},"requestBodies":{"delete-many":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"title":"Ids","description":"Unique list of IDs for the object to delete","type":"array","items":{"type":"integer"}}}}}}}},"schemas":{"Account":{"type":"object","properties":{"id":{"title":"Object ID","description":"Unique ID for this account object","type":"integer"},"name":{"title":"Account name","description":"Populated from custodian data","type":"string"},"firm_id":{"title":"Firm Id","description":"ID of the owning firm","type":"integer"},"entity_id":{"title":"Entity id","description":"See Entity ID Prefixes","type":"string","deprecated":true},"household_id":{"title":"Household Id","description":"Household Id this account belongs to","type":"integer"},"short_name":{"title":"Short name","description":"The account short name or \"SNAM\"","type":"string","deprecated":true},"inception_date":{"title":"Inception date","description":"Date of account inception, if applicable. May differ from opening date.","type":"string","format":"date-time"},"close_date":{"title":"Close date","description":"Date the account was closed, if applicable","type":"string","format":"date-time","deprecated":true},"status":{"title":"Status","description":"Status of the account object. It can be funded, papered, closed or slate. Funded account is considered active account, Papered or Closed account is inactive, and Stale is unknown","type":"string","enum":["funded","papered","closed","stale"],"deprecated":true},"benchmarks_ids":{"title":"Benchmark id list","description":"List of ids for benchmarks associated with the account","type":"array","items":{"type":"integer"}},"is_account":{"title":"Is account?","description":"Is this entity an account? (Yes)","type":"boolean"},"is_household":{"title":"Is household","description":"Is this entity a household? (No)","type":"boolean"},"number":{"title":"Account number","description":"Account number","type":"string"},"custodian":{"title":"Financial institution data source","description":"Custodian the account data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","EGB","MLT","TIA"]},"address_1":{"title":"Client address","description":"First line address","type":"string"},"address_2":{"title":"Client address","description":"Second line address","type":"string"},"address_3":{"title":"Client address","description":"Third line address","type":"string"},"city":{"title":"Client city","description":"City of the account-holder","type":"string"},"state":{"title":"Client state","description":"State of the account-holder","type":"string"},"zip_code":{"title":"Client zip code","description":"Zip code of the account-holder","type":"string"},"country":{"title":"Client country","description":"Country of the account-holder","type":"string"},"acct_type":{"title":"Account type","description":"Type of account. Example, IRA Roth, 401k, etc.","type":"string"},"is_tax_deferred":{"title":"Deferred tax account?","description":"True if this account is tax deferrable. This data is typically provided by the financial institution","type":"boolean"},"is_taxable":{"title":"Taxable account?","description":"True if this account is taxable. This data is typically provided by the financial institution","type":"boolean"},"payment_source":{"title":"Method of collecting fees for this account","description":"C=billed at the custodian D=billed directly","type":"string","enum":["C","D"]},"first_billable_date":{"title":"First billable date","description":"The date at which this account begins accruing advisor fees","type":"string","format":"date-time"},"billing_splits_ids":{"title":"Billing splits id list","description":"List of ids of splits associated with this account","type":"array","items":{"type":"integer"}},"fee_structures_ids":{"title":"Fee structure id list","description":"List of ids of fee structures associated with this account","type":"array","items":{"type":"integer"}},"display_name":{"title":"Display name","description":"Display name of the account","type":"string"},"display_number":{"title":"Display number","description":"Display number of the account","type":"string"},"is_direct_billed":{"title":"Is direct billed?","description":"Is this account directly billed?","type":"boolean"},"is_custodian_billed":{"title":"Is custodain billed?","description":"Is this account billed at the custodian level?","type":"boolean"},"is_active":{"title":"Is active?","description":"Is this an active account?","type":"boolean","deprecated":true},"is_closed":{"title":"Is closed?","description":"Is this a closed account?","type":"boolean","deprecated":true},"first_cost_basis_date":{"title":"First cost basis date","description":"First date when cost basis information is known for this account","type":"string","format":"date-time"},"last_cost_basis_date":{"title":"Last cost basis date","description":"Most recent date when cost basis information is known for this account","type":"string","format":"date-time"},"first_positions_date":{"title":"First positions date","description":"First date when positions information is known for this account","type":"string","format":"date"},"last_positions_date":{"title":"Last positions date","description":"Most recent date when positions information is known for this account","type":"string","format":"date"},"first_quarantine_date":{"title":"First quarantine date","description":"Earliest date at which this account was quarantined for data reconciliation, or null if it's not currently quarantined","type":"string","format":"date","deprecated":true},"last_reporting_date":{"title":"Last reporting date","description":"Lastest date when the reporting information was recorded for this account","type":"string","format":"date"},"first_transactions_date":{"title":"First transactions date","description":"First date when transaction information was recorded for this account","type":"string","format":"date"},"last_transactions_date":{"title":"Last transactions date","description":"Latest date when transaction information was recorded for this account","type":"string","format":"date"},"first_funded_date":{"title":"Fist funded date","description":"Date when the account was first funded","type":"string","format":"date-time","deprecated":true},"target_allocation_id":{"title":"Target allocation ID","description":"Target allocation id associated with this account","type":"integer"},"investment_model_id":{"title":"Investment model ID","description":"Investment model id associated with this account","type":"integer"},"required_cash":{"title":"Required cash","description":"Required cash amount in dollars to be set aside for withdrawals","type":"number"},"advisor_code":{"title":"Advisor code","description":"[Deprecated] Please refer to the `advisor_codes` field. `advisor_code` will be removed in future versions.","type":"string","deprecated":true},"advisor_codes":{"title":"Advisor Codes","description":"The list of Advisor Codes that the account is associated with.","type":"array","items":{"type":"string"}},"buy_securities_ids":{"title":"Buy securities ids","description":"Securities specifically to buy","type":"array","items":{"type":"integer"}},"do_not_buy_securities_ids":{"title":"Do not buy securities ids","description":"Securities specifically to not buy","type":"array","items":{"type":"integer"}},"sell_securities_ids":{"title":"Sell securiteis ids","description":"Securities specifically to sell","type":"array","items":{"type":"integer"}},"do_not_sell_securities_ids":{"title":"Do not sell securities ids","description":"Securities specifically to not sell","type":"array","items":{"type":"integer"}},"notes":{"title":"Notes","description":"General notes on account entered by user","type":"string"},"unsupervised_securities_ids":{"title":"Unsupervised securities ids","description":"Securities to be excluded in trading integrations (e.g. rebalancing calculations)","type":"array","items":{"type":"integer"}},"required_cash_frequency":{"title":"Required cash frequency","description":"Required cash frequency for this account object. M for monthly, Q for quarterly, O for one time","type":"string","enum":["","M","Q","O"]},"first_performance_date":{"title":"First performance date","description":"First performance date for this account","type":"string","format":"date-time"},"first_papered_date":{"title":"First papered date","description":"Date when the account was first papered","type":"string","format":"date-time","deprecated":true},"last_portfolio_data_date":{"title":"Last portfolio data date","description":"Date for the last portfolio data for this account object","type":"string","format":"date-time"},"tax_id_token":{"title":"Tax ID Token","description":"Tokenized representation of the account's owning tax ID.","type":"string"},"is_pledged_account":{"title":"Is Pledged Account","description":"Boolean that determines whether or not an account is a pledged account.","type":"boolean"},"source_margin_indicator":{"title":"Source Margin Indicator","description":"Raw margin account designation as received directly from the custodian. Values vary by custodian (e.g., True/False for SWB, \"1\"/\"R\"/\"T\"/\"Z\"/blank for NFS, \"Y\"/\"N\" for PER, \"Margin\"/\"Portfolio Margin\"/\"Cash\" for IBK).","type":"string"},"restrictions":{"title":"Account Restrictions","description":"List of restriction descriptions or restriction codes as provided by the custodian.","type":"array","items":{"type":"object","properties":{"code":{"description":"The restriction code","type":"string"},"description":{"description":"The restriction description","type":"string"}}}},"prime_brokerage_indicator":{"title":"Prime Brokerage Indicator","description":"The prime brokerage indicator passed through from the custodian (if they provide it).\n\nPlease consulte the [data dictionary](https://docs.bridgeft.com/docs/data-dictionary-v26) for details about possible values from the custodian.\n","type":"string"},"account_type_reported":{"title":"Account Type Reported","description":"Raw account type passed through from custodians.","type":"string"},"registration_type_reported":{"title":"Registration Type Reported","description":"Raw registration type passed through from custodians.","type":"string"},"registration_lines_reported":{"title":"Registration Lines Reported","description":"Raw registration lines passed through from custodians.","type":"array","items":{"type":"string"}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Accounts":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"Household":{"type":"object","properties":{"id":{"title":"Object ID","description":"Unique household identifier","type":"integer","format":"int64"},"name":{"title":"Household name","description":"Populated from custodian data but can be modified by users","type":"string"},"firm_id":{"title":"Managing firm id","description":"ID of the owning firm","type":"integer"},"entity_id":{"title":"Entity Id","description":"See Entiti ID Prefixes","type":"string"},"opening_date":{"title":"Opening date","description":"Date the household was opened","type":"string","format":"date-time"},"inception_date":{"title":"Inception date","description":"Date of household inception, if applicable. May differ from opening date","type":"string","format":"date-time"},"close_date":{"title":"Close date","description":"Date the household was closed, if applicable","type":"string","format":"date-time"},"status":{"title":"Status","description":"See Account and Household Status Codes.","type":"string","deprecated":true},"benchmarks_ids":{"title":"Benchmarks id list","description":"List of ids for benchmarks associated with the household","type":"array","items":{"type":"integer"}},"is_account":{"title":"Is Accont","description":"Is this entity an account? (No)","type":"boolean"},"is_household":{"title":"Is Household","description":"Is this entity a household? (Yes)","type":"boolean"},"last_reporting_date":{"title":"Last reporting date","description":"Most recent date that portfolio data was processed for this household","type":"string","format":"date-time"},"first_account_reporting_date":{"title":"First account reporting date","description":"Earliest date that portfolio data was processed among accounts in this household","type":"string","format":"date-time"},"last_account_reporting_date":{"title":"Last account reporting date","description":"Most recent date that portfolio data was processed among accounts in this household","type":"string","format":"date-time"},"short_name":{"title":"Short name","description":"Short name for the household object","type":"string","deprecated":true},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Households":{"type":"array","items":{"$ref":"#/components/schemas/Household"}},"Firm":{"type":"object","properties":{"id":{"title":"Object ID","description":"Unique ID for this firm object","type":"integer","format":"int64"},"parent_firm_id":{"title":"Parent firm id","description":"ID of the parent firm, if applicable","type":"integer"},"permissions":{"title":"Permissions","description":"List of permissions accessible to the firm. See Permissions Overview.","type":"array","items":{"type":"string"}},"name":{"title":"Name","description":"Firm name","type":"string"},"short_name":{"title":"Short name","description":"The firm short name or \"SNAM\"","type":"string"},"relationship_code":{"title":"Relationship code","description":"A system-generated code used for storage purposes","type":"string"},"logo_url":{"title":"Logo URL","description":"Public URL of the firm's logo","type":"string"},"disclosures":{"title":"Disclosures","description":"HTML-encoded disclosures intended for reporting","type":"string"},"reporting_frequency":{"title":"Reporting frequency","description":"See Frequency Codes","type":"string","enum":["D","W","M","Q","Y"]},"report_on_heldaway_accounts":{"title":"Report on heldaway accounts","description":"Option to include held-away assets in PDF reports","type":"boolean"},"show_bridge_logo":{"title":"Show bridge logo","description":"Show bridge logo?","type":"boolean"},"show_firm_logo":{"title":"Show firm logo","description":"Show firm logo?","type":"boolean"},"cp_enabled":{"title":"Client portal enabled","description":"Is the client portal is enabled for the firm's customers?","type":"boolean"},"cp_web_reports_enabled":{"title":"Client portal web reports enabled","description":"Can clients access their own web reports from the portal?","type":"boolean"},"cp_printable_reports_enabled":{"title":"Client portal printable reports enabled","description":"Can clients download printable reports?","type":"boolean"},"cp_invoices_enabled":{"title":"Client portal invoices enabled","description":"Can clients view their invoices?","type":"boolean"},"cp_shared_files_enabled":{"title":"Client portal shared files enabled","description":"Can clients access shared files?","type":"boolean"},"cp_heldaways_enabled":{"title":"Client portal heldaways enabled","description":"Can clients access and add heldaway assets?","type":"boolean"},"invoice_header":{"title":"Invoice header","description":"HTML invoice header","type":"string"},"invoice_footer":{"title":"Invoice footer","description":"HTML invoice footer","type":"string"},"invoice_from":{"title":"Invoice form","description":"The address of the firm","type":"string"},"invoice_due_date_option":{"title":"Invoice due date option","description":"Option to use for calculating due date. Choices are 30 (30 days from the invoice date), E (end of next month), or the empty string.","type":"string","enum":["30","E"]},"invoice_include_fee_structures":{"title":"Invoice include fee structures","description":"Whether to include a description of the fee structures used in the billing","type":"boolean"},"invoice_effective_rates":{"title":"Invoice effective rates","description":"Whether to include effective rates (total billed divided by total assets) in the invoice","type":"boolean"},"invoice_annualized_effective_rates":{"title":"Invoice annualized effective rates","description":"Whether to show the effective rate as an annual percentage","type":"boolean"},"invoice_show_agreement":{"title":"Invoice show agreement","description":"Whether to show the disclaimer agreement text, standard from V2 invoices","type":"boolean"},"invoice_not_a_bill_explanation":{"title":"Invoice not a bill explanation","description":"If true and the invoice doesn't represent a bill (because it'll be withdrawn directly)","type":"boolean"},"is_active":{"title":"Is active","description":"Is the firm active?","type":"boolean"},"is_billing_active":{"title":"Is billing active","description":"Is the billing state active?","type":"boolean"},"billing_include_accrued_income":{"title":"Billing included accrued income","description":"Is accrued income included?","type":"boolean"},"billing_partition_option":{"title":"Billing pertition option","description":"See Frequency Codes","type":"string","enum":["D","W","M","Q","Y"]},"primary_color":{"title":"Primary color","description":"Primary color is the main color used on Atlas","type":"string"},"accent_color":{"title":"Accent color","description":"Accent color is occasionally used in elements such as checkboxes","type":"string"},"brand_colors":{"title":"Brand colors","description":"Brand colors are used in charts generated from reporting","type":"array","items":{"type":"string"}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Firms":{"type":"array","items":{"$ref":"#/components/schemas/Firm"}},"BillingGroup":{"type":"object","properties":{"id":{"title":"Object ID","description":"The unique resource ID for this Billing Group","type":"integer","format":"int64"},"name":{"title":"Billing group name","description":"The name of this Billing Group","type":"string"},"slug":{"title":"Sluggified name","description":"The sluggified name of this Billing Group","type":"string"},"household_id":{"title":"Household id","description":"The ID of the associated household for this Billing Group","type":"integer"},"firm_id":{"title":"Firm id","description":"The firm ID of the managing firm for this Billing Group","type":"integer"},"minimum_ids":{"title":"Minimum id","description":"A list of billing minimum ID's associated with this Billing Group","type":"array","items":{"type":"integer"}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"},"assignments":{"title":"Assignments","description":"A list of AccountGroupAssignment objects associated with this Billing Group","type":"object","properties":{"id":{"title":"Object ID","description":"The unique resource id for this Account Group Assignment","type":"integer","format":"int64"},"account_id":{"title":"Account id","description":"The related account of this assignment","type":"integer"},"group_id":{"title":"Group id","description":"The related group of this assignment","type":"integer"},"fee_location":{"title":"Fee location","description":"Numerical indicator for fee location behavior. Options are 0 (charged to itself), -1 (uncharged / charged to the group, where fees are distributed in prorate fashion by size), or a positive integer, which represents the ID of the account being charged.","type":"integer","enum":[0,-1]},"fee_location_option":{"title":"Fee location option","description":"The desired fee location option. Options are S (self), G (group), or A (account).","type":"string","enum":["S","G","A"]}}}}},"BillingGroups":{"type":"array","items":{"$ref":"#/components/schemas/BillingGroup"}},"AssetAdjustment":{"type":"object","properties":{"id":{"title":"Object Id","description":"The unique resource ID for this Asset Adjustment","type":"integer"},"name":{"title":"Name","description":"The name of this Asset Adjustment","type":"string"},"slug":{"title":"Sluggified name","description":"The sluggified name of this Asset Adjustment","type":"string"},"security_ids":{"title":"Security IDs","description":"List of security ids associated with this asset adjustment","type":"array","items":{"type":"integer"}},"adjustment_type":{"title":"Adjustment type","description":"i for inclusion, e for exclusion","type":"string","enum":["i","e"]},"level":{"title":"Level","description":"f for firm-wide, a for the account level","type":"string","enum":["f","a"]},"firm_id":{"title":"Firm id","description":"The firm ID of the managing firm","type":"integer"},"weight":{"title":"Weight","description":"Weight of the adjusted asset","type":"integer"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"AssetAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/AssetAdjustment"}},"FeeStructure":{"type":"object","properties":{"id":{"title":"Object id","description":"The unique resource ID for this Fee Structure","type":"integer"},"created_by_user_id":{"title":"Created by id","description":"The user ID of the creator User","type":"integer","deprecated":true},"firm_id":{"title":"Firm id","description":"The firm ID of the managing firm","type":"integer"},"name":{"title":"Name","description":"The name of this Fee Structure","type":"string"},"slug":{"title":"Slug","description":"The slugified name of this Fee Structure","type":"string"},"calculation_type":{"title":"Calculation type","description":"R for Flat Rate, A for Flat Account Fee, G for Flat Group Fee, D for Drop Through, T for Tiered Fee, and F for Favor Fee","type":"string","enum":["R","A","G","D","T","F"]},"collection_type":{"title":"Collection type","description":"See Billing Collection Types","type":"string"},"frequency":{"title":"Frequency","description":"See Frequency Codes","type":"string","enum":["M","Q"]},"quarter_cycle":{"title":"Quarter cycle","description":"See Billing Quarter Cycle Codes","type":"integer"},"balance_type":{"title":"Balance type","description":"E for end of period balance, A for average daily balance, P for ending period balance w/ adjustment for flows, C for ending period balance w/adjustment for flows less cash","type":"string","enum":["E","A","P","C"]},"flat_rate":{"title":"Flat rate","description":"The flat rate for this Fee Structure. Must be between 0 and 99 inclusive. Will be stored and converted to a Percentage. (i.e. 1 -> 1% and 0.25 -> 0.25%)","type":"number","format":"float"},"flat_dollar_fee":{"title":"Flat dollar fee","description":"The flat dollar fee for this Fee Structure","type":"number","format":"float"},"tiers":{"title":"Tiers","description":"Tiers associated with the fee structure","type":"array","items":{"type":"object","properties":{"id":{"title":"Id","description":"Id associated with the tier object","type":"integer"},"min_balance":{"title":"Minimum balance","description":"Minimum balance for the tier","type":"number"},"max_balance":{"title":"Maximum balance","description":"Maximum balance for the tier","type":"number"},"rate":{"title":"Rate","description":"Rate for the tier","type":"number"},"fee_structure_id":{"title":"Fee structure id","description":"Fee structure id associated with this tier","type":"integer"}}}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"FeeStructures":{"type":"array","items":{"$ref":"#/components/schemas/FeeStructure"}},"Minimuns":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource ID for this Billing Minimum","type":"integer"},"firm_id":{"title":"Firm Id","description":"The firm ID of the managing firm","type":"integer"},"name":{"title":"Name","description":"The name of this Billing Minimum","type":"string"},"value":{"title":"Value","description":"The value of this Billing Minimum","type":"number","format":"float"},"value_type":{"title":"Value type","description":"F for flat amount, P for percentage","type":"string","enum":["F","P"]},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"MinimunsMany":{"type":"array","items":{"$ref":"#/components/schemas/Minimuns"}},"Split":{"type":"array","items":{"$ref":"#/paths/~1billing~1splits~1%7Bid%7D/put/requestBody/content/application~1json/schema"}},"Splits":{"$ref":"#/components/schemas/Split"},"BillingReport":{"type":"object","properties":{"id":{"description":"The unique resource ID for this billing report","type":"integer"},"firm_id":{"description":"The firm ID of the managing firm","type":"integer"},"created_invoices":{"description":"True if invoices were created when the report was created","type":"boolean"},"billing_date":{"description":"The input date to the billing report","type":"string","format":"date-time"},"snapshot_date":{"description":"The closest date available to the billing date for which there's data at the time of running the report","type":"string","format":"date-time"},"run_date":{"description":"The most recent market date corresponding to when the report date","type":"string","format":"date-time"},"created_date":{"description":"The calendar date on which the report was generated / created","type":"string","format":"date-time"},"annual_fee":{"description":"Total fee and debited amount annualized","type":"number","format":"float"},"annual_debit":{"description":"The annual debit amount for this billing report","type":"number","format":"float"},"total_balance":{"description":"Sum of all group balances on the billing date","type":"number","format":"float"},"aum_on_billing_date":{"description":"All assets under management on the billing date","type":"number","format":"float"},"period_debit":{"description":"Total debited amount for the period","type":"number","format":"float"},"direct_billed_period_debit":{"description":"The direct billed period debit for this billing report","type":"number","format":"float"},"custodian_billed_period_debit":{"description":"The custodian billed period debit for this billing report","type":"number","format":"float"},"split_payout":{"description":"Total payout of all splits for this period","type":"number","format":"float"},"split_payout_annualized":{"description":"Split payout on an annualized basis","type":"number","format":"float"},"firm_share":{"description":"The firm's share for the period. Equals period_debit - split_payout.","type":"number","format":"float"},"firm_share_annualized":{"description":"Firm's annualized share. Equals annual_debit - split_payout_annualized.","type":"number","format":"float"},"account_value_on_snapshot_date":{"description":"Maps account ID to total account valuation on a particular date","type":"object"},"account_cash_on_snapshot_date":{"description":"Maps the cash amount in the account as of the billing date","type":"object"},"account_value_on_run_date":{"description":"Maps account ID to total account valuation as of the report run date","type":"object"},"account_cash_on_run_date":{"description":"Maps the cash amount in the account as of the report run date","type":"object"},"group_value_on_snapshot_date":{"description":"Maps a group ID to the total value of all accounts in the group on the snapshot date","type":"object"},"group_cash_on_snapshot_date":{"description":"Maps group ID to the total cash value of all accounts in the group on the snapshot date","type":"object"},"group_value_on_run_date":{"description":"Maps a group ID to the total value of all accounts in the group on the run date","type":"object"},"group_cash_on_run_date":{"description":"Maps group ID to the total cash value of all accounts in the group on the run date","type":"object"},"account_ids":{"description":"The associated accounts ID's for this billing report","type":"array","items":{"type":"integer"}},"group_ids":{"description":"The associated group ID's for this billing report","type":"array","items":{"type":"integer"}},"fee_structure_ids":{"description":"The associated fee structure ID's for this billing report","type":"array","items":{"type":"integer"}},"billing_split_ids":{"description":"The associated billing split ID's for this billing report","type":"array","items":{"type":"integer"}},"n_accounts":{"description":"The number of accounts for this billing report","type":"integer"},"n_groups":{"description":"The number of groups for this billing report","type":"integer"},"n_splits":{"description":"The number of billing splits for this billing report","type":"integer"},"n_fee_structures":{"description":"The number of fee structures for this billing report","type":"integer"},"account_df":{"description":"A collection of maps for various data points of the billing run keyed on `account_id`","type":"object"},"group_df":{"description":"A collection of maps for various data points of the billing run keyed on `group_id`","type":"object"},"minfee_df":{"description":"Detail of a minimum fee if included on the billing run.","type":"object"},"splits_df":{"description":"A collection of maps detailing the split percentages applied in the billing run.","type":"object"},"agg_splits_by_account_df":{"description":"A collection maps for split calculation details for accounts keyed on `account_id`","type":"object"},"agg_splits_by_splitter_df":{"description":"A collection of objects detailing billing splits. Keyed on `splitter_slug`","type":"object"},"agg_splits_by_group_df":{"description":"A collection maps for split calculation details for billing groups keyed on `group_id`","type":"object"},"structure_fees_by_group_fs":{"description":"Keyed on (1) group id and (2) fee structure id where it is valued on a number representing the structure fee corresponding to that groupid / fee structure combination","type":"object"},"fee_upload_file_id":{"description":"The corresponding fee upload file model instance","type":"integer"},"fee_structures_serialized":{"description":"The list of fee structures included in the billing run.","type":"object"},"asset_adjustments_serialized":{"description":"A list of asset adjustments included in the billing run.","type":"object"},"billing_groups_serialized":{"description":"The list of included billing groups in the billing run.","type":"object"},"billing_minimums_serialized":{"description":"The list of billing minimus included in the billing run.","type":"object"},"splits_serialized":{"description":"The list of billing splits included in the billing run","type":"object"},"fee_structure_assignments":{"description":"A map keyed on `account_id` indicating fee structures assigned to accounts.","type":"object"},"split_assignments":{"description":"A map keyed on `account_id` indicating splitters assigned to accounts.","type":"object"},"is_firm_wide_billing":{"description":"Indicates if the billing run is for the entire firm. If `true` all billing groups will be included.","type":"boolean"},"is_rebate_billing":{"description":"Indicates whether the billing run was selected as rebate","type":"boolean"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"BillingReports":{"type":"array","items":{"$ref":"#/components/schemas/BillingReport"}},"FeeUpload":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource ID for this Fee Upload File","type":"integer"},"firm_id":{"title":"Firm id","description":"The firm ID of the managing firm","type":"integer"},"end_date":{"title":"End date","description":"The date that this Fee Upload File ends","type":"string","format":"date-time"},"file_keys":{"title":"File keys","description":"A list of String file keys for this Fee Upload File","type":"array","items":{"type":"string"}},"num_files":{"title":"Number of files","description":"The number of files for this Fee Upload File","type":"integer"},"num_custodians":{"title":"Number of custodains","description":"The number of custodians for this Fee Upload File","type":"integer"},"num_accounts":{"title":"Number of accounts","description":"The number of accounts for this Fee Upload File","type":"integer"},"num_households":{"title":"Number of households","description":"The number of households for this Fee Upload File","type":"integer"},"total_annual_debit":{"title":"Total annual debit","description":"The total annual debit for this Fee Upload File","type":"number","format":"float"},"total_period_debit":{"title":"Total period debit","description":"The total period debit for this Fee Upload File","type":"number","format":"float"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"FeeUploads":{"type":"array","items":{"$ref":"#/components/schemas/FeeUpload"}},"Invoice":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Invoice","type":"integer"},"firm_id":{"description":"The firm ID of the managing firm","type":"integer"},"household_id":{"description":"Household id associated with the invoice","type":"integer"},"minimum_ids":{"description":"The list of minumum ID's associated with this Invoice","type":"array","items":{"type":"integer"}},"billing_date":{"description":"Billing date for this Invoice","type":"string","format":"date-time"},"billing_group_id":{"description":"The billing group ID for this Invoice","type":"integer"},"snapshot_date":{"description":"The snapshot date for this Invoice","type":"string","format":"date-time"},"billing_report_id":{"description":"The associated billing report ID for this Invoice","type":"integer"},"account_value_on_snapshot_date":{"description":"Maps account ID to total account valuation on a particular date","type":"object"},"account_cash_on_snapshot_date":{"description":"Maps the cash amount in the account as of the billing date","type":"object"},"account_value_on_run_date":{"description":"Maps account ID to total account valuation as of the report run date","type":"object"},"account_cash_on_run_date":{"description":"Maps the cash amount in the account as of the report run date","type":"object"},"group_value_on_snapshot_date":{"description":"Maps a group ID to the total value of all accounts in the group on the snapshot date","type":"object"},"group_cash_on_snapshot_date":{"description":"Maps group ID to the total cash value of all accounts in the group on the snapshot date","type":"object"},"group_value_on_run_date":{"description":"Maps a group ID to the total value of all accounts in the group on the run date","type":"object"},"group_cash_on_run_date":{"description":"Maps group ID to the total cash value of all accounts in the group on the run date","type":"object"},"annual_fee":{"description":"The total fee and debited amount annualized just for this billing group","type":"number","format":"float"},"annual_debit":{"description":"The annual debit for this Invoice","type":"number","format":"float"},"total_balance":{"description":"The total group balance on the snapshot date","type":"number","format":"float"},"period_debit":{"description":"The total debited amount for the period just for this billing group on the snapshot date","type":"number","format":"float"},"direct_billed_period_debit":{"description":"The direct billed period debit for this Invoice.","type":"number","format":"float"},"custodian_billed_period_debit":{"description":"The custodian billed period debit for this Invoice","type":"number","format":"float"},"account_ids":{"description":"The list of account ID's associated with this Invoice","type":"array","items":{"type":"integer"}},"fee_structure_ids":{"description":"The list of fee structure ID's associated with this Invoice","type":"array","items":{"type":"integer"}},"n_accounts":{"description":"The number of accounts in the report","type":"integer"},"n_fee_structures":{"description":"The number of fee structures in the report","type":"integer"},"account_df":{"description":"Serialized from the account_df data-frame on the billing calculator","type":"object"},"group_df":{"description":"Serialized from group_df on the billing calculator","type":"object"},"minfee_df":{"description":"Serialized from minimum fee on the billing calculator","type":"object"},"fee_structures_serialized":{"description":"A serialization of fee structures as they existed at the time the report was generated","type":"object"},"asset_adjustments_serialized":{"description":"Serialized asset adjustments at the time the report was generated","type":"object"},"billing_group_serialized":{"description":"Serialized billing group at the time the invoice was created","type":"object"},"download_url":{"description":"Download link which specifies the url to generate and return a binary stream for the Invoice PDF.","type":"string"},"due_date":{"description":"Invoice due date, calculated using firm settings at the time the invoice was generated","type":"string","format":"date-time"},"account_fs_df":{"description":"Serialized from the account_fs_df dataframe on the billing calculator","type":"object"},"group_id":{"description":"Group Id of this invoice","type":"integer"},"pdf_state":{"description":"State of the billing invoice pdf state. 0 for does not exist, 1 for created, 2 for generating, 3 for success, -1 for failed","type":"string"},"client_name":{"description":"Name of the client associated with this invoice","type":"string"},"fee_structure_assignments":{"description":"Serialized fee structure assignments at the time the invoice was created","type":"object"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Invoices":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"FileSharing":{"type":"object","properties":{"id":{"description":"The unique resource id for the Shared File","type":"integer"},"firm_id":{"description":"The firm id assigned to this Shared File","type":"integer"},"uploaded_by_user_id":{"description":"The id of the User that created this Shared File","type":"integer"},"sharing_scope":{"description":"Determines whether the sharing of this file is firm-wide (a) or restricted to households (h). See Entity ID Prefixes.","type":"string","enum":["a","h"]},"shared_household_id":{"description":"Set when the file is sharing with the household scope","type":"integer"},"size_bytes":{"description":"The size in bytes of this Shared File","type":"integer"},"filename":{"description":"The S3 filename for this Shared File","type":"string"},"file_type":{"description":"See Shared File Types","type":"string"},"content_type":{"description":"The content type for this Shared File","type":"string"}}},"FileSharings":{"type":"array","items":{"$ref":"#/components/schemas/FileSharing"}},"HeldawayDepository":{"type":"object","properties":{"id":{"description":"The unique resource id for this Heldaway Transaction","type":"integer"},"plaid_transaction_id":{"description":"The ID of the transaction on Plaid","type":"string"},"plaid_account_id":{"description":"The Plaid account id associated with this heldaway transaction","type":"string"},"plaid_item_id":{"description":"The id of the heldaway connection associated with this transaction","type":"string"},"household_id":{"description":"The id of the household to which this transaction belongs","type":"integer"},"firm_id":{"description":"The id of the firm managing this heldaway transaction","type":"integer"},"categories":{"description":"A hierarchical array of the categories to which this transaction belongs","type":"array","items":{"type":"string"}},"category_id":{"description":"The ID of the category to which this transaction belongs","type":"string"},"plaid_transaction_type":{"description":"The type of Transaction determined by Plaid","type":"string"},"name":{"description":"Description of the transaction","type":"string"},"merchant_name":{"description":"Clean name of the merchant if applicable","type":"string"},"amount":{"description":"The settled dollar value. Positive values when money moves out of the account; negative values when money moves in. For example, purchases are positive; credit card payments, direct deposits, refunds are negative","type":"number","format":"float"},"iso_currency_code":{"description":"The ISO currency code of the transaction. Always null if unofficial_currency_code is non-null.","type":"string"},"unofficial_currency_code":{"description":"The currency code associated with the transaction, if not recognized as an ISO code. For example, cryptocurrencies such as BTC. Always null if iso_currency_code is non-null.","type":"string"},"date":{"description":"For pending transactions, Plaid returns the date the transaction occurred; for posted transactions, Plaid returns the date the transaction posts. Both dates are returned in an ISO 8601 format ( YYYY-MM-DD ). Dates reflect the date posted by the bank and are not standardized to a timezone by Plaid.","type":"string","format":"date-time"},"authorized_date":{"description":"The date that the transaction was authorized. Dates are returned in an ISO 8601 format ( YYYY-MM-DD ).","type":"string","format":"date-time"},"location":{"description":"Information about where the transaction occurred. The location key will always be an Object, but no location data elements are guaranteed.","type":"object"},"payment_meta":{"description":"Information about a transfer payment. The payment_meta key will always be an Object, but no payment_meta data elements are guaranteed. This object will be deprecated in the future.","type":"object"},"payment_channel":{"description":"The channel used to make a payment. Possible values are; online, in store, other. This field will replace the transaction_type field.","type":"object"},"pending":{"description":"When true, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled.","type":"boolean"},"account_owner":{"description":"The name of the account owner. This field is not typically populated and only relevant when dealing with sub-accounts.","type":"string"},"transaction_code":{"description":"The transaction code","type":"string"},"plaid_pending_transaction":{"description":"Information about the plaid pending transaction","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"HeldawayDepositories":{"type":"array","items":{"$ref":"#/components/schemas/HeldawayDepository"}},"HeldawayHolding":{"type":"object","properties":{"id":{"description":"The unique resource id for this Heldaway Position","type":"integer"},"plaid_account_id":{"description":"The Plaid account id associated with this heldaway position","type":"string"},"plaid_item_id":{"description":"The id of the heldaway connection that owns this position","type":"string"},"household_id":{"description":"The id of the household to which this position belongs","type":"integer"},"firm_id":{"description":"The id of the firm managing this heldaway position","type":"integer"},"cost_basis":{"description":"The cost basis of the holding, if it is available from the institution","type":"number","format":"float"},"iso_currency_code":{"description":"Unit of currency that is displayed where null is defaulted to USD","type":"string"},"unofficial_currency_code":{"description":"The unofficial currency of the holding.","type":"string"},"institution_price":{"description":"The last price given by the institution for this security.","type":"number","format":"float"},"institution_price_as_of":{"description":"The date at which institution_price was current.","type":"string","format":"date-time"},"quantity":{"description":"The amount of shares of this position","type":"number","format":"float"},"security":{"description":"JSON string containing information about the security","type":"string"},"institution_value":{"description":"The total value of the position","type":"number","format":"float"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"HeldawayHoldings":{"type":"array","items":{"$ref":"#/components/schemas/HeldawayHolding"}},"HeldawayInvestment":{"type":"object","properties":{"id":{"description":"Unique ID of the Heldaway Investment Transaction","type":"integer"},"plaid_investment_transaction_id":{"description":"The ID of the Investment transaction, unique across all Plaid transactions.","type":"string"},"plaid_item_id":{"description":"The id of the heldaway connection that owns this transaction.","type":"string"},"plaid_account_id":{"description":"The ID of the account against which this transaction posted.","type":"string"},"plaid_security_id":{"description":"The ID of the security assigned by Plaid to which this transaction is related.","type":"string"},"date":{"description":"Date The ISO-8601 posting date for the transaction, or transacted date for pending transactions.","type":"string"},"name":{"description":"The Institution’s description of the transaction.","type":"string"},"quantity":{"description":"The Amount of the security involved in this transaction.","type":"number","format":"float"},"amount":{"description":"The complete value of the transaction. Positive values when cash is debited, e.g. purchases of stock; negative values when cash is credited, e.g. sales of stock. Treatment remains the same for cash-only movements unassociated with securities.","type":"number","format":"float"},"price":{"description":"The price of the security at which this transaction occurred.","type":"number","format":"float"},"fees":{"description":"The combined value of all fees applied to this transaction.","type":"number","format":"float"},"type":{"description":"Investment Transaction type assigned by Plaid","type":"string"},"subtype":{"description":"Investment Transaction subtype assigned by Plaid","type":"string"},"iso_currency_code":{"description":"The ISO-4217 currency code of the transaction. Always null if unofficial_currency_code is non-null.","type":"string"},"unofficial_currency_code":{"description":"The unofficial currency of the transaction. Always null if iso_currency_code is non-null. This is present if the price is denominated in an unrecognized currency e.g. Bitcoin, rewards points.","type":"string"},"cancel_transaction_id":{"description":"Present only when the transaction type is cancel, and indicates the investment_transaction_id of the transaction which was cancelled.","type":"string"},"household_id":{"description":"The id of the household to which this transaction belongs.","type":"integer"},"firm_id":{"description":"The id of the firm managing this heldaway transaction.","type":"integer"},"created_at_utc":{"description":"Timestamp for when the record was created.","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated.","type":"string","format":"date-time"}}},"HeldawayInvestments":{"type":"array","items":{"$ref":"#/components/schemas/HeldawayInvestment"}},"Model":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this model object","type":"integer"},"name":{"title":"Name","description":"Name for the model","type":"string"},"firm_id":{"title":"Firm Id","description":"Id of the firm this model is associated with","type":"integer"},"strategy_allocations":{"title":"Strategy allocation","description":"Strategy allocation associated with this model","type":"array","items":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this strategy allocation","type":"integer"},"model_id":{"title":"Model Id","description":"Model Id for this strategy allocation","type":"integer"},"strategy_id":{"title":"Strategy Id","description":"Strategy ID for this strategy allocation","type":"integer"},"weight":{"title":"Weight","description":"Weight of the strategy allocation associated to the investment model","type":"number"}}}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Models":{"type":"array","items":{"$ref":"#/components/schemas/Model"}},"Strategy":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this strategy object","type":"integer"},"name":{"title":"Name","description":"Name for the strategy","type":"string"},"firm_id":{"title":"Firm Id","description":"Id of the firm this strategy is associated with","type":"integer"},"description":{"title":"Description","description":"Description of the strategy","type":"string"},"provider":{"title":"Provider","description":"Provider of the strategy","type":"string"},"investment_minimum":{"title":"Investment minimum","description":"Investment minimum","type":"number"},"fee":{"title":"Fee","description":"Fee reported on the strategy","type":"number"},"benchmark_id":{"title":"Benchmark id","description":"Id of the benchmark associated with this strategy","type":"integer"},"strategy_type":{"title":"Strategy type","description":"Type of the strategy.","type":"string","enum":["Core","Satellite","Income","Alternatives"]},"tax_managed":{"title":"Tax managed","description":"Is the tax managed?","type":"boolean"},"risk_category":{"title":"Risk category","description":"Risk category of the strategy. CP for Capital Preservation, CO for Conservative, MC for Moderate Conservative, MO for Moderate, MG for Moderate Growth, GR for Growth, AG for Aggressive Growth","type":"string","enum":["CP","CO","MC","MO","MG","GR","AG"]},"search_tags":{"title":"Search tags","description":"Search tags for the strategy","type":"array","items":{"type":"string"}},"asset_type":{"title":"Asset type","description":"Asset type of the strategy","type":"string"},"fact_sheet_available":{"title":"Fact sheet available","description":"Is the fact sheet available?","type":"boolean"},"esg":{"title":"ESG","description":"Is environmental, social, governance?","type":"boolean"},"etf_action_identifier":{"title":"Etf action identifier","description":"Identifier for etc action","type":"string"},"security_allocations":{"title":"Security allocation","description":"Security allocation associated with this model","type":"array","items":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this security allocation","type":"integer"},"weight":{"title":"Weight","description":"Weight of the security allocation associated with the strategy","type":"number"},"security_id":{"title":"Security Id","description":"Security Id associated with the strategy","type":"integer"},"strategy_id":{"title":"Strategy ID","description":"ID of the associated strategy","type":"integer"}}}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Strategies":{"type":"array","items":{"$ref":"#/components/schemas/Strategy"}},"AssetClassification":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this asset classification object","type":"integer"},"firm_id":{"title":"Firm id","description":"ID of the owning firm","type":"integer"},"security_id":{"title":"Security id","description":"ID of the security being classified","type":"integer"},"created_by_user_id":{"title":"Created by user id","description":"ID of the user that created the classification","type":"integer"},"class_tag_id":{"title":"Class Tag id","description":"ID of the class tag for the classification","type":"integer"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"AssetClassifications":{"type":"array","items":{"$ref":"#/components/schemas/AssetClassification"}},"ClassificationTag":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this class tag object","type":"integer"},"name":{"title":"Name","description":"Class tag name","type":"string"},"firm_id":{"title":"Firm id","description":"ID of the owning firm","type":"integer"},"created_dt_utc":{"title":"Created date","description":"Created timestamp in UTC","type":"string","format":"date-time"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"ClassificationTags":{"type":"array","items":{"$ref":"#/components/schemas/ClassificationTag"}},"Benchmark":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this benchmark object","type":"integer"},"firm_id":{"title":"Firm id","description":"ID of the owning firm","type":"integer"},"name":{"title":"Name","description":"Benchmark name","type":"string"},"slug":{"title":"Slug","description":"Slugified benchmark name","type":"string"},"coefficients":{"title":"Coefficients","description":"Coefficients associated with this benchmark","type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this benchmark coefficient object","type":"integer"},"weight":{"title":"Weight","description":"The coefficient on the benchmark; stored on the percentage scale (0.0 to 100.0)","type":"string"},"benchmark_id":{"title":"Benchmark id","description":"Benchmark object ID to which this coefficient belongs","type":"integer"},"index_id":{"title":"Index id","description":"ID of the index that the benchmark weight is tied to","type":"integer"}}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Benchmarks":{"type":"array","items":{"$ref":"#/components/schemas/Benchmark"}},"ReportSetting":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this report settings object","type":"integer"},"firm_id":{"title":"Firm id","description":"ID of the owning firm","type":"integer"},"user_id":{"title":"User id","description":"ID of the user concerned with creating the report. If null, applied settings will be firm-wide. Otherwise, the settings are specific to the given user","type":"integer"},"component":{"title":"Component","description":"Specifies to which area these settings apply (i.e., printable reports, the advisor's default settings, the client's default settings). Can either be printable, advisor_defaults, client_defaults, or user","type":"string","enum":["printable","advisor_defaults","client_defaults","user"]},"account_summary":{"title":"Account summary","description":"Include account summary?","type":"boolean"},"consolidated_summary":{"title":"Consolidate summary","description":"Include consolidated summary?","type":"boolean"},"performance_summary":{"title":"Performance summary","description":"Include performance summary?","type":"boolean"},"benchmark_perf_summary":{"title":"Benchmark perfmance summary","description":"Include benchmark performance summary?","type":"boolean"},"performance_chart":{"title":"Performance chart","description":"Include performance chart?","type":"boolean"},"appraisals":{"title":"Appraisals","description":"Include appraisals?","type":"boolean"},"asset_allocation_top_holdings":{"title":"Asset allocation top holdings","description":"Include asset allocation top holdings?","type":"boolean"},"buy_sells":{"title":"Buy sells","description":"Include buys and sells?","type":"boolean"},"deposits_withdrawals":{"title":"Deposites Withdrawals","description":"Include deposits and withdrawals?","type":"boolean"},"income":{"title":"Income","description":"Include income?","type":"boolean"},"realized_gain_loss":{"title":"Realized gain loss","description":"Include realized gain loss?","type":"boolean"},"management_fees":{"title":"Management Fees","description":"Include management fees?","type":"boolean"},"net_investment_chart":{"title":"Net investment chart","description":"Include net investment chart?","type":"boolean"},"portfolio_snapshot":{"title":"Portfolio snapshot","description":"Include portfolio snapshot?","type":"boolean"},"household_performance_attribution":{"title":"Household performance attribute","description":"Include household performance attribute?","type":"boolean"},"target_vs_actual_allocation":{"title":"Target vs actual allocation","description":"Include target vs actual allocation?","type":"boolean"},"security_performance":{"title":"Security performance","description":"Include security performance?","type":"boolean"},"appraisals_wo_cost_basis":{"title":"Appraisals without cost basis","description":"Include appraisals without cost basis?","type":"boolean"},"risk_return_chart":{"title":"Risk return chart","description":"Include risk return chart?","type":"boolean"},"security_exclusions":{"title":"Security exclusion","description":"Include security exclusions?","type":"boolean"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"ReportSettings":{"type":"array","items":{"$ref":"#/components/schemas/ReportSetting"}},"PrintableReport":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this printable report object","type":"integer"},"firm_id":{"title":"Firm Id","description":"ID of the owning firm","type":"integer"},"account_id":{"title":"Account id","description":"ID of the account that the report is on. Null if household_id is non-null","type":"integer"},"household_id":{"title":"Household id","description":"ID of the household that the report is on. Null if account_id is non-null","type":"integer"},"created_by_user_id":{"title":"Created by user id","description":"ID of the user that created the report","type":"integer","deprecated":true},"report_date":{"title":"Report date","description":"Report date","type":"string","format":"date-time"},"frequency":{"title":"Frequency","description":"See Frequency Codes","type":"string"},"start_date":{"title":"Start date","description":"start date","type":"string","format":"date-time"},"end_date":{"title":"End date","description":"End date","type":"string","format":"date-time"},"timestamp_utc":{"title":"Timestamp UTC","description":"Created/last updated timestamp in UTC","type":"string","format":"date-time"},"dt_utc":{"title":"Date time UTC","description":"Created/last updated timestamp in datetime UTC","type":"string","format":"date-time"},"size_bytes":{"title":"Size bytes","description":"Size of the printable report in bytes","type":"integer"},"client_accessible":{"title":"Client accessibility","description":"If true, the report is accessible in the client portal","type":"boolean"},"tags":{"title":"Tags","description":"List of specified tags, if applicable (system-generated reports are always untagged)","type":"array","items":{"type":"string"}},"sub_reports":{"title":"Sub reports","description":"List of sub-reports included in this printable report","type":"array","items":{"type":"string"}},"state":{"title":"State","description":"0 if the report is generating, R if it's ready, and E if it's failed","type":"string"},"error_message":{"title":"Error message","description":"Error message if in error state E","type":"string"},"download_url":{"title":"Download Url","description":"Download link which specifies the url to generate and return a binary stream for the Printable PDF","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"PrintableReports":{"type":"array","items":{"$ref":"#/components/schemas/PrintableReport"}},"TargetAllocation":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this target allocation object","type":"integer"},"firm_id":{"title":"Firm id","description":"ID of the owning firm","type":"integer"},"name":{"title":"Name","description":"Name for the target allocation","type":"integer"},"slug":{"title":"Slug","description":"Slugified target allocation name","type":"string"},"coefficients":{"title":"Coefficient","description":"Target allocation coefficient","type":"array","items":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this target allocation coefficient object","type":"integer"},"mac":{"title":"Master asset class","description":"Master asset class associated with this coefficient","type":"integer"},"weight":{"title":"Weight","description":"Weight of the coefficient","type":"number"},"class_tag_id":{"title":"Class tag id","description":"Asset classification tag id associated with the coefficient","type":"integer"},"negative_tolerance":{"title":"Negative tolerance","description":"Value of negative tolerance","type":"number"},"positive_tolerance":{"title":"Positive tolerance","description":"Value of positive tolerance","type":"number"}}}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"TargetAllocations":{"type":"array","items":{"$ref":"#/components/schemas/TargetAllocation"}},"Job":{"type":"object","properties":{"id":{"title":"Id","description":"Unique ID for this background job object","type":"integer"},"firm_id":{"title":"Firm id","description":"ID of the owning firm","type":"integer"},"job_type":{"title":"Job type","description":"The type of this job. Currently either b for a billing report, pdfrp for a PDF report, or bd for a bulk download","type":"string","enum":["b","pdfrp","db"]},"created_dt_utc":{"title":"Created time","description":"Create timestamp in UTC","type":"string","format":"date-time"},"last_updated_dt_utc":{"title":"Last updated time","description":"The last date and time this Background Job was updated","type":"string","format":"date-time"},"queued_dt_utc":{"title":"Queued time","description":"The last date and time this Background Job was queued","type":"string","format":"date-time"},"started_dt_utc":{"title":"Started date time","description":"The last date and time this Background Job was started","type":"string","format":"date-time"},"finished_dt_utc":{"title":"Finished date time","description":"The last date and time this Background Job was finished","type":"string","format":"date-time"},"failed_dt_utc":{"title":"Failed date time","description":"The last date and time this Background Job was failed","type":"string","format":"date-time"},"created_by_id":{"title":"Created by id","description":"The user id for the user who created this Background Job","type":"integer"},"is_finished":{"title":"Is finished","description":"Returns true if the job is finished","type":"boolean"},"is_running":{"title":"Is running","description":"Returns true if the job has been dequeued and is running","type":"boolean"},"is_failed":{"title":"Is failed","description":"Returns true if the job failed due to an exception","type":"boolean"},"is_revoked":{"title":"Is revoked","description":"Returns true if the job was cancelled by the user","type":"boolean"},"num_steps":{"title":"Number of steps","description":"The progress of a job. Note that the number of steps might not be known until the job is dequeued.","type":"integer"},"current_step":{"title":"Current step","description":"Zero corresponds to the job waiting to be processed","type":"integer"},"email_notification":{"title":"Email notification","description":"If true, this sends an email notification to the user who created the job","type":"string","format":"date-time","deprecated":true},"email_notification_dt_utc":{"title":"Email notification at UTC time","description":"The timestamp at which the email notification was sent. Only applies when email_notification is enabled","type":"string","format":"date-time","deprecated":true},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Jobs":{"type":"array","items":{"$ref":"#/components/schemas/Job"}},"Aum":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource ID for this AUM","type":"integer"},"firm_id":{"title":"Firm id","description":"The firm ID of the managing firm","type":"integer"},"as_of_date":{"title":"As of date","description":"The current date of the AUM","type":"string","format":"date-time"},"frequency":{"title":"Frequency","description":"Daily (D) or Monthly (M) Frequency","type":"string","enum":["D","M"]},"total":{"title":"Total","description":"The total assets under management for the firm.","type":"number","format":"float"}}},"Aums":{"type":"array","items":{"$ref":"#/components/schemas/Aum"}},"HealdawayAccount":{"type":"object","properties":{"id":{"description":"Unique ID for this account object","type":"integer"},"firm_id":{"description":"ID of the owning firm","type":"integer"},"plaid_item_id":{"description":"ID of the associated Plaid connection","type":"string"},"plaid_account_id":{"description":"Account associated with this plaid account object","type":"string"},"household_id":{"description":"ID of the household to which this account belongs","type":"integer"},"type":{"description":"See Account Schema on Plaid's API Documentation; https://plaid.com/docs/#account-schema","type":"string"},"subtype":{"description":"See Account Schema on Plaid's API Documentation; https://plaid.com/docs/#account-schema","type":"string"},"institution_name":{"description":"Name of the account-holder institution","type":"string"},"official_name":{"description":"Official name of the account assigned by the institution","type":"string"},"mask":{"description":"Last four alphanumeric digits of the account number","type":"string"},"name":{"description":"Account name","type":"string"},"balances":{"description":"Information about the account's current balance","type":"object","properties":{"available":{"description":"Available total balance","type":"number"},"current":{"description":"Available current balance","type":"number"},"limit":{"description":"Balance limit","type":"number"},"iso_currency_code":{"description":"ISO currency code","type":"string"}}},"verification_status":{"description":"See https://plaid.com/docs/#account-verification-status","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"HealdawayAccounts":{"type":"array","items":{"$ref":"#/components/schemas/HealdawayAccount"}},"IncomeExpense":{"type":"object","properties":{"id":{"description":"The unique resource id for the Transaction","type":"integer"},"account_id":{"description":"The id of the Account associated with this Transaction","type":"integer"},"security_id":{"description":"The id of the Security associated with this Transaction","type":"integer"},"type":{"description":"The type of transaction. Possible values, INC=income, EXP=expense","type":"string","enum":["INC","EXP"]},"reported_date":{"description":"The date the custodian reports the transaction","type":"string","format":"date-time"},"transaction_date":{"description":"The date of the transaction on a trade basis","type":"string","format":"date-time"},"abs_amount":{"description":"The dollar amount associated with the Transaction","type":"number","format":"float"},"transaction_fee":{"description":"Fees associated with the Transaction (e.g. commission)","type":"number","format":"float"},"is_performance_impact":{"description":"Flag to indicate if the Transaction affects the time-weighted return performance calculation","type":"boolean"},"is_positive_cash_impact":{"description":"Flag to indicate if the Transaction increases the cash balance","type":"boolean"},"is_cancel":{"description":"Flag to indicate if this Transaction is a cancel from the custodian","type":"boolean"},"recon_id":{"type":"integer","deprecated":true,"nullable":true},"description":{"description":"Description of the transaction from the custodian","type":"string"},"meta_data":{"description":"Raw Meta Data passed through from the custodian","type":"object","deprecated":true},"custodian":{"title":"Financial institution data source","description":"Custodian the account data comes from. TDA=TD Ameritrade (Available prior to Sept. 2, 2023), SWB=Schwab, NFS=Fidelity, PER=Pershing, MLT=MillenniumTrust, HDG=Manual","type":"string","enum":["TDA (Available prior to Sept. 2, 2023)","SWB","NFS","PER","DST","MLT","HDG"]},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"},"is_outside":{"type":"boolean","deprecated":true,"nullable":true},"partition_id":{"type":"integer","deprecated":true,"nullable":true}}},"IncomeExpenses":{"type":"array","items":{"$ref":"#/components/schemas/IncomeExpense"}},"AccountBalance":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Balance object","type":"integer"},"as_of_date":{"description":"The current date for this Balance","type":"string","format":"date-time"},"prior_as_of_date":{"description":"The most recent date before the as_of_date","type":"string","format":"date-time"},"account_id":{"description":"The id of the Account associated with this Balance","type":"integer"},"household_id":{"description":"The id of the Household associated with this Balance.","type":"integer"},"beginning_period_value":{"description":"The beginning value of on the as_of_date. This is equal to the ending_period_value on the prior_as_of_date","type":"number","format":"float"},"ending_period_value":{"description":"The ending value on the as_of_date","type":"number","format":"float"},"abs_cash_currency_contribution":{"description":"Total value of cash deposits","type":"number","format":"float"},"abs_cash_currency_withdrawal":{"description":"Total value of cash withdrawals","type":"number","format":"float"},"abs_security_contribution":{"description":"Total value of security deposits","type":"number","format":"float"},"abs_security_withdrawal":{"description":"Total value of security withdrawals","type":"number","format":"float"},"abs_income":{"description":"Total value of performance affecting income (e.g. dividends, interest)","type":"number","format":"float"},"abs_expense":{"description":"Total value of performance affecting expenses (e.g. ADR fees)","type":"number","format":"float"},"abs_non_performance_income":{"description":"Total value of non-performance affecting income (e.g. return of principle)","type":"number","format":"float"},"abs_non_performance_expense":{"description":"Total value of non-performance affecting expenses (e.g. tax withholding)","type":"number","format":"float"},"total_fee":{"description":"Total value of management fees","type":"number","format":"float"},"percentage_period_net_return":{"description":"Daily, net time weighted return","type":"number","format":"float"},"percentage_period_gross_return":{"description":"Daily, gross time weighted return","type":"number","format":"float"},"cash_currency_impact":{"description":"Change in cash on as_of_date from all sources (e.g. income, trade activity)","type":"number","format":"float"},"cash_value":{"description":"Value of cash on as_of_date","type":"number","format":"float"},"security_holdings_value":{"description":"Market value of securities on as_of_date","type":"number","format":"float"},"unrealized_gain_loss":{"description":"Value of gain or loss on as_of_date for open positions (calculated as market value of all positions minus cost basis of all positions)","type":"number","format":"float"},"realized_gain_loss":{"description":"Value of gain or loss from closing transactions","type":"number","format":"float"},"cash_currency_net_contribution":{"description":"Net cash contribution (i.e. Cash Deposits minus Cash Withdrawals)","type":"number","format":"float"},"security_net_contribution":{"description":"Net security contributions (i.e. Security Deposits minus Security Withdrawals)","type":"number","format":"float"},"value":{"type":"number","format":"float"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"},"abs_outside_income":{"description":"Total value of outside income","type":"number","format":"float"},"abs_outside_expense":{"description":"Total value of outside expense","type":"number","format":"float"},"abs_initialization_contribution":{"description":"Total value of initialized contribution","type":"number","format":"float"},"abs_initialization_withdrawal":{"description":"Total value of initialized withdrawal","type":"number","format":"float"},"manual_holding_appreciation":{"description":"Maunual holding apreciation amount","type":"number","format":"float"}}},"AccountBalances":{"type":"array","items":{"$ref":"#/components/schemas/AccountBalance"}},"HouseholdBalance":{"type":"object","properties":{"as_of_date":{"description":"The current date for this Balance","type":"string","format":"date-time"},"prior_as_of_date":{"description":"The most recent date before the as_of_date","type":"string","format":"date-time"},"household_id":{"description":"The id of the Household associated with this Balance.","type":"integer"},"beginning_period_value":{"description":"The beginning value of on the as_of_date. This is equal to the ending_period_value on the prior_as_of_date","type":"number","format":"float"},"ending_period_value":{"description":"The ending value on the as_of_date","type":"number","format":"float"},"abs_cash_currency_contribution":{"description":"Total value of cash deposits","type":"number","format":"float"},"abs_cash_currency_withdrawal":{"description":"Total value of cash withdrawals","type":"number","format":"float"},"abs_security_contribution":{"description":"Total value of security deposits","type":"number","format":"float"},"abs_security_withdrawal":{"description":"Total value of security withdrawals","type":"number","format":"float"},"abs_income":{"description":"Total value of performance affecting income (e.g. dividends, interest)","type":"number","format":"float"},"abs_expense":{"description":"Total value of performance affecting expenses (e.g. ADR fees)","type":"number","format":"float"},"abs_non_performance_income":{"description":"Total value of non-performance affecting income (e.g. return of principle)","type":"number","format":"float"},"abs_non_performance_expense":{"description":"Total value of non-performance affecting expenses (e.g. tax withholding)","type":"number","format":"float"},"total_fee":{"description":"Total value of management fees","type":"number","format":"float"},"percentage_period_net_return":{"description":"Daily, net time weighted return","type":"number","format":"float"},"percentage_period_gross_return":{"description":"Daily, gross time weighted return","type":"number","format":"float"},"cash_currency_impact":{"description":"Change in cash on as_of_date from all sources (e.g. income, trade activity)","type":"number","format":"float"},"cash_value":{"description":"Value of cash on as_of_date","type":"number","format":"float"},"security_holdings_value":{"description":"Market value of securities on as_of_date","type":"number","format":"float"},"unrealized_gain_loss":{"description":"Value of gain or loss on as_of_date for open positions (calculated as market value of all positions minus cost basis of all positions)","type":"number","format":"float"},"realized_gain_loss":{"description":"Value of gain or loss from closing transactions","type":"number","format":"float"},"cash_currency_net_contribution":{"description":"Net cash contribution (i.e. Cash Deposits minus Cash Withdrawals)","type":"number","format":"float"},"security_net_contribution":{"description":"Net security contributions (i.e. Security Deposits minus Security Withdrawals)","type":"number","format":"float"},"value":{"type":"number","format":"float"},"abs_outside_income":{"description":"Total value of outside income","type":"number","format":"float"},"abs_outside_expense":{"description":"Total value of outside expense","type":"number","format":"float"},"abs_initialization_contribution":{"description":"Total value of initialized contribution","type":"number","format":"float"},"abs_initialization_withdrawal":{"description":"Total value of initialized withdrawal","type":"number","format":"float"},"manual_holding_appreciation":{"description":"Maunual holding apreciation amount","type":"number","format":"float"}}},"HouseholdBalances":{"type":"array","items":{"$ref":"#/components/schemas/HouseholdBalance"}},"BuySell":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the Transaction","type":"integer"},"account_id":{"description":"The id of the Account associated with this Transaction","type":"integer"},"security_id":{"description":"The id of the Security associated with this Transaction","type":"integer"},"type":{"description":"The type of transaction. Possible values, BTO - buy to open, BTC - buy to close, STO - sell to open, STC - sell to close","type":"string","enum":["BTO","BTC","STO","STC"]},"reported_date":{"description":"The date the custodian reports the transaction","type":"string","format":"date-time"},"transaction_date":{"description":"The date of the transaction on a trade basis","type":"string","format":"date-time"},"abs_units":{"description":"The quantity of shares for the Transaction","type":"number","format":"float"},"abs_amount":{"description":"The dollar amount associated with the Transaction","type":"number","format":"float"},"transaction_fee":{"description":"Fees associated with the Transaction (e.g. commission)","type":"number","format":"float"},"is_cancel":{"description":"Flag to indicate if this Transaction is a cancel from the custodian","type":"boolean"},"recon_id":{"type":"integer","deprecated":true,"nullable":true},"description":{"description":"Description of the transaction from the custodian","type":"string"},"meta_data":{"description":"Raw Meta Data passed through from the custodian","type":"object","deprecated":true},"custodian":{"title":"Financial institution data source","description":"Custodian the account data comes from. TDA=TD Ameritrade (Available prior to Sept. 2, 2023), SWB=Schwab, NFS=Fidelity, PER=Pershing, MLT=MillenniumTrust, HDG=Manual","type":"string","enum":["TDA (Available prior to Sept. 2, 2023)","SWB","NFS","PER","DST","MLT","HDG"]},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"},"partition_id":{"type":"integer","deprecated":true,"nullable":true}}},"BuySells":{"type":"array","items":{"$ref":"#/components/schemas/BuySell"}},"GainLoss":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the Transaction","type":"integer"},"account_id":{"description":"The id of the Account associated with this Transaction","type":"integer"},"open_date":{"description":"The date the corresponding lot was opened. Note that this field may be populated with the special date value \"1900-01-01\" which is to be understood as the absence of cost basis information for the corresponding closing fill","type":"string","format":"date-time"},"close_date":{"description":"The date the closing fill was posted","type":"string","format":"date-time"},"security_id":{"description":"The id of the Security associated with this Transaction","type":"integer"},"direction":{"description":"Flag meant to indicate if the lot is long or short. Potential values L=Long, S=Short","type":"string","enum":["L","S"]},"short_term":{"description":"Indicates whether the gain loss is short term (less than a year)","type":"boolean"},"long_term":{"description":"Indicates whether the gain loss is long term (more than a year)","type":"boolean"},"abs_open_units":{"description":"The total quantity of open shares prior to the transaction (e.g. 400 shares originally, 200 shares sold)","type":"number","format":"float"},"abs_closed_units":{"description":"The total quantity of closed shares of the transaction","type":"number","format":"float"},"open_value":{"description":"The cost basis of the open shares (in example above, the cost basis for the 400 shares)","type":"number","format":"float"},"close_value":{"description":"The cost basis of the closed shares","type":"number","format":"float"},"amount":{"description":"The dollar amount associated with the transaction (e.g. sale amount to close a long position, purchase amount to close a short position)","type":"number","format":"float"},"is_cancel":{"description":"Flag to indicate if this transaction is a cancel at the custodian","type":"boolean"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"GainLosses":{"type":"array","items":{"$ref":"#/components/schemas/GainLoss"}},"AccountHistoricalBalance":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Historical Balance object","type":"integer"},"as_of_date":{"description":"The current date for this Historical Balance","type":"string","format":"date-time"},"prior_as_of_date":{"description":"The most recent date before the as_of_date","type":"string","format":"date-time"},"account_id":{"description":"The id of the Account associated with this Historical Balance","type":"integer"},"household_id":{"description":"The id of the Household associated with this Historical Balance","type":"integer"},"beginning_period_value":{"description":"The beginning value of on the as_of_date. This is equal to the ending_period_value on the prior_as_of_date","type":"number","format":"float"},"ending_period_value":{"description":"The ending value on the as_of_date","type":"number","format":"float"},"abs_cash_currency_contribution":{"description":"Total value of cash deposits","type":"number","format":"float"},"abs_cash_currency_withdrawal":{"description":"Total value of cash withdrawals","type":"number","format":"float"},"abs_security_contribution":{"description":"Total value of security deposits","type":"number","format":"float"},"abs_security_withdrawal":{"description":"Total value of security withdrawals","type":"number","format":"float"},"abs_income":{"description":"Total value of performance affecting income (e.g. dividends, interest)","type":"number","format":"float"},"abs_expense":{"description":"Total value of performance affecting expenses (e.g. ADR fees)","type":"number","format":"float"},"abs_non_performance_income":{"description":"Total value of non-performance affecting income (e.g. return of principle)","type":"number","format":"float"},"abs_non_performance_expense":{"description":"Total value of non-performance affecting expenses (e.g. tax withholding)","type":"number","format":"float"},"total_fee":{"description":"Total value of management fees","type":"number","format":"float"},"percentage_period_net_return":{"description":"Net return for period (note can be monthly, daily - depends on what data is provided)","type":"number","format":"float"},"percentage_period_gross_return":{"description":"Gross return for period (note can be monthly, daily - depends on what data is provided)","type":"number","format":"float"},"total_contribution":{"description":"Total cash and security contributions","type":"number","format":"float"},"total_withdrawal":{"description":"Total cash and security withdrawals","type":"number","format":"float"},"custodian":{"title":"Financial institution data source","description":"Custodian the account data comes from TDA=TD Ameritrade (Available prior to Sept. 2, 2023), SWB=Schwab, NFS=Fidelity, PER=Pershing, MLT=MillenniumTrust, HDG=Manual","type":"string","enum":["TDA","SWB","NFS","PER","DST","MLT","HDG"]},"account_number":{"description":"Account number at the custodian","type":"string"},"frequency":{"title":"Frequency","description":"Frequency of return provided (e.g. M for monthly)","type":"string","enum":["D","W","M","Q","Y"]},"contribution_period_weight":{"description":"Used to represent timing of cash flow in a month. Potential values 1 = end of month, 0.5 = mid-month, 0 = beginning of month","type":"number","format":"float","enum":[1,0.5,0]},"withdrawal_period_weight":{"description":"Used to represent timing of cash flow in a month. Potential values 1 = end of month, 0.5 = mid-month, 0 = beginning of month","type":"number","format":"float","enum":[1,0.5,0]},"npni_period_weight":{"description":"Used to represent timing of cash flow in a month. Potential values 1 = end of month, 0.5 = mid-month, 0 = beginning of month","type":"number","format":"float","enum":[1,0.5,0]},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"AccountHistoricalBalances":{"type":"array","items":{"$ref":"#/components/schemas/AccountHistoricalBalance"}},"HouseholdHistoricalBalance":{"type":"object","properties":{"as_of_date":{"description":"The current date for this Historical Balance","type":"string","format":"date-time"},"prior_as_of_date":{"description":"The most recent date before the as_of_date","type":"string","format":"date-time"},"household_id":{"description":"The id of the Household associated with this Historical Balance","type":"integer"},"beginning_period_value":{"description":"The beginning value of on the as_of_date. This is equal to the ending_period_value on the prior_as_of_date","type":"number","format":"float"},"ending_period_value":{"description":"The ending value on the as_of_date","type":"number","format":"float"},"abs_cash_currency_contribution":{"description":"Total value of cash deposits","type":"number","format":"float"},"abs_cash_currency_withdrawal":{"description":"Total value of cash withdrawals","type":"number","format":"float"},"abs_security_contribution":{"description":"Total value of security deposits","type":"number","format":"float"},"abs_security_withdrawal":{"description":"Total value of security withdrawals","type":"number","format":"float"},"abs_income":{"description":"Total value of performance affecting income (e.g. dividends, interest)","type":"number","format":"float"},"abs_expense":{"description":"Total value of performance affecting expenses (e.g. ADR fees)","type":"number","format":"float"},"abs_non_performance_income":{"description":"Total value of non-performance affecting income (e.g. return of principle)","type":"number","format":"float"},"abs_non_performance_expense":{"description":"Total value of non-performance affecting expenses (e.g. tax withholding)","type":"number","format":"float"},"total_fee":{"description":"Total value of management fees","type":"number","format":"float"},"percentage_period_net_return":{"description":"Net return for period (note can be monthly, daily - depends on what data is provided)","type":"number","format":"float"},"percentage_period_gross_return":{"description":"Gross return for period (note can be monthly, daily - depends on what data is provided)","type":"number","format":"float"},"total_contribution":{"description":"Total cash and security contributions","type":"number","format":"float"},"total_withdrawal":{"description":"Total cash and security withdrawals","type":"number","format":"float"},"custodian":{"title":"Financial institution data source","description":"Custodian the account data comes from TDA=TD Ameritrade (Available prior to Sept. 2, 2023), SWB=Schwab, NFS=Fidelity, PER=Pershing, MLT=MillenniumTrust, HDG=Manual","type":"string","enum":["TDA","SWB","NFS","PER","DST","MLT","HDG"]},"account_number":{"description":"Account number at the custodian","type":"string"},"frequency":{"title":"Frequency","description":"Frequency of return provided (e.g. M for monthly)","type":"string","enum":["D","W","M","Q","Y"]},"contribution_period_weight":{"description":"Used to represent timing of cash flow in a month. Potential values 1 = end of month, 0.5 = mid-month, 0 = beginning of month","type":"number","format":"float","enum":[1,0.5,0]},"withdrawal_period_weight":{"description":"Used to represent timing of cash flow in a month. Potential values 1 = end of month, 0.5 = mid-month, 0 = beginning of month","type":"number","format":"float","enum":[1,0.5,0]},"npni_period_weight":{"description":"Used to represent timing of cash flow in a month. Potential values 1 = end of month, 0.5 = mid-month, 0 = beginning of month","type":"number","format":"float","enum":[1,0.5,0]}}},"HouseholdHistoricalBalances":{"type":"array","items":{"$ref":"#/components/schemas/HouseholdHistoricalBalance"}},"AccountHolding":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Holdings object","type":"integer"},"as_of_date":{"description":"The current date for this Holding","type":"string","format":"date-time"},"security_id":{"description":"The id of the Security associated with this Holding","type":"integer"},"account_id":{"description":"The id of the Account associated with this Holding","type":"integer"},"household_id":{"description":"The id of the Household associated with this Holding","type":"integer"},"direction":{"description":"Flag to indicate if Holding is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"first_open_date":{"description":"The original open date for the holding - this represents the earliest cost basis date available at the custodian. Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for at least one of the component positions in this holding","type":"string","format":"date-time"},"first_origination_date":{"description":"The earliest origination date for the holding - this represents the earliest cost basis date available at the custodian in all time even for shares originated outside the account. Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for at least one of the component positions in this holding","type":"string","format":"date-time"},"latest_open_date":{"description":"The most recent date for opening lots (e.g. last time more shares were purchased). Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for all of the component positions in this holding","type":"string","format":"date-time"},"abs_units":{"description":"Quantity of shares for the holding - combine with direction to know if the position is long or short","type":"number","format":"float"},"appraised_unit_price":{"description":"Market price of security on as_of_date","type":"number","format":"float"},"abs_beginning_value":{"description":"Cost basis of the units","type":"number","format":"float"},"realized_gain_loss":{"description":"Aggregates from Gain Loss end point; dollar gain or loss from trade activity","type":"number","format":"float"},"cost_basis_known":{"description":"Is the cost basis known for this holding?","type":"boolean"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"AccountHoldings":{"type":"array","items":{"$ref":"#/components/schemas/AccountHolding"}},"HouseholdHolding":{"type":"object","properties":{"as_of_date":{"description":"The current date for this Holding","type":"string","format":"date-time"},"security_id":{"description":"The id of the Security associated with this Holding","type":"integer"},"household_id":{"description":"The id of the Household associated with this Holding","type":"integer"},"direction":{"description":"Flag to indicate if Holding is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"first_open_date":{"description":"The original open date for the holding - this represents the earliest cost basis date available at the custodian. Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for at least one of the component positions in this holding","type":"string","format":"date-time"},"first_origination_date":{"description":"The earliest origination date for the holding - this represents the earliest cost basis date available at the custodian in all time even for shares originated outside the account. Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for at least one of the component positions in this holding","type":"string","format":"date-time"},"latest_open_date":{"description":"The most recent date for opening lots (e.g. last time more shares were purchased). Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for all of the component positions in this holding","type":"string","format":"date-time"},"abs_units":{"description":"Quantity of shares for the holding - combine with direction to know if the position is long or short","type":"number","format":"float"},"appraised_unit_price":{"description":"Market price of security on as_of_date","type":"number","format":"float"},"abs_beginning_value":{"description":"Cost basis of the units","type":"number","format":"float"},"realized_gain_loss":{"description":"Aggregates from Gain Loss end point; dollar gain or loss from trade activity","type":"number","format":"float"},"cost_basis_known":{"description":"Is the cost basis known for this holding?","type":"boolean"}}},"HouseholdHoldings":{"type":"array","items":{"$ref":"#/components/schemas/HouseholdHolding"}},"Position":{"type":"object","properties":{"id":{"description":"The unique resource id for this Position","type":"integer"},"as_of_date":{"description":"The current date for this Position","type":"string","format":"date-time"},"open_date":{"description":"The date this position was opened in the account.Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for the lot associated with this position","type":"string","format":"date-time"},"origination_date":{"description":"The date that this position originated in all time. For example, a position transferred in would have an origination_date of the date that the position was first opened in whichever account it was opened. Note that this field may be populated with the special date value \"\"1900-01-01\"\" which is to be understood as the absence of cost basis information for the lot associated with this position","type":"string","format":"date-time"},"security_id":{"description":"The id of the Security associated with this Position","type":"integer"},"lot_id":{"description":"The id of the lot associated with this Position","type":"integer"},"security_ledger_id":{"description":"The id of the security ledger associated with this Position","type":"integer"},"account_id":{"description":"The id of the Account associated with this Position","type":"integer"},"direction":{"description":"Flag to indicate if Holding is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"abs_open_units":{"description":"Quantity of shares for the Position","type":"number","format":"float"},"cost_basis_unit_price":{"description":"Unit cost price for the position (i.e. tax lot)","type":"number","format":"float"},"appraised_unit_price":{"description":"Market price of the security on the as_of_date","type":"number","format":"float"},"realized_gain_loss":{"description":"Dollar gain or loss from trade activity for this security on the as_of_date","type":"number","format":"float"},"abs_closed_units":{"description":"Quantity of shares closed","type":"number","format":"float"},"cost_basis_known":{"description":"Is the cost basis known for this position?","type":"boolean"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Positions":{"type":"array","items":{"$ref":"#/components/schemas/Position"}},"AccountSecurityBalance":{"type":"object","properties":{"id":{"description":"The unique resource ID for this Security Balance object","type":"integer"},"as_of_date":{"description":"The current date for this Security Balance","type":"string","format":"date-time"},"account_id":{"description":"The id of the Account associated with this Security Balance","type":"integer"},"household_id":{"description":"The id of the Household associated with this Security Balance","type":"integer"},"security_id":{"description":"The id of the Security associated with this Security Balance","type":"integer"},"units":{"description":"The number of shares","type":"number","format":"float"},"realized_gl":{"description":"Aggregates from Gain Loss end point; dollar gain or loss from trade activity","type":"number","format":"float"},"abs_income":{"description":"Aggregates from Income Expense end point; value of performance affecting income such as dividends","type":"number","format":"float"},"abs_expense":{"description":"Aggregates from Income Expense end point; value of performance affecting expenses such as ADR fees","type":"number","format":"float"},"appraised_unit_price":{"description":"The market price of the security on the as_of_date","type":"number","format":"float"},"appraised_value":{"description":"Market value of the security on the as_of_date (calculated as units * appraised_unit_price)","type":"number","format":"float"},"beginning_value":{"description":"Cost basis of the units","type":"number","format":"float"},"holding_period_return":{"description":"Security level return on the as_of_date","type":"number","format":"float"},"transfer_out_unrealized_gain_loss":{"description":"Unrealized gain loss that has transfered out","type":"number"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"AccountSecurityBalances":{"type":"array","items":{"$ref":"#/components/schemas/AccountSecurityBalance"}},"HouseholdSecurityBalance":{"type":"object","properties":{"as_of_date":{"description":"The current date for this Security Balance","type":"string","format":"date-time"},"household_id":{"description":"The id of the Household associated with this Security Balance","type":"integer"},"security_id":{"description":"The id of the Security associated with this Security Balance","type":"integer"},"units":{"description":"The number of shares","type":"number","format":"float"},"realized_gl":{"description":"Aggregates from Gain Loss end point; dollar gain or loss from trade activity","type":"number","format":"float"},"abs_income":{"description":"Aggregates from Income Expense end point; value of performance affecting income such as dividends","type":"number","format":"float"},"abs_expense":{"description":"Aggregates from Income Expense end point; value of performance affecting expenses such as ADR fees","type":"number","format":"float"},"appraised_unit_price":{"description":"The market price of the security on the as_of_date","type":"number","format":"float"},"appraised_value":{"description":"Market value of the security on the as_of_date (calculated as units * appraised_unit_price)","type":"number","format":"float"},"beginning_value":{"description":"Cost basis of the units","type":"number","format":"float"},"holding_period_return":{"description":"Security level return on the as_of_date","type":"number","format":"float"},"transfer_out_unrealized_gain_loss":{"description":"Unrealized gain loss that has transfered out","type":"number"}}},"HouseholdSecurityBalances":{"type":"array","items":{"$ref":"#/components/schemas/HouseholdSecurityBalance"}},"Transfer":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the Transaction","type":"integer"},"account_id":{"description":"The id of the Account associated with this Transaction","type":"integer"},"security_id":{"description":"The id of the Security associated with this Transaction","type":"integer"},"type":{"description":"The type of Transfer. Possible values, DEP - cash deposit, WITH - cash withdrawal, TLO - transfer long to open - security transfers into an account, TLC - transfer long to close - security transfers out of an account","type":"string","enum":["DEP","WITH","TLO","TLC"]},"reported_date":{"description":"The date the custodian reports the transaction","type":"string","format":"date-time"},"transaction_date":{"description":"The date of the transaction on a trade basis","type":"string","format":"date-time"},"abs_units":{"description":"The quantity of shares for the Transfer","type":"number","format":"float"},"unit_price":{"description":"he closing market price of the security on the transaction_date. Note, for cash, this is always 1","type":"number","format":"float"},"cost_basis_unit_price":{"description":"The unit cost price for shares being transferred","type":"number","format":"float"},"transaction_fee":{"description":"Fees associated with the Transaction (e.g. commission)","type":"number","format":"float"},"is_cancel":{"description":"Flag to indicate if this Transaction is a cancel from the custodian","type":"boolean"},"recon_id":{"type":"integer","deprecated":true,"nullable":true},"description":{"description":"Description of the transaction from the custodian","type":"string"},"meta_data":{"description":"Raw Meta Data passed through from the custodian","type":"object","deprecated":true},"custodian":{"description":"Custodian the account data comes from. TDA=TD Ameritrade (Available prior to Sept. 2, 2023), SWB=Schwab, NFS=Fidelity, PER=Pershing, MLT=MillenniumTrust, HDG=Manual","type":"string","enum":["TDA (Available prior to Sept. 2, 2023)","SWB","NFS","PER","DST","MLT","HDG"]},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"},"origination_date":{"description":"Date when the transaction was originated","type":"string","format":"date-time","nullable":true},"cost_basis_known":{"description":"Is the cost basis known for this transaction?","type":"boolean"},"replaced_transfer_id":{"description":"The id of the replaced transfer associated with this transaction","type":"integer","nullable":true},"partition_id":{"type":"integer","deprecated":true,"nullable":true}}},"Transfers":{"type":"array","items":{"$ref":"#/components/schemas/Transfer"}},"SourceLot":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the lot","type":"integer"},"account_id":{"description":"The id of the Account associated with this lot","type":"integer"},"security_id":{"description":"The id of the Security associated with this lot","type":"integer"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"source":{"title":"Financial institution data source","description":"Custodian or source the lot data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this lot","type":"string"},"feed_code":{"description":"The feed code of the Account associated with this lot","type":"string"},"reported_date":{"description":"The date the custodian reports the lot","type":"string","format":"date-time"},"lot_identifier":{"description":"The custodian reported lot identifier if applicable","type":"string"},"abs_current_units":{"description":"The quantity of shares for the reported lot","type":"number","format":"float"},"abs_current_value":{"description":"The market value of the shares for the reported lot using the source-provided price","type":"number","format":"float"},"abs_current_value_unit_price":{"description":"Prevailing price per unit of the security, as determined by the source provider","type":"number","format":"float"},"abs_current_value_reported":{"description":"Current market value as reported directly from source lots","type":"number","format":"float"},"abs_current_value_unit_price_reported":{"description":"Price as reported directly from source lots","type":"number","format":"float"},"abs_cost_basis":{"description":"The total cost of the shares for the reported lot","type":"number","format":"float"},"abs_adjusted_cost_basis":{"description":"The total adjusted cost of the shares for the reported lot","type":"number","format":"float"},"unrealized_gain_loss":{"description":"Difference between abs_current_value and abs_cost_basis. If either is null, this field will be null, but treated as zero for aggregating unrealized gain/loss","type":"number","format":"float"},"unrealized_gain_loss_reported":{"description":"The current unrealized gains for the lot if reported","type":"number","format":"float"},"realized_gain_loss_reported":{"description":"Realized gain/loss for partially closed lots as reported by the data source, or null if not provided","type":"number","format":"float"},"original_open_date":{"description":"The date that the corresponding lot was initially opened (even outside of the current account) if reported","type":"string","format":"date-time"},"abs_original_open_units":{"description":"The original quantity of shares which opened the corresponding lot, if reported","type":"number","format":"float"},"direction":{"description":"Flag to indicate if lot is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"cost_basis_fully_known":{"description":"True if the cost basis for this lot is fully known","type":"boolean"},"cost_basis_fully_known_reported":{"description":"Source-provided determination of whether cost basis is known. Null if the source doesn't provide such indications of completed cost basis information","type":"boolean"},"wash_sale":{"description":"True if the lot is affected by a wash sale","type":"boolean"},"disallowed_loss_amount":{"description":"Lost amount that cannot be used for tax offset, if the lot is part of a wash sale violation","type":"number","format":"float"},"certified":{"description":"True if the cost basis is certified","type":"boolean"},"lot_selection_method":{"description":"The lot selection method of the lot if reported by the source","type":"string"},"original_data":{"description":"The raw data exactly as reported by the source with original field names","type":"object","deprecated":true},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}},"SourceLots":{"type":"array","items":{"$ref":"#/components/schemas/SourceLot"}},"SourcePosition":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the position","type":"integer"},"account_id":{"description":"The id of the Account associated with this Position","type":"integer"},"security_id":{"description":"The id of the Security associated with this Position","type":"integer"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"source":{"title":"Financial institution data source","description":"Custodian or source the position data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this Position","type":"string"},"feed_code":{"description":"The feed code of the Account associated with this Position","type":"string"},"reported_date":{"description":"The date the custodian reports the position","type":"string","format":"date-time"},"first_open_date":{"description":"The minimum open date among all lots with known open date","type":"string","format":"date-time"},"direction":{"description":"Flag to indicate if position is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"abs_units":{"description":"The quantity of shares for the reported position","type":"number","format":"float"},"abs_settled_units":{"description":"The quantity of settled shares for the reported position","type":"number","format":"float"},"abs_value":{"description":"The market value using source-provided prices on the reported date","type":"number","format":"float"},"abs_value_lt":{"description":"The portion of the market value that is known to belong to a long-term lot","type":"number","format":"float"},"abs_value_st":{"description":"The portion of the market value that is known to belong to a long-term lot","type":"number","format":"float"},"abs_value_reported":{"description":"The current market value as reported directly from the source","type":"number","format":"float"},"abs_value_unit_price_reported":{"description":"The price as reported on source positions","type":"number","format":"float"},"abs_value_unit_price":{"description":"Price per unit (qty) using source-provided market prices of the security","type":"number","format":"float"},"abs_cost_basis":{"description":"The total cost basis value of the position as aggregated from reported open lots","type":"number","format":"float"},"abs_cost_basis_lt":{"description":"The sum of the cost basis among open lots with fully known cost basis that were originated over 365 days ago","type":"number","format":"float"},"abs_cost_basis_st":{"description":"The sum of the cost basis among open lots with fully known cost basis that were originated over within the last year","type":"number","format":"float"},"cost_basis_fully_known":{"description":"True if the cost basis for all shares in this positions are fully known","type":"boolean"},"unrealized_gain_loss_reported":{"description":"The unrealized gains or losses of the position if reported by the source","type":"number","format":"float"},"unrealized_gain_loss_lt_reported":{"description":"The portion of unrealized gain/loss known to be a long-term holding if reported by the source","type":"number","format":"float"},"unrealized_gain_loss_st_reported":{"description":"The portion of unrealized gain/loss known to be a short-term holding if reported by the source","type":"number","format":"float"},"unrealized_gain_loss":{"description":"The unrealized gains or losses of the position as calculated by comparing current market value to aggregated cost basis","type":"number","format":"float"},"unrealized_gain_loss_lt":{"description":"The portion of unrealized gain/loss known to be a long-term holding.","type":"number","format":"float"},"unrealized_gain_loss_st":{"description":"The portion of unrealized gain/loss known to be a short-term holding.","type":"number","format":"float"},"open_lots":{"description":"Total number of open lots reported by the source","type":"integer"},"open_lots_with_cost_basis":{"description":"Total number of open lots reported by the source with fully known cost basis","type":"integer"},"open_lots_lt":{"description":"Total number of long-term open lots reported by the source","type":"integer"},"open_lots_with_cost_basis_lt":{"description":"Total number of long-term open lots reported by the source with fully known cost basis","type":"integer"},"open_lots_st":{"description":"Total number of short-term open lots reported by the source","type":"integer"},"open_lots_with_cost_basis_st":{"description":"Total number of short-term open lots reported by the source with fully known cost basis","type":"integer"},"open_units":{"description":"Total number of open units reported by the source","type":"number","format":"float"},"open_units_with_cost_basis":{"description":"Total number of open units reported by the source with fully known cost basis","type":"number","format":"float"},"open_units_lt":{"description":"Total number of long-term open units reported by the source","type":"number","format":"float"},"open_units_with_cost_basis_lt":{"description":"Total number of long-term open units reported by the source with fully known cost basis","type":"number","format":"float"},"open_units_st":{"description":"Total number of short-term open units reported by the source","type":"number","format":"float"},"open_units_with_cost_basis_st":{"description":"Total number of short-term open units reported by the source with fully known cost basis","type":"number","format":"float"},"original_data":{"description":"The raw data exactly as reported by the source with original field names","type":"object","deprecated":true},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}},"SourcePositions":{"type":"array","items":{"$ref":"#/components/schemas/SourcePosition"}},"SourceRealizedGainLoss":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the realized gain loss","type":"integer"},"account_id":{"description":"The id of the Account associated with this Realized gain loss","type":"integer"},"security_id":{"description":"The id of the Security associated with this Realized gain loss","type":"integer"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"source":{"title":"Financial institution data source","description":"Custodian or source the realized gain loss data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial ServicesAPX=Apex Fintech Solutions, DST=DST Systems, FPR=Fidelity 401k, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this Realized gain loss","type":"string"},"feed_code":{"description":"The feed code of the Account associated with this Realized gain loss","type":"string"},"reported_date":{"description":"The date the custodian reports the realized gain loss","type":"string","format":"date-time"},"direction":{"description":"Flag to indicate if lot is Long or Short. Potential values, L = Long, S = Short","type":"string","enum":["L","S"]},"abs_closed_units":{"description":"The quantity of closed units","type":"number","format":"float"},"abs_closed_value":{"description":"The value of the closed units","type":"number","format":"float"},"close_date":{"description":"The date that the corresponding closed units were closed","type":"string","format":"date-time"},"settle_date":{"description":"The date that the corresponding closed units were settled","type":"string","format":"date-time"},"abs_opened_units":{"description":"The quantity of originally opened units for the corresponding lot","type":"number","format":"float"},"abs_opened_value":{"description":"The value of the originally opened units","type":"number","format":"float"},"open_date":{"description":"The date that the units were originally opened","type":"string","format":"date-time"},"amount":{"description":"The gain or loss from the closed units","type":"number","format":"float"},"amount_st":{"description":"The short term gain or loss from the closed units","type":"number","format":"float"},"amount_lt":{"description":"The long term gain or loss from the closed units","type":"number","format":"float"},"lot_identifier":{"description":"The lot identifier closed if reported by the source","type":"string"},"lot_selection_method":{"description":"The lot selection method of the lot if reported by the source","type":"string"},"original_data":{"description":"The raw data exactly as reported by the source with original field names","type":"object","deprecated":true},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}},"SourceRealizedGainLosses":{"type":"array","items":{"$ref":"#/components/schemas/SourceRealizedGainLoss"}},"SourceAccountBalance":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the account balance","type":"integer"},"account_id":{"description":"The id of the Account associated with this account balance","type":"integer"},"source":{"title":"Financial institution data source","description":"Custodian or source the account balance data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, TDA=TD Ameritrade (Available prior to Sept. 2, 2023), EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","TDA (Available prior to Sept. 2, 2023)","EGB","MLT","TIA"]},"account_number":{"description":"The account number of the Account associated with this account balance","type":"string"},"feed_code":{"description":"The feed code of the Account associated with this account balance","type":"string"},"reported_date":{"description":"The date the source reports the account balance","type":"string","format":"date-time"},"cash_value_reported":{"description":"The cash value as reported by the source","type":"number","format":"float"},"cash_value":{"description":"The cash value as aggregated by source positions","type":"number","format":"float"},"securities_value_reported":{"description":"The securities value as reported by the source","type":"number","format":"float"},"securities_value":{"description":"The securities value as aggregated by source positions","type":"number","format":"float"},"total_value_reported":{"description":"The total cash and security value as reported by the source","type":"number","format":"float"},"total_value":{"description":"The total cash and security value as aggregated by source positions","type":"number","format":"float"},"unrealized_gain_loss_lt":{"description":"The total unrealized gain/loss as aggregated by source lots known to be long-term lots","type":"number","format":"float"},"unrealized_gain_loss_st":{"description":"The total unrealized gain/loss as aggregated by source lots known to be short-term lots","type":"number","format":"float"},"unrealized_gain_loss_lt_reported":{"description":"The total unrealized gain/loss as aggregated from reported unrealized gain losses on source lots known to be long-term lots","type":"number","format":"float"},"unrealized_gain_loss_st_reported":{"description":"The total unrealized gain/loss as aggregated from reported unrealized gain losses on source lots known to be short-term lots","type":"number","format":"float"},"total_unrealized_gain_loss":{"description":"The total unrealized gain/loss as aggregated by source lots","type":"number","format":"float"},"total_unrealized_gain_loss_reported":{"description":"The total unrealized gain/loss as aggregated from reported unrealized gain losses on source lots","type":"number","format":"float"},"abs_cash_contribution":{"description":"The value of transfers in of cash and cash equivalents (i.e., money market assets) on the reported date","type":"number","format":"float"},"abs_cash_withdrawal":{"description":"The value of transfers out of cash and cash equivalents on the reported date","type":"number","format":"float"},"abs_security_contribution":{"description":"The value of transfers in of securities on the reported date","type":"number","format":"float"},"abs_security_withdrawal":{"description":"The value of transfers out of securities on the reported date","type":"number","format":"float"},"total_abs_contribution":{"description":"The total value of cash and security contributions on the reported date","type":"number","format":"float"},"total_abs_withdrawal":{"description":"The total value of cash and security withdrawals on the reported date","type":"number","format":"float"},"total_net_contribution":{"description":"Total net contributions made to the account on the reported date","type":"number","format":"float"},"abs_income":{"description":"The total income from held securities on the reported date","type":"number","format":"float"},"abs_expense":{"description":"The total expenses from held securities on the reported date","type":"number","format":"float"},"net_income":{"description":"The total net income from held securities on the reported date","type":"number","format":"float"},"abs_non_performing_income":{"description":"The total income exempt from performance impact on the reported date","type":"number","format":"float"},"abs_non_performing_expense":{"description":"The total expense exempt from performance impact on the reported date","type":"number","format":"float"},"net_non_performing_income":{"description":"The net income exempt from performance impact on the reported date","type":"number","format":"float"},"abs_management_fee":{"description":"The value of management fees applied to the account on the reported date","type":"number","format":"float"},"cost_basis_fully_known":{"description":"True only if all cost basis is fully known across all positions in the account","type":"boolean"},"original_data":{"description":"The raw data exactly as reported by the source with original field names","type":"object","deprecated":true},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}},"SourceAccountBalances":{"type":"array","items":{"$ref":"#/components/schemas/SourceAccountBalance"}},"SourceTransaction":{"type":"object","properties":{"id":{"title":"Id","description":"The unique resource id for the transaction","type":"integer"},"account_id":{"description":"The id of the Account associated with this Transaction","type":"integer"},"security_id":{"description":"The id of the Security associated with this Transaction","type":"integer"},"reported_date":{"description":"The date the custodian reports the transaction","type":"string","format":"date-time"},"source":{"title":"Financial institution data source","description":"Custodian or source the transaction data comes from. APX=Apex, AXO=Axos, EGB=Eaglebrook, FPR=Fidelity 401k, IBK=Interactive Brokers, MLT=MillenniumTrust, NFS=Fidelity, PER=Pershing, PTA=Pontera, SWB=Schwab, TDA=TD Ameritrade, TIA=Tiaa","type":"string","enum":["APX","AXO","DST","EGB","FPR","IBK","MLT","NFS","PER","PTA","SWB","TDA","TIA"]},"account_number":{"description":"The account number of the Account associated with this Transaction","type":"string"},"feed_code":{"description":"The feed code of the Account associated with this Transaction","type":"string"},"source_security_symbol":{"description":"The symbol of the corresponding security as reported by the source if applicable","type":"string"},"source_security_cusip":{"description":"The cusip of the corresponding security as reported by the source if applicable","type":"string"},"source_transaction_code":{"description":"The custodian reported transaction code for the transaction","type":"string"},"category":{"description":"BridgeFT transaction categorization. Used in conjunction with classification to classify transaction type. trd = Trade, xfr = Transfer, inc = Income/Expense, crp = Corporate Action, oth = Other","type":"string","enum":["trd","xfr","inc","crp","oth"]},"classification":{"description":"BridgeFT transaction categorization. Used in conjunction with classification to classify transaction type. bto = Buy to Open, stc = Sell to Close, btc = Buy to Close, sto = Sell to Open, dvr = Dividend Reinvestment, inc = Other Income, exp = Other Expense, div = Dividend, int = Interest, mfe = Management Fee, tax = Tax, dep = Deposit, wth = Withdrawal, rec = Shares Received, del = Shares Delivered, spl = Split, chg = Symbol Change, jnl = Journal, oth = Other","type":"string","enum":["bto","stc","btc","sto","dvr","inc","exp","div","int","mfe","tax","dep","wth","rec","del","spl","chg","jnl","oth"]},"transaction_date":{"description":"The date of the transaction. May be different from the reported date.","type":"string","format":"date-time"},"settle_date":{"description":"The date that the transaction settled if reported","type":"string","format":"date-time"},"trade_settle_ind":{"description":"Indicator to declare if the trade records provided by the custodian is coming from a trade date or settlement date based system of record. T = Trade Date Based, S = Settlement Date Based, and empty values are for non-trade activity or data is not provided by the custodian.","type":"string","enum":["T","S",""]},"accrued_interest":{"description":"Custodian provided accrued interest associated with a transaction.","type":"number","format":"float"},"corresponding_account_number":{"description":"The corresponding account number for the transaction, if available. For example, if account A receives a transfer of funds from account B, this field would display Account B's number, whereas the AccountNumber field would display Account A's number.","type":"string"},"units":{"description":"The signed quantity of shares for the reported transaction","type":"number","format":"float"},"amount":{"description":"The signed amount for the reported transaction","type":"number","format":"float"},"unit_price":{"description":"The unit price of the transaction if reported","type":"number","format":"float"},"fees":{"description":"Any fees for the transaction as reported by the custodian","type":"number","format":"float"},"is_cancel":{"description":"True if the transaction is canceled. Canceled transactions are often paired with a matching uncanceled transactions.","type":"boolean"},"description":{"description":"Extra description for the transaction","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"}}},"SourceTransactions":{"type":"array","items":{"$ref":"#/components/schemas/SourceTransaction"}},"Oauth":{"type":"object","properties":{"ExpiresIn":{"title":"Expires in","description":"The token expiry time","type":"integer"},"TokenType":{"title":"Token Type","description":"Type of the token generated. Example, Bearer","type":"string"},"IdToken":{"title":"Id Token","description":"The token id","type":"string"},"RefreshToken":{"title":"Refreshed Token","description":"The refreshed token id","type":"string"}}},"Client":{"type":"object","properties":{"id":{"title":"Object ID","description":"Unique ID for this client object","type":"integer"},"firm_id":{"title":"Firm ID","description":"ID of the owning firm","type":"integer","example":39},"user_id":{"title":"User ID","description":"ID of the user associated to this client object","type":"integer"},"prefix":{"title":"Prefix","description":"Name prefix of the client","type":"string"},"first_name":{"title":"First Name","description":"First name of the client","type":"string"},"last_name":{"title":"Last Name","description":"Last name of the client","type":"string"},"email":{"title":"Email","description":"Email of the client","type":"string"},"phone_number":{"title":"Phone number","description":"Phone number","type":"string"},"birth_date":{"title":"Birth date","description":"Date of birth","type":"string","format":"date-time"},"retirement_date":{"title":"Retirement date","description":"Date of retirement of the client","type":"string","format":"date-time"},"annual_income":{"title":"Annual income","description":"Annual income of the client","type":"number"},"address_1":{"title":"Client address","description":"First line address","type":"string"},"address_2":{"title":"Client address","description":"Second line address","type":"string"},"address_3":{"title":"Client address","description":"Third line address","type":"string"},"city":{"title":"Client city","description":"City of the client","type":"string"},"state":{"title":"Client state","description":"State of the client","type":"string"},"zip_code":{"title":"Client zip code","description":"Zip code of the client","type":"string"},"country":{"title":"Client country","description":"Country of the client","type":"string"},"relationship_type":{"title":"Relationship type","description":"Relationship of the client. A for active, I for indirect, P for potential, and F for former","type":"string","enum":["A","I","P","F"]},"notes":{"title":"Notes","description":"Notes","type":"string"},"client_tier":{"title":"Client tier","description":"Tier associated with the client","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Clients":{"type":"array","items":{"$ref":"#/components/schemas/Client"}},"Index":{"type":"object","properties":{"id":{"description":"The unique resource id of the Index.","type":"integer"},"internal_name":{"description":"Our internal name for the index.","type":"string"},"vendor_name":{"description":"Vendor's name of the index.","type":"string"},"cusip":{"description":"Cusip associated with the index","type":"string"},"symbol":{"description":"Symbol associated with the index","type":"string"},"issuer_cusip":{"description":"Issuer cusip associated with the index","type":"string"},"name":{"description":"Name for the index","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Indexes":{"type":"array","items":{"$ref":"#/components/schemas/Index"}},"Security":{"type":"object","properties":{"id":{"description":"The unique resource id for the Security","type":"integer"},"cusip":{"description":"A unique nine-character code for the security","type":"string"},"symbol":{"description":"The symbol used to represent the Security","type":"string"},"description":{"description":"The description of the Security","type":"string"},"master_asset_class":{"description":"Asset class associated with the security. EQ for Equity Asset Class, DT for Fixed Income Asset Class, CA for Cash Asset Class, CE for Cash Equivalent Asset Class, MX for Mixed Asset Class or Other Class, UC for Unclassified Asset Class, ETF for ETF Asset Class, CR for Crypto Asset Class, and empty string for Unknown Asset Class","type":"string","enum":["EQ","DT","CA","CE","MX","UC","ETF","CR"]},"broad_code":{"description":"The broad code of the Security","type":"string","deprecated":true},"sic_code":{"description":"The sic code of the security","type":"string"},"issue_type":{"description":"An internal mapping of the Security's issue code","type":"string"},"issue_type_code":{"description":"The Security's issue code","type":"integer"},"security_type":{"description":"The type of this Security. \"Alternative\" Includes structures products, MBS, CDO, etc. \"Option\" Includes options on equities and futures. \"Fund\" Includes a fund that is not a ETF of mutual fund.","type":"string","enum":["Stock","Bond","Cash","Cash Equivalent","ETF","Mutual Fund","Alternative","Option","Fund","Crypto","Unknown"]},"identifier":{"description":"The primary identifier for the Security","type":"string"},"prefixed_identifier":{"description":"The primary identifier for the Security with a prefix indicating the identifier type. S for Listed Symbol, C for Custodian","type":"string","enum":["S","C"]},"bond_rating":{"description":"Bond Rating of Bond provided by the custodian (currently only supported for Pershing Securities)","type":"string"},"maturity_date":{"description":"Maturity Date of Bond provided by the custodian (currently only supported for Pershing Securities)","type":"string","format":"date-time"},"expiration_date":{"description":"Expiration Date of Options, Rights and Warrants provided by the custodian  (currently only supported for Pershing Securities)","type":"string","format":"date-time"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Securities":{"type":"array","items":{"$ref":"#/components/schemas/Security"}},"ApiKey":{"type":"object","properties":{"id":{"description":"The unique resource id for the api key","type":"integer"},"description":{"description":"Description of the api key","type":"string"},"name":{"description":"Name for the api key","type":"string"},"key":{"description":"The key value","type":"string"},"user_id":{"description":"User id associated with the api key","type":"integer"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"ApiKeys":{"type":"array","items":{"$ref":"#/components/schemas/ApiKey"}},"ClientUser":{"type":"object","properties":{"id":{"description":"Unique ID for this user object","type":"integer"},"firm_id":{"description":"ID of the owning firm","type":"integer"},"account_access_level":{"description":"The user's accessibility level with respect to accounts; can either have access to all accounts or be limited to a subset of them. Can either be all or limited.","type":"string","enum":["all","limited"]},"accessible_household_ids":{"description":"If the user is limited to a subset of accounts, these are the accessible households","type":"array","items":{"type":"integer"}},"permissions":{"description":"Editable list of permissions assigned to the user. See Permissions Overview.","type":"array","items":{"type":"string"}},"is_owner":{"description":"Is this user the owner of the associated firm? (Always false for a client)","type":"boolean"},"end_client_household_id":{"description":"The household of the end client. All client users should have a reference to the household.","type":"integer"},"household_id":{"description":"Alias for end_client_household_id","type":"integer"},"role_id":{"description":"The ID of the user-defined role.","type":"integer"},"is_firm_user":{"description":"Is the user an employee of the managing firm? (No)","type":"boolean"},"is_client_user":{"description":"Is the user a client of the managing firm? (Yes)","type":"boolean"},"is_demo_user":{"description":"Is the user a demo user?","type":"boolean"},"is_verified":{"description":"Does the user have access to the account?","type":"boolean"},"verified_dt_utc":{"description":"Timestamp in UTC of when the user was verified.","type":"string","format":"date-time"},"role_name":{"description":"The role of the user. Can either be end_client for client users, or firm_user for firm users. In this case it should be end_client.","type":"string"},"first_name":{"description":"User first name","type":"string"},"last_name":{"description":"User last name","type":"string"},"full_name":{"description":"User full name","type":"string"},"email":{"description":"User email","type":"string"},"is_active":{"description":"Is the client user active?","type":"boolean"},"last_login":{"description":"Time when the client last logged in","type":"string","format":"date-time"},"date_joined":{"description":"Date when the client joined","type":"string","format":"date-time"},"usage_tier":{"description":"Usage teir associated with this user","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"ClientUsers":{"type":"array","items":{"$ref":"#/components/schemas/ClientUser"}},"FirmUser":{"type":"object","properties":{"id":{"description":"Unique ID for this user object","type":"integer"},"firm_id":{"description":"ID of the owning firm","type":"integer"},"account_access_level":{"description":"The user's accessibility level with respect to accounts; can either have access to all accounts or be limited to a subset of them. Can either be all or limited.","type":"string","enum":["all","limited"]},"accessible_household_ids":{"description":"If the user is limited to a subset of accounts, these are the accessible households","type":"array","items":{"type":"integer"}},"permissions":{"description":"Editable list of permissions assigned to the user. See Permissions Overview.","type":"array","items":{"type":"string"}},"granted_permissions":{"description":"Read-only list of permissions that govern the user's actual permissions, which are intersected with firm permissions. See Permissions Overview.","type":"array","items":{"type":"string"}},"is_owner":{"description":"Is this user the owner of the associated firm? (Always false for a client)","type":"boolean"},"end_client_household_id":{"description":"The household of the end client. All client users should have a reference to the household.","type":"integer"},"household_id":{"description":"Alias for end_client_household_id","type":"integer"},"role_id":{"description":"The ID of the user-defined role.","type":"integer"},"is_firm_user":{"description":"Is the user an employee of the managing firm? (No)","type":"boolean"},"is_client_user":{"description":"Is the user a client of the managing firm? (Yes)","type":"boolean"},"is_demo_user":{"description":"Is the user a demo user?","type":"boolean"},"is_verified":{"description":"Does the user have access to the account?","type":"boolean"},"verified_dt_utc":{"description":"Timestamp in UTC of when the user was verified.","type":"string","format":"date-time"},"role_name":{"description":"The role of the user. Can either be end_client for client users, or firm_user for firm users. In this case it should be end_client.","type":"string"},"first_name":{"description":"User first name","type":"string"},"last_name":{"description":"User last name","type":"string"},"full_name":{"description":"User full name","type":"string"},"email":{"description":"User email","type":"string"},"is_active":{"description":"Is the client user active?","type":"boolean"},"last_login":{"description":"Time when the client last logged in","type":"string","format":"date-time"},"date_joined":{"description":"Date when the client joined","type":"string","format":"date-time"},"usage_tier":{"description":"Usage teir associated with this user","type":"string"},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"FirmUsers":{"type":"array","items":{"$ref":"#/components/schemas/FirmUser"}},"Role":{"type":"object","properties":{"id":{"description":"Unique ID for this role object","type":"integer"},"firm_id":{"description":"ID of the owning firm","type":"integer"},"created_by_user_id":{"description":"The user profile id of the creator user","type":"integer"},"name":{"description":"Role name","type":"string"},"slug":{"description":"Slugified role name","type":"string"},"description":{"description":"Description of this user role","type":"string"},"permissions":{"description":"List of permission codes given by this role. See Permissions Overview.","type":"array","items":{"type":"string"}},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"}},"AccountSummary":{"type":"object","properties":{"source":{"title":"Financial institution data source","description":"Custodian or source the account balance data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","EGB","MLT","TIA"],"type":"object","properties":{"account_number":{"title":"Account Number","description":"The account number of the Account associated with this account balance","type":"object","properties":{"account_id":{"title":"Account Id","description":"The id of the Account associated with this account balance","type":"integer"},"source":{"title":"Financial Institution Data Source","description":"Custodian or source the account balance data comes from. APX=Apex Fintech Solutions, AXO=Axos Advisory Services, DST=DST Systems, FPR=Fidelity 401k/403b, IBK=Interactive Brokers, NFS=Fidelity Investments, PER=Pershing, PTA=Pontera, SWB=Charles Schwab, EGB=Eaglebrook, MLT=Millenium Trust, TIA=TIAA Financial Services","type":"string","enum":["APX","AXO","DST","FPR","IBK","NFS","PER","PTA","SWB","EGB","MLT","TIA"]},"status":{"title":"Account Status","description":"Status of the account. It can be funded, papered, closed or slate. Funded account is considered active account, Papered or Closed account is inactive, and Stale is unknown","type":"string","enum":["funded","papered","closed","stale"]},"first_quarantine_date":{"title":"First quarantine date","description":"Earliest date at which this account was quarantined for data reconciliation, or null if it's not currently quarantined","type":"string","format":"date"},"n_positions":{"title":"Number of Positions","description":"Number of positions associated with this account","type":"integer"},"n_lots":{"title":"Number of Lots","description":"Number of lots associated with this account","type":"integer"},"n_bals":{"title":"Number of Balances","description":"Number of balance associated with this account","type":"integer"},"reported_date":{"title":"Reported date","description":"Date when the source date (positions, lots, balances) are reported","type":"string","format":"date"}}}}}}},"TaxId":{"type":"string"},"TaxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"RoiRequest":{"type":"object","properties":{"id":{"title":"Object ID","description":"Unique ID for this roi request object","type":"integer","format":"int64"},"custodian":{"title":"Financial institution data source","description":"Custodian from which the accounts data originates. PER=Pershing, MLT=MillenniumTrust, IBK=InteractiveBrokers, EGB=Eaglebrook Advisors. If you don’t see certain custodians in this list, it indicates that those custodians do not accept ROI requests via emails. As a result, this API does not support such cases","type":"string","enum":["PER","MLT","IBK","EGB"]},"advisor_codes":{"title":"Advisor code","description":"The advisor code associated with this ROI request","type":"array","items":{"type":"string"}},"owner_name":{"title":"Owner name","description":"The representative person (such as the Advisor) on whose behalf you are requesting data feed authorization","type":"string"},"firm_name":{"title":"Firm Name","description":"BridgeFT Client Firm Name (this is your firm name), who sending an ROI request","type":"string"},"sender_name":{"title":"Sender Name","description":"BridgeFT Client representative who triggering this ROI request","type":"string"},"cc_emails":{"title":"CC Emails","description":"Any persons who should be involved in the ROI process and receive a copy of the ROI request. These could include Advisor’s team contacts","type":"array","items":{"type":"string"}},"reply_to_emails":{"title":"Reply To Emails","description":"Email addresses of the Advisor or Advisor’s representatives. These email addresses will automatically receive responses from the custodian when they use the “Reply To” function in their email inbox","type":"array","items":{"type":"string"}},"status":{"title":"Status","description":"Status to check if an email is in sent or failure state","type":"string","enum":["Sent","Error"]},"created_at_utc":{"description":"Timestamp for when the record was created","type":"string","format":"date-time"},"updated_at_utc":{"description":"Timestamp for when the record was updated","type":"string","format":"date-time"}}},"Error":{"type":"object","required":["message"],"properties":{"message":{"type":"string"},"validation_errors":{"type":"array","items":{"type":"string"}}}},"Delete":{"type":"object","properties":{"id":{"type":"integer"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Bearer"},"basicAuth":{"type":"http","scheme":"basic"}}},"security":[{"bearerAuth":[]}]}