{"openapi":"3.1.1","info":{"version":"1.0.0","title":"BoldTrail BackOffice API Documentation","description":"## BASICS\n\nBoldTrail BackOffice provides an API that can be used to create, retrieve, update, and delete virtually all of the resources\nstored and manipulated by the system. This interface incorporates several elements of the **REST** tradition,\nmaking access to these actions consistent and intuitive.\n\n\nIn a nutshell: collections are accessed via a URL ending in a plural noun such as `.../transactions`,\nand to target an individual resource instance, append its numerical id `.../transactions/85`.\nTo tell the API whether you are viewing, updating, or deleting the resource,\nmake use of the “HTTP verbs,” `GET`, \u003e`PUT`, `PATCH` and `DELETE`.\nTo create a new resource, send a `POST` request to the collection’s URL `.../transactions`.\nThe API’s response will be the content of the requested resource(s) or the data from the as-updated resource.\n\n\nThe BoldTrail BackOffice API allows client software to retrieve and operate on a user’s data by making HTTP requests\nto transfer **JSON-encapsulated** data.\n\n\nBecause the BoldTrail BackOffice API is accessible by anything that can make HTTP requests, not only can API client software\nbe written in almost any available programming language, but people can interact with it directly through any tool\nthat’s capable of making requests and receiving responses.\n\n\n## AUTHORIZATION\n\nAll API requests have to be authenticated with credentials for a specific BoldTrail BackOffice account, on whose behalf\nthe request is being made. Credentials are currently a single per-account user **API Key** and has the same\naccess level as the user whom the key belongs to. \u003cbr\u003e\u003cbr\u003e\n\n\nThe API Key has to be passed with each API request as `api_key` parameter:\n```http\n  GET /api/v1/users?api_key=.....\n```\n\n## REQUESTS\n\nBoldTrail BackOffice API uses **JSON** encoding. When sending `POST` or `PUT` requests, request body\nshould be encoded to **JSON** format. We also require sender to include a `Content-Type: application/json` header\nindicating type of the request body.\n\nRequest example:\n\n```http\n  POST /api/v1/users?api_key=.....\n  Content-Type: application/json\n\n  {\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"email\": \"test@example.com\",\n    \"role\": \"Office administrator\"\n  }\n```\n","contact":{"name":"BoldTrail BackOffice support","email":"support@brokermint.com","url":"https://brokermint.com"}},"servers":[{"description":"BoldTrail BackOffice API","url":"https://my.brokermint.com/api"}],"security":[{"API_KEY":[]}],"tags":[{"name":"API LIMITS","description":"### BoldTrail BackOffice API limits\nTo ensure the best user experience and platform performance, requests through the BoldTrail BackOffice API are rate-limited. Current limits:\n- 100 requests per 10 seconds limit\n- 2000 requests per hour limit\n- 100 failed requests per hour\n\n### Best practices for avoiding rate limiting\n\nIf you make multiple API requests in a short period of time, you will reach the API request limit. After that,\nBoldTrail BackOffice will stop processing all requests until the next cycle starts. BoldTrail BackOffice account rate limits are\nlisted in the API limits section at brokermint.com/api. Consider looking at them before starting an integration project.\n\nBelow we prepared a set of pro-tips for using our API without exceeding the limits\n\n### Track your API activity\n\nYou can interpret the following response headers to confirm the account’s current\nrate limit and monitor the number of requests remaining in the current **Burst** (10 seconds) period:\n\n```\n  X-Brokermint-Burst-Limit: 100\n  X-Brokermint-Burst-Remaining: 99\n```\n\nand **Hour** period:\n\n```\n  X-Brokermint-Hour-Limit: 2000\n  X-Brokermint-Hour-Remaining: 1999\n```\n\nand **Failed** requests numbers:\n\n```\n  X-Brokermint-Errors-Limit: 100\n  X-Brokermint-Errors-Remaining: 90\n```\n\n### Catch errors caused by limit exceeding\n\nFor each request, you can check if the rate limit has been reached.\nIf you’ll see the `429 \"Too many requests\"` status code, it means that you have reached the rate limit.\n\nWe recommend **adding code to your script that catches `429` responses**.\nIf the script ignores the `\"Too Many Requests\"` error and continues to try to make requests,\nsubsequent requests will be blocked until the beginning of the next cycle.\n\nFor example, a rate limited request may return the following response headers:\n\n```\n  \u003c HTTP/1.1 429\n  \u003c Server: nginx/1.4.2\n  \u003c Date: Wed, 15 Jun 2022 20:16:47 GMT\n  \u003c Connection: keep-alive\n  \u003c Status: 429\n  \u003c X-Brokermint-Burst-Limit: 100\n  \u003c X-Brokermint-Burst-Remaining: 56\n  \u003c X-Brokermint-Hour-Limit: 2000\n  \u003c X-Brokermint-Hour-Remaining: 0\n  \u003c X-Brokermint-Errors-Remaining: 0\n  \u003c X-Brokermint-Errors-Limit: 100\n  \u003c X-Brokermint-Hour-Reset: 1655326800000\n  \u003c Strict-Transport-Security: max-age=864000\n  \u003c Content-Length: 155\n```\n\nYour JSON response body will look like:\n\n```\n  {\"status\": 429, \"error\": \"You have fired too many requests. Please follow API limitation policies. For more information, please visit our API documentation.\"}\n```\n\nThe response headers contains the following key information:\n\n+ `Status: 429`\n+ `X-Brokermint-Hour-Remaining: 0`\n+ `X-Brokermint-Hour-Reset: 1655326800000`\n\nThe `429` status code means you’ve exceeded the rate limit. The `X-Brokermint-Hour-Remaining` header\nshows that the requestor reached hour limit, and `X-Brokermint-Hour-Reset` specifies\na **13-digit Unix timestamp** that indicates when the next cycle starts, and you’ll be allowed to make API calls.\nYour code should stop making additional API requests until enough time has passed to retry.\n\nThe following example shows an easy way to detect rate limiting errors:\n\n```\n  response = request.get(url)\n  headers = response.headers\n\n  if headers[\"Status\"] equals 429:\n    if headers[\"X-Brokermint-Hour-Remaining\"] equals 0:\n      alert(\"Hour rate limited. Waiting to retry ...\")\n      wait_until(headers[\"X-Brokermint-Hour-Reset\"])\n      retry(url)\n\n    if headers[\"X-Brokermint-Burst-Remaining\"] equals 0:\n      alert(\"Burst rate limited. Waiting to retry ...\")\n      wait_until(Time.next_10_seconds_begins)\n      retry(url)\n```\n\n\u003e The code above is a pseudo-code example that is intended to help you build your own algorithm for catching 429 errors.\n\n### Reduce the number of requests\n\nMake sure you make only the requests that you need. Here’s the list of things to consider when assessing\nyour integration architecture and API requests:\n\n1. Delete requests if they are not providing information further used within your platform.\n\n2. Cache frequently used data on the server or on the client side using DOM storage. You can also save\nrelatively static information in a database or serialize it in a file.\n\n3. Instead of making a batch of requests, use webhook subscriptions to listen for events and\nensure your data is up to date. This will allow your integration to\nautomatically perform actions when a webhook event is received.\n\n4. Use batch endpoints (such as “List available transactions”, which allows\nyou to get up to 1000 transactions within a single request),\ninstead of making 1000 different API requests for each single transaction.\n\n### Consider using throttling process\n\nIf you regularly approach or bump into the rate limit, consider including a process in your\ncode that regulates the rate of your requests so that they’re distributed more evenly over time.\nThis is known as a **throttling process** or a **throttling controller**. Regulating the request rate\ncan be done statically or dynamically. For example, you can monitor your request rate and\nregulate requests when the rate approaches the rate limit.\n\n\u003e To determine if you need to implement a throttling process, monitor your request errors.\nHow often do you get 429 errors? Does the frequency warrant implementing a throttling process?\n\n### Frequently Asked Questions\n\n**Q**: *Is there an endpoint that returns all endpoints for a resource, including rate limits and times to retry?*\n\n**A**: No, we don’t provide a rate-limit endpoint.\n\nHowever, we do provide the following response headers that you can use to confirm the account’s\ncurrent rate limit and monitor the number of requests remaining in the current minute:\n\n```\n  X-Brokermint-Burst-Limit: 100\n  X-Brokermint-Burst-Remaining: 50\n  X-Brokermint-Hour-Limit: 2000\n  X-Brokermint-Hour-Remaining: 1950\n  X-Brokermint-Errors-Limit: 100\n  X-Brokermint-Errors-Remaining: 90\n  X-Brokermint-Hour-Reset: 1655343500000\n```\n\n**Q**: *What happens when the rate limit is reached?*\n\n**A**: The request is not being processed; you’ll get a 429 response code.\nIf you reached Burst limit (100 requests per 10 seconds), you are able to\nwait until new 10 seconds period will start to continue requests.\n\nAlso, if you are reached Hour limit (2000 requests per hour), you’ll need\nto wait until new hour begins. The X-Brokermint-Hour-Reset header\n(13-digit Unix timestamp) will help you to determinate, when next cycle starts.\n\nHowever, if you got more than 100 errored responses during the hour, your integration will be required to wait until next cycle starts.\n\n**Q**: *Will batching calls reduce the number of API calls? How about making parallel calls?*\n\n**A**: No, batching calls won’t reduce the number of API calls. However, using a batch endpoint will reduce calls.\n"},{"name":"UPLOAD DOCUMENTS","description":"### How file uploading works​\n\nIn BoldTrail BackOffice, we allow users to upload files through our API using the simple logic: request the upload link and then upload the file.\n\n\u003e Due to our constant commitment to customer security, we allow uploading files like PDF, JPG, DOCX and so on. [See the full list of allowed formats here.](https://support.brokermint.com/en/articles/7125998-security-measures-file-upload-at-brokermint)\n\nDepending on the module, the request's URI and set of parameters will vary, but the overall logic will remain the same and include 2 simple steps:\n\n**STEP 1: Get the upload document link**\n\nUse the **\"Request upload URL\"** endpoint to generate the new upload document link. Keep in mind that the link will expire in 5 minutes since the creation.\n\nRequest example:\n\n```\nPOST /api/v1/..../request_upload_url\n```\n\nResponse example:\n```json\n{\n  \"upload_url\": \"http://example.com/upload_document?data=JhsDcf_wey%a27gasu...\"\n}\n```\n\n\n**STEP 2: Upload the document**\n\nUse this link along with the ``\"file\"`` [Multipart](https://www.w3.org/Protocols/rfc1341/7_2_Multipart.html) parameter to upload the document to the system.  As a result, you will receive a `200 OK` response with the uploaded document information as a JSON.\n\nRequest example:\n```\nPOST http://example.com/upload_document?data=JhsDcf_wey%a27gasu...\n\nContent-Type: multipart/form-data; boundary=\"boundary\"\n\n--boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"sample.pdf\"\nContent-Type: application/pdf\n\n\u003cfile body\u003e\n```\n\nResponse example:\n```json\n{\n  \"id\": 82,\n  \"name\": \"sample.pdf\",\n  \"task_id\": null,\n  \"content_type\": \"application/pdf\",\n  \"has_package\": false,\n  \"review_status\": null,\n  \"upload_status\": \"complete\",\n  \"status\": \"ready\",\n  \"url\": \"http://link.to.file/sample.pdf\"\n}\n```\n"},{"name":"ACCOUNTS","description":"Accounts management API"},{"name":"ACCOUNT SETTINGS V2","description":"Account settings management API"},{"name":"ACTIVITIES","description":"Activities management API\n### List of available event types (query parameters)\n\n  - bill_created      \n  - bill_updated      \n  - bill_deleted      \n  - invoice_created      \n  - invoice_updated      \n  - invoice_deleted      \n  - payment_created      \n  - payment_updated      \n  - payment_deleted      \n  - act_on_behalf_of_scope_changed      \n  - type_mapping_updated      \n  - office_mapping_updated      \n  - integration_disconnected      \n  - integration_connected      \n  - included_in_integration_reporting      \n  - excluded_from_integration_reporting      \n  - bhhs_deductions_updated      \n  - agent_mapping_updated      \n  - transaction_share_updated      \n  - transaction_share_revoked_recipient      \n  - transaction_share_revoked      \n  - transaction_share_added_recipients      \n  - transaction_share_added      \n  - ledger_posting_created      \n  - account_team_updated      \n  - account_team_resorted      \n  - account_team_deleted      \n  - account_team_created      \n  - task_updated      \n  - task_incomplete      \n  - document_unassigned      \n  - document_assigned      \n  - task_deleted      \n  - deadlines_changed      \n  - task_created      \n  - task_complete      \n  - tenant_screening_sent      \n  - remax      \n  - recurring_billing_updated      \n  - recurring_billing_deleted      \n  - recurring_billing_created      \n  - recurring_charge_updated      \n  - recurring_charge_agents_updated      \n  - recurring_charge_deleted      \n  - recurring_charge_created      \n  - incoming_offer_unrejected      \n  - incoming_offer_submitted      \n  - incoming_offer_rejected      \n  - incoming_offer_email_sent      \n  - incoming_offer_document_downloaded      \n  - incoming_offer_approved      \n  - oauth_rdparty_application_authorized      \n  - fa_enabled      \n  - fa_disabled      \n  - fa_device_reset      \n  - fa_device_registered      \n  - library_folder_renamed      \n  - library_folder_privacy_changed      \n  - library_folder_deleted      \n  - library_folder_created      \n  - library_document_uploaded      \n  - library_document_replaced      \n  - library_document_renamed      \n  - library_document_moved      \n  - library_document_deleted      \n  - boldtrail_users_mapping_updated      \n  - boldtrail_contact_was_deleted      \n  - boldtrail_account_disconnected      \n  - boldtrail_account_connected      \n  - transfer_updated      \n  - transfer_deleted      \n  - transfer_created      \n  - statement_regenerated      \n  - statement_emailed      \n  - statement_created      \n  - statement_charged      \n  - refund_updated      \n  - refund_deleted      \n  - refund_created      \n  - received_payment_updated      \n  - received_payment_deleted      \n  - received_payment_created      \n  - journal_entry_updated      \n  - journal_entry_deleted      \n  - journal_entry_created      \n  - invoice_emailed      \n  - deposit_updated      \n  - deposit_deleted      \n  - deposit_created      \n  - credit_memo_updated      \n  - credit_memo_deleted      \n  - credit_memo_created      \n  - balance_netting_updated      \n  - balance_netting_deleted      \n  - balance_netting_created      \n  - feature_flags_package_removed      \n  - feature_flags_package_added      \n  - feature_flags_feature_status_updated      \n  - feature_flags_feature_enabled      \n  - feature_flags_feature_disabled      \n  - feature_flags_accounts_removed      \n  - feature_flags_accounts_added      \n  - email_received      \n  - emd_statement_generated      \n  - emd_statement_emailed      \n  - emd_statement_downloaded      \n  - emd_operation_updated      \n  - emd_operation_receipts_detached      \n  - emd_operation_receipts_attached      \n  - emd_operation_deleted      \n  - emd_operation_created      \n  - emd_updated      \n  - emd_created      \n  - documents_merged      \n  - documents_emailed      \n  - document_updated      \n  - document_submitted_for_approval      \n  - document_split      \n  - document_shared      \n  - document_renamed      \n  - document_rejected      \n  - document_downloaded      \n  - document_deleted      \n  - document_approved      \n  - document_approval_revoked      \n  - document_added      \n  - contacts_bulk_updated      \n  - contact_updated      \n  - contact_privacy_changed      \n  - contact_deleted      \n  - contact_created      \n  - contact_assignee_changed      \n  - transaction_tgc_updated      \n  - transaction_side_representer_changed      \n  - transaction_commissions_finalized      \n  - calculated_commissions      \n  - transaction_commissions_award_distribution_updated      \n  - transaction_commissions_award_allocation_updated      \n  - transaction_commission_statement_emailed      \n  - transaction_commission_statement_downloaded      \n  - transaction_commission_plan_applied      \n  - transaction_commission_item_updated      \n  - transaction_commission_item_deleted      \n  - transaction_commission_item_added      \n  - transaction_cda_signed      \n  - transaction_cda_sent_for_signature      \n  - transaction_cda_generated      \n  - transaction_cda_emailed      \n  - transaction_cda_downloaded      \n  - transaction_agent_deleted      \n  - transaction_agent_added      \n  - starting_values_changed      \n  - personal_deduction_updated      \n  - personal_deduction_deleted      \n  - personal_deduction_added      \n  - commissions_plan_unassigned      \n  - commissions_plan_renamed      \n  - commissions_plan_item_updated      \n  - commissions_plan_item_deleted      \n  - commissions_plan_item_added      \n  - commissions_plan_deleted      \n  - commissions_plan_created      \n  - commissions_plan_cloned      \n  - commissions_plan_assigned      \n  - chained_commissions_plan_assigned      \n  - comment_added      \n  - checklist_template_updated      \n  - checklist_template_deleted      \n  - checklist_template_cloned      \n  - checklist_autoapply_settings_updated      \n  - checklist_template_added      \n  - accounting_account_updated      \n  - accounting_account_group_updated      \n  - accounting_account_group_deleted      \n  - accounting_account_group_added      \n  - accounting_account_deleted      \n  - accounting_account_added      \n  - account_updated_buyer_offer_fields      \n  - account_updated_buyer_offer_field      \n  - account_deleted_buyer_offer_field      \n  - account_added_buyer_offer_field      \n  - user_unassigned      \n  - user_assigned      \n  - transaction_updated      \n  - transaction_reopened      \n  - owner_changed      \n  - transaction_moved      \n  - transaction_email_to_everybody_sent      \n  - transaction_deleted      \n  - transaction_created      \n  - contact_unassigned      \n  - contact_assigned      \n  - transaction_closed      \n  - checklist_voided      \n  - checklist_updated      \n  - checklist_skipped      \n  - checklist_deleted      \n  - checklist_added      \n  - transaction_cancelled      \n  - backup_requested      \n  - backup_downloaded      \n  - document_signatures_resent      \n  - document_signatures_requested      \n  - document_signature_complete      \n  - document_signature_cancelled      \n  - document_partially_signed      \n  - document_package_created      \n  - account_purchased_subscription      \n  - documents_submitted      \n  - agent_withholding_updated      \n  - agent_withholding_deleted      \n  - agent_withholding_created      \n  - agent_onboarding_task_updated      \n  - agent_onboarding_task_incomplete      \n  - agent_onboarding_task_deleted      \n  - agent_onboarding_task_created      \n  - agent_onboarding_task_complete      \n  - agent_onboarding_comment_added      \n  - agent_onboarding_started      \n  - agent_onboarding_restarted      \n  - agent_onboarding_finished      \n  - agent_onboarding_document_updated      \n  - agent_onboarding_document_submitted_for_approval      \n  - agent_onboarding_document_signatures_requested      \n  - agent_onboarding_document_rejected      \n  - agent_onboarding_document_deleted      \n  - agent_onboarding_document_approved      \n  - agent_onboarding_document_approval_revoked      \n  - agent_onboarding_document_added      \n  - agent_onboarding_canceled      \n  - account_updated_transaction_fields      \n  - account_updated_transaction_field      \n  - account_deleted_transaction_field      \n  - account_added_transaction_field      \n  - account_updated_contact_fields      \n  - account_updated_contact_field      \n  - account_deleted_contact_field      \n  - account_added_contact_field      \n  - account_updated_account_user_fields      \n  - account_updated_account_user_field      \n  - account_deleted_account_user_field      \n  - account_added_account_user_field      \n  - account_updated      \n  - account_changed_owner      \n  - account_launch_status_updated      \n  - account_created      \n  - user_updated      \n  - user_unsubscribed_from_notification      \n  - user_team_changed      \n  - user_subscribed_for_notification      \n  - user_removed_from_team      \n  - user_deactivated      \n  - new_user_added_to_account      \n  - user_added_to_team      \n  - user_activated      \n  - users_account_access_revoked      \n  - user_received_account_access      \n  - permissions_changed      \n  - agent_onboarding_comment_updated      \n  - comment_updated      \n  - payment_method_updated      \n  - payment_method_set_as_default      \n  - payment_method_deleted      \n  - payment_method_created      \n  - payment_method_canceled      \n  - payment_method_activation_email_sent      \n  - payment_gateway_updated      \n  - payment_gateway_deleted      \n  - payment_gateway_created      \n  - payment_sent      \n  - payment_failed      \n  - payment_method_charged      \n  - payment_method_charge_failed      \n  - buyer_offer_withdrawn      \n  - buyer_offer_updated      \n  - buyer_offer_rejected      \n  - buyer_offer_participant_deleted      \n  - buyer_offer_participant_created      \n  - buyer_offer_owner_updated      \n  - buyer_offer_moved      \n  - buyer_offer_email_sent      \n  - buyer_offer_document_updated      \n  - buyer_offer_document_downloaded      \n  - buyer_offer_document_deleted      \n  - buyer_offer_document_added      \n  - buyer_offer_deleted      \n  - buyer_offer_created      \n  - buyer_offer_comment_created      \n  - buyer_offer_checklist_template_updated      \n  - buyer_offer_checklist_template_task_updated      \n  - buyer_offer_checklist_template_task_deleted      \n  - buyer_offer_checklist_template_task_added      \n  - buyer_offer_checklist_template_deleted      \n  - buyer_offer_checklist_template_created      \n  - buyer_offer_checklist_task_updated      \n  - buyer_offer_task_complete      \n  - buyer_offer_checklist_task_exempted      \n  - buyer_offer_checklist_task_deleted      \n  - buyer_offer_checklist_task_added      \n  - buyer_offer_activated      \n  - buyer_offer_accepted      \n"},{"name":"AGENT ONBOARDING","description":"Agent onboarding checklists management API"},{"name":"USERS","description":"Users management API\n"},{"name":"USER COMMISSION PLANS","description":"User's commission plan management API"},{"name":"CONTACTS","description":"Contacts management API"},{"name":"CONTACTS V2","description":"Contacts management API v2. Same resource as CONTACTS, but account custom fields are exchanged flat (one top-level key per field, keyed by the field label) instead of the v1 nested `custom_attributes` array. Call `Get current contacts schema` to discover an account's fields."},{"name":"COMMISSION PLANS","description":"Commission plans API"},{"name":"CHART OF ACCOUNTS (COA)","description":"Chart of accounts API"},{"name":"GENERAL LEDGER","description":"General Ledger API"},{"name":"TRANSACTIONS V3","description":"Transactions API V3"},{"name":"TRANSACTION PARTICIPANTS","description":"Transaction's participants management API"},{"name":"TRANSACTION COMMISSIONS","description":"To add commission items or replace all commission items for an existing transaction\nuse [transaction commission items endpoint](#tag/TRANSACTION-COMMISSIONS/paths/~1v1~1transactions~1{bm_transaction_id}~1commissions/post).\nTo create a transaction with commissions, use the [create transaction endpoint](#tag/TRANSACTIONS/paths/~1v1~1transactions/post)\nwith the `commission_items` attribute included into the request body, along with transaction attributes (see [Sample request](#transactions-commissions-sample-request)).\nThis attribute must be a list of commission item objects (see [Commission item structure](#commission-item-structure)).\nA minimal set of `commission_items` must contain `tgc` (Total gross commission), `award_distribution`,\n`award_allocation` and `sales_volume` items. All the commission item's attributes are\nmandatory, except for the `tgc` item, where `side` must be absent or set to `null`.\n\nA transaction can, for example, have only one `award_distribution` commission item per side (eg.)\nand one `award_allocation` / `sales_volume` / `split` commission item per side and payee.\nEvery `item_type` has its own list of available units of measure (uom), you can find the complete list\nof available items types and their units of measure below.\n\n### \u003ca name=\"commission-item-structure\"\u003e\u003c/a\u003eCommission item structure\n```\n{\n  \"item_type\": string, // (see \"List of available item types and unit of measures\" below for a full list of available item types)\n  \"side\": string, // (\"buying\" or \"listing\"),\n  \"payer_id\": integer,\n  \"payer_type:\" string,\n  \"payee_id\": integer,\n  \"payee_type\": string,\n  \"tiers\": [\n    {\n      \"low_limit\": float,\n      \"value\": float,\n      \"uom\": string // (see \"List of available item types and unit of measures\" below for a full list of available unit of measures)\n    }\n  ],\n  \"tags\": [string] // optional, if specified - replaces any tags previously set on the item\n}\n```\n\nThe `split` commission item can be configured using the following additional attributes:\n```\n{\n  \"sliding_base\": string, // (\"gross commission\", \"company dollar contribution\", \"sales volume\", \"transaction points\", \"agent commission\", \"commission basis\" or \"split: company's portion\")\n  \"sliding_base_period\": string, // (\"year to date\", \"month to date\", \"month of the acceptance date\", \"since last anniversary\", \"last 12 months to the current date\", \"last 12 months to the end of the previous month\", \"custom range\" or \"this transaction only\")\n  \"sliding_base_accrued_by\": string // (\"agent\", \"team\")\n}\n```\n\n### List of available item types and units of measures\n| Item Type                  | Unit of Measure                                                                           |\n| -------------------------- | ----------------------------------------------------------------------------------------- |\n| `tgc`                      | `% of price sold`, `$`                                                                    |\n| `award_distribution`       | `% of price sold`, `% of tgc`, `$`                                                        |\n| `award_allocation`         | `% of shared gross income`, `$`                                                           |\n| `sales_volume`             | `% of price sold`, `$`                                                                    |\n| `split`                    | `% of remaining balance`, `% of tgc`,\u003cbr\u003e`% of side income`, `% of commission basis`, `$` |\n\n### \u003ca name=\"transactions-commissions-sample-request\"\u003e\u003c/a\u003eCreate Transaction With Commissions Sample request\n```\nPOST https://my.brokermint.com/api/v2/transactions?api_key={{YOUR_API_KEY}}\nContent-Type: application/json\n\n{\n  \"address\": \"1150 W 14th Street\",\n  \"city\": \"Upland\",\n  \"state\": \"CA\",\n  \"zip\": \"91786\",\n  \"status\": \"listing\",\n  \"price\": 1000000.0,\n  \"transaction_type\": \"traditional sale\",\n  \"representing\": \"seller\",\n  \"acceptance_date\": null,\n  \"expiration_date\": null,\n  \"closing_date\": null,\n  \"listing_date\": null,\n\n  \"buying_side_representer\": {\n    \"id\": 4212407,\n    \"type\": \"Contact\"\n  },\n  \"listing_side_representer\": {\n    \"id\": 6014,\n    \"type\": \"Account\"\n  },\n\n  \"commission_items\": [\n    {\n      \"item_type\": \"tgc\",\n      \"side\": null,\n      \"payer_id\": 6014,\n      \"payer_type\": \"Account\",\n      \"payee_id\": 6014,\n      \"payee_type\": \"Account\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 6.0,\n          \"uom\": \"% of price sold\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"award_distribution\",\n      \"side\": \"listing\",\n      \"payer_id\": 6014,\n      \"payer_type\": \"Account\",\n      \"payee_id\": 6014,\n      \"payee_type\": \"Account\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 3.0,\n          \"uom\": \"% of price sold\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"award_distribution\",\n      \"side\": \"buying\",\n      \"payer_id\": 4212407,\n      \"payer_type\": \"Contact\",\n      \"payee_id\": 4212407,\n      \"payee_type\": \"Contact\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 3.0,\n          \"uom\": \"% of price sold\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"award_allocation\",\n      \"side\": \"listing\",\n      \"payer_id\": 6014,\n      \"payer_type\": \"Account\",\n      \"payee_id\": 36736,\n      \"payee_type\": \"User\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 80.0,\n          \"uom\": \"% of shared gross income\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"sales_volume\",\n      \"side\": \"listing\",\n      \"payer_id\": 36736,\n      \"payer_type\": \"User\",\n      \"payee_id\": 36736,\n      \"payee_type\": \"User\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 80.0,\n          \"uom\": \"% of price sold\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"split\",\n      \"side\": \"listing\",\n      \"payer_id\": 6014,\n      \"payer_type\": \"Account\",\n      \"payee_id\": 36736,\n      \"payee_type\": \"User\",\n      \"sliding_base\": \"sales volume\",\n      \"sliding_base_period\": \"year to date\",\n      \"sliding_base_amount\": 0.0,\n      \"sliding_base_accrued_by\": \"agent\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 80.0,\n          \"uom\": \"% of remaining balance\"\n        },\n        {\n          \"low_limit\": 100000.0,\n          \"value\": 90.0,\n          \"uom\": \"% of remaining balance\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"award_allocation\",\n      \"side\": \"listing\",\n      \"payer_id\": 6014,\n      \"payer_type\": \"Account\",\n      \"payee_id\": 36467,\n      \"payee_type\": \"User\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 20.0,\n          \"uom\": \"% of shared gross income\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"sales_volume\",\n      \"side\": \"listing\",\n      \"payer_id\": 36467,\n      \"payer_type\": \"User\",\n      \"payee_id\": 36467,\n      \"payee_type\": \"User\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 20.0,\n          \"uom\": \"% of price sold\"\n        }\n      ]\n    },\n    {\n      \"item_type\": \"split\",\n      \"side\": \"listing\",\n      \"payer_id\": 6014,\n      \"payer_type\": \"Account\",\n      \"payee_id\": 36467,\n      \"payee_type\": \"User\",\n      \"sliding_base\": \"gross commission\",\n      \"sliding_base_period\": \"year to date\",\n      \"sliding_base_accrued_by\": \"agent\",\n      \"tiers\": [\n        {\n          \"low_limit\": 0.0,\n          \"value\": 80.0,\n          \"uom\": \"% of remaining balance\"\n        }\n      ]\n    }\n  ]\n}\n```\n"},{"name":"TRANSACTION CHECKLISTS","description":"Transaction checklists management API"},{"name":"TRANSACTION TASKS","description":"Transaction's task management API"},{"name":"TRANSACTION DOCUMENTS","description":"Transaction documents management API"},{"name":"E-SIGNATURES","description":"Electronic signature requests API"},{"name":"TRANSACTION BACKUPS","description":"Transaction backups access API"},{"name":"TRANSACTION OFFERS","description":"Offers management API\n"},{"name":"INCOMING TRANSACTIONS","description":"Incoming transactions management API"},{"name":"BUYER OFFERS","description":"Buyer Offers API"},{"name":"BUYER OFFER PARTICIPANTS","description":"Buyer offer checklist management API"},{"name":"BUYER OFFER CHECKLISTS","description":"Buyer offer checklist management API"},{"name":"BUYER OFFER TASKS","description":"Buyer offer task management API"},{"name":"BUYER OFFER DOCUMENTS","description":"Buyer offer documents management API"},{"name":"REVIEW DOCUMENTS","description":"Review documents API"},{"name":"REPORTS","description":"Reporting API V2"},{"name":"TODO","description":"Todo tasks management API"},{"name":"SSO","description":"SSO API allows remotely login user into the BoldTrail BackOffice.\nTo login a user into the BoldTrail BackOffice website using sso token,\nredirect the user to the URL: `https://my.brokermint.com/users/sign_in_by_token?token=\u003ctoken\u003e`\n\nAn optional `url_back` query parameter can be appended to navigate the user to a specific page after sign-in.\nIt must be a relative path. Example: `https://my.brokermint.com/users/sign_in_by_token?token=\u003ctoken\u003e\u0026url_back=/#/account/lists/transaction-fields`\n"},{"name":"WEBHOOKS","description":"Webhook subscriptions allow you to listen for events you are interested in so your integration\ncan automatically perform required actions.\n\n### Building a webhook endpoint\nBefore creating a subscription, you need to create a webhook endpoint on you server which\nwill be POSTed for every event occurrence on BoldTrail BackOffice side in JSON format. To acknowledge\nan incoming event, your endpoint must return HTTP 200 status code within 10 seconds.\nOtherwise, the notification attempt is repeated. See [Retry policy](#webhooks-retry-policy) for more information.\n\n### Creating a subscription\nTo create a subscription, use [create API endpoint](#tag/WEBHOOKS/paths/~1v1~1webhooks/post)\nusing your webhook endpoint URL as `callback_url`. Every account's user is limited to 5 subscriptions.\nAfter subscription created, it needs to be [Activated](#tag/WEBHOOKS/paths/~1v1~1webhooks~1{id}~1activate/post)\nto start receiving webhook events.\n**Make sure to save the `secret_token` from the response, you won't be able to see it again.**\n\n### Security\nEvery event notification includes `X-Brokermint-Webhook-Signature` HTTP header containing\nthe request's signature (HMAC Hex Digest). This allows you to verify that the events were sent by BoldTrail BackOffice,\nnot by a third party. BoldTrail BackOffice generates signatures using a hash-based message authentication\ncode ([HMAC](https://en.wikipedia.org/wiki/Hash-based_message_authentication_code)) with\n[SHA-256](https://en.wikipedia.org/wiki/SHA-2). To verify the signature, you need to compute\nan HMAC Hex Digest with the SHA256 hash function using your subscription's `secret_token` as the key and\nthe request body as the message and compare the result with the signature in the header.\n\n### Test your webhook endpoint\nTo test your webhook endpoint you can use [test API endpoint](#tag/WEBHOOKS/paths/~1v1~1webhooks~1:id~1test/post).\nIt sends a test event to your webhook endpoint with `{\"value\": \"ping\"}` as an `object`.\n\n### \u003ca name=\"webhooks-retry-policy\"\u003e\u003c/a\u003eRetry policy\nEvery failed event notification attempt is repeated over next 4 hours with the following\ninterval — 5, 10, 15, 30, 60 and 120 minutes. After 6 failures to send the notification,\nBoldTrail BackOffice marks the event as failed, deactivates the webhook subscription and emails you about the deactivation.\n\n### Event deliverability\nBoldTrail BackOffice does not guarantee delivery of events in the order in which they are generated and immediately\nafter an entity was created/updated/deleted. It may take up to 2 minutes to deliver the event since it's been triggered.\nAlso, your webhook endpoint might occasionally receive the same event more than once,\nor the `delete|removed` event could be false positive (sent before the `create` message).\nTherefore, we advise you to log the events you've processed and not process\nalready logged events, considering the sequence of events.\n\n### Event object\nThe Webhook payload is sent in standard JSON format and contains an event object with the\nfollowing information represented by key-value pairs:\n- `event_id` - A unique event ID\n- `event_type` - The lifecycle event that triggered the payload (e.g. transaction.created; transaction.updated; etc.)\n- `api_version` - The API version\n- `object` - The object containing the relevant information of the affected entity\n- `metadata` - The data which is passed to the webhook subscription when created\n- `created_at` - 13-digit unix timestamp of the time at which the event trigger occurred\n\n### List of available event types\n| Event type | Description | Object structure | API version |\n|-------|-------|-------|-------|\n| transaction.created | Occurs whenever a new transaction is created | [response sample](#tag/TRANSACTIONS-V3/paths/~1v3~1transactions/post) | 3 |\n| transaction.created | Occurs whenever a new transaction is created | [response sample](#tag/TRANSACTIONS-V2-%28deprecated%29/paths/~1v2~1transactions/post) | 2 |\n| transaction.updated | Occurs whenever a transaction is updated | [response sample](#tag/TRANSACTIONS-V3/paths/~1v3~1transactions/post) | 3 |\n| transaction.updated | Occurs whenever a transaction is updated | [response sample](#tag/TRANSACTIONS-V2-%28deprecated%29/paths/~1v2~1transactions/post) | 2 |\n| transaction.deleted | Occurs whenever a transaction is deleted | `{ \"id\": 23,\"deleted_at\": 1679667148337,\"external_id\": \"\" }` | 2 |\n| transaction.participant.added | Occurs whenever a participant is added to transaction | [user response sample](#tag/TRANSACTION-PARTICIPANTS/paths/~1v1~1transactions~1{bm_transaction_id}~1participants~1users/post);\u003cbr /\u003e [contact response sample](#tag/TRANSACTION-PARTICIPANTS/paths/~1v1~1transactions~1{bm_transaction_id}~1participants~1contacts/post) | 1 |\n| transaction.participant.updated | Occurs whenever a transaction participant is updated | [user response sample](#tag/TRANSACTION-PARTICIPANTS/paths/~1v1~1transactions~1{bm_transaction_id}~1participants~1users/post);\u003cbr /\u003e [contact response sample](#tag/TRANSACTION-PARTICIPANTS/paths/~1v1~1transactions~1{bm_transaction_id}~1participants~1contacts/post) | 1 |\n| transaction.participant.removed | Occurs whenever a participant is removed from transaction | `{ \"id\": 123456, \"bm_transaction_id\": 123456, \"contact_id\": 123456, \"type\": \"contact\" }` \u003cbr/\u003e or \u003cbr/\u003e `{ \"id\": 123456, \"bm_transaction_id\": 123456, \"user_id\": 123456, \"type\": \"user\" }` | 1 |\n| incoming_transaction.accepted | Occurs whenever a incoming transaction accepted | [ShortIncomingTransaction response sample](#tag/INCOMING-TRANSACTIONS/paths/~1v1~1incoming_transactions~1{id}/get) | 1 |\n| incoming_transaction.discarded | Occurs whenever a incoming transaction discarded | [ShortIncomingTransaction response sample](#tag/INCOMING-TRANSACTIONS/paths/~1v1~1incoming_transactions~1{id}/get) | 1 |\n| buyer_offer.created | Occurs whenever a new buyer offer is created | [response sample](#tag/BUYER-OFFERS/paths/~1v1~1buyer_offers/post) | 1 |\n| buyer_offer.updated | Occurs whenever a buyer offer is updated | [response sample](#tag/BUYER-OFFERS/paths/~1v1~1buyer_offers/post) | 1 |\n| buyer_offer.deleted | Occurs whenever a buyer offer is deleted | `{ \"id\": 123456 }` | 1 |\n| buyer_offer.participant.added | Occurs whenever a participant is added to buyer offer | `{ \"id\": 123456, \"participant_type\": \"contact\", \"participant_id\": 654321, \"role\": \"Agent\", \"owner\": false, \"first_name\": \"Jonh\", \"last_name\": \"Doe\", \"email\": \"jonh.doe@example.com\" }` \u003cbr/\u003e or \u003cbr/\u003e `{ \"id\": 123456, \"participant_type\": \"user\", \"participant_id\": 654321, \"role\": \"Agent\", \"owner\": false, \"first_name\": \"Jonh\", \"last_name\": \"Doe\", \"email\": \"jonh.doe@example.com\" }` | 1 |\n| buyer_offer.participant.updated | Occurs whenever a buyer offer participant is updated | `{ \"id\": 123456, \"participant_type\": \"contact\", \"participant_id\": 654321, \"role\": \"Agent\", \"owner\": false, \"first_name\": \"Jonh\", \"last_name\": \"Doe\", \"email\": \"jonh.doe@example.com\" }` \u003cbr/\u003e or \u003cbr/\u003e `{ \"id\": 123456, \"participant_type\": \"user\", \"participant_id\": 654321, \"role\": \"Agent\", \"owner\": false, \"first_name\": \"Jonh\", \"last_name\": \"Doe\", \"email\": \"jonh.doe@example.com\" }` | 1 |\n| buyer_offer.participant.removed | Occurs whenever a participant is removed from buyer offer | `{ \"id\": 123456, \"buyer_offer_id\": 123456, \"participant_id\": 654321, \"participant_type\": \"contact\" }` \u003cbr/\u003e or \u003cbr/\u003e `{ \"id\": 123456, \"buyer_offer_id\": 123456, \"participant_id\": 654321, \"participant_type\": \"user\" }` | 1 |\n\n\n### Event example\n```\n{\n  \"event_id\": \"df6d06fe-cc2b-422d-9737-52b30a48d4f7\",\n  \"event_type\": \"transaction.created\",\n  \"api_version\": \"2\",\n  \"object\": {\n    \"address\": \"17019 Broken Rock Court\",\n    \"city\": \"Riverside\",\n    \"state\": \"CA\",\n    \"zip\": \"92503\",\n    \"status\": \"listing\",\n    ...\n  },\n  \"metadata\": {},\n  \"created_at\": 1604964452345\n}\n```\n"},{"name":"ACCOUNT SETTINGS (deprecated)","description":"Account settings management API"},{"name":"TRANSACTIONS (deprecated)","description":"Deprecated transactions API, use Transactions v3 API instead"},{"name":"TRANSACTIONS V2 (deprecated)","description":"Transactions API V2 (deprecated, use Transactions v3 API instead)"}],"components":{"securitySchemes":{"API_KEY":{"type":"apiKey","description":"All API requests have to be authenticated with credentials for a specific BoldTrail BackOffice account,\non whose behalf the request is being made. Credentials are currently a single per-account user API Key and\nhas the same access level as the user whom the key belongs to.\nThe API Key has to be passed with each API request as `api_key` parameter.\n","in":"query","name":"api_key"}},"parameters":{"countParam":{"name":"count","in":"query","description":"Specifies the number of items to retrieve","example":50,"schema":{"type":"integer","minimum":1,"maximum":1000}},"sortParam":{"name":"sort","in":"query","description":"Specifies the order of items to retrieve. From more recent to oldest or vice versa.\nDefault value is \"asc\"\n","example":"desc","schema":{"type":"string"}},"startingFromIdParam":{"name":"starting_from_id","in":"query","description":"Specifies the ID of entity to retrieve records starting from","example":1000,"schema":{"type":"integer"}},"bm_transaction_id":{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},"full_info":{"name":"full_info","in":"query","required":false,"description":"Specifies whether to retrieve short or full participant information.\n","schema":{"type":"integer","enum":[0,1],"default":0},"example":1}},"schemas":{"dateParamSchema":{"oneOf":[{"type":"string","description":"date in a form YYYY-MM-DD"},{"type":"integer","description":"13-digit unix timestamp"}]},"dateStamp":{"type":"integer","description":"13-digit unix timestamp","examples":[1428278400000]},"ShortUserFields":{"type":"object","properties":{"email":{"type":"string","format":"email","examples":["test@example.com"]},"first_name":{"type":"string","examples":["John"]},"last_name":{"type":"string","examples":["Doe"]},"company":{"type":"string","examples":["MegaCorp"]},"role":{"type":"string","examples":["Office administrator"]},"team":{"type":"string","description":"team name, the team is created if it doesn't exist yet.\nOn update: omit the field to keep the current team,\npass an empty value to remove the user from their team\n","examples":["North Office"]},"external_id":{"type":"string","description":"external identifier passed during user creation,\nthis value available through users API only,\nusers can be filtered by this field to see whether such user already exists\n","examples":["crm1234"]}}},"NewShortUser":{"allOf":[{"$ref":"#/components/schemas/ShortUserFields"},{"type":"object","required":["email","first_name","last_name"]}]},"CreateUserParams":{"allOf":[{"$ref":"#/components/schemas/NewFullUser"},{"type":"object","properties":{"permissions":{"description":"Permissions, can be a subset of the enabled permissions only\n","allOf":[{"$ref":"#/components/schemas/UserPermissions"}]},"commission_plan_ids":{"description":"List of commission plan ids that you want to apply for newly created user","type":"array","items":{"type":"integer"},"examples":[[101,102]]},"onboarding_template_id":{"description":"ID of agent onboarding checklist template","type":"integer","examples":[44]},"onboarding_template_assignees":{"description":"Array of agent onboarding template assignees. Each role for the provided template checklist template must be set.","type":"array","items":{"type":"object","properties":{"role":{"description":"Role name from the provided onboarding checklist template","type":"string"},"user_id":{"type":"integer"}}},"examples":[[{"role":"account owner","user_id":123}]]}}}]},"FullUserFields":{"allOf":[{"$ref":"#/components/schemas/ShortUserFields"},{"type":"object","properties":{"birthday":{"$ref":"#/components/schemas/dateStamp"},"anniversary_date":{"$ref":"#/components/schemas/dateStamp"},"phone":{"type":"string","examples":["619-433-6789"]},"My Custom Field":{"type":"string","x-mcp-schema-placeholder":true,"description":"Below are your user's custom fields\nThey depends upon Account fields settings\n","examples":["Account's custom fields below"]},"Address":{"type":"string","x-mcp-schema-placeholder":true,"description":"custom field that depends on your account setting","examples":["11332 Demo St"]},"City":{"type":"string","x-mcp-schema-placeholder":true,"description":"custom field that depends on your account setting","examples":["San Diego"]},"State":{"type":"string","x-mcp-schema-placeholder":true,"description":"custom field that depends on your account setting","examples":["CA"]},"Zip":{"type":"string","x-mcp-schema-placeholder":true,"description":"custom field that depends on your account setting","examples":["92123"]}}}]},"NewFullUser":{"allOf":[{"$ref":"#/components/schemas/FullUserFields"},{"type":"object","required":["email","first_name","last_name"]}]},"UpdateFullUser":{"$ref":"#/components/schemas/FullUserFields"},"ShortUser":{"allOf":[{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"user_id":{"type":"integer","description":"the ID of the user, it's the same value as \"id\" field\nthis ID will be the same for this user across all accounts this user participates\n","examples":[123]},"account_user_id":{"type":"integer","description":"uniquely identifies user-to-account association\nit's unique for this user in each account\n","examples":[345]},"custom_id":{"type":"string","description":"Customized user ID shown on UI as \"User ID\"\nit's the read-only calculated value, in most of the cases this is the \"user_id\"\ncustomizations like adding office ID or showing external_id instead can be requested\n","examples":["CA920010:123"]},"type":{"type":"string","description":"entity type, always set to \"user\"","examples":["user"]},"name":{"type":"string","description":"full user name","examples":["Jonh Doe"]},"active":{"type":"boolean","examples":[true]},"account_user_active":{"type":"boolean","description":"Whether this user's membership in the current account is active, as distinct\nfrom \"active\" (the user's global active state across all accounts)\n","examples":[true]}}},{"$ref":"#/components/schemas/NewShortUser"}]},"FullUser":{"allOf":[{"$ref":"#/components/schemas/ShortUser"},{"$ref":"#/components/schemas/NewFullUser"},{"type":"object","properties":{"comments":{"type":"array","items":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/dateStamp"},"text":{"type":"string","examples":["The comment text"]},"author":{"type":"string","examples":["John Doe"]}}}},"avatar_added":{"type":"boolean","description":"indicates whether user has non-default avatar","examples":[false]},"avatar_url":{"type":"string","description":"URL to user's avatar","examples":["/assets/empty-avatar.png"]},"last_sign_in":{"$ref":"#/components/schemas/dateStamp"},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"}}}]},"CurrentUserDetails":{"allOf":[{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"user_id":{"type":"integer","description":"the ID of the user, it's the same value as \"id\" field\nthis ID will be the same for this user across all accounts this user participates\n","examples":[123]},"account_user_id":{"type":"integer","description":"uniquely identifies user-to-account association\nit's unique for this user in each account\n","examples":[345]},"custom_id":{"type":"string","description":"Customized user ID shown on UI as \"User ID\"\nit's the read-only calculated value, in most of the cases this is the \"user_id\"\ncustomizations like adding office ID or showing external_id instead can be requested\n","examples":["CA920010:123"]},"external_id":{"type":"string","description":"external identifier passed during user creation,\nthis value available through users API only,\nusers can be filtered by this field to see whether such user already exists\n","examples":["crm1234"]},"active":{"type":"boolean","examples":[true]},"role":{"type":"string","examples":["Office administrator"]},"team":{"type":"string","examples":["North Office"]},"type":{"type":"string","description":"entity type, always set to \"user\""},"first_name":{"type":"string","examples":["John"]},"last_name":{"type":"string","examples":["Doe"]},"name":{"type":"string","description":"full user name","examples":["John Doe"]},"email":{"type":"string","format":"email","examples":["test@example.com"]}}}]},"UserPermissions":{"type":"object","properties":{"create_transaction":{"type":"boolean","examples":[true],"description":"Can create transactions"},"edit_transaction":{"type":"boolean","examples":[true],"description":"Can edit transactions"},"delete_transaction":{"type":"boolean","examples":[true],"description":"Can delete transactions"},"cancel_transaction":{"type":"boolean","examples":[true],"description":"Can cancel transactions"},"manage_all_company_transactions":{"type":"boolean","examples":[true],"description":"Can access all company transactions"},"manage_transaction_checklist_tasks":{"type":"boolean","examples":[true],"description":"Can manage transaction checklist tasks"},"manage_transaction_checklists":{"type":"boolean","examples":[true],"deprecated":true,"description":"Deprecated and retained only for historical purposes.\u003cbr/\u003e\nIts value is derived from \u003cb\u003e\"Can manage transaction checklist tasks\"\u003c/b\u003e permission.\n"},"add_checklists_for_transaction":{"type":"boolean","examples":[true],"description":"Can add checklists for transaction"},"remove_checklists_from_transaction":{"type":"boolean","examples":[true],"description":"Can remove checklists for transaction"},"add_remove_checklists_for_transaction":{"type":"boolean","examples":[true],"deprecated":true,"description":"Deprecated and retained only for historical purposes.\u003cbr/\u003e\nIts value is enabled when both \u003cb\u003e\"Can add checklists for transaction\"\u003c/b\u003e and\n\u003cb\u003e\"Can remove checklists for transaction\"\u003c/b\u003e permissions are enabled.\n"},"close_transactions":{"type":"boolean","examples":[true],"description":"Can close transactions"},"close_unapproved_transactions":{"type":"boolean","examples":[true],"description":"Can close not approved transactions.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can close transactions\"\u003c/b\u003e permission.\n"},"reopen_transactions":{"type":"boolean","examples":[true],"description":"Can re-open transactions"},"move_transactions":{"type":"boolean","examples":[true],"description":"Can move transactions"},"edit_emd":{"type":"boolean","examples":[true],"description":"Can edit earnest money deposit"},"view_own_transaction_commissions":{"type":"boolean","examples":[true],"description":"Can view own transaction commissions"},"view_transaction_commissions":{"type":"boolean","examples":[true],"description":"Can view all transaction commissions.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can view own transaction commissions\"\u003c/b\u003e permission.\n"},"edit_transaction_commissions":{"type":"boolean","examples":[true],"description":"Can edit transaction commissions.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can view all transaction commissions\"\u003c/b\u003e permission.\n"},"access_transaction_commissions":{"type":"boolean","examples":[true],"deprecated":true,"description":"Deprecated and retained only for historical purposes.\u003cbr/\u003e\nIts value is enabled when both \u003cb\u003e\"Can view all transaction commissions\"\u003c/b\u003e and\n\u003cb\u003e\"Can edit transaction commissions\"\u003c/b\u003e permissions are enabled.\n"},"generate_cda":{"type":"boolean","examples":[true],"description":"Can generate CDA.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can view all transaction commissions\"\u003c/b\u003e permission.\n"},"change_award_distribution":{"type":"boolean","examples":[true],"description":"Can change award distribution.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can view all transaction commissions\"\u003c/b\u003e permission.\n"},"finalize_commissions":{"type":"boolean","examples":[true],"description":"Can finalize commissions.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can view all transaction commissions\"\u003c/b\u003e permission.\n"},"manage_transaction_shares":{"type":"boolean","examples":[true],"description":"Can share transactions"},"access_buyer_offers":{"type":"boolean","examples":[true],"description":"Can access buyer offers"},"create_buyer_offer":{"type":"boolean","examples":[true],"description":"Can create buyer offers.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access buyer offers\"\u003c/b\u003e permission.\n"},"edit_buyer_offer":{"type":"boolean","examples":[true],"description":"Can edit buyer offers.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access buyer offers\"\u003c/b\u003e permission.\n"},"delete_buyer_offer":{"type":"boolean","examples":[true],"description":"Can access all company buyer offers.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access buyer offers\"\u003c/b\u003e permission.\n"},"manage_all_company_buyer_offers":{"type":"boolean","examples":[false],"description":"Can access all company buyer offers.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access buyer offers\"\u003c/b\u003e permission.\n"},"pipeline":{"type":"boolean","examples":[true],"description":"Can see individual pipeline"},"access_personal_reports":{"type":"boolean","examples":[true],"description":"Can access personal reports"},"access_company_reports":{"type":"boolean","examples":[true],"description":"Can access company reports"},"access_private_contacts":{"type":"boolean","examples":[true],"description":"Can access private contacts"},"manage_private_contacts":{"type":"boolean","examples":[true],"description":"Can access private contacts.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access private contacts\"\u003c/b\u003e permission.\n"},"access_account_activity":{"type":"boolean","examples":[true],"description":"Can access account activity"},"access_transaction_activity":{"type":"boolean","examples":[true],"description":"Can access transaction activity"},"access_library":{"type":"boolean","examples":[true],"description":"Can access library"},"manage_library":{"type":"boolean","examples":[true],"description":"Can manage library.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access library\"\u003c/b\u003e permission.\n"},"access_all_private_folders":{"type":"boolean","examples":[true],"description":"Can access all private folders.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access library\"\u003c/b\u003e permission.\n"},"approve_documents":{"type":"boolean","examples":[true],"description":"Can approve documents"},"secondary_approve_documents":{"type":"boolean","examples":[true],"description":"Can second level approve documents"},"submit_transactions_for_approval":{"type":"boolean","examples":[true],"description":"Can submit transactions for approval"},"submit_documents_for_approval":{"type":"boolean","examples":[true],"description":"Can submit individual documents.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can submit transactions for approval\"\u003c/b\u003e permission.\n"},"manage_company_settings":{"type":"boolean","examples":[true],"description":"Can manage company settings"},"manage_company_info":{"type":"boolean","examples":[true],"description":"Can edit company info.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can manage company settings\"\u003c/b\u003e permission.\n"},"manage_company_users":{"type":"boolean","examples":[true],"description":"Can manage users.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can manage company settings\"\u003c/b\u003e permission.\n"},"manage_company_checklist_templates":{"type":"boolean","examples":[true],"description":"Can manage checklist templates.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can manage company settings\"\u003c/b\u003e permission.\n"},"manage_company_lists":{"type":"boolean","examples":[true],"description":"Can manage fields.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can manage company settings\"\u003c/b\u003e permission.\n"},"manage_company_commissions_plans":{"type":"boolean","examples":[true],"description":"Can manage commissions plans.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can manage company settings\"\u003c/b\u003e permission.\n"},"manage_dashboard":{"type":"boolean","examples":[true],"description":"Can manage dashboard.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can manage company settings\"\u003c/b\u003e permission.\n"},"access_accounting":{"type":"boolean","examples":[true],"description":"Can access accounting"},"manage_agent_billing":{"type":"boolean","examples":[true],"description":"Can manage agent billing.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access accounting\"\u003c/b\u003e permission.\n"},"manage_recurring_charges":{"type":"boolean","examples":[true],"description":"Can manage recurring charges.\u003cbr/\u003e\nDepends on \u003cb\u003e\"Can access accounting\"\u003c/b\u003e permission.\n"}}},"Account":{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"company_name":{"type":"string","examples":["MegaCorp"]},"location_name":{"type":"string","examples":["San Diego"]},"address":{"type":"string","examples":["11332 Demo St"]},"city":{"type":"string","examples":["San Diego"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":[92123]},"domain":{"type":"string","examples":["my.brokermint.com"]},"phone":{"type":"string","examples":["619-433-6789"]},"fax":{"type":"string","examples":["619-433-6789"]},"office_code":{"type":"string","examples":["HBDF-123131"]},"license_number":{"type":"string","examples":[123456789]},"logo_url":{"type":"string","examples":["https://s3-eu-central-1.amazonaws.com/BUCKET/FILE"]},"color_scheme":{"type":"object","properties":{"name":{"type":"string","examples":["teal"]},"color":{"type":"string","examples":["#49b9bd"]}}},"locale":{"type":"string","examples":["us"],"enum":["us","ca"]},"capabilities":{"type":"array","items":{"type":"string","enum":["accounting","agent onboarding"]},"examples":[["accounting","agent onboarding"]]}}},"BuyerOfferFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["The field name"]},"label":{"type":"string","examples":["The field label"]},"type":{"type":"string","enum":["text","dropdown","date","money"]},"required":{"type":"boolean","examples":[false]}}}},"TransactionFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["The field name"]},"label":{"type":"string","examples":["The field label"]},"type":{"type":"string","enum":["text","dropdown","date","money"]},"requirements":{"type":"object","properties":{"always":{"type":"boolean","examples":[false]},"when":{"type":"object","properties":{"status":{"type":"array","items":{"type":"string"},"examples":[["pending","closed"]]},"representing":{"type":"string","examples":["seller"]}}}}},"required":{"deprecated":true,"type":"boolean","examples":[true]},"required_if_status":{"deprecated":true,"type":"string","enum":["pending","closed","cancelled"]}}}},"TransactionFieldsV2":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["The field name"]},"label":{"type":"string","examples":["The field label"]},"type":{"type":"string","enum":["text","dropdown","date","money"]},"requirements":{"type":"object","properties":{"always":{"type":"boolean","examples":[false]},"when":{"type":"object","properties":{"status":{"type":"array","items":{"type":"string"},"examples":[["pending","closed"]]},"representing":{"type":"string","examples":["seller"]}}}}}}}},"TransactionTypes":{"type":"array","items":{"type":"string"},"examples":[["Commercial sale","Residential sale","Offer"]]},"TransactionRoles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["Seller"]},"requirements":{"type":"object","properties":{"when":{"type":"object","properties":{"side_representings":{"type":"array","items":{"type":"string"},"examples":[["seller","both"]]},"transaction_type":{"type":"array","items":{"type":"string"},"examples":[["Commercial sale","Commercial lease"]]},"transaction_statuses":{"type":"array","items":{"type":"string"},"examples":[["active","pending"]]},"transaction_status":{"deprecated":true,"description":"list of legacy statuses","type":"array","items":{"type":"string"},"examples":[["listing","pending"]]},"side_represented":{"deprecated":true,"type":"string","examples":["seller"]}}},"always":{"type":"boolean","examples":[false]},"default":{"type":"object","description":"User that will be assigned to role by default","properties":{"id":{"type":"integer","examples":[123]},"type":{"type":"string","examples":["Contact"]}}}}}}}},"TransactionRolesV2":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["Seller"]},"requirements":{"type":"object","properties":{"when":{"type":"object","properties":{"representing":{"type":"array","items":{"type":"string"},"examples":[["seller","both"]]},"transaction_type":{"type":"array","items":{"type":"string"},"examples":[["Commercial sale","Commercial lease"]]},"status":{"type":"array","items":{"type":"string"},"examples":[["active","pending"]]}}},"always":{"type":"boolean","examples":[false]},"default":{"type":"object","description":"User that will be assigned to role by default","properties":{"id":{"type":"integer","examples":[123]},"type":{"type":"string","examples":["Contact"]}}}}}}}},"AccountUserFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["address"]},"label":{"type":"string","examples":["Address"]},"type":{"type":"string","enum":["text","dropdown","date","money"],"examples":["text"]},"requirements":{"type":"object","properties":{"always":{"type":"boolean","examples":[false]},"when":{"type":"object","properties":{"role":{"type":"string","examples":["Agent"]}}}}}}}},"ContactFields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["brand"]},"label":{"type":"string","examples":["Brand"]},"options":{"type":"array","items":{"type":"string"},"examples":[["Brand 1","Brand 2","Brand 3"]]},"type":{"type":"string","enum":["text","dropdown","date","money"]},"requirements":{"type":"object","properties":{"always":{"type":"boolean","examples":[false]},"when":{"type":"object","properties":{"contact_type":{"type":"string","examples":["Other"]}}}}}}}},"ContactTypes":{"type":"array","items":{"type":"string"},"examples":[["Agent","Broker","Lender"]]},"ContactLeadSources":{"type":"array","items":{"type":"string"},"examples":[["MLS","Referral","Sign call"]]},"DocumentRejectionReasons":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","examples":["Incomplete"]},"comment":{"type":"string","examples":["Document is incomplete"]}}}},"EmailTemplates":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["John Doe"]},"subject":{"type":"string","examples":["Need verification"]},"body":{"type":"string","examples":["Hi, please check the attached documents"]}}}},"Activity":{"allOf":[{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of event","examples":[1000]},"event_type":{"type":"string","description":"Event type [query parameter](#tag/ACTIVITIES)","examples":["checklist_added"]},"event_label":{"type":"string","description":"Event type value","examples":["checklist added"]},"change_list":{"type":["array","null"],"items":{"type":"object"},"description":"Changes that triggered the creation of the event. Dynamic field: the structure depends on event type","examples":[[{"property":"assigned_to_role","old_value":null,"new_value":"Transaction coordinator"}]]},"bm_transaction_id":{"type":["integer","null"],"description":"Identifier of transaction","examples":[1001]},"agent_onboarding_id":{"type":["integer","null"],"description":"Identifier of onboarding agent","examples":[1002]},"user_id":{"type":["integer","null"],"description":"Identifier of user","examples":[1003]},"account_id":{"type":"integer","description":"Identifier of account","examples":[1004]},"contact_id":{"type":["integer","null"],"description":"Identifier of contact","examples":[1005]},"content":{"type":"string","description":"Explanation of event, based on the type","examples":["created account \"Company ltd\""]},"comment":{"type":["string","null"],"description":"Body of user comment","examples":["Check those documents"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"document_id":{"type":["integer","null"],"description":"Identifier of document","examples":[1006]},"originator_id":{"type":"integer","description":"Identifier of event author","examples":[1007]},"originator_name":{"type":"string","description":"Name of event author","examples":["Mike White"]},"metadata":{"type":"object","description":"Dynamic field: the structure depends on event type"},"document":{"description":"Document structure for the document attached to the event. Null when the event is\nnot related to a document.\n","anyOf":[{"$ref":"#/components/schemas/Document"},{"type":"null"}]}}}]},"OnboardingChecklistTemplate":{"type":"object","properties":{"id":{"type":"integer","examples":[341]},"name":{"type":"string","examples":["Buying"]}}},"EsignRecipient":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer","description":"Contact ID when `type` is `contact`, user ID when `type` is `user`","examples":[5678]},"type":{"type":"string","enum":["contact","user"]}}},"EsignSigner":{"allOf":[{"$ref":"#/components/schemas/EsignRecipient"},{"type":"object","required":["role_identifier"],"properties":{"role_identifier":{"type":"string","description":"Identifier of the package role this person signs as","examples":["seller"]}}}]},"EsignRequest":{"type":"object","description":"E-signature request of a document","properties":{"status":{"type":"string","enum":["not sent","sent for signature","signed","canceled"],"examples":["sent for signature"]},"has_signatures":{"type":"boolean","description":"`true` when at least one signer has signed","examples":[false]},"canceled":{"type":"boolean","description":"`true` when the request is canceled. On a document with no active request, `true` when its last request was canceled","examples":[false]},"signers":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","examples":["signed"]},"role_identifier":{"type":"string","examples":["buyer_agent"]},"signer_role":{"type":"string","examples":["Buyer's Agent"]},"signer_name":{"type":"string","examples":["John Smith"]},"signer_email":{"type":"string","examples":["john.smith@example.com"]}}},"examples":[[{"status":"signed","role_identifier":"buyer_agent","signer_role":"Buyer's Agent","signer_name":"John Smith","signer_email":"john.smith@example.com"},{"status":"sent","role_identifier":"seller_agent","signer_role":"Seller's Agent","signer_name":"Jane Doe","signer_email":"jane.doe@example.com"}]]}}},"EsignError":{"type":"object","properties":{"error":{"type":"string","examples":["Cannot cancel eSign for document"]},"status":{"type":"integer","description":"HTTP status code of the response","examples":[400]}}},"Backup":{"type":"object","properties":{"id":{"type":"integer","examples":[3]},"link":{"type":"string","description":"Publicly accessible URL to transaction backup,\nwith 60 minutes expiration time.\n","examples":["https://s3-eu-central-1.amazonaws.com/bucket/folder/backup.zip"]},"completed_at":{"$ref":"#/components/schemas/dateStamp"},"file_name":{"type":"string","examples":["3998_Indiana_St,_Carlton,_MA,_90210.zip"]}}},"ParticipantOptions":{"type":"object","properties":{"preserve_existing_role":{"type":"boolean","description":"`false` (default): their existing role is changed to `role`; when they have several roles, only the oldest one is changed.\n`true`: their existing roles are kept and they are added with `role` as well, e.g. Listing agent and Buyer's agent.\nNo effect when the person is not on the transaction yet or already has `role`.","examples":[true]},"role":{"type":"string","description":"Person role in transaction. Required when the person is not on the transaction yet.\nWhen omitted for a person already on the transaction, their roles stay unchanged.","examples":["Agent"]},"owner":{"type":"boolean","description":"`true` makes the person the transaction owner. There could be only one owner, so the current owner loses ownership.\nEvery transaction task not assigned to a role is reassigned to the new owner.\n`false` or omitted leaves ownership unchanged; it does not remove ownership.","examples":[true]}}},"ParticipantUsersList":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/FullUserParticipant"},{"$ref":"#/components/schemas/ShortUserParticipant"}]}},"ParticipantContactsList":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/FullContactParticipant"},{"$ref":"#/components/schemas/ShortContactParticipant"}]}},"ShortParticipantsList":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ShortUserParticipant"},{"$ref":"#/components/schemas/ShortContactParticipant"}]}},"FullParticipantsList":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/FullUserParticipant"},{"$ref":"#/components/schemas/FullContactParticipant"}]}},"ParticipantExtension":{"type":"object","properties":{"owner":{"type":"boolean","description":"Indicates whether this person is the owner of transaction","examples":[false]},"role":{"type":"string","description":"role of this person in transaction","examples":["Agent"]}}},"ShortUserParticipant":{"allOf":[{"$ref":"#/components/schemas/ShortUser"},{"$ref":"#/components/schemas/ParticipantExtension"}]},"FullUserParticipant":{"allOf":[{"$ref":"#/components/schemas/FullUser"},{"$ref":"#/components/schemas/ParticipantExtension"}]},"ShortContactParticipant":{"allOf":[{"$ref":"#/components/schemas/ShortContact"},{"$ref":"#/components/schemas/ParticipantExtension"}]},"FullContactParticipant":{"allOf":[{"$ref":"#/components/schemas/FullContact"},{"$ref":"#/components/schemas/ParticipantExtension"}]},"ChecklistTemplateWithAutoapply":{"allOf":[{"$ref":"#/components/schemas/ChecklistTemplate"},{"type":"object","properties":{"autoapply_settings":{"type":"object","properties":{"requirements":{"type":"object","oneOf":[{"type":"object","properties":{"always":{"type":"boolean","enum":[true],"description":"If set, checklist will always be applied"}}},{"type":"object","properties":{"always":{"type":"boolean","enum":[false],"description":"If not set, \"when\" conditions will be applied. If \"when\" condition is not set the transaction will be matched on it by default."},"when":{"type":"object","properties":{"status":{"type":"array","items":{"type":"string"},"description":"Status condition"},"transaction_type":{"type":"array","items":{"type":"string"},"description":"Transaction type condition"},"property_type":{"type":"array","items":{"type":"string"},"description":"Property type condition"},"representing":{"type":"array","items":{"type":"string"},"description":"Representing condition"}},"additionalProperties":false}}}]}}}}}]},"RepresentingSide":{"type":"string","description":"which side the brokerage represents","enum":["seller","buyer","both"],"examples":["buyer"]},"TransactionStatusValue":{"type":"string","description":"transaction status","enum":["opportunity","active","pending","closed","cancelled"],"examples":["active"]},"TransactionOldStatus":{"type":"object","properties":{"status":{"type":"string","enum":["pre-listing","listing","pending","closed","cancelled"],"examples":["listing"]}}},"TransactionStatus":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/TransactionStatusValue"}}},"NewTransaction":{"type":"object","properties":{"external_id":{"type":"string","examples":["RT123-45"]},"address":{"type":"string","examples":["11332 Demo St"]},"city":{"type":"string","examples":["San Diego"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["92123"]},"transaction_name":{"type":"string","examples":["Johnson Family Home"]},"transaction_type":{"type":"string","description":"One of the account's transaction types - they differ per account; the defaults start with 'traditional sale', 'short sale', 'REO'","examples":["traditional sale"]},"price":{"type":"number","examples":[415000.42]},"acceptance_date":{"type":"integer","description":"13-digit unix timestamp (Expected without hours, minutes, or seconds. If included, these values will be cleared.)","examples":[1428278400000]},"expiration_date":{"type":"integer","description":"13-digit unix timestamp (Expected without hours, minutes, or seconds. If included, these values will be cleared.)","examples":[1530278400000]},"closing_date":{"type":"integer","description":"13-digit unix timestamp (Expected without hours, minutes, or seconds. If included, these values will be cleared.)","examples":[1443571200000]},"listing_date":{"type":"integer","description":"13-digit unix timestamp (Expected without hours, minutes, or seconds. If included, these values will be cleared.)","examples":[1400575080000]},"timezone":{"type":"integer","description":"transaction timezone in hours from UTC","examples":[-7]},"listing_side_representer":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"examples":[341]},"type":{"type":["string","null"],"enum":["Account","Contact",null]}}},"buying_side_representer":{"type":["object","null"],"properties":{"id":{"type":["integer","null"],"examples":[12]},"type":{"type":["string","null"],"enum":["Account","Contact",null]}}}}},"TransactionContacts":{"type":"object","properties":{"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","examples":[12]},"type":{"type":"string","examples":["user"]},"role":{"type":"string","examples":["Seller"]}}}}}},"Transaction":{"allOf":[{"$ref":"#/components/schemas/NewTransaction"},{"$ref":"#/components/schemas/TransactionContacts"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64"},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"representing":{"$ref":"#/components/schemas/RepresentingSide"},"sales_volume":{"type":"number","examples":[415000.42]},"total_gross_commission":{"type":"number","examples":[6000.42]},"commissions_finalized_at":{"type":"integer","description":"13-digit unix timestamp","examples":[1443571200000]},"closed_at":{"type":"integer","description":"13-digit unix timestamp","examples":[1450575080000]}}}]},"NewTransactionV1":{"allOf":[{"$ref":"#/components/schemas/NewTransaction"},{"$ref":"#/components/schemas/TransactionContacts"},{"$ref":"#/components/schemas/TransactionOldStatus"},{"type":"object","required":["address","city","state","zip","price","status","listing_side_representer","buying_side_representer"],"properties":{"custom_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["property_type"]},"label":{"type":"string","examples":["Property type"]},"type":{"type":"string","enum":["text","date","dropdown","money"],"examples":["dropdown"]},"value":{"type":"string","examples":["Duplex"]},"requirements":{"type":"object","properties":{"always":{"type":"boolean","examples":[false]},"when":{"type":"object","properties":{"status":{"type":"array","items":{"type":"string"},"examples":[["pending","closed"]]}}}}},"options":{"type":"array","description":"list of dropdown options, in case type is dropdown","items":{"type":"string"},"examples":[["Not specified","Single family","Duplex","Multi unit","Condo","Townhouse"]]},"required":{"deprecated":true,"type":"boolean","examples":[true]},"required_if_status":{"deprecated":true,"type":"string","examples":["pending"]}}}}}}]},"UpdateTransactionV1":{"allOf":[{"$ref":"#/components/schemas/NewTransaction"},{"$ref":"#/components/schemas/TransactionContacts"},{"$ref":"#/components/schemas/TransactionOldStatus"},{"type":"object","required":["id"],"properties":{"custom_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["property_type"]},"label":{"type":"string","examples":["Property type"]},"type":{"type":"string","enum":["text","date","dropdown","money"],"examples":["dropdown"]},"value":{"type":"string","examples":["Duplex"]},"requirements":{"type":"object","properties":{"always":{"type":"boolean","examples":[false]},"when":{"type":"object","properties":{"status":{"type":"array","items":{"type":"string"},"examples":[["pending","closed"]]}}}}},"options":{"type":"array","description":"list of dropdown options, in case type is dropdown","items":{"type":"string"},"examples":[["Not specified","Single family","Duplex","Multi unit","Condo","Townhouse"]]},"required":{"deprecated":true,"type":"boolean","examples":[true]},"required_if_status":{"deprecated":true,"type":"string","examples":["pending"]}}}}}}]},"TransactionV1":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"$ref":"#/components/schemas/UpdateTransactionV1"}]},"SearchTransaction":{"type":"object","properties":{"id":{"type":"integer","description":"transaction ID","examples":[2]},"address":{"type":"string","description":"transaction address","examples":["28687 Euna Stravenue"]},"city":{"type":"string","description":"transaction city","examples":["Darlenetown"]},"state":{"type":"string","description":"transaction state","examples":["NY"]},"zip":{"type":"string","description":"transaction zip","examples":["15040"]},"status_order":{"type":"integer","examples":[2]},"status":{"type":"string","description":"transaction status","examples":["closed"]},"representing":{"$ref":"#/components/schemas/RepresentingSide"},"price":{"type":"number","description":"transaction price","examples":[3495000]},"custom_id":{"type":"string","description":"transaction custom id","examples":["TR-2018-2"]},"transaction_name":{"type":"string","description":"Name for buyer opportunity","examples":["Johnson Family Home"]},"name":{"type":"string","description":"transaction owner name","examples":["Elmo Corwin"]},"email":{"type":"string","description":"transaction owner email","examples":["jadyn@bernhard.net"]},"role":{"type":"string","description":"transaction owner role","examples":["tc"]}}},"CustomAttributesV2":{"type":"object","properties":{"Property type":{"type":"string","x-mcp-schema-placeholder":true,"description":"Custom attribute \"Property Type\" (example, might not exist in the target account)","examples":["Duplex"]},"MLS #":{"type":"string","x-mcp-schema-placeholder":true,"description":"Custom attribute \"MLS #\" (example, might not exist in the target account)","examples":["IR28020198"]}}},"NewTransactionV2":{"allOf":[{"$ref":"#/components/schemas/NewTransaction"},{"$ref":"#/components/schemas/TransactionContacts"},{"$ref":"#/components/schemas/TransactionOldStatus"},{"$ref":"#/components/schemas/CustomAttributesV2"},{"type":"object","required":["address","city","state","zip","price","status","listing_side_representer","buying_side_representer"]}]},"UpdateTransactionV2":{"allOf":[{"$ref":"#/components/schemas/NewTransaction"},{"$ref":"#/components/schemas/TransactionContacts"},{"$ref":"#/components/schemas/CustomAttributesV2"},{"$ref":"#/components/schemas/TransactionOldStatus"},{"type":"object","properties":{"reopen_reason":{"type":"string","description":"Reopen reason. Required when changing from inactive status (`\"closed\"`, `\"cancelled\"`) to active status (`\"pre-listing\"`, `\"listing\"`, `\"pending\"`)"}}}]},"TransactionV2":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"$ref":"#/components/schemas/CustomAttributesV2"},{"$ref":"#/components/schemas/TransactionOldStatus"}]},"ShortTransaction":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"address":{"type":"string","examples":["11332 Demo St"]},"city":{"type":"string","examples":["San Diego"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["92123"]},"price":{"type":"number","examples":[415000.42]}}},"ShortTransactionV2":{"allOf":[{"$ref":"#/components/schemas/ShortTransaction"},{"$ref":"#/components/schemas/TransactionOldStatus"}]},"NewTransactionV3":{"allOf":[{"$ref":"#/components/schemas/NewTransaction"},{"$ref":"#/components/schemas/TransactionContacts"},{"$ref":"#/components/schemas/TransactionStatus"},{"$ref":"#/components/schemas/CustomAttributesV2"},{"type":"object","oneOf":[{"title":"Regular transaction","required":["address","city","state","zip","price","status","transaction_type","listing_side_representer","buying_side_representer"]},{"title":"Buyer opportunity","required":["transaction_name","status","transaction_type","listing_side_representer","buying_side_representer"],"properties":{"status":{"description":"When status is \"opportunity\" and you represents buying side, there are new required fields"},"transaction_name":{"type":"string","description":"Name for buyer opportunity"},"buyer_agreement_date":{"$ref":"#/components/schemas/dateStamp"},"buyer_expiration_date":{"$ref":"#/components/schemas/dateStamp"}}}]}]},"UpdateTransactionV3":{"allOf":[{"$ref":"#/components/schemas/NewTransaction"},{"$ref":"#/components/schemas/TransactionStatus"},{"$ref":"#/components/schemas/CustomAttributesV2"},{"type":"object","properties":{"reopen_reason":{"type":"string","description":"Reopen reason. Required when changing from inactive status (`\"closed\"`, `\"cancelled\"`) to active status (`\"opportunity\"`, `\"active\"`, `\"pending\"`)"},"buyer_agreement_date":{"$ref":"#/components/schemas/dateStamp"},"buyer_expiration_date":{"$ref":"#/components/schemas/dateStamp"},"apply_checklist_automation":{"$ref":"#/components/schemas/ApplyChecklistAutomation"}}}]},"ApplyChecklistAutomation":{"type":"string","enum":["force","strict"],"description":"Applies the account's checklist templates whose auto-apply settings match the transaction.\nChecklist tasks are assigned to transaction roles.\nOmit to apply none.\n- `force` - a task assigned to an absent role is re-assigned to the transaction owner\n- `strict` - if a matched checklist has a task assigned to an absent role, the request fails and nothing is saved\n"},"MissingChecklistRolesError":{"type":"object","properties":{"error":{"type":"string"},"status":{"type":"integer","examples":[400]},"data":{"type":"object","description":"Checklists that need roles the transaction does not have.","properties":{"error_type":{"type":"string","examples":["MissingChecklistRoles"]},"checklists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"missing_roles":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","examples":["Transaction Coordinator"]},"default":{"type":["object","null"],"description":"The account's default for the role, when it is an active user or an existing contact. Offer it to the user.","properties":{"type":{"type":"string","enum":["user","contact"]},"id":{"type":"integer"}}}}}}}}}}}}},"AppliedChecklists":{"type":"object","properties":{"applied_checklists":{"type":"array","description":"Present only when `apply_checklist_automation` was sent.","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}},"ShortTransactionV3":{"allOf":[{"$ref":"#/components/schemas/ShortTransaction"},{"$ref":"#/components/schemas/TransactionStatus"},{"type":"object","properties":{"transaction_name":{"type":"string","description":"Name for buyer opportunity"},"representing":{"$ref":"#/components/schemas/RepresentingSide"}}}]},"TransactionV3":{"allOf":[{"$ref":"#/components/schemas/Transaction"},{"$ref":"#/components/schemas/TransactionStatus"},{"$ref":"#/components/schemas/CustomAttributesV2"},{"type":"object","properties":{"transaction_name":{"type":"string","description":"Name for buyer opportunity"},"buyer_agreement_date":{"$ref":"#/components/schemas/dateStamp"},"buyer_expiration_date":{"$ref":"#/components/schemas/dateStamp"}}}]},"TransactionIncludes":{"type":"object","properties":{"commission_items":{"type":"array","items":{"$ref":"#/components/schemas/BaseCommissionItem"}},"participants":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/ShortUserParticipant"},{"$ref":"#/components/schemas/ShortContactParticipant"}]}}}},"DocumentWithPreviewUrl":{"allOf":[{"$ref":"#/components/schemas/Document"},{"type":"object","properties":{"preview_url":{"type":"string","description":"Publicly accessible URL to document preview image,\nwith 15 minutes expiration time.\n","examples":["https://s3-eu-central-1.amazonaws.com/BUCKET/FILE"]}}}]},"TransactionDocumentUploadUrl":{"type":"object","properties":{"upload_url":{"type":"string","examples":["https://example.com/upload_document?data=..."]}}},"TransactionEmailRecipient":{"type":"object","description":"User or contact of the account","required":["id","type"],"properties":{"id":{"type":"integer","description":"ID of user or contact"},"type":{"type":"string","enum":["user","contact"]}}},"FieldDescriptor":{"description":"Describes one field of an entity's \"current schema\" (buyer offers, transactions, users, contacts), built-in or account level custom.","type":"object","required":["uid","label","key","type"],"properties":{"uid":{"type":"string","description":"Opaque identifier of the field. Treat it as a random string even though it may look meaningful. Identify a field by its label, then reference it by its uid","examples":["address"]},"label":{"type":"string","description":"User visible field label. The only human-meaningful name of the field — match on it when looking a field up by name","examples":["Address"]},"key":{"type":"string","description":"Key under which the value is set in the response DTO.","examples":["address"]},"type":{"type":"string","description":"Value type of the field","enum":["text","date","dropdown","money","number","boolean","object"],"examples":["text"]},"readonly":{"type":"boolean","examples":[true]},"additional":{"type":"boolean","description":"Whether the field is an account level custom field (may not exists in other accounts) or always present.","examples":[true]},"requirements":{"type":"object","description":"Scenarios in which the field is required","properties":{"always":{"type":"boolean","description":"Field is always required","examples":[true]}}},"options":{"type":"array","description":"Allowed string options, for dropdown fields only","items":{"type":"string"},"examples":[["Option A","Option B"]]}}},"BuyerOfferBase":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/BuyerOfferStatus"},"address":{"type":"string","examples":["11332 Demo St"]},"city":{"type":"string","examples":["San Diego"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["92123"]},"price":{"type":"number","examples":[415000.52]},"financing":{"type":"string","enum":["Cash","Conventional mortgage","Hard money loan","FHA loan","USDA loan","VA loan","Non-conforming loan","Seller financing"],"examples":["Conventional mortgage"]},"transaction_type":{"type":"string","description":"One of the account's transaction types - they differ per account; the defaults start with 'traditional sale', 'short sale', 'REO'","examples":["traditional sale"]}}},"BuyerOfferDisplayNames":{"type":"object","properties":{"buyer_name":{"type":"string","description":"Name of the participant with role \"Buyer\" (derived, read-only)","examples":["John Doe"]},"owner_name":{"type":"string","description":"Name of the participant marked as owner (derived, read-only)","examples":["John Doe"]}}},"BuyerOfferResponse":{"allOf":[{"type":"object","properties":{"id":{"type":"integer","examples":[123]}}},{"$ref":"#/components/schemas/BuyerOfferBase"},{"$ref":"#/components/schemas/BuyerOfferDisplayNames"},{"type":"object","properties":{"buyer_opportunity_id":{"type":"integer","description":"Identifier of BoldTrail BackOffice transaction where the buyer offer is located","examples":[234]},"bm_transaction_id":{"type":"integer","description":"Identifier of associated BoldTrail BackOffice transaction. This represens the transaction that was created (sourced) from given buyer offer","examples":[111]},"closing_date":{"$ref":"#/components/schemas/dateStamp"},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"}}},{"$ref":"#/components/schemas/BuyerOfferAdditionalFields"}]},"BuyerOfferShortResponse":{"allOf":[{"type":"object","properties":{"id":{"type":"integer","examples":[123]}}},{"$ref":"#/components/schemas/BuyerOfferBase"},{"$ref":"#/components/schemas/BuyerOfferDisplayNames"},{"type":"object","properties":{"bm_transaction_id":{"type":"integer","description":"Identifier of associated BoldTrail BackOffice transaction","examples":[111]},"closing_date":{"$ref":"#/components/schemas/dateStamp"},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"}}}]},"BuyerOfferResponseWithParticipants":{"allOf":[{"$ref":"#/components/schemas/BuyerOfferResponse"},{"type":"object","properties":{"participants":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOfferParticipant"}}}}]},"NewBuyerOfferRequest":{"allOf":[{"type":"object","required":["buyer_opportunity_id","address","city","state","zip","price","financing"],"properties":{"buyer_opportunity_id":{"type":"integer","description":"The ID of the transaction where the buyer offer will be created"},"address":{"type":"string","examples":["11332 Demo St"]},"city":{"type":"string","examples":["San Diego"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["92123"]},"price":{"type":"number","examples":[415000.52]},"financing":{"type":"string","enum":["Cash","Conventional mortgage","Hard money loan","FHA loan","USDA loan","VA loan","Non-conforming loan","Seller financing"],"examples":["Conventional mortgage"]},"transaction_type":{"type":"string","description":"One of the account's transaction types - they differ per account; the defaults start with 'traditional sale', 'short sale', 'REO'","examples":["traditional sale"]},"participants":{"type":"array","items":{"type":"object","required":["participant_type","participant_id","role"],"properties":{"participant_type":{"type":"string","enum":["user","contact"]},"participant_id":{"type":"integer","description":"contact or user id\n","examples":[123]},"role":{"type":"string","description":"role of this person in the buyer offer","examples":["Agent"]},"owner":{"type":"boolean","description":"Indicates whether this person is the owner of the buyer offer","examples":[false]}}}}}},{"$ref":"#/components/schemas/BuyerOfferAdditionalFields"}]},"UpdateBuyerOfferRequest":{"allOf":[{"$ref":"#/components/schemas/BuyerOfferBase"},{"$ref":"#/components/schemas/BuyerOfferAdditionalFields"}]},"BuyerOfferParticipant":{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"participant_type":{"type":"string","enum":["user","contact"]},"participant_id":{"type":"integer","description":"contact or user id\n","examples":[123]},"role":{"type":"string","description":"role of this person in the buyer offer","examples":["Agent"]},"owner":{"type":"boolean","description":"Indicates whether this person is the owner of the buyer offer","examples":[false]},"first_name":{"type":"string","description":"full user name","examples":["Jonh"]},"last_name":{"type":"string","description":"full user name","examples":["Doe"]},"email":{"type":"string","description":"full user name","examples":["jonh.doe@example.com"]}}},"BuyerOfferParticipantRequestSchema":{"type":"object","required":["participant_type","participant_id","role","owner"],"properties":{"id":{"type":["integer","null"],"examples":[123],"description":"Set to `NULL` (or omit this field) for new participants"},"participant_type":{"type":"string","enum":["user","contact"]},"participant_id":{"type":"integer","description":"contact or user id\n","examples":[123]},"role":{"type":"string","description":"role of this person in the buyer offer","examples":["Agent"]},"owner":{"type":"boolean","description":"Indicates whether this person is the owner of the buyer offer","examples":[false]}}},"BuyerOfferStatus":{"type":"string","enum":["active","accepted","rejected","withdrawn"],"examples":["active"]},"BuyerOfferAdditionalFields":{"type":"object","additionalProperties":{"x-additionalPropertiesName":"\"field name\"","oneOf":[{"type":"string"},{"type":"integer"}],"description":"Custom buyer offer fields. For example:\n```\n{\n  ...\n  \"Legal description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\"\n}\n```\n"}},"BuyerOfferDocument":{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"bm_transaction_id":{"type":["integer","null"],"examples":[null]},"buyer_offer_id":{"type":"integer","examples":[123]},"task_id":{"type":"integer","examples":[123]},"name":{"type":"string","examples":["Agreement.pdf"]},"pages":{"type":"integer","examples":[12]},"review_status":{"type":"string","enum":["pending approval","approved","approved (not sent)","rejected","rejected (not sent)"],"examples":["pending approval"]},"upload_status":{"type":"string","enum":["processing","complete"],"examples":["complete"]},"content_type":{"type":"string","examples":["application/pdf"]},"has_package":{"type":"boolean","examples":[true]},"status":{"type":"string","examples":["ready"]},"url":{"type":"string","description":"Publicly accessible URL to uploaded document,\nwith 15 minutes expiration time.\n","examples":["https://s3-eu-central-1.amazonaws.com/BUCKET/FILE"]}}},"BuyerOfferDocumentWithPreviewUrl":{"allOf":[{"$ref":"#/components/schemas/BuyerOfferDocument"},{"type":"object","properties":{"preview_url":{"type":"string","description":"Publicly accessible URL to document preview image,\nwith 15 minutes expiration time.\n","examples":["https://s3-eu-central-1.amazonaws.com/BUCKET/FILE"]}}}]},"BuyerOfferDocumentWithUploadUrl":{"type":"object","properties":{"upload_url":{"type":"string","examples":["https://example.com/upload_document?data=..."]}}},"CoaAccount":{"type":"object","properties":{"id":{"type":"integer","examples":[3]},"number":{"type":"integer","examples":[100]},"name":{"type":"string","examples":["Accounts receivable"]},"type":{"type":"string","enum":["assets","liabilities","income","expenses","equity"],"examples":["assets"]},"group_id":{"type":"integer","examples":[1],"description":"See [/v1/accounting/chart_of_accounts/groups](#operation/getCoaGroups)"}}},"CoaGroup":{"type":"object","properties":{"id":{"type":"integer","examples":[1]},"name":{"type":"string","examples":["Accounts receivable"]},"type":{"type":"string","enum":["assets","liabilities","income","expenses","equity"],"examples":["assets"]}}},"Checklist":{"type":"object","properties":{"id":{"type":"integer","examples":[341]},"name":{"type":"string","examples":["Buying"]},"type":{"type":"string","examples":["Transactional"]}}},"TransactionChecklist":{"allOf":[{"$ref":"#/components/schemas/Checklist"},{"type":"object","properties":{"bm_transaction_id":{"type":"integer","examples":[1234]}}}]},"ChecklistTemplate":{"allOf":[{"$ref":"#/components/schemas/Checklist"},{"type":"object","properties":{"sort_order":{"type":"integer","examples":[0]},"depends_on":{"type":"object","properties":{"dates":{"type":"array","items":{"type":"string","examples":["acceptance_date"]}},"roles":{"type":"array","items":{"type":"string","examples":["broker"]}}}}}}]},"NewComment":{"type":"object","required":["body"],"properties":{"body":{"type":"string","description":"Comment text. To mention a user write `@[Full Name](user_\u003cuser_id\u003e)`, e.g. `@[John Doe](user_12)`, with the `user_id` taken from the transaction's user participants or the users list. Only this form emails the user; a plain `@Name` is stored as text and notifies nobody. To add a link write `[Title](https://\u003curl\u003e)`, e.g. `[Inspection report](https://example.com/report)`. Only `https://` URLs become links; any other target is shown as plain text.","examples":["Docs are uploaded, @[John Doe](user_12) please take a look at [the report](https://example.com/report)"]}}},"Comment":{"type":"object","properties":{"id":{"type":"integer","examples":[1]},"body":{"type":"string","examples":["This is a comment"]},"author_id":{"type":"integer","examples":[12]},"author_name":{"type":"string","examples":["John Doe"]},"subject_id":{"type":"integer","examples":[12]},"subject_type":{"type":"string","examples":["BmTransaction"]},"created_at":{"type":"integer","description":"13-digit unix timestamp","examples":[1761497719747]},"updated_at":{"type":"integer","description":"13-digit unix timestamp","examples":[1761497719747]},"mention_refs":{"type":"array","description":"List of users mentioned in the comment","items":{"type":"object","properties":{"id":{"type":"integer","examples":[12]},"name":{"type":"string","examples":["John Doe"]},"type":{"type":"string","examples":["user"],"enum":["user","contact"]}}}}}},"CommissionInfo":{"type":"object","properties":{"version":{"type":"integer","examples":[10]},"status":{"type":"string","examples":["finalized"],"enum":["not finalized","finalized"]},"finalized_at":{"$ref":"#/components/schemas/dateStamp"}}},"CommissionPlan":{"type":"object","properties":{"id":{"type":"integer","examples":[3]},"name":{"type":"string","examples":["Sample Commission Plan"]}}},"CommissionPlanWithItems":{"allOf":[{"$ref":"#/components/schemas/CommissionPlan"},{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/BaseCommissionItem"},{"type":"object","properties":{"calculation":{"type":"string","enum":["Simple","SlidingScale"],"examples":["Simple"]},"calculation_metadata":{"type":"object"}}}]}}}}]},"BaseCommissionItem":{"type":"object","properties":{"id":{"type":"integer","examples":[22890084]},"name":{"type":"string","examples":["Agent Split"]},"item_type":{"type":"string","examples":["split"]},"payer_id":{"type":"integer","examples":[6014]},"payer_type":{"type":"string","enum":["Account","User","Contact"],"examples":["Account"]},"payee_id":{"type":"integer","examples":[26372]},"payee_type":{"type":"string","enum":["Account","User","Contact"],"examples":["User"]},"sliding_base":{"type":"string","examples":["gross commission"]},"sliding_base_period":{"type":"string","examples":["custom range"]},"custom_sliding_base_period":{"type":"array","items":{"$ref":"#/components/schemas/dateStamp"},"examples":[[1575928800000,1577743200000]]},"sliding_base_amount":{"type":"number","examples":[5000.42]},"sliding_base_accrued_by":{"type":"string","examples":["agent"]},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/CommissionItemTier"}},"minimum_dollar_amount":{"type":"number","examples":[50.42]},"maximum_dollar_amount":{"type":"number","examples":[100.42]},"pay_to":{"type":"object","properties":{"name":{"type":"string","examples":["Rental Corp"]},"address":{"type":"string","examples":["Main Street 12"]},"city":{"type":"string","examples":["Genova"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["92210-2344"]}}},"tags":{"type":"array","items":{"type":"string"},"examples":[["agent split"]]}}},"CommissionItem":{"allOf":[{"$ref":"#/components/schemas/BaseCommissionItem"},{"type":"object","properties":{"side":{"type":"string","enum":["listing","buying"],"examples":["listing"]},"payer_name":{"type":"string","examples":["Brokerage Corp"]},"payee_name":{"type":"string","examples":["Agent Blue"]},"payee_first_name":{"type":"string","examples":["Agent"]},"payee_last_name":{"type":"string","examples":["Blue"]},"payee_company":{"type":"string","examples":["Agent's Corp"]},"calculated_dollar_amount":{"type":"number","examples":[50.42]},"prorated_according_to":{"type":"string","examples":["award allocation"]},"applied_plan":{"type":"string","examples":["The Agent Plan"]}}}]},"CommissionItemTier":{"type":"object","properties":{"id":{"type":"integer","examples":[7329124]},"commission_item_id":{"type":"integer","examples":[22890084]},"low_limit":{"type":"number","examples":[10]},"value":{"type":"number","examples":[10]},"uom":{"type":"string","examples":["% of price sold"]}}},"NewShortContact":{"type":"object","anyOf":[{"required":["email"]},{"required":["first_name","last_name"]}],"properties":{"email":{"type":"string","format":"email","examples":["test@example.com"]},"first_name":{"type":"string","examples":["Jonh"]},"last_name":{"type":"string","examples":["Doe"]},"contact_type":{"type":"string","description":"Contact's role, like Escrow Officer, Selling Agent etc.","examples":["client"]}}},"NewFullContact":{"allOf":[{"$ref":"#/components/schemas/NewShortContact"},{"type":"object","properties":{"external_id":{"type":"string","description":"external identifier passed during user creation,\nthis value available through users API only,\nusers can be filtered by this field to see whether such user already exists\n","examples":["crm1234"]},"company":{"type":"string","examples":["OCP CORP"]},"address":{"type":"string","examples":["Private 14 W Lambert Road 377"]},"city":{"type":"string","examples":["La Habra"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["90631"]},"phone":{"type":"string","examples":["123-456-7890"]},"mobile_phone":{"type":"string","examples":["123-456-7890"]},"fax":{"type":"string","examples":["123-456-7890"]},"private":{"type":"boolean","examples":[false]},"lead_source":{"type":"string","examples":["Referral"]},"assignee_id":{"type":"integer","description":"Optional account_user ID of the user the contact is assigned to"},"custom_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","examples":["property_type"]},"label":{"type":"string","examples":["Property type"]},"type":{"type":"string","enum":["text","date","dropdown","money"],"examples":["dropdown"]},"options":{"type":"array","description":"list of dropdown options, in case type is dropdown","items":{"type":"string"},"examples":[["Not specified","Single family","Duplex"]]},"value":{"type":"string","examples":["Duplex"]}}}}}}]},"ShortContact":{"allOf":[{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"contact_id":{"type":"integer","description":"the ID of the contact, matches with ID,\nneeded for mixed responses when contacts and users returned wthin one list\n","examples":[123]},"type":{"type":"string","description":"entity type, always set to \"contact\"","examples":["contact"]},"name":{"type":"string","description":"full contact name","examples":["Jonh Doe"]}}},{"$ref":"#/components/schemas/NewShortContact"}]},"FullContact":{"allOf":[{"$ref":"#/components/schemas/ShortContact"},{"$ref":"#/components/schemas/NewFullContact"},{"type":"object","properties":{"role":{"type":"string","description":"contact role, the same as contact type,\nfor the cases when contacts participate transaction,\nrole will be the contact's role in transaction\n","examples":["client"]},"created_by":{"type":"integer","description":"account_user ID of the user who created the contact","examples":[123]},"creator_name":{"type":"string","description":"Name of user who created contact","examples":["John Doe"]},"comments":{"type":"array","items":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/dateStamp"},"text":{"type":"string","examples":["the comment text"]},"author":{"type":"string","examples":["John Doe"]}}}},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"}}}]},"ContactWritableFieldsV2":{"type":"object","properties":{"external_id":{"type":"string","description":"external identifier for the contact; used to match on subsequent syncs","examples":["crm1234"]},"company":{"type":"string","examples":["OCP CORP"]},"address":{"type":"string","examples":["Private 14 W Lambert Road 377"]},"city":{"type":"string","examples":["La Habra"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["90631"]},"phone":{"type":"string","examples":["123-456-7890"]},"mobile_phone":{"type":"string","examples":["123-456-7890"]},"fax":{"type":"string","examples":["123-456-7890"]},"private":{"type":"boolean","examples":[false]},"lead_source":{"type":"string","examples":["Referral"]},"assignee_id":{"type":"integer","description":"Optional user ID of the user the contact is assigned to"}}},"CustomAttributesContactsV2":{"type":"object","properties":{"Age":{"type":"string","x-mcp-schema-placeholder":true,"description":"Custom contact field \"Age\" (example, might not exist in the target account)","examples":["35"]},"Property type":{"type":"string","x-mcp-schema-placeholder":true,"description":"Custom contact field \"Property type\" (example, might not exist in the target account)","examples":["Duplex"]}}},"NewFullContactV2":{"allOf":[{"$ref":"#/components/schemas/NewShortContact"},{"$ref":"#/components/schemas/ContactWritableFieldsV2"},{"$ref":"#/components/schemas/CustomAttributesContactsV2"}]},"NewContactV2":{"allOf":[{"$ref":"#/components/schemas/NewFullContactV2"},{"type":"object","required":["first_name","last_name"]}]},"FullContactV2":{"allOf":[{"$ref":"#/components/schemas/ShortContact"},{"$ref":"#/components/schemas/ContactWritableFieldsV2"},{"$ref":"#/components/schemas/CustomAttributesContactsV2"},{"type":"object","description":"In v2 the account custom fields are merged flat onto the top level of the response (one key per field, keyed by the field label) rather than nested under `custom_attributes`; call `Get current contacts schema` to learn which labels an account returns.","properties":{"role":{"type":"string","description":"contact role, the same as contact type","examples":["client"]},"created_by":{"type":"integer","description":"User ID of the user who created the contact","examples":[123]},"creator_name":{"type":"string","description":"Name of user who created contact","examples":["John Doe"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"}}}]},"BulkContactV2":{"allOf":[{"$ref":"#/components/schemas/NewContactV2"},{"type":"object","required":["external_id"]}]},"BulkContactsRequestV2":{"type":"object","required":["contacts"],"properties":{"import_tag":{"type":"string","maxLength":64,"description":"Optional free-form label for one import run. It is recorded on the bulk audit event, so every record touched by the run can be found again later. Use the same tag across every request and every entity type of one import.","examples":["acme-onboarding-2026-09"]},"contacts":{"type":"array","maxItems":250,"description":"Up to 250 contacts. An empty array succeeds and does nothing.","items":{"$ref":"#/components/schemas/BulkContactV2"}}}},"BulkContactsResponseV2":{"type":"object","properties":{"records":{"type":"array","description":"The records that were written.","items":{"type":"object","properties":{"status":{"type":"string","enum":["created","updated"],"examples":["created"]},"id":{"type":"integer","description":"BoldTrail BackOffice ID of the contact","examples":[4711]},"external_id":{"type":"string","examples":["crm-9"]}}}},"errors":{"type":"array","description":"The records that failed.","items":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"The `external_id` of the failed record. Null only when the record did not carry one, which is itself an error.","examples":["crm-7"]},"error":{"type":"string","examples":["Email can't be empty"]}}}},"status":{"type":"string","description":"`error` when `errors` is non-empty, `ok` otherwise.","enum":["ok","error"],"examples":["error"]}}},"Document":{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"bm_transaction_id":{"type":"integer","examples":[12]},"buyer_offer_id":{"type":["integer","null"],"examples":[null]},"task_id":{"type":"integer","examples":[123]},"name":{"type":"string","examples":["Listing agreement.pdf"]},"pages":{"type":"integer","examples":[12]},"content_type":{"type":"string","examples":["application/pdf"]},"has_package":{"type":"boolean","examples":[true]},"review_status":{"type":["string","null"],"enum":["pending approval","approved","approved (not sent)","rejected","rejected (not sent)","pending approval (2nd level)","approved (2nd level)","approved (not sent, 2nd level)","rejected (2nd level)","rejected (not sent, 2nd level)",null],"examples":["approved"]},"upload_status":{"type":"string","enum":["processing","complete"],"examples":["complete"]},"status":{"type":"string","examples":["rendering"]},"url":{"type":"string","description":"Publicly accessible URL to uploaded document,\nwith 15 minutes expiration time.\n","examples":["https://s3-eu-central-1.amazonaws.com/BUCKET/FILE"]},"esign":{"anyOf":[{"$ref":"#/components/schemas/EsignRequest"},{"type":"null"}]},"pages_sizes":{"type":"array","description":"Sizes of the document pages, in the page order.\nReturned only when requested with `include=pages_sizes`.\n","items":{"type":"object","properties":{"width":{"type":"number","examples":[612]},"height":{"type":"number","examples":[792]}}},"examples":[[{"width":612,"height":792}]]}}},"Invoice":{"type":"object","properties":{"id":{"type":"integer","examples":[3]},"type":{"type":"string","enum":["invoice"],"examples":["invoice"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"invoice_number":{"type":"integer","examples":[1001]},"invoice_date":{"$ref":"#/components/schemas/dateStamp"},"due_date":{"$ref":"#/components/schemas/dateStamp"},"balance_due":{"type":"number","examples":[20.42]},"balance_total":{"type":"number","examples":[50.42]},"balance_subtotal":{"type":"number","examples":[50.42]},"issued_to_ref":{"$ref":"#/components/schemas/ContactUserRef"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceLineItem"}},"applied_payments":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPayment"}},"applied_nettings":{"type":"array","items":{"$ref":"#/components/schemas/AppliedNetting"}},"tax_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTaxItem"}}}},"InvoiceLineItem":{"type":"object","properties":{"memo":{"type":"string","examples":["memo memo"]},"price":{"type":"number","examples":[50]},"total":{"type":"number","examples":[50]},"quantity":{"type":"number","examples":[1]},"ar_account_id":{"type":"integer","examples":[1]},"income_account_id":{"type":"integer","examples":[2]},"tax_code_name":{"type":"string","examples":["GST"]}}},"Bill":{"type":"object","properties":{"id":{"type":"integer","examples":[4]},"type":{"type":"string","enum":["bill"],"examples":["bill"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"bill_number":{"type":"string","examples":["B1001"]},"bill_date":{"$ref":"#/components/schemas/dateStamp"},"due_date":{"$ref":"#/components/schemas/dateStamp"},"balance_due":{"type":"number","examples":[50.42]},"balance_total":{"type":"number","examples":[50.42]},"payee_ref":{"$ref":"#/components/schemas/ContactUserRef"},"line_items":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string","examples":["memo memo"]},"price":{"type":"number","examples":[50]},"total":{"type":"number","examples":[50]},"quantity":{"type":"number","examples":[1]},"ap_account_id":{"type":"integer","examples":[2]},"expenses_account_id":{"type":"integer","examples":[4]},"tax_code_name":{"type":"string","examples":["GST"]}}}},"applied_payments":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPayment"}},"applied_nettings":{"type":"array","items":{"$ref":"#/components/schemas/AppliedNetting"}},"tax_items":{"type":"array","items":{"$ref":"#/components/schemas/BillTaxItem"}}}},"ReceivedPayment":{"type":"object","properties":{"id":{"type":"integer","examples":[5]},"type":{"type":"string","enum":["received_payment"],"examples":["received_payment"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"assets_account_id":{"type":"integer","examples":[3]},"ref_number":{"type":"string","examples":["REF0001"]},"payment_date":{"$ref":"#/components/schemas/dateStamp"},"payment_method":{"type":"string","examples":["Credit card"]},"amount_total":{"type":"number","examples":[50.42]},"amount_unapplied":{"type":"number","examples":[50.42]},"payer_ref":{"$ref":"#/components/schemas/ContactUserRef"},"status":{"type":"string","enum":["processed","pending","failed"],"examples":["processed"]},"applied_credits":{"type":"array","items":{"$ref":"#/components/schemas/AppliedCredits"}},"covered_invoices":{"type":"array","items":{"$ref":"#/components/schemas/CoveredInvoice"}}}},"MadePayment":{"type":"object","properties":{"id":{"type":"integer","examples":[6]},"type":{"type":"string","enum":["made_payment"],"examples":["made_payment"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"assets_account_id":{"type":"integer","examples":[3]},"ref_number":{"type":"string","examples":["REF0001"]},"payment_date":{"$ref":"#/components/schemas/dateStamp"},"payment_method":{"type":"string","examples":["Credit card"]},"amount_total":{"type":"number","examples":[50.42]},"amount_unapplied":{"type":"number","examples":[50.42]},"payee_ref":{"$ref":"#/components/schemas/ContactUserRef"},"status":{"type":"string","enum":["processed","pending","failed"],"examples":["processed"]},"covered_bills":{"type":"array","items":{"$ref":"#/components/schemas/CoveredBill"}}}},"JournalEntry":{"type":"object","properties":{"id":{"type":"integer","examples":[7]},"type":{"type":"string","enum":["journal_entry"],"examples":["journal_entry"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"entry_date":{"$ref":"#/components/schemas/dateStamp"},"ref_number":{"type":"string","examples":["ABS123"]},"notes":{"type":"string","examples":["Journal entry note"]},"line_items":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","examples":[50]},"entry_type":{"type":"string","enum":["debit","credit"],"examples":["debit"]},"memo":{"type":"string","examples":["memo memo"]},"coa_account_id":{"type":"integer","examples":[1]},"coa_account_name":{"type":"string","examples":["100 · Accounts receivable (A/R)"]},"party_ref":{"$ref":"#/components/schemas/ContactUserRef"}}}}}},"CreditMemo":{"type":"object","properties":{"id":{"type":"integer","examples":[8]},"type":{"type":"string","enum":["credit_memo"],"examples":["credit_memo"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"credit_memo_number":{"type":"integer","examples":[1001]},"credit_memo_date":{"$ref":"#/components/schemas/dateStamp"},"amount_total":{"type":"number","examples":[50.42]},"amount_to_credit":{"type":"number","examples":[20.42]},"issued_to_ref":{"$ref":"#/components/schemas/ContactUserRef"},"line_items":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string","examples":["memo memo"]},"price":{"type":"number","examples":[50]},"quantity":{"type":"number","examples":[1]},"total":{"type":"number","examples":[50]},"ar_account_id":{"type":"integer","examples":[1]},"income_account_id":{"type":"integer","examples":[2]},"tax_code_name":{"type":"string","examples":["GST"]}}}},"applied_payments":{"type":"array","items":{"$ref":"#/components/schemas/AppliedPayment"}},"tax_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceTaxItem"}}}},"Deposit":{"type":"object","properties":{"id":{"type":"integer","examples":[9]},"type":{"type":"string","enum":["deposit"],"examples":["deposit"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"deposit_date":{"$ref":"#/components/schemas/dateStamp"},"amount_total":{"type":"number","examples":[50.42]},"deposited_to_account_id":{"type":"integer","examples":[123]},"line_items":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","examples":[50]},"entry_type":{"type":"string","enum":["debit","credit"],"examples":["debit"]},"memo":{"type":"string","examples":["memo memo"]},"coa_account_id":{"type":"integer","examples":[1]},"coa_account_name":{"type":"string","examples":["100 · Accounts receivable (A/R)"]},"party_ref":{"$ref":"#/components/schemas/ContactUserRef"},"payment_method":{"type":"string","examples":["ACH"]},"ref_number":{"type":"string","examples":["ABS123"]},"tax_code_name":{"type":"string","examples":["GST"]}}}},"tax_items":{"type":"array","items":{"$ref":"#/components/schemas/DepositTaxItem"}}}},"Refund":{"type":"object","properties":{"id":{"type":"integer","examples":[10]},"type":{"type":"string","enum":["refund"],"examples":["refund"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"refund_number":{"type":"integer","examples":[1001]},"refund_date":{"$ref":"#/components/schemas/dateStamp"},"amount_total":{"type":"number","examples":[50.42]},"payment_method":{"type":"string","examples":["Credit card"]},"issued_from_account_id":{"type":"integer","examples":[123]},"issued_to_ref":{"$ref":"#/components/schemas/ContactUserRef"},"line_items":{"type":"array","items":{"type":"object","properties":{"memo":{"type":"string","examples":["memo memo"]},"price":{"type":"number","examples":[50]},"quantity":{"type":"number","examples":[1]},"total":{"type":"number","examples":[50]},"coa_account_id":{"type":"integer","examples":[1]},"tax_code_name":{"type":"string","examples":["GST"]}}}},"tax_items":{"type":"array","items":{"$ref":"#/components/schemas/RefundTaxItem"}}}},"Transfer":{"type":"object","properties":{"id":{"type":"integer","examples":[11]},"type":{"type":"string","enum":["transfer"],"examples":["transfer"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"transfer_date":{"$ref":"#/components/schemas/dateStamp"},"transferred_from_account_id":{"type":"integer","examples":[123]},"transferred_to_account_id":{"type":"integer","examples":[124]},"amount":{"type":"number","examples":[50.42]},"memo":{"type":"string","examples":["Money transfer"]}}},"BalanceNetting":{"type":"object","properties":{"id":{"type":"integer","examples":[12]},"type":{"type":"string","enum":["balance_netting"],"examples":["balance_netting"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"bm_transaction_id":{"type":"integer","examples":[123]},"assets_account_id":{"type":"integer","examples":[123]},"ref_number":{"type":"string","examples":["BN-1"]},"balance_netting_date":{"$ref":"#/components/schemas/dateStamp"},"party_ref":{"$ref":"#/components/schemas/ContactUserRef"},"covered_bills":{"type":"array","items":{"$ref":"#/components/schemas/CoveredBill"}},"covered_invoices":{"type":"array","items":{"$ref":"#/components/schemas/CoveredInvoice"}}}},"ContactUserRef":{"type":"object","properties":{"id":{"type":"integer","examples":[3]},"type":{"type":"string","enum":["contact","user"],"examples":["contact"]}}},"AppliedPayment":{"type":"object","properties":{"applied_amount":{"type":"number","examples":[30.42]},"payment":{"type":"object","properties":{"id":{"type":"integer","examples":[5]}}}}},"AppliedNetting":{"type":"object","properties":{"applied_amount":{"type":"number","examples":[30.42]},"payment":{"type":"object","properties":{"id":{"type":"integer","examples":[5]}}}}},"AppliedCredits":{"type":"object","properties":{"applied_amount":{"type":"number","examples":[30.42]},"credit_memo":{"type":"object","properties":{"id":{"type":"integer","examples":[9]}}}}},"CoveredInvoice":{"type":"object","properties":{"applied_amount":{"type":"number","examples":[30.42]},"invoice":{"type":"object","properties":{"id":{"type":"integer","examples":[5]}}}}},"CoveredBill":{"type":"object","properties":{"applied_amount":{"type":"number","examples":[30.42]},"bill":{"type":"object","properties":{"id":{"type":"integer","examples":[5]}}}}},"BillTaxItem":{"type":"object","properties":{"amount":{"type":"number","examples":[30.42]},"tax_rate_name":{"type":"string","examples":["GST"]},"tax_rate_value":{"type":"number","examples":[5.42]},"ap_account_id":{"type":"integer","examples":[1]}}},"InvoiceTaxItem":{"type":"object","properties":{"amount":{"type":"number","examples":[30.42]},"tax_rate_name":{"type":"string","examples":["GST"]},"tax_rate_value":{"type":"number","examples":[5.42]},"ar_account_id":{"type":"integer","examples":[1]}}},"DepositTaxItem":{"type":"object","properties":{"amount":{"type":"number","examples":[30.42]},"tax_rate_name":{"type":"string","examples":["GST"]},"tax_rate_value":{"type":"number","examples":[5.42]},"party_ref":{"$ref":"#/components/schemas/ContactUserRef"}}},"RefundTaxItem":{"type":"object","properties":{"amount":{"type":"number","examples":[30.42]},"tax_rate_name":{"type":"string","examples":["GST"]},"tax_rate_value":{"type":"number","examples":[5.42]}}},"DeletedLedgerTransaction":{"properties":{"id":{"type":"number","examples":[123]},"deleted_at":{"$ref":"#/components/schemas/dateStamp"},"type":{"type":"string","enum":["bill","invoice","journal_entry","made_payment","received_payment","credit_memo","deposit","transfer","refund","balance_netting"],"examples":["invoice"]}}},"IncomingTransaction":{"allOf":[{"$ref":"#/components/schemas/ShortIncomingTransaction"},{"type":"object","properties":{"transaction_data":{"allOf":[{"$ref":"#/components/schemas/CreatedIncomingTransaction"}]},"latest_accepted_data":{"allOf":[{"$ref":"#/components/schemas/CreatedIncomingTransaction"}]}}}]},"ShortIncomingTransaction":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"BoldTrail BackOffice identifier of incoming transaction","examples":[123]},"external_id":{"type":"string","description":"External identifier of incoming transaction","examples":["SF098323"]},"source_id":{"type":"string","description":"The name of CRM or other systems that is sourced for the incoming transaction","examples":["salesforce.com"]},"bm_transaction_id":{"type":"integer","description":"Identifier of associated BoldTrail BackOffice transaction","examples":[111]},"status":{"type":"string","enum":["new","accepted","discarded","unverified"],"examples":["new"]},"account_id":{"type":"integer","description":"BoldTrail BackOffice account identifier","examples":[433]},"created_by_id":{"type":"integer","description":"Identifier of BoldTrail BackOffice user, used for an API request to create the incoming transaction","examples":[344]},"created_at":{"type":"integer","description":"13-digit unix timestamp","examples":[1428278400000]},"updated_at":{"type":"integer","description":"13-digit unix timestamp","examples":[1428278400000]},"agent_id":{"type":"string","description":"External identifier of the agent, owner of the incoming transaction","examples":["111"]},"agent_name":{"type":"string","description":"Name of external agent","examples":["Mike Brown"]},"assigned_to_id":{"type":"integer","description":"Identifier of BoldTrail BackOffice user, assigned as the owner of the incoming transaction","examples":[443]}}},"CreatedIncomingTransaction":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"original entity ID  in the source system.\nthis value available through transaction API only,\ntransactions can be filtered by this field to see whether such transaction already exists\n","examples":["SF098323"]},"agent_id":{"type":"string","description":"external ID of assigned agent\n","examples":["crm987"]},"agent_name":{"type":"string","examples":["John Doe"]},"address":{"type":"string","examples":["11332 Demo St"]},"city":{"type":"string","examples":["San Diego"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["92123"]},"status":{"type":"string","enum":["listing","pending","closed","cancelled"],"examples":["listing"]},"transaction_type":{"type":"string","examples":["traditional sale"]},"price":{"type":"number","examples":[415000.42]},"representing":{"type":"string","enum":["seller","buyer","both"],"examples":["buyer"]},"acceptance_date":{"type":"integer","description":"13-digit unix timestamp","examples":[1428278400000]},"expiration_date":{"type":"integer","description":"13-digit unix timestamp","examples":[1530278400000]},"closed_at":{"type":"integer","description":"13-digit unix timestamp","examples":[1450575080000]},"closing_date":{"type":"integer","description":"13-digit unix timestamp","examples":[1443571200000]},"listing_date":{"type":"integer","description":"13-digit unix timestamp","examples":[1400575080000]},"total_gross_commission":{"type":"number","examples":[6000.42]},"custom_attributes":{"type":"object","description":"Below are your transaction's custom fields\nthey depends on your Account settings\n","properties":{"MLS #":{"type":"string","examples":["A10145294"]},"Lockbox":{"type":"string","examples":["Yes"]},"Total baths":{"type":"string","examples":["2"]},"Legal description":{"type":"string","examples":["SLAND MANOR CONDO - SOUTH TOWER UNIT 6-A"]}}}}},"Offer":{"type":"object","required":["price"],"properties":{"id":{"type":"string","examples":["d48c68cfca"]},"status":{"type":"string","enum":["received","approved","rejected"],"examples":["received"]},"bm_transaction_id":{"type":"integer","format":"int64","examples":[1234]},"price":{"type":"number","examples":[415000.42]},"prequalified":{"type":"boolean","examples":[true]},"earnest_money":{"type":"number","examples":[1000.42]},"loan_type":{"type":"string","enum":["Cash","Conventional","Hard money","VA","FHA","Other"],"examples":["Cash"]},"lender":{"type":"string","examples":["Lender Name"]},"notes":{"type":"string","examples":["Offer notes text"]},"contingencies":{"type":"string","examples":["Offer contingencies text"]},"buyer_first_name":{"type":"string","examples":["John"]},"buyer_last_name":{"type":"string","examples":["Doe"]},"buyer_email":{"type":"string","format":"email","examples":["sample@email.com"]},"buyer_phone":{"type":"string","examples":["619-433-6789"]},"buyer_company":{"type":"string","examples":["Buyer CO"]},"agent_name":{"type":"string","examples":["Mike Kush"]},"agent_company":{"type":"string","examples":["Buyer Agent Co"]},"agent_email":{"type":"string","format":"email","examples":["sample@email.com"]},"agent_phone":{"type":"string","examples":["619-433-6789"]},"agent_fax":{"type":"string","examples":["619-433-6789"]},"offer_link":{"type":"string","examples":["https://my.brokermint.com/offers/d48c68cfca"]},"comments":{"type":"array","items":{"type":"object","properties":{"created_at":{"$ref":"#/components/schemas/dateStamp"},"text":{"type":"string","examples":["The comment text"]},"created_by":{"type":"string","examples":["John Doe"]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/OfferAttachment"}}}}},"amendments":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","examples":["counter offer"]},"created_at":{"$ref":"#/components/schemas/dateStamp"},"text":{"type":"string","examples":["The amendment text"]},"created_by":{"type":"string","examples":["John Doe"]},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/OfferAttachment"}}}}},"offer_documents":{"type":"array","items":{"$ref":"#/components/schemas/OfferAttachment"}},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"}}},"OfferAttachment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","examples":[793]},"name":{"type":"string","examples":["Document.pdf"]},"content_type":{"type":"string","examples":["application/pdf"]},"pages":{"type":"integer","examples":[3]},"manageable":{"type":"boolean","examples":[true]},"path":{"type":"string","examples":["docs/account_000/transaction_unsorted_data/2020-08-05 18-11-46.980/141f4f51308762e7566c.pdf"]},"size":{"type":"integer","examples":[7945]}}},"OfferAttachmentDownload":{"description":"Shape returned by fetching a single offer attachment (a presigned download link),\ndistinct from OfferAttachment's shape when embedded in an offer's\ncomments/amendments/offer_documents.\n","type":"object","properties":{"id":{"type":"integer","format":"int64","examples":[793]},"name":{"type":"string","examples":["Document.pdf"]},"url":{"type":"string","description":"Publicly accessible URL to the attachment, with 15 minutes expiration time.\n","examples":["https://s3-eu-central-1.amazonaws.com/BUCKET/FILE"]}}},"ReportEntry":{"type":"object","properties":{"id":{"type":"integer","examples":[10]},"name":{"type":"string","description":"The report name","examples":["Agent profile"]},"version":{"type":"integer","description":"Report generation version \u003cbr/\u003e\n1 - prebuilt report, created by BoldTrail BackOffice \u003cbr/\u003e\n2 - custom report created by user\n","enum":[1,2],"examples":[1]},"report_type":{"type":"string","description":"Depending on the version \u003cbr/\u003e\nit can be report identifier for v1 reports used to reference reports in API V1\nor \u003cbr/\u003e\ntype of the base report, like Transaction or Agents for v2 custom reports.\n","examples":["agents_profile"]},"include_all_locations":{"type":"boolean","description":"Specifies whether this report will include data from sub-accounts if there are any"}}},"ReportFilter":{"type":"object","properties":{"field":{"type":"string","description":"name of the filtered report field","examples":["representing"]},"type":{"type":"string","description":"type of the field, like text or date","enum":["text","date"],"examples":["text"]},"multiple":{"type":"boolean","description":"whether the filter takes several comma separated values","examples":[false]},"available_options":{"type":["array","null"],"description":"list of available filter values, that can be supplied to filter, `null` when any value is accepted","items":{"type":"string"},"examples":[["buyer","seller","both"]]}}},"ReportData":{"type":"object","description":"Sample report data","properties":{"transaction_id":{"type":"string","examples":[365467]},"account_id":{"type":"string","examples":[6014]},"full_address":{"type":"string","examples":["20946 E Canyon Ridge Lane, Walnut, CA 91789"]},"owner_name":{"type":"string","examples":["John Doe"]},"status":{"type":"string","examples":["active"]},"price":{"type":"string","examples":[2900]}}},"ReportFilterV1":{"type":"object","properties":{"column":{"type":"string","examples":["expiration_date"]},"type":{"type":"string","description":"type of the field, like text or date","enum":["text","date"],"examples":["date"]},"dynamic":{"type":"string","description":"marks filter as the client side only,\nfeel free to ignore dynamic filters\n","examples":[false]},"comparison":{"type":"string","description":"type of filter comparison","examples":["range"]},"options":{"type":"array","items":{"type":"object","properties":{"val":{"type":"string","examples":["1475305200000-1477983599999"]},"text":{"type":"string","examples":["expiring this month"]}}}}}},"ReportDataV1":{"type":"object","description":"Sample report data","properties":{"transaction_id":{"type":"string","examples":[53]},"account_id":{"type":"string","examples":[6014]},"listing_date":{"type":"integer","examples":[6014]},"full_address":{"type":"string","examples":["20946 E Canyon Ridge Lane, Walnut, CA 91789"]},"owner_name":{"type":"string","examples":["John Doe"]},"status":{"type":"string","examples":["active"]},"price":{"type":"string","examples":[2900]}}},"ChecklistWithTransactionId":{"allOf":[{"$ref":"#/components/schemas/Checklist"},{"type":"object","properties":{"bm_transaction_id":{"type":"integer","examples":[100]}}}]},"NewTask":{"type":"object","required":["name"],"properties":{"name":{"type":"string","examples":["Escrow deposit receipt"]},"description":{"type":"string","examples":["Updated description"]},"document_required":{"type":"boolean","examples":[true]},"document_approval_required":{"type":"boolean","examples":[true]},"document_second_approval_required":{"type":"boolean","examples":[false]},"deadline":{"$ref":"#/components/schemas/dateStamp"},"assigned_to_id":{"type":"integer","description":"ID of user or contact","examples":[1]},"assigned_to_type":{"type":"string","examples":["user"],"description":"Allowed values: `user`, `contact`\n"},"assigned_to_role":{"type":"string","examples":["inspector"]},"done":{"type":"boolean","examples":[false],"deprecated":true,"description":"Deprecated. Use `status` instead."}}},"TaskStatus":{"type":"string","description":"Current task status. Mirrors values from `Tasks::Core::TASK_STATUS`.\n","enum":["todo","uploaded","review requested","review approved (not sent)","review approved","review rejected (not sent)","review rejected","review requested (2nd)","review approved (not sent / 2nd)","review rejected (not sent / 2nd)","exemption requested","exemption approved (not sent)","exempt","exemption rejected (not sent)","exemption rejected","complete","complete (approved)"]},"Task":{"allOf":[{"type":"object","properties":{"id":{"type":"integer","examples":[3]}}},{"$ref":"#/components/schemas/NewTask"},{"type":"object","properties":{"submitted_at":{"$ref":"#/components/schemas/dateStamp"},"document_id":{"type":"integer","description":"ID of assigned document","examples":[29]},"checklist_id":{"type":"integer","description":"ID of task's checklist","examples":[123]},"checklist":{"$ref":"#/components/schemas/ChecklistWithTransactionId"},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"},"assigned_to_name":{"type":"string","description":"task assignee name","examples":["John Doe"]},"assigned_to_id":{"type":"integer","description":"task assignee ID","examples":[123]},"assigned_to_type":{"type":"string","description":"task assignee type","examples":["user"]},"assigned_to_role":{"type":"string","description":"task assignee role","examples":["Agent"]},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"examples":["review requested"]},"allowed_transitions":{"type":"array","description":"Statuses the task can transition to next. Uses the same values as `status`.\n","items":{"$ref":"#/components/schemas/TaskStatus"},"examples":[["review approved","exemption requested"]]},"exemption":{"type":"string","examples":["requested"],"deprecated":true,"description":"Deprecated. Use `status` instead."},"sort_order":{"type":["integer","null"],"description":"Task display order within checklist","examples":[0]},"comments":{"type":"array","description":"Array of comments associated with this task","items":{"$ref":"#/components/schemas/Comment"}},"bm_transaction":{"type":"object","description":"Transaction information","properties":{"id":{"type":"integer","examples":[3]},"address":{"type":"string","examples":["17019 Broken Rock Court"]},"city":{"type":"string","examples":["Riverside"]},"state":{"type":"string","examples":["CA"]},"zip":{"type":"string","examples":["92503"]},"price":{"type":"number","format":"float","examples":[639000.42]},"status":{"type":"string","description":"Transaction status","examples":["active"]},"representing":{"type":"string","description":"Who the brokerage represents","examples":["buyer"]},"transaction_name":{"type":"string","description":"Display name for the transaction","examples":["Johnson - 17019 Broken Rock Court"]},"full_address":{"type":"string","description":"Transaction's address as one line","examples":["17019 Broken Rock Court, Riverside, CA 92503"]}}},"document":{"anyOf":[{"$ref":"#/components/schemas/Document"},{"type":"null"}]},"document_approval_required":{"type":"boolean","examples":[true],"description":"Whether the document requires first-level approval"},"document_second_approval_required":{"type":"boolean","examples":[false],"description":"Whether the document requires second-level approval (two-tier approval workflow)"},"required_document_ids":{"type":"array","description":"IDs of documents required to satisfy this task","items":{"type":"integer"},"examples":[[29]]},"required_documents":{"type":"array","description":"Full document objects for `required_document_ids`, each enriched with\nits originating library. Only present when the request includes\n`?include=required_documents`.\n","items":{"allOf":[{"$ref":"#/components/schemas/Document"},{"type":"object","properties":{"library":{"type":["object","null"],"description":"Library the document originates from, when applicable","properties":{"id":{"type":"integer","examples":[12]},"identifier":{"type":"string","examples":["listing_agreement"]},"name":{"type":"string","examples":["Listing Agreement"]},"is_access_allowed":{"type":"boolean","description":"Whether the current user has access to this library","examples":[true]}}}}}]}}}}]},"BaseWebhookSubscription":{"type":"object","properties":{"callback_url":{"type":"string"},"event_types":{"type":"array","items":{"type":"object","required":["event"],"properties":{"event":{"type":"string"},"api_version":{"type":"string"}}}},"metadata":{"type":"object"}}},"NewWebhookSubscription":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookSubscription"},{"type":"object","required":["callback_url"]}]},"WebhookSubscription":{"allOf":[{"$ref":"#/components/schemas/NewWebhookSubscription"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64"},"created_at":{"$ref":"#/components/schemas/dateStamp"},"updated_at":{"$ref":"#/components/schemas/dateStamp"}}}]},"CreatedWebhookSubscription":{"allOf":[{"$ref":"#/components/schemas/WebhookSubscription"},{"type":"object","properties":{"secret_token":{"type":"string"}}}]},"UpdateWebhookSubscription":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookSubscription"},{"type":"object","required":["id"]}]}},"examples":{"ShortTransactionParticipants":{"summary":"Sample short participants response","value":[{"id":348,"user_id":348,"account_user_id":502,"custom_id":"348","external_id":"crm123","active":true,"role":"Title officer","team":null,"type":"user","first_name":"Joe","last_name":"User","name":"Joe User","email":"joe@user.com","owner":true},{"id":445,"contact_id":445,"first_name":"Bill","last_name":"The Seller","name":"Bill The Seller","email":"bill@seller.com","type":"contact","contact_type":"other","owner":false,"role":"Seller"}]},"FullTransactionParticipants":{"summary":"Sample full participants response","value":[{"id":348,"user_id":348,"account_user_id":502,"custom_id":"348","external_id":"crm123","active":true,"role":"Title officer","team":null,"type":"user","first_name":"Joe","last_name":"User","name":"Joe User","email":"joe@user.com","owner":true,"phone":"0123456789","company":"The Joe Corp","birthday":1566248400000,"anniversary_date":1566334800000,"avatar_added":true,"avatar_url":"https://s3.amazonaws.com/../500.gif","created_at":1567255283692,"updated_at":1575986327648,"last_sign_in":0,"Address":"North St. 1","City":"Uhuhu","State":"CA","Zip":"92123","License :":"123456","License expiration":1574892000000,"Annual Cap":10000},{"id":445,"contact_id":445,"first_name":"Bill","last_name":"The Seller","name":"Bill The Seller","email":"bill@seller.com","type":"contact","contact_type":"other","owner":false,"role":"Seller","company":"Bill's CO","address":"Wide St. 124","city":"Walnut","state":"CA","zip":"91789","phone":"987654321","mobile_phone":"987654321","fax":"987654321","private":false,"lead_source":"salesforce.com","external_id":null,"updated_at":1566318420695,"created_at":1566318420695,"created_by":1,"creator_name":"The User","Custom Field":"Custom Value"}]},"NewTransactionV1":{"summary":"Sample transaction request","value":{"address":"17019 Broken Rock Court","city":"Riverside","state":"CA","zip":"92503","status":"listing","price":639000,"transaction_type":"traditional sale","transaction_name":"Johnson Family Home","representing":"both","acceptance_date":1541455200000,"expiration_date":1576188000000,"created_at":1517256364083,"updated_at":1575282414563,"closing_date":1575151200000,"total_gross_commission":10000,"listing_date":1516658400000,"external_id":"mls269463329","timezone":-7,"commissions_finalized_at":null,"custom_id":"TR-2018-341614","closed_at":null,"custom_attributes":[{"type":"string","label":"MLS #","name":"mls_number","required":true,"value":"IR28020198"},{"type":"dropdown","label":"Lead source","name":"lead_source","value":"SalesForce","options":["SalesForce","BoomTowm","Phone","Email"]},{"type":"dropdown","label":"Property Type","value":"Single Family","options":["Single Family","Multi Unit","Multi-2 units","Multi-3 units","Multi-4 units","Other"]},{"type":"string","label":"Seller's name","required":true,"required_if_status":"pending","name":"f352942056"},{"type":"string","label":"Area","name":"area","value":"Major: 252 - Riverside"},{"type":"string","label":"Half baths","name":"half_baths","value":"1"},{"type":"string","label":"Showing instructions","name":"showing_instructions","value":null},{"type":"string","label":"Description","name":"description","value":"Perched high in the hills above Riverside, this home has sweeping views of the hilly landscape and city lights. The entry foyer features a three story vaulted ceiling and is filled with natural light. With five bedrooms, the spacious layout has bedroom's on each floor of the house."},{"type":"money","label":"Amount received","name":"amount_received","value":100}],"buying_side_representer":{"id":6014,"type":"Account"},"listing_side_representer":{"id":6014,"type":"Account"}}},"NewTransactionV2":{"summary":"Sample transaction request","value":{"address":"17019 Broken Rock Court","city":"Riverside","state":"CA","zip":"92503","status":"listing","price":639000,"transaction_type":"traditional sale","transaction_name":"Johnson Family Home","representing":"both","acceptance_date":1541455200000,"expiration_date":1576188000000,"created_at":1517256364083,"updated_at":1575282414563,"closing_date":1575151200000,"total_gross_commission":10000,"listing_date":1516658400000,"external_id":"mls269463329","timezone":-7,"commissions_finalized_at":null,"custom_id":"TR-2018-341614","closed_at":null,"MLS #":"IR28020198","Lead source":"SalesForce","Property Type":"Single Family","Seller's name":null,"Area":"Major: 252 - Riverside","Half baths":"1","Showing instructions":null,"Description":"Perched high in the hills above Riverside, this home has sweeping views of the hilly landscape and city lights. The entry foyer features a three story vaulted ceiling and is filled with natural light. With five bedrooms, the spacious layout has bedroom's on each floor of the house.","buying_side_representer":{"id":6014,"type":"Account"},"listing_side_representer":{"id":6014,"type":"Account"}}},"NewTransactionV3":{"summary":"Sample transaction request","value":{"address":"17019 Broken Rock Court","city":"Riverside","state":"CA","zip":"92503","status":"active","price":639000,"transaction_type":"traditional sale","transaction_name":"Johnson Family Home","representing":"both","acceptance_date":1541455200000,"expiration_date":1576188000000,"created_at":1517256364083,"updated_at":1575282414563,"closing_date":1575151200000,"total_gross_commission":10000,"listing_date":1516658400000,"external_id":"mls269463329","timezone":-7,"commissions_finalized_at":null,"custom_id":"TR-2018-341614","closed_at":null,"MLS #":"IR28020198","Lead source":"SalesForce","Property Type":"Single Family","Seller's name":null,"Area":"Major: 252 - Riverside","Half baths":"1","Showing instructions":null,"Description":"Perched high in the hills above Riverside, this home has sweeping views of the hilly landscape and city lights. The entry foyer features a three story vaulted ceiling and is filled with natural light. With five bedrooms, the spacious layout has bedroom's on each floor of the house.","buying_side_representer":{"id":6014,"type":"Account"},"listing_side_representer":{"id":6014,"type":"Account"}}},"ChecklistTemplateWithAutoapply":{"summary":"Sample checklist template with autoapply settings","value":{"id":1,"name":"Buying","depends_on":{"dates":["acceptance_date"],"roles":["buyer"]},"autoapply_settings":{"requirements":{"always":false,"when":{"status":["pending","active"],"transaction_type":["traditional sale"]}}}}},"TransactionCommissions":{"summary":"Sample transaction commissions request","value":[{"item_type":"tgc","side":null,"payer_id":6014,"payer_type":"Account","payee_id":6014,"payee_type":"Account","tiers":[{"low_limit":0,"value":6,"uom":"% of price sold"}]},{"item_type":"award_distribution","side":"listing","payer_id":6014,"payer_type":"Account","payee_id":6014,"payee_type":"Account","tiers":[{"low_limit":0,"value":3,"uom":"% of price sold"}]},{"item_type":"award_distribution","side":"buying","payer_id":4212407,"payer_type":"Contact","payee_id":4212407,"payee_type":"Contact","tiers":[{"low_limit":0,"value":3,"uom":"% of price sold"}]},{"item_type":"award_allocation","side":"listing","payer_id":6014,"payer_type":"Account","payee_id":36736,"payee_type":"User","tiers":[{"low_limit":0,"value":80,"uom":"% of shared gross income"}]},{"item_type":"sales_volume","side":"listing","payer_id":36736,"payer_type":"User","payee_id":36736,"payee_type":"User","tiers":[{"low_limit":0,"value":80,"uom":"% of price sold"}]},{"item_type":"split","side":"listing","payer_id":6014,"payer_type":"Account","payee_id":36736,"payee_type":"User","sliding_base":"sales volume","sliding_base_period":"year to date","sliding_base_amount":0,"sliding_base_accrued_by":"agent","tiers":[{"low_limit":0,"value":80,"uom":"% of remaining balance"},{"low_limit":100000,"value":90,"uom":"% of remaining balance"}],"tags":["referral"]},{"item_type":"award_allocation","side":"listing","payer_id":6014,"payer_type":"Account","payee_id":36467,"payee_type":"User","tiers":[{"low_limit":0,"value":20,"uom":"% of shared gross income"}]},{"item_type":"sales_volume","side":"listing","payer_id":36467,"payer_type":"User","payee_id":36467,"payee_type":"User","tiers":[{"low_limit":0,"value":20,"uom":"% of price sold"}]},{"item_type":"split","side":"listing","payer_id":6014,"payer_type":"Account","payee_id":36467,"payee_type":"User","sliding_base":"gross commission","sliding_base_period":"year to date","sliding_base_accrued_by":"agent","tiers":[{"low_limit":0,"value":80,"uom":"% of remaining balance"}]}]},"NewWebhookSubscription":{"summary":"Sample webhook subscription request","value":{"callback_url":"https://example.com/callback","event_types":[{"event":"transaction.created","api_version":"2"}],"metdata":{}}}},"responses":{"BadRequestMissingChecklistRoles":{"description":"Invalid request, or (strict) matched checklists need roles the transaction lacks; nothing is saved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MissingChecklistRolesError"}}}}}},"paths":{"/v1/users/{id}/sso_token":{"get":{"summary":"Get SSO token for user","tags":["SSO"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of user to generate SSO token for","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"SSO token","content":{"application/json":{"schema":{"type":"object","properties":{"sso_token":{"type":"string","examples":["kDsnaiAaG3EQK7yx9Tx+U+/6CXUmq/polXNUBDGhqw9sAa0FmJn/DroFkRilLS1EY7DNxk1OUMyIrNPokBoZ87XY="]}}}}}}}}},"/v1/users":{"get":{"summary":"List available users in account","description":"The resulting list will be limited by at most 1000 records.\nFollowig parameters allow to paginate and filter the output.\n","tags":["USERS"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"active","in":"query","required":false,"description":"Filter active/inactive users. By default all users are returned.\nUse \"1\" to query active users only or \"0\" to query inactive.\n","schema":{"type":"integer","enum":[0,1]},"example":1},{"name":"created_since","in":"query","required":false,"description":"Filter users created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"updated_since","in":"query","required":false,"description":"Filter users updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"external_ids","in":"query","required":false,"description":"Filter users by the comma separated list of externale IDs\n","example":"crm123,extdId124,234","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"emails","in":"query","required":false,"description":"Filter users by the comma separated list of emails\n","example":"a@b.com,test@example.com","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"full_info","in":"query","required":false,"description":"Specifies whether to retrieve short or full user information.\n","schema":{"type":"integer","enum":[0,1],"default":0},"example":1},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values: `comments`\n","example":"comments","schema":{"type":"array","items":{"type":"string","enum":["comments"]}}}],"responses":{"200":{"description":"User list response","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"title":"FullUser","$ref":"#/components/schemas/FullUser"},{"title":"ShortUser","$ref":"#/components/schemas/ShortUser"}]}}}}}}},"post":{"summary":"Create user","tags":["USERS"],"parameters":[{"name":"send_instructions","in":"query","required":false,"description":"Specifies whether to send welcome email and login instructions\n","schema":{"type":"integer","enum":[0,1],"default":0},"example":1}],"requestBody":{"description":"User to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserParams"}}}},"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullUser"}}}}}}},"/v1/users/schema":{"get":{"summary":"Get current account's user field schema","description":"Returns the user fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means.","tags":["USERS"],"responses":{"200":{"description":"Current account-user field schema","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldDescriptor"}}}}}}}},"/v1/users/{id}":{"get":{"summary":"Get user by ID","tags":["USERS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of user","example":1234,"schema":{"type":"integer"}},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values: `comments`\n","example":"comments","schema":{"type":"array","items":{"type":"string","enum":["comments"]}}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullUser"}}}}}},"put":{"summary":"Update user","tags":["USERS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of user","example":123,"schema":{"type":"integer"}}],"requestBody":{"description":"User updates, only the specified attributes will be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFullUser"}}}},"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullUser"}}}}}}},"/v1/users/me":{"get":{"summary":"Get current user details","tags":["USERS"],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentUserDetails"}}}}}}},"/v1/users/{id}/permissions":{"get":{"summary":"Get user permissions","tags":["USERS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of user","example":123,"schema":{"type":"integer"}}],"responses":{"200":{"description":"User permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPermissions"}}}}}},"put":{"summary":"Update user permissions","tags":["USERS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of user","example":123,"schema":{"type":"integer"}}],"requestBody":{"description":"Permission updates, only the specified permissions will be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPermissions"}}}},"responses":{"200":{"description":"Updated permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPermissions"}}}}}}},"/v1/users/search":{"get":{"summary":"Search users","tags":["USERS"],"parameters":[{"name":"keyword","in":"query","description":"text to search in user name or email","required":true,"example":"John","schema":{"type":"string"}}],"responses":{"200":{"description":"It returns a response with a list of the first 10 users","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShortUser"}}}}}}}},"/v1/accounts":{"get":{"summary":"Get list of user's accounts","tags":["ACCOUNTS"],"responses":{"200":{"description":"Accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}}}}},"/v1/accounts/{account_id}":{"get":{"summary":"Get account by ID","tags":["ACCOUNTS"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}}}}},"/v1/accounts/current":{"get":{"summary":"Get current account details","tags":["ACCOUNTS"],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}}}}},"/v1/accounts/{account_id}/settings/buyer_offer_fields":{"get":{"summary":"Get buyer offer fields","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Buyer offer fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOfferFields"}}}}}}},"/v1/accounts/{account_id}/settings/transaction_fields":{"get":{"summary":"Get transaction fields","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionFields"}}}}}}},"/v1/accounts/{account_id}/settings/transaction_types":{"get":{"summary":"Get transaction types","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionTypes"}}}}}}},"/v1/accounts/{account_id}/settings/transaction_participant_roles":{"get":{"summary":"Get transaction roles","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction participant roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionRoles"}}}}}}},"/v1/accounts/{account_id}/settings/contact_fields":{"get":{"summary":"Get contact fields","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFields"}}}}}}},"/v1/accounts/{account_id}/settings/contact_types":{"get":{"summary":"Get contact types","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactTypes"}}}}}}},"/v1/accounts/{account_id}/settings/contact_lead_sources":{"get":{"summary":"Get contact lead sources","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact lead sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactLeadSources"}}}}}}},"/v1/accounts/{account_id}/settings/account_user_fields":{"get":{"summary":"Get account user fields","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Account user fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUserFields"}}}}}}},"/v1/accounts/{account_id}/settings/email_templates":{"get":{"summary":"Get email templates","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Email templates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplates"}}}}}}},"/v1/accounts/{account_id}/settings/document_rejection_reasons":{"get":{"summary":"Get document rejection reasons","tags":["ACCOUNT SETTINGS (deprecated)"],"parameters":[{"name":"account_id","in":"path","required":true,"description":"ID of account","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Document rejection reasons","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRejectionReasons"}}}}}}},"/v2/accounts/settings/buyer_offer_fields":{"get":{"summary":"Get buyer offer fields","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Buyer offer fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOfferFields"}}}}}}},"/v2/accounts/settings/transaction_fields":{"get":{"summary":"Get transaction fields","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Transaction fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionFieldsV2"}}}}}}},"/v2/accounts/settings/transaction_types":{"get":{"summary":"Get transaction types","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Transaction types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionTypes"}}}}}}},"/v2/accounts/settings/transaction_participant_roles":{"get":{"summary":"Get transaction roles","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Transaction participant roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionRolesV2"}}}}}}},"/v2/accounts/settings/contact_fields":{"get":{"summary":"Get contact fields","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Contact fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactFields"}}}}}}},"/v2/accounts/settings/contact_types":{"get":{"summary":"Get contact types","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Contact types","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactTypes"}}}}}}},"/v2/accounts/settings/contact_lead_sources":{"get":{"summary":"Get contact lead sources","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Contact lead sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactLeadSources"}}}}}}},"/v2/accounts/settings/account_user_fields":{"get":{"summary":"Get account user fields","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Account user fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUserFields"}}}}}}},"/v2/accounts/settings/email_templates":{"get":{"summary":"Get email templates","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Email templates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplates"}}}}}}},"/v2/accounts/settings/document_rejection_reasons":{"get":{"summary":"Get document rejection reasons","tags":["ACCOUNT SETTINGS V2"],"responses":{"200":{"description":"Document rejection reasons","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentRejectionReasons"}}}}}}},"/v1/activities":{"get":{"summary":"List available activities in account","description":"The fields of the response are dynamic and limited by at most 200 records.\nFollowing parameters allow to paginate and filter the output.\n","tags":["ACTIVITIES"],"parameters":[{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"bm_transaction_ids","in":"query","required":false,"description":"Filter activities by the comma separated list of transaction IDs.\n","example":"123,124,125","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"agent_onboarding_ids","in":"query","required":false,"description":"Filter activities by the comma separated list of agent onboarding IDs.\n","example":"321,322,333","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"buyer_offer_ids","in":"query","required":false,"description":"Filter activities by the comma separated list of buyer offer IDs.\n","example":"321,322,333","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"participated_by","in":"query","required":false,"description":"Filter activities by the comma separated list of participants.\nParameter format TYPE-ID, i.g. “User-230” or “Contact-1245”.\n","example":"User-230,Contact-1245","schema":{"type":"string"}},{"name":"event_types","in":"query","required":false,"description":"Filter activities by the comma separated list of event types.\n","example":"comment_added,task_complete,account_created","schema":{"type":"string"}},{"name":"created_since","in":"query","required":false,"description":"Filter activities created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp.\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"count","in":"query","description":"Specifies the number of items to retrieve.","example":20,"schema":{"type":"integer","minimum":1,"maximum":200}},{"$ref":"#/components/parameters/sortParam"}],"responses":{"200":{"description":"Activities list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}}}}}}}},"/v1/agent_onboardings/checklist_templates":{"get":{"summary":"List of available onboarding's checklists templates","tags":["AGENT ONBOARDING"],"responses":{"200":{"description":"List of available transaction's checklists","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingChecklistTemplate"}}}}}}}},"/v1/agent_onboardings/checklist_templates/{template_id}/assignees":{"get":{"summary":"Get onboarding checklist assignees","tags":["AGENT ONBOARDING"],"parameters":[{"name":"template_id","in":"path","required":true,"description":"ID of agent onboarding checklist template","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Onboarding checklist assignees","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"role":{"description":"Role name from the provided onboarding checklist template","type":"string"},"assigned_to":{"$ref":"#/components/schemas/ShortUser"}}}}}}}}}},"/v1/reviews":{"get":{"summary":"List of pending review documents","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"type","in":"query","required":false,"description":"Review type. Optional, \"transaction\" is the only value and the default\n","example":"transaction","schema":{"type":"string","enum":["transaction"]}},{"name":"bm_transaction_ids","in":"query","style":"form","explode":false,"description":"Filter pending review documents by the comma separated list of transaction IDs\n","example":"456,9277","schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Pending review documents list response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bm_transaction":{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"address":{"type":"string","examples":["1700 Libby Spurs"]},"city":{"type":"string","examples":["Lake Justina"]},"state":{"type":"string","examples":["MT"]},"zip":{"type":"string","examples":["61773-9547"]},"price":{"type":"number","examples":[26290.45]},"status":{"type":"string","examples":["pending"]}}},"bm_transaction_owner":{"type":"object","properties":{"id":{"type":"integer","examples":[123]},"type":{"type":"string","examples":["user"]},"name":{"type":"string","examples":["Jovani Sporer"]}}},"review_document_ids":{"type":"array","items":{"type":"integer"},"examples":[[45,76,123]]},"exempted_tasks_ids":{"type":"array","items":{"type":"integer"},"examples":[[1,34]]},"last_submitted_at":{"$ref":"#/components/schemas/dateStamp"}}}}}}}}}},"/v1/reviews/documents/{document_id}/submit":{"post":{"summary":"Submit document for review","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Document submitted"},"403":{"description":"User does not have permission to submit documents","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/documents/{document_id}/approve":{"post":{"summary":"Approve document","description":"Approves a document for review. This endpoint supports both first-level and second-level approvals.\n\nRequires either first-level or second-level document review permissions.\n","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string","description":"Optional approval comment"},"finalize":{"type":"boolean","description":"When true, immediately transitions the task to its final \"approved\" state (instead of the intermediate \"approved not sent\")"}}},"example":{"comment":"Document approved","finalize":false}}}},"responses":{"200":{"description":"Document approved"},"403":{"description":"User does not have permission to approve documents","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/documents/{document_id}/reject":{"post":{"summary":"Reject document","description":"Rejects a document during review. This endpoint supports both first-level and second-level rejections.\n\nUsers with either first-level or second-level document approval permissions can use this endpoint.\nA rejection comment is required.\n","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["comment"],"properties":{"comment":{"type":"string","description":"Rejection reason"},"finalize":{"type":"boolean","description":"When true, immediately transitions the task to its final \"rejected\" state (instead of the intermediate \"rejected not sent\")"}}},"example":{"comment":"Document is incomplete","finalize":false}}}},"responses":{"200":{"description":"Document rejected"},"403":{"description":"User does not have permission to reject documents","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/documents/{document_id}/revoke_approval":{"post":{"summary":"Revoke document approval","description":"This allows reviewers to undo their approval decision and send the document back for revision.\n\nRequires either first-level or second-level document review permissions.\n","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Approval successfully revoked"},"403":{"description":"User does not have permission to revoke approvals","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/tasks/{task_id}/request_exemption":{"post":{"summary":"Request task exemption","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task exemption rejected"},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/tasks/{task_id}/approve_exemption":{"post":{"summary":"Approve task exemption","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string"},"finalize":{"type":"boolean","description":"When true, immediately transitions the task to its final \"exempt\" state (instead of the intermediate \"exemption approved (not sent)\")"}}},"example":{"comment":"Task exemption approved","finalize":false}}}},"responses":{"200":{"description":"Task exemption approved"},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/tasks/{task_id}/reject_exemption":{"post":{"summary":"Reject task exemptaion","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["comment"],"properties":{"comment":{"type":"string","description":"Rejection reason"},"finalize":{"type":"boolean","description":"When true, immediately transitions the task to its final \"exemption rejected\" state (instead of the intermediate \"exemption rejected (not sent)\")"}}},"example":{"comment":"Task is incomplete","finalize":false}}}},"responses":{"200":{"description":"Task exemption rejected"},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/tasks/{task_id}/revoke_exemption":{"post":{"summary":"Revoke task exemption","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task exemption revoked"},"403":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["You don't have permission"]}}}}}}}}},"/v1/reviews/send_reviewed_email":{"post":{"summary":"Send reviewed email","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"query","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"type","in":"query","required":false,"description":"Review type. Optional, \"transaction\" is the only value and the default\n","example":"transaction","schema":{"type":"string","enum":["transaction"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["notes"],"properties":{"cc":{"type":"array","items":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer"},"type":{"type":"string"}}}},"notes":{"type":"string","description":"Documents review resolution"}}},"example":{"cc":[{"id":123,"type":"user"},{"id":745,"type":"contact"}],"notes":"A batch of documents for the transaction 123 Main St have been reviewed.\n\nHere are the results:\nAPPROVED: 1\nREJECTED: 0\n"}}}},"responses":{"200":{"description":"Email sent"}}}},"/v1/reviews/checklists/{checklist_id}/submit":{"post":{"summary":"Submit all non-submitted documents in checklist for review","tags":["REVIEW DOCUMENTS"],"parameters":[{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Documents submission successful"}}}},"/v1/esign/request_signature":{"post":{"summary":"Send signature request","description":"Sends a document package for electronic signature and emails the signers right away. The emails cannot be\nrecalled. Once sent, the package cannot be edited until the request is canceled with\n`/v1/esign/cancel_signature`.\n\nEach signer signs as one of the package roles. A role without a signer is skipped and its signature fields\nare discarded.\n\nResponds with 400 and sends nothing when a signer or cc recipient does not exist in the account.\n","tags":["E-SIGNATURES"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_id","signers","timezone_offset"],"properties":{"document_id":{"type":"integer","description":"ID of the document package","examples":[1234]},"signers":{"type":"array","minItems":1,"description":"Who signs, and as which package role","items":{"$ref":"#/components/schemas/EsignSigner"}},"ordered_signers":{"type":"boolean","description":"`true` emails signers one at a time in the `signers` order, each once the previous one has signed. `false` emails everyone at once","default":false},"cc_recipients":{"type":"array","description":"People who receive a copy of the request and the signed document but do not sign","items":{"$ref":"#/components/schemas/EsignRecipient"}},"timezone_offset":{"type":"integer","description":"Requester's UTC offset in whole hours. Used to show event times in the requester's local time on the audit trail and on some signer-filled dates","examples":[-5]},"timezone_abbreviation":{"type":"string","description":"Label for the requester's timezone. Printed in the audit trail PDF as \"EST (UTC-5)\" and on some signer-filled dates. Derived from `timezone_offset` when omitted (e.g. \"-05\")","examples":["EST"]},"email_template":{"type":"object","description":"Replaces the standard request email. Also used when the email is resent","required":["subject","body"],"properties":{"subject":{"type":"string","description":"Email subject. Placeholders are not replaced","examples":["Please sign: Purchase agreement"]},"body":{"type":"string","description":"Plain text replacing the standard message, line breaks are kept. `$(recipient_name)`, `$(recipient_email)` and `$(signer_role)` are replaced for each recipient, any other `$(...)` becomes empty.","examples":["Hi $(recipient_name),\nplease sign the purchase agreement."]}}}}}}}},"responses":{"200":{"description":"Signature request sent. The signature request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsignRequest"},{"type":"object","properties":{"status":{"enum":["sent for signature"]}}}]}}}},"400":{"description":"No signers, invalid `timezone_offset`, a signer or cc recipient does not exist, or the package is not in a transaction or buyer offer, or was already sent or signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}},"403":{"description":"User has no access to the document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}},"404":{"description":"Document package not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}}}}},"/v1/esign/resend_signature_email":{"post":{"summary":"Resend signature request","description":"Emails the signature request to one of its signers again, with the same subject and message. The document\nand the request do not change.\n\n`signer_email` and `signer_name` must match the signer exactly as the request was sent.\n","tags":["E-SIGNATURES"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_id","signer_email","signer_name"],"properties":{"document_id":{"type":"integer","description":"ID of the document package","examples":[1234]},"signer_email":{"type":"string","description":"Signer's email as the request was sent","examples":["john.smith@example.com"]},"signer_name":{"type":"string","description":"Signer's name as the request was sent","examples":["John Smith"]}}}}}},"responses":{"200":{"description":"Email resent. The signature request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsignRequest"},{"type":"object","properties":{"status":{"enum":["sent for signature"]}}}]}}}},"400":{"description":"A required parameter is missing, or the document is already signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}},"403":{"description":"User has no access to the document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}},"404":{"description":"Document package or signer not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}}}}},"/v1/esign/cancel_signature":{"post":{"summary":"Cancel signature request","description":"Cancels the signature request of a document package that was sent for signature or already signed, so the\npackage can be edited and sent again. Signers can no longer sign the canceled request.\n\n`keep_signatures` chooses what happens to the input signers already made:\n\n- `false` voids all of it. The package returns to the state it was in before sending, with its signer roles\n  and markup.\n- `true` keeps it on the document. The document becomes a flat PDF with the audit trail attached, its signer\n  roles and markup are cleared and have to be set up again.\n\nResponds with 400 and changes nothing when the package has no sent or signed request: it was never sent, or\nits request is already canceled.\n","tags":["E-SIGNATURES"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["document_id","keep_signatures"],"properties":{"document_id":{"type":"integer","description":"ID of the document package","examples":[1234]},"keep_signatures":{"type":"boolean","description":"`true` to keep the input signers already made and flatten the document, `false` to void all of it and restore markup \u0026 roles","examples":[false]}}}}}},"responses":{"200":{"description":"Signature request canceled. The canceled request, with signer statuses at the time of canceling","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/EsignRequest"},{"type":"object","properties":{"status":{"enum":["canceled"]}}}]},"example":{"status":"canceled","has_signatures":true,"canceled":true,"signers":[{"status":"signed","role_identifier":"buyer","signer_role":"Buyer","signer_name":"John Smith","signer_email":"john.smith@example.com"},{"status":"sent","role_identifier":"seller","signer_role":"Seller","signer_name":"Jane Doe","signer_email":"jane.doe@example.com"}]}}}},"400":{"description":"The package has no sent or signed signature request to cancel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}},"403":{"description":"User has no access to the document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}},"404":{"description":"Document package not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EsignError"}}}}}}},"/v1/backups":{"get":{"summary":"List of all available transaction's backups","description":"The resulting list will be limited by at most 1000 records.\nFollowig parameters allow to paginate and filter the output.\n","tags":["TRANSACTION BACKUPS"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"completed_since","in":"query","required":false,"description":"Filter backups completed since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"exclude_backup_ids","in":"query","required":false,"description":"Filter out backups with IDs in specified comma separated list\n","example":123345543,"style":"form","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"List of available transaction's backups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Backup"}}}}}}}},"/v1/transactions/{bm_transaction_id}/backup":{"get":{"summary":"Get latest transaction backup","tags":["TRANSACTION BACKUPS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Latest available transaction backup link","content":{"application/json":{"schema":{"type":"object","properties":{"link":{"type":"string","description":"Publicly accessible URL to transaction backup,\nwith 60 minutes expiration time.\n","examples":["https://s3-eu-central-1.amazonaws.com/bucket/folder/backup.zip"]}}}}}}}}},"/v1/transactions/{bm_transaction_id}/participants":{"get":{"summary":"List of transaction participants","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"$ref":"#/components/parameters/full_info"}],"responses":{"200":{"description":"List of participants","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ShortParticipantsList"},{"$ref":"#/components/schemas/FullParticipantsList"}]},"examples":{"short":{"$ref":"#/components/examples/ShortTransactionParticipants"},"full":{"$ref":"#/components/examples/FullTransactionParticipants"}}}}}}}},"/v1/transactions/{bm_transaction_id}/participants/users":{"get":{"summary":"List of user-participants","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"$ref":"#/components/parameters/full_info"}],"responses":{"200":{"description":"List of user-participants","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantUsersList"}}}}}},"post":{"summary":"Add / update user participation","description":"Adds the user to the transaction with `role`, or updates the participation they already have.\nThe response shows only the role from this call; the participants list shows a user with several roles once per role.","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"}],"requestBody":{"description":"Participant options","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ParticipantOptions"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"ID of user","examples":[12]}}}]}}}},"responses":{"200":{"description":"Updated participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullUserParticipant"}}}},"201":{"description":"Created participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullUserParticipant"}}}}}}},"/v1/transactions/{bm_transaction_id}/participants/users/{id}":{"get":{"summary":"Get user-participants by user ID","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"name":"id","in":"path","required":true,"description":"ID of user","example":567,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/full_info"}],"responses":{"200":{"description":"User participating transaction","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FullUserParticipant"},{"$ref":"#/components/schemas/ShortUserParticipant"}]}}}}}},"put":{"summary":"Update user participation","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"name":"id","in":"path","required":true,"description":"ID of user","example":567,"schema":{"type":"integer"}}],"requestBody":{"description":"Participant options","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantOptions"}}}},"responses":{"200":{"description":"Updated participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullUserParticipant"}}}}}},"delete":{"summary":"Remove user from transaction","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"name":"id","in":"path","required":true,"description":"ID of user","example":567,"schema":{"type":"integer"}}],"responses":{"200":{"description":"User removed from transaction"}}}},"/v1/transactions/{bm_transaction_id}/participants/contacts":{"get":{"summary":"List of contact-participants","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"$ref":"#/components/parameters/full_info"}],"responses":{"200":{"description":"List of contact-participants","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantContactsList"}}}}}},"post":{"summary":"Add / update contact participation","description":"Adds the contact to the transaction with `role`, or updates the participation they already have.\nThe response shows only the role from this call; the participants list shows a contact with several roles once per role.","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"}],"requestBody":{"description":"Participant options","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ParticipantOptions"},{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"ID of contact","examples":[12]}}}]}}}},"responses":{"200":{"description":"Updated participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContactParticipant"}}}},"201":{"description":"Created participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContactParticipant"}}}}}}},"/v1/transactions/{bm_transaction_id}/participants/contacts/{id}":{"get":{"summary":"Get contact-participant by Contact ID","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"name":"id","in":"path","required":true,"description":"ID of contact","example":567,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/full_info"}],"responses":{"200":{"description":"Contact-participants","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/FullContactParticipant"},{"$ref":"#/components/schemas/ShortContactParticipant"}]}}}}}},"put":{"summary":"Update contact participation","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"name":"id","in":"path","required":true,"description":"ID of Contact","example":567,"schema":{"type":"integer"}}],"requestBody":{"description":"Participant options","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantOptions"}}}},"responses":{"200":{"description":"Updated contact-participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContactParticipant"}}}}}},"delete":{"summary":"Remove contact from transaction","tags":["TRANSACTION PARTICIPANTS"],"parameters":[{"$ref":"#/components/parameters/bm_transaction_id"},{"name":"id","in":"path","required":true,"description":"ID of Contact","example":567,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact removed from transaction"}}}},"/v1/transactions":{"get":{"summary":"List available transactions","description":"The resulting list will be limited by at most 1000 records.\nFollowig parameters allow to paginate and filter the output.\n","tags":["TRANSACTIONS (deprecated)"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"statuses","in":"query","required":false,"description":"Filter transactions by specified statuses.\nAllowed values: `pre-listing`, `listing`, `pending`, `closed`, `cancelled`\n","examples":{"statuses":{"value":"listing,pending","summary":"comma separated multiple statuses"}},"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["pre-listing","listing","pending","closed","cancelled"]}}},{"name":"created_since","in":"query","required":false,"description":"Filter transactions created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"updated_since","in":"query","required":false,"description":"Filter transactions updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"closed_since","in":"query","required":false,"description":"Filter transactions closed since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"owned_by","in":"query","required":false,"description":"Filter transactions by owner\nowner format TYPE-ID, i.g. “User-230” or “Contact-1245”\n","example":"User-230","schema":{"type":"string"}},{"name":"external_ids","in":"query","required":false,"description":"Filter transactions by the comma separated list of externale IDs\n","example":"crm123,extdId124,234","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Transaction list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransactionV1"}}}}}}},"post":{"summary":"Creates new transaction","description":"API to create new transaction.\n","tags":["TRANSACTIONS (deprecated)"],"requestBody":{"description":"Transaction to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTransactionV1"},"examples":{"transactionExample":{"$ref":"#/components/examples/NewTransactionV1"}}}}},"responses":{"200":{"description":"Created transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionV1"}}}}}}},"/v1/transactions/{id}":{"get":{"summary":"Get transaction by ID","tags":["TRANSACTIONS (deprecated)"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionV1"}}}}}},"put":{"summary":"Updates transaction","description":"Allows to update existing transaction\nUpdate will affect only specified fields, all other fields will be preserve their values.\n\n\\* *updated_at and created_at are read-only fields* \u003cbr/\u003e\n** *custom_attributes is a single field and subject for full replacement by received value*\n","tags":["TRANSACTIONS (deprecated)"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"requestBody":{"description":"Transaction updates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransactionV1"},"examples":{"transactionExample":{"$ref":"#/components/examples/NewTransactionV1"}}}}},"responses":{"200":{"description":"Updated transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionV1"}}}}}},"delete":{"summary":"Delete transaction by ID","tags":["TRANSACTIONS (deprecated)"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction deleted"}}}},"/v1/transactions/search":{"get":{"summary":"Search transaction","tags":["TRANSACTIONS (deprecated)"],"parameters":[{"name":"keyword","in":"query","description":"text to search in transaction address, MLS number, agent name or email","required":true,"example":"28687 Euna Stravenue","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Transaction list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchTransaction"}}}}}}}},"/v2/transactions":{"get":{"summary":"List available transactions","description":"The resulting list will be limited by at most 1000 records.\nFollowing parameters allow to paginate and filter the output.\n","tags":["TRANSACTIONS V2 (deprecated)"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"statuses","in":"query","required":false,"description":"Filter transactions by specified statuses.\nAllowed values: `pre-listing`, `listing`, `pending`, `closed`, `cancelled`\n","examples":{"statuses":{"value":["listing","pending"],"summary":"comma separated multiple statuses"}},"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["pre-listing","listing","pending","closed","cancelled"]}}},{"name":"created_since","in":"query","required":false,"description":"Filter transactions created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"updated_since","in":"query","required":false,"description":"Filter transactions updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"closed_since","in":"query","required":false,"description":"Filter transactions closed since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"closing_date_range","in":"query","required":false,"description":"Filter transactions that have closing_date within specified date range. \u003cbr/\u003e\nit expects valid Unix timestamp range in a form of: `{from date}-{to date}` \u003cbr/\u003e\ne.g. `closing_date=1556697600-1557165600` \u003cbr/\u003e\ntranslates to: \u003cbr/\u003e\n         from `1556697600` (Wed, 01 May 2019 00:00:00 -0800) \u003cbr/\u003e\n         to   `1557165600` (Mon, 06 May 2019 10:00:00 -0800) \u003cbr/\u003e\nalso you can use shortcuts like:\n  - today\n  - yesterday\n  - tomorrow\n  - in_the_past\n  - in_a_future\n  - week_to_date\n  - current_week\n  - last_week\n  - last_2_weeks\n  - next_week\n  - month_to_date\n  - current_month\n  - last_month\n  - last_2_months\n  - last_3_months\n  - next_month\n  - next_2_months\n  - next_3_months\n  - same_month_last_year\n  - quarter_to_date\n  - current_quarter\n  - last_quarter\n  - q1_of_this_year\n  - q2_of_this_year\n  - q3_of_this_year\n  - q4_of_this_year\n  - same_quarter_last_year\n  - ytd\n  - current_year\n  - last_year\n  - next_year\n","examples":{"timestamps":{"value":"1556697600-1557165600","summary":"13-digit unix timestamps range"},"shortcut":{"value":"last_month","summary":"date range that covers last month"}},"schema":{"type":"string"}},{"name":"lead_source","in":"query","required":false,"description":"Filter transactions by lead source.\n","example":"Salesforce","schema":{"type":"string"}},{"name":"owned_by","in":"query","required":false,"description":"Filter transactions by owner.\nParameter format TYPE-ID, i.g. “User-230” or “Contact-1245”\n","example":"User-230","schema":{"type":"string"}},{"name":"participated_by","in":"query","required":false,"description":"Filter transactions by participant.\nParameter format TYPE-ID, i.g. “User-230” or “Contact-1245”\n","example":"User-230","schema":{"type":"string"}},{"name":"representing","in":"query","required":false,"description":"Filter transactions by side representer.\nAllowed values: `buyer`, `seller`, `both`\n","example":"seller","schema":{"type":"string"}},{"name":"external_ids","in":"query","required":false,"description":"Filter transactions by the comma separated list of external IDs\n","example":"crm123,extdId124,234","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"full_info","in":"query","required":false,"description":"Specifies whether to retrieve short or full transaction information.\nBy default each transaction has only: id, status, address, city, state, zip, price,\nrepresenting, transaction_name.\nSet to 1 to get full transaction shape including sides, commission totals and custom fields.\n","schema":{"type":"integer","enum":[0,1]},"example":1},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values:\n  - `commission_items` - commission items of the transaction\n  - `participants` - people on the transaction (agents and contacts) with their names, emails and roles\n","example":"commission_items,participants","schema":{"type":"array","items":{"type":"string"}}},{"name":"timezone","in":"query","description":"timezone you need filters to be interpreted in, 0 (UTC) by default","example":-8,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction list response","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"title":"TransactionV2","allOf":[{"$ref":"#/components/schemas/TransactionV2"},{"$ref":"#/components/schemas/TransactionIncludes"}]},{"title":"ShortTransactionV2","allOf":[{"$ref":"#/components/schemas/ShortTransactionV2"},{"$ref":"#/components/schemas/TransactionIncludes"}]}]}}}}}}},"post":{"summary":"Creates new transaction","description":"API to create new transaction.\n","tags":["TRANSACTIONS V2 (deprecated)"],"requestBody":{"description":"Transaction to create","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewTransactionV2"},{"type":"object","properties":{"buyer_offer_id":{"type":"string","description":"ID of associated accepted buyer offer","examples":["1234567890"]}}}]},"examples":{"transactionExample":{"$ref":"#/components/examples/NewTransactionV2"}}}}},"responses":{"200":{"description":"Created transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionV2"}}}}}}},"/v2/transactions/{bm_transaction_id}":{"get":{"summary":"Get transaction by ID","tags":["TRANSACTIONS V2 (deprecated)"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values:\n  - `commission_items` - commission items of the transaction\n  - `participants` - people on the transaction (agents and contacts) with their names, emails and roles\n","example":"commission_items,participants","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Transaction","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TransactionV2"},{"$ref":"#/components/schemas/TransactionIncludes"}]}}}}}},"put":{"summary":"Updates transaction","description":"Allows to update existing transaction\nUpdate will affect only specified fields, all other fields will be preserve their values.\n\n\\* *updated_at and created_at are read-only fields*\n","tags":["TRANSACTIONS V2 (deprecated)"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"requestBody":{"description":"Transaction updates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransactionV2"},"examples":{"transactionExample":{"$ref":"#/components/examples/NewTransactionV2"}}}}},"responses":{"200":{"description":"Updated transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionV2"}}}}}},"delete":{"summary":"Delete transaction by ID","tags":["TRANSACTIONS V2 (deprecated)"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction deleted"}}}},"/v2/transactions/deleted":{"get":{"summary":"List Deleted Transactions","tags":["TRANSACTIONS V2 (deprecated)"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"name":"deleted_since","in":"query","required":false,"description":"Filter transactions updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}}],"responses":{"200":{"description":"Deleted transactions information","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"deleted_at":{"$ref":"#/components/schemas/dateStamp"},"external_id":{"type":["string","null"],"description":"External identifier of the transaction; null when it was not set.","examples":["dotloop:123"]},"metadata":{"type":"object","properties":{"deletion_type":{"type":"string","enum":["deleted","moved"],"description":"How the transaction left this account:\n\"deleted\" for an outright deletion, \"moved\" when it was moved to\nanother account (see moved_to_account_id).\n","examples":["deleted"]},"moved_to_account_id":{"type":"integer","description":"Target account id; present only when deletion_type is \"moved\".","examples":[10020]}}}}}}}}}}}},"/v3/transactions":{"get":{"summary":"List available transactions","description":"The resulting list will be limited by at most 1000 records.\nFollowing parameters allow to paginate and filter the output.\n","tags":["TRANSACTIONS V3"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"statuses","in":"query","required":false,"description":"Filter transactions by specified statuses.\nAllowed values: `opportunity`, `active`, `pending`, `closed`, `cancelled`\n","examples":{"statuses":{"value":["active","pending"],"summary":"comma separated multiple statuses"}},"style":"form","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransactionStatusValue"}}},{"name":"created_since","in":"query","required":false,"description":"Filter transactions created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"updated_since","in":"query","required":false,"description":"Filter transactions updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"closed_since","in":"query","required":false,"description":"Filter transactions closed since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"closing_date_range","in":"query","required":false,"description":"Filter transactions that have closing_date within specified date range. \u003cbr/\u003e\nit expects valid Unix timestamp range in a form of: `{from date}-{to date}` \u003cbr/\u003e\ne.g. `closing_date=1556697600-1557165600` \u003cbr/\u003e\ntranslates to: \u003cbr/\u003e\n         from `1556697600` (Wed, 01 May 2019 00:00:00 -0800) \u003cbr/\u003e\n         to   `1557165600` (Mon, 06 May 2019 10:00:00 -0800) \u003cbr/\u003e\nalso you can use shortcuts like:\n  - today\n  - yesterday\n  - tomorrow\n  - in_the_past\n  - in_a_future\n  - week_to_date\n  - current_week\n  - last_week\n  - last_2_weeks\n  - next_week\n  - month_to_date\n  - current_month\n  - last_month\n  - last_2_months\n  - last_3_months\n  - next_month\n  - next_2_months\n  - next_3_months\n  - same_month_last_year\n  - quarter_to_date\n  - current_quarter\n  - last_quarter\n  - q1_of_this_year\n  - q2_of_this_year\n  - q3_of_this_year\n  - q4_of_this_year\n  - same_quarter_last_year\n  - ytd\n  - current_year\n  - last_year\n  - next_year\n","examples":{"timestamps":{"value":"1556697600-1557165600","summary":"13-digit unix timestamps range"},"shortcut":{"value":"last_month","summary":"date range that covers last month"}},"schema":{"type":"string"}},{"name":"lead_source","in":"query","required":false,"description":"Filter transactions by lead source.\n","example":"Salesforce","schema":{"type":"string"}},{"name":"owned_by","in":"query","required":false,"description":"Filter transactions by owner.\nParameter format TYPE-ID, i.g. “User-230” or “Contact-1245”\n","example":"User-230","schema":{"type":"string"}},{"name":"participated_by","in":"query","required":false,"description":"Filter transactions by participant.\nParameter format TYPE-ID, i.g. “User-230” or “Contact-1245”\n","example":"User-230","schema":{"type":"string"}},{"name":"representing","in":"query","required":false,"description":"Filter transactions by side representer.\nAllowed values: `buyer`, `seller`, `both`\n","example":"seller","schema":{"type":"string"}},{"name":"external_ids","in":"query","required":false,"description":"Filter transactions by the comma separated list of external IDs\n","example":"crm123,extdId124,234","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"full_info","in":"query","required":false,"description":"Specifies whether to retrieve short or full transaction information.\nBy default each transaction has only: id, status, address, city, state, zip, price,\nrepresenting, transaction_name.\nSet to 1 to get full transaction shape including sides, commission totals and custom fields.\n","schema":{"type":"integer","enum":[0,1]},"example":1},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values:\n  - `commission_items` - commission items of the transaction\n  - `participants` - people on the transaction (agents and contacts) with their names, emails and roles\n","example":"commission_items,participants","schema":{"type":"array","items":{"type":"string"}}},{"name":"timezone","in":"query","description":"timezone you need filters to be interpreted in, 0 (UTC) by default","example":-8,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction list response","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"title":"TransactionV3","allOf":[{"$ref":"#/components/schemas/TransactionV3"},{"$ref":"#/components/schemas/TransactionIncludes"}]},{"title":"ShortTransactionV3","allOf":[{"$ref":"#/components/schemas/ShortTransactionV3"},{"$ref":"#/components/schemas/TransactionIncludes"}]}]}}}}}}},"post":{"summary":"Creates new transaction","description":"API to create new transaction.\n","tags":["TRANSACTIONS V3"],"requestBody":{"description":"Transaction to create","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/NewTransactionV3"},{"type":"object","properties":{"buyer_offer_id":{"type":"string","description":"ID of associated accepted buyer offer","examples":["1234567890"]},"apply_checklist_automation":{"$ref":"#/components/schemas/ApplyChecklistAutomation"}}}]},"examples":{"transactionExample":{"$ref":"#/components/examples/NewTransactionV3"}}}}},"responses":{"200":{"description":"Created transaction","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TransactionV3"},{"$ref":"#/components/schemas/AppliedChecklists"}]}}}},"400":{"$ref":"#/components/responses/BadRequestMissingChecklistRoles"}}}},"/v3/transactions/{bm_transaction_id}":{"get":{"summary":"Get transaction by ID","tags":["TRANSACTIONS V3"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values:\n  - `commission_items` - commission items of the transaction\n  - `participants` - people on the transaction (agents and contacts) with their names, emails and roles\n","example":"commission_items,participants","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Transaction","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TransactionV3"},{"$ref":"#/components/schemas/TransactionIncludes"}]}}}}}},"put":{"summary":"Updates transaction","description":"Allows to update existing transaction\nUpdate will affect only specified fields, all other fields will be preserve their values.\n\n\\* *updated_at and created_at are read-only fields*\n","tags":["TRANSACTIONS V3"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"requestBody":{"description":"Transaction updates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransactionV3"},"examples":{"transactionExample":{"$ref":"#/components/examples/NewTransactionV3"}}}}},"responses":{"200":{"description":"Updated transaction","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TransactionV3"},{"$ref":"#/components/schemas/AppliedChecklists"}]}}}},"400":{"$ref":"#/components/responses/BadRequestMissingChecklistRoles"}}},"delete":{"summary":"Delete transaction by ID","tags":["TRANSACTIONS V3"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction deleted"}}}},"/v3/transactions/deleted":{"get":{"summary":"List Deleted Transactions","tags":["TRANSACTIONS V3"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"name":"deleted_since","in":"query","required":false,"description":"Filter transactions updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}}],"responses":{"200":{"description":"Deleted transactions information","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"deleted_at":{"$ref":"#/components/schemas/dateStamp"},"external_id":{"type":["string","null"],"description":"External identifier of the transaction; null when it was not set.","examples":["dotloop:123"]},"metadata":{"type":"object","properties":{"deletion_type":{"type":"string","enum":["deleted","moved"],"description":"How the transaction left this account:\n\"deleted\" for an outright deletion, \"moved\" when it was moved to\nanother account (see moved_to_account_id).\n","examples":["deleted"]},"moved_to_account_id":{"type":"integer","description":"Target account id; present only when deletion_type is \"moved\".","examples":[10020]}}}}}}}}}}}},"/v3/transactions/schema":{"get":{"summary":"Get current transactions schema","description":"Returns the transaction fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means.","tags":["TRANSACTIONS V3"],"responses":{"200":{"description":"Current transactions schema","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/FieldDescriptor"},{"type":"object","description":"Transaction fields additionally support conditional requirements, beyond the base \"always required\" flag.","properties":{"requirements":{"type":"object","description":"Scenarios in which the field is required","properties":{"always":{"type":"boolean","description":"Field is always required","examples":[false]},"when":{"type":"object","description":"Field is required when all listed conditions match","properties":{"representings":{"type":"array","items":{"$ref":"#/components/schemas/RepresentingSide"},"examples":[["buyer"]]},"status":{"type":"array","items":{"$ref":"#/components/schemas/TransactionStatusValue"},"examples":[["opportunity","active"]]}}},"except":{"type":"object","description":"Field is required except when all listed conditions match","properties":{"representings":{"type":"array","items":{"$ref":"#/components/schemas/RepresentingSide"},"examples":[["buyer"]]},"status":{"type":"array","items":{"$ref":"#/components/schemas/TransactionStatusValue"},"examples":[["opportunity","active","cancelled"]]}}}}}}}]}}}}}}}},"/v3/transactions/{bm_transaction_id}/schema":{"get":{"summary":"Get specific transaction fields schema","description":"Returns the field schema of one transaction: the built-in fields plus the custom fields as they are set on that transaction, which may differ from the account's current schema. Each entry describes one field — see the response schema for what each key means.","tags":["TRANSACTIONS V3"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns historic transaction schema","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/FieldDescriptor"},{"type":"object","description":"Transaction fields additionally support conditional requirements, beyond the base \"always required\" flag.","properties":{"requirements":{"type":"object","description":"Scenarios in which the field is required","properties":{"always":{"type":"boolean","description":"Field is always required","examples":[false]},"when":{"type":"object","description":"Field is required when all listed conditions match","properties":{"representings":{"type":"array","items":{"$ref":"#/components/schemas/RepresentingSide"},"examples":[["buyer"]]},"status":{"type":"array","items":{"$ref":"#/components/schemas/TransactionStatusValue"},"examples":[["opportunity","active"]]}}},"except":{"type":"object","description":"Field is required except when all listed conditions match","properties":{"representings":{"type":"array","items":{"$ref":"#/components/schemas/RepresentingSide"},"examples":[["buyer"]]},"status":{"type":"array","items":{"$ref":"#/components/schemas/TransactionStatusValue"},"examples":[["opportunity","active","cancelled"]]}}}}}}}]}}}}}}}},"/v3/transactions/{bm_transaction_id}/comments":{"get":{"summary":"List of transaction's comments","tags":["TRANSACTIONS V3"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"responses":{"200":{"description":"List of transaction's comments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"post":{"summary":"Add a comment to a transaction","tags":["TRANSACTIONS V3"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"requestBody":{"description":"Comment body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewComment"}}}},"responses":{"200":{"description":"Comment added","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Comment"},{"type":"object","properties":{"mentions_without_access":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User ID"},"name":{"type":"string","description":"User name"},"type":{"type":"string","description":"User type"}},"examples":[{"id":123,"name":"John Doe","type":"user"}]}}}}]}}}}}}},"/v3/transactions/{bm_transaction_id}/comments/{comment_id}":{"put":{"summary":"Update a comment","tags":["TRANSACTIONS V3"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}},{"name":"comment_id","in":"path","required":true,"description":"ID of comment","schema":{"type":"integer"}}],"requestBody":{"description":"Comment body","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewComment"}}}},"responses":{"200":{"description":"Comment updated","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Comment"},{"type":"object","properties":{"mentions_without_access":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User ID"},"name":{"type":"string","description":"User name"},"type":{"type":"string","description":"User type"}},"examples":[{"id":123,"name":"John Doe","type":"user"}]}}}}]}}}}}}},"/v3/transactions/search":{"get":{"summary":"Search transaction","tags":["TRANSACTIONS V3"],"parameters":[{"name":"keyword","in":"query","description":"text to search in transaction address, MLS number, agent name or email","required":true,"example":"28687 Euna Stravenue","schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Transaction list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchTransaction"}}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists":{"get":{"summary":"List of available transaction's checklists","tags":["TRANSACTION CHECKLISTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of available transaction's checklists","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransactionChecklist"}}}}}}},"post":{"summary":"Add a checklist to the transaction","tags":["TRANSACTION CHECKLISTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Checklist template id","required":true,"content":{"application/json":{"schema":{"type":"object","required":["checklist_template_id"],"properties":{"checklist_template_id":{"type":"integer","format":"int64","examples":[2]}}}}}},"responses":{"201":{"description":"Created checklist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Checklist"}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/batch_add":{"post":{"summary":"Add multiple checklists to the transaction","tags":["TRANSACTION CHECKLISTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Checklist template ids","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"checklist_template_ids":{"type":"array","items":{"type":"integer"}}},"examples":[{"checklist_template_ids":[341]}]}}}},"responses":{"201":{"description":"Created checklists","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Checklist"}}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}":{"get":{"summary":"Get transaction checklist by ID","tags":["TRANSACTION CHECKLISTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Checklist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionChecklist"}}}}}},"put":{"summary":"Updates checklist name","description":"Allows to update existing checklist name\n","tags":["TRANSACTION CHECKLISTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Checklist updates","required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","examples":["Buying"]}}}}}},"responses":{"200":{"description":"Checklist updated"}}},"delete":{"summary":"Delete checklist by ID","tags":["TRANSACTION CHECKLISTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","schema":{"type":"integer"}},{"name":"documents_action","in":"query","required":false,"description":"By default, it unassigns document from tasks and moves them to the unsorted transaction folder.","schema":{"type":"string","enum":["delete","unassign"]},"example":"delete"}],"responses":{"200":{"description":"Checklist deleted"}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/void":{"post":{"summary":"Void checklist by ID","tags":["TRANSACTION CHECKLISTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer","examples":[1234]}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","schema":{"type":"integer","examples":[1234]}},{"name":"submitted_documents_action","in":"query","required":false,"description":"Action to be applied to the pending documents on the checklist tasks, by default it does nothing.","schema":{"type":"string","enum":["ignore","approve","reject"]},"example":"reject"}],"responses":{"200":{"description":"Checklist voided"}}}},"/v1/transactions/checklist_templates":{"get":{"summary":"List available checklist templates","tags":["TRANSACTION CHECKLISTS"],"responses":{"200":{"description":"Checklist template list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChecklistTemplateWithAutoapply"}},"examples":{"checklistTemplateExample":{"$ref":"#/components/examples/ChecklistTemplateWithAutoapply"}}}}}}}},"/v1/transactions/{bm_transaction_id}/documents":{"post":{"summary":"Upload document to transaction","tags":["TRANSACTION DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Transaction comment","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"task_id":{"type":"integer","description":"ID of task to add document to","examples":[439]},"name":{"type":"string","description":"Document's file name","examples":["Listing agreement.pdf"]},"content_type":{"type":"string","default":"text/plain","examples":["application/pdf"]},"path":{"type":"string","format":"URL","description":"public URL to document file","examples":["https://s3-eu-central-1.amazonaws.com/BUCKET/FILE"]}}}}}},"responses":{"200":{"description":"ID of newly created document, not yet uploaded","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","examples":[123]}}}}}}}},"get":{"summary":"Get list of transaction's documents","tags":["TRANSACTION DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}}}}},"/v1/transactions/{bm_transaction_id}/documents/{document_id}":{"get":{"summary":"Get transaction's document","tags":["TRANSACTION DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}},{"name":"with_preview_url","in":"query","required":false,"description":"Set to 1 to retrieve documents with preview link","example":1,"schema":{"type":"integer","enum":[0,1],"default":0}}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Document"},{"$ref":"#/components/schemas/DocumentWithPreviewUrl"}]}}}}}},"delete":{"summary":"Remove transaction's document","tags":["TRANSACTION DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Document deleted"}}}},"/v1/transactions/{bm_transaction_id}/documents/{document_id}/rename":{"post":{"summary":"Rename document","description":"Allows to change existing document name\n","tags":["TRANSACTION DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Document update","required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","examples":["Listing agreement"]}}}}}},"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}}}}},"/v1/transactions/{bm_transaction_id}/documents/request_upload_url":{"post":{"summary":"Request document upload URL","description":"Generate a new upload document link. [See how file uploading works](#tag/UPLOAD-DOCUMENTS)\n","tags":["TRANSACTION DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}},{"name":"task_id","in":"query","required":false,"description":"Task ID\u003cbr\u003e\nIt allows attach an uploaded document to a specified task \u003cbr\u003e\notherwise it will be uploaded to the \"Unsorted\" folder of transaction\n","schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionDocumentUploadUrl"}}}}}}},"/v1/transactions/{bm_transaction_id}/send_email":{"post":{"summary":"Send transaction email","description":"Send an email from a transaction to users or contacts of the account, optionally attaching\ndocuments. Recipients must be existing users or contacts; to email an address that is neither,\ncreate a contact for it first.\n","tags":["TRANSACTION DOCUMENTS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["to","subject","message"],"properties":{"to":{"type":"array","items":{"$ref":"#/components/schemas/TransactionEmailRecipient"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/TransactionEmailRecipient"}},"subject":{"type":"string","examples":["Signed listing agreement"]},"message":{"type":"string","examples":["Please find the signed listing agreement attached."]},"document_ids":{"type":"array","description":"Documents of this transaction to attach","items":{"type":"integer"}},"exclude_audit_trails":{"type":"boolean","description":"Remove BackOffice e-sign audit trail pages, if any, from the attached documents"}}},"example":{"to":[{"id":123,"type":"user"},{"id":745,"type":"contact"}],"subject":"Signed listing agreement","message":"Please find the signed listing agreement attached.","document_ids":[5678]}}}},"responses":{"200":{"description":"Email sent","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["sent"]},"recipients_count":{"type":"integer","description":"Number of email addresses the email was sent to"},"cc_count":{"type":"integer","description":"Number of email addresses copied (CC)"},"documents_count":{"type":"integer","description":"Number of documents attached"}}}}}}}}},"/v1/buyer_offers":{"get":{"summary":"List available buyer offers","description":"The resulting list will be limited by at most 1000 records.\nFollowig parameters allow to paginate and filter the output.\n","tags":["BUYER OFFERS"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"statuses","in":"query","required":false,"description":"Filter buyer offers by specified statuses.\n","examples":{"statuses":{"value":["rejected","withdrawn"],"summary":"comma separated multiple statuses"}},"style":"form","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOfferStatus"}}},{"name":"created_since","in":"query","required":false,"description":"Filter buyer offers created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"updated_since","in":"query","required":false,"description":"Filter buyer offers updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"closing_date_range","in":"query","required":false,"description":"Filter buyer offers that have closing_date within specified date range. \u003cbr/\u003e\nit expects valid Unix timestamp range in a form of: `{from date}-{to date}` \u003cbr/\u003e\ne.g. `closing_date=1556697600-1557165600` \u003cbr/\u003e\ntranslates to: \u003cbr/\u003e\n         from `1556697600` (Wed, 01 May 2019 00:00:00 -0800) \u003cbr/\u003e\n         to   `1557165600` (Mon, 06 May 2019 10:00:00 -0800) \u003cbr/\u003e\nalso you can use shortcuts like:\n  - today\n  - yesterday\n  - tomorrow\n  - in_the_past\n  - in_a_future\n  - week_to_date\n  - current_week\n  - last_week\n  - last_2_weeks\n  - next_week\n  - month_to_date\n  - current_month\n  - last_month\n  - last_2_months\n  - last_3_months\n  - next_month\n  - next_2_months\n  - next_3_months\n  - same_month_last_year\n  - quarter_to_date\n  - current_quarter\n  - last_quarter\n  - q1_of_this_year\n  - q2_of_this_year\n  - q3_of_this_year\n  - q4_of_this_year\n  - same_quarter_last_year\n  - ytd\n  - current_year\n  - last_year\n  - next_year\n","examples":{"timestamps":{"value":"1556697600-1557165600","summary":"13-digit unix timestamps range"},"shortcut":{"value":"last_month","summary":"date range that covers last month"}},"schema":{"type":"string"}},{"name":"owned_by","in":"query","required":false,"description":"Filter buyer offers by owner.\nParameter format TYPE-ID, i.g. “User-230” or “Contact-1245”\n","example":"User-230","schema":{"type":"string"}},{"name":"participated_by","in":"query","required":false,"description":"Filter buyer offers by participant.\nParameter format TYPE-ID, i.g. “User-230” or “Contact-1245”\n","example":"User-230","schema":{"type":"string"}},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values: `participants`\n","example":"participants","schema":{"type":"array","items":{"type":"string","enum":["participants"]}}},{"name":"timezone","in":"query","description":"timezone you need filters to be interpreted in, 0 (UTC) by default","example":-8,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Buyer offer list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOfferResponseWithParticipants"}}}}}}},"post":{"summary":"Creates new buyer offer","description":"API to create new buyer offer.\n","tags":["BUYER OFFERS"],"requestBody":{"description":"Buyer offer to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewBuyerOfferRequest"}}}},"responses":{"200":{"description":"Created buyer offer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOfferResponseWithParticipants"}}}}}}},"/v1/buyer_offers/{id}":{"get":{"summary":"Get buyer offer by ID","tags":["BUYER OFFERS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of a buyer offer","schema":{"type":"integer"}},{"name":"include","in":"query","style":"form","explode":false,"required":false,"description":"Includes related objects into output.\nAllowed values: `participants`\n","example":"participants","schema":{"type":"array","items":{"type":"string","enum":["participants"]}}}],"responses":{"200":{"description":"Buyer offer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOfferResponseWithParticipants"}}}}}},"put":{"summary":"Updates buyer offer","description":"Allows to update existing buyer offer\nUpdate will affect only specified fields, all other fields will be preserve their values.\n","tags":["BUYER OFFERS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of buyer offer","schema":{"type":"integer"}}],"requestBody":{"description":"Buyer offer updates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBuyerOfferRequest"}}}},"responses":{"200":{"description":"Updated buyer offer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOfferResponse"}}}}}},"delete":{"summary":"Permanently deletes buyer offer","description":"Permanently deletes buyer offer and all associated with it data including documents.\nIn most of the cases updating buyer offer state to \"withdrawn\" is preferable to deletion.\n","tags":["BUYER OFFERS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of buyer offer","schema":{"type":"integer"}}],"responses":{"200":{"description":"Buyer offer deleted"}}}},"/v1/buyer_offers/schema":{"get":{"summary":"Get current buyer offers schema","description":"Returns the buyer offer fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means.","tags":["BUYER OFFERS"],"responses":{"200":{"description":"Current buyer offers schema","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldDescriptor"}}}}}}}},"/v1/buyer_offers/search":{"get":{"summary":"Search buyer offer","tags":["BUYER OFFERS"],"parameters":[{"name":"keyword","in":"query","description":"text to search in buyer offer address, MLS number, contact name","required":true,"example":"123 West Park","schema":{"type":"string"}},{"name":"buyer_opportunity_id","in":"query","description":"The ID of transaction where the offers are located","required":false,"example":123,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Buyer offer list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOfferShortResponse"}}}}}}}},"/v1/buyer_offers/{id}/participants":{"put":{"summary":"Update buyer offer participants","tags":["BUYER OFFER PARTICIPANTS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of a buyer offer","schema":{"type":"integer"}},{"name":"participants","in":"query","required":true,"style":"form","schema":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOfferParticipantRequestSchema"}}}],"responses":{"200":{"description":"Task","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOfferParticipant"}}}}}}}},"/v1/buyer_offers/checklist_templates":{"get":{"summary":"List available checklist templates","tags":["BUYER OFFER CHECKLISTS"],"responses":{"200":{"description":"Checklist template list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChecklistTemplate"}}}}}}}},"/v1/buyer_offers/{buyer_offer_id}/tasks":{"get":{"summary":"Get list of tasks","tags":["BUYER OFFER TASKS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"incomplete_tasks_only","in":"query","required":false,"description":"This parameter is used to filter the task by completion status.\nUse \"1\" to query not completed tasks only. By default all tasks are returned.\n","schema":{"type":"integer","enum":[0,1]},"example":1}],"responses":{"200":{"description":"Task","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}}},"/v1/buyer_offers/{buyer_offer_id}/tasks/{task_id}":{"get":{"summary":"Get task by ID","tags":["BUYER OFFER TASKS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of BuyerOfferTask","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}}},"/v1/buyer_offers/{buyer_offer_id}/tasks/apply_checklist_template":{"post":{"summary":"Apply checklist template","tags":["BUYER OFFER TASKS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"checklist_template_id","in":"query","required":true,"description":"ID of buyer offer's checklist template","example":1234,"schema":{"type":"integer"}},{"name":"replace_todo_tasks","in":"query","required":false,"description":"This parameter allows you to remove all incomplete to-do tasks from the buyer offer before adding a new checklist.\nIt set to `false` by default and all the new tasks will be added on top of existing ones.\n","example":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Checklist template applied"}}}},"/v1/buyer_offers/{buyer_offer_id}/tasks/{task_id}/complete":{"post":{"summary":"Complete task","tags":["BUYER OFFER TASKS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of BuyerOfferTask","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task completed"}}}},"/v1/buyer_offers/{buyer_offer_id}/tasks/{task_id}/request_exemption":{"post":{"summary":"Request task exemption","tags":["BUYER OFFER TASKS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of BuyerOfferTask","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task exemption requested"}}}},"/v1/buyer_offers/{buyer_offer_id}/tasks/{task_id}/move_to_todo":{"post":{"summary":"Move task to \"todo\"","tags":["BUYER OFFER TASKS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of BuyerOfferTask","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task moved"}}}},"/v1/buyer_offers/{buyer_offer_id}/tasks/{task_id}/move_to_in_progress":{"post":{"summary":"Move task to \"in progress\"","tags":["BUYER OFFER TASKS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of BuyerOfferTask","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task moved"}}}},"/v1/buyer_offers/{buyer_offer_id}/documents":{"get":{"summary":"Get list of buyer offer's documents","tags":["BUYER OFFER DOCUMENTS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BuyerOfferDocument"}}}}}}}},"/v1/buyer_offers/{buyer_offer_id}/documents/{document_id}":{"get":{"summary":"Get buyer offer's document","tags":["BUYER OFFER DOCUMENTS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","example":1234,"schema":{"type":"integer"}},{"name":"document_id","in":"path","required":true,"description":"ID of document","example":1234,"schema":{"type":"integer"}},{"name":"with_preview_url","in":"query","required":false,"description":"Set to 1 to retrieve documents with preview link","example":1,"schema":{"type":"integer","enum":[0,1],"default":0}}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuyerOfferDocument"},{"$ref":"#/components/schemas/BuyerOfferDocumentWithPreviewUrl"}]}}}}}}},"/v1/buyer_offers/{buyer_offer_id}/documents/request_upload_url":{"post":{"summary":"Request document upload URL","description":"Generate a new upload document link. [See how file uploading works](#tag/UPLOAD-DOCUMENTS)\n","tags":["BUYER OFFER DOCUMENTS"],"parameters":[{"name":"buyer_offer_id","in":"path","required":true,"description":"ID of buyer offer","schema":{"type":"integer"}},{"name":"task_id","in":"query","required":false,"description":"Task ID\u003cbr\u003e\nIt allows attach an uploaded document to a specified task\n","schema":{"type":"integer"}}],"responses":{"200":{"description":"Upload document URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerOfferDocumentWithUploadUrl"}}}}}}},"/v1/accounting/chart_of_accounts/accounts":{"get":{"summary":"Get Accounts","tags":["CHART OF ACCOUNTS (COA)"],"operationId":"getCoaAccounts","responses":{"200":{"description":"Accounts","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CoaAccount"}}}}}}}},"/v1/accounting/chart_of_accounts/groups":{"get":{"summary":"Get Groups","tags":["CHART OF ACCOUNTS (COA)"],"operationId":"getCoaGroups","responses":{"200":{"description":"Account Groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CoaGroup"}}}}}}}},"/v1/commission_plans":{"get":{"summary":"List of available commission plans","tags":["COMMISSION PLANS"],"responses":{"200":{"description":"List of available commission plans","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionPlan"}}}}}}}},"/v1/commission_plans/{id}":{"get":{"summary":"Get commission plan by ID","tags":["COMMISSION PLANS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of commission plan","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Commission plan with commission items","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionPlanWithItems"}}}}}}}},"/v1/users/{user_id}/commission_plans":{"get":{"summary":"List commission plans assigned to user","tags":["USER COMMISSION PLANS"],"parameters":[{"name":"user_id","in":"path","required":true,"description":"ID of user","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of user's assigned commission plans","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionPlan"}}}}}}}},"/v1/users/{user_id}/commission_plans/{plan_id}":{"post":{"summary":"Assing commission plan to user","tags":["USER COMMISSION PLANS"],"parameters":[{"name":"user_id","in":"path","required":true,"description":"ID of user","example":1234,"schema":{"type":"integer"}},{"name":"plan_id","in":"path","required":true,"description":"ID of commission plan","example":5,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of user's assigned commission plans","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionPlan"}}}}}}},"delete":{"summary":"Unassign commission plan from user","tags":["USER COMMISSION PLANS"],"parameters":[{"name":"user_id","in":"path","required":true,"description":"ID of user","example":1234,"schema":{"type":"integer"}},{"name":"plan_id","in":"path","required":true,"description":"ID of commission plan","example":5,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of user's assigned commission plans","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionPlan"}}}}}}}},"/v1/transactions/{bm_transaction_id}/commissions":{"get":{"summary":"Get the list of transaction commission items","tags":["TRANSACTION COMMISSIONS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of transaction's commission items","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionItem"}}}}}}},"put":{"summary":"Replace transaction commission items","description":"Replaces all commission items of the transaction and finalizes the commissions by default.\nPass `finalize=0` to keep the commissions as a draft that is finalized separately.\n","tags":["TRANSACTION COMMISSIONS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"finalize","in":"query","required":false,"description":"Defaults to `1` when not provided: the commissions are finalized right away.\nUse `0` to keep them as a draft.\n","schema":{"type":"integer","enum":[0,1],"default":1},"example":0}],"requestBody":{"description":"[See above](#tag/TRANSACTION-COMMISSIONS) for more details about\ncommission items structure and required commission item types.\n","required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionItem"}},"examples":{"TransactionCommissions":{"$ref":"#/components/examples/TransactionCommissions"}}}}},"responses":{"200":{"description":"List of transaction's commission items","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionItem"}}}}}}}},"/v1/transactions/{bm_transaction_id}/commissions/finalize":{"post":{"summary":"Finalize transaction commissions","tags":["TRANSACTION COMMISSIONS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Transaction commissions finalized"}}}},"/v1/transactions/{bm_transaction_id}/commissions/agents/{agent_id}/plans":{"post":{"summary":"Apply commission plan","tags":["TRANSACTION COMMISSIONS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"agent_id","in":"path","required":true,"description":"ID of an existing agent","example":456,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["side"],"properties":{"side":{"type":"string","enum":["listing","buying"],"examples":["listing"]},"plan_id":{"oneOf":[{"type":"integer"},{"type":"string","enum":["first"]}],"description":"Plan id to apply or '**first**' string value to apply user's default (first) plan.\n","examples":[789]}}}}}},"responses":{"200":{"description":"List of transaction's commission items","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommissionItem"}}}}}}}},"/v1/transactions/{bm_transaction_id}/commissions/info":{"get":{"summary":"Get commission info","tags":["TRANSACTION COMMISSIONS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Commission status info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommissionInfo"}}}}}}},"/v1/contacts":{"get":{"summary":"List available contacts in account","description":"The resulting list will be limited by at most 1000 records.\nFollowig parameters allow to paginate and filter the output.\n","tags":["CONTACTS"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"created_since","in":"query","required":false,"description":"Filter contacts created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"updated_since","in":"query","required":false,"description":"Filter contacts updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"external_ids","in":"query","required":false,"description":"Filter contacts by the comma separated list of externale IDs\n","example":"crm123,extdId124,234","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"emails","in":"query","required":false,"description":"Filter contacts by the comma separated list of emails\n","example":"a@b.com,test@example.com","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"full_info","in":"query","required":false,"description":"Specifies whether to retrieve short or full contact information.\n","schema":{"type":"integer","enum":[0,1],"default":0},"example":1}],"responses":{"200":{"description":"Contats list response","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/FullContact"},{"$ref":"#/components/schemas/ShortContact"}]}}}}}}},"post":{"summary":"Create contact","tags":["CONTACTS"],"requestBody":{"description":"Contact to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewFullContact"}}}},"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContact"}}}}}}},"/v1/contacts/{id}":{"get":{"summary":"Get contact by ID","tags":["CONTACTS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of contact","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContact"}}}}}},"put":{"summary":"Update contact","tags":["CONTACTS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of contact","example":123,"schema":{"type":"integer"}}],"requestBody":{"description":"Contact updates, only the specified attributes will be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewFullContact"}}}},"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContact"}}}}}},"delete":{"summary":"Remove contact by ID","tags":["CONTACTS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of contact","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact deleted"},"400":{"description":"Contact cannot be deleted because it is used in related entities","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["Contact has references"]},"error_details":{"type":"string","description":"Human-readable bullet-point list of blocking references","examples":["- assigned to 7 transaction(s)\n- added as a payee on 5 commission payments\n"]},"has_critical_references":{"type":"boolean","description":"True if the contact has critical references (payment methods, ledger entries, EMD) that cannot be automatically re-assigned before deletion"},"status":{"type":"integer","examples":[400]}}}}}}}}},"/v1/contacts/search":{"get":{"summary":"Search contact","tags":["CONTACTS"],"parameters":[{"name":"keyword","in":"query","required":true,"example":"John","schema":{"type":"string"}}],"responses":{"200":{"description":"Contacts list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShortContact"}}}}}}}},"/v2/contacts":{"get":{"summary":"List available contacts in account","description":"Contacts the calling user can see, ordered by id. Each contact has its name, email and\ncontact type; with `full_info=1` it also has phone, address, assignee and the account's\ncustom fields, flat (one top-level key per field, keyed by field label).\nThe resulting list will be limited by at most 1000 records.\n","tags":["CONTACTS V2"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"created_since","in":"query","required":false,"description":"Filter contacts created since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"updated_since","in":"query","required":false,"description":"Filter contacts updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"external_ids","in":"query","required":false,"description":"Filter contacts by the comma separated list of external IDs","example":"crm123,extdId124,234","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"emails","in":"query","required":false,"description":"Filter contacts by the comma separated list of emails","example":"a@b.com,test@example.com","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"full_info","in":"query","required":false,"description":"Specifies whether to retrieve short or full contact information.","schema":{"type":"integer","enum":[0,1],"default":0},"example":1}],"responses":{"200":{"description":"Contacts list response","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/FullContactV2"},{"$ref":"#/components/schemas/ShortContact"}]}}}}}}},"post":{"summary":"Create contact","description":"Creates a contact. Account custom fields are passed flat, one top-level\nkey per field, keyed by the field label. Call\n`Get current contacts schema` first to discover the account's fields\n(built-in and custom) and their labels.\n","tags":["CONTACTS V2"],"requestBody":{"description":"Contact to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewContactV2"}}}},"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContactV2"}}}}}}},"/v2/contacts/bulk":{"post":{"summary":"Create or update contacts in bulk","description":"Creates or updates up to 250 contacts in one request. Each record uses\nthe shape `Create contact v2` accepts, including flat custom fields, and\nis validated the same way.\n\nEvery record must carry a non-blank `external_id`.\n\nRecords are matched by `external_id`, then `email`, then first and last\nname; a match is updated, anything unmatched is created. Email and name\nmatches ignore case. A repeated `external_id` within one request updates\nthe same contact, last one wins.\n\nEach record is processed independently and is reported by its\n`external_id`. `records` plus `errors` add up to the number of records\nsent. A partial failure is still HTTP 200; check the top-level `status`.\n\nLoad users before contacts, and contacts before transactions, finishing\neach set before starting the next. Send the batches of one entity type\nsequentially, not in parallel.\n","tags":["CONTACTS V2"],"requestBody":{"description":"Contacts to create or update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkContactsRequestV2"}}}},"responses":{"200":{"description":"Per-record outcome. Returned for a full success and for a partial failure alike.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkContactsResponseV2"}}}}}}},"/v2/contacts/schema":{"get":{"summary":"Get current contacts schema","description":"Returns the contact fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means.","tags":["CONTACTS V2"],"responses":{"200":{"description":"Current contacts schema","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FieldDescriptor"}}}}}}}},"/v2/contacts/{id}":{"get":{"summary":"Get contact by ID","tags":["CONTACTS V2"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of contact","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContactV2"}}}}}},"put":{"summary":"Update contact","description":"Updates a contact. Only the specified attributes are updated. Account\ncustom fields are passed flat, one top-level key per field, keyed by the\nfield label - call `Get current contacts schema` to discover them.\n","tags":["CONTACTS V2"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of contact","example":123,"schema":{"type":"integer"}}],"requestBody":{"description":"Contact updates, only the specified attributes will be updated","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewFullContactV2"}}}},"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContactV2"}}}}}},"delete":{"summary":"Remove contact by ID","tags":["CONTACTS V2"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of contact","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Contact deleted"}}}},"/v2/contacts/search":{"get":{"summary":"Search contacts","tags":["CONTACTS V2"],"parameters":[{"name":"keyword","in":"query","required":true,"example":"John","schema":{"type":"string"}}],"responses":{"200":{"description":"Contacts list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ShortContact"}}}}}}}},"/v1/accounting/ledger/transactions":{"get":{"summary":"List General Ledger Transactions","tags":["GENERAL LEDGER"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"updated_since","in":"query","required":false,"description":"Filter transactions updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}}],"responses":{"200":{"description":"General Ledger Transactions","content":{"application/json":{"schema":{"type":"object","required":["transactions"],"properties":{"transactions":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Invoice"},{"$ref":"#/components/schemas/Bill"},{"$ref":"#/components/schemas/ReceivedPayment"},{"$ref":"#/components/schemas/MadePayment"},{"$ref":"#/components/schemas/JournalEntry"},{"$ref":"#/components/schemas/CreditMemo"},{"$ref":"#/components/schemas/Deposit"},{"$ref":"#/components/schemas/Transfer"},{"$ref":"#/components/schemas/Refund"},{"$ref":"#/components/schemas/BalanceNetting"}]}}}}}}}}}},"/v1/accounting/ledger/transactions/{id}":{"get":{"summary":"Get General Ledger Transaction by ID","tags":["GENERAL LEDGER"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of transaction","schema":{"type":"integer"}}],"responses":{"200":{"description":"General Ledger Transaction","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Invoice"},{"$ref":"#/components/schemas/Bill"},{"$ref":"#/components/schemas/ReceivedPayment"},{"$ref":"#/components/schemas/MadePayment"},{"$ref":"#/components/schemas/JournalEntry"},{"$ref":"#/components/schemas/CreditMemo"},{"$ref":"#/components/schemas/Deposit"},{"$ref":"#/components/schemas/Transfer"},{"$ref":"#/components/schemas/Refund"},{"$ref":"#/components/schemas/BalanceNetting"}]}}}}}}},"/v1/accounting/ledger/deleted":{"get":{"summary":"List Deleted General Ledger Transactions","tags":["GENERAL LEDGER"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"name":"deleted_since","in":"query","required":false,"description":"Filter transactions deleted since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}}],"responses":{"200":{"description":"Deleted Ledger Transaction","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeletedLedgerTransaction"}}}}}}}},"/v1/incoming_transactions":{"get":{"summary":"List available incoming transactions","description":"The resulting list will be limited by at most 1000 records.\nFollowing parameters allow to paginate and filter the output.\n","tags":["INCOMING TRANSACTIONS"],"parameters":[{"$ref":"#/components/parameters/countParam"},{"$ref":"#/components/parameters/startingFromIdParam"},{"name":"statuses","in":"query","required":false,"description":"Filter incoming transactions by specified statuses.\nAllowed values: `new`, `accepted`, `discarded`, `unverified`\n","examples":{"statuses":{"value":["new","accepted"],"summary":"comma separated multiple statuses"}},"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["new","accepted","discarded","unverified"]}}},{"name":"updated_since","in":"query","required":false,"description":"Filter incoming transactions updated since specified date.\nDate format: YYYY-MM-DD or 13-digit unix timestamp\n","examples":{"timestamp":{"value":1566225495596,"summary":"13-digit unix timestamp"},"datestring":{"value":"2019-08-27","summary":"YYYY-MM-DD date string"}},"schema":{"$ref":"#/components/schemas/dateParamSchema"}},{"name":"source_id","in":"query","required":false,"description":"Filter transactions by source.\nThis can be the name of CRM or other system that you sourced these transactions,\nthis allows to distinct incoming transactions with the same external IDs from different sources\n","example":"Salesforce","schema":{"type":"string"}},{"name":"external_ids","in":"query","required":false,"description":"Filter incoming transactions by the comma separated list of external IDs\n","example":"crm123,extdId124,234","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"full_info","in":"query","required":false,"description":"Specifies whether to retrieve short or full incoming transaction information.\nList is returned in short format by default.\n","schema":{"type":"integer","enum":[0,1]},"example":1}],"responses":{"200":{"description":"Incoming transaction list response","content":{"application/json":{"schema":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/IncomingTransaction"},{"$ref":"#/components/schemas/ShortIncomingTransaction"}]}}}}}}},"post":{"summary":"Add incoming transactions","description":"Create or update incoming transactions.\u003cbr/\u003e\nUpdate will happen in case incoming transaction with the same `external_id` and `source_id` already exists.\u003cbr/\u003e\n\n**Note:** if existing transaction was already *accepted* of *declined*, its updates will be ignored.\n","tags":["INCOMING TRANSACTIONS"],"requestBody":{"description":"Incoming transaction","required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id","transactions"],"properties":{"source_id":{"type":"string","description":"Incoming transaction source\nthis can be the name of CRM or other system that you sourced these transactions,\nthis allows to distinct incoming transactions with the same external IDs from different sources\n","examples":["salesforce.com"]},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/CreatedIncomingTransaction"}}}}}}},"responses":{"200":{"description":"List of identifiers for created incoming transactions","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Incoming transaction ID","examples":[33]},"external_id":{"type":"string","description":"Incoming transaction ID","examples":["CRM1234"]}}}}}}}}}},"/v1/incoming_transactions/{id}":{"get":{"summary":"Get incoming transaction by ID","tags":["INCOMING TRANSACTIONS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of incoming transaction","example":567,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Incoming transaction","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IncomingTransaction"},{"$ref":"#/components/schemas/ShortIncomingTransaction"}]}}}}}}},"/v1/transactions/{bm_transaction_id}/offers":{"get":{"summary":"List available offers in transaction","tags":["TRANSACTION OFFERS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"transaction ID","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Offer list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}}}}}}}},"/v1/transactions/{bm_transaction_id}/offers/{id}":{"get":{"summary":"Get offer by ID","tags":["TRANSACTION OFFERS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"transaction ID","example":1234,"schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"description":"ID of the offer","example":"d48c68cfca","schema":{"type":"string"}}],"responses":{"200":{"description":"Offer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offer"}}}}}}},"/v1/transactions/{bm_transaction_id}/offers/{offer_id}/attachments/{attachment_id}":{"get":{"summary":"Get offer attachment by ID","tags":["TRANSACTION OFFERS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"transaction ID","example":1234,"schema":{"type":"integer"}},{"name":"offer_id","in":"path","required":true,"description":"ID of the offer","example":"d48c68cfca","schema":{"type":"string"}},{"name":"attachment_id","in":"path","required":true,"description":"ID of the offer attachment","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Offer attachment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferAttachmentDownload"}}}}}}},"/v1/transactions/{bm_transaction_id}/offers/new_offer_link":{"get":{"summary":"Get new offer link","tags":["TRANSACTION OFFERS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"transaction ID","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"New offer link","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","examples":["http://my.brokermint.com/offers/cede66cad5/new"]}}}}}}}}},"/v2/reports":{"get":{"summary":"List available reports in account","tags":["REPORTS"],"responses":{"200":{"description":"Report list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportEntry"}}}}}}}},"/v2/reports/{report_id}/filters":{"get":{"summary":"List of filters and available filter options for specified report","tags":["REPORTS"],"parameters":[{"name":"report_id","in":"path","required":true,"example":12,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Report filters response","content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/ReportFilter"}}}}}}}}}},"/v2/reports/{report_id}":{"get":{"summary":"Retrieve report data","description":"**Note:** Report data is limited. The maximum number of rows returned is not more than `1000`\n\nEach report has its own filters. Get them, with the values they accept, from\n`GET /v2/reports/{report_id}/filters` and pass them in `filters`.\n\nA filter the report does not have, or a value that is not among a filter's available options,\nis rejected with a `400` error.\n","tags":["REPORTS"],"parameters":[{"name":"report_id","in":"path","required":true,"example":12,"schema":{"type":"integer"}},{"name":"filters","in":"query","required":false,"description":"report filters in a form of `filters[field]=value`, where `field` is a `field` received in\nthe report filters response \u003cbr/\u003e\ntext filter value is one of the `available_options` of that filter, or several comma separated\nones when the filter is `multiple`, e.g. `filters[status]=active,pending` \u003cbr/\u003e\ndate filter value is one of the `available_options` of that filter or a Unix timestamp range\nin a form of `{from date}-{to date}`,\ne.g. `filters[closing_date]=1556697600-1557165600` \u003cbr/\u003e\ntranslates to: \u003cbr/\u003e\n         from `1556697600` (Wed, 01 May 2019 00:00:00 -0800) \u003cbr/\u003e\n         to   `1557165600` (Mon, 06 May 2019 10:00:00 -0800)\n","style":"deepObject","explode":true,"examples":{"text":{"value":{"status":"active,pending"},"summary":"comma separated multiple statuses"},"date_range":{"value":{"closing_date":"1556697600-1557165600"},"summary":"unix timestamps range"},"date_option":{"value":{"closing_date":"last_month"},"summary":"one of the date filter available options"}},"schema":{"type":"object","additionalProperties":{"type":"string"}}},{"name":"timezone","in":"query","description":"timezone you need date fields and filters to be interpreted in","example":-8,"schema":{"type":"integer"}},{"name":"start","in":"query","description":"Specifies the number of items to skip before retrieving the result list","example":5,"schema":{"type":"integer"}},{"name":"count","in":"query","description":"Specifies the number of items to retrieve, max 1000.","example":50,"schema":{"type":"integer","minimum":1,"maximum":1000}}],"responses":{"200":{"description":"Report data. (**Note:** The actual set of columns will depend on your report configuration)\n","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReportData"}}}}}}},"400":{"description":"A requested filter is unknown or has a value that is not among its available options","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["Report filters rejected - unknown filter agent_name, the report filters are: status, closing_date; invalid options for status: sold, available options are: *, active, pending, closed"]}}}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/all/tasks":{"get":{"summary":"List of all transaction's tasks","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"with_documents","in":"query","required":false,"description":"Set to 1 to retrieve only tasks that require or have documents.\nList is returned all transaction tasks by default.\n","schema":{"type":"integer","enum":[0,1],"default":0},"example":1}],"responses":{"200":{"description":"List of tasks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks":{"get":{"summary":"List of tasks in specified transaction checklists","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"with_documents","in":"query","required":false,"description":"Set to 1 to retrieve only tasks that require or have documents.\nBy default, list will contain all tasks in the specified transaction checklist.\n","schema":{"type":"integer","enum":[0,1],"default":0},"example":1}],"responses":{"200":{"description":"List of tasks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"post":{"summary":"Create a new tasks in specified transaction checklists","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Task to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTask"}}}},"responses":{"200":{"description":"Created task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks/{task_id}":{"get":{"summary":"Get taks by ID","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}},{"name":"include","in":"query","required":false,"description":"Comma-separated list of relations to expand in the response.\nSupported value: `required_documents` — expands `required_document_ids` into\nfull document objects, see `required_documents` on the `Task` schema.\n","schema":{"type":"string","enum":["required_documents"]},"example":"required_documents"}],"responses":{"200":{"description":"Task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}},"put":{"summary":"Update task","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Task updates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTask"}}}},"responses":{"200":{"description":"Updated task","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}},"delete":{"summary":"Remove taks by ID","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Deleted task"}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks/{task_id}/assign_document":{"post":{"summary":"Assign document to task","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"ID of document","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"document_id":{"type":"integer","examples":[123]}}}}}},"responses":{"200":{"description":"Unassigned task's document"}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks/{task_id}/unassign_document":{"post":{"summary":"Unassign task's document","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Unassigned task's document"}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks/{task_id}/complete":{"post":{"summary":"Mark task as complete","description":"Transitions the task to the 'complete' status. The task must meet all requirements\n(document uploaded if required, no pending reviews) before it can be completed.\n","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task successfully completed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"404":{"description":"Task not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["task not found"]}}}}}},"400":{"description":"Task cannot be completed due to invalid state","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks/{task_id}/uncomplete":{"post":{"summary":"Mark task as incomplete","description":"Transitions the task from 'complete' status back to 'todo' status.\nThis allows reopening a previously completed task.\n","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Task successfully marked as incomplete","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}},"404":{"description":"Task not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","examples":["task not found"]}}}}}},"400":{"description":"Task cannot be uncompleted due to invalid state","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks/{task_id}/comments":{"get":{"summary":"List of task's comments","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of task's comments","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"post":{"summary":"Add task's comment","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}}],"requestBody":{"description":"Task comment","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewComment"}}}},"responses":{"200":{"description":"Task comment","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Comment"},{"type":"object","properties":{"mentions_without_access":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User ID"},"name":{"type":"string","description":"User name"},"type":{"type":"string","description":"User type"}},"examples":[{"id":123,"name":"John Doe","type":"user"}]}}}}]}}}}}}},"/v1/transactions/{bm_transaction_id}/checklists/{checklist_id}/tasks/{task_id}/comments/{comment_id}":{"put":{"summary":"Update task's comment","tags":["TRANSACTION TASKS"],"parameters":[{"name":"bm_transaction_id","in":"path","required":true,"description":"ID of transaction","example":1234,"schema":{"type":"integer"}},{"name":"checklist_id","in":"path","required":true,"description":"ID of checklist","example":1234,"schema":{"type":"integer"}},{"name":"task_id","in":"path","required":true,"description":"ID of task","example":1234,"schema":{"type":"integer"}},{"name":"comment_id","in":"path","required":true,"description":"ID of comment","example":5678,"schema":{"type":"integer"}}],"requestBody":{"description":"Task comment","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewComment"}}}},"responses":{"200":{"description":"Task comment","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Comment"},{"type":"object","properties":{"mentions_without_access":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User ID"},"name":{"type":"string","description":"User name"},"type":{"type":"string","description":"User type"}},"examples":[{"id":123,"name":"John Doe","type":"user"}]}}}}]}}}}}}},"/v1/todo":{"get":{"summary":"List of all uncompleted transaction's tasks","description":"The resulting list will be limited by at most 200 records.\n","tags":["TODO"],"responses":{"200":{"description":"List of all uncompleted transaction's tasks","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}}},"/v1/webhooks":{"get":{"summary":"List of available webhook subscriptions","description":"The resulting list will be limited by 5 records at most.\nFollowing parameters allow to paginate and filter the output.\n","tags":["WEBHOOKS"],"parameters":[{"name":"count","in":"query","description":"Specifies the number of items to retrieve","example":2,"schema":{"type":"integer","minimum":1,"maximum":5}},{"$ref":"#/components/parameters/startingFromIdParam"}],"responses":{"200":{"description":"Webhook subscriptions list response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"}}}}}}},"post":{"summary":"Create new webhook subscription","description":"Note that subscription needs to be activated first to start receiving webhook events.","tags":["WEBHOOKS"],"requestBody":{"description":"Webhook subscription to create","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewWebhookSubscription"},"examples":{"transactionExample":{"$ref":"#/components/examples/NewWebhookSubscription"}}}}},"responses":{"200":{"description":"Created webhook subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedWebhookSubscription"}}}}}}},"/v1/webhooks/{id}":{"get":{"summary":"Get webhook subscription by ID","tags":["WEBHOOKS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of webhook subscription","schema":{"type":"integer"}}],"responses":{"200":{"description":"Webhook subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}}}},"put":{"summary":"Update webhook subscription","description":"Allows to update an existing webhook subscription.\nThe update will affect only specified fields. All other fields will preserve their values.\n\n\\* *updating callback_url deactivates webhook subscription*\n\n\\* *updated_at and created_at are read-only fields*\n","tags":["WEBHOOKS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of webhook subscription","schema":{"type":"integer"}}],"requestBody":{"description":"Webhook subscription updates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookSubscription"},"examples":{"transactionExample":{"$ref":"#/components/examples/NewWebhookSubscription"}}}}},"responses":{"200":{"description":"Updated webhook subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}}}},"delete":{"summary":"Delete webhook subscription by ID","tags":["WEBHOOKS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of webhook subscription","schema":{"type":"integer"}}],"responses":{"200":{"description":"Webhook subscription deleted"}}}},"/v1/webhooks/{id}/activate":{"post":{"summary":"Activate webhook subscription by ID","tags":["WEBHOOKS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of webhook subscription","schema":{"type":"integer"}}],"responses":{"200":{"description":"Webhook subscription activated"},"400":{"description":"Webhook subscription not activated, request to callback_url failed"}}}},"/v1/webhooks/{id}/deactivate":{"post":{"summary":"Deactivate webhook subscription by ID","tags":["WEBHOOKS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of webhook subscription","schema":{"type":"integer"}}],"responses":{"200":{"description":"Webhook subscription deactivated"}}}},"/v1/webhooks/{id}/test":{"post":{"summary":"Send asynchronous ping event to webhook subscription's callback url","tags":["WEBHOOKS"],"parameters":[{"name":"id","in":"path","required":true,"description":"ID of webhook subscription","schema":{"type":"integer"}}],"responses":{"200":{"description":"Ping event sent"}}}}}}