{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"219aac9f-bf17-40cd-b3ae-acb46f0a0fb7","name":"TMO API","description":"The Mortgage Office API provides resources for querying and modifying your company databases. The API uses JSON web service semantics. Each web service implements the business processes as defined in this API documentation.\n\n## Authentication\n\nAll API requests require the following headers:\n\n- `Token`: Your API token (assigned by Applied Business Software)\n    \n- `Database`: The name of your company database\n    \n\nEnvironments:\n\n- US: [https://api.themortgageoffice.com](https://api.themortgageoffice.com)\n    \n- Canada: [https://api-ca.themortgageoffice.com](https://api-ca.themortgageoffice.com)\n    \n- Australia: [https://api-aus.themortgageoffice.com](https://api-aus.themortgageoffice.com)\n    \n\nSandbox Access:\n\n- URL: [https://api.themortgageoffice.com](https://api.themortgageoffice.com)\n    \n- Token: TMO\n    \n- Database: API Sandbox\n    \n\n## Common Response Structure\n\nAll API endpoints return a response with the following structure:\n\n``` json\n{\n  \"Data\": \"string or object\",\n  \"ErrorMessage\": \"string\",\n  \"ErrorNumber\": 0,\n  \"Status\": 0\n}\n\n ```\n\n## Response Fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| Data | string or object | The response data, which varies depending on the endpoint |\n| ErrorMessage | string | Error message, if any |\n| ErrorNumber | integer | Error number |\n| Status | integer | Status of the request |\n\n# Release Notes\n\n| **Release Notes** |\n| --- |\n| **March 30, 2026**  <br>\\- Lender Attachments: We’ve introduced a new API that allows external systems to upload and associate attachments directly with lender records. Through this endpoint, integrations can add documents such as agreements or supporting files to lender records by submitting file metadata and base64-encoded content. This enhancement makes it easier to automate document management workflows and maintain lender documentation through integrations.  <br>\\- New API: Funding Disbursements - A new endpoint is now available to retrieve funding disbursement records from The Mortgage Office. This API allows integrators to filter and retrieve disbursement data using a variety of query parameters, including loan, lender, record IDs, and date ranges. This enhancement enables external systems to synchronize funding disbursement information for reporting, reconciliation, and other downstream integrations.  <br>\\- New API: Commitments - A new endpoint has been introduced for retrieving loan commitment records. The Commitments API supports filtering by loan, lender, and expected or received date ranges. It returns detailed commitment information including amount, dates, status, and audit metadata. This allows external systems to access commitment data for reporting, monitoring funding expectations, and integration with other financial workflows.  <br>\\- Trust Ledger API Improvements - Trust ledger–related API endpoints have been updated to automatically recalculate trust balances when transactions are created via the API. This improvement ensures that: Overall trust balances and Client-specific ledger balances are recalculated immediately after API transactions, keeping balances consistent with what is displayed in the TMO application.This update improves accuracy and consistency for integrations that create trust ledger transactions programmatically. |\n| **March 10, 2026**  <br>PATCH Partial Loan Updates  <br>\\- Loan update API calls now support partial updates, meaning only the fields that need to be changed must be included in the request |\n| **January 12, 2026**  <br>Events Journal:  <br>\\- Events Journal (GET): New endpoint to retrieve event journal entries with filtering, sorting, pagination, and UTC timestamps.  <br>\\- Events Journal (POST): New endpoint to create one or more event journal entries in a single request.  <br>Mortgage Pools:  <br>\\- Trust Ledger: New GET endpoint to fetch trust ledger transactions by pool with optional date and bank account filters.  <br>\\- Capital History: Updated /LSS.svc/Capital/History to include PoolAccount and PoolRecID in the response and renamed LenderHistoryRecId to RecId for clarity.  <br>Loan Servicing:  <br>\\- Loan Conversations: Added MemoTextPlain field to return plain-text memo content alongside existing rich text.  <br>\\- Lender History: New search endpoint to retrieve lender/vendor transaction history across multiple lenders with incremental sync support |\n| **January 8, 2026**  <br>Mortgage Pools: New reference fields have been added to pool history transaction. These include certificate ID, ReversalRecId, DistributionRecId, TDSGroupRecId, TransferRecId. |\n| **November 17, 2025**  <br>Mortgage Pools: New endpoints to create and update Partners are now available for Capital module. |\n| **October 30, 2025**  <br>Loan Servicing:  <br>\\- Trust Account Transactions: New GET /LSS.svc/TrustAccounts/{AccountRecID} endpoint retrieves trust ledger transactions with optional filters (fromDate, toDate, payAccount) and pagination via PageSize and Offset headers. Returns transaction details with splits.  <br>\\- Delivery Method Support: NewLender and UpdateLender endpoints now accept a DeliveryMethod field (0–7) to define communication preferences. GetLender and GetVendor endpoints return the selected delivery method.  <br>\\- Partner Management: New POST /LSS.svc/Shares/Partners endpoint creates a partner record. PATCH /LSS.svc/Shares/Partners/{partnerAccount} updates an existing partner record using the same payload format. |\n| **September 9, 2025**  <br>Loan Servicing:  <br>GetLoanCharges endpoint has been updated to return charge history.  <br>Get history endpoint now available for Capial invested mortgage pools. The endpoint allows filtering by date range, pool acount and partner account. |\n| **August 21, 2025**  <br>Loan Servicing:  <br>Insurance effective date added to insurance endpoints.  <br>Mortgage Pools: Introducing a set of endpoints allowing access to Capital Invested mortgage pools. |\n| **July 16, 2025**  <br>Loan Servicing:  <br>For Commercial, Construction, and Line of Credit loans, API calls now use BilledToDate instead of PaidToDate. The NewLoan and UpdateLoan endpoints remain backward compatible by using PaidToDate if BilledToDate is not provided. GetLoan no longer returns PaidToDate for these loan types, so any integrations must be updated to reference BilledToDate:  <br>\\- Terms.Commercial.BilledToDate for Commercial loans  <br>\\- Terms.LOC_BilledToDate for Lines of Credit  <br>\\- Terms.CON_BilledToDate for Construction loans  <br>  <br>Loan Origination:  <br>NewLoan and UpdateLoan endpoints now support Notes field |\n| **June 2, 2025**  <br>Mortgage Pools: Introducing a set of endpoints allowing access to Shares Owned mortgage pools |\n| **March 26, 2025**  <br>Loan Servicing: GetLoanTrustLedger has been updated to return category for each transaction. The category can be \"Impound\" or \"Reserve\"  <br>  <br>Loan Servicing: additional fields were added to NewLoan and UpdateLoan endpoints.  <br>  <br>Loan Servicing: GetVendor, GetVendors and GetVendorsByTimestamp endpoints have been addeed to return all Vendor details including custom fields.  <br>  <br>Loan Servicing: GetCheckRegister has been updated to return ChkGroupRecID |\n| **January 9, 2025**  <br>Loan Servicing: getLenders and GetLendersByTimestamp endpoints now support pagination using PageSize and Offset request header.  <br>  <br>Loan Servicing: Escrow Voucher API has been updated to include following fields:  <br>\\- VoucherType  <br>\\- PropertyRecID  <br>\\- InsuranceRecID  <br>  <br>Loan Servicing: NewLoan, GetLoan and UpdateLoan endpoints has been modified to include following fields in Co-Borrower details:  <br>\\- DeliveryOptions  <br>\\- CCR_AddressIndicator  <br>\\- CCR_ResidenceCode  <br>\\- AssociatedBorrower  <br>\\- Title  <br>\\- PercentOwnership  <br>\\- AuthorizedSigner  <br>\\- LegalStructureType |\n| **December 2, 2024**  <br>Loan Servicing: Loan API endpoints were updated to support additional terms fields.  <br>Construction:  <br>\\- Interest on Available Funds  <br>\\- Interest on Available Funds - Method  <br>\\- Interest on Available Funds - the rate to use when Fixed Rate or Modifier is selected.  <br>\\- Completion Date  <br>\\- Construction Loan Amount  <br>\\- Contractor License No.  <br>\\- RecID of construction contractor vendor  <br>\\- Joint Checks  <br>\\- Project Description  <br>\\- Project Sq. Ft.  <br>\\- Revolving  <br>Penalties:  <br>\\- DefaultRateUse  <br>  <br>Loan Servicing: getLenders and getLendersByTimestamp endpoints now support pagination using Offset and PageSize headers. |\n| **October 18, 2024**  <br>Loan Servicing: Updated LoanAdjustment endpoint to allow posting non-cash historical adjustments to a loan.  <br>  <br>Loan Servicing: Following endpoint have been updated to include construction trust balance:  <br>\\- GetLoan  <br>\\- GetLoans  <br>\\- GetLoansByTimestamp |\n| **October 7, 2024**  <br>Loan servicing API has been updated to include flood zone field for collaterals. GetLoanProperties endpoint now returns flood zone for each property. ​NewProperty and UpdateProperty endpoints now accept FloodZone field.  <br>  <br>Loan Origination API: Added property encumbrance information to collateral details in the following endpoints:  <br>\\- GetLoan  <br>\\- NewLoan  <br>\\- NewCollateral  <br>\\- UpdateCollateral  <br>The endpoints now support multiple encumbrances per collateral property. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"37774064","team":460849,"collectionId":"219aac9f-bf17-40cd-b3ae-acb46f0a0fb7","publishedId":"2sAXjGcE4E","public":true,"publicUrl":"https://developers.themortgageoffice.com","privateUrl":"https://go.postman.co/documentation/37774064-219aac9f-bf17-40cd-b3ae-acb46f0a0fb7","customColor":{"top-bar":"EAEFF4","right-sidebar":"1c1c34","highlight":"ff755f"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/15434baa-6c5c-420d-8c17-6a5ccfd680ff/VE1PLWxvZ28tU2Vjb25kYXJ5TGVmdC1SZXZlcnNlLVJHQi5wbmc=","colors":{"top-bar":"212121","right-sidebar":"1C1C34","highlight":"FF755F"}},{"name":"light","logo":"https://content.pstmn.io/444fe558-54c0-4f3f-8e5a-9e79c299c018/VE1PLWxvZ28tU2Vjb25kYXJ5TGVmdC1GdWxsLUNvbG9yLVJHQi5wbmc=","colors":{"top-bar":"EAEFF4","right-sidebar":"1c1c34","highlight":"ff755f"}}]}},"version":"8.10.0","publishDate":"2025-12-15T21:38:30.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/444fe558-54c0-4f3f-8e5a-9e79c299c018/VE1PLWxvZ28tU2Vjb25kYXJ5TGVmdC1GdWxsLUNvbG9yLVJHQi5wbmc=","logoDark":"https://content.pstmn.io/15434baa-6c5c-420d-8c17-6a5ccfd680ff/VE1PLWxvZ28tU2Vjb25kYXJ5TGVmdC1SZXZlcnNlLVJHQi5wbmc="}},"statusCode":200},"environments":[{"name":"TMO API","id":"b9b941d0-8d12-427d-80c7-46429d5af299","owner":"28403304","values":[{"key":"Account","value":":Account","enabled":true},{"key":"Loan Number","value":":Account","enabled":true},{"key":"LenderAccount","value":":Account","enabled":true},{"key":"From","value":":FromDate","enabled":true},{"key":"To","value":":ToDate","enabled":true},{"key":"ID","value":":ID","enabled":true},{"key":"Type","value":":Type","enabled":true},{"key":"LoanTransactionRecID","value":":ID","enabled":true,"type":"default"},{"key":"NSFDate","value":":Date","enabled":true,"type":"default"},{"key":"NSFCharge","value":":ChargeAmount","enabled":true,"type":"default"},{"key":"RecID","value":":RecID","enabled":true},{"key":"Base URL","value":"api.themortgageoffice.com","enabled":true,"type":"default"},{"key":"Token","value":"Your API token (assigned by Applied Business Software)","enabled":true,"type":"default"},{"key":"Database","value":"The name of your company database","enabled":true,"type":"default"},{"key":"SandboxToken","value":"TMO","enabled":true,"type":"default"},{"key":"SandboxDB","value":"API Sandbox","enabled":true,"type":"default"},{"key":"PropertyRecID","value":":RecID","enabled":true,"type":"default"},{"key":"PoolAccount","value":":Account","enabled":true,"type":"default"},{"key":"PartnerAccount","value":":PartnerAccount","type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/27d481745f571ccdf2060fbbbec52fcba1c49bd6fde35bbd2b4720dcd884894b","favicon":"https://res.cloudinary.com/postman/image/upload/v1766618174/team/7f62f666bf8bd04b6776894c7b941e5e.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"TMO API","value":"28403304-b9b941d0-8d12-427d-80c7-46429d5af299"}],"canonicalUrl":"https://developers.themortgageoffice.com/view/metadata/2sAXjGcE4E"}