{"info":{"_postman_id":"e22caf3b-54b8-4ac3-bd86-e5a8abc3544e","name":"Omega Client","description":"<html><head></head><body><h1 id=\"confidentiality\">Confidentiality</h1>\n<hr>\n<p>This API documentation and all related materials, including the Services, technical information, product plans, designs, and business processes disclosed herein, constitute <strong>Confidential Information</strong> as defined under the Master Agreement between Megasys (\"Disclosing Party\") and the subscribing client (\"Receiving Party\"). By accessing this documentation, you agree that:</p>\n<ol>\n<li><p><strong>If you are a client of Megasys</strong>, your use of this documentation is governed by the confidentiality obligations set forth in the Confidentiality Section of your Master Agreement, including your obligation to protect Confidential Information with no less than reasonable care and to limit its use to purposes consistent with your Agreement.</p>\n</li>\n<li><p><strong>If you are a third-party developer, consultant, or contractor</strong> accessing this documentation on behalf of a Megasys client, you acknowledge that: (a) you are accessing Confidential Information of Megasys; (b) your access has been authorized solely for purposes consistent with the client's Agreement with Megasys; and (c) you are bound by confidentiality obligations <strong>no less stringent</strong> than those required under the client's Master Agreement. Your client is responsible for ensuring you have executed an appropriate confidentiality agreement prior to accessing this documentation.</p>\n</li>\n<li><p><strong>All users</strong> agree not to disclose, reproduce, or use any information contained herein for any purpose outside the scope of the authorized engagement with Megasys, and to apply the same degree of care used to protect their own confidential information of like kind — but in no event less than reasonable care.</p>\n</li>\n</ol>\n<p>Unauthorized access, disclosure, or use of this documentation may constitute a breach of contract and/or applicable law.  </p>\n<h1 id=\"overview\">Overview</h1>\n<hr>\n<p>This document contains the list of all available Omega endpoints.<br>Megasys offers a robust set of web service based API's (Application Programming Interface) that allow your development team to seamlessly integrate external processes with Omega.</p>\n<h2 id=\"api-pricing\">API Pricing</h2>\n<p>Check your Omega Quote for specific pricing information.</p>\n<h2 id=\"number-code-and-guid-lookups\">Number, code and GUID lookups</h2>\n<p>Selected requests accept the record's business number/code or GUID in the same route parameter. Related request fields use optional string aliases such as <code>accountNumberOrId</code>, <code>customerNumberOrId</code>, <code>primaryBranchNumberOrId</code> and <code>supervisorLoginOrId</code>. Each request lists the exact accepted key: some use a description, filename, login or name. A GUID must identify that record type.</p>\n<p>Existing numeric and GUID fields remain supported with their existing JSON types. Numbers in new string aliases must be quoted. Supply matching scalar alternatives or choose one form; choose only one old/new list. New aliases generally reject blank strings and treat null/omitted as absent. For numeric account request models, <code>accountNumberOrId</code> also treats empty/whitespace as absent and falls back to <code>account_number</code>; a usable account selector remains required. This exception does not apply to <code>customerNumberOrId</code>, related references or query filters. Existing optional key-or-GUID settings explicitly documented as blank-to-clear retain that behavior. Unknown, ambiguous, wrong-type or unrelated records are rejected.</p>\n<p>Repurchase and reversal requests accept <code>accountNumbersOrIds</code>; cancellation accepts <code>batchNumbersOrIds</code>. Batch status accepts a batch number or GUID. Use an exact GUID for duplicated batch numbers. Reversal source selection accepts an original repurchase batch number or GUID in <code>repurchaseBatchNumberOrId</code>.</p>\n<p>Examples are templates: use records from the authenticated client's system and retain each operation's required fields. The optional related aliases in the request templates are null until selected. This lookup update does not change transaction IDs, child-record IDs, concurrency tokens, permissions or business rules. Features described here require the release that includes the lookup update.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Confidentiality","slug":"confidentiality"},{"content":"Overview","slug":"overview"}],"owner":"7349830","collectionId":"e22caf3b-54b8-4ac3-bd86-e5a8abc3544e","publishedId":"2sBY4Mv1zZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-10-20T21:06:08.000Z"},"item":[{"name":"Authentication Methods","item":[{"name":"Login","id":"aa821ca7-ca54-4bd5-8c68-c89118990535","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"clientNumber\": \"{{client_number}}\",\r\n    \"userName\": \"{{user_name}}\",\r\n    \"password\": \"{{password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/login","description":"<p>This method will authenticate the API access and return a token. The token access will time out after 60 minutes.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>ClientNumber</em></td>\n<td>Required. Must be a valid int32 greater than 0. This is the Omega client number.</td>\n</tr>\n<tr>\n<td><em>UserName</em></td>\n<td>Required. String with max length of 50. Must be a valid user login from the Omega system.</td>\n</tr>\n<tr>\n<td><em>Password</em></td>\n<td>Required. Login password for the provided user login.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","login"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8bfa01da-d6e7-49e6-9baa-5897e4a48c44","name":"Login - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"clientNumber\": \"{{client_number}}\",\r\n    \"userName\": \"{{user_name}}\",\r\n    \"password\":\"{{password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcZ2l0bGFiXG9tZWdhXE9tZWdhLldlYkFwcFxhcGlcY2xpZW50XGxvZ2lu?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 24 Jun 2021 18:19:33 GMT"},{"key":"Content-Length","value":"88"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"token\": \"1b9db307-5f9b-4e80-b5dd-1e699b1aaeb5\",\n    \"error\": null\n}"},{"id":"93e54215-5954-43f3-9839-2ad03df62e42","name":"Login - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":"{\r\n    \"clientNumber\": \"{{client_number}}\",\r\n    \"userName\": \"{{user_name}}\",\r\n    \"password\":\"{{password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcbG9naW4=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 04 Aug 2021 18:27:52 GMT"},{"key":"Content-Length","value":"89"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"error\": \"Client dayend is in progress.\"\n}"}],"_postman_id":"aa821ca7-ca54-4bd5-8c68-c89118990535"},{"name":"Logout","id":"53a462af-e0fd-4675-b83a-941f630787f7","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/logout","description":"<p>This method is used to delete the Omega token when it is no longer in use.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The token that was assigned to you when you called the Login method</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","logout"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"24312084-5882-4f1f-be51-584d81803eac","name":"Logout - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcZ2l0bGFiXG9tZWdhXE9tZWdhLldlYkFwcFxhcGlcY2xpZW50XGxvZ2lu?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 24 Jun 2021 18:19:33 GMT"},{"key":"Content-Length","value":"88"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": null\n}"},{"id":"8317b77b-2ba3-4b0b-85f7-8e58efb28a8c","name":"Logout - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 24 Jun 2021 18:19:33 GMT"},{"key":"Content-Length","value":"98"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Object reference not set to an instance of an object.\"\n    ]\n}"}],"_postman_id":"53a462af-e0fd-4675-b83a-941f630787f7"}],"id":"36d9dde9-8885-4b4e-a3cd-6f231ead3f7c","description":"<h2 id=\"option-1-userpassword-token-authentication\">Option 1: User/Password Token Authentication</h2>\n<p>This is the simplest way to authenticate your API requests (User settings such as password change requirement and user lockout will apply). Here's what you need to do:</p>\n<ol>\n<li><p><strong>Prepare The Required Credentials</strong></p>\n<ol>\n<li><p>Client Number</p>\n</li>\n<li><p>Omega Username</p>\n</li>\n<li><p>Omega Password</p>\n</li>\n</ol>\n</li>\n<li><p><strong>Call The Login Endpoint</strong></p>\n<ol>\n<li><p>You'll receive an authentication token</p>\n</li>\n<li><p>Include this token in the body of all your subsequent API requests</p>\n</li>\n</ol>\n</li>\n</ol>\n<p>It's that simple! The token handles all the authentication for you.</p>\n<h2 id=\"option-2-dynamic-signature\">Option 2: Dynamic Signature</h2>\n<p>For enhanced security, you can use our signature-based authentication. Here's what you need to do:</p>\n<ol>\n<li><p><strong>Prepare The Required Credentials</strong> (Find this in your Omega user profile or manager):</p>\n<ol>\n<li><p>Public Key</p>\n</li>\n<li><p>Private Key (your secret key - store this in a secured place like keepass!)</p>\n</li>\n</ol>\n</li>\n<li><p><strong>For Each API Call, Include These in Your Request Headers</strong>:</p>\n<ol>\n<li><p><code>publicKey</code>: Your public API key</p>\n</li>\n<li><p><code>timeStamp</code>: Current time in milliseconds in epoch datetime</p>\n</li>\n<li><p><code>signature</code>: Your generated signature</p>\n</li>\n</ol>\n</li>\n</ol>\n<h1 id=\"creating-the-signature\"><strong>Creating the Signature</strong></h1>\n<h4 id=\"signature-formula\">Signature Formula:</h4>\n<p>Compute an HMAC (Hash-based Message Authentication Code) using the SHA-512 algorithm with a key.</p>\n<h4 id=\"example\">Example:</h4>\n<p>Calling the <code>getaccount</code> endpoint:</p>\n<ul>\n<li><em>Set initial fields below</em></li>\n</ul>\n<p>publicKey: 80d6b518-99e6-4b9b-a92e-e15ea5cfc8fd<br />privateKey: 533f3734-35c6-4dac-843b-61c7add5be36<br />endpointName: getaccount<br />timeStamp: 1747866462729</p>\n<ul>\n<li>Generate string to be hashed</li>\n</ul>\n<p>hashString = endpointName + timestamp + privateKey<br />hashString: getaccount174786646272980d6b518-99e6-4b9b-a92e-e15ea5cfc8fd</p>\n<ul>\n<li>Hash the string with the publicKey to create the signature</li>\n</ul>\n<p>hmacKey = publicKey<br />signature = hmacsha512(hmacKey, hashString)</p>\n<p>signature: cab783c9c8e53a22ae4fb8603c9303c2958e7714a7194ee1c3ce1895f888549859dc4cdbbac3312ba04863db05b7ddad573a62289c12e2c5deb64316314edc3b</p>\n<p><strong>Pro Tip</strong>: Remember to convert all input to lowercase before generating the signature!</p>\n","_postman_id":"36d9dde9-8885-4b4e-a3cd-6f231ead3f7c"},{"name":"Account","item":[{"name":"AccountActivate","id":"6a0433e5-3554-4ac8-8f69-2b159086eb62","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/ActivateAccount","description":"<h3 id=\"activate-account\">Activate Account</h3>\n<p>Activates the supplied account by setting its <code>AdminStatusId</code> to the client's <code>DefaultActivatedAccountAdminStatusId</code> (from Servicing <code>ExternalMasterConfiguration</code>) and running <code>Omega.CommonAccount.Shared.AccountServices.ActivateAccount</code> to generate the first installment and any associated transactions. Accounts that are already active (same admin status and <code>InternalStatus == Active</code>) fail with <code>\"Account already activated.\"</code>. Call this after an origination has been funded/booked to move it into servicing.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/ActivateAccount</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional string. The authentication token returned by the Login method. When omitted, the dynamic-signature headers (<code>publicKey</code>, <code>timeStamp</code>, <code>signature</code>) must be supplied or the call fails with <code>BadRequest</code>.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code> with <code>statusCode</code>, <code>result</code>, and an <code>errors</code> array. Installment generation errors are surfaced through <code>errors</code> (e.g. <code>\"Error activating account: &lt;message&gt;\"</code>).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","ActivateAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"993fab72-e6c3-4e0f-9318-821f0a51dc93","name":"ActivateAccount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"30001212\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/ActivateAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e8988734-f46d-4d83-8dbf-55f1714313f0","name":"ActivateAccount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": 30001212,\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/ActivateAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error activating account: Account already activated.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"6a0433e5-3554-4ac8-8f69-2b159086eb62"},{"name":"AccountActivateBulk","id":"e6dd9208-7940-44d0-9176-5bd1bd35152e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_number_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/ActivateAccount?token={{token}}","description":"<h3 id=\"activate-account-bulk\">Activate Account (bulk)</h3>\n<p>Activates one to 250 accounts through the same activation service as the single route, moving each to the configured default activated admin status. An account that is already activated is reported as that account's own failure and does not stop the batch. Accounts commit independently and Day End is checked before each one. The route reuses the single Activate Account permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","ActivateAccount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"47137420-3888-4715-b28c-9509075993f0","name":"AccountActivateBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ActivateAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ActivateAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"e346e5ea-b835-4254-891e-4a6f8335d614","name":"AccountActivateBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ActivateAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ActivateAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"66710d1c-4217-4ce6-b4fb-fccd064ce7f9","name":"AccountActivateBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ActivateAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ActivateAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"c7217318-da88-4d56-afd0-b5154773d616","name":"AccountActivateBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ActivateAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ActivateAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"e6dd9208-7940-44d0-9176-5bd1bd35152e"},{"name":"AccountAssignedCollectorUpdate","id":"55765574-287f-4b62-93b8-1f536c2f55ba","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"AssignedCollector\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": \"{{account_number}}\",\r\n            \"valueToUpdate\": \"{{assigned_collector}}\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts","description":"<h6 id=\"this-method-with-type-set-as-assignedcollector-will-set-the-assigned-collector-on-the-account\">This method with <strong>\"</strong><em><strong>Type</strong></em><strong>\"</strong> set as <code>AssignedCollector</code> will set the assigned collector on the account.</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Token</em></td>\n<td>Required. Token to identify your login access provided by the Login method.</td>\n</tr>\n<tr>\n<td><em>Type</em></td>\n<td>Required. Must be set to \"AssignedCollector\" to assign account collector.</td>\n</tr>\n<tr>\n<td><em>Data</em></td>\n<td>Required. The list of collectors to assign to an account.</td>\n</tr>\n<tr>\n<td><em>AccountNumber</em></td>\n<td>Required. Must be a valid int64 greater than 0. This field must match an account number in the Omega system.</td>\n</tr>\n<tr>\n<td><em>ValueToUpdate</em></td>\n<td>Required. String with max length of 50. Must be a valid user login from the Omega system. The user must also be an active <a href=\"https://%7B%7Bbase_url%7D%7D/Client/Servicing/Maintenance/CollectorMaintenance.aspx\">collector</a>.</td>\n</tr>\n</tbody>\n</table>\n</div><p>API Access: the caller's API Access role needs the UpdateAccounts endpoint, or its <strong>Assigned Collector</strong> operation. A role granted only some types gets 403 for the others.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","updateaccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cac33368-a86d-461c-b5b6-6fedb86b04b9","name":"Assigned Collector - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"AssignedCollector\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 13002,\r\n            \"valueToUpdate\": \"username1\"\r\n        },\r\n        {\r\n            \"accountNumber\": 2530,\r\n            \"valueToUpdate\": \"username2\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"},{"id":"b16711f9-6373-431b-a98c-acd5314ebe04","name":"Assigned Collector - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"AssignedCollector\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 13002,\r\n            \"valueToUpdate\": \"username1\"\r\n        },\r\n        {\r\n            \"accountNumber\": 2530,\r\n            \"valueToUpdate\": \"username2\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Record 1 Account 13002: User 'username1' not found.\",\n        \"Record 2 Account 2530: Account not found.\"\n    ]\n}"}],"_postman_id":"55765574-287f-4b62-93b8-1f536c2f55ba"},{"name":"AccountChargeOffAdd","id":"6900f08f-3804-4576-9ab4-5fe6b418b5a2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number_or_id}}\",\n  \"chargeOffAmount\": 12500,\n  \"effectiveDate\": \"{{effective_date}}\",\n  \"creationBranchDate\": \"{{branch_date}}\",\n  \"dealerReserveAmount\": 0,\n  \"adminStatusIdAtChargeOff\": null,\n  \"referenceId\": null,\n  \"notes\": \"\",\n  \"wasReversed\": false,\n  \"insuranceRefundSum\": 0,\n  \"subAccountSum\": 0,\n  \"lateFeeSum\": 0,\n  \"otherBalanceFeeSum\": 0,\n  \"unpaidInterestOrFinanceChargeRebateAmount\": 0,\n  \"totalOriginationFeeRebate\": 0,\n  \"dealerDiscountFromBalanceAmount\": 0,\n  \"dealerDiscountFromLossAmount\": 0,\n  \"dealerWithholdAmount\": 0,\n  \"details\": [],\n  \"adminStatusAtChargeOffCodeOrId\": null,\n  \"referenceNumberOrId\": null,\n  \"reversalReferenceNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AccountChargeOff","description":"<h3 id=\"add-account-charge-off\">Add Account Charge-Off</h3>\n<p>Creates a new account charge-off record with optional detail lines. Mirrors the Add Charge-Off flow on the Account Charge-Off maintenance screen. The body mirrors the full charge-off data contract, including dealer-reserve, discount, points, acquisition-fee, and unpaid-balance breakdown fields. Returns the new charge-off <code>Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/AccountChargeOff</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) being charged off.</td>\n</tr>\n<tr>\n<td><em>chargeOffAmount</em></td>\n<td>Required decimal. Total principal amount being charged off.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Required date. Effective date of the charge-off.</td>\n</tr>\n<tr>\n<td><em>creationBranchDate</em></td>\n<td>Required date. Branch date on which the charge-off is posted.</td>\n</tr>\n<tr>\n<td><em>dealerReserveAmount</em></td>\n<td>Optional decimal. Dealer reserve amount associated with the charge-off.</td>\n</tr>\n<tr>\n<td><em>adminStatusIdAtChargeOff</em></td>\n<td>Optional Guid. Admin status <code>Id</code> that should be posted at charge-off.</td>\n</tr>\n<tr>\n<td><em>referenceId</em></td>\n<td>Optional Guid. Reference-number <code>Id</code> to attach to the charge-off transaction.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form note attached to the charge-off.</td>\n</tr>\n<tr>\n<td><em>insuranceRefundSum</em>, <em>subAccountSum</em>, <em>lateFeeSum</em>, <em>otherBalanceFeeSum</em>, <em>unpaidInterestOrFinanceChargeRebateAmount</em>, <em>totalOriginationFeeRebate</em>, <em>dealerDiscountFromBalanceAmount</em>, <em>dealerDiscountFromLossAmount</em>, <em>dealerWithholdAmount</em>, <em>pointsFromBalanceAmount</em>, <em>pointsFromLossAmount</em>, <em>acqFeeFromBalanceAmount</em>, <em>acqFeeFromLossAmount</em>, <em>afterCOWaivedUnpaidInterest</em>, <em>subAccountInsuranceSum</em></td>\n<td>Optional decimals. Balance breakdown amounts captured at charge-off.</td>\n</tr>\n<tr>\n<td><em>unpaidSubAccountMethod</em>, <em>unpaidLateFeeMethod</em>, <em>unpaidOtherBalanceFeeMethod</em>, <em>unpaidInterestMethod</em>, <em>unpaidSubAccountInsuranceMethod</em></td>\n<td>Optional integers. Disposition codes for each unpaid-balance bucket.</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>Optional array. Charge-off detail items (<code>accountTransactionId</code>, <code>amount</code>, <code>insurancePolicyId</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>adminStatusAtChargeOffCodeOrId</code></td>\n<td><code>adminStatusIdAtChargeOff</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>referenceNumberOrId</code></td>\n<td><code>referenceId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>reversalReferenceNumberOrId</code></td>\n<td><code>reversalReferenceNumberId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>details[].insurancePolicyNumberOrId</code></td>\n<td><code>details[].insurancePolicyId</code></td>\n<td>String. policy number for the selected account or policy GUID belonging to that account. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"adminStatusAtChargeOffCodeOrId\": \"ACTIVE\",\n  \"referenceNumberOrId\": \"12345\",\n  \"reversalReferenceNumberOrId\": \"12345\",\n  \"details\": [\n    {\n      \"insurancePolicyNumberOrId\": \"POL123\"\n    }\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","AccountChargeOff"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c3612c2c-5426-4ab9-9e45-d8c138363567","name":"AddAccountChargeOff - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"chargeOffAmount\": 12500,\n  \"effectiveDate\": \"{{effective_date}}\",\n  \"creationBranchDate\": \"{{branch_date}}\",\n  \"notes\": \"Charged off per collections policy\",\n  \"adminStatusAtChargeOffCodeOrId\": null,\n  \"referenceNumberOrId\": null,\n  \"reversalReferenceNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AccountChargeOff"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"65af7fad-1fd9-46a4-b66b-e26037036c4c","name":"AddAccountChargeOff - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"00000000\",\n  \"chargeOffAmount\": 12500,\n  \"effectiveDate\": \"{{effective_date}}\",\n  \"creationBranchDate\": \"{{branch_date}}\",\n  \"notes\": \"Charged off per collections policy\",\n  \"adminStatusAtChargeOffCodeOrId\": null,\n  \"referenceNumberOrId\": null,\n  \"reversalReferenceNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AccountChargeOff"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"6900f08f-3804-4576-9ab4-5fe6b418b5a2"},{"name":"AccountChargeOffAddBulk","id":"6542e2b4-51d1-4670-b04b-9546654cbb20","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"id\": \"11111111-1111-4111-8111-111111111111\",\n    \"chargeOffAmount\": 1250.00,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"notes\": \"Bulk charge-off\",\n    \"details\": []\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"id\": \"22222222-2222-4222-8222-222222222222\",\n    \"chargeOffAmount\": 725.00,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"details\": []\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountChargeOff?token={{token}}","description":"<p>Adds charge-off records for one to 250 accounts. The body is an array of independent account requests; every item requires <code>accountNumberOrId</code> plus its own charge-off fields. Supply a unique <code>id</code> for every charge-off and every detail row. Those IDs are retry keys: replaying a completed add returns the existing record instead of creating a duplicate. The route reuses the single Add Account Charge-Off permission and commits each account independently.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>[].adminStatusAtChargeOffCodeOrId</code></td>\n<td><code>[].adminStatusIdAtChargeOff</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].referenceNumberOrId</code></td>\n<td><code>[].referenceId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].reversalReferenceNumberOrId</code></td>\n<td><code>[].reversalReferenceNumberId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].details[].insurancePolicyNumberOrId</code></td>\n<td><code>[].details[].insurancePolicyId</code></td>\n<td>String. policy number for the selected account or policy GUID belonging to that account. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"\": [\n      {\n        \"adminStatusAtChargeOffCodeOrId\": \"ACTIVE\",\n        \"referenceNumberOrId\": \"12345\",\n        \"reversalReferenceNumberOrId\": \"12345\",\n        \"details\": [\n          {\n            \"insurancePolicyNumberOrId\": \"POL123\"\n          }\n        ]\n      }\n    ]\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","AddAccountChargeOff"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4a6a3ff8-aeea-4498-94a7-47975bd5b707","name":"AccountChargeOffAddBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"id\":\"11111111-1111-4111-8111-111111111111\",\"chargeOffAmount\":1250,\"effectiveDate\":\"2026-08-25\",\"creationBranchDate\":\"2026-08-25\",\"details\":[]}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"Id\":\"11111111-1111-4111-8111-111111111111\"}}]}}"},{"id":"508d2972-265f-412a-b346-f44932df9b3b","name":"AccountChargeOffAddBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"id\": \"11111111-1111-4111-8111-111111111111\",\n    \"chargeOffAmount\": 1250,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"notes\": \"Partial-error example\",\n    \"details\": []\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"id\": \"22222222-2222-4222-8222-222222222222\",\n    \"chargeOffAmount\": 725,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"details\": []\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"1959f209-d465-46da-8ca3-f9605890352d","name":"AccountChargeOffAddBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"6542e2b4-51d1-4670-b04b-9546654cbb20"},{"name":"AccountCustomerAdd","id":"5c6553f1-f10b-49ed-ae5a-edc062de1952","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"accountNumberOrId\": \"1000123\",\n    \"customerType\": 1,\n    \"entityType\": 1,\n    \"customerStatus\": 1,\n    \"militaryActiveDuty\": false,\n    \"customer\": {\n        \"firstName\": \"Jordan\",\n        \"middleName\": \"A\",\n        \"lastName\": \"Reyes\",\n        \"socialSecurityNumber\": \"555112222\",\n        \"birthday\": \"1988-04-12\",\n        \"maritalStatus\": 2,\n        \"numberOfDependents\": 2,\n        \"languageCode\": 1,\n        \"primaryAddressAsOfDate\": \"2023-06-01\",\n        \"physicalAddress\": {\n            \"addrLine1\": \"123 Main St\",\n            \"addrLine2\": \"Apt 4\",\n            \"city\": \"Los Angeles\",\n            \"zipCode\": \"90001\",\n            \"provinceAbbreviation\": \"CA\"\n        },\n        \"emailAddress\": \"jordan.reyes@example.com\",\n        \"defaultTransmissionType\": 1,\n        \"expenseRent\": 1850.00,\n        \"phoneNumbers\": [\n            {\n                \"phoneNumber\": \"6195550142\",\n                \"phoneNumberType\": 4,\n                \"primary\": true,\n                \"callOk\": true\n            },\n            {\n                \"phoneNumber\": \"6195550188\",\n                \"phoneNumberType\": 3,\n                \"callOk\": true\n            }\n        ],\n        \"employers\": [\n            {\n                \"employerName\": \"Acme Manufacturing\",\n                \"startDate\": \"2021-03-15\",\n                \"occupation\": \"Machinist\",\n                \"salary\": 68000,\n                \"salaryFrequency\": 5,\n                \"address\": {\n                    \"addrLine1\": \"900 Industrial Way\",\n                    \"city\": \"Los Angeles\",\n                    \"zipCode\": \"90021\",\n                    \"provinceAbbreviation\": \"CA\"\n                },\n                \"phoneNumber\": \"2135550190\"\n            }\n        ],\n        \"otherIncome\": {\n            \"source\": \"Rental property\",\n            \"amount\": 950.00,\n            \"frequency\": 6\n        },\n        \"references\": [\n            {\n                \"name\": \"Alex Morgan\",\n                \"contactType\": 4,\n                \"emailAddress\": \"alex.morgan@example.com\",\n                \"address\": {\n                    \"addrLine1\": \"88 Oak Street\",\n                    \"city\": \"San Diego\",\n                    \"zipCode\": \"92101\",\n                    \"provinceAbbreviation\": \"CA\"\n                },\n                \"phoneNumbers\": [\n                    {\n                        \"phoneNumber\": \"6195550177\",\n                        \"phoneNumberType\": 4,\n                        \"primary\": true,\n                        \"callOk\": true\n                    }\n                ]\n            }\n        ]\n    }\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountCustomer?token={{token}}","description":"<h3 id=\"add-account-customer\">Add Account Customer</h3>\n<p>Adds a borrower to an account by creating the <code>Common.AccountCustomer</code> row - what the customer entry screen does when a borrower is added. This record is what every other customer endpoint hangs off, and it is also what gives a customer the account its change log is written against, so a customer with no account link produces no customer-change log entries.\nThe borrower is supplied one of two ways, and exactly one of them:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Use</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Link a customer who already exists.</td>\n</tr>\n<tr>\n<td><em>customer</em></td>\n<td>Create a brand-new customer and link it in the same transaction.</td>\n</tr>\n<tr>\n<td>Sending both, or neither, is rejected. Creating the customer here is the <strong>only</strong> way to add one through the API, which is deliberate: it keeps a customer from ever existing without an account.</td>\n<td></td>\n</tr>\n<tr>\n<td>Writes the same <code>Account_Change_Borrower_Added_or_Removed</code> entry the screen's add path writes.</td>\n<td></td>\n</tr>\n<tr>\n<td>The account's borrower mix is re-checked with the new row folded in, so the request is rejected if it would leave the account with no primary borrower, two primary borrowers, two spouses, or a guarantor alongside a spouse or co-signer. Taking the Primary Customer or Spouse role from a borrower who already holds it needs <code>demoteExistingTo</code>, which changes both rows in one transaction.</td>\n<td></td>\n</tr>\n<tr>\n<td>An inactive customer is refused with \"Customer is unavailable\", the same way the screen refuses one.</td>\n<td></td>\n</tr>\n<tr>\n<td><strong>HTTP Method:</strong> POST</td>\n<td></td>\n</tr>\n<tr>\n<td><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer</code></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td><strong>Required</strong> string. Account GUID or numeric account number.</td>\n</tr>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Customer GUID or numeric customer number. Supply this <strong>or</strong> <code>customer</code>.</td>\n</tr>\n<tr>\n<td><em>customer</em></td>\n<td>A whole new customer to create. Supply this <strong>or</strong> <code>customerIdOrNumber</code>. See below.</td>\n</tr>\n<tr>\n<td><em>customerType</em></td>\n<td><strong>Required</strong> int. <code>CustomerTypes</code> (1 Primary Customer, 2 Spouse, 3 Co-Signer, 4 Guarantor).</td>\n</tr>\n<tr>\n<td><em>entityType</em></td>\n<td>Optional int. <code>EntityTypes</code> (1 Individual, the default, or 2 Business or Corporation).</td>\n</tr>\n<tr>\n<td><em>customerStatus</em></td>\n<td>Optional int. <code>CustomerStatuses</code>, defaulting to 1 Active.</td>\n</tr>\n<tr>\n<td><em>militaryActiveDuty</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullExperian</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullEquifax</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullTransUnion</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullFactorTrust</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>demoteExistingTo</em></td>\n<td>Optional int. Required when this request takes the Primary Customer or Spouse role from a borrower who already holds it: the <code>CustomerTypes</code> value that borrower should become (normally 3 Co-Signer).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"the-customer-object\">The <code>customer</code> object</h4>\n<p>Carries only what a user can enter on the customer entry screen. Fields the screen shows read-only are absent on purpose, because the processes that own them set them: <strong>MLA Last Result</strong> by the MLA check, <strong>Email OK</strong> by unsubscribe handling, <strong>Text OK</strong> by the texting opt-in, and the <strong>Customer Portal</strong> options by the customer in the portal.\nThe new customer's number is allocated by Omega during the insert and comes back as <code>CustomerNumber</code> in the response - see Response below.</p>\n<h5 id=\"required-fields\">Required fields</h5>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>firstName</em></td>\n<td>Letters, numbers, spaces and hyphens, up to 50 characters.</td>\n</tr>\n<tr>\n<td><em>lastName</em></td>\n<td>Letters, numbers, spaces and hyphens, up to 50 characters.</td>\n</tr>\n<tr>\n<td><em>physicalAddress</em></td>\n<td>The primary address. Omega refuses a customer without one. Object with <code>addrLine1</code>, <code>city</code>, <code>zipCode</code>, and either <code>provinceId</code> or <code>provinceAbbreviation</code>.</td>\n</tr>\n<tr>\n<td><em>primaryAddressAsOfDate</em></td>\n<td>When the customer moved to the physical address.</td>\n</tr>\n<tr>\n<td><em>socialSecurityNumber</em></td>\n<td>Nine digits, with or without dashes. Required <strong>unless</strong> the client's <code>ExternalMasterConfiguration.RequireCustomerSsn</code> is off, and checked for duplicates unless the client allows duplicate SSNs.</td>\n</tr>\n</tbody>\n</table>\n</div><h5 id=\"optional-fields---general\">Optional fields - General</h5>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>ssnCountryCode</em></td>\n<td>Int.</td>\n</tr>\n<tr>\n<td><em>middleName</em>, <em>akaName</em></td>\n<td>Same character rules as the names above.</td>\n</tr>\n<tr>\n<td><em>suffix</em></td>\n<td><code>Suffix</code>, defaulting to 1 Blank.</td>\n</tr>\n<tr>\n<td><em>driversLicenseNumber</em></td>\n<td>Printable ASCII, 20 characters.</td>\n</tr>\n<tr>\n<td><em>driversLicenseProvinceId</em> / <em>driversLicenseProvinceAbbreviation</em></td>\n<td>Either form.</td>\n</tr>\n<tr>\n<td><em>driversLicenseExpirationDate</em>, <em>birthday</em>, <em>lastOfacCheckDate</em></td>\n<td>Dates.</td>\n</tr>\n<tr>\n<td><em>sex</em></td>\n<td><code>Gender</code> (1 Male, 2 Female, 3 Not Selected, the default).</td>\n</tr>\n<tr>\n<td><em>maritalStatus</em></td>\n<td><code>MaritalStatuses</code>, defaulting to 5 Not Selected.</td>\n</tr>\n<tr>\n<td><em>isHomeOwner</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>languageCode</em></td>\n<td><code>UserLanguageTypes</code> (1 English, the default, 2 Spanish, 3 French).</td>\n</tr>\n<tr>\n<td><em>numberOfDependents</em></td>\n<td>0 to 999.</td>\n</tr>\n<tr>\n<td><em>homeBranchId</em> / <em>homeBranchNumber</em></td>\n<td>Either form.</td>\n</tr>\n</tbody>\n</table>\n</div><h5 id=\"optional-fields---addresses-time-zone-communication-expenses\">Optional fields - Addresses, time zone, communication, expenses</h5>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>mailingAddress</em></td>\n<td>Address object. Supplying one clears <code>isBillAddressSameAsPrimary</code>.</td>\n</tr>\n<tr>\n<td><em>previousAddress</em></td>\n<td>Address object. Requires <code>previousAddressAsOfDate</code>, which can never be later than <code>primaryAddressAsOfDate</code>.</td>\n</tr>\n<tr>\n<td><em>isBillAddressSameAsPrimary</em></td>\n<td>Bool, defaulting to true when no mailing address is supplied.</td>\n</tr>\n<tr>\n<td><em>timeZoneId</em> / <em>timeZoneCode</em></td>\n<td>Either form.</td>\n</tr>\n<tr>\n<td><em>callAfterTime</em>, <em>callBeforeTime</em></td>\n<td><code>HH:mm</code> or <code>HH:mm:ss</code>. Both go together; left out, the time zone's own window is used.</td>\n</tr>\n<tr>\n<td><em>emailAddress</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>allowBilling</em>, <em>allowLate</em>, <em>allowGeneralLetters</em>, <em>allowTransactions</em>, <em>allowPayments</em></td>\n<td>Bools.</td>\n</tr>\n<tr>\n<td><em>defaultTransmissionType</em></td>\n<td><code>TransmissionMethods</code>, defaulting to 1 Print. <strong>EMail is rejected on create</strong> - Email OK is recorded by the e-mail opt-in handling, not on a new customer - so switch to it afterwards with the customer communication endpoint. Fax requires a Fax phone number in <code>phoneNumbers</code>.</td>\n</tr>\n<tr>\n<td><em>customerPortalDeliveryMethod</em></td>\n<td><code>CustomerPortalDeliveryMethods</code>, defaulting to 1 Opted Out.</td>\n</tr>\n<tr>\n<td><em>expenseRent</em>, <em>expenseUtilities</em>, <em>expenseOther</em>, <em>expenseCreditBureau</em></td>\n<td>Decimals.</td>\n</tr>\n<tr>\n<td><em>expenseOtherDescription</em></td>\n<td>String.</td>\n</tr>\n</tbody>\n</table>\n</div><h5 id=\"optional-child-records\">Optional child records</h5>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>phoneNumbers</em></td>\n<td>Array. Each row needs <code>phoneNumber</code> and <code>phoneNumberType</code>; <code>primary</code>, <code>callOk</code>, <code>phoneNumberStatusId</code> / <code>phoneNumberStatusDescription</code> are optional. Exactly one row is primary - the first is taken as primary when none is marked. There is no <code>textOk</code>: texting consent is recorded by the opt-in flow when the provider confirms it, so a number being created has none to carry. Turn it on afterwards with the customer phone endpoints.</td>\n</tr>\n<tr>\n<td><em>employers</em></td>\n<td>Array. <code>employerName</code> and <code>startDate</code> go together; <code>endDate</code> makes it a former employer (Active is derived, not an input). <code>salaryHours</code> is 0 to 168 and is kept only when <code>salaryFrequency</code> is Hourly. Each employer takes one <code>address</code> and one <code>phoneNumber</code>, always a Work number and always primary for that employer.</td>\n</tr>\n<tr>\n<td><em>otherIncome</em></td>\n<td>Object - the screen carries one per customer. <code>source</code> and <code>amount</code> are required; <code>hours</code> is kept only when <code>frequency</code> is Hourly.</td>\n</tr>\n<tr>\n<td><em>references</em></td>\n<td>Array. <code>name</code> and <code>contactType</code> are required; Billing (1), Banker (2), General (3) and OmegaSign (21) are not selectable for references. Each reference takes one <code>address</code> and its own <code>phoneNumbers</code> rows, of which exactly one is primary.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>The new <code>Common.AccountCustomer</code> row.</td>\n</tr>\n<tr>\n<td><em>AccountId</em>, <em>CustomerId</em></td>\n<td>The account and the borrower it links.</td>\n</tr>\n<tr>\n<td><em>CustomerNumber</em></td>\n<td>The number Omega assigned, present when a new customer was created and null when an existing one was linked. Returned so a caller that just created customers does not need a follow-up read per customer to learn the number every other endpoint identifies them by.</td>\n</tr>\n<tr>\n<td><em>Displaced*</em></td>\n<td>Present only when <code>demoteExistingTo</code> moved another borrower out of the Primary Customer or Spouse role: the row, customer and new type of the borrower that was displaced.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"5c6553f1-f10b-49ed-ae5a-edc062de1952"},{"name":"AccountCustomerUpdate","id":"b3f4fbb3-095f-45fb-9c8b-19ed92b5c399","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"customerStatus\": 1,\n    \"customerType\": 1,\n    \"entityType\": 1,\n    \"militaryActiveDuty\": false,\n    \"pullExperian\": true,\n    \"pullEquifax\": true,\n    \"pullTransUnion\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountCustomer/{{account_customer_id}}?token={{token}}","description":"<h3 id=\"update-account-customer\">Update Account Customer</h3>\n<p>Updates the <code>Common.AccountCustomer</code> fields the customer entry screen edits per account: the General group box customer status, entity type and customer type, the military active duty flag, and the Additional Information credit-bureau pull flags. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag.\nMLA Last Result is display only on the screen (the Check MLA Status button writes it), so it is not settable here.</p>\n<h4 id=\"removing-a-borrower\">Removing a borrower</h4>\n<p>How a borrower is removed depends on whether the account has been activated, matching the screen:</p>\n<ul>\n<li><p><strong>Activated account</strong> - \"Clear Customer\" keeps the row and sets <code>CustomerStatus</code> to Deleted (40)\nwith a status-change timestamp, because borrower history is tracked from activation onwards. Use\n<code>customerStatus: 40</code> here; <code>DELETE</code> is refused on an activated account.</p>\n</li>\n<li><p><strong>Not activated</strong> (internal status Loan Application or Approved Account Pending Activation) - the\naccount-customer row is deleted outright along with its verification, linked documents, credit\ninquiries and report temp fields, since no history is tracked yet. Use\n<code>DELETE api/Client/Account/AccountCustomer/{id}</code>.</p>\n</li>\n</ul>\n<p>Removing a non-primary borrower is one call. Removing the primary borrower takes two, matching what the screen does inside a single save, because an account must always have exactly one primary:</p>\n<ol>\n<li><p><code>PUT .../AccountCustomer/{otherBorrowerId}</code> with <code>customerType: 1</code> and <code>demoteExistingTo: 3</code> -\nthe replacement becomes the primary customer and the outgoing one becomes a co-signer.</p>\n</li>\n<li><p><code>PUT .../AccountCustomer/{outgoingBorrowerId}</code> with <code>customerStatus: 40</code>.\nTaken in the other order the first call is rejected, because it would leave the account with no primary borrower.\nOnly one borrower can be the Primary Customer and only one can be the Spouse. Promoting a borrower into a role another borrower holds needs <code>demoteExistingTo</code>, so both rows change together the way the screen swaps them in a single save; without it the request is rejected rather than reclassifying a borrower implicitly. The response then also reports the displaced borrower.\nChanging <code>customerStatus</code> stamps the status-change timestamp the way the screen does, and the borrower-mix rules the screen enforces are checked against the account's stored rows: exactly one primary borrower, the primary must be active while any active borrower exists, at most one spouse, at least one active or deceased borrower, and no mixing a guarantor with a spouse or co-signer.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer/{id}</code></p>\n</li>\n</ol>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. <code>Common.AccountCustomer.Id</code>, from <code>GET api/Client/Account/AccountCustomer/{accountNumberOrId}</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerStatus</em></td>\n<td>Optional int. <code>CustomerStatuses</code> (1 Active, 20 Deceased, 30 Terminated, 40 Deleted).</td>\n</tr>\n<tr>\n<td><em>customerType</em></td>\n<td>Optional int. <code>CustomerTypes</code> (1 Primary Customer, 2 Spouse, 3 Co-Signer, 4 Guarantor).</td>\n</tr>\n<tr>\n<td><em>entityType</em></td>\n<td>Optional int. <code>EntityTypes</code> (1 Individual, 2 Business or Corporation).</td>\n</tr>\n<tr>\n<td><em>militaryActiveDuty</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullExperian</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullEquifax</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullTransUnion</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>pullFactorTrust</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>demoteExistingTo</em></td>\n<td>Optional int. Required when this request promotes the borrower to Primary Customer or Spouse and another borrower already holds that role: the <code>CustomerTypes</code> value that borrower should become (normally 3 Co-Signer). Both rows change in one transaction.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer","{{account_customer_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"b3f4fbb3-095f-45fb-9c8b-19ed92b5c399"},{"name":"AccountCustomerDelete","id":"608392bc-8d35-4675-abf6-cc3a936187bb","request":{"method":"DELETE","header":[],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer/{{account_customer_id}}?token={{token}}","description":"<h3 id=\"delete-account-customer\">Delete Account Customer</h3>\n<p>Removes a borrower from an account that has <strong>not been activated yet</strong>, which is what \"Clear Customer\" does during account entry: the <code>Common.AccountCustomer</code> row is deleted outright, together with its originations customer verification, the customer's account linked documents, its account customer credit inquiries and its report temp fields. Omega tracks no borrower history before activation, so nothing is kept behind.\nAllowed only while the account's internal status is Loan Application (1) or Approved Account Pending Activation (2). Once an account is activated the screen keeps the row and moves it to Deleted status instead, so this is refused and the error points at <code>PUT api/Client/Account/AccountCustomer/{id}</code> with <code>customerStatus</code> 40.\nThe borrower-mix rules still apply: an account keeps at least one borrower, exactly one primary customer, and at least one active or deceased borrower. To remove the sitting primary, first promote a replacement with <code>customerType</code> 1 and <code>demoteExistingTo</code>, then delete this row.\n<strong>HTTP Method:</strong> DELETE\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. <code>Common.AccountCustomer.Id</code>, from <code>GET api/Client/Account/AccountCustomer/{accountNumberOrId}</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer","{{account_customer_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"608392bc-8d35-4675-abf6-cc3a936187bb"},{"name":"AccountChargeOffGet","id":"8416be17-0273-4f7e-b434-8780d4284150","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/account/AccountChargeOff/{{account_number_or_id}}?fetchDetail=false","description":"<h3 id=\"get-current-account-charge-off\">Get Current Account Charge-Off</h3>\n<p>Returns the current (non-reversed) charge-off record for an account, or <code>null</code> when the account has never been charged off or the most recent charge-off was reversed. Mirrors the read path used by the Account Charge-Off maintenance screen when it loads the existing record for editing.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/AccountChargeOff/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account to look up.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchDetail</em></td>\n<td>Optional boolean. When <code>true</code>, the response also includes the charge-off detail line items. Defaults to <code>false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","AccountChargeOff","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"fetchDetail","value":"false"}],"variable":[]}},"response":[{"id":"a893b59e-92a1-491d-bb50-403e943b1b2e","name":"GetAccountChargeOff - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/AccountChargeOff/{{account_number}}?fetchDetail=true","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","AccountChargeOff","{{account_number}}"],"query":[{"key":"fetchDetail","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ChargeOffAmount\": 12500.00,\n        \"EffectiveDate\": \"04/18/2026\",\n        \"CreationBranchDate\": \"04/18/2026\",\n        \"DealerReserveAmount\": 0,\n        \"AdminStatusIdAtChargeOff\": null,\n        \"ReferenceId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ReversalReferenceNumberId\": null,\n        \"Notes\": \"Charged off per collections policy\",\n        \"WasReversed\": false,\n        \"ReversalBranchDate\": null,\n        \"InsuranceRefundSum\": 0,\n        \"SubAccountSum\": 0,\n        \"LateFeeSum\": 0,\n        \"OtherBalanceFeeSum\": 0,\n        \"UnpaidInterestOrFinanceChargeRebateAmount\": 0,\n        \"Details\": []\n    }\n}"},{"id":"0522073a-6984-4ecf-83a0-27e211954e21","name":"GetAccountChargeOff - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/AccountChargeOff/00000000?fetchDetail=true","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","AccountChargeOff","00000000"],"query":[{"key":"fetchDetail","value":"true"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"8416be17-0273-4f7e-b434-8780d4284150"},{"name":"AccountChargeOffGetBulk","id":"ccee8265-3b8e-4ca7-a12e-90310914ae0d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"fetchDetail\": true },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"fetchDetail\": false }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountChargeOff?token={{token}}","description":"<p>Returns the current non-reversed charge-off for one to 250 accounts. Each array item accepts an account number or account ID and independently chooses whether to include charge-off details. The route reuses the single Get Account Charge-Off permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountChargeOff"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"60bf0ab7-3d61-4522-8943-a57cd6ff2bf2","name":"AccountChargeOffGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"Id\":\"11111111-1111-4111-8111-111111111111\",\"ChargeOffAmount\":1250}}]}}"},{"id":"83b55838-f26f-451e-8932-10716fc2dc7f","name":"AccountChargeOffGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"fetchDetail\": true\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"fetchDetail\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"a5190a90-8cc6-4ca7-9797-057f65a5b55a","name":"AccountChargeOffGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"ccee8265-3b8e-4ca7-a12e-90310914ae0d"},{"name":"AccountChargeOffsGetAll","id":"2eef086c-145c-477c-9596-f4bf1be87529","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/account/AccountChargeOff/{{account_number_or_id}}/all?fetchDetail=false","description":"<h3 id=\"get-all-account-charge-offs\">Get All Account Charge-Offs</h3>\n<p>Returns every charge-off record (current and reversed) for an account, ordered from most recent. Use this when auditing the full charge-off/reversal history rather than just the active record. Returns an empty array when the account has no charge-off history.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/AccountChargeOff/{accountNumberOrId}/all</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account to look up.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchDetail</em></td>\n<td>Optional boolean. When <code>true</code>, each charge-off in the response also includes its detail line items. Defaults to <code>false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","AccountChargeOff","{{account_number_or_id}}","all"],"host":["{{base_url}}"],"query":[{"key":"fetchDetail","value":"false"}],"variable":[]}},"response":[{"id":"6bf3a160-d13f-46b9-a3eb-3145b94eae64","name":"GetAllAccountChargeOffs - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/AccountChargeOff/{{account_number}}/all?fetchDetail=false","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","AccountChargeOff","{{account_number}}","all"],"query":[{"key":"fetchDetail","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000001\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"ChargeOffAmount\": 12500.00,\n            \"EffectiveDate\": \"04/18/2026\",\n            \"CreationBranchDate\": \"04/18/2026\",\n            \"WasReversed\": false,\n            \"ReversalBranchDate\": null,\n            \"Notes\": \"Charged off per collections policy\"\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000002\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"ChargeOffAmount\": 8200.00,\n            \"EffectiveDate\": \"01/10/2025\",\n            \"CreationBranchDate\": \"01/10/2025\",\n            \"WasReversed\": true,\n            \"ReversalBranchDate\": \"02/14/2025\",\n            \"Notes\": \"Initial charge-off later reversed\"\n        }\n    ]\n}"},{"id":"2cf91259-9b85-47c5-952d-20fb5e05c908","name":"GetAllAccountChargeOffs - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/AccountChargeOff/00000000/all?fetchDetail=false","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","AccountChargeOff","00000000","all"],"query":[{"key":"fetchDetail","value":"false"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"2eef086c-145c-477c-9596-f4bf1be87529"},{"name":"AccountChargeOffsGetAllBulk","id":"c567c098-61c3-410e-8a34-47d16ea2f801","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"fetchDetail\": false },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"fetchDetail\": false }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAllAccountChargeOffs?token={{token}}","description":"<p>Returns charge-off history for one to 250 accounts, including reversed records. Each item requires an account number or account ID. <code>fetchDetail</code> must be false because expanding details across a history list is unbounded; use the single-account route when details are required. The route reuses the single Get All Account Charge-Offs permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAllAccountChargeOffs"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"0e3f248a-c6d9-4ae1-b636-c6d7edf8a6f3","name":"AccountChargeOffsGetAllBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAllAccountChargeOffs?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAllAccountChargeOffs"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"Id\":\"11111111-1111-4111-8111-111111111111\",\"ChargeOffAmount\":1250}]}]}}"},{"id":"f38f1b87-53d7-43dd-bc59-4b047f9c203e","name":"AccountChargeOffsGetAllBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"fetchDetail\": false\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"fetchDetail\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAllAccountChargeOffs?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAllAccountChargeOffs"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"3e3b2e55-954c-4027-8c43-ee47c02976ec","name":"AccountChargeOffsGetAllBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAllAccountChargeOffs?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAllAccountChargeOffs"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"c567c098-61c3-410e-8a34-47d16ea2f801"},{"name":"AccountChargeOffUpdate","id":"2ff5dc7e-2c3d-4d54-a598-9678eed7a652","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number_or_id}}\",\n  \"chargeOffAmount\": 12500,\n  \"effectiveDate\": \"{{effective_date}}\",\n  \"creationBranchDate\": \"{{branch_date}}\",\n  \"dealerReserveAmount\": 0,\n  \"adminStatusIdAtChargeOff\": null,\n  \"referenceId\": null,\n  \"notes\": \"Updated charge-off amounts\",\n  \"wasReversed\": false,\n  \"reversalBranchDate\": null,\n  \"reversalReferenceNumberId\": null,\n  \"insuranceRefundSum\": 0,\n  \"subAccountSum\": 0,\n  \"lateFeeSum\": 0,\n  \"otherBalanceFeeSum\": 0,\n  \"unpaidInterestOrFinanceChargeRebateAmount\": 0,\n  \"details\": [],\n  \"adminStatusAtChargeOffCodeOrId\": null,\n  \"referenceNumberOrId\": null,\n  \"reversalReferenceNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AccountChargeOff/{{charge_off_id}}","description":"<h3 id=\"update-account-charge-off\">Update Account Charge-Off</h3>\n<p>Updates an existing account charge-off and its detail lines. Mirrors the Edit Charge-Off flow on the Account Charge-Off maintenance screen. The route <code>id</code> identifies the charge-off record; the server automatically re-reads the current <code>Ts</code> for optimistic concurrency so the request body does not need to supply one. Returns the updated charge-off <code>Id</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/AccountChargeOff/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the charge-off record to update.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same field set as <code>POST api/client/account/AccountChargeOff</code>, with the following additions that are typically set only on update:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>wasReversed</em></td>\n<td>Optional boolean. When <code>true</code>, marks the charge-off as reversed.</td>\n</tr>\n<tr>\n<td><em>reversalBranchDate</em></td>\n<td>Optional date. Branch date on which the reversal was posted. Required when <code>wasReversed</code> is <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>reversalReferenceNumberId</em></td>\n<td>Optional Guid. Reference-number <code>Id</code> of the reversal transaction.</td>\n</tr>\n</tbody>\n</table>\n</div><p>See <code>POST api/client/account/AccountChargeOff</code> for the full balance breakdown and detail-item field reference.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>adminStatusAtChargeOffCodeOrId</code></td>\n<td><code>adminStatusIdAtChargeOff</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>referenceNumberOrId</code></td>\n<td><code>referenceId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>reversalReferenceNumberOrId</code></td>\n<td><code>reversalReferenceNumberId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>details[].insurancePolicyNumberOrId</code></td>\n<td><code>details[].insurancePolicyId</code></td>\n<td>String. policy number for the selected account or policy GUID belonging to that account. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"adminStatusAtChargeOffCodeOrId\": \"ACTIVE\",\n  \"referenceNumberOrId\": \"12345\",\n  \"reversalReferenceNumberOrId\": \"12345\",\n  \"details\": [\n    {\n      \"insurancePolicyNumberOrId\": \"POL123\"\n    }\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","AccountChargeOff","{{charge_off_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2de2138d-ea19-4eb3-9e7f-e3a59f44fa79","name":"UpdateAccountChargeOff - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"chargeOffAmount\": 12500,\n  \"effectiveDate\": \"{{effective_date}}\",\n  \"creationBranchDate\": \"{{branch_date}}\",\n  \"notes\": \"Adjusted charge-off amount after review\",\n  \"adminStatusAtChargeOffCodeOrId\": null,\n  \"referenceNumberOrId\": null,\n  \"reversalReferenceNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AccountChargeOff/{{charge_off_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"320e80c1-0414-49bb-9ea8-204bac9d8825","name":"UpdateAccountChargeOff - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"chargeOffAmount\": 12500,\n  \"effectiveDate\": \"{{effective_date}}\",\n  \"creationBranchDate\": \"{{branch_date}}\",\n  \"notes\": \"Adjusted charge-off amount after review\",\n  \"adminStatusAtChargeOffCodeOrId\": null,\n  \"referenceNumberOrId\": null,\n  \"reversalReferenceNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AccountChargeOff/00000000-0000-0000-0000-000000000000"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account charge-off not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"2ff5dc7e-2c3d-4d54-a598-9678eed7a652"},{"name":"AccountChargeOffUpdateBulk","id":"c7b529d1-4842-433f-9384-69ebf1f0b671","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"id\": \"{{charge_off_id}}\",\n    \"chargeOffAmount\": 1200.00,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"notes\": \"Updated by bulk API\",\n    \"details\": []\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"id\": \"33333333-3333-4333-8333-333333333333\",\n    \"chargeOffAmount\": 700.00,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"details\": []\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountChargeOff?token={{token}}","description":"<p>Updates charge-off records for one to 250 accounts. Every item supplies the account number or ID, the charge-off <code>id</code>, and that account's complete replacement values. The service verifies that the charge-off belongs to the selected account and loads its current timestamp before saving. Detail rows also require stable IDs. The route reuses the single Update Account Charge-Off permission and commits each account independently.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>[].adminStatusAtChargeOffCodeOrId</code></td>\n<td><code>[].adminStatusIdAtChargeOff</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].referenceNumberOrId</code></td>\n<td><code>[].referenceId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].reversalReferenceNumberOrId</code></td>\n<td><code>[].reversalReferenceNumberId</code></td>\n<td>String. transaction reference number or reference-record GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].details[].insurancePolicyNumberOrId</code></td>\n<td><code>[].details[].insurancePolicyId</code></td>\n<td>String. policy number for the selected account or policy GUID belonging to that account. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"\": [\n      {\n        \"adminStatusAtChargeOffCodeOrId\": \"ACTIVE\",\n        \"referenceNumberOrId\": \"12345\",\n        \"reversalReferenceNumberOrId\": \"12345\",\n        \"details\": [\n          {\n            \"insurancePolicyNumberOrId\": \"POL123\"\n          }\n        ]\n      }\n    ]\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","UpdateAccountChargeOff"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"cf3e6fc3-246e-465d-8d83-3e78a44e43b7","name":"AccountChargeOffUpdateBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"id\":\"11111111-1111-4111-8111-111111111111\",\"chargeOffAmount\":1200,\"effectiveDate\":\"2026-08-25\",\"creationBranchDate\":\"2026-08-25\",\"details\":[]}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"Id\":\"11111111-1111-4111-8111-111111111111\"}}]}}"},{"id":"a5414c68-e698-4a80-ad0c-4c20e68f46b4","name":"AccountChargeOffUpdateBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"id\": \"{{charge_off_id}}\",\n    \"chargeOffAmount\": 1200,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"notes\": \"Partial-error example\",\n    \"details\": []\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"id\": \"33333333-3333-4333-8333-333333333333\",\n    \"chargeOffAmount\": 700,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"creationBranchDate\": \"{{branch_date}}\",\n    \"dealerReserveAmount\": 0,\n    \"details\": []\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"29c91514-b895-43f3-ac10-8d02692d2a33","name":"AccountChargeOffUpdateBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountChargeOff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateAccountChargeOff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"c7b529d1-4842-433f-9384-69ebf1f0b671"},{"name":"AccountConvenienceFeeUpdate","id":"b9cb1586-8887-40ae-a317-45188b3c4b5e","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"ConvenienceFee\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": \"{{account_number}}\",\r\n            \"valueToUpdate\": \"{{convenience_fee}}\"\r\n        }\r\n    ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts","description":"<h6 id=\"this-method-with-type-set-as-conveniencefee-will-set-or-clear-the-payment-convenience-fee-on-the-account\">This method with <strong>\"<em>Type</em>\"</strong> set as <code>ConvenienceFee</code> will set or clear the payment convenience fee on the account.</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Token</em></td>\n<td>Required. Token to identify your login access provided by the Login method.</td>\n</tr>\n<tr>\n<td><em>Type</em></td>\n<td>Required. Must be set to \"ConvenienceFee\" to update the account payment convenience fee.</td>\n</tr>\n<tr>\n<td><em>Data</em></td>\n<td>Required. The list of collectors to assign to an account.</td>\n</tr>\n<tr>\n<td><em>AccountNumber</em></td>\n<td>Required. Must be a valid int64 greater than 0. This field must match an account number in the Omega system.</td>\n</tr>\n<tr>\n<td><em>ValueToUpdate</em></td>\n<td>Optional decimal string. When blank, the existing payment convenience fee is cleared.</td>\n</tr>\n</tbody>\n</table>\n</div><p>API Access: the caller's API Access role needs the UpdateAccounts endpoint, or its <strong>Convenience Fee</strong> operation. A role granted only some types gets 403 for the others.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","updateaccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c2ab4788-a828-491f-80f0-f8067f17c708","name":"Convenience Fee - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"ConvenienceFee\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 34892,\r\n            \"valueToUpdate\": \"2.99\"\r\n        },\r\n        {\r\n            \"accountNumber\": 34881,\r\n            \"valueToUpdate\": \"2.99\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"},{"id":"712367b3-6b97-4dfc-a732-2993b6ed56de","name":"Convenience Fee - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"ConvenienceFee\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 34892,\r\n            \"valueToUpdate\": \"convfee\"\r\n        },\r\n        {\r\n            \"accountNumber\": 0,\r\n            \"valueToUpdate\": \"2.99\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Record 1 Account 34892: Invalid convenience fee amount.\",\n        \"Record 2 Account 0: Account not found.\"\n    ]\n}"}],"_postman_id":"b9cb1586-8887-40ae-a317-45188b3c4b5e"},{"name":"AccountAdminStatusUpdate","id":"90920b40-a2ac-4a02-bddd-506a58325025","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"type\": \"AdminStatus\",\n    \"data\": [\n        {\n            \"accountNumber\": \"{{account_number}}\",\n            \"valueToUpdate\": \"{{admin_status_code}}\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts","description":"<h6 id=\"this-method-with-type-set-as-adminstatus-sets-the-admin-status-of-one-or-more-accounts\">This method with <strong>\"<em>Type</em>\"</strong> set as <code>AdminStatus</code> sets the admin status of one or more accounts.</h6>\n<p>Each account is updated and saved on its own, with the same rules as View Account and Mass Update Admin Status. Only the account is saved: the account log gets an \"Admin Status changed\" entry with the old and new codes, and account triggers run. An account that already has the admin status is left as it is and is not an error.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Token</em></td>\n<td>Required. Token to identify your login access provided by the Login method.</td>\n</tr>\n<tr>\n<td><em>Type</em></td>\n<td>Required. Must be set to \"AdminStatus\" to update account admin statuses.</td>\n</tr>\n<tr>\n<td><em>Data</em></td>\n<td>Required. The accounts to update, at most 250 in one request.</td>\n</tr>\n<tr>\n<td><em>AccountNumber</em></td>\n<td>Required. Must be a valid int64 greater than 0. This field must match an account number in the Omega system. The account must be activated and not purged; Closed and Charged Off accounts can be updated.</td>\n</tr>\n<tr>\n<td><em>ValueToUpdate</em></td>\n<td>Required. The new admin status code (or its Id). It must be active and a Servicing or Both admin status.</td>\n</tr>\n</tbody>\n</table>\n</div><p>API Access: the caller's API Access role needs the UpdateAccounts endpoint, or its <strong>Admin Status</strong> operation. A role granted the whole endpoint may use every type; a role granted only some types gets 403 for the others. The client's API key (the system user) is not checked.</p>\n<p>A browser session (SessionId) has no API Access role, so it needs the screen permission instead: <strong>Edit Admin Status</strong> for one account, <strong>Mass Update Admin Status</strong> for more than one. Without it the request gets 403.</p>\n<p>Enhanced security: on Enterprise edition, an admin status that uses enhanced security can only be changed from, or to, by users whose roles allow it. The client's API key signs in as the system user, which has no roles, so it is treated as an administrator and may use secured statuses. A status flagged enhanced without its enhanced settings is refused for everyone.</p>\n<p>Errors are listed per account as \"Record n Account x: reason\". statusCode is 0 (Ok) when every account was updated or already had the status, 100 (Successful With Error) when some were updated, and 50 (Error) when none were.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","updateaccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"11c3575a-2593-4689-ae49-6283412cba80","name":"Admin Status - Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"type\": \"AdminStatus\",\n    \"data\": [\n        {\n            \"accountNumber\": 30011709,\n            \"valueToUpdate\": \"BK\"\n        },\n        {\n            \"accountNumber\": 30011710,\n            \"valueToUpdate\": \"BK\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"errors\": []\n}"},{"id":"6ad5838f-9439-42b1-b7d0-4a12bae00019","name":"Admin Status - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"type\": \"AdminStatus\",\n    \"data\": [\n        {\n            \"accountNumber\": 30011709,\n            \"valueToUpdate\": \"BK\"\n        },\n        {\n            \"accountNumber\": 30011711,\n            \"valueToUpdate\": \"NOSUCH\"\n        },\n        {\n            \"accountNumber\": 0,\n            \"valueToUpdate\": \"BK\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 100,\n    \"result\": \"Successful With Error\",\n    \"errors\": [\n        \"Record 2 Account 30011711: Admin status 'NOSUCH' not found.\",\n        \"Record 3 Account 0: Account not found.\"\n    ]\n}"},{"id":"ebda3fee-3d4a-4a5e-9c83-cb14117cac3c","name":"Admin Status - Not Allowed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"type\": \"AdminStatus\",\n    \"data\": [\n        {\n            \"accountNumber\": 30011709,\n            \"valueToUpdate\": \"BK\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"\"Your API Access role does not allow 'AdminStatus' on this endpoint.\""}],"_postman_id":"90920b40-a2ac-4a02-bddd-506a58325025"},{"name":"AccountCustomer1099CTaxFormByIdGet","id":"5319af4c-e595-4225-b076-827cbffe0f46","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/ById/{{account_customer_1099c_id}}","description":"<h3 id=\"get-account-1099-c-tax-form-by-id\">Get Account 1099-C Tax Form By Id</h3>\n<p>Returns a single 1099-C tax form record by its Guid primary key. Wraps <code>AccountCustomer1099CTaxFormServices.ReturnAccountCustomerTaxFormWithId</code>, which does a direct <code>FetchEntity</code> on <code>Common.AccountCustomer1099CTaxForm</code>. Returns <code>Tax form not found</code> when the Guid is valid but no matching row exists.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/ById/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountCustomer1099CTaxForm</code> row to fetch. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank or not a parseable Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer1099CTaxForm","ById","{{account_customer_1099c_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9e12377b-16d4-4e83-aa8b-2192e0536ac3","name":"GetAccountCustomer1099CTaxFormById - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/ById/{{account_customer_1099c_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000001\",\n        \"AccountCustomerId\": \"00000000-0000-0000-0000-000000000010\",\n        \"TaxYear\": 2025,\n        \"Printed\": true,\n        \"CreationBranchDate\": \"01/31/2026\",\n        \"CreatedByUserId\": \"00000000-0000-0000-0000-000000000020\",\n        \"Box1OccurrenceDate\": \"12/31/2025\",\n        \"Box2DebtAmount\": 12500.00,\n        \"Box3Interest\": 0,\n        \"Box4Description\": \"Charge-off balance\",\n        \"Box5IsPersonallyLiable\": true,\n        \"Box6ReasonCode\": 1,\n        \"Box7PropertyFairMarketValue\": null\n    }\n}"},{"id":"71c5522c-d069-4c4c-9113-2e7831a79a48","name":"GetAccountCustomer1099CTaxFormById - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/ById/00000000-0000-0000-0000-000000000000"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Tax form not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"5319af4c-e595-4225-b076-827cbffe0f46"},{"name":"AccountCustomer1099CTaxFormsGet","id":"09f41377-1aba-4178-9586-9ab2ffef00d6","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/{{account_number_or_id}}","description":"<h3 id=\"get-account-1099-c-tax-forms\">Get Account 1099-C Tax Forms</h3>\n<p>Returns every 1099-C tax form attached to an account, ordered by <code>TaxYear</code> descending then by <code>Ts</code> descending. Resolves the account via the <code>accountNumberOrId</code> route segment (accepts either the Omega account number or the account <code>Id</code> Guid) and then returns the tax-form collection from <code>AccountCustomer1099CTaxFormServices.ReturnAccountCustomerTaxForm</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) to look up. Returns <code>BadRequest</code> with the standard invalid parameter message when blank, and an <code>Account not found</code> error when the account cannot be resolved for the calling client.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer1099CTaxForm","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4fd44f6b-2943-4daf-aabb-8db26e4fe824","name":"GetAccountCustomer1099CTaxForms - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/{{account_number}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000001\",\n            \"AccountCustomerId\": \"00000000-0000-0000-0000-000000000010\",\n            \"TaxYear\": 2025,\n            \"Printed\": true,\n            \"CreationBranchDate\": \"01/31/2026\",\n            \"CreatedByUserId\": \"00000000-0000-0000-0000-000000000020\",\n            \"Box1OccurrenceDate\": \"12/31/2025\",\n            \"Box2DebtAmount\": 12500.00,\n            \"Box3Interest\": 0,\n            \"Box4Description\": \"Charge-off balance\",\n            \"Box5IsPersonallyLiable\": true,\n            \"Box6ReasonCode\": 1,\n            \"Box7PropertyFairMarketValue\": null\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000002\",\n            \"AccountCustomerId\": \"00000000-0000-0000-0000-000000000010\",\n            \"TaxYear\": 2024,\n            \"Printed\": true,\n            \"CreationBranchDate\": \"01/31/2025\",\n            \"CreatedByUserId\": \"00000000-0000-0000-0000-000000000020\",\n            \"Box1OccurrenceDate\": \"12/31/2024\",\n            \"Box2DebtAmount\": 8200.00,\n            \"Box3Interest\": 0,\n            \"Box4Description\": \"Charge-off balance\",\n            \"Box5IsPersonallyLiable\": true,\n            \"Box6ReasonCode\": 1,\n            \"Box7PropertyFairMarketValue\": null\n        }\n    ]\n}"},{"id":"1988e32c-264e-419f-a768-cf1487199174","name":"GetAccountCustomer1099CTaxForms - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer1099CTaxForm/00000000"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"09f41377-1aba-4178-9586-9ab2ffef00d6"},{"name":"AccountCustomer1099CTaxFormsGetBulk","id":"d698c44e-84c3-4c14-bbd5-f1ed572d2da3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomer1099CTaxForms?token={{token}}","description":"<p>Returns 1099-C tax forms for one to 250 accounts. Every item requires <code>accountNumberOrId</code>, which accepts an account number or account ID. The route reuses the single Account Customer 1099-C Tax Forms permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountCustomer1099CTaxForms"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"13078543-832a-490d-bbf8-4959093666bf","name":"AccountCustomer1099CTaxFormsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomer1099CTaxForms?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCustomer1099CTaxForms"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[]}]}}"},{"id":"a1adcc9a-26d8-42b9-9cf9-4d6717ff5305","name":"AccountCustomer1099CTaxFormsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomer1099CTaxForms?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCustomer1099CTaxForms"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"ab9fda93-0e7b-4036-8d7a-1f0ec6b70200","name":"AccountCustomer1099CTaxFormsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomer1099CTaxForms?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCustomer1099CTaxForms"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"d698c44e-84c3-4c14-bbd5-f1ed572d2da3"},{"name":"AccountCustomerByIdGet","id":"fd3d1301-a764-4d3f-88da-cadb5c179dc0","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer/ById/{{account_customer_id}}","description":"<h3 id=\"get-account-customer-by-id\">Get Account Customer By Id</h3>\n<p>Returns a single <code>Common.AccountCustomer</code> row by its Guid primary key. Wraps <code>AccountCustomerServices.ReturnCommonAccountCustomerById</code>, which does a direct <code>FetchEntity</code> on <code>Common.AccountCustomer</code>. Use this when the caller already has the account-customer <code>Id</code> (for example, from a prior <code>GET /AccountCustomer/{accountNumberOrId}</code> response) and only needs the link record without refetching the full account collection.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer/ById/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountCustomer</code> row to fetch. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank or not a parseable Guid, and <code>Account customer record not found</code> when no matching row exists.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer","ById","{{account_customer_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1bd2ef35-e2b4-478d-83ff-2fccb32dad0f","name":"GetAccountCustomerById - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer/ById/{{account_customer_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000010\",\n        \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"CustomerId\": \"00000000-0000-0000-0000-000000000100\",\n        \"CustomerType\": 1,\n        \"CustomerStatus\": 1,\n        \"EntityType\": 1,\n        \"CreationBranchDate\": \"04/18/2026\",\n        \"SequenceNumber\": 1,\n        \"MilitaryActiveDuty\": false,\n        \"PullExperian\": true,\n        \"PullEquifax\": true,\n        \"PullTransUnion\": true,\n        \"PullFactorTrust\": false\n    }\n}"},{"id":"bf210179-7e88-44e0-87b6-7723b9a0d5ce","name":"GetAccountCustomerById - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer/ById/00000000-0000-0000-0000-000000000999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account customer record not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"fd3d1301-a764-4d3f-88da-cadb5c179dc0"},{"name":"AccountCustomersGet","id":"d4a51ba0-02d9-45d7-9872-a37fbcf05556","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer/{{account_number_or_id}}?fetchCustomer=true&includeDeletedCustomers=false","description":"<h3 id=\"get-account-customers\">Get Account Customers</h3>\n<p>Returns the <code>Common.AccountCustomer</code> rows linked to an account, sorted by <code>CustomerType</code>, <code>CreationBranchDate</code>, then <code>Ts</code> ascending. Resolves the account via the <code>accountNumberOrId</code> route segment (accepts the Omega account number or the account <code>Id</code> Guid) and forwards to <code>AccountCustomerServices.ReturnAccountCustomers</code>. When <code>fetchCustomer</code> is <code>true</code> each row also includes the related <code>Common.Customer</code> record.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) to look up. Returns <code>BadRequest</code> with the standard invalid parameter message when blank, and an <code>Account not found</code> error when the account cannot be resolved for the calling client.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchCustomer</em></td>\n<td>Optional boolean. When <code>true</code> the response includes the navigated <code>CommonCustomer</code> record for each account-customer row. Defaults to <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>includeDeletedCustomers</em></td>\n<td>Optional boolean. When <code>false</code> the service filters to <code>CustomerStatus = Active</code> (primary customers marked <code>Deceased</code> are always kept). Set to <code>true</code> to return every account-customer row regardless of status. Defaults to <code>false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"fetchCustomer","value":"true"},{"key":"includeDeletedCustomers","value":"false"}],"variable":[]}},"response":[{"id":"1474a584-2eeb-4b10-854b-6d0fc89a0fa9","name":"GetAccountCustomers - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountCustomer/{{account_number}}?fetchCustomer=true&includeDeletedCustomers=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountCustomer","{{account_number}}"],"query":[{"key":"fetchCustomer","value":"true"},{"key":"includeDeletedCustomers","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000010\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"CustomerId\": \"00000000-0000-0000-0000-000000000100\",\n            \"CustomerType\": 1,\n            \"CustomerStatus\": 1,\n            \"CreationBranchDate\": \"04/18/2026\",\n            \"SequenceNumber\": 1,\n            \"MilitaryActiveDuty\": false,\n            \"PullExperian\": true,\n            \"PullEquifax\": true,\n            \"PullTransUnion\": true,\n            \"CommonCustomer\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000100\",\n                \"CustomerNumber\": 10001,\n                \"FirstName\": \"Jane\",\n                \"LastName\": \"Doe\",\n                \"FullNameFML\": \"Jane Q Doe\"\n            }\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000011\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"CustomerId\": \"00000000-0000-0000-0000-000000000101\",\n            \"CustomerType\": 2,\n            \"CustomerStatus\": 1,\n            \"CreationBranchDate\": \"04/18/2026\",\n            \"SequenceNumber\": 2,\n            \"MilitaryActiveDuty\": false,\n            \"PullExperian\": false,\n            \"PullEquifax\": false,\n            \"PullTransUnion\": false,\n            \"CommonCustomer\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000101\",\n                \"CustomerNumber\": 10002,\n                \"FirstName\": \"John\",\n                \"LastName\": \"Doe\",\n                \"FullNameFML\": \"John R Doe\"\n            }\n        }\n    ]\n}"},{"id":"3ea0d691-d173-48ed-abd3-c95e775abecc","name":"GetAccountCustomers - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountCustomer/00000000?fetchCustomer=true&includeDeletedCustomers=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountCustomer","00000000"],"query":[{"key":"fetchCustomer","value":"true"},{"key":"includeDeletedCustomers","value":"false"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d4a51ba0-02d9-45d7-9872-a37fbcf05556"},{"name":"AccountCustomersGetBulk","id":"35160798-f1a3-492e-966f-ae1a1cad60d0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"fetchCustomer\": true, \"includeDeletedCustomers\": false },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"fetchCustomer\": false, \"includeDeletedCustomers\": true }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomers?token={{token}}","description":"<p>Returns account-customer relationships for one to 250 accounts. Every item supplies an account number or account ID and can independently set <code>fetchCustomer</code> and <code>includeDeletedCustomers</code>. The route reuses the single Get Account Customers permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountCustomers"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"94c56f8b-1691-4aed-adba-e27854cafaf0","name":"AccountCustomersGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"fetchCustomer\":true,\"includeDeletedCustomers\":false}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomers?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCustomers"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"customer_number\":10001,\"relationship\":\"Primary\"}]}]}}"},{"id":"9227fc56-6f72-43f3-b673-5e6eb15abab7","name":"AccountCustomersGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"fetchCustomer\": true,\n    \"includeDeletedCustomers\": false\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"fetchCustomer\": false,\n    \"includeDeletedCustomers\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomers?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCustomers"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"f6d1b006-1ef8-49d0-a832-0ffbbc92003d","name":"AccountCustomersGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomers?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCustomers"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"35160798-f1a3-492e-966f-ae1a1cad60d0"},{"name":"AccountCustomerByIdGetBulk","id":"f9baa967-703a-4e81-a19d-2a7352667a07","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"accountCustomerId\": \"{{account_customer_id}}\" },\n  { \"accountNumberOrId\": \"{{account_number_2}}\", \"accountCustomerId\": \"{{account_customer_id_2}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCustomerById?token={{token}}","description":"<p>Returns one <code>Common.AccountCustomer</code> row per item, for up to 250 items. Each item supplies <code>accountCustomerId</code> (the row, replacing the single route's path segment) and <code>accountNumberOrId</code> (the account the row is keyed and reported under). Items naming the same account are not collapsed, so several borrowers on one account can be read in one request. The route reuses the single Get Account Customer By Id permission and counts as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountCustomerById"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"f9baa967-703a-4e81-a19d-2a7352667a07"},{"name":"AccountCustomerAddBulk","id":"c09b5d4e-1fe2-4a57-97f9-ea2dd805d7d5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"customerType\": 3,\n    \"entityType\": 1\n  },\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"customerType\": 1,\n    \"demoteExistingTo\": 3,\n    \"customer\": {\n      \"firstName\": \"Jordan\",\n      \"lastName\": \"Reyes\",\n      \"socialSecurityNumber\": \"555112222\",\n      \"primaryAddressAsOfDate\": \"2023-06-01\",\n      \"physicalAddress\": {\n        \"addrLine1\": \"123 Main St\",\n        \"city\": \"Los Angeles\",\n        \"zipCode\": \"90001\",\n        \"provinceAbbreviation\": \"CA\"\n      }\n    }\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountCustomer?token={{token}}","description":"<p>Adds a borrower to an account once per item, for up to 250 items. Each item is the single Add Account Customer body: <code>accountNumberOrId</code>, <code>customerType</code>, and <strong>either</strong> <code>customerIdOrNumber</code> to link an existing customer <strong>or</strong> a <code>customer</code> object to create a new one in the same transaction - not both, and not neither.</p>\n<p>Items naming the same account are <strong>not</strong> collapsed: an account legitimately takes several borrowers in one request. When an item claims Primary Customer (1) or Spouse (2) and another borrower already holds that role, <code>demoteExistingTo</code> must say what the displaced borrower becomes (normally 3 Co-Signer); both rows change in the same transaction, matching how the customer entry screen swaps them in one save.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed. The route reuses the single Add Account Customer permission and counts as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","AddAccountCustomer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"c09b5d4e-1fe2-4a57-97f9-ea2dd805d7d5"},{"name":"AccountCustomerUpdateBulk","id":"314215c8-26c7-43db-8785-037cc2d10698","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"accountCustomerId\": \"{{account_customer_id}}\",\n    \"customerType\": 1,\n    \"demoteExistingTo\": 3\n  },\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"accountCustomerId\": \"{{account_customer_id_2}}\",\n    \"customerStatus\": 40\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountCustomer?token={{token}}","description":"<p>Updates one <code>Common.AccountCustomer</code> row per item, for up to 250 items. Each item is the single Update Account Customer body plus <code>accountCustomerId</code> (the row, replacing the path segment) and <code>accountNumberOrId</code> (the account the row is keyed and reported under). Merge semantics: a property left out is not changed.</p>\n<p>Items naming the same account are <strong>not</strong> collapsed, which is what lets both halves of a Primary Customer swap travel in one request. Promoting a borrower to Primary Customer (1) or Spouse (2) while another holds that role requires <code>demoteExistingTo</code>; without it the promotion is rejected so a borrower is never reclassified implicitly.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code>. The route reuses the single Update Account Customer permission and counts as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","UpdateAccountCustomer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"314215c8-26c7-43db-8785-037cc2d10698"},{"name":"AccountCustomerDeleteBulk","id":"d1686426-2036-4b3e-ab35-f8fb7c0fec23","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"accountCustomerId\": \"{{account_customer_id}}\" },\n  { \"accountNumberOrId\": \"{{account_number_2}}\", \"accountCustomerId\": \"{{account_customer_id_2}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountCustomer?token={{token}}","description":"<p>Removes a borrower from an account that has <strong>not</strong> been activated yet, once per item, for up to 250 items - what \"Clear Customer\" does during account entry, where the row is deleted outright because no history is tracked before activation. On an activated account the item fails and the batch continues; there the screen keeps the row and moves it to Deleted status, so use the bulk update with <code>customerStatus</code> 40 instead.</p>\n<p>Each item supplies <code>accountCustomerId</code> (the row) and <code>accountNumberOrId</code> (the account the row is keyed and reported under). Items naming the same account are not collapsed. Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code>. The route reuses the single Delete Account Customer permission and counts as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","DeleteAccountCustomer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"d1686426-2036-4b3e-ab35-f8fb7c0fec23"},{"name":"AccountErrorLogByAccountDelete","id":"07f4a5f8-e252-49f3-a760-f3fe039a6a4f","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountErrorLog/ByAccount/{{account_number_or_id}}","description":"<h3 id=\"delete-account-error-log-by-account\">Delete Account Error Log By Account</h3>\n<p>Deletes every <code>Common.AccountErrorLog</code> row tied to the specified account. Wraps <code>AccountErrorLogServices.DeleteAccountErrorLogByAccount</code>, which resolves the account via <code>AccountServices.ReturnAccountByNumberOrId</code> and then removes all error log entries for that account. Returns the account's Guid along with a <code>Deleted</code> flag so the caller can confirm which account was cleared.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountErrorLog/ByAccount/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-shape\">Response Shape</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>AccountId</em></td>\n<td>Guid of the account whose error log rows were removed.</td>\n</tr>\n<tr>\n<td><em>Deleted</em></td>\n<td>Always <code>true</code> when the delete succeeds.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountErrorLog","ByAccount","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"105f8965-70cc-4f79-8efc-7ea9fc7c0165","name":"DeleteAccountErrorLogByAccount - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountErrorLog/ByAccount/30001212"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"AccountId\": \"00000000-0000-0000-0000-000000000001\",\n        \"Deleted\": true\n    }\n}"},{"id":"c85f6b79-2902-479d-858c-156d3da9a2ff","name":"DeleteAccountErrorLogByAccount - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountErrorLog/ByAccount/00000000"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"07f4a5f8-e252-49f3-a760-f3fe039a6a4f"},{"name":"AccountErrorLogByAccountDeleteBulk","id":"b13af135-2063-442c-a122-bd738fc85a6c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountErrorLogByAccount?token={{token}}","description":"<h3 id=\"delete-account-error-log-by-account-bulk\">Delete Account Error Log By Account (bulk)</h3>\n<p>Deletes all account error-log rows for one to 250 accounts. Each array item requires an account number or account ID. Accounts commit independently, Day End is checked before each account, and repeating a completed delete is safe. The route reuses the single Delete Account Error Log By Account permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","DeleteAccountErrorLogByAccount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"29f8ad85-4277-46df-9d6a-ae1ea197b3c2","name":"AccountErrorLogByAccountDeleteBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountErrorLogByAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountErrorLogByAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"33800559-0e8e-4c82-ba25-d422941caa80","name":"AccountErrorLogByAccountDeleteBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountErrorLogByAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountErrorLogByAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"2f8cb322-0bfc-484f-aa39-042739b849cb","name":"AccountErrorLogByAccountDeleteBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountErrorLogByAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountErrorLogByAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"b13af135-2063-442c-a122-bd738fc85a6c"},{"name":"AccountGet","id":"d6cd2255-0d20-410e-98ac-678f431b486e","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"{{account_number}}\",\n    \"show_transactions\": false,\n    \"exclude_inactive_transactions\": false,\n    \"starting_effective_date\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccount","description":"<p>This method is used to get the full account detail.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required int64. Omega account number</td>\n</tr>\n<tr>\n<td><em>show_transactions</em></td>\n<td>Optional bool. Defaults to false. When true, appends a <code>GetAccountTransactions</code> section to the account summary payload</td>\n</tr>\n<tr>\n<td><em>exclude_inactive_transactions</em></td>\n<td>Optional bool. Defaults to false. Ignored unless <em>show_transactions</em> is true</td>\n</tr>\n<tr>\n<td><em>starting_effective_date</em></td>\n<td>Optional date (<code>yyyy-MM-dd</code>). Defaults to null. Ignored unless <em>show_transactions</em> is true</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0d3993af-cca8-42dc-9e5c-a7bee96dd5ad","name":"GetAccount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"10002007\",\n  \"show_transactions\": true,\n  \"exclude_inactive_transactions\": true,\n  \"starting_effective_date\": \"2018-06-01\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Date","value":"Tue, 05 May 2026 23:57:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Accounts\": {\n            \"AccountSummary\": {\n                \"AccountNumber\": \"10002007\",\n                \"ClassNumber\": \"11\",\n                \"GetAccountSummary\": {\n                    \"OpenDate\": \"06/04/2015\",\n                    \"LoanAmount\": \"2000.00\",\n                    \"Term\": \"36\",\n                    \"Frequency\": \"Monthly\",\n                    \"Rate\": \"0.0000%\",\n                    \"MilitaryAPR\": \"0.0000%\",\n                    \"StateAllInAPR\": \"0.0000%\",\n                    \"PaymentAmount\": \"169.23\",\n                    \"State\": \"IL\",\n                    \"LastPaidDate\": \"08/02/2018\",\n                    \"NextDueDate\": \"06/04/2016\",\n                    \"NextAmountDue\": \"5625.45\",\n                    \"CurrentBalance\": \"1948.86\",\n                    \"UnpaidLateFees\": \"0.00\",\n                    \"UnpaidOtherFees\": \"0.00\",\n                    \"PaymentOverShortAmount\": \"76.93\",\n                    \"TotalBalance\": \"1948.86\",\n                    \"PastDueAmount\": \"5625.45\",\n                    \"PayoffAmount\": \"5625.45\",\n                    \"AdminStatus\": \"A\",\n                    \"InternalStatus\": \"Active\",\n                    \"AllowPayment\": \"true\",\n                    \"AllowPaymentMessage\": null,\n                    \"IBUnpaidInterest\": \"3676.59\",\n                    \"IBYTDInterestPaid\": \"0.00\",\n                    \"IBTotalInterestPaid\": \"1887.32\",\n                    \"LastPaymentAmount\": \"30.00\",\n                    \"LastPaymentPrincipalPaid\": \"0.00\",\n                    \"LastPaymentInterestPaid\": \"20.00\",\n                    \"LastPaymentOtherBalancePaid\": \"10.00\",\n                    \"LastPaymentEnterDate\": \"08/02/2018\",\n                    \"LastPaymentPreviousBalance\": \"1948.86\",\n                    \"CollateralDescription\": \"Unknown\",\n                    \"CollateralVehicleYear\": null,\n                    \"CollateralVehicleMake\": null,\n                    \"CollateralVehicleModel\": null,\n                    \"CollateralVIN\": null,\n                    \"AccountType\": \"Interest_Bearing_Direct\",\n                    \"NextPaymentDueDate\": \"10/04/2025\"\n                },\n                \"GetBranchSummary\": {\n                    \"Name\": \"Co. 10 East Magdalenastad\",\n                    \"Number\": \"90\",\n                    \"BranchPhoneNumber\": null\n                },\n                \"GetBorrowerSummary\": {\n                    \"CustomerNumber\": \"377\",\n                    \"CustomerType\": \"Primary_Customer\",\n                    \"FirstName\": \"Teagan\",\n                    \"LastName\": \"Connelly\",\n                    \"SocialSecurityNumberLast4\": \"7313\",\n                    \"Birthday\": \"08/01/1968\",\n                    \"Email\": null,\n                    \"DriversLicenseNumber\": \"E217345\",\n                    \"PrimaryPhoneNumber\": \"(391) 739-2950\",\n                    \"AddressLine1\": \"336 Shayne Grove\",\n                    \"AddressLine2\": \"7501 O'Kon Trail\",\n                    \"AddressLine3\": null,\n                    \"AddressCity\": \"North Katelynberg\",\n                    \"AddressState\": \"IL\",\n                    \"AddressZipCode\": \"62321-2532\",\n                    \"MilitaryActiveDuty\": \"False\",\n                    \"LanguageCode\": \"English\"\n                },\n                \"GetAccountTransactions\": {\n                    \"GetAccountTransaction\": [\n                        {\n                            \"TransactionNumber\": \"73\",\n                            \"EffectiveDate\": \"06/01/2018\",\n                            \"CreationBranchDate\": \"06/01/2018\",\n                            \"TransactionCreationDateTime\": \"06/01/2018 02:45:57 PM\",\n                            \"Type\": \"Payment\",\n                            \"TransactionCode\": \"PYC\",\n                            \"CodeDescription\": \"Customer Payment\",\n                            \"Fund\": \"Check\",\n                            \"PaidWithCheckNumber\": \"2961\",\n                            \"TransactionAmount\": \"-30.00\",\n                            \"CurrentBalance\": \"1948.86\",\n                            \"NextDueDate\": \"06/04/2016\",\n                            \"DaysPastDue\": \"727\",\n                            \"UserLogin\": \"Ivah.Reilly51\",\n                            \"Comment\": \"\",\n                            \"ReferenceNumber\": \"7306\",\n                            \"Active\": \"True\",\n                            \"PaymentDetails\": {\n                                \"PaymentType\": \"Payment Regular\",\n                                \"PrincipalAmount\": \"0.00\",\n                                \"InterestAmount\": \"20.00\",\n                                \"IVAAmount\": null,\n                                \"LateFeesAmount\": \"10.00\",\n                                \"OtherFeesAmount\": null,\n                                \"SubAcctsAmount\": null,\n                                \"ThirdPartyFeeAmount\": null\n                            }\n                        },\n                        {\n                            \"TransactionNumber\": \"74\",\n                            \"EffectiveDate\": \"06/05/2018\",\n                            \"CreationBranchDate\": \"06/05/2018\",\n                            \"TransactionCreationDateTime\": \"06/04/2018 05:18:50 PM\",\n                            \"Type\": \"Class Change\",\n                            \"TransactionCode\": null,\n                            \"CodeDescription\": \"Class Change\",\n                            \"Fund\": null,\n                            \"PaidWithCheckNumber\": null,\n                            \"TransactionAmount\": null,\n                            \"CurrentBalance\": null,\n                            \"NextDueDate\": \"06/04/2016\",\n                            \"DaysPastDue\": null,\n                            \"UserLogin\": \"System_User\",\n                            \"Comment\": \"Previous Class: 10            \",\n                            \"ReferenceNumber\": \"7335\",\n                            \"Active\": \"True\",\n                            \"PaymentDetails\": {\n                                \"PaymentType\": null,\n                                \"PrincipalAmount\": \"0.00\",\n                                \"InterestAmount\": null,\n                                \"IVAAmount\": null,\n                                \"LateFeesAmount\": null,\n                                \"OtherFeesAmount\": null,\n                                \"SubAcctsAmount\": null,\n                                \"ThirdPartyFeeAmount\": null\n                            },\n                            \"NonFinancialDetails\": {\n                                \"Change\": null,\n                                \"Original\": \"Previous Class: 10\"\n                            }\n                        },\n                        {\n                            \"TransactionNumber\": \"75\",\n                            \"EffectiveDate\": \"06/05/2018\",\n                            \"CreationBranchDate\": \"06/05/2018\",\n                            \"TransactionCreationDateTime\": \"06/04/2018 05:18:50 PM\",\n                            \"Type\": \"Interest Rate Change\",\n                            \"TransactionCode\": null,\n                            \"CodeDescription\": \"Interest Rate Change\",\n                            \"Fund\": null,\n                            \"PaidWithCheckNumber\": null,\n                            \"TransactionAmount\": null,\n                            \"CurrentBalance\": null,\n                            \"NextDueDate\": \"06/04/2016\",\n                            \"DaysPastDue\": null,\n                            \"UserLogin\": \"System_User\",\n                            \"Comment\": \"Rate Changed from 95.0000 %   \",\n                            \"ReferenceNumber\": \"7335\",\n                            \"Active\": \"True\",\n                            \"PaymentDetails\": {\n                                \"PaymentType\": null,\n                                \"PrincipalAmount\": \"0.00\",\n                                \"InterestAmount\": null,\n                                \"IVAAmount\": null,\n                                \"LateFeesAmount\": null,\n                                \"OtherFeesAmount\": null,\n                                \"SubAcctsAmount\": null,\n                                \"ThirdPartyFeeAmount\": null\n                            },\n                            \"NonFinancialDetails\": {\n                                \"Change\": \"New Rate 0.0000%\",\n                                \"Original\": \"Old Rate 95.0000%\"\n                            }\n                        },\n                        {\n                            \"TransactionNumber\": \"76\",\n                            \"EffectiveDate\": \"06/14/2018\",\n                            \"CreationBranchDate\": \"06/14/2018\",\n                            \"TransactionCreationDateTime\": \"06/14/2018 05:17:58 PM\",\n                            \"Type\": \"Late Fee\",\n                            \"TransactionCode\": \"LTC\",\n                            \"CodeDescription\": \"Late Charge\",\n                            \"Fund\": null,\n                            \"PaidWithCheckNumber\": null,\n                            \"TransactionAmount\": \"10.00\",\n                            \"CurrentBalance\": \"1948.86\",\n                            \"NextDueDate\": \"06/04/2016\",\n                            \"DaysPastDue\": null,\n                            \"UserLogin\": \"System_User\",\n                            \"Comment\": \"Pmt Due 6/4/2018              \",\n                            \"ReferenceNumber\": \"7426\",\n                            \"Active\": \"True\",\n                            \"PaymentDetails\": {\n                                \"PaymentType\": null,\n                                \"PrincipalAmount\": \"-20.00\",\n                                \"InterestAmount\": null,\n                                \"IVAAmount\": null,\n                                \"LateFeesAmount\": \"10.00\",\n                                \"OtherFeesAmount\": null,\n                                \"SubAcctsAmount\": null,\n                                \"ThirdPartyFeeAmount\": null\n                            },\n                            \"OtherBalanceDetails\": {\n                                \"DueDate\": \"06/14/2018\",\n                                \"AmountPaidToDate\": \"10.00\",\n                                \"Balance\": \"0.00\",\n                                \"LastPaidDate\": \"08/02/2018\",\n                                \"PaidInFull\": \"True\"\n                            }\n                        },\n                        {\n                            \"TransactionNumber\": \"77\",\n                            \"EffectiveDate\": \"08/02/2018\",\n                            \"CreationBranchDate\": \"08/02/2018\",\n                            \"TransactionCreationDateTime\": \"08/02/2018 09:13:24 AM\",\n                            \"Type\": \"Payment\",\n                            \"TransactionCode\": \"PYC\",\n                            \"CodeDescription\": \"Customer Payment\",\n                            \"Fund\": \"Check\",\n                            \"PaidWithCheckNumber\": \"3041\",\n                            \"TransactionAmount\": \"-30.00\",\n                            \"CurrentBalance\": \"1948.86\",\n                            \"NextDueDate\": \"06/04/2016\",\n                            \"DaysPastDue\": \"789\",\n                            \"UserLogin\": \"Adele10\",\n                            \"Comment\": \"\",\n                            \"ReferenceNumber\": \"7926\",\n                            \"Active\": \"True\",\n                            \"PaymentDetails\": {\n                                \"PaymentType\": \"Payment Regular\",\n                                \"PrincipalAmount\": \"0.00\",\n                                \"InterestAmount\": \"20.00\",\n                                \"IVAAmount\": null,\n                                \"LateFeesAmount\": \"10.00\",\n                                \"OtherFeesAmount\": null,\n                                \"SubAcctsAmount\": null,\n                                \"ThirdPartyFeeAmount\": null\n                            }\n                        }\n                    ]\n                }\n            }\n        }\n    },\n    \"errors\": []\n}"},{"id":"f0215cb1-7c67-44f8-a684-124fbfac522f","name":"GetAccount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|e03d19b0-8e6e-419f-88c2-e41cc69d47a5|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 13 Dec 2022 22:39:20 GMT"},{"key":"Content-Length","value":"111"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error fetching account: Invalid account number\"\n    ]\n}"}],"_postman_id":"d6cd2255-0d20-410e-98ac-678f431b486e"},{"name":"AccountGetBulk","id":"dc151750-210d-40d4-b4e3-d6efd826f5de","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"version\": 1,\n    \"show_transactions\": false\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"version\": 2,\n    \"show_transactions\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccount?token={{token}}","description":"<p>Returns the bounded account record for one to 250 accounts. The body is an array of per-account objects. <code>accountNumberOrId</code> is required on every item and accepts an account number or account <code>Id</code> (Guid); <code>version</code>, <code>exclude_inactive_transactions</code>, and <code>starting_effective_date</code> are optional per item. <code>show_transactions</code> must be false because transaction history is unbounded. Pass <code>token</code> in the query string or use API key headers. Attempted batches return HTTP 200 with results in <code>data.accounts</code>; request-level validation failures return HTTP 400. This route reuses the single-account Get Account API Access permission and is unavailable with SessionId auth.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c93a0b29-7202-4f7f-ae8e-78b1c8e0f1eb","name":"AccountGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"version\":1,\"show_transactions\":false}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\",\n      \"errors\": [], \"warnings\": [], \"data\": {}\n    }]\n  }\n}"},{"id":"ccd15f67-1975-4a09-9b5c-c2c8871de432","name":"AccountGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"version\": 1,\n    \"show_transactions\": false\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"version\": 1,\n    \"show_transactions\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"fdfa50d0-34d9-4435-a44a-18809300e8d3","name":"AccountGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"dc151750-210d-40d4-b4e3-d6efd826f5de"},{"name":"AccountCollateralsGet","id":"5e233643-6187-4ca1-b2e9-cf71c870983a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/account/Collateral/{{account_number_or_id}}?token={{token}}","description":"<h3 id=\"get-account-collateral\">Get Account Collateral</h3>\n<p>Returns all active collateral rows tied to an existing account.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Collateral/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when not authenticating with an <code>Authorization</code> header.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-notes\">Response Notes</h4>\n<p>Returns <code>collaterals</code> with collateral code, type, values, GPS fields, vehicle details, title details, report-to-bureau flag, and base64 row-version <code>ts</code> values for PUT concurrency checks.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Collateral","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ae9b321e-d0c4-43bf-a36a-0d814ecae3e3","name":"GetAccountCollaterals - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/Collateral/{{account_number}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Collateral","{{account_number}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": 100001,\n        \"collaterals\": []\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"5e233643-6187-4ca1-b2e9-cf71c870983a"},{"name":"AccountCollateralsGetBulk","id":"c2bd5699-fcb8-4d36-b7b8-67b624ca8616","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollaterals?token={{token}}","description":"<p>Returns collateral assigned to one to 250 accounts. Every array item requires <code>accountNumberOrId</code>, which accepts an account number or account ID. The route reuses the single Get Account Collaterals permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountCollaterals"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"67f1d88f-1550-4769-a30b-3eff1bde1999","name":"AccountCollateralsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollaterals?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCollaterals"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"id\":\"44444444-4444-4444-8444-444444444444\",\"description\":\"2019 Sedan\"}]}]}}"},{"id":"68515cc3-3334-4753-b95d-8fc4e95806dd","name":"AccountCollateralsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollaterals?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCollaterals"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"cb0637d2-a036-44d8-903d-b985e0df3bf3","name":"AccountCollateralsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollaterals?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCollaterals"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"c2bd5699-fcb8-4d36-b7b8-67b624ca8616"},{"name":"AccountCollateralGet","id":"4ba4e6b2-d0cd-4f94-94f6-01d927b6d8a9","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/account/Collateral/{{account_number_or_id}}/{{collateral_id}}?token={{token}}","description":"<h3 id=\"get-account-collateral-by-id\">Get Account Collateral By Id</h3>\n<p>Returns one active collateral row tied to an existing account.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Collateral/{accountNumberOrId}/{collateralId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>collateralId</em></td>\n<td>Required Guid. <code>Common.Collateral.Id</code> for the account collateral row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when not authenticating with an <code>Authorization</code> header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","Collateral","{{account_number_or_id}}","{{collateral_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"27f62b1c-0fce-4a71-8a90-c6064fd32b7e","name":"GetAccountCollateral - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/Collateral/{{account_number}}/{{collateral_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Collateral","{{account_number}}","{{collateral_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"ts\": \"AAAAAAAAB9E=\",\n        \"collateralCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"collateralCodeDescription\": \"AUTO\",\n        \"collateralType\": \"Auto\",\n        \"description\": \"2024 Ford F-150\",\n        \"value1\": 12000.00,\n        \"value2\": 15000.00,\n        \"reportToBureau\": false\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"4ba4e6b2-d0cd-4f94-94f6-01d927b6d8a9"},{"name":"AccountCollateralGetBulk","id":"af3a7ba4-367e-4571-84f8-a77a334086df","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"collateralId\": \"{{collateral_id}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"collateralId\": \"44444444-4444-4444-8444-444444444444\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollateral?token={{token}}","description":"<p>Returns one specified collateral record for each of up to 250 accounts. Every item supplies its own <code>accountNumberOrId</code> and <code>collateralId</code>. The route reuses the single Get Account Collateral permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountCollateral"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"8c3a841f-ccd8-416c-9b03-8e72c7a1ac03","name":"AccountCollateralGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"collateralId\":\"44444444-4444-4444-8444-444444444444\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"id\":\"44444444-4444-4444-8444-444444444444\",\"description\":\"2019 Sedan\"}}]}}"},{"id":"30c4056e-7f5b-484e-8440-68d20ab6f79a","name":"AccountCollateralGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralId\": \"{{collateral_id}}\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"collateralId\": \"44444444-4444-4444-8444-444444444444\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"d1b90f77-541c-4eb1-a333-ff1b1987f579","name":"AccountCollateralGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"af3a7ba4-367e-4571-84f8-a77a334086df"},{"name":"CollateralSummaryGetBulk","id":"3072292b-da86-44aa-ba64-1328e43703e3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralSummary?token={{token}}","description":"<p>Returns collateral summaries for one to 250 accounts, including permission-aware VIN masking. Each array item requires <code>accountNumberOrId</code>, accepting an account number or account <code>Id</code> (Guid). The lower cap bounds collection output. This route reuses the single-account Collateral Summary permission and returns one result row per account.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetCollateralSummary"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"723f39b0-b6e1-4a75-a52d-63fb7199e3d2","name":"CollateralSummaryGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetCollateralSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"1b7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"has_collateral\": false, \"collaterals\": [], \"value1_label\": \"Wholesale\", \"value2_label\": \"Retail\", \"value3_label\": null }\n    }]\n  }\n}"},{"id":"3e0f9822-9544-43b3-a110-ce417a7606cd","name":"CollateralSummaryGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetCollateralSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"9f3a2eb1-2227-4aa9-a3d7-619989ed88cd","name":"CollateralSummaryGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetCollateralSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"3072292b-da86-44aa-ba64-1328e43703e3"},{"name":"AccountCollateralAdd","id":"60be02d0-dbdc-4113-ad0c-79a3ec88b5db","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"collateralCodeOrId\": \"{{collateral_code_or_id}}\",\n  \"value1\": 12000,\n  \"value2\": 15000,\n  \"value3\": null,\n  \"isNew\": false,\n  \"trackTitleDetails\": true,\n  \"reportToBureau\": false,\n  \"description\": \"2024 Ford F-150\",\n  \"vehicle\": {\n    \"year\": 2024,\n    \"make\": \"Ford\",\n    \"model\": \"F-150\",\n    \"licenseNumber\": \"ABC123\",\n    \"vin\": \"1FTFW1E50RFA00001\",\n    \"color\": \"Blue\",\n    \"mileage\": 5000,\n    \"licensePlateProvinceAbbreviationOrId\": null\n  }\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Collateral/{{account_number_or_id}}","description":"<h3 id=\"add-account-collateral\">Add Account Collateral</h3>\n<p>Adds a collateral row to an existing account through the same collateral save path used by the account screens.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Collateral/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-fields\">Body Fields</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when not authenticating with an <code>Authorization</code> header.</td>\n</tr>\n<tr>\n<td><em>collateralCodeOrId</em></td>\n<td>Required string. Collateral code description or <code>Common.CollateralCode.Id</code>. Code must be active and belong to the logged-in client.</td>\n</tr>\n<tr>\n<td><em>value1</em>, <em>value2</em>, <em>value3</em></td>\n<td>Optional decimal values. Value 1 maps to wholesale value, value 2 maps to retail value.</td>\n</tr>\n<tr>\n<td><em>reportToBureau</em></td>\n<td>Optional boolean. When true, existing report-to-bureau collateral on the account is cleared.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required for Misc collateral. Optional for vehicle collateral.</td>\n</tr>\n<tr>\n<td><em>vehicle</em></td>\n<td>Required for Auto, Truck, and Vessel collateral. Must include <code>year</code>, <code>make</code>, and <code>model</code>.</td>\n</tr>\n<tr>\n<td><em>vehicle.truck</em></td>\n<td>Optional Truck-specific fields. Used only when the collateral code type is Truck.</td>\n</tr>\n<tr>\n<td><em>vehicle.vessel</em></td>\n<td>Optional Vessel-specific fields. Used only when the collateral code type is Vessel.</td>\n</tr>\n<tr>\n<td><em>title</em></td>\n<td>Optional title details. When supplied, <code>titleStatusCodeId</code> is required.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>vehicle.licensePlateProvinceAbbreviationOrId</code></td>\n<td><code>vehicle.licensePlateProvinceId</code></td>\n<td>String. province/state abbreviation or province/state GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>title.titleStatusCodeOrId</code></td>\n<td><code>title.titleStatusCodeId</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>title.statusSetByUserLoginOrId</code></td>\n<td><code>title.statusSetByUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"vehicle\": {\n    \"licensePlateProvinceAbbreviationOrId\": \"CA\"\n  },\n  \"title\": {\n    \"titleStatusCodeOrId\": \"1\",\n    \"statusSetByUserLoginOrId\": \"collector.login\"\n  }\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Collateral","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ed1f91af-fcdb-4674-8408-626b24362edb","name":"AddAccountCollateral - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"collateralCodeOrId\": \"{{collateral_code_or_id}}\",\n  \"description\": \"2024 Ford F-150\",\n  \"vehicle\": {\n    \"year\": 2024,\n    \"make\": \"Ford\",\n    \"model\": \"F-150\",\n    \"licensePlateProvinceAbbreviationOrId\": null\n  }\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Collateral/{{account_number}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"collateralCodeDescription\": \"AUTO\",\n        \"collateralType\": \"Auto\",\n        \"description\": \"2024 Ford F-150\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"60be02d0-dbdc-4113-ad0c-79a3ec88b5db"},{"name":"AccountCollateralAddBulk","id":"247080b1-b4bd-4d90-a1b1-201ee55d80e4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"collateralCodeOrId\": \"{{collateral_code}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 15000\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"collateralCodeOrId\": \"{{collateral_code}}\",\n    \"description\": \"2020 Truck\",\n    \"value1\": 22000\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountCollateral?token={{token}}","description":"<h3 id=\"add-account-collateral-bulk\">Add Account Collateral (bulk)</h3>\n<p>Adds one collateral record to each of one to 250 accounts through the same service as the single POST route. Every item supplies <code>accountNumberOrId</code> plus the collateral body the single route takes in its request body. Accounts commit independently and Day End is checked before each one. The route reuses the single Add Account Collateral permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>[].vehicle.licensePlateProvinceAbbreviationOrId</code></td>\n<td><code>[].vehicle.licensePlateProvinceId</code></td>\n<td>String. province/state abbreviation or province/state GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].title.titleStatusCodeOrId</code></td>\n<td><code>[].title.titleStatusCodeId</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].title.statusSetByUserLoginOrId</code></td>\n<td><code>[].title.statusSetByUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"\": [\n      {\n        \"vehicle\": {\n          \"licensePlateProvinceAbbreviationOrId\": \"CA\"\n        },\n        \"title\": {\n          \"titleStatusCodeOrId\": \"1\",\n          \"statusSetByUserLoginOrId\": \"collector.login\"\n        }\n      }\n    ]\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","AddAccountCollateral"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"07dc5ca9-4afa-478d-808b-2445238ac45f","name":"AccountCollateralAddBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralCodeOrId\": \"{{collateral_code}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 15000\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"id\":\"44444444-4444-4444-8444-444444444444\",\"description\":\"2019 Sedan\"}}]}}"},{"id":"f32f546a-5022-4ba8-b819-5328c1978d05","name":"AccountCollateralAddBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralCodeOrId\": \"{{collateral_code}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 15000\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"collateralCodeOrId\": \"{{collateral_code}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 15000\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"id\":\"44444444-4444-4444-8444-444444444444\",\"description\":\"2019 Sedan\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"5602501c-ce28-48f4-bc7a-b5c24e08362f","name":"AccountCollateralAddBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"c8997208-bd4f-42e9-b980-18ef17aa2d0c","name":"AccountCollateralAddBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"247080b1-b4bd-4d90-a1b1-201ee55d80e4"},{"name":"AccountCollateralUpdate","id":"a6303be1-92ca-4c98-89a1-4b77b2cf523d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"ts\": \"{{collateral_ts_base64}}\",\n  \"collateralCodeOrId\": \"{{new_collateral_code_or_id}}\",\n  \"description\": \"2024 Ford F-150\",\n  \"value1\": 12100,\n  \"value2\": 15100,\n  \"reportToBureau\": true,\n  \"vehicle\": {\n    \"mileage\": 5500,\n    \"color\": \"Blue\",\n    \"licensePlateProvinceAbbreviationOrId\": null\n  }\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Collateral/{{account_number_or_id}}/{{collateral_id}}","description":"<h3 id=\"update-account-collateral\">Update Account Collateral</h3>\n<p>Updates an existing account collateral row. This can change the collateral code when the new code has the same collateral type as the existing row. To change between Auto/Truck/Vessel/Misc types, delete and re-add the collateral.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Collateral/{accountNumberOrId}/{collateralId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>collateralId</em></td>\n<td>Required Guid. <code>Common.Collateral.Id</code> to update.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-fields\">Body Fields</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when not authenticating with an <code>Authorization</code> header.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional string. Base64 row-version returned by GET. If supplied and stale, the update is rejected.</td>\n</tr>\n<tr>\n<td><em>collateralCodeOrId</em></td>\n<td>Optional string. New active collateral code description or <code>Common.CollateralCode.Id</code>. Must be the same collateral type as the existing row.</td>\n</tr>\n<tr>\n<td><em>description</em>, <em>value1</em>, <em>value2</em>, <em>value3</em>, <em>isNew</em>, <em>trackTitleDetails</em>, <em>gpsTrackingSerial</em>, <em>gpsProvider</em>, <em>gpsProduct</em>, <em>traxProduct</em>, <em>originalValue1</em>, <em>originalValue2</em>, <em>originalValue3</em>, <em>reportToBureau</em></td>\n<td>Optional fields to update.</td>\n</tr>\n<tr>\n<td><em>vehicle</em></td>\n<td>Optional vehicle fields for Auto, Truck, and Vessel collateral.</td>\n</tr>\n<tr>\n<td><em>title</em></td>\n<td>Optional title fields. Set <code>title.display</code> to <code>false</code> to remove title details from the collateral.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>vehicle.licensePlateProvinceAbbreviationOrId</code></td>\n<td><code>vehicle.licensePlateProvinceId</code></td>\n<td>String. province/state abbreviation or province/state GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>title.titleStatusCodeOrId</code></td>\n<td><code>title.titleStatusCodeId</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>title.statusSetByUserLoginOrId</code></td>\n<td><code>title.statusSetByUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"vehicle\": {\n    \"licensePlateProvinceAbbreviationOrId\": \"CA\"\n  },\n  \"title\": {\n    \"titleStatusCodeOrId\": \"1\",\n    \"statusSetByUserLoginOrId\": \"collector.login\"\n  }\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Collateral","{{account_number_or_id}}","{{collateral_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"def12f93-0b0e-4961-8516-f2d109f662de","name":"UpdateAccountCollateral - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"ts\": \"{{collateral_ts_base64}}\",\n    \"collateralCodeOrId\": \"{{new_collateral_code_or_id}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Collateral/{{account_number}}/{{collateral_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"collateralCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"collateralCodeDescription\": \"AUTO2\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"a6303be1-92ca-4c98-89a1-4b77b2cf523d"},{"name":"AccountCollateralUpdateBulk","id":"d2fd11c7-811a-49e7-a0f0-a1ebd19107dc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"collateralId\": \"{{collateral_id}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 14500\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountCollateral?token={{token}}","description":"<h3 id=\"update-account-collateral-bulk\">Update Account Collateral (bulk)</h3>\n<p>Updates one collateral record on each of one to 250 accounts. Every item supplies <code>accountNumberOrId</code> and <code>collateralId</code> — the two path segments the single PUT route uses — plus the collateral changes. Send <code>ts</code> to keep the single route's optimistic-concurrency check. Accounts commit independently and Day End is checked before each one. The route reuses the single Update Account Collateral permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>[].vehicle.licensePlateProvinceAbbreviationOrId</code></td>\n<td><code>[].vehicle.licensePlateProvinceId</code></td>\n<td>String. province/state abbreviation or province/state GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].title.titleStatusCodeOrId</code></td>\n<td><code>[].title.titleStatusCodeId</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>[].title.statusSetByUserLoginOrId</code></td>\n<td><code>[].title.statusSetByUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"\": [\n      {\n        \"vehicle\": {\n          \"licensePlateProvinceAbbreviationOrId\": \"CA\"\n        },\n        \"title\": {\n          \"titleStatusCodeOrId\": \"1\",\n          \"statusSetByUserLoginOrId\": \"collector.login\"\n        }\n      }\n    ]\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","UpdateAccountCollateral"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"78f06940-7ce2-4bfd-b233-f334ebcd9bce","name":"AccountCollateralUpdateBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralId\": \"{{collateral_id}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 14500\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"id\":\"44444444-4444-4444-8444-444444444444\",\"description\":\"2019 Sedan\"}}]}}"},{"id":"21e8fcb1-6bae-4458-940a-2e5a3bfa7874","name":"AccountCollateralUpdateBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralId\": \"{{collateral_id}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 14500\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"collateralId\": \"{{collateral_id}}\",\n    \"description\": \"2019 Sedan\",\n    \"value1\": 14500\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"id\":\"44444444-4444-4444-8444-444444444444\",\"description\":\"2019 Sedan\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"a11348d7-dce0-4170-b444-3e5d3e98f3fb","name":"AccountCollateralUpdateBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"5f7e5eb7-310c-44bc-a5fd-0baea638896a","name":"AccountCollateralUpdateBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"d2fd11c7-811a-49e7-a0f0-a1ebd19107dc"},{"name":"AccountCollateralDelete","id":"b7731076-eb51-41bb-8f8a-9d2a1bac234d","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/account/Collateral/{{account_number_or_id}}/{{collateral_id}}?token={{token}}","description":"<h3 id=\"delete-account-collateral\">Delete Account Collateral</h3>\n<p>Deletes an existing collateral row from an account through the same collateral delete path used by the account screens.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Collateral/{accountNumberOrId}/{collateralId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>collateralId</em></td>\n<td>Required Guid. <code>Common.Collateral.Id</code> to delete.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when not authenticating with an <code>Authorization</code> header.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"delete-validation\">Delete Validation</h4>\n<p>Delete is rejected when the collateral is the current report-to-bureau collateral and other collateral still exists, when the account has an Active or Sold repossession, or when the collateral is linked to lender insurance. The response body includes the specific error message.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Collateral","{{account_number_or_id}}","{{collateral_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"2f81d76f-24f7-403d-a237-eca86e84b51d","name":"DeleteAccountCollateral - Blocked","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/Collateral/{{account_number}}/{{collateral_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Collateral","{{account_number}}","{{collateral_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Collateral cannot be deleted because an Active or Sold repossession record exists.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"b7731076-eb51-41bb-8f8a-9d2a1bac234d"},{"name":"AccountCollateralDeleteBulk","id":"822dc091-c272-4826-bd5e-4307171c97e2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"collateralId\": \"{{collateral_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountCollateral?token={{token}}","description":"<h3 id=\"delete-account-collateral-bulk\">Delete Account Collateral (bulk)</h3>\n<p>Deletes one collateral record from each of one to 250 accounts. Every item supplies <code>accountNumberOrId</code> and <code>collateralId</code>. The single route's guards still apply per account: a collateral that reports to the bureau cannot be removed while others remain visible, and an account with an active or sold repossession is refused. Accounts commit independently and Day End is checked before each one. The route reuses the single Delete Account Collateral permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","DeleteAccountCollateral"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"9c4c0d46-0e3d-4599-b501-0d85a722babf","name":"AccountCollateralDeleteBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralId\": \"{{collateral_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"6355b424-475a-4b21-ba7b-8d8901b90b58","name":"AccountCollateralDeleteBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralId\": \"{{collateral_id}}\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"collateralId\": \"{{collateral_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"6773cc70-12d8-4b04-abb3-d27735d2ae43","name":"AccountCollateralDeleteBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"a6f6c558-18a7-497c-b4d0-7e66e408f993","name":"AccountCollateralDeleteBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountCollateral?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountCollateral"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"822dc091-c272-4826-bd5e-4307171c97e2"},{"name":"AccountCreditReportingGet","id":"81cd9298-eeb8-4f02-8b59-f369b5a9f4bf","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/CreditReporting/{{account_number}}?token={{token}}","description":"<h3 id=\"get-account-credit-reporting\">Get Account Credit Reporting</h3>\n<p>Returns the account-level credit reporting fields shown on ViewAccount &gt; Credit Reporting &gt; General: FCRA Occurrence Date, Consumer Compliance Code, Original Creditor and Original Creditor Type. It also returns the account's portfolio, whose Original Creditor values are used on the credit report when the account's own values are blank.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/CreditReporting/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when not authenticating with an <code>Authorization</code> header.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fcraOccurrenceDate</em></td>\n<td>Date or null. FCRA Occurrence Date.</td>\n</tr>\n<tr>\n<td><em>consumerComplianceCode</em></td>\n<td>String or null. <code>XA</code> through <code>XJ</code>, or <code>XR</code>.</td>\n</tr>\n<tr>\n<td><em>originalCreditor</em></td>\n<td>String or null. Account-level Original Creditor (Metro 2 K1 segment).</td>\n</tr>\n<tr>\n<td><em>originalCreditorType</em></td>\n<td>String or null. Account-level Original Creditor Type, such as <code>Retail</code> or <code>Medical_Health_Care</code>.</td>\n</tr>\n<tr>\n<td><em>isCollectionAccountPortfolio</em></td>\n<td>Boolean. True when the portfolio type is Collection Account. Original Creditor values are only sent on the credit report for these accounts.</td>\n</tr>\n<tr>\n<td><em>portfolio</em></td>\n<td>Object or null. <code>portfolioNumber</code>, <code>description</code>, <code>portfolioType</code>, and the portfolio's own <code>originalCreditor</code> and <code>originalCreditorType</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><p>An unknown account returns <code>400</code> with <code>Account not found.</code> API Access roles that do not allow all endpoints must be granted this endpoint.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","CreditReporting","{{account_number}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a259d25a-054e-4310-923c-2ae3c6cb47c6","name":"AccountCreditReportingGet - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/CreditReporting/10001027?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","CreditReporting","10001027"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"accountId\": \"cf1c70e7-cb1f-4c2f-9543-a978b65c8e81\",\n    \"accountNumber\": 10001027,\n    \"fcraOccurrenceDate\": \"2025-07-15T00:00:00\",\n    \"consumerComplianceCode\": \"XB\",\n    \"originalCreditor\": \"ACME RETAIL\",\n    \"originalCreditorType\": \"Medical_Health_Care\",\n    \"isCollectionAccountPortfolio\": true,\n    \"portfolio\": {\n      \"portfolioNumber\": 2,\n      \"description\": \"NEW PORTFOLIO\",\n      \"portfolioType\": \"Collection_Account\",\n      \"originalCreditor\": \"PORTFOLIO OC TEST\",\n      \"originalCreditorType\": \"Retail\"\n    }\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"007c33c4-fea6-42e8-a534-d803940dfd7c","name":"AccountCreditReportingGet - Failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/CreditReporting/99999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","CreditReporting","99999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"Account not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"81cd9298-eeb8-4f02-8b59-f369b5a9f4bf"},{"name":"AccountCreditReportingUpdate","id":"fe351f68-18f0-42e8-be1c-316eb9613027","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"fcraOccurrenceDate\": \"2026-01-15\",\n    \"consumerComplianceCode\": \"XB\",\n    \"originalCreditor\": \"ACME RETAIL\",\n    \"originalCreditorType\": \"Retail\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/UpdateCreditReporting?token={{token}}","description":"<h3 id=\"update-account-credit-reporting\">Update Account Credit Reporting</h3>\n<p>Updates the account-level credit reporting fields on one to 250 existing accounts: FCRA Occurrence Date, Consumer Compliance Code, Original Creditor and Original Creditor Type. These are the fields on ViewAccount &gt; Credit Reporting &gt; General. Each account is validated and saved on its own and gets its own row in the response, so one bad account does not stop the others. Day End is checked before each account.</p>\n<p>Only the fields you send are changed. Leave a field out (or send <code>null</code>) to keep its current value. Send an empty string <code>\"\"</code> to clear it.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when not authenticating with an <code>Authorization</code> header. Query string.</td>\n</tr>\n<tr>\n<td><em>[].accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>[].fcraOccurrenceDate</em></td>\n<td>Optional string. FCRA Occurrence Date as <code>yyyy-MM-dd</code>. Cannot be after the current business date.</td>\n</tr>\n<tr>\n<td><em>[].consumerComplianceCode</em></td>\n<td>Optional string. <code>XA</code>, <code>XB</code>, <code>XC</code>, <code>XD</code>, <code>XE</code>, <code>XF</code>, <code>XG</code>, <code>XH</code>, <code>XJ</code> or <code>XR</code>. <code>NONE</code> or <code>\"\"</code> clears it. Not case-sensitive.</td>\n</tr>\n<tr>\n<td><em>[].originalCreditor</em></td>\n<td>Optional string. Account-level Original Creditor for the Metro 2 K1 segment, up to 30 characters.</td>\n</tr>\n<tr>\n<td><em>[].originalCreditorType</em></td>\n<td>Optional string. <code>Retail</code>, <code>Medical_Health_Care</code>, <code>Oil_Company</code>, <code>Government</code>, <code>Personal_Services</code>, <code>Insurance</code>, <code>Educational</code>, <code>Banking</code>, <code>Rental_Leasing</code>, <code>Utilities</code>, <code>Cable_Cellular</code>, <code>Financial</code>, <code>Credit_Union</code>, <code>Automotive</code> or <code>Check_Guarantee</code>. Not case-sensitive.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Each item must supply at least one of the four fields.</p>\n<p><strong>Removing a compliance code that was already reported.</strong> Clearing the code stops it from being sent on later files, but does not by itself tell the bureaus to remove it. To remove a code the bureaus already have, send <code>XR</code> (Removes the most recently reported Compliance Condition Code). This matches the Credit Reporting screen.</p>\n<p><strong>Original Creditor values are only reported for Collection Account portfolios.</strong> They are saved for any account, but the credit report only sends them (Metro 2 K1 segment) when the account's portfolio type is Collection Account. A blank account value falls back to the portfolio's value. When a request sets either field on an account whose portfolio is not a Collection Account, the values are saved and the account's row includes a warning.</p>\n<p>Each account whose values change gets one account log entry, \"Credit Reporting - General changed\", listing the old and new value of each changed field. Resending values that are already saved changes nothing and writes no log entry. The response row's <code>data</code> holds the saved values plus <code>changedFields</code>.</p>\n<p>More than 250 items, an empty list, or a blank account selector rejects the whole request with no changes. API Access roles that do not allow all endpoints must be granted this endpoint.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","UpdateCreditReporting"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"415abee6-8429-4599-adaf-508cffbf8c80","name":"AccountCreditReportingUpdate - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"10001027\",\n    \"fcraOccurrenceDate\": \"2025-07-15\",\n    \"consumerComplianceCode\": \"XB\",\n    \"originalCreditor\": \"ACME RETAIL\",\n    \"originalCreditorType\": \"Medical_Health_Care\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/UpdateCreditReporting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","UpdateCreditReporting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"requestId\": \"5a406581-1370-4b46-b0fc-533cc45edc40\",\n    \"requested\": 1,\n    \"total\": 1,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 10001027,\n        \"accountNumberOrId\": \"10001027\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"changedFields\": [\n            \"fcraOccurrenceDate\",\n            \"consumerComplianceCode\",\n            \"originalCreditor\",\n            \"originalCreditorType\"\n          ],\n          \"accountId\": \"cf1c70e7-cb1f-4c2f-9543-a978b65c8e81\",\n          \"accountNumber\": 10001027,\n          \"fcraOccurrenceDate\": \"2025-07-15T00:00:00\",\n          \"consumerComplianceCode\": \"XB\",\n          \"originalCreditor\": \"ACME RETAIL\",\n          \"originalCreditorType\": \"Medical_Health_Care\",\n          \"isCollectionAccountPortfolio\": true,\n          \"portfolio\": {\n            \"portfolioNumber\": 2,\n            \"description\": \"NEW PORTFOLIO\",\n            \"portfolioType\": \"Collection_Account\",\n            \"originalCreditor\": \"PORTFOLIO OC TEST\",\n            \"originalCreditorType\": \"Retail\"\n          }\n        }\n      }\n    ]\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"f4e3e35f-0a7a-4bed-883a-13149b91a550","name":"AccountCreditReportingUpdate - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"10001043\", \"originalCreditorType\": \"Retail\" },\n  { \"accountNumberOrId\": \"10001061\", \"consumerComplianceCode\": \"XZ\" },\n  { \"accountNumberOrId\": \"99999999\", \"consumerComplianceCode\": \"XA\" }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/UpdateCreditReporting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","UpdateCreditReporting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 100,\n  \"result\": \"Successful With Error\",\n  \"data\": {\n    \"requestId\": \"6d688945-cc56-490b-8b91-c864f65bea73\",\n    \"requested\": 3,\n    \"total\": 3,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 2,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 10001043,\n        \"accountNumberOrId\": \"10001043\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [\n          \"This account's portfolio code is not a Collection Account, so Original Creditor and Original Creditor Type were saved but will not be included in credit reporting until the account is moved to a Collection Account portfolio.\"\n        ],\n        \"data\": {\n          \"changedFields\": [\n            \"originalCreditorType\"\n          ],\n          \"accountId\": \"cc60d701-25f0-4e4f-9ae1-01990613977b\",\n          \"accountNumber\": 10001043,\n          \"fcraOccurrenceDate\": \"2012-10-24T00:00:00\",\n          \"consumerComplianceCode\": \"XA\",\n          \"originalCreditor\": \"XYZ BANK\",\n          \"originalCreditorType\": \"Retail\",\n          \"isCollectionAccountPortfolio\": false,\n          \"portfolio\": null\n        }\n      },\n      {\n        \"accountNumber\": 10001061,\n        \"accountNumberOrId\": \"10001061\",\n        \"status\": \"Failed\",\n        \"message\": \"consumerComplianceCode 'XZ' is not valid. Use one of XA, XB, XC, XD, XE, XF, XG, XH, XJ, XR, or NONE to clear it.\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"consumerComplianceCode 'XZ' is not valid. Use one of XA, XB, XC, XD, XE, XF, XG, XH, XJ, XR, or NONE to clear it.\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"ee46830a-71d0-40b6-921d-755cd538174a","name":"AccountCreditReportingUpdate - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/UpdateCreditReporting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","UpdateCreditReporting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": []\n}"},{"id":"0eb69487-9228-424f-bc9d-06b03b02a0e4","name":"AccountCreditReportingUpdate - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/UpdateCreditReporting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","UpdateCreditReporting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"fe351f68-18f0-42e8-be1c-316eb9613027"},{"name":"AccountLinkedDocumentByIdGet","id":"3741869e-c631-4ff5-8b3c-9debeceeec9a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ById/{{account_linked_document_id}}","description":"<h3 id=\"get-account-linked-document-by-id\">Get Account Linked Document By Id</h3>\n<p>Returns a single <code>Common.AccountLinkedDocument</code> row by its Guid primary key. Wraps <code>AccountLinkedDocumentWSServices.ReturnAccountLinkedDocumentByIdWS</code>, which calls <code>AccountLinkedDocumentServices.ReturnAccountLinkedDocument(id, databaseName)</code> to fetch the full document entity (as <code>MyCommonAccountLinkedDocumentEntity</code>). Returns <code>Document not found</code> when the Guid is valid but no matching row exists.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ById/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountLinkedDocument</code> row to fetch. Returns <code>BadRequest</code> with the standard invalid parameter message when blank or not a parseable Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLinkedDocument","ById","{{account_linked_document_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"de5e740c-8fa6-4389-bab3-e378e972ecce","name":"GetAccountLinkedDocumentById - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ById/00000000-0000-0000-0000-000000000010"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000010\",\n        \"ParentId\": \"00000000-0000-0000-0000-000000000001\",\n        \"AttachmentLevel\": 0,\n        \"Description\": \"Signed Contract\",\n        \"Location\": \"s3://omega-docs/20260401-contract.pdf\",\n        \"FileSize\": 204800,\n        \"DocumentSource\": 1,\n        \"ViewOption\": 0,\n        \"CustomerId\": null,\n        \"CollateralId\": null,\n        \"MergeFormId\": null,\n        \"PageCount\": 3,\n        \"CreationBranchDate\": \"2026-04-01T10:15:00\"\n    }\n}"},{"id":"8a5860b5-e02a-416b-b272-d67dd0116199","name":"GetAccountLinkedDocumentById - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ById/00000000-0000-0000-0000-000000000999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Document not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"3741869e-c631-4ff5-8b3c-9debeceeec9a"},{"name":"AccountLinkedDocumentDelete","id":"51f2c4b7-955d-4d7f-96d1-98c82a42b325","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{{account_linked_document_id}}","description":"<h3 id=\"delete-account-linked-document\">Delete Account Linked Document</h3>\n<p>Deletes a single <code>Common.AccountLinkedDocument</code> row by its Guid primary key. Wraps <code>AccountLinkedDocumentWSServices.DeleteAccountLinkedDocumentWS</code>, which first fetches the document to capture its <code>Location</code>, then calls <code>AccountLinkedDocumentServices.DeleteAccountLinkedDocument</code> with a default <code>DocumentStorageParameters</code> instance targeting <code>DocumentStorageLocations.S3</code>. The transaction is committed with <code>CommitTransaction(uow, databaseName)</code>. Returns the deleted document Id plus a <code>Deleted</code> flag so the caller can confirm the operation.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountLinkedDocument</code> row to delete. Returns <code>BadRequest</code> with the standard invalid parameter message when blank or not a parseable Guid, and <code>Document not found</code> when no row matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-shape\">Response Shape</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid of the deleted <code>Common.AccountLinkedDocument</code> row.</td>\n</tr>\n<tr>\n<td><em>Deleted</em></td>\n<td>Always <code>true</code> when the delete succeeds.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLinkedDocument","{{account_linked_document_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c45e29c4-44e3-40f5-8e81-d8ff114ff4a8","name":"DeleteAccountLinkedDocument - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/00000000-0000-0000-0000-000000000010"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000010\",\n        \"Deleted\": true\n    }\n}"},{"id":"16810b67-c6fa-4ab0-bed8-ed9c6f1db3a8","name":"DeleteAccountLinkedDocument - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/00000000-0000-0000-0000-000000000999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Document not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"51f2c4b7-955d-4d7f-96d1-98c82a42b325"},{"name":"AccountLinkedDocumentDescriptionChange","id":"c8bbbdda-04ed-4827-9306-c851846c3ff2","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"description\": \"Updated contract description\",\n  \"viewOption\": 0,\n  \"customerId\": null,\n  \"customerNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{{account_linked_document_id}}/Description","description":"<h3 id=\"change-account-linked-document-description\">Change Account Linked Document Description</h3>\n<p>Updates the description and view options on an existing <code>Common.AccountLinkedDocument</code> row. Wraps <code>AccountLinkedDocumentWSServices.ChangeAccountLinkedDocumentDescriptionWS</code>, which fetches the document to capture its <code>Ts</code> (row timestamp), resolves the caller's client time via <code>Megasys.Framework.BLL.Date.ClientDateTimeNow</code>, then calls <code>AccountLinkedDocumentServices.ChangeDescriptionAccountLinkedDocument</code> with the supplied <code>description</code>, <code>viewOption</code> (cast to <code>Omega.DocSafe.Types.Enums.AccountDocumentViewOptions</code>), and optional <code>customerId</code>. The transaction is committed with <code>CommitTransaction(uow, databaseName)</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{id}/Description</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountLinkedDocument</code> row to update. Returns <code>BadRequest</code> with the standard invalid parameter message when blank or not a parseable Guid, and <code>Document not found</code> when no row matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New description to persist on the document.</td>\n</tr>\n<tr>\n<td><em>viewOption</em></td>\n<td>Required int. Maps to <code>Omega.DocSafe.Types.Enums.AccountDocumentViewOptions</code> (e.g. <code>0</code> = Account, <code>1</code> = Customer).</td>\n</tr>\n<tr>\n<td><em>customerId</em></td>\n<td>Optional Guid. When <code>viewOption</code> targets a customer-scoped view, set to the <code>Common.Customer.Id</code> the document should be linked to; otherwise leave null.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-shape\">Response Shape</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid of the updated <code>Common.AccountLinkedDocument</code> row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>customerNumberOrId</code></td>\n<td><code>customerId</code></td>\n<td>String. customer number (positive 32-bit integer) or customer GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. A supplied customer must belong to the document's account; customer documents must use their owning customer. Omitting the customer preserves vendor, voucher, agent and provisional-upload description edits under their existing ownership checks.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"customerNumberOrId\": \"12345\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLinkedDocument","{{account_linked_document_id}}","Description"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"07284cd0-85b4-45d9-b86e-8d66e659c313","name":"ChangeAccountLinkedDocumentDescription - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"example-token\",\n  \"description\": \"Updated contract description\",\n  \"viewOption\": 0,\n  \"customerId\": null,\n  \"customerNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/00000000-0000-0000-0000-000000000010/Description"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000010\"\n    }\n}"},{"id":"8a450e10-a65a-4847-86fc-916bc401d94e","name":"ChangeAccountLinkedDocumentDescription - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"example-token\",\n  \"description\": \"Updated contract description\",\n  \"viewOption\": 0,\n  \"customerId\": null,\n  \"customerNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/00000000-0000-0000-0000-000000000999/Description"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Document not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c8bbbdda-04ed-4827-9306-c851846c3ff2"},{"name":"AccountLinkedDocumentsByAccountDelete","id":"99fe590a-704e-4c7f-8a39-078077ba7d2c","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ByAccount/{{account_number_or_id}}","description":"<h3 id=\"delete-account-linked-documents-by-account\">Delete Account Linked Documents By Account</h3>\n<p>Deletes every <code>Common.AccountLinkedDocument</code> row tied to the specified account. Wraps <code>AccountLinkedDocumentWSServices.DeleteAccountLinkedDocumentsByAccountWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountLinkedDocumentServices.DeleteAccountLinkedDocumentsByAccountId(uow, databaseName, accountId, clientId)</code>. Returns the account Guid plus a <code>Deleted</code> flag confirming which account was cleared.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ByAccount/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. Returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-shape\">Response Shape</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>AccountId</em></td>\n<td>Guid of the account whose linked-document rows were removed.</td>\n</tr>\n<tr>\n<td><em>Deleted</em></td>\n<td>Always <code>true</code> when the delete succeeds.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLinkedDocument","ByAccount","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"54b86825-76b6-4717-b1cb-fa7f415dc87e","name":"DeleteAccountLinkedDocumentsByAccount - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ByAccount/30001212"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"AccountId\": \"00000000-0000-0000-0000-000000000001\",\n        \"Deleted\": true\n    }\n}"},{"id":"e020303e-ce9f-4a8b-942a-fd8f771f3628","name":"DeleteAccountLinkedDocumentsByAccount - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/ByAccount/99999999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"99fe590a-704e-4c7f-8a39-078077ba7d2c"},{"name":"AccountLinkedDocumentsByAccountDeleteBulk","id":"d613a4c7-23bd-44b7-8d98-0a1831ce1a84","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountLinkedDocumentsByAccount?token={{token}}","description":"<h3 id=\"delete-account-linked-documents-by-account-bulk\">Delete Account Linked Documents By Account (bulk)</h3>\n<p>Deletes every linked document for one to 250 accounts. Each array item requires an account number or account ID. Accounts commit independently and Day End is checked before each one. The route reuses the single Delete Account Linked Documents By Account permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","DeleteAccountLinkedDocumentsByAccount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"d1ce2b6c-c974-4537-8d9a-a2d8c1ecd1ed","name":"AccountLinkedDocumentsByAccountDeleteBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountLinkedDocumentsByAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountLinkedDocumentsByAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"deleted\":3}}]}}"},{"id":"dee82c40-a2e5-456d-acce-09fa3e50d03c","name":"AccountLinkedDocumentsByAccountDeleteBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountLinkedDocumentsByAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountLinkedDocumentsByAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"deleted\":3}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"723685cc-1638-4c28-b105-cbf78d1ebf3a","name":"AccountLinkedDocumentsByAccountDeleteBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountLinkedDocumentsByAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountLinkedDocumentsByAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"ad42ce5d-de86-484c-ada6-e265853864c3","name":"AccountLinkedDocumentsByAccountDeleteBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/DeleteAccountLinkedDocumentsByAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","DeleteAccountLinkedDocumentsByAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"d613a4c7-23bd-44b7-8d98-0a1831ce1a84"},{"name":"AccountLinkedDocumentsGet","id":"36fd56a8-378e-4756-adac-5acaf8a8fc8e","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{{account_number_or_id}}","description":"<h3 id=\"get-account-linked-documents\">Get Account Linked Documents</h3>\n<p>Returns every <code>Common.AccountLinkedDocument</code> row attached to the specified account at the <code>Account</code> attachment level. Wraps <code>AccountLinkedDocumentWSServices.ReturnAccountLinkedDocumentsWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountLinkedDocumentServices.ReturnAccountLinkedDocuments</code> with <code>AttachmentLevel.Account</code>. Data is returned as a <code>DataTable</code> serialized to JSON so each row exposes the full linked-document schema (Id, Description, Location, FileSize, DocumentSource, etc.).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLinkedDocument","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cd0ab59d-05ee-47ae-9784-f85896a0df23","name":"GetAccountLinkedDocuments - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/30001212"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000010\",\n            \"Description\": \"Signed Contract\",\n            \"Location\": \"s3://omega-docs/20260401-contract.pdf\",\n            \"FileSize\": 204800,\n            \"DocumentSource\": 1,\n            \"ViewOption\": 0,\n            \"CustomerId\": null,\n            \"CollateralId\": null,\n            \"MergeFormId\": null,\n            \"CreationBranchDate\": \"2026-04-01T10:15:00\"\n        }\n    ]\n}"},{"id":"e23a1dfb-c50f-45c5-9b4d-ca795ed9d337","name":"GetAccountLinkedDocuments - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/99999999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"36fd56a8-378e-4756-adac-5acaf8a8fc8e"},{"name":"AccountLinkedDocumentsGetBulk","id":"ad791e20-8891-42a9-9730-eae1ea3a538b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLinkedDocuments?token={{token}}","description":"<h3 id=\"get-account-linked-documents-bulk\">Get Account Linked Documents (bulk)</h3>\n<p>Returns linked-document metadata for one to 250 accounts. Every array item requires <code>accountNumberOrId</code>, which accepts an account number or account ID. The route reuses the single Get Account Linked Documents permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountLinkedDocuments"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c5ff08da-cf5c-4a22-bc14-179eaf585271","name":"AccountLinkedDocumentsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"id\":\"55555555-5555-4555-8555-555555555555\",\"description\":\"Signed contract\"}]}]}}"},{"id":"29c6a35e-0f82-4e41-bead-fc77d50e14c2","name":"AccountLinkedDocumentsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [{\"id\":\"55555555-5555-4555-8555-555555555555\",\"description\":\"Signed contract\"}]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"1459b93b-8aac-42e6-b3b8-19ce1128809b","name":"AccountLinkedDocumentsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"782f5ca3-c522-4599-9a8b-521b4d4d3140","name":"AccountLinkedDocumentsGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"ad791e20-8891-42a9-9730-eae1ea3a538b"},{"name":"AccountLogByIdGet","id":"e53929bc-a256-4b4d-ad35-e502c982c05a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/ById/{{account_log_id}}","description":"<h3 id=\"get-account-log-by-id\">Get Account Log By Id</h3>\n<p>Returns a single <code>Common.AccountLog</code> row by its Guid primary key. Wraps <code>AccountLogWSServices.ReturnAccountLogByIdWS</code>, which calls <code>AccountLogServices.ReturnAccountLogById(databaseName, logId)</code>. The underlying LLBLGen fetch resolves by primary key, so the response is either the full <code>MyCommonAccountLogEntity</code> or an error payload with <code>\"Account log entry not found\"</code> when the Id does not exist.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLog/ById/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required. The Guid primary key of the <code>Common.AccountLog</code> row. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank or not a valid Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLog","ById","{{account_log_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0711d2e3-ac76-41fd-9b4b-58a26e92a6b3","name":"GetAccountLogById - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/ById/00000000-0000-0000-0000-000000000501"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000501\",\n        \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n        \"EventType\": 1,\n        \"ChangeDescription\": \"Customer called to confirm payment arrangement\",\n        \"CreationServerDate\": \"2026-04-18T10:15:00\",\n        \"CreationBranchDate\": \"2026-04-18T10:15:00\",\n        \"CreationUserId\": \"00000000-0000-0000-0000-0000000000FA\"\n    }\n}"},{"id":"d4181327-f525-4698-9e85-7f81cf2faa6e","name":"GetAccountLogById - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/ById/00000000-0000-0000-0000-000000000999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account log entry not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e53929bc-a256-4b4d-ad35-e502c982c05a"},{"name":"AccountLogNotesGet","id":"9b8db5f6-15d3-4b1c-9ebb-2d793a375e76","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLogNote/{{account_log_id}}","description":"<h3 id=\"get-account-log-notes\">Get Account Log Notes</h3>\n<p>Returns every <code>Common.AccountLogNote</code> row tied to a single <code>Common.AccountLog</code> entry. Wraps <code>AccountLogNoteWSServices.ReturnAccountLogNotesWS</code>, which calls <code>AccountLogNoteServices.ReturnAccountLogNotes(accountLogId, databaseName)</code>. Data is serialized as an LLBLGen entity collection, exposing promise details (PromiseStatus, PromisedPaymentAmount, PromisedPaymentDate, etc.) associated with the parent log event.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLogNote/{accountLogId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountLogId</em></td>\n<td>Required. The Guid primary key of the parent <code>Common.AccountLog</code> row. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank or not a valid Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLogNote","{{account_log_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b6ad7087-c638-4178-b5b1-9d2a32fd30fa","name":"GetAccountLogNotes - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLogNote/00000000-0000-0000-0000-000000000501"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000601\",\n            \"AccountLogId\": \"00000000-0000-0000-0000-000000000501\",\n            \"PromiseStatus\": 1,\n            \"PromisedPaymentAmount\": 250.00,\n            \"PromisedPaymentDate\": \"2026-04-25T00:00:00\",\n            \"PromisedPaymentMethod\": 1,\n            \"Comment\": \"Customer committed to mailing check\"\n        }\n    ]\n}"},{"id":"df73eac6-bb48-4c0f-8704-c87c3646b046","name":"GetAccountLogNotes - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLogNote/not-a-guid"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"\"Invalid parameter data\""}],"_postman_id":"9b8db5f6-15d3-4b1c-9ebb-2d793a375e76"},{"name":"AccountLogsByPromiseStatusGet","id":"e82801ed-4e84-429a-81c9-84287e86f60a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/{{account_number_or_id}}/ByPromiseStatus/{{promise_status}}","description":"<h3 id=\"get-account-logs-by-promise-status\">Get Account Logs By Promise Status</h3>\n<p>Returns every <code>Common.AccountLog</code> row of event type <code>Note</code> attached to the specified account whose related <code>Common.AccountLogNote.PromiseStatus</code> matches the supplied value. Wraps <code>AccountLogWSServices.ReturnAccountLogsByPromiseStatusWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountLogServices.ReturnAccountLogsByPromiseStatus(accountId, databaseName, (PromiseStatuses)promiseStatus)</code>. Results are sorted by <code>CreationServerDate</code> descending and serialized as a <code>MyCommonAccountLogEntity</code> collection.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLog/{accountNumberOrId}/ByPromiseStatus/{promiseStatus}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n<tr>\n<td><em>promiseStatus</em></td>\n<td>Required. Integer value from the <code>Omega.Servicing.Types.Enums.PromiseStatuses</code> enum. Valid values: <code>1</code> (Active), <code>2</code> (Promise_Kept), <code>3</code> (Promise_Broken), <code>4</code> (Promise_Canceled).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLog","{{account_number_or_id}}","ByPromiseStatus","{{promise_status}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f89089e5-f504-4d70-b687-e899abd57144","name":"GetAccountLogsByPromiseStatus - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/30001212/ByPromiseStatus/1"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000501\",\n            \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n            \"EventType\": 1,\n            \"ChangeDescription\": \"Customer promised $250 on 2026-04-25\",\n            \"CreationServerDate\": \"2026-04-18T10:15:00\",\n            \"CreationBranchDate\": \"2026-04-18T10:15:00\",\n            \"CreationUserId\": \"00000000-0000-0000-0000-0000000000FA\"\n        }\n    ]\n}"},{"id":"229b8773-c083-4e43-93d1-db3d5dc7e1fe","name":"GetAccountLogsByPromiseStatus - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/99999999/ByPromiseStatus/1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e82801ed-4e84-429a-81c9-84287e86f60a"},{"name":"AccountLogsByPromiseStatusGetBulk","id":"8d7fce5d-094e-4f83-b971-cb2719e70f42","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"promiseStatus\": 1\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogsByPromiseStatus?token={{token}}","description":"<h3 id=\"get-account-logs-by-promise-status-bulk\">Get Account Logs By Promise Status (bulk)</h3>\n<p>Returns account logs filtered by promise status for one to 250 accounts. Every item supplies its own <code>accountNumberOrId</code> and <code>promiseStatus</code>, so different accounts may be filtered differently in one call. The route reuses the single Get Account Logs By Promise Status permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountLogsByPromiseStatus"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"2779d87b-3907-4b23-bead-bc9c28cd166b","name":"AccountLogsByPromiseStatusGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"promiseStatus\": 1\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogsByPromiseStatus?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogsByPromiseStatus"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"id\":\"66666666-6666-4666-8666-666666666666\",\"promiseStatus\":1}]}]}}"},{"id":"22d3a914-ce76-4b2f-bbfb-e2b1ebb17bc1","name":"AccountLogsByPromiseStatusGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"promiseStatus\": 1\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"promiseStatus\": 1\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogsByPromiseStatus?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogsByPromiseStatus"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [{\"id\":\"66666666-6666-4666-8666-666666666666\",\"promiseStatus\":1}]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"098a0672-2349-4f87-8000-56c69d59cc11","name":"AccountLogsByPromiseStatusGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogsByPromiseStatus?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogsByPromiseStatus"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"7de0d2cd-c50f-42ab-8db4-2dd00ce1559b","name":"AccountLogsByPromiseStatusGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogsByPromiseStatus?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogsByPromiseStatus"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"8d7fce5d-094e-4f83-b971-cb2719e70f42"},{"name":"AccountLogsGet","id":"18b6b782-b6b9-4891-bf1d-fb4634987a09","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/{{account_number_or_id}}","description":"<h3 id=\"get-account-logs\">Get Account Logs</h3>\n<p>Returns every <code>Common.AccountLog</code> row of event type <code>Note</code> attached to the specified account, ordered by <code>CreationServerDate</code> descending. Wraps <code>AccountLogWSServices.ReturnAccountLogsWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountLogServices.ReturnAccountLogs(accountId, databaseName)</code>. Data is returned as an LLBLGen <code>EntityCollection&lt;MyCommonAccountLogEntity&gt;</code> serialized to JSON, so each row exposes the full account-log schema (Id, AccountId, EventType, ChangeDescription, CreationServerDate, CreationBranchDate, etc.).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLog/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLog","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"59ac036e-0edc-4e12-ac60-6da5e8dd6bba","name":"GetAccountLogs - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/30001212"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000501\",\n            \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n            \"EventType\": 1,\n            \"ChangeDescription\": \"Customer called to confirm payment arrangement\",\n            \"CreationServerDate\": \"2026-04-18T10:15:00\",\n            \"CreationBranchDate\": \"2026-04-18T10:15:00\",\n            \"CreationUserId\": \"00000000-0000-0000-0000-0000000000FA\"\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000500\",\n            \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n            \"EventType\": 1,\n            \"ChangeDescription\": \"Left voicemail requesting callback\",\n            \"CreationServerDate\": \"2026-04-15T09:42:00\",\n            \"CreationBranchDate\": \"2026-04-15T09:42:00\",\n            \"CreationUserId\": \"00000000-0000-0000-0000-0000000000FA\"\n        }\n    ]\n}"},{"id":"aa3caa72-46af-4f8d-8b02-1e6811329b42","name":"GetAccountLogs - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/99999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"18b6b782-b6b9-4891-bf1d-fb4634987a09"},{"name":"AccountLogsGetBulk","id":"2231fbd9-6412-464c-8fc1-f2be6cf99cf5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogs?token={{token}}","description":"<h3 id=\"get-account-logs-bulk\">Get Account Logs (bulk)</h3>\n<p>Returns account logs for one to 250 accounts. Every array item requires <code>accountNumberOrId</code>, which accepts an account number or account ID. The route reuses the single Get Account Logs permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountLogs"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"d66c8398-bcb4-4f4f-a97b-b97eab9a7b63","name":"AccountLogsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogs?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogs"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"id\":\"66666666-6666-4666-8666-666666666666\",\"logDate\":\"2026-08-01\"}]}]}}"},{"id":"d799aada-d85d-49ad-ac83-7af8142e2b0d","name":"AccountLogsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogs?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogs"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [{\"id\":\"66666666-6666-4666-8666-666666666666\",\"logDate\":\"2026-08-01\"}]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"cfc0d1ab-d054-4824-b3b8-1fe140700c1e","name":"AccountLogsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogs?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogs"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"db6beb6b-f9dd-4fd5-a436-488351db2e93","name":"AccountLogsGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountLogs?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountLogs"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"2231fbd9-6412-464c-8fc1-f2be6cf99cf5"},{"name":"AccountNumberSaveNew","id":"adca82c2-ca85-447d-9d5b-91c21e25604d","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_to_renumber}}\",\n    \"newAccountNumber\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountNumber","description":"<h3 id=\"save-new-account-number\">Save New Account Number</h3>\n<p>Assigns a new Omega account number to an existing account. Wraps <code>AccountWSServices.SaveNewAccountNumberWS</code>, which loads the account via <code>AccountServices.ReturnAccountEntity</code>, then calls <code>AccountServices.SaveNewAccountNumber</code> inside a single <code>UnitOfWork2</code> committed with <code>CommitTransaction</code>. When <code>newAccountNumber</code> is omitted (or not greater than zero) the next number is generated with <code>InternalMasterConfigurationServices.GenerateNewAccountNumber</code>, matching the behavior of <code>Client/Servicing/GenerateAccountNumber.aspx</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountNumber</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. The existing account's current account number or Guid id. Resolved through <code>SharedWSServices.GetCommonAccountId</code>; a missing match returns a <code>BadRequest</code> with <code>\"Account not found.\"</code>.</td>\n</tr>\n<tr>\n<td><em>newAccountNumber</em></td>\n<td>Optional int64. The requested new account number. When omitted, <code>null</code>, or <code>&lt;= 0</code>, Omega auto-generates the next available number via <code>InternalMasterConfigurationServices.GenerateNewAccountNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code> with <code>statusCode</code>, <code>result</code>, <code>errors</code>, <code>warnings</code>, and a <code>data</code> block: <code>{ accountId, oldAccountNumber, newAccountNumber }</code>. Validation failures return HTTP 400 with the same envelope.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","AccountNumber"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9dd44eea-15b3-4364-9c34-b4f6c686a6dc","name":"SaveNewAccountNumber - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"30001212\",\n    \"newAccountNumber\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountNumber"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-0000000000A1\",\n        \"oldAccountNumber\": 30001212,\n        \"newAccountNumber\": 30001299\n    }\n}"},{"id":"71177773-4ec1-4363-b865-e3f422127f73","name":"SaveNewAccountNumber - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"newAccountNumber\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountNumber"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"adca82c2-ca85-447d-9d5b-91c21e25604d"},{"name":"AccountNumberSaveNewBulk","id":"4a58fbf7-e515-4104-9b0b-07399f4bb9a4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"newAccountNumber\": 30009999\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/SaveNewAccountNumber?token={{token}}","description":"<h3 id=\"save-new-account-number-bulk\">Save New Account Number (bulk)</h3>\n<p>Assigns a new account number to each of one to 250 accounts. Every item supplies <code>accountNumberOrId</code> for the account to renumber and, optionally, <code>newAccountNumber</code>; when it is omitted the next generated number is used. Accounts commit independently and Day End is checked before each one. The route reuses the single Save New Account Number permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","SaveNewAccountNumber"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"298a69d6-0261-4715-9bec-944f70d1ff3d","name":"AccountNumberSaveNewBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newAccountNumber\": 30009999\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveNewAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveNewAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"accountId\":\"11111111-1111-4111-8111-111111111111\",\"oldAccountNumber\":30001212,\"newAccountNumber\":30009999}}]}}"},{"id":"063d6e3d-5b34-4c5b-9a29-2ba488c79594","name":"AccountNumberSaveNewBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newAccountNumber\": 30009999\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"newAccountNumber\": 30009999\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveNewAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveNewAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"accountId\":\"11111111-1111-4111-8111-111111111111\",\"oldAccountNumber\":30001212,\"newAccountNumber\":30009999}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"7dc7ddc6-00a4-4d85-a40c-445e61fb8595","name":"AccountNumberSaveNewBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveNewAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveNewAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"ea7d9d96-af8d-413e-8d07-c60715e0456f","name":"AccountNumberSaveNewBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveNewAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveNewAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"4a58fbf7-e515-4104-9b0b-07399f4bb9a4"},{"name":"AccountPayoffByIdGet","id":"acb4fb29-a949-43b7-92b2-8933dc94e594","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPayoff/ById/{{account_payoff_id}}","description":"<h3 id=\"get-account-payoff-by-id\">Get Account Payoff By Id</h3>\n<p>Returns a single <code>Common.AccountPayoff</code> record by its Guid primary key. Wraps <code>AccountPayoffWSServices.ReturnAccountPayoffByIdWS</code>, which validates the Guid and then calls <code>AccountPayoffServices.ReturnAccountPayoff(payoffId, databaseName)</code>. Responds with <code>Payoff record not found</code> when no row matches the supplied id.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountPayoff/ById/{payoffId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>payoffId</em></td>\n<td>Required. The Guid primary key of the <code>Common.AccountPayoff</code> row. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank or not a valid Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountPayoff","ById","{{account_payoff_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1f211017-84d2-4d8f-90ed-84e878b05888","name":"GetAccountPayoffById - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPayoff/ById/00000000-0000-0000-0000-000000000701"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000701\",\n        \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n        \"CreationBranchDate\": \"2026-04-18T00:00:00\",\n        \"PayoffAmount\": 12845.72\n    }\n}"},{"id":"682e127e-b98f-4a8c-9050-5b53c17d4b98","name":"GetAccountPayoffById - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPayoff/ById/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Payoff record not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"acb4fb29-a949-43b7-92b2-8933dc94e594"},{"name":"AccountPayoffGet","id":"8aa20dbf-9cb5-4bd0-9bbb-549a0b7ae310","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPayoff/{{account_number_or_id}}?fetchDetail=true","description":"<h3 id=\"get-account-payoff\">Get Account Payoff</h3>\n<p>Returns the most recent <code>Common.AccountPayoff</code> record for the specified account, optionally including its <code>CommonAccountPayoffDetail</code> child rows. Wraps <code>AccountPayoffWSServices.ReturnAccountPayoffWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountPayoffServices.ReturnAccountPayoffByAccountId(accountId, databaseName, fetchDetail)</code>. Results are sorted by <code>CreationBranchDate</code> descending, so only the latest payoff is returned. <code>data</code> is <code>null</code> when no payoff exists for the account.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountPayoff/{accountNumberOrId}?fetchDetail={bool}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchDetail</em></td>\n<td>Optional (default <code>false</code>). When <code>true</code>, the response includes the related <code>Details</code> collection (each payoff transaction line prefetched via <code>MyCommonAccountPayoffEntity.PrefetchPathCommonAccountPayoffDetails</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountPayoff","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"fetchDetail","value":"true"}],"variable":[]}},"response":[{"id":"1f762b86-c8ef-4020-9de2-63e7cfb5753f","name":"GetAccountPayoff - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountPayoff/30001212?fetchDetail=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountPayoff","30001212"],"query":[{"key":"fetchDetail","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000701\",\n        \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n        \"CreationBranchDate\": \"2026-04-18T00:00:00\",\n        \"PayoffAmount\": 12845.72,\n        \"CommonAccountPayoffDetails\": [\n            {\n                \"Id\": \"00000000-0000-0000-0000-000000000801\",\n                \"AccountPayoffId\": \"00000000-0000-0000-0000-000000000701\",\n                \"AccountTransactionId\": \"00000000-0000-0000-0000-000000000901\"\n            },\n            {\n                \"Id\": \"00000000-0000-0000-0000-000000000802\",\n                \"AccountPayoffId\": \"00000000-0000-0000-0000-000000000701\",\n                \"AccountTransactionId\": \"00000000-0000-0000-0000-000000000902\"\n            }\n        ]\n    }\n}"},{"id":"69d0856d-815e-4f77-9795-36e23a431037","name":"GetAccountPayoff - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountPayoff/99999999?fetchDetail=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountPayoff","99999999"],"query":[{"key":"fetchDetail","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"8aa20dbf-9cb5-4bd0-9bbb-549a0b7ae310"},{"name":"AccountPayoffGetBulk","id":"c79e7dbf-fe50-4b93-ae5d-e2bd24c0bf6d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"fetchDetail\": false\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"fetchDetail\": false\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Bulk/AccountPayoff?token={{token}}","description":"<h3 id=\"get-account-payoff-bulk\">Get Account Payoff (bulk)</h3>\n<p>Returns payoff information for several accounts in one call. Each account is resolved through the same code path as the single-account <code>GET api/Client/Account/AccountPayoff/{accountNumberOrId}</code>, so the figures are identical.</p>\n<p><strong>This is a POST because the single-account form carries the account in the URL path</strong>, which cannot hold a collection and has no request body. The account list travels in the body rather than the query string so it is not bounded by URL length and does not appear in web-server and proxy access logs.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Bulk/AccountPayoff?token={{token}}</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string on every array item. Omega account number or account <code>Id</code> (Guid). One request may mix numbers and IDs.</td>\n</tr>\n<tr>\n<td><em>fetchDetail</em></td>\n<td>Optional boolean on every array item that must remain <code>false</code>. Detailed payoff output is not bounded; request each detailed payoff through the single-account endpoint.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers.</p>\n<h4 id=\"response\">Response</h4>\n<p>Returns <strong>HTTP 200 for any batch that was attempted, including one where every account failed</strong> — check <code>statusCode</code>, not the HTTP status. <code>Ok</code> means all succeeded; <code>Successful_With_Error</code> means some or all did not. Per-account results are in <code>data.accounts</code>; each row echoes the submitted <code>accountNumberOrId</code>, provides the resolved <code>accountNumber</code> when found, and carries that account's own <code>singleStatusCode</code>, <code>errors</code>, <code>warnings</code> and <code>data</code>. Top-level <code>errors</code> is used only for a request-level failure — empty list, over the 100 cap, missing permission, or unsupported authentication, or <code>fetchDetail: true</code> — where nothing was attempted and the response is a 400.</p>\n<p><strong>Billing:</strong> one bulk request counts as a single API call, regardless of how many accounts it contains. The API meter is incremented once per HTTP request at authentication, so requesting payoffs for 250 accounts in one call is metered as 1, not 100.</p>\n<p>Uses the same API Access permission as the single-account payoff endpoint. The reuse is declared on the Client controller action. Not available on SessionId authentication.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Bulk","AccountPayoff"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ce0c9552-e37e-488e-9045-45a7547f5fcb","name":"AccountPayoffGetBulk - Partial success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"fetchDetail\": false\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"fetchDetail\": false\n    },\n    {\n        \"accountNumberOrId\": \"99999999\",\n        \"fetchDetail\": false\n    }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Bulk/AccountPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Bulk","AccountPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Successful_With_Error\",\n    \"result\": \"Successful With Error\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n        \"requested\": 3,\n        \"total\": 3,\n        \"succeeded\": 2,\n        \"succeededWithError\": 0,\n        \"failed\": 1,\n        \"skipped\": 0,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30001212,\n                \"accountNumberOrId\": \"30001212\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"id\": \"00000000-0000-0000-0000-000000000000\",\n                    \"ts\": \"AAAAAAAAAAA=\",\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"creationBranchDate\": \"2026-04-18T00:00:00\",\n                    \"payoffAmount\": 8342.17\n                }\n            },\n            {\n                \"accountNumber\": 30001213,\n                \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"id\": \"00000000-0000-0000-0000-000000000000\",\n                    \"ts\": \"AAAAAAAAAAA=\",\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"creationBranchDate\": \"2026-04-18T00:00:00\",\n                    \"payoffAmount\": 1204.55\n                }\n            },\n            {\n                \"accountNumber\": 99999999,\n                \"accountNumberOrId\": \"99999999\",\n                \"status\": \"Failed\",\n                \"message\": \"Account not found\",\n                \"singleStatusCode\": \"Error\",\n                \"singleResult\": \"Error\",\n                \"errors\": [\"Account not found\"],\n                \"warnings\": [],\n                \"data\": null\n            }\n        ]\n    }\n}"},{"id":"73a1fcf0-5b75-4ec7-a484-70d54d72c2d5","name":"AccountPayoffGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"fetchDetail\": false\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"fetchDetail\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Bulk/AccountPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Bulk","AccountPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"9f329e28-ff7f-40fe-980b-4649938c85b1","name":"AccountPayoffGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Bulk/AccountPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Bulk","AccountPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"48b204bb-2f4b-48bc-a0ce-79141459c5de","name":"AccountPayoffGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false},{\"accountNumberOrId\":\"30001212\",\"fetchDetail\":false}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Bulk/AccountPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Bulk","AccountPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c79e7dbf-fe50-4b93-ae5d-e2bd24c0bf6d"},{"name":"AccountPendingPaymentAmountChangesGet","id":"f270e522-ba15-41b4-b40a-8fa53c88aeb1","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/{{account_number_or_id}}","description":"<h3 id=\"get-account-pending-payment-amount-changes\">Get Account Pending Payment Amount Changes</h3>\n<p>Returns every <code>Servicing.AccountPendingPaymentAmountChange</code> row for the specified account. Wraps <code>AccountPendingPaymentAmountChangeWSServices.ReturnAccountPendingPaymentAmountChangesWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountPendingPaymentAmountChangeServices.ReturnAccountPendingPaymentAmountChanges(accountId, databaseName)</code>. The result is serialized as an LLBLGen entity collection of <code>MyServicingAccountPendingPaymentAmountChangeEntity</code> rows.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountPendingPaymentAmountChange","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d68c5a0f-bcf4-4f90-99d5-a735f701833b","name":"GetAccountPendingPaymentAmountChanges - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/30001212"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000B01\",\n            \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n            \"EffectiveNextDueDate\": \"2026-05-01T00:00:00\",\n            \"PaymentChange\": 25.00,\n            \"SourceType\": 1,\n            \"Comment\": \"Rate adjustment effective next cycle\",\n            \"CreationBranchDate\": \"2026-04-18T00:00:00\"\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000B02\",\n            \"AccountId\": \"00000000-0000-0000-0000-0000000000A1\",\n            \"EffectiveNextDueDate\": \"2026-06-01T00:00:00\",\n            \"PaymentChange\": -10.00,\n            \"SourceType\": 1,\n            \"Comment\": \"Partial curtailment re-amortization\",\n            \"CreationBranchDate\": \"2026-04-18T00:00:00\"\n        }\n    ]\n}"},{"id":"f01c5158-0632-46c2-bdd3-902172bec320","name":"GetAccountPendingPaymentAmountChanges - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/99999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f270e522-ba15-41b4-b40a-8fa53c88aeb1"},{"name":"AccountPendingPaymentAmountChangesGetBulk","id":"f861392d-a707-4079-a47c-1d21e60fd273","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountPendingPaymentAmountChanges?token={{token}}","description":"<h3 id=\"get-account-pending-payment-amount-changes-bulk\">Get Account Pending Payment Amount Changes (bulk)</h3>\n<p>Returns pending payment-amount-change records for one to 250 accounts. Every item requires an account number or account ID. This differs from <code>Bulk/GetPendingPaymentChanges</code>, which returns the AccountController summary/detail contract. The route reuses the single Account Pending Payment Amount Change permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountPendingPaymentAmountChanges"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"523e8a35-ddc0-4efa-b629-4f2f1fb22429","name":"AccountPendingPaymentAmountChangesGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountPendingPaymentAmountChanges?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountPendingPaymentAmountChanges"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"currentPayment\":125,\"newPayment\":140}]}]}}"},{"id":"935b5c51-4bbd-4307-a8c9-eeaf9642f799","name":"AccountPendingPaymentAmountChangesGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountPendingPaymentAmountChanges?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountPendingPaymentAmountChanges"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"77ff9d85-3389-43e4-8de0-131ff88cf480","name":"AccountPendingPaymentAmountChangesGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountPendingPaymentAmountChanges?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountPendingPaymentAmountChanges"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"f861392d-a707-4079-a47c-1d21e60fd273"},{"name":"PendingPaymentChangesGetBulk","id":"7c16abe7-5dde-466b-ad83-82c88383bacd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"display_option\": \"Detail\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"display_option\": \"Summary\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChanges?token={{token}}","description":"<h3 id=\"get-pending-payment-changes-bulk\">Get Pending Payment Changes (bulk)</h3>\n<p>Returns pending payment-amount changes for one to 250 accounts. Every array item requires <code>accountNumberOrId</code> and may set its own <code>display_option</code> to <code>Detail</code> or <code>Summary</code>. The selector accepts an account number or account <code>Id</code> (Guid). The route reuses the single-account Pending Payment Changes permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetPendingPaymentChanges"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5c73086f-18ca-4c43-a638-6c3f86987696","name":"PendingPaymentChangesGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"display_option\":\"Detail\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChanges?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPendingPaymentChanges"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"ea7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"current_payment_amount\": 125.00, \"pending_changes\": [] }\n    }]\n  }\n}"},{"id":"a2fd94c0-4476-4a98-bb0b-7818d236deb0","name":"PendingPaymentChangesGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"display_option\": \"Detail\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"display_option\": \"Summary\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChanges?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPendingPaymentChanges"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"33645cf9-80f2-4e88-83e1-6e9e3a418f77","name":"PendingPaymentChangesGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChanges?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPendingPaymentChanges"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"7c16abe7-5dde-466b-ad83-82c88383bacd"},{"name":"AccountRemarkCodeAdd","id":"35c92afe-5734-4ad1-b146-6e681b94de27","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"AddRemarkCode\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": \"{{account_number}}\",\r\n            \"valueToUpdate\": \"{{add_remark_code}}\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts","description":"<h6 id=\"this-method-with-type-set-as-addremarkcode-will-add-the-provided-remark-code-to-the-account\">This method with <strong>\"<em>Type</em>\"</strong> set as <code>AddRemarkCode</code> will add the provided remark code to the account.</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Token</em></td>\n<td>Required. Token to identify your login access provided by the Login method.</td>\n</tr>\n<tr>\n<td><em>Type</em></td>\n<td>Required. Must be set to <code>AddRemarkCode</code> to add remark to an account.</td>\n</tr>\n<tr>\n<td><em>Data</em></td>\n<td>Required. The list of account remark code to add.</td>\n</tr>\n<tr>\n<td><em>AccountNumber</em></td>\n<td>Required. Must be a valid int64 greater than 0. This field must match an account number in the Omega system.</td>\n</tr>\n<tr>\n<td><em>ValueToUpdate</em></td>\n<td>Required. String with max length of 10. Must be a valid <a href=\"https://%7B%7Bbase_url%7D%7D/Client/Common/RemarkCodeMaintenance.aspx\">remark code</a> from the Omega system.</td>\n</tr>\n</tbody>\n</table>\n</div><p>API Access: the caller's API Access role needs the UpdateAccounts endpoint, or its <strong>Add Remark Code</strong> operation. A role granted only some types gets 403 for the others.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","updateaccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ea801701-8763-4583-b5e7-afd385e0654f","name":"Add Remark Code - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"AddRemarkCode\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 13002,\r\n            \"valueToUpdate\": \"Legal\"\r\n        },\r\n        {\r\n            \"accountNumber\": 2530,\r\n            \"valueToUpdate\": \"Repo\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"},{"id":"5a3f3f58-fc15-43db-88ef-feb4e986b261","name":"Add Remark Code - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"AddRemarkCode\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 13002,\r\n            \"valueToUpdate\": \"Legal\"\r\n        },\r\n        {\r\n            \"accountNumber\": 2530,\r\n            \"valueToUpdate\": \"Repo\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Record 1 Account 13002: Remark Code 'Legal' not found.\",\n        \"Record 2 Account 2530: Account not found.\"\n    ]\n}"}],"_postman_id":"35c92afe-5734-4ad1-b146-6e681b94de27"},{"name":"AccountRemarkCodesGetBulk","id":"27ce63f1-721e-47a5-8375-1cc383912d1f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountRemarkCodes?token={{token}}","description":"<h3 id=\"get-account-remark-codes-bulk\">Get Account Remark Codes (bulk)</h3>\n<p>Returns the remark codes assigned to one to 250 accounts. Every array item requires <code>accountNumberOrId</code>, which accepts an account number or account ID. The route reuses the single Get Account Remark Codes permission (<code>GET api/Client/Common/RemarkCode/Account/{accountNumberOrId}</code>).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountRemarkCodes"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e7071026-093c-4e8e-bbe8-ecb4b27f9340","name":"AccountRemarkCodesGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountRemarkCodes?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountRemarkCodes"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"code\":\"BK\",\"description\":\"Bankruptcy\"}]}]}}"},{"id":"84c5e515-02f7-4336-9cc8-97909bb4be3f","name":"AccountRemarkCodesGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountRemarkCodes?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountRemarkCodes"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [{\"code\":\"BK\",\"description\":\"Bankruptcy\"}]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"e6cda9d4-3ade-43ce-8a3c-855a89db1e32","name":"AccountRemarkCodesGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountRemarkCodes?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountRemarkCodes"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"6787b3e9-5536-4685-b3b7-826787ac152f","name":"AccountRemarkCodesGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountRemarkCodes?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountRemarkCodes"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"27ce63f1-721e-47a5-8375-1cc383912d1f"},{"name":"AccountRemarkCodeDelete","id":"5fe42824-1414-4ed5-8e0e-e9be0001d168","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"RemoveRemarkCode\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": \"{{account_number}}\",\r\n            \"valueToUpdate\": \"{{remove_remark_code}}\"\r\n        }\r\n    ]\r\n    \r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts","description":"<h6 id=\"this-method-with-type-set-as-removeremarkcode-will-remove-the-provided-remark-code-from-the-account\">This method with <strong>\"<em>Type</em>\"</strong> set as <code>RemoveRemarkCode</code> will remove the provided remark code from the account.</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Token</em></td>\n<td>Required. Token to identify your login access provided by the Login method.</td>\n</tr>\n<tr>\n<td><em>Type</em></td>\n<td>Required. Must be set to <code>RemoveRemarkCode</code> to remove remark from an account.</td>\n</tr>\n<tr>\n<td><em>Data</em></td>\n<td>Required. The list of account remark code to remove.</td>\n</tr>\n<tr>\n<td><em>AccountNumber</em></td>\n<td>Required. Must be a valid int64 greater than 0. This field must match an account number in the Omega system.</td>\n</tr>\n<tr>\n<td><em>ValueToUpdate</em></td>\n<td>Required. String with max length of 10. Must be a valid <a href=\"https://%7B%7Bbase_url%7D%7D/Client/Common/RemarkCodeMaintenance.aspx\">remark code</a> from the Omega system.</td>\n</tr>\n</tbody>\n</table>\n</div><p>API Access: the caller's API Access role needs the UpdateAccounts endpoint, or its <strong>Remove Remark Code</strong> operation. A role granted only some types gets 403 for the others.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","updateaccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"61f63199-c532-4c8d-984a-c895608fedde","name":"Remove Remark Code - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"RemoveRemarkCode\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 13002,\r\n            \"valueToUpdate\": \"Legal\"\r\n        },\r\n        {\r\n            \"accountNumber\": 2530,\r\n            \"valueToUpdate\": \"Repo\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"},{"id":"02636b33-a71c-4b01-b8cb-23b42a2a37f8","name":"Remove Remark Code - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"RemoveRemarkCode\",\r\n    \"data\": [\r\n        {\r\n            \"accountNumber\": 13002,\r\n            \"valueToUpdate\": \"Legal\"\r\n        },\r\n        {\r\n            \"accountNumber\": 2530,\r\n            \"valueToUpdate\": \"Repo\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/updateaccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Record 1 Account 13002: Remark Code 'Legal' not found.\",\n        \"Record 2 Account 2530: Account not found.\"\n    ]\n}"}],"_postman_id":"5fe42824-1414-4ed5-8e0e-e9be0001d168"},{"name":"AccountsByCustomerGet","id":"3eb62982-4665-4e77-afbc-865b72d12b72","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"customer_number\": \"{{customer_number}}\",\n    \"show_transactions\": false,\n    \"exclude_inactive_transactions\": false,\n    \"starting_effective_date\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountsByCustomer","description":"<p>This method is used to get all account summary details for a given customer.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>customer_number</em></td>\n<td>Required int64. Omega assigned customer number to query.</td>\n</tr>\n<tr>\n<td><em>show_transactions</em></td>\n<td>Optional bool. Defaults to false. When true, appends a <code>GetAccountTransactions</code> section to each returned account summary</td>\n</tr>\n<tr>\n<td><em>exclude_inactive_transactions</em></td>\n<td>Optional bool. Defaults to false. Ignored unless <em>show_transactions</em> is true</td>\n</tr>\n<tr>\n<td><em>starting_effective_date</em></td>\n<td>Optional date (<code>yyyy-MM-dd</code>). Defaults to null. Ignored unless <em>show_transactions</em> is true</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetAccountsByCustomer"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d9cee15b-1be0-4fc6-824d-57e5dd1237d1","name":"GetAccountsByCustomer - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"customer_number\": \"{{customer_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountsByCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcR2V0QWNjb3VudHNCeUN1c3RvbWVy?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 20:10:08 GMT"},{"key":"Content-Length","value":"1467"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Accounts\": {\n            \"AccountSummary\": [\n                {\n                    \"AccountNumber\": \"30010393\",\n                    \"ClassNumber\": \"10\",\n                    \"GetAccountSummary\": {\n                        \"OpenDate\": \"08/18/2021\",\n                        \"LoanAmount\": \"10000.00\",\n                        \"Term\": \"12\",\n                        \"Frequency\": \"Monthly\",\n                        \"Rate\": \"10.0000%\",\n                        \"MilitaryAPR\": \"13.8361%\",\n                        \"PaymentAmount\": \"897.18\",\n                        \"State\": \"IL\",\n                        \"LastPaidDate\": \"08/18/2021\",\n                        \"NextDueDate\": \"10/18/2021\",\n                        \"NextAmountDue\": \"497.18\",\n                        \"CurrentBalance\": \"8907.90\",\n                        \"UnpaidLateFees\": \"0.00\",\n                        \"UnpaidOtherFees\": \"0.00\",\n                        \"PaymentOverShortAmount\": \"400.00\",\n                        \"TotalBalance\": \"8907.90\",\n                        \"PastDueAmount\": \"0.00\",\n                        \"PayoffAmount\": \"8906.90\",\n                        \"AdminStatus\": \"A\",\n                        \"InternalStatus\": \"Active\",\n                        \"AllowPayment\": \"true\",\n                        \"AllowPaymentMessage\": null,\n                        \"BlockedFundsType\": {\n                            \"FundsType\": [\n                                \"Money_Order\",\n                                \"Cashiers_Check\",\n                                \"ACH\",\n                                \"InterPoynt\",\n                                \"ExpiTrans_ACH\"\n                            ]\n                        },\n                        \"IBUnpaidInterest\": \"0.00\",\n                        \"IBYTDInterestPaid\": \"0.00\",\n                        \"IBTotalInterestPaid\": \"0.00\",\n                        \"LastPaymentAmount\": \"100.00\",\n                        \"LastPaymentPrincipalPaid\": \"100.00\",\n                        \"LastPaymentInterestPaid\": null,\n                        \"LastPaymentOtherBalancePaid\": null,\n                        \"LastPaymentEnterDate\": \"8/18/2021\",\n                        \"LastPaymentPreviousBalance\": \"9007.90\",\n                        \"CollateralDescription\": \"2015 honda civic\",\n                        \"CollateralVehicleYear\": \"2015\",\n                        \"CollateralVehicleMake\": \"honda\",\n                        \"CollateralVehicleModel\": \"civic\",\n                        \"CollateralVIN\": \"DS921HFQ132HI98321\",\n                        \"AccountType\": \"Interest_Bearing_Direct\",\n                        \"NextPaymentDueDate\": \"10/18/2021\"\n                    },\n                    \"GetBranchSummary\": {\n                        \"Name\": \"Co. 10 East Magdalenastad\",\n                        \"Number\": \"90\",\n                        \"BranchPhoneNumber\": null\n                    },\n                    \"GetBorrowerSummary\": [\n                        {\n                            \"CustomerNumber\": \"656\",\n                            \"CustomerType\": \"Primary_Customer\",\n                            \"FirstName\": \"John\",\n                            \"LastName\": \"Doe\",\n                            \"SocialSecurityNumberLast4\": \"1111\",\n                            \"Birthday\": \"07/29/1997\",\n                            \"Email\": \"JohnDoe123@megasys.net\",\n                            \"DriversLicenseNumber\": \"D244233\",\n                            \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n                            \"AddressLine1\": \"500 City Pkwy W\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"Orange\",\n                            \"AddressState\": \"CA\",\n                            \"AddressZipCode\": \"92868\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        },\n                        {\n                            \"CustomerNumber\": \"538\",\n                            \"CustomerType\": \"Co_Signer\",\n                            \"FirstName\": \"Hallie\",\n                            \"LastName\": \"Auer\",\n                            \"SocialSecurityNumberLast4\": \"4730\",\n                            \"Birthday\": \"09/12/1991\",\n                            \"Email\": null,\n                            \"DriversLicenseNumber\": \"Z446614\",\n                            \"PrimaryPhoneNumber\": \"(477) 773-8622\",\n                            \"AddressLine1\": \"8245 Bethel Brook\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"Gavinton\",\n                            \"AddressState\": \"IL\",\n                            \"AddressZipCode\": \"63949\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        }\n                    ]\n                },\n                {\n                    \"AccountNumber\": \"30009964\",\n                    \"ClassNumber\": \"10\",\n                    \"GetAccountSummary\": {\n                        \"OpenDate\": \"08/16/2021\",\n                        \"LoanAmount\": \"10000.00\",\n                        \"Term\": \"12\",\n                        \"Frequency\": \"Monthly\",\n                        \"Rate\": \"10.0000%\",\n                        \"MilitaryAPR\": \"9.9981%\",\n                        \"PaymentAmount\": \"879.15\",\n                        \"State\": \"IL\",\n                        \"LastPaidDate\": null,\n                        \"NextDueDate\": \"09/16/2021\",\n                        \"NextAmountDue\": \"879.15\",\n                        \"CurrentBalance\": \"10000.00\",\n                        \"UnpaidLateFees\": \"0.00\",\n                        \"UnpaidOtherFees\": \"0.00\",\n                        \"PaymentOverShortAmount\": \"0.00\",\n                        \"TotalBalance\": \"10000.00\",\n                        \"PastDueAmount\": \"0.00\",\n                        \"PayoffAmount\": \"10008.22\",\n                        \"AdminStatus\": \"A\",\n                        \"InternalStatus\": \"Active\",\n                        \"AllowPayment\": \"true\",\n                        \"AllowPaymentMessage\": null,\n                        \"BlockedFundsType\": {\n                            \"FundsType\": [\n                                \"Money_Order\",\n                                \"Cashiers_Check\",\n                                \"ACH\",\n                                \"InterPoynt\"\n                            ]\n                        },\n                        \"IBUnpaidInterest\": \"8.22\",\n                        \"IBYTDInterestPaid\": \"0.00\",\n                        \"IBTotalInterestPaid\": \"0.00\",\n                        \"LastPaymentAmount\": null,\n                        \"LastPaymentPrincipalPaid\": null,\n                        \"LastPaymentInterestPaid\": null,\n                        \"LastPaymentOtherBalancePaid\": null,\n                        \"LastPaymentEnterDate\": null,\n                        \"LastPaymentPreviousBalance\": null,\n                        \"CollateralDescription\": \"2015 honda civci\",\n                        \"CollateralVehicleYear\": \"2015\",\n                        \"CollateralVehicleMake\": \"honda\",\n                        \"CollateralVehicleModel\": \"civci\",\n                        \"CollateralVIN\": \"dsfsd342\",\n                        \"AccountType\": \"Interest_Bearing_Direct\",\n                        \"NextPaymentDueDate\": \"09/16/2021\"\n                    },\n                    \"GetBranchSummary\": {\n                        \"Name\": \"Co. 10 East Magdalenastad\",\n                        \"Number\": \"90\",\n                        \"BranchPhoneNumber\": null\n                    },\n                    \"GetBorrowerSummary\": [\n                        {\n                            \"CustomerNumber\": \"360\",\n                            \"CustomerType\": \"Primary_Customer\",\n                            \"FirstName\": \"Mary\",\n                            \"LastName\": \"Jane\",\n                            \"SocialSecurityNumberLast4\": \"2295\",\n                            \"Birthday\": \"05/24/1971\",\n                            \"Email\": null,\n                            \"DriversLicenseNumber\": \"A455592\",\n                            \"PrimaryPhoneNumber\": \"(949) 999-9999\",\n                            \"AddressLine1\": \"432 Kennith Rd\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"East Meggieton\",\n                            \"AddressState\": \"IL\",\n                            \"AddressZipCode\": \"92936\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        },\n                        {\n                            \"CustomerNumber\": \"158\",\n                            \"CustomerType\": \"Spouse\",\n                            \"FirstName\": \"Michael\",\n                            \"LastName\": \"Smith\",\n                            \"SocialSecurityNumberLast4\": \"2915\",\n                            \"Birthday\": null,\n                            \"Email\": null,\n                            \"DriversLicenseNumber\": null,\n                            \"PrimaryPhoneNumber\": \"(949) 999-9999\",\n                            \"AddressLine1\": \"767 Crawford Ave\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"New Gloriaberg\",\n                            \"AddressState\": \"RI\",\n                            \"AddressZipCode\": \"85842\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        },\n                        {\n                            \"CustomerNumber\": \"656\",\n                            \"CustomerType\": \"Co_Signer\",\n                            \"FirstName\": \"John\",\n                            \"LastName\": \"Doe\",\n                            \"SocialSecurityNumberLast4\": \"1111\",\n                            \"Birthday\": \"07/29/1997\",\n                            \"Email\": \"JohnDoe123@megasys.net\",\n                            \"DriversLicenseNumber\": \"D244233\",\n                            \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n                            \"AddressLine1\": \"500 City Pkwy W\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"Orange\",\n                            \"AddressState\": \"CA\",\n                            \"AddressZipCode\": \"92868\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        }\n                    ]\n                },\n                {\n                    \"AccountNumber\": \"30006354\",\n                    \"ClassNumber\": \"11\",\n                    \"GetAccountSummary\": {\n                        \"OpenDate\": \"06/22/2018\",\n                        \"LoanAmount\": \"500.00\",\n                        \"Term\": \"12\",\n                        \"Frequency\": \"Monthly\",\n                        \"Rate\": \"0.0000%\",\n                        \"MilitaryAPR\": \"94.9953%\",\n                        \"PaymentAmount\": \"66.06\",\n                        \"State\": \"IL\",\n                        \"LastPaidDate\": \"02/15/2019\",\n                        \"NextDueDate\": \"11/22/2018\",\n                        \"NextAmountDue\": \"667.74\",\n                        \"CurrentBalance\": \"417.62\",\n                        \"UnpaidLateFees\": \"50.00\",\n                        \"UnpaidOtherFees\": \"0.00\",\n                        \"PaymentOverShortAmount\": \"30.82\",\n                        \"TotalBalance\": \"467.62\",\n                        \"PastDueAmount\": \"667.74\",\n                        \"PayoffAmount\": \"667.74\",\n                        \"AdminStatus\": \"A\",\n                        \"InternalStatus\": \"Active\",\n                        \"AllowPayment\": \"true\",\n                        \"AllowPaymentMessage\": null,\n                        \"BlockedFundsType\": {\n                            \"FundsType\": [\n                                \"Money_Order\",\n                                \"Cashiers_Check\",\n                                \"ACH\",\n                                \"InterPoynt\"\n                            ]\n                        },\n                        \"IBUnpaidInterest\": \"200.12\",\n                        \"IBYTDInterestPaid\": \"0.00\",\n                        \"IBTotalInterestPaid\": \"212.68\",\n                        \"LastPaymentAmount\": \"66.00\",\n                        \"LastPaymentPrincipalPaid\": \"0.00\",\n                        \"LastPaymentInterestPaid\": \"36.00\",\n                        \"LastPaymentOtherBalancePaid\": \"30.00\",\n                        \"LastPaymentEnterDate\": \"2/15/2019\",\n                        \"LastPaymentPreviousBalance\": \"417.62\",\n                        \"CollateralDescription\": null,\n                        \"CollateralVehicleYear\": null,\n                        \"CollateralVehicleMake\": null,\n                        \"CollateralVehicleModel\": null,\n                        \"CollateralVIN\": null,\n                        \"AccountType\": \"Interest_Bearing_Direct\",\n                        \"NextPaymentDueDate\": \"08/22/2021\"\n                    },\n                    \"GetBranchSummary\": {\n                        \"Name\": \"Co. 10 East Magdalenastad\",\n                        \"Number\": \"90\",\n                        \"BranchPhoneNumber\": null\n                    },\n                    \"GetBorrowerSummary\": {\n                        \"CustomerNumber\": \"656\",\n                        \"CustomerType\": \"Primary_Customer\",\n                        \"FirstName\": \"John\",\n                        \"LastName\": \"Doe\",\n                        \"SocialSecurityNumberLast4\": \"1111\",\n                        \"Birthday\": \"07/29/1997\",\n                        \"Email\": \"JohnDoe123@megasys.net\",\n                        \"DriversLicenseNumber\": \"D244233\",\n                        \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n                        \"AddressLine1\": \"500 City Pkwy W\",\n                        \"AddressLine2\": null,\n                        \"AddressLine3\": null,\n                        \"AddressCity\": \"Orange\",\n                        \"AddressState\": \"CA\",\n                        \"AddressZipCode\": \"92868\",\n                        \"MilitaryActiveDuty\": \"False\"\n                    }\n                }\n            ]\n        }\n    },\n    \"errors\": []\n}"},{"id":"63e0ce20-8ea6-4738-8b7b-4ed56063395a","name":"GetAccountsByCustomer - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"customer_number\": \"{{customer_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountsByCustomer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|ef1203c0-197f-4a22-8e1f-a4695ad98a33|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 13 Dec 2022 22:42:20 GMT"},{"key":"Content-Length","value":"114"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error fetching accounts: Invalid customer number\"\n    ]\n}"}],"_postman_id":"3eb62982-4665-4e77-afbc-865b72d12b72"},{"name":"AccountsByCustomerIdGet","id":"06a37753-6f1d-4d36-ada7-ed79b55ceb1f","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountCustomer/ByCustomer/{{customer_number_or_id}}?fetchAccount=true&activatedAccountsOnly=false&includeClosed=false","description":"<h3 id=\"get-accounts-by-customer\">Get Accounts By Customer</h3>\n<p>Returns the <code>Common.AccountCustomer</code> rows linked to a customer, i.e. every account the customer is attached to. Resolves the customer via the <code>customerNumberOrId</code> route segment (accepts the Omega customer number or the customer <code>Id</code> Guid) and forwards to <code>AccountCustomerServices.ReturnAccountCustomersWithCustomerId</code>. When <code>fetchAccount</code> is <code>true</code> each row also includes the navigated <code>Common.Account</code> record.</p>\n<p>Note: Postman already exposes a legacy POST helper at <code>GetAccountsByCustomer.request.yaml</code> that calls the older <code>api/Client/Account/GetAccountsByCustomer</code> route. This request documents the canonical current GET route.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountCustomer/ByCustomer/{customerNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerNumberOrId</em></td>\n<td>Required string. Omega customer number or customer <code>Id</code> (Guid) to look up. Returns <code>BadRequest</code> with the standard invalid parameter message when blank, and a <code>Customer not found</code> error when the customer cannot be resolved for the calling client.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchAccount</em></td>\n<td>Optional boolean. When <code>true</code> the response includes the navigated <code>CommonAccount</code> record for each account-customer row. Defaults to <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>activatedAccountsOnly</em></td>\n<td>Optional boolean. When <code>true</code> only activated accounts are returned. Defaults to <code>false</code>.</td>\n</tr>\n<tr>\n<td><em>includeClosed</em></td>\n<td>Optional boolean. When <code>true</code> the service also returns accounts whose internal status is <code>Closed</code>. Defaults to <code>false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountCustomer","ByCustomer","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"fetchAccount","value":"true"},{"key":"activatedAccountsOnly","value":"false"},{"key":"includeClosed","value":"false"}],"variable":[]}},"response":[{"id":"cfd6788b-a1b9-4e0e-9011-8f7365bbb051","name":"GetAccountsByCustomerId - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountCustomer/ByCustomer/{{customer_number}}?fetchAccount=true&activatedAccountsOnly=false&includeClosed=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountCustomer","ByCustomer","{{customer_number}}"],"query":[{"key":"fetchAccount","value":"true"},{"key":"activatedAccountsOnly","value":"false"},{"key":"includeClosed","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000010\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"CustomerId\": \"00000000-0000-0000-0000-000000000100\",\n            \"CustomerType\": 1,\n            \"CustomerStatus\": 1,\n            \"CreationBranchDate\": \"04/18/2026\",\n            \"SequenceNumber\": 1,\n            \"CommonAccount\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000000\",\n                \"AccountNumber\": 30001212,\n                \"InternalStatus\": 1,\n                \"CreationBranchDate\": \"04/18/2026\"\n            }\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000012\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000500\",\n            \"CustomerId\": \"00000000-0000-0000-0000-000000000100\",\n            \"CustomerType\": 1,\n            \"CustomerStatus\": 1,\n            \"CreationBranchDate\": \"07/10/2025\",\n            \"SequenceNumber\": 1,\n            \"CommonAccount\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000500\",\n                \"AccountNumber\": 30005455,\n                \"InternalStatus\": 1,\n                \"CreationBranchDate\": \"07/10/2025\"\n            }\n        }\n    ]\n}"},{"id":"c42e8e76-2665-4d91-9cc3-e74dbc085385","name":"GetAccountsByCustomerId - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountCustomer/ByCustomer/99999999?fetchAccount=true&activatedAccountsOnly=false&includeClosed=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountCustomer","ByCustomer","99999999"],"query":[{"key":"fetchAccount","value":"true"},{"key":"activatedAccountsOnly","value":"false"},{"key":"includeClosed","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Customer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"06a37753-6f1d-4d36-ada7-ed79b55ceb1f"},{"name":"AccountsByCustomerPhoneGet","id":"9a01a42d-191d-4e13-9a3b-5bc8ef8f382b","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"phone_number\": \"{{customer_phone}}\",\n    \"show_transactions\": false,\n    \"exclude_inactive_transactions\": false,\n    \"starting_effective_date\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountsByCustomerPhone","description":"<p>This method is used to get all account summary details for <strong>all customers</strong> with the matching phone number.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>phone_number</em></td>\n<td>Required int64. Customer unformatted phone number to query.</td>\n</tr>\n<tr>\n<td><em>show_transactions</em></td>\n<td>Optional bool. Defaults to false. When true, appends a <code>GetAccountTransactions</code> section to each returned account summary</td>\n</tr>\n<tr>\n<td><em>exclude_inactive_transactions</em></td>\n<td>Optional bool. Defaults to false. Ignored unless <em>show_transactions</em> is true</td>\n</tr>\n<tr>\n<td><em>starting_effective_date</em></td>\n<td>Optional date (<code>yyyy-MM-dd</code>). Defaults to null. Ignored unless <em>show_transactions</em> is true</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetAccountsByCustomerPhone"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"74a18dd8-07e9-4f77-bf24-9a2b88983b29","name":"GetAccountsByCustomerPhone - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"phone_number\": \"{{customer_phone}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountsByCustomerPhone"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcR2V0QWNjb3VudHNCeUN1c3RvbWVyUGhvbmU=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 20:13:21 GMT"},{"key":"Content-Length","value":"1467"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Accounts\": {\n            \"AccountSummary\": [\n                {\n                    \"AccountNumber\": \"30010393\",\n                    \"ClassNumber\": \"10\",\n                    \"GetAccountSummary\": {\n                        \"OpenDate\": \"08/18/2021\",\n                        \"LoanAmount\": \"10000.00\",\n                        \"Term\": \"12\",\n                        \"Frequency\": \"Monthly\",\n                        \"Rate\": \"10.0000%\",\n                        \"MilitaryAPR\": \"13.8361%\",\n                        \"PaymentAmount\": \"897.18\",\n                        \"State\": \"IL\",\n                        \"LastPaidDate\": \"08/18/2021\",\n                        \"NextDueDate\": \"10/18/2021\",\n                        \"NextAmountDue\": \"497.18\",\n                        \"CurrentBalance\": \"8907.90\",\n                        \"UnpaidLateFees\": \"0.00\",\n                        \"UnpaidOtherFees\": \"0.00\",\n                        \"PaymentOverShortAmount\": \"400.00\",\n                        \"TotalBalance\": \"8907.90\",\n                        \"PastDueAmount\": \"0.00\",\n                        \"PayoffAmount\": \"8906.90\",\n                        \"AdminStatus\": \"A\",\n                        \"InternalStatus\": \"Active\",\n                        \"AllowPayment\": \"true\",\n                        \"AllowPaymentMessage\": null,\n                        \"BlockedFundsType\": {\n                            \"FundsType\": [\n                                \"Money_Order\",\n                                \"Cashiers_Check\",\n                                \"ACH\",\n                                \"InterPoynt\",\n                                \"ExpiTrans_ACH\"\n                            ]\n                        },\n                        \"IBUnpaidInterest\": \"0.00\",\n                        \"IBYTDInterestPaid\": \"0.00\",\n                        \"IBTotalInterestPaid\": \"0.00\",\n                        \"LastPaymentAmount\": \"100.00\",\n                        \"LastPaymentPrincipalPaid\": \"100.00\",\n                        \"LastPaymentInterestPaid\": null,\n                        \"LastPaymentOtherBalancePaid\": null,\n                        \"LastPaymentEnterDate\": \"8/18/2021\",\n                        \"LastPaymentPreviousBalance\": \"9007.90\",\n                        \"CollateralDescription\": \"2015 honda civic\",\n                        \"CollateralVehicleYear\": \"2015\",\n                        \"CollateralVehicleMake\": \"honda\",\n                        \"CollateralVehicleModel\": \"civic\",\n                        \"CollateralVIN\": \"DS921HFQ132HI98321\",\n                        \"AccountType\": \"Interest_Bearing_Direct\",\n                        \"NextPaymentDueDate\": \"10/18/2021\"\n                    },\n                    \"GetBranchSummary\": {\n                        \"Name\": \"Co. 10 East Magdalenastad\",\n                        \"Number\": \"90\",\n                        \"BranchPhoneNumber\": null\n                    },\n                    \"GetBorrowerSummary\": [\n                        {\n                            \"CustomerNumber\": \"656\",\n                            \"CustomerType\": \"Primary_Customer\",\n                            \"FirstName\": \"John\",\n                            \"LastName\": \"Doe\",\n                            \"SocialSecurityNumberLast4\": \"1111\",\n                            \"Birthday\": \"07/29/1997\",\n                            \"Email\": \"JohnDoe123@megasys.net\",\n                            \"DriversLicenseNumber\": \"D244233\",\n                            \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n                            \"AddressLine1\": \"500 City Pkwy W\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"Orange\",\n                            \"AddressState\": \"CA\",\n                            \"AddressZipCode\": \"92868\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        },\n                        {\n                            \"CustomerNumber\": \"538\",\n                            \"CustomerType\": \"Co_Signer\",\n                            \"FirstName\": \"Hallie\",\n                            \"LastName\": \"Auer\",\n                            \"SocialSecurityNumberLast4\": \"4730\",\n                            \"Birthday\": \"09/12/1991\",\n                            \"Email\": null,\n                            \"DriversLicenseNumber\": \"Z446614\",\n                            \"PrimaryPhoneNumber\": \"(477) 773-8622\",\n                            \"AddressLine1\": \"8245 Bethel Brook\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"Gavinton\",\n                            \"AddressState\": \"IL\",\n                            \"AddressZipCode\": \"63949\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        }\n                    ]\n                },\n                {\n                    \"AccountNumber\": \"30009964\",\n                    \"ClassNumber\": \"10\",\n                    \"GetAccountSummary\": {\n                        \"OpenDate\": \"08/16/2021\",\n                        \"LoanAmount\": \"10000.00\",\n                        \"Term\": \"12\",\n                        \"Frequency\": \"Monthly\",\n                        \"Rate\": \"10.0000%\",\n                        \"MilitaryAPR\": \"9.9981%\",\n                        \"PaymentAmount\": \"879.15\",\n                        \"State\": \"IL\",\n                        \"LastPaidDate\": null,\n                        \"NextDueDate\": \"09/16/2021\",\n                        \"NextAmountDue\": \"879.15\",\n                        \"CurrentBalance\": \"10000.00\",\n                        \"UnpaidLateFees\": \"0.00\",\n                        \"UnpaidOtherFees\": \"0.00\",\n                        \"PaymentOverShortAmount\": \"0.00\",\n                        \"TotalBalance\": \"10000.00\",\n                        \"PastDueAmount\": \"0.00\",\n                        \"PayoffAmount\": \"10008.22\",\n                        \"AdminStatus\": \"A\",\n                        \"InternalStatus\": \"Active\",\n                        \"AllowPayment\": \"true\",\n                        \"AllowPaymentMessage\": null,\n                        \"BlockedFundsType\": {\n                            \"FundsType\": [\n                                \"Money_Order\",\n                                \"Cashiers_Check\",\n                                \"ACH\",\n                                \"InterPoynt\"\n                            ]\n                        },\n                        \"IBUnpaidInterest\": \"8.22\",\n                        \"IBYTDInterestPaid\": \"0.00\",\n                        \"IBTotalInterestPaid\": \"0.00\",\n                        \"LastPaymentAmount\": null,\n                        \"LastPaymentPrincipalPaid\": null,\n                        \"LastPaymentInterestPaid\": null,\n                        \"LastPaymentOtherBalancePaid\": null,\n                        \"LastPaymentEnterDate\": null,\n                        \"LastPaymentPreviousBalance\": null,\n                        \"CollateralDescription\": \"2015 honda civci\",\n                        \"CollateralVehicleYear\": \"2015\",\n                        \"CollateralVehicleMake\": \"honda\",\n                        \"CollateralVehicleModel\": \"civci\",\n                        \"CollateralVIN\": \"dsfsd342\",\n                        \"AccountType\": \"Interest_Bearing_Direct\",\n                        \"NextPaymentDueDate\": \"09/16/2021\"\n                    },\n                    \"GetBranchSummary\": {\n                        \"Name\": \"Co. 10 East Magdalenastad\",\n                        \"Number\": \"90\",\n                        \"BranchPhoneNumber\": null\n                    },\n                    \"GetBorrowerSummary\": [\n                        {\n                            \"CustomerNumber\": \"360\",\n                            \"CustomerType\": \"Primary_Customer\",\n                            \"FirstName\": \"Mary\",\n                            \"LastName\": \"Jane\",\n                            \"SocialSecurityNumberLast4\": \"2295\",\n                            \"Birthday\": \"05/24/1971\",\n                            \"Email\": null,\n                            \"DriversLicenseNumber\": \"A455592\",\n                            \"PrimaryPhoneNumber\": \"(949) 999-9999\",\n                            \"AddressLine1\": \"432 Kennith Rd\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"East Meggieton\",\n                            \"AddressState\": \"IL\",\n                            \"AddressZipCode\": \"92936\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        },\n                        {\n                            \"CustomerNumber\": \"158\",\n                            \"CustomerType\": \"Spouse\",\n                            \"FirstName\": \"Michael\",\n                            \"LastName\": \"Smith\",\n                            \"SocialSecurityNumberLast4\": \"2915\",\n                            \"Birthday\": null,\n                            \"Email\": null,\n                            \"DriversLicenseNumber\": null,\n                            \"PrimaryPhoneNumber\": \"(949) 999-9999\",\n                            \"AddressLine1\": \"767 Crawford Ave\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"New Gloriaberg\",\n                            \"AddressState\": \"RI\",\n                            \"AddressZipCode\": \"85842\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        },\n                        {\n                            \"CustomerNumber\": \"656\",\n                            \"CustomerType\": \"Co_Signer\",\n                            \"FirstName\": \"John\",\n                            \"LastName\": \"Doe\",\n                            \"SocialSecurityNumberLast4\": \"1111\",\n                            \"Birthday\": \"07/29/1997\",\n                            \"Email\": \"JohnDoe123@megasys.net\",\n                            \"DriversLicenseNumber\": \"D244233\",\n                            \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n                            \"AddressLine1\": \"500 City Pkwy W\",\n                            \"AddressLine2\": null,\n                            \"AddressLine3\": null,\n                            \"AddressCity\": \"Orange\",\n                            \"AddressState\": \"CA\",\n                            \"AddressZipCode\": \"92868\",\n                            \"MilitaryActiveDuty\": \"False\"\n                        }\n                    ]\n                },\n                {\n                    \"AccountNumber\": \"30006354\",\n                    \"ClassNumber\": \"11\",\n                    \"GetAccountSummary\": {\n                        \"OpenDate\": \"06/22/2018\",\n                        \"LoanAmount\": \"500.00\",\n                        \"Term\": \"12\",\n                        \"Frequency\": \"Monthly\",\n                        \"Rate\": \"0.0000%\",\n                        \"MilitaryAPR\": \"94.9953%\",\n                        \"PaymentAmount\": \"66.06\",\n                        \"State\": \"IL\",\n                        \"LastPaidDate\": \"02/15/2019\",\n                        \"NextDueDate\": \"11/22/2018\",\n                        \"NextAmountDue\": \"667.74\",\n                        \"CurrentBalance\": \"417.62\",\n                        \"UnpaidLateFees\": \"50.00\",\n                        \"UnpaidOtherFees\": \"0.00\",\n                        \"PaymentOverShortAmount\": \"30.82\",\n                        \"TotalBalance\": \"467.62\",\n                        \"PastDueAmount\": \"667.74\",\n                        \"PayoffAmount\": \"667.74\",\n                        \"AdminStatus\": \"A\",\n                        \"InternalStatus\": \"Active\",\n                        \"AllowPayment\": \"true\",\n                        \"AllowPaymentMessage\": null,\n                        \"BlockedFundsType\": {\n                            \"FundsType\": [\n                                \"Money_Order\",\n                                \"Cashiers_Check\",\n                                \"ACH\",\n                                \"InterPoynt\"\n                            ]\n                        },\n                        \"IBUnpaidInterest\": \"200.12\",\n                        \"IBYTDInterestPaid\": \"0.00\",\n                        \"IBTotalInterestPaid\": \"212.68\",\n                        \"LastPaymentAmount\": \"66.00\",\n                        \"LastPaymentPrincipalPaid\": \"0.00\",\n                        \"LastPaymentInterestPaid\": \"36.00\",\n                        \"LastPaymentOtherBalancePaid\": \"30.00\",\n                        \"LastPaymentEnterDate\": \"2/15/2019\",\n                        \"LastPaymentPreviousBalance\": \"417.62\",\n                        \"CollateralDescription\": null,\n                        \"CollateralVehicleYear\": null,\n                        \"CollateralVehicleMake\": null,\n                        \"CollateralVehicleModel\": null,\n                        \"CollateralVIN\": null,\n                        \"AccountType\": \"Interest_Bearing_Direct\",\n                        \"NextPaymentDueDate\": \"08/22/2021\"\n                    },\n                    \"GetBranchSummary\": {\n                        \"Name\": \"Co. 10 East Magdalenastad\",\n                        \"Number\": \"90\",\n                        \"BranchPhoneNumber\": null\n                    },\n                    \"GetBorrowerSummary\": {\n                        \"CustomerNumber\": \"656\",\n                        \"CustomerType\": \"Primary_Customer\",\n                        \"FirstName\": \"John\",\n                        \"LastName\": \"Doe\",\n                        \"SocialSecurityNumberLast4\": \"1111\",\n                        \"Birthday\": \"07/29/1997\",\n                        \"Email\": \"JohnDoe123@megasys.net\",\n                        \"DriversLicenseNumber\": \"D244233\",\n                        \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n                        \"AddressLine1\": \"500 City Pkwy W\",\n                        \"AddressLine2\": null,\n                        \"AddressLine3\": null,\n                        \"AddressCity\": \"Orange\",\n                        \"AddressState\": \"CA\",\n                        \"AddressZipCode\": \"92868\",\n                        \"MilitaryActiveDuty\": \"False\"\n                    }\n                }\n            ]\n        }\n    },\n    \"errors\": []\n}"},{"id":"a2756b25-25eb-4330-b452-ae7ce3e9db56","name":"GetAccountsByCustomerPhone - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"phone_number\": \"{{customer_phone}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountsByCustomerPhone"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|5cf2da5b-a407-4c1c-987c-b1884f0ed101|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 13 Dec 2022 22:44:56 GMT"},{"key":"Content-Length","value":"113"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error fetching accounts: Invalid phone number\"\n    ]\n}"}],"_postman_id":"9a01a42d-191d-4e13-9a3b-5bc8ef8f382b"},{"name":"AccountSummaryGet","id":"17776408-0a4c-4352-99de-5a654618e74a","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountSummary","description":"<p>This method is used to get the account basic summary detail. For quick account information access.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required int64. Omega account number</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetAccountSummary"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"436965a5-682a-443d-a40c-55a870814b3c","name":"GetAccountSummary - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountSummary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcR2V0QWNjb3VudFN1bW1hcnk=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 20:05:35 GMT"},{"key":"Content-Length","value":"584"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"GetAccountSummary\": {\n            \"OpenDate\": \"08/18/2021\",\n            \"LoanAmount\": \"10000.00\",\n            \"Term\": \"12\",\n            \"Frequency\": \"Monthly\",\n            \"Rate\": \"10.0000%\",\n            \"MilitaryAPR\": \"13.8361%\",\n            \"PaymentAmount\": \"897.18\",\n            \"State\": \"IL\",\n            \"LastPaidDate\": \"08/18/2021\",\n            \"NextDueDate\": \"10/18/2021\",\n            \"NextAmountDue\": \"497.18\",\n            \"CurrentBalance\": \"8907.90\",\n            \"UnpaidLateFees\": \"0.00\",\n            \"UnpaidOtherFees\": \"0.00\",\n            \"PaymentOverShortAmount\": \"400.00\",\n            \"TotalBalance\": \"8907.90\",\n            \"PastDueAmount\": \"0.00\",\n            \"PayoffAmount\": \"8906.90\",\n            \"AdminStatus\": \"A\",\n            \"InternalStatus\": \"Active\",\n            \"AllowPayment\": \"true\",\n            \"AllowPaymentMessage\": null,\n            \"BlockedFundsType\": {\n                \"FundsType\": [\n                    \"Money_Order\",\n                    \"Cashiers_Check\",\n                    \"ACH\",\n                    \"InterPoynt\",\n                    \"ExpiTrans_ACH\"\n                ]\n            },\n            \"IBUnpaidInterest\": \"0.00\",\n            \"IBYTDInterestPaid\": \"0.00\",\n            \"IBTotalInterestPaid\": \"0.00\",\n            \"LastPaymentAmount\": \"100.00\",\n            \"LastPaymentPrincipalPaid\": \"100.00\",\n            \"LastPaymentInterestPaid\": null,\n            \"LastPaymentOtherBalancePaid\": null,\n            \"LastPaymentEnterDate\": \"8/18/2021\",\n            \"LastPaymentPreviousBalance\": \"9007.90\",\n            \"CollateralDescription\": \"2015 honda civic\",\n            \"CollateralVehicleYear\": \"2015\",\n            \"CollateralVehicleMake\": \"honda\",\n            \"CollateralVehicleModel\": \"civic\",\n            \"CollateralVIN\": \"DS921HFQ132HI98321\",\n            \"AccountType\": \"Interest_Bearing_Direct\",\n            \"NextPaymentDueDate\": \"10/18/2021\"\n        }\n    },\n    \"errors\": []\n}"},{"id":"748c2fa8-d7e9-46ce-a625-f07af5337c4d","name":"GetAccountSummary - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetAccountSummary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|352305c6-5eda-4f30-aa7c-0f97b1f8fd83|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 13 Dec 2022 22:40:24 GMT"},{"key":"Content-Length","value":"111"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error fetching account: Invalid account number\"\n    ]\n}"}],"_postman_id":"17776408-0a4c-4352-99de-5a654618e74a"},{"name":"AccountSummaryGetBulk","id":"602fe21a-ca6e-4f23-ae9c-41461b751e84","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountSummary?token={{token}}","description":"<p>Returns account summaries for one to 250 accounts. Send an array of per-account objects; each item requires <code>accountNumberOrId</code>, which accepts an account number or account <code>Id</code> (Guid). Pass <code>token</code> in the query string or use API key headers. Attempted batches return one result per account in <code>data.accounts</code>. This route reuses the single-account Get Account Summary permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountSummary"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5198ebfa-0b72-4f42-968a-e7e9b1edcf5c","name":"AccountSummaryGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"4a7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\",\n      \"errors\": [], \"warnings\": [], \"data\": {}\n    }]\n  }\n}"},{"id":"ed21e27e-683a-4d71-8b83-aaed79897c7a","name":"AccountSummaryGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"576df4d9-d21a-40c5-992b-f92257c52cfa","name":"AccountSummaryGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"602fe21a-ca6e-4f23-ae9c-41461b751e84"},{"name":"AccountFeesDataGetBulk","id":"16e23e1f-2c5d-451e-af84-412766adae1c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountFeesData?token={{token}}","description":"<p>Returns bounded fee and balance data for one to 250 accounts. Each array item requires <code>accountNumberOrId</code>, accepting an account number or account <code>Id</code> (Guid). Results are returned per account and this route reuses the single-account Account Fees Data permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetAccountFeesData"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6c61c3ce-e9a0-4d47-a523-6256faad262c","name":"AccountFeesDataGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountFeesData?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountFeesData"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"da7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"unpaid_late_fees\": 0.00, \"unpaid_other_balance\": 0.00, \"available_credit\": 500.00 }\n    }]\n  }\n}"},{"id":"8446ac61-e1b6-4a58-9967-0298c9114010","name":"AccountFeesDataGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountFeesData?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountFeesData"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"48d1f3e4-a6cd-429d-9579-1453ccd2b91c","name":"AccountFeesDataGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetAccountFeesData?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetAccountFeesData"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"16e23e1f-2c5d-451e-af84-412766adae1c"},{"name":"AcctDocUpload","id":"8613ec44-b0f0-4f91-b446-77ba5b39fac5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"file_name\": \"{{file_name}}\",\n  \"file_base64\": \"{{file_base64}}\",\n  \"stip_number\": \"{{stip_number}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/UploadAcctDoc","description":"<p>This method is used to upload an account document into the Omega system. A status ok is returned upon a successful upload.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>file_name</em></td>\n<td>The full name of the upload file with extension</td>\n</tr>\n<tr>\n<td><em>file_base64</em></td>\n<td>Required string. The base64 encoding of the file</td>\n</tr>\n<tr>\n<td><em>stip_number</em></td>\n<td>Optional int. Stipulation number to associate with the document</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","UploadAcctDoc"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e693cdc0-daf8-4580-9678-5841adf0963d","name":"UploadAcctDoc - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"file_name\": \"{{file_name}}\",\n  \"file_base64\": \"{{file_base64}}\",\n  \"stip_number\": \"{{stip_number}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/UploadAcctDoc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcVXBsb2FkQWNjdERvYw==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 22:18:26 GMT"},{"key":"Content-Length","value":"211"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"},{"id":"a4311097-cd90-47dc-9f49-d1f4832090dd","name":"UploadAcctDoc - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"file_name\": \"{{file_name}}\",\n  \"file_base64\": \"{{file_base64}}\",\n  \"stip_number\": \"{{stip_number}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/UploadAcctDoc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcVXBsb2FkQWNjdERvYw==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 22:37:00 GMT"},{"key":"Content-Length","value":"267"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error uploading doc: Your authentication token is invalid or has expired. Call the Login method to retrieve a new token.\",\n        \" at Omega.WebApp.BLL.WebServices.CustomerWSServices.UploadAcctDoc(String token, Int64 accountNumber, String fileName, String fileBase64, Nullable`1 stipNumber)\"\n    ]\n}"}],"_postman_id":"8613ec44-b0f0-4f91-b446-77ba5b39fac5"},{"name":"AcctDocUploadBulk","id":"febe0e4a-fa2e-4946-a064-7a63b567e48c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"file_name\": \"contract.pdf\",\n    \"file_base64\": \"{{file_base64}}\",\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/UploadAcctDoc?token={{token}}","description":"<h3 id=\"upload-account-document-bulk\">Upload Account Document (bulk)</h3>\n<p>Uploads one document to each of one to 250 accounts. Every item supplies <code>account_number</code>, <code>file_name</code>, and base64 <code>file_base64</code>, plus an optional <code>stip_number</code>. Like the single route this is allowed during Day End. Accounts commit independently. The route reuses the single Upload Account Document permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","UploadAcctDoc"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a8bba62e-47dc-4e42-a3e2-a200f1401a3a","name":"AcctDocUploadBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"file_name\": \"contract.pdf\",\n    \"file_base64\": \"{{file_base64}}\",\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UploadAcctDoc?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UploadAcctDoc"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"eb4a367a-5800-40e9-a612-39405abc189c","name":"AcctDocUploadBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"file_name\": \"contract.pdf\",\n    \"file_base64\": \"{{file_base64}}\",\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"file_name\": \"contract.pdf\",\n    \"file_base64\": \"{{file_base64}}\",\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UploadAcctDoc?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UploadAcctDoc"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"b420e6f3-2793-419b-a34a-369a71b34b13","name":"AcctDocUploadBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UploadAcctDoc?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UploadAcctDoc"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"ecd4cb67-09c0-4042-bb08-987396cad0fe","name":"AcctDocUploadBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UploadAcctDoc?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UploadAcctDoc"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"febe0e4a-fa2e-4946-a064-7a63b567e48c"},{"name":"AddRecurringBilling","id":"3fe61a79-6604-4d28-a712-0b8d1a837e2f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"billing_amount\": 25,\n  \"comment\": \"Monthly recurring fee\",\n  \"billing_frequency\": \"Monthly\",\n  \"next_billing_date\": \"{{next_billing_date}}\",\n  \"end_billing_date\": null,\n  \"days_after_due_date\": 0,\n  \"total_billing_periods\": null,\n  \"billing_day\": 15,\n  \"billing_day_2\": null,\n  \"confirm_reopen_closed_account\": false,\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AddRecurringBilling","description":"<h3 id=\"add-recurring-billing\">Add Recurring Billing</h3>\n<p>Creates an active recurring billing row for an account. The transaction code must be available and eligible for recurring billing. Every value below is checked by the same rules as the Recurring Billing screen and the account imports; a request that breaks one is refused with a message naming the problem, and nothing is saved.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/AddRecurringBilling</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>transaction_code</em></td>\n<td>Required string. Client transaction code. Must resolve to an available contractual-balance or other-balance transaction code.</td>\n</tr>\n<tr>\n<td><em>billing_amount</em></td>\n<td>Required decimal. Must be greater than zero, with no more than 2 decimal places.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string, up to 50 characters. Comment stored on the recurring billing row.</td>\n</tr>\n<tr>\n<td><em>billing_frequency</em></td>\n<td>Required string. One of <code>Daily</code>, <code>Weekly</code>, <code>Bi_Weekly</code>, <code>Semi_Monthly</code>, <code>Monthly</code>, <code>Bi_Monthly</code>, <code>Quarterly</code>, <code>Semi_Annually</code>, <code>Annually</code>, <code>Biennial</code>, or <code>One_Time</code> (case does not matter; a space or hyphen may replace the underscore), or its number (1 to 11). Other numbers and combined values such as <code>Monthly,Weekly</code> are refused.</td>\n</tr>\n<tr>\n<td><em>next_billing_date</em></td>\n<td>Required date. First date considered by day-end for posting the recurring billing charge. Cannot be before the account's posting start date.</td>\n</tr>\n<tr>\n<td><em>end_billing_date</em></td>\n<td>Optional date. Last date the row may post; cannot be before <code>next_billing_date</code>. Use <code>null</code> for no end date.</td>\n</tr>\n<tr>\n<td><em>days_after_due_date</em></td>\n<td>Required integer. Shown as Bill Due Days in the UI: the fee is due this many days after the billing date. Zero or greater, and no more than the frequency allows: Daily 0, Weekly 6, Bi_Weekly 13, Semi_Monthly 14, Monthly 29, Bi_Monthly 59, Quarterly 89, Semi_Annually 181, Annually 364, Biennial 729, One_Time 365.</td>\n</tr>\n<tr>\n<td><em>total_billing_periods</em></td>\n<td>Optional integer, 1 or more. Use <code>null</code> for no period limit; 0 or less is refused.</td>\n</tr>\n<tr>\n<td><em>billing_day</em></td>\n<td>Optional integer 1-31. Used by monthly-based frequencies to normalize future billing dates.</td>\n</tr>\n<tr>\n<td><em>billing_day_2</em></td>\n<td>Optional integer 1-31. Used only for <code>Semi_Monthly</code>. Requires <code>billing_day</code> when supplied.</td>\n</tr>\n<tr>\n<td><em>confirm_reopen_closed_account</em></td>\n<td>Optional boolean. If the account is closed, the server requires this to be <code>true</code> before reopening the account while saving an active recurring billing row. Charged-off accounts are not reopened by this API.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"side-effects-and-validation\">Side Effects and Validation</h4>\n<p>If the transaction code updates the account payment amount, only one active or waived recurring billing row on the account may use that kind of transaction code. The same mutex is enforced when saving or reactivating recurring billing rows.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","AddRecurringBilling"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7fff2892-4b38-4494-8ea1-dac198021616","name":"AddRecurringBilling - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"billing_amount\": 25,\n  \"comment\": \"Monthly recurring fee\",\n  \"billing_frequency\": \"Monthly\",\n  \"next_billing_date\": \"{{next_billing_date}}\",\n  \"end_billing_date\": null,\n  \"days_after_due_date\": 0,\n  \"total_billing_periods\": null,\n  \"billing_day\": 15,\n  \"billing_day_2\": null,\n  \"confirm_reopen_closed_account\": false,\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AddRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"64b83bb4-cd15-4176-8620-04413345d85a","name":"AddRecurringBilling - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"0\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"billing_amount\": 25,\n  \"comment\": \"Monthly recurring fee\",\n  \"billing_frequency\": \"Monthly\",\n  \"next_billing_date\": \"{{next_billing_date}}\",\n  \"end_billing_date\": null,\n  \"days_after_due_date\": 0,\n  \"total_billing_periods\": null,\n  \"billing_day\": 15,\n  \"billing_day_2\": null,\n  \"confirm_reopen_closed_account\": false,\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/AddRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid account number\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"3fe61a79-6604-4d28-a712-0b8d1a837e2f"},{"name":"AddRecurringBillingBulk","id":"97865517-3883-41aa-8293-2cad8bffc57a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 25,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"comment\": \"Bulk API recurring billing\",\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AddRecurringBilling?token={{token}}","description":"<h3 id=\"add-recurring-billing-bulk\">Add Recurring Billing (bulk)</h3>\n<p>Adds a recurring-billing schedule to each of one to 250 accounts. Every item supplies its own transaction code, amount, frequency, next billing date, and day-of-month options. Accounts commit independently and Day End is checked before each one. The route reuses the single Add Recurring Billing permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","AddRecurringBilling"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"31a51939-3e4b-4263-ad6c-191c6b3cd32e","name":"AddRecurringBillingBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 25,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"comment\": \"Bulk API recurring billing\",\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"1a76699e-6b9c-4e73-a426-1db55e5e7b93","name":"AddRecurringBillingBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 25,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"comment\": \"Bulk API recurring billing\",\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 25,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"comment\": \"Bulk API recurring billing\",\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"7b310bfc-442f-4540-afab-fa360a9ffb7d","name":"AddRecurringBillingBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"7ae21292-da7b-4d75-af88-c8b660cdb249","name":"AddRecurringBillingBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AddRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AddRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"97865517-3883-41aa-8293-2cad8bffc57a"},{"name":"ClassChange","id":"8d3cfd44-a7f6-475b-911b-499826a045ba","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"newClassNumberOrId\": \"{{new_class_number_or_id}}\",\n    \"newAdminStatusOrId\": \"\",\n    \"addRemarkCodeOrId\": \"\",\n    \"newInterestRate\": 12.5,\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeClass","description":"<h3 id=\"change-class\">Change Class</h3>\n<p>Changes an account's class through the same servicing transaction used by the Change Class account maintenance screen. The request supports every editable screen field: target class, optional admin status, optional remark code, and the new interest rate required for an Interest Bearing target class.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/ChangeClass</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when authenticating with a login token. Not needed when using API-key headers. <code>SessionId</code> authentication is not supported.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being updated.</td>\n</tr>\n<tr>\n<td><em>newClassNumberOrId</em></td>\n<td>Required string. Active target class number or class <code>Id</code> (Guid). Direct accounts can only use Direct classes; Indirect accounts can only use Indirect classes. An Interest Bearing account can only use another Interest Bearing class.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusOrId</em></td>\n<td>Optional string. Active servicing admin-status code or <code>Id</code> to apply with the class change. The current status and statuses outside the caller's enhanced-security access are rejected.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Active servicing remark code or <code>Id</code> to add. A code already present on the account and codes outside the caller's enhanced-security access are rejected.</td>\n</tr>\n<tr>\n<td><em>newInterestRate</em></td>\n<td>Required decimal for an Interest Bearing target class; omit it for a Precompute target class. Supply a percentage, such as <code>12.5</code> for 12.5%. The target class minimum and maximum rate rules apply.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. When omitted, the current business date is used. If supplied, it must equal the current business date, matching the screen's fixed effective date.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row version from the account record. When supplied, the call fails if another user has changed the account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The account must be Active or Active Charge-Off, must not be closed or frozen, and must pass the normal servicing transaction guards. A successful response includes the old and new class IDs and numbers, the posted rate as a percentage when applicable, the effective date, and the reference number. This HTTP request is billed and audited as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","ChangeClass"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"53b3f311-cf93-40b8-86e9-0eb847ce948d","name":"ClassChange - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"30001212\",\n    \"newClassNumberOrId\": \"15\",\n    \"newAdminStatusOrId\": \"\",\n    \"addRemarkCodeOrId\": \"\",\n    \"newInterestRate\": 12.5,\n    \"effectiveDate\": \"08/31/2026\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeClass"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"accountId\": \"11111111-1111-4111-8111-111111111111\",\n    \"accountNumber\": \"30001212\",\n    \"oldClassId\": \"22222222-2222-4222-8222-222222222222\",\n    \"oldClassNumber\": 10,\n    \"newClassId\": \"33333333-3333-4333-8333-333333333333\",\n    \"newClassNumber\": 15,\n    \"newAdminStatusId\": null,\n    \"addRemarkCodeId\": null,\n    \"newInterestRate\": 12.5,\n    \"effectiveDate\": \"08/31/2026\",\n    \"referenceNumber\": \"1000047\"\n  }\n}"},{"id":"225c3c66-1b2b-4724-a65b-c8cfec35867b","name":"ClassChange - Invalid Account Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"30001212\",\n    \"newClassNumberOrId\": \"20\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeClass"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"Cannot convert to class '20'. An Interest Bearing account can only convert to another Interest Bearing class.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"8d3cfd44-a7f6-475b-911b-499826a045ba"},{"name":"AllowReassignment","id":"0c056a7e-3a97-47fa-aa20-f9481f280137","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"allowReassignment\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/AllowReassignment","description":"<h3 id=\"allow-reassignment\">Allow Reassignment</h3>\n<p>Sets the View Account <strong>Allow Reassignment</strong> checkbox (<code>Common.Account.AllowCollectorReassignment</code>). Only the account is saved: the account log gets an \"Allow Collector Reassignment changed\" note, and account triggers run.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/AllowReassignment</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when authenticating with a login token. Not needed when using API-key headers. <code>SessionId</code> authentication is not supported.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid). The account must be activated and not purged; Closed and Charged Off accounts can be changed.</td>\n</tr>\n<tr>\n<td><em>allowReassignment</em></td>\n<td>Required boolean. <code>true</code> checks Allow Reassignment; <code>false</code> clears it. Omitting the field is rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"permissions\">Permissions</h4>\n<p>A caller signed in as a user needs <strong>Edit Assigned Collector Settings</strong>, the permission View Account uses to enable the Allow Reassignment checkbox. An API key caller (the system user) is not checked for it; API Access decides which endpoints a key may call.</p>\n<h4 id=\"response\">Response</h4>\n<p>A successful response returns <code>accountId</code>, <code>accountNumber</code>, <code>oldAllowReassignment</code>, <code>allowReassignment</code>, and <code>changed</code>. An account that already has the requested value is not changed: the response is <code>Ok</code> with <code>changed: false</code> and a warning. Errors return HTTP 400 with the reason in <code>errors</code>. This HTTP request is billed and audited as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","AllowReassignment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c39db743-8573-441d-b823-feaca6124436","name":"AllowReassignment - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"30011709\",\n    \"allowReassignment\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/AllowReassignment"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"accountId\": \"11111111-1111-4111-8111-111111111111\",\n    \"accountNumber\": \"30011709\",\n    \"oldAllowReassignment\": false,\n    \"allowReassignment\": true,\n    \"changed\": true\n  }\n}"},{"id":"beb0bab5-fcf2-49c7-a87d-518fe25babf3","name":"AllowReassignment - Account Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"allowReassignment\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/AllowReassignment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"Account not found\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"0c056a7e-3a97-47fa-aa20-f9481f280137"},{"name":"ClassChangeBulk","id":"e73a5c5b-6098-4f10-bc06-32cc7192bae1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newClassNumberOrId\": \"15\",\n        \"newAdminStatusOrId\": \"\",\n        \"addRemarkCodeOrId\": \"\",\n        \"newInterestRate\": 12.5,\n        \"effectiveDate\": \"\",\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newClassNumberOrId\": \"20\",\n        \"newAdminStatusOrId\": \"\",\n        \"addRemarkCodeOrId\": \"\",\n        \"effectiveDate\": \"\",\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeClass?token={{token}}","description":"<h3 id=\"change-class-bulk\">Change Class (bulk)</h3>\n<p>Changes classes for one to 250 accounts. Each array item supports the same fields and business rules as the single Change Class endpoint, including its own target class, optional admin status, optional remark code, percentage interest rate, effective date, and account row version.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeClass?token={{token}}</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>newClassNumberOrId</em></td>\n<td>Required string. Active target class number or class <code>Id</code> that is eligible for this account's Direct/Indirect and Interest Bearing/Precompute type.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusOrId</em></td>\n<td>Optional string. Active servicing admin-status code or <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Active servicing remark code or <code>Id</code> to add.</td>\n</tr>\n<tr>\n<td><em>newInterestRate</em></td>\n<td>Required decimal percentage when that item's target class is Interest Bearing; omit it for a Precompute target.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Uses the current business date when omitted and must equal it when supplied.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for that account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Every account commits independently, Day End is checked before each mutation, and a valid attempted batch returns HTTP 200 even when one or more account rows fail. Inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes.</p>\n<p>Because the array has no top-level token, pass the token in the query string as shown or use API key headers. This route reuses the single Change Class API Access permission and is unavailable with SessionId authentication. The complete bulk HTTP request is billed and audited as one API call, not once per account. Every repeated or retried HTTP request is another billed API call. Retrying a successful row will fail because its current class already equals the requested class.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","ChangeClass"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"8c7c1cf9-5fab-4eac-a820-174c624e8e20","name":"ClassChangeBulk - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newClassNumberOrId\": \"15\",\n    \"newInterestRate\": 12.5\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeClass?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeClass"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 1,\n    \"total\": 1,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"accountId\": \"11111111-1111-4111-8111-111111111111\",\n          \"accountNumber\": \"30001212\",\n          \"oldClassId\": \"22222222-2222-4222-8222-222222222222\",\n          \"oldClassNumber\": 10,\n          \"newClassId\": \"33333333-3333-4333-8333-333333333333\",\n          \"newClassNumber\": 15,\n          \"newAdminStatusId\": null,\n          \"addRemarkCodeId\": null,\n          \"newInterestRate\": 12.5,\n          \"effectiveDate\": \"08/31/2026\",\n          \"referenceNumber\": \"1000047\"\n        }\n      }\n    ]\n  }\n}"},{"id":"dd57204b-9ada-4c1b-8bda-423cdabeb9dc","name":"ClassChangeBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newClassNumberOrId\": \"15\",\n    \"newInterestRate\": 12.5\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"newClassNumberOrId\": \"15\",\n    \"newInterestRate\": 12.5\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeClass?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeClass"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"accountId\": \"11111111-1111-4111-8111-111111111111\",\n          \"accountNumber\": \"30001212\",\n          \"oldClassId\": \"22222222-2222-4222-8222-222222222222\",\n          \"oldClassNumber\": 10,\n          \"newClassId\": \"33333333-3333-4333-8333-333333333333\",\n          \"newClassNumber\": 15,\n          \"newAdminStatusId\": null,\n          \"addRemarkCodeId\": null,\n          \"newInterestRate\": 12.5,\n          \"effectiveDate\": \"08/31/2026\",\n          \"referenceNumber\": \"1000047\"\n        }\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"}],"_postman_id":"e73a5c5b-6098-4f10-bc06-32cc7192bae1"},{"name":"BranchChange","id":"935b621e-dde7-42d2-91e5-28fa44dbd27a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"newBranchNumberOrId\": \"{{new_branch_number}}\",\n    \"newAdminStatusOrId\": \"\",\n    \"addRemarkCodeOrId\": \"\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeBranch","description":"<h3 id=\"change-branch\">Change Branch</h3>\n<p>Changes an account's branch. Mirrors the Change Branch account maintenance screen. Optionally posts a new admin status and/or remark on the same effective date. Returns the posted account identifiers, the old and new branch IDs, the effective date used, and the generated reference number.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/ChangeBranch</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string when authenticating with a login token. Not needed when using API-key headers. <code>SessionId</code> authentication is not supported.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being updated.</td>\n</tr>\n<tr>\n<td><em>newBranchNumberOrId</em></td>\n<td>Required string. Branch number or branch <code>Id</code> (Guid) to move the account to.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusOrId</em></td>\n<td>Optional string. Admin status code or <code>Id</code> to post at the same time as the branch change. Leave blank to leave the current admin status in place.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Remark code or <code>Id</code> to attach to the branch-change action.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date of the branch change. When omitted, the current branch date is used.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div><p>This HTTP request is billed and audited as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","ChangeBranch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b7e06138-1c8a-4817-9afa-fc5b85cc7b5b","name":"ChangeBranch - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"newBranchNumberOrId\": \"{{new_branch_number}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeBranch"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"oldBranchId\": \"00000000-0000-0000-0000-000000000000\",\n        \"newBranchId\": \"00000000-0000-0000-0000-000000000000\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"referenceNumber\": \"1000047\"\n    }\n}"},{"id":"53657a52-cca0-4568-8468-6d70a6827f1b","name":"ChangeBranch - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"newBranchNumberOrId\": \"{{new_branch_number}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeBranch"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"935b621e-dde7-42d2-91e5-28fa44dbd27a"},{"name":"BranchChangeBulk","id":"3a927e4a-6509-4b3b-bad4-1763a3861b05","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newBranchNumberOrId\": \"2\",\n        \"newAdminStatusOrId\": \"\",\n        \"addRemarkCodeOrId\": \"\",\n        \"effectiveDate\": \"\",\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newBranchNumberOrId\": \"3\",\n        \"newAdminStatusOrId\": \"\",\n        \"addRemarkCodeOrId\": \"\",\n        \"effectiveDate\": \"\",\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeBranch?token={{token}}","description":"<h3 id=\"change-branch-bulk\">Change Branch (bulk)</h3>\n<p>Changes branch assignments for up to 250 accounts. Each array item is a complete <code>ChangeBranchParameter</code>, so its account, branch, admin status, remark code, effective date, and optional row version are independent from the other items.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeBranch?token={{token}}</code></p>\n<h4 id=\"request-body\">Request body</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>newBranchNumberOrId</em></td>\n<td>Required string. Branch number or branch <code>Id</code> to move the account to.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusOrId</em></td>\n<td>Optional string. Admin status code or <code>Id</code> to post at the same time.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Remark code or <code>Id</code> to attach to the branch-change action.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Uses the current branch date when omitted.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for this account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers. This route reuses the single-account Change Branch API Access permission and is unavailable with SessionId authentication.</p>\n<h4 id=\"paynearme-settlement-banks\">PayNearMe settlement banks</h4>\n<p>Moving an account between branches whose PayNearMe settlement banks differ makes one outbound PayNearMe call for that account. Those calls share this request's 250-account limit; there is no separate ceiling on them. Accounts that do not need a call — clients without PayNearMe, branches sharing a settlement bank, or accounts with no PayNearMe order — make none, which is the common case.</p>\n<p>A connection or vendor failure never fails the branch change, which has already committed. The account returns <code>status: \"Succeeded\"</code> with the failure as a warning in its own row, so it can be corrected directly. Re-sending the same request will not retry the sync: the branch change is already applied, so that item would fail with \"Current branch is the same as the new branch\".</p>\n<p>A batch where many accounts each need a call is as slow as those calls make it. Size batches with that in mind rather than relying on the 250 cap alone.</p>\n<p>A valid attempted batch returns HTTP 200; inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes. Each account commits independently. One bulk request is billed as one API call, not once per account. Every repeated or retried HTTP request is another billed API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","ChangeBranch"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"81849a38-67ec-4256-8948-45e5b7b98147","name":"BranchChangeBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newBranchNumberOrId\": \"2\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeBranch?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeBranch"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"accountId\":\"11111111-1111-4111-8111-111111111111\",\"accountNumber\":\"30001212\",\"oldBranchId\":\"22222222-2222-4222-8222-222222222222\",\"newBranchId\":\"33333333-3333-4333-8333-333333333333\",\"effectiveDate\":\"08/26/2026\",\"referenceNumber\":\"1001\"}}]}}"},{"id":"a626a02d-ba05-41f1-8e6d-b54401f2ff9c","name":"BranchChangeBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newBranchNumberOrId\": \"2\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"newBranchNumberOrId\": \"2\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeBranch?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeBranch"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"accountId\": \"11111111-1111-4111-8111-111111111111\",\n          \"accountNumber\": \"30001212\",\n          \"oldBranchId\": \"22222222-2222-4222-8222-222222222222\",\n          \"newBranchId\": \"33333333-3333-4333-8333-333333333333\",\n          \"effectiveDate\": \"08/26/2026\",\n          \"referenceNumber\": \"1001\"\n        }\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"9cca4135-8e61-4435-92c7-8f2e39c463dd","name":"BranchChangeBulk - PayNearMe Sync Failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newBranchNumberOrId\": \"2\"\n  },\n  {\n    \"accountNumberOrId\": \"30001299\",\n    \"newBranchNumberOrId\": \"2\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeBranch?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeBranch"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 2,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"accountId\": \"11111111-1111-4111-8111-111111111111\",\n          \"accountNumber\": \"30001212\",\n          \"oldBranchId\": \"22222222-2222-4222-8222-222222222222\",\n          \"newBranchId\": \"33333333-3333-4333-8333-333333333333\",\n          \"effectiveDate\": \"08/26/2026\",\n          \"referenceNumber\": \"1001\"\n        }\n      },\n      {\n        \"accountNumber\": 30001299,\n        \"accountNumberOrId\": \"30001299\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [\n          \"The branch change succeeded but the PayNearMe settlement bank was not updated: The remote server returned an error: (503) Service Unavailable.\"\n        ],\n        \"data\": {\n          \"accountId\": \"44444444-4444-4444-8444-444444444444\",\n          \"accountNumber\": \"30001299\",\n          \"oldBranchId\": \"22222222-2222-4222-8222-222222222222\",\n          \"newBranchId\": \"33333333-3333-4333-8333-333333333333\",\n          \"effectiveDate\": \"08/26/2026\",\n          \"referenceNumber\": \"1051\"\n        }\n      }\n    ]\n  }\n}"},{"id":"8eca5212-636c-4e2e-a80f-30b0eaad88a6","name":"BranchChangeBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeBranch?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeBranch"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"ceb46cab-46ee-4ce1-b3e2-6ab128511a7f","name":"BranchChangeBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeBranch?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeBranch"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"3a927e4a-6509-4b3b-bad4-1763a3861b05"},{"name":"CancelRecurringBilling","id":"181a9abf-d2b6-4491-9e85-2fd756e56180","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CancelRecurringBilling","description":"<h3 id=\"cancel-recurring-billing\">Cancel Recurring Billing</h3>\n<p>Cancels a recurring billing row for an account. The row must belong to the supplied account. The server records the cancelling user and the client-date cancellation timestamp.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/CancelRecurringBilling</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>recurring_billing_id</em></td>\n<td>Required Guid. Recurring billing row to cancel. Must belong to the supplied account.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","CancelRecurringBilling"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"aa653007-7e4c-410d-87ac-9ce1fb027384","name":"CancelRecurringBilling - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CancelRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e625b1ad-e52f-45e4-b1e9-a092fdbbdecb","name":"CancelRecurringBilling - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"recurring_billing_id\": \"00000000-0000-0000-0000-000000000000\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CancelRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Recurring billing record not found for the specified account\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"181a9abf-d2b6-4491-9e85-2fd756e56180"},{"name":"WaiveRecurringBilling","id":"8ca10ad7-55dd-482a-bfd1-3ae16094d0d1","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/WaiveRecurringBilling","description":"<h3 id=\"waive-recurring-billing\">Waive Recurring Billing</h3>\n<p>Waives an active recurring billing row. Each waived period still posts, with a matching credit on the same due date, and the row keeps advancing. The row must belong to the supplied account. The account log records the user and the client-date timestamp.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/WaiveRecurringBilling</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>recurring_billing_id</em></td>\n<td>Required Guid. Active recurring billing row to waive. Must belong to the supplied account.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Client-owned records must belong to the authenticated client.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","WaiveRecurringBilling"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8410de87-2098-4250-b405-304cab5d1aa1","name":"WaiveRecurringBilling - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/WaiveRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"8ca10ad7-55dd-482a-bfd1-3ae16094d0d1"},{"name":"ActivateRecurringBilling","id":"2622d50b-c5e7-441f-897b-97b7b7eb9ec2","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ActivateRecurringBilling","description":"<h3 id=\"activate-recurring-billing\">Activate Recurring Billing</h3>\n<p>Activates a waived recurring billing row from its current next billing date. Waived periods are not billed later. The row must belong to the supplied account. The account log records the user and the client-date timestamp.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/ActivateRecurringBilling</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>recurring_billing_id</em></td>\n<td>Required Guid. Waived recurring billing row to activate. Must belong to the supplied account.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Client-owned records must belong to the authenticated client.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","ActivateRecurringBilling"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6089c63a-8a5b-4685-a3ce-e1b13bd56606","name":"ActivateRecurringBilling - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ActivateRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"2622d50b-c5e7-441f-897b-97b7b7eb9ec2"},{"name":"CancelRecurringBillingBulk","id":"3f49c6bb-3275-448a-9146-1b3e3511fe34","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/CancelRecurringBilling?token={{token}}","description":"<h3 id=\"cancel-recurring-billing-bulk\">Cancel Recurring Billing (bulk)</h3>\n<p>Cancels one recurring-billing schedule on each of one to 250 accounts. Every item supplies <code>account_number</code> and the <code>recurring_billing_id</code> to cancel; a schedule that does not belong to the supplied account is reported as that account's own failure. Accounts commit independently and Day End is checked before each one. The route reuses the single Cancel Recurring Billing permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","CancelRecurringBilling"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"88ad77c3-314b-4b96-84f2-e3945f7875a0","name":"CancelRecurringBillingBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CancelRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CancelRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"d6251469-cb77-4bd0-8d4f-1fd19f49b0fa","name":"CancelRecurringBillingBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CancelRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CancelRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"58572b6d-5456-46a2-ab4c-3d3d37950376","name":"CancelRecurringBillingBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CancelRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CancelRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"114ceb3a-e2c1-409f-8be6-df7f933afeae","name":"CancelRecurringBillingBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CancelRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CancelRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"3f49c6bb-3275-448a-9146-1b3e3511fe34"},{"name":"CloseOutPayoff","id":"20cd2aaf-f185-413c-82a7-a510a01eede4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"payoffDate\": \"{{payoff_date}}\",\n    \"insuranceRefundReason\": \"Regular_Or_Early_Payoff\",\n    \"includeFutureLateFees\": false,\n    \"includePendingRepoFees\": false,\n    \"saveToNotes\": false,\n    \"actionCodeOrId\": \"\",\n    \"note\": \"\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CloseOut/Payoff","description":"<h3 id=\"close-out---payoff\">Close Out - Payoff</h3>\n<p>Calculates a payoff quote for an account and optionally writes the quote to the account log. Mirrors the pipeline used by <code>PayoffAccount.aspx</code>. Returns the payoff breakdown (current balance, sub-accounts, late fees, finance charge rebate, insurance refund, net payoff, per diem) so a caller can render the same figures shown on the Payoff Account screen.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/CloseOut/Payoff</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being quoted.</td>\n</tr>\n<tr>\n<td><em>payoffDate</em></td>\n<td>Required date. Effective date for the payoff calculation. Must be on or after the posting start date and the last financial transaction date.</td>\n</tr>\n<tr>\n<td><em>insuranceRefundReason</em></td>\n<td>Optional string. One of the <code>InsuranceRefundReasons</code> enum names (defaults to <code>Regular_Or_Early_Payoff</code>).</td>\n</tr>\n<tr>\n<td><em>includeFutureLateFees</em></td>\n<td>Optional boolean. When <code>true</code>, includes future scheduled late fees in the quote.</td>\n</tr>\n<tr>\n<td><em>includePendingRepoFees</em></td>\n<td>Optional boolean. When <code>true</code>, includes pending repossession storage and other repo fees.</td>\n</tr>\n<tr>\n<td><em>saveToNotes</em></td>\n<td>Optional boolean. When <code>true</code>, writes the payoff quote to the account log using the supplied action code.</td>\n</tr>\n<tr>\n<td><em>actionCodeOrId</em></td>\n<td>Conditional string. Action code or <code>Id</code> to attach to the account log entry. Required when <code>saveToNotes</code> is <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>note</em></td>\n<td>Optional string. Free-form note prepended to the generated payoff log entry.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","CloseOut","Payoff"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0a570b34-a4cc-4b6e-bf8e-cb69aed0cef6","name":"CloseOutPayoff - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"payoffDate\": \"{{payoff_date}}\",\n    \"insuranceRefundReason\": \"Regular_Or_Early_Payoff\",\n    \"includeFutureLateFees\": false,\n    \"includePendingRepoFees\": false,\n    \"saveToNotes\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CloseOut/Payoff"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"payoffDate\": \"04/18/2026\",\n        \"firstDue\": \"05/15/2024\",\n        \"nextDue\": \"05/15/2026\",\n        \"originalTerm\": 60,\n        \"remainingTerm\": 36,\n        \"dealerCode\": \"DLR001\",\n        \"currentBalance\": \"$12,345.67\",\n        \"subAccounts\": \"$0.00\",\n        \"lateFees\": \"$25.00\",\n        \"otherFees\": \"$0.00\",\n        \"interest\": \"$45.32\",\n        \"iva\": null,\n        \"feesInterestSubtotal\": \"$70.32\",\n        \"subtotal\": \"$12,415.99\",\n        \"financeChargeRebate\": \"N/A\",\n        \"insuranceRefund\": \"$0.00\",\n        \"cashbackSubtotal\": \"$0.00\",\n        \"netPayoff\": \"$12,415.99\",\n        \"perDiem\": \"$2.03\",\n        \"repoStorage\": \"\",\n        \"repoFees\": \"\",\n        \"otherRepoFees\": \"\",\n        \"originationFeeRebate\": \"$0.00\",\n        \"originationFees\": []\n    }\n}"},{"id":"9aa06720-be23-4753-a46c-4bd24958072c","name":"CloseOutPayoff - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"payoffDate\": \"{{payoff_date}}\",\n    \"insuranceRefundReason\": \"Regular_Or_Early_Payoff\",\n    \"includeFutureLateFees\": false,\n    \"includePendingRepoFees\": false,\n    \"saveToNotes\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CloseOut/Payoff"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"20cd2aaf-f185-413c-82a7-a510a01eede4"},{"name":"CloseOutPayoffBulk","id":"75d1fc83-124b-464f-9efa-d1c0ce241c03","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"payoffDate\": \"{{payoff_date}}\",\n    \"includeFutureLateFees\": false,\n    \"saveToNotes\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutPayoff?token={{token}}","description":"<h3 id=\"close-out-payoff-bulk\">Close Out Payoff (bulk)</h3>\n<p>Calculates a payoff quote for one to 250 accounts and, when <code>saveToNotes</code> is true, writes the quote to each account's notes. Because it can write, this route takes the Day End interlock and is checked before every account. Every item supplies its own payoff date, refund reason, and fee options. The route reuses the single Close Out Payoff permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","CloseOutPayoff"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7cef531f-9e69-4145-9742-4ce4f1360d01","name":"CloseOutPayoffBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"payoffDate\": \"{{payoff_date}}\",\n    \"includeFutureLateFees\": false,\n    \"saveToNotes\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"payoffAmount\":10450.22}}]}}"},{"id":"92fe15d4-94b8-47e4-b50e-1740caa09d47","name":"CloseOutPayoffBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"payoffDate\": \"{{payoff_date}}\",\n    \"includeFutureLateFees\": false,\n    \"saveToNotes\": false\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"payoffDate\": \"{{payoff_date}}\",\n    \"includeFutureLateFees\": false,\n    \"saveToNotes\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"payoffAmount\":10450.22}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"a9087d84-ec11-43c3-a39b-2efa5b395e3c","name":"CloseOutPayoffBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"53d787c4-f035-4fcc-876d-79467e5504ff","name":"CloseOutPayoffBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutPayoff?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutPayoff"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"75d1fc83-124b-464f-9efa-d1c0ce241c03"},{"name":"CloseOutUnwind","id":"bac4db65-f9ce-4909-b226-1bc9a2020f1a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"closeOutCodeOrId\": \"{{close_out_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"comment\": \"Unwound via API\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CloseOut/Unwind","description":"<h3 id=\"close-out---unwind\">Close Out - Unwind</h3>\n<p>Unwinds an account using the close-out pipeline shared with <code>UnwindAccount.aspx</code>. Resolves the unwind close-out code (falling back to the class default of type <code>Unwind</code>), runs <code>CalculateCloseOut</code> and posts the resulting transaction through <code>GenericAccountTransaction</code>. Returns the account identifiers and the posted transaction's reference numbers.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/CloseOut/Unwind</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> to unwind.</td>\n</tr>\n<tr>\n<td><em>closeOutCodeOrId</em></td>\n<td>Optional string. Close-out code or <code>Id</code> to use. Must be of type <code>Unwind</code>. When omitted, the account class's default unwind code is used.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusOrId</em></td>\n<td>Optional string. Administrative status code or <code>Id</code> applied to the account after unwind.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Free-form comment stored with the unwind transaction.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date for the unwind. Defaults to the current business date.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","CloseOut","Unwind"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"14b822fc-e8ad-42c8-9fb2-4e148335681f","name":"CloseOutUnwind - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"closeOutCodeOrId\": \"{{close_out_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"comment\": \"Unwound via API\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CloseOut/Unwind"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"closeOutCode\": \"UNW\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"referenceNumbers\": [\"1000045\"]\n    }\n}"},{"id":"be7c1c3e-2fd8-4345-b182-5d47dbdb87ab","name":"CloseOutUnwind - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"closeOutCodeOrId\": \"{{close_out_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"comment\": \"Unwound via API\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/CloseOut/Unwind"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"bac4db65-f9ce-4909-b226-1bc9a2020f1a"},{"name":"CloseOutUnwindBulk","id":"c8b3fcef-67f8-4f3c-a85f-533d662fb696","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"closeOutCodeOrId\": \"{{close_out_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"comment\": \"Bulk API unwind\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutUnwind?token={{token}}","description":"<h3 id=\"close-out-unwind-bulk\">Close Out Unwind (bulk)</h3>\n<p>Unwinds one to 250 accounts through the same close-out pipeline as the single route. Every item supplies its own close-out code, admin status, comment, effective date, and <code>accountTs</code>. Accounts commit independently and Day End is checked before each one. The route reuses the single Close Out Unwind permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","CloseOutUnwind"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fc362183-099e-48e6-8452-7d96d77b99f4","name":"CloseOutUnwindBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"closeOutCodeOrId\": \"{{close_out_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"comment\": \"Bulk API unwind\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutUnwind?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutUnwind"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"3e1a0cfb-4565-498e-94ba-300a163adbfb","name":"CloseOutUnwindBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"closeOutCodeOrId\": \"{{close_out_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"comment\": \"Bulk API unwind\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"closeOutCodeOrId\": \"{{close_out_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"comment\": \"Bulk API unwind\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutUnwind?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutUnwind"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"91d37c30-ad9a-4a5f-9e5c-abfa70e3aa09","name":"CloseOutUnwindBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutUnwind?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutUnwind"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"c034ab2f-3947-45cf-9a40-1f50aa4b5403","name":"CloseOutUnwindBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/CloseOutUnwind?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","CloseOutUnwind"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"c8b3fcef-67f8-4f3c-a85f-533d662fb696"},{"name":"CollateralLinkedDocumentsGet","id":"2390481b-68cc-46ef-bd0e-13f5b30737af","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{{account_number_or_id}}/Collateral/{{collateral_id}}","description":"<h3 id=\"get-collateral-linked-documents\">Get Collateral Linked Documents</h3>\n<p>Returns every <code>Common.AccountLinkedDocument</code> row attached to a specific collateral record on the specified account. Wraps <code>AccountLinkedDocumentWSServices.ReturnCollateralLinkedDocumentsWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountLinkedDocumentServices.ReturnCollateralLinkedDocuments(accountId, databaseName, collateralId)</code>. Data is returned as a <code>DataTable</code> serialized to JSON with one row per linked document.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLinkedDocument/{accountNumberOrId}/Collateral/{collateralId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n<tr>\n<td><em>collateralId</em></td>\n<td>Required Guid. Primary key of the <code>Common.Collateral</code> row whose linked documents should be returned. Must parse as a Guid; otherwise the controller returns <code>BadRequest</code> with the standard invalid parameter message.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLinkedDocument","{{account_number_or_id}}","Collateral","{{collateral_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"158971c7-9433-4a9e-bf9a-ac12b730beb1","name":"GetCollateralLinkedDocuments - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/30001212/Collateral/00000000-0000-0000-0000-000000000020"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000011\",\n            \"Description\": \"Vehicle Title\",\n            \"Location\": \"s3://omega-docs/20260402-title.pdf\",\n            \"FileSize\": 81920,\n            \"DocumentSource\": 1,\n            \"ViewOption\": 0,\n            \"CollateralId\": \"00000000-0000-0000-0000-000000000020\",\n            \"CustomerId\": null,\n            \"MergeFormId\": null,\n            \"CreationBranchDate\": \"2026-04-02T09:30:00\"\n        }\n    ]\n}"},{"id":"87ad0646-c597-4bab-92bf-f3ce61dec822","name":"GetCollateralLinkedDocuments - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/99999999/Collateral/00000000-0000-0000-0000-000000000020"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"2390481b-68cc-46ef-bd0e-13f5b30737af"},{"name":"CollateralLinkedDocumentsGetBulk","id":"e44b16f0-0acd-46f9-a702-bc773bf26eb8","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"collateralId\": \"{{collateral_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralLinkedDocuments?token={{token}}","description":"<h3 id=\"get-collateral-linked-documents-bulk\">Get Collateral Linked Documents (bulk)</h3>\n<p>Returns linked-document metadata for one collateral record on each of one to 250 accounts. Every item requires <code>accountNumberOrId</code> and a <code>collateralId</code> that is a valid ID (GUID); the single route rejects a malformed collateral ID as a bad request, so bulk validates the whole request the same way before any account is read. The route reuses the single Get Collateral Linked Documents permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetCollateralLinkedDocuments"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ad89b012-562b-4c5d-a960-2c5784a78187","name":"CollateralLinkedDocumentsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralId\": \"{{collateral_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetCollateralLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"id\":\"55555555-5555-4555-8555-555555555555\",\"description\":\"Title\"}]}]}}"},{"id":"41cb0de0-3480-4870-bf04-c61ad8324967","name":"CollateralLinkedDocumentsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"collateralId\": \"{{collateral_id}}\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"collateralId\": \"{{collateral_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetCollateralLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [{\"id\":\"55555555-5555-4555-8555-555555555555\",\"description\":\"Title\"}]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"c6ff5bfb-a2a7-4782-97d8-5cef623c02c2","name":"CollateralLinkedDocumentsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetCollateralLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"a3ff522e-67e5-401c-a75f-476035873b92","name":"CollateralLinkedDocumentsGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetCollateralLinkedDocuments?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetCollateralLinkedDocuments"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"e44b16f0-0acd-46f9-a702-bc773bf26eb8"},{"name":"CollectionNotesImport","id":"875d4db0-c52d-4026-a20b-ee56b271de37","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"collection_notes_import_xml_data\": \"{{collection_notes_import_xml_data}}\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/ImportCollectionNotes","description":"<p>This method is used to import one or more account notes into the Omega system. A status ok is returned upon a successful upload.</p>\n<p>Import Schema:</p>\n<p><code>https://[base_url]/Schemas/Import/ImportCollectionNotes.xsd</code></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>collection_notes_import_xml_data</em></td>\n<td>Required string. The collection note data, in XML format, and adhering to the Import Collection Notes schema. The import data must be URL encoded before setting the field</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","ImportCollectionNotes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"767ff899-52c1-4f00-a7ac-74aaef7f9805","name":"ImportCollectionNotes - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n\t\"collection_notes_import_xml_data\":\"{{collection_notes_import_xml_data}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ImportCollectionNotes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcSW1wb3J0Q29sbGVjdGlvbk5vdGVz?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 21:37:17 GMT"},{"key":"Content-Length","value":"76"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"Success\",\n    \"errors\": []\n}"},{"id":"cd2bd5d1-fe7a-49b5-8614-3fb08b6be9e9","name":"ImportCollectionNotes - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"collectionNotesImportXMLData\": \"{{collection_notes_import_xml_data}}\"\n}\n/*\n{\n    \"token\": \"{{token}}\",\n    \"collectionNotesImportXMLData\": [\n        {\n            \"AccountLogNotes\": [\n                {\n                    \"AccountLog\": [\n                        {\n                            \"AccountNumber\": \"{{account_number}}\",\n                            \"LogNote\": [\n                                {\n                                    \"ActionCode\": \"CC\",\n                                    \"ResultCode\": \"NF\",\n                                    \"Notes\": \"NeedFaxNumberUrgently\",\n                                    \"NoteDateTime\": \"2021-08-18T15:00:00\",\n                                    \"CreatedByUserName\": \"{{user_name}}\",\n                                    \"IsActiveAlert\": \"true\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n*/\n/*\n<AccountLogNotes>\n    <AccountLog>\n      <AccountNumber>30019999</AccountNumber>\n      <LogNote>\n        <ActionCode>CC</ActionCode>\n        <ResultCode>NF</ResultCode>\n        <Notes>NeedFaxNumberUrgently</Notes>\n        <NoteDateTime>2021-08-18T15:00:00</NoteDateTime>\n        <CreatedByUserName>developer</CreatedByUserName>\n        <IsActiveAlert>true</IsActiveAlert>\n      </LogNote>\n    </AccountLog>\n</AccountLogNotes>\n*/","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/ImportCollectionNotes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|43def523-e459-437d-8430-3c6f08666801|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 03 Dec 2022 17:03:27 GMT"},{"key":"Content-Length","value":"125"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error importing notes: Value cannot be null.\\r\\nParameter name: s\"\n    ]\n}"}],"_postman_id":"875d4db0-c52d-4026-a20b-ee56b271de37"},{"name":"ContractualBalancePost","id":"c4c4755e-7431-491f-adf5-d21fc6215197","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"transaction_code\": \"{{contractual_balance_transaction_code}}\",\n  \"gl_account\": \"{{gl_account}}\",\n  \"amount\": \"{{contractual_balance_trans_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostContractualBalance","description":"<p>Posts a contractual-balance (receivable) transaction on the supplied account. When <code>report_mode</code> is <code>true</code>, the transaction is calculated and validated only and is not committed.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Session id, token, or API key accepted by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required date (ISO-8601, e.g. <code>2024-01-28T00:00:00Z</code>). Posting/effective date of the transaction.</td>\n</tr>\n<tr>\n<td><em>transaction_code</em></td>\n<td>Required string. Contractual-balance transaction code configured in Omega.</td>\n</tr>\n<tr>\n<td><em>gl_account</em></td>\n<td>Optional string. Accepts either the client's General Account number or the general-ledger account GUID; blank or omitted values are treated as null.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal. Transaction amount.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Free-text comment stored with the transaction.</td>\n</tr>\n<tr>\n<td><em>report_mode</em></td>\n<td>Optional boolean (default <code>false</code>). When <code>true</code>, the transaction is previewed/validated but not posted.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostContractualBalance"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6314bd07-bffb-4a72-b1f0-43a55fdd631e","name":"PostContractualBalance - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"transaction_code\": \"{{contractual_balance_transaction_code}}\",\n  \"gl_account\": \"12345\",\n  \"amount\": \"{{contractual_balance_trans_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostContractualBalance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"current_balance\": \"$1,004.20\",\n        \"late_other_fees\": \"$140.00\",\n        \"unpaid_sub_accounts\": \"$120.00\",\n        \"total_balance\": \"$1,264.20\",\n        \"unpaid_interest\": \"$707.35\",\n        \"number_of_late_fees\": \"10\",\n        \"number_of_unpaid_sub_accounts\": \"1\",\n        \"number_of_nsfs\": \"0\",\n        \"payment_extensions\": \"0\",\n        \"over_short_amount\": \"$0.88\",\n        \"original_points_amount\": \"$0.00\",\n        \"original_acq_fee_amount\": \"$0.00\"\n    },\n    \"errors\": null\n}\n"},{"id":"9361a0fd-c597-4f99-a03a-f0ca7292026f","name":"PostContractualBalance - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"transaction_code\": \"{{contractual_balance_transaction_code}}\",\n  \"gl_account\": \"999999\",\n  \"amount\": \"{{contractual_balance_trans_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostContractualBalance"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"\"Invalid gl_account. Expected a valid GL Account number or GUID value.\""}],"_postman_id":"c4c4755e-7431-491f-adf5-d21fc6215197"},{"name":"ContractualBalancePostBulk","id":"15e71c7e-bddf-4ee7-baa5-2ccfa7ee20e3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"effective_date\": \"{{effective_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"gl_account\": \"{{gl_account}}\",\n    \"amount\": 125,\n    \"comment\": \"Bulk API adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostContractualBalance?token={{token}}","description":"<h3 id=\"post-contractual-balance-bulk\">Post Contractual Balance (bulk)</h3>\n<p>Posts a contractual-balance transaction to each of one to 250 accounts. Every item supplies its own transaction code, amount, effective date, comment, and optional GL account, so a batch may mix transaction codes. Set <code>report_mode</code> to true on an item to calculate and return the resulting balances without posting. Accounts commit independently and Day End is checked before each one. The route reuses the single Post Contractual Balance permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostContractualBalance"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a4fac830-cbf2-40fc-8955-cb61851f19a9","name":"ContractualBalancePostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"effective_date\": \"{{effective_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"gl_account\": \"{{gl_account}}\",\n    \"amount\": 125,\n    \"comment\": \"Bulk API adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostContractualBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostContractualBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"current_balance\":\"$10,575.22\",\"total_balance\":\"$10,925.22\"}}]}}"},{"id":"0b1fedd7-338b-425c-8360-3e12256acc75","name":"ContractualBalancePostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"effective_date\": \"{{effective_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"gl_account\": \"{{gl_account}}\",\n    \"amount\": 125,\n    \"comment\": \"Bulk API adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"effective_date\": \"{{effective_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"gl_account\": \"{{gl_account}}\",\n    \"amount\": 125,\n    \"comment\": \"Bulk API adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostContractualBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostContractualBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"current_balance\":\"$10,575.22\",\"total_balance\":\"$10,925.22\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"831e7eab-b51a-49c9-a20d-9bd413a8eeb4","name":"ContractualBalancePostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostContractualBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostContractualBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"3fb5347e-fead-44ec-926b-924bf74be889","name":"ContractualBalancePostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostContractualBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostContractualBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"15e71c7e-bddf-4ee7-baa5-2ccfa7ee20e3"},{"name":"DueDateChange","id":"8cebe311-677e-4fc7-bda2-c8c57b5b3e3c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"newNextDueDate\": \"{{new_next_due_date}}\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"comment\": \"\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeDueDate","description":"<h3 id=\"change-due-date\">Change Due Date</h3>\n<p>Changes an account's next due date. Mirrors the Due Date Change account maintenance screen. Returns the posted account identifiers, the old and new next-due dates, the effective date used, and the generated reference number.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/ChangeDueDate</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being updated.</td>\n</tr>\n<tr>\n<td><em>newNextDueDate</em></td>\n<td>Required date. New next-due date to assign to the account.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date of the due-date change. When omitted, the current branch date is used.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Free-form note attached to the due-date change action log entry.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-route-multiple-accounts\">Bulk route (multiple accounts)</h4>\n<p>For multiple accounts use <code>POST https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeDueDate?token={{token}}</code>. Its request body is an array of <code>ChangeDueDateParameter</code> objects, so every account can use its own due date, effective date, comment, and <code>accountTs</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Body</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>array</em></td>\n<td>One to 100 objects using the same fields documented above. <code>accountNumberOrId</code> accepts an account number or account <code>Id</code> (Guid). Duplicate accounts are collapsed and the first item is used.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-request-body-example\">Bulk request body example</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newNextDueDate\": \"06/15/2026\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"comment\": \"First account due date change\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newNextDueDate\": \"06/20/2026\",\n        \"effectiveDate\": \"04/19/2026\",\n        \"comment\": \"Second account due date change\"\n    }\n]\n</code></pre><p>Because the body is an array with no top-level <code>token</code>, pass token authentication in the query string as shown above, or use API key headers. The bulk route reuses this single-account route's API Access permission and is not available on SessionId authentication.</p>\n<p>The bulk form returns <strong>HTTP 200 for any batch that was attempted, including one where every account failed</strong> — check <code>statusCode</code>, not the HTTP status. <code>Ok</code> means all succeeded; <code>Successful_With_Error</code> means some or all did not. Per-account outcomes are in <code>data.accounts</code>, each carrying the submitted <code>accountNumberOrId</code>, the resolved <code>accountNumber</code> when found, and that account's own <code>singleStatusCode</code>, <code>errors</code>, <code>warnings</code> and <code>data</code>. Top-level <code>errors</code> is used only for a request-level failure, where nothing was attempted and the response is a 400.</p>\n<p><strong>Billing:</strong> one bulk request counts as a single API call, regardless of how many accounts it contains. The API meter is incremented once per HTTP request at authentication, so sending 100 accounts in one call is metered as 1, not 100.\nAccounts are processed one at a time and each commits independently, so a failure part-way through leaves earlier accounts committed. Re-running is safe for this operation.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","ChangeDueDate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7e94dd0c-035b-43cb-8153-c6f590948120","name":"ChangeDueDate - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"newNextDueDate\": \"{{new_next_due_date}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeDueDate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"oldNextDueDate\": \"05/15/2026\",\n        \"newNextDueDate\": \"06/15/2026\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"referenceNumber\": \"1000049\"\n    }\n}"},{"id":"5cb53ba2-2230-4357-9eb5-9aa79bcb0d06","name":"ChangeDueDate - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"newNextDueDate\": \"{{new_next_due_date}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangeDueDate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"8cebe311-677e-4fc7-bda2-c8c57b5b3e3c"},{"name":"DueDateChangeBulk","id":"29ffe70c-0e40-4697-aa35-515fdb12c0fe","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newNextDueDate\": \"06/15/2026\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"comment\": \"First account due date change\",\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newNextDueDate\": \"06/20/2026\",\n        \"effectiveDate\": \"04/19/2026\",\n        \"comment\": \"Second account due date change\",\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeDueDate?token={{token}}","description":"<h3 id=\"change-due-date-bulk\">Change Due Date (bulk)</h3>\n<p>Changes due dates for up to 250 accounts. Each array item is a complete <code>ChangeDueDateParameter</code>, so every account can use its own new due date, effective date, comment, and optional row version.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeDueDate?token={{token}}</code></p>\n<h4 id=\"request-body\">Request body</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>newNextDueDate</em></td>\n<td>Required date. New next-due date for this account.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Uses the current branch date when omitted.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional note for this account's action log entry.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for this account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers. This route reuses the single-account Change Due Date API Access permission and is unavailable with SessionId authentication.</p>\n<p>A valid attempted batch returns HTTP 200; inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes. Each account commits independently. One bulk request is billed as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","ChangeDueDate"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"0b5363dc-ab58-479d-ac89-5faff8ce8447","name":"ChangeDueDate Bulk - Partial success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newNextDueDate\": \"06/15/2026\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"comment\": \"First account due date change\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newNextDueDate\": \"06/20/2026\",\n        \"effectiveDate\": \"04/19/2026\",\n        \"comment\": \"Second account due date change\"\n    },\n    {\n        \"accountNumberOrId\": \"99999999\",\n        \"newNextDueDate\": \"06/25/2026\",\n        \"effectiveDate\": \"04/20/2026\",\n        \"comment\": \"Missing account example\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeDueDate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeDueDate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Successful_With_Error\",\n    \"result\": \"Successful With Error\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n        \"requested\": 3,\n        \"total\": 3,\n        \"succeeded\": 2,\n        \"succeededWithError\": 0,\n        \"failed\": 1,\n        \"skipped\": 0,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30001212,\n                \"accountNumberOrId\": \"30001212\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"accountNumber\": \"30001212\",\n                    \"oldNextDueDate\": \"05/15/2026\",\n                    \"newNextDueDate\": \"06/15/2026\",\n                    \"effectiveDate\": \"04/18/2026\",\n                    \"referenceNumber\": \"1000049\"\n                }\n            },\n            {\n                \"accountNumber\": 30001213,\n                \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                    \"accountNumber\": \"30001213\",\n                    \"oldNextDueDate\": \"05/20/2026\",\n                    \"newNextDueDate\": \"06/20/2026\",\n                    \"effectiveDate\": \"04/19/2026\",\n                    \"referenceNumber\": \"1000050\"\n                }\n            },\n            {\n                \"accountNumber\": 99999999,\n                \"accountNumberOrId\": \"99999999\",\n                \"status\": \"Failed\",\n                \"message\": \"Account not found\",\n                \"singleStatusCode\": \"Error\",\n                \"singleResult\": \"Error\",\n                \"errors\": [\"Account not found\"],\n                \"warnings\": [],\n                \"data\": null\n            }\n        ]\n    }\n}"},{"id":"db8b0ddc-72a6-4ee0-84d5-039e75576ab0","name":"DueDateChangeBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newNextDueDate\": \"06/15/2026\",\n    \"effectiveDate\": \"04/18/2026\",\n    \"comment\": \"Partial-error example\",\n    \"accountTs\": \"\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"newNextDueDate\": \"06/20/2026\",\n    \"effectiveDate\": \"04/19/2026\",\n    \"comment\": \"Partial-error example\",\n    \"accountTs\": \"\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeDueDate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeDueDate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"ec2c21b2-aeed-4577-9f89-3ae1ac6c3267","name":"DueDateChangeBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangeDueDate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangeDueDate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"29ffe70c-0e40-4697-aa35-515fdb12c0fe"},{"name":"ElectronicSignatureAdd","id":"9bcb046d-b4c7-42ba-978b-6f84f76b3918","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountLinkedDocumentId\": \"{{account_linked_document_id}}\",\n    \"parentId\": \"{{customer_id}}\",\n    \"hasSigned\": false,\n    \"documentId\": 1,\n    \"parentType\": 0,\n    \"signedDate\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature","description":"<h3 id=\"add-electronic-signature\">Add Electronic Signature</h3>\n<p>Creates a new <code>Common.AccountElectronicSignature</code> row linking an Omega-signed document to a signing participant (customer, Omega user, or contact). Wraps <code>AccountElectronicSignatureWSServices.AddAccountElectronicSignatureWS</code>, which calls <code>AccountDocuSignServices.AddAccountOmegaSign</code> and commits the unit of work. Returns the newly generated signature <code>Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountElectronicSignature</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountLinkedDocumentId</em></td>\n<td>Required Guid. <code>Common.AccountLinkedDocument.Id</code> of the document being signed.</td>\n</tr>\n<tr>\n<td><em>parentId</em></td>\n<td>Required Guid. <code>Id</code> of the signing participant. Meaning depends on <code>parentType</code>: the customer <code>Id</code> when <code>parentType = 0</code> (Customer), the Omega user <code>Id</code> when <code>parentType = 1</code> (Omega), or the contact <code>Id</code> when <code>parentType = 2</code> (Contact).</td>\n</tr>\n<tr>\n<td><em>hasSigned</em></td>\n<td>Required boolean. <code>true</code> once the participant has completed the signature, <code>false</code> for an outstanding (pending) signer.</td>\n</tr>\n<tr>\n<td><em>documentId</em></td>\n<td>Required int. Ordinal of the document inside the merged signing package (1-based when multiple documents are signed together).</td>\n</tr>\n<tr>\n<td><em>parentType</em></td>\n<td>Required int. <code>AccountElectronicSignaturesParentType</code> enum value: <code>0 = Customer</code>, <code>1 = Omega</code>, <code>2 = Contact</code>.</td>\n</tr>\n<tr>\n<td><em>signedDate</em></td>\n<td>Optional date. Timestamp the signature was captured. Leave null for a pending signer; set when <code>hasSigned = true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountElectronicSignature"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"eb8c6dd9-4bf4-4e26-94ea-4b414fe1d3ad","name":"AddElectronicSignature - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountLinkedDocumentId\": \"00000000-0000-0000-0000-000000000010\",\n    \"parentId\": \"00000000-0000-0000-0000-000000000100\",\n    \"hasSigned\": false,\n    \"documentId\": 1,\n    \"parentType\": 0,\n    \"signedDate\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000200\"\n    }\n}"},{"id":"4af5c738-e2e6-457f-9854-54ef005a8675","name":"AddElectronicSignature - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountLinkedDocumentId\": \"00000000-0000-0000-0000-000000000000\",\n    \"parentId\": \"00000000-0000-0000-0000-000000000100\",\n    \"hasSigned\": false,\n    \"documentId\": 1,\n    \"parentType\": 0,\n    \"signedDate\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error creating electronic signature: AccountLinkedDocument record does not exist\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"9bcb046d-b4c7-42ba-978b-6f84f76b3918"},{"name":"ElectronicSignatureByIdGet","id":"1e487544-d6be-4a05-bbc2-344ebff10f0a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/{{account_electronic_signature_id}}","description":"<h3 id=\"get-electronic-signature-by-id\">Get Electronic Signature By Id</h3>\n<p>Returns a single <code>Common.AccountElectronicSignature</code> row by its Guid primary key. Wraps <code>AccountDocuSignServices.ReturnAccountOmegaSign(databaseName, id)</code>, which performs a <code>FetchEntityUsingUniqueConstraint</code> on the <code>AccountElectronicSignatures</code> table. Returns <code>Electronic signature record not found</code> when the Guid is valid but no matching row exists.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountElectronicSignature/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountElectronicSignature</code> row to fetch. The controller returns <code>BadRequest</code> with the standard invalid parameter message when the value is blank or not a parseable Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountElectronicSignature","{{account_electronic_signature_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f15fd71e-f12a-446d-a333-658f2336cf01","name":"GetElectronicSignatureById - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/00000000-0000-0000-0000-000000000200"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000200\",\n        \"AccountLinkedDocumentId\": \"00000000-0000-0000-0000-000000000010\",\n        \"ParentId\": \"00000000-0000-0000-0000-000000000100\",\n        \"HasSigned\": true,\n        \"DocumentId\": 1,\n        \"SignedDate\": \"04/18/2026\",\n        \"ParentType\": 0,\n        \"SignLink\": null\n    }\n}"},{"id":"8e7f1123-05f5-40ee-8897-f46e333284de","name":"GetElectronicSignatureById - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/00000000-0000-0000-0000-000000000999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Electronic signature record not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"1e487544-d6be-4a05-bbc2-344ebff10f0a"},{"name":"ElectronicSignatureDelete","id":"d4719963-c029-44ef-8eb7-942acf2c90af","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/{{account_electronic_signature_id}}","description":"<h3 id=\"delete-electronic-signature\">Delete Electronic Signature</h3>\n<p>Deletes a single <code>Common.AccountElectronicSignature</code> row identified by the route <code>id</code>. Wraps <code>AccountElectronicSignatureWSServices.DeleteAccountElectronicSignatureWS</code>, which calls <code>AccountDocuSignServices.DeleteAccountOmegaSign</code>. Returns an <code>OmegaSign record does not exist</code> error when the signature cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountElectronicSignature/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountElectronicSignature</code> row to delete. Returns the standard invalid parameter message when blank or not a parseable Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountElectronicSignature","{{account_electronic_signature_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"aaf4ea9b-ab8a-4e78-a443-4db0a319cc9f","name":"DeleteElectronicSignature - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/00000000-0000-0000-0000-000000000200"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000200\",\n        \"Deleted\": true\n    }\n}"},{"id":"0033132f-7c24-47ca-bd28-371e616e6cf0","name":"DeleteElectronicSignature - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/00000000-0000-0000-0000-000000000999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error deleting electronic signature: OmegaSign record does not exist\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d4719963-c029-44ef-8eb7-942acf2c90af"},{"name":"ElectronicSignaturesByDocumentGet","id":"bd57109c-7f56-4fdd-bf73-40ca7ad9b421","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/ByDocument/{{account_linked_document_id}}","description":"<h3 id=\"get-electronic-signatures-by-document\">Get Electronic Signatures By Document</h3>\n<p>Returns every <code>Common.AccountElectronicSignature</code> row linked to a given account document (signed and unsigned). Wraps <code>AccountDocuSignServices.ReturnSignedCustomers</code>, which filters <code>CommonAccountElectronicSignatureFields.AccountLinkedDocumentId</code> against the supplied Guid. Useful for rendering the participant list on an OmegaSign package along with their current signed/unsigned status.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountElectronicSignature/ByDocument/{accountLinkedDocumentId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountLinkedDocumentId</em></td>\n<td>Required Guid. <code>Common.AccountLinkedDocument.Id</code> identifying the signed document package. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank or not a parseable Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountElectronicSignature","ByDocument","{{account_linked_document_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a01f13f7-bee9-418b-952f-68430dcded2d","name":"GetElectronicSignaturesByDocument - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/ByDocument/00000000-0000-0000-0000-000000000010"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000200\",\n            \"AccountLinkedDocumentId\": \"00000000-0000-0000-0000-000000000010\",\n            \"ParentId\": \"00000000-0000-0000-0000-000000000100\",\n            \"HasSigned\": true,\n            \"DocumentId\": 1,\n            \"SignedDate\": \"04/18/2026\",\n            \"ParentType\": 0,\n            \"SignLink\": null\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000201\",\n            \"AccountLinkedDocumentId\": \"00000000-0000-0000-0000-000000000010\",\n            \"ParentId\": \"00000000-0000-0000-0000-000000000101\",\n            \"HasSigned\": false,\n            \"DocumentId\": 1,\n            \"SignedDate\": null,\n            \"ParentType\": 0,\n            \"SignLink\": \"https://sign.example.com/session/abc123\"\n        }\n    ]\n}"},{"id":"01dc75ef-1e20-48a2-9c65-e881e25a4fed","name":"GetElectronicSignaturesByDocument - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/ByDocument/not-a-valid-guid"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"\"Invalid parameter data\""}],"_postman_id":"bd57109c-7f56-4fdd-bf73-40ca7ad9b421"},{"name":"ElectronicSignatureUpdate","id":"28e82714-d2c3-4a15-8377-a74b4156ec53","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountLinkedDocumentId\": \"{{account_linked_document_id}}\",\n    \"parentId\": \"{{customer_id}}\",\n    \"hasSigned\": true,\n    \"documentId\": 1,\n    \"signedDate\": \"{{signed_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/{{account_electronic_signature_id}}","description":"<h3 id=\"update-electronic-signature\">Update Electronic Signature</h3>\n<p>Updates an existing <code>Common.AccountElectronicSignature</code> row. The route <code>id</code> identifies the signature record; the controller re-fetches the row and calls <code>AccountDocuSignServices.SaveAccountOmegaSign</code> to persist the supplied fields. Returns <code>Electronic signature record not found for update</code> when the <code>id</code> does not resolve to a row for the calling client.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountElectronicSignature/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>Common.AccountElectronicSignature</code> row to update. Returns the standard invalid parameter message when blank or not a parseable Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountLinkedDocumentId</em></td>\n<td>Required Guid. <code>Common.AccountLinkedDocument.Id</code> of the document being signed.</td>\n</tr>\n<tr>\n<td><em>parentId</em></td>\n<td>Required Guid. <code>Id</code> of the signing participant (see <code>POST api/Client/Account/AccountElectronicSignature</code> for <code>parentType</code> mapping).</td>\n</tr>\n<tr>\n<td><em>hasSigned</em></td>\n<td>Required boolean. <code>true</code> once the participant has completed the signature.</td>\n</tr>\n<tr>\n<td><em>documentId</em></td>\n<td>Required int. Ordinal of the document inside the merged signing package.</td>\n</tr>\n<tr>\n<td><em>signedDate</em></td>\n<td>Required date. Timestamp the signature was captured. Persisted onto the signature row.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unlike the POST body, <code>parentType</code> is not updatable via PUT; the row keeps the value set at creation time.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountElectronicSignature","{{account_electronic_signature_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a8ca3d11-041e-4a7e-9cfb-9638d38118ab","name":"UpdateElectronicSignature - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountLinkedDocumentId\": \"00000000-0000-0000-0000-000000000010\",\n    \"parentId\": \"00000000-0000-0000-0000-000000000100\",\n    \"hasSigned\": true,\n    \"documentId\": 1,\n    \"signedDate\": \"04/18/2026\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/00000000-0000-0000-0000-000000000200"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000200\"\n    }\n}"},{"id":"b7fa0634-eb24-4389-8652-e6da3ae02c95","name":"UpdateElectronicSignature - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountLinkedDocumentId\": \"00000000-0000-0000-0000-000000000010\",\n    \"parentId\": \"00000000-0000-0000-0000-000000000100\",\n    \"hasSigned\": true,\n    \"documentId\": 1,\n    \"signedDate\": \"04/18/2026\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/00000000-0000-0000-0000-000000000999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Electronic signature record not found for update\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"28e82714-d2c3-4a15-8377-a74b4156ec53"},{"name":"Freeze","id":"7e038e7a-52c3-49dc-9401-63154a1760a9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Freeze","description":"<h3 id=\"freeze-account\">Freeze Account</h3>\n<p>Freezes an account's accruals and earnings. Mirrors the Freeze action on the View Account screen. Returns the posted account identifiers, a flag confirming the frozen state, the effective date used, and the prior freeze date if one existed.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Freeze</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being frozen.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date of the freeze. When omitted, the current branch date is used.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-route-multiple-accounts\">Bulk route (multiple accounts)</h4>\n<p>For multiple accounts use <code>POST https://{{base_url}}/api/client/account/Maintenance/Bulk/Freeze?token={{token}}</code>. Its request body is an array of <code>FreezeAccountParameter</code> objects, so every account can use its own effective date and <code>accountTs</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Body</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>array</em></td>\n<td>One to 100 objects using the same fields documented above. <code>accountNumberOrId</code> accepts an account number or account <code>Id</code> (Guid). Duplicate accounts are collapsed and the first item is used.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-request-body-example\">Bulk request body example</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveDate\": \"04/18/2026\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveDate\": \"04/19/2026\"\n    }\n]\n</code></pre><p>Because the body is an array with no top-level <code>token</code>, pass token authentication in the query string as shown above, or use API key headers. The bulk route reuses this single-account route's API Access permission and is not available on SessionId authentication.</p>\n<p>The bulk form returns <strong>HTTP 200 for any batch that was attempted, including one where every account failed</strong> — check <code>statusCode</code>, not the HTTP status. <code>Ok</code> means all succeeded; <code>Successful_With_Error</code> means some or all did not. Per-account outcomes are in <code>data.accounts</code>, each carrying the submitted <code>accountNumberOrId</code>, the resolved <code>accountNumber</code> when found, and that account's own <code>singleStatusCode</code>, <code>errors</code>, <code>warnings</code> and <code>data</code>. Top-level <code>errors</code> is used only for a request-level failure, where nothing was attempted and the response is a 400.</p>\n<p><strong>Billing:</strong> one bulk request counts as a single API call, regardless of how many accounts it contains. The API meter is incremented once per HTTP request at authentication, so sending 100 accounts in one call is metered as 1, not 100.\nAccounts are processed one at a time and each commits independently, so a failure part-way through leaves earlier accounts committed. Re-running is safe for this operation.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Freeze"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"58e9bb7f-5a45-44d1-9f4b-11b8aa37437d","name":"Freeze - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Freeze"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"frozen\": true,\n        \"effectiveDate\": \"04/18/2026\",\n        \"previousFreezeDate\": null\n    }\n}"},{"id":"7833d9ae-797c-471f-8b4d-19083e168372","name":"Freeze - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"00000000\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Freeze"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"7e038e7a-52c3-49dc-9401-63154a1760a9"},{"name":"FreezeBulk","id":"07b47cdd-7ae5-444e-916d-17a0e01cd0fa","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveDate\": \"04/19/2026\",\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Freeze?token={{token}}","description":"<h3 id=\"freeze-account-bulk\">Freeze Account (bulk)</h3>\n<p>Freezes up to 250 accounts. Each array item is a complete <code>FreezeAccountParameter</code>, so every account can use its own effective date and optional row version.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/Freeze?token={{token}}</code></p>\n<h4 id=\"request-body\">Request body</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Uses the current branch date when omitted.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for this account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers. This route reuses the single-account Freeze API Access permission and is unavailable with SessionId authentication.</p>\n<p>A valid attempted batch returns HTTP 200; inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes. Each account commits independently. One bulk request is billed as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","Freeze"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6edd8b66-c5ea-4d69-a6fd-5b38a5de83c8","name":"Freeze Bulk - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveDate\": \"04/18/2026\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveDate\": \"04/19/2026\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Freeze?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","Freeze"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n        \"requested\": 2,\n        \"total\": 2,\n        \"succeeded\": 2,\n        \"succeededWithError\": 0,\n        \"failed\": 0,\n        \"skipped\": 0,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30001212,\n                \"accountNumberOrId\": \"30001212\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"accountNumber\": \"30001212\",\n                    \"frozen\": true,\n                    \"effectiveDate\": \"04/18/2026\",\n                    \"previousFreezeDate\": null\n                }\n            },\n            {\n                \"accountNumber\": 30001213,\n                \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                    \"accountNumber\": \"30001213\",\n                    \"frozen\": true,\n                    \"effectiveDate\": \"04/19/2026\",\n                    \"previousFreezeDate\": null\n                }\n            }\n        ]\n    }\n}"},{"id":"9663701d-2268-4e02-b0ec-5982bfa4a5e2","name":"FreezeBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"effectiveDate\": \"04/18/2026\",\n    \"accountTs\": \"\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"effectiveDate\": \"04/19/2026\",\n    \"accountTs\": \"\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Freeze?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","Freeze"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"8e25f3ef-3abc-4831-87aa-7f818d0cd18e","name":"FreezeBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Freeze?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","Freeze"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"07b47cdd-7ae5-444e-916d-17a0e01cd0fa"},{"name":"GetActiveRecurringBilling","id":"a81cfd75-5e74-4a98-9a50-5b0b001b18d4","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetActiveRecurringBilling","description":"<h3 id=\"get-active-recurring-billing\">Get Active Recurring Billing</h3>\n<p>Returns only active recurring billing rows for an account. This is a convenience route over <code>GetRecurringBilling</code> that forces active-only behavior on the server.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/GetActiveRecurringBilling</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required int64. Omega account number.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetActiveRecurringBilling"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"93fc35ee-ea06-42d9-88c4-9d923b1bc452","name":"GetActiveRecurringBilling - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetActiveRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Ok\",\n    \"errors\": [],\n    \"data\": [\n        {\n            \"id\": \"00000000-0000-0000-0000-000000000000\",\n            \"transaction_code_id\": \"00000000-0000-0000-0000-000000000000\",\n            \"transaction_code\": \"RF\",\n            \"transaction_code_description\": \"Recurring Fee\",\n            \"billing_amount\": 25.00,\n            \"comment\": \"Monthly recurring fee\",\n            \"billing_frequency\": \"Monthly\",\n            \"first_billing_date\": \"2026-06-15\",\n            \"next_billing_date\": \"2026-07-15\",\n            \"last_billing_date\": \"2026-06-15\",\n            \"end_billing_date\": null,\n            \"days_after_due_date\": 0,\n            \"total_billing_periods\": null,\n            \"periods_completed\": 1,\n            \"billing_status\": \"Active\",\n            \"billing_day\": 15,\n            \"billing_day_2\": null,\n            \"last_transaction_id\": \"00000000-0000-0000-0000-000000000000\",\n            \"updates_payment_amount\": false,\n            \"created_date\": \"2026-06-01 09:30:00\"\n        }\n    ]\n}"},{"id":"73eb4adb-b258-4fda-a370-37df2dd977ee","name":"GetActiveRecurringBilling - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"0\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetActiveRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Error\",\n    \"errors\": [\n        \"Invalid account number\"\n    ],\n    \"data\": null\n}"}],"_postman_id":"a81cfd75-5e74-4a98-9a50-5b0b001b18d4"},{"name":"GetActiveRecurringBillingBulk","id":"f560ae25-147e-4eaf-9146-71a5eac56a5a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetActiveRecurringBilling?token={{token}}","description":"<p>Returns active recurring-billing records for one to 250 accounts. Each array item requires <code>accountNumberOrId</code>, accepting an account number or account <code>Id</code> (Guid). The lower cap bounds collection output. This route reuses the single-account Get Active Recurring Billing permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetActiveRecurringBilling"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"cc4215dc-528f-4bb8-a68d-e85be5fc9c79","name":"GetActiveRecurringBillingBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetActiveRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetActiveRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"ba7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [], \"data\": []\n    }]\n  }\n}"},{"id":"7b2a41e0-0a23-42f7-a1e2-c9158b61f83b","name":"GetActiveRecurringBillingBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetActiveRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetActiveRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"9ebfb7be-9d7e-493f-ac47-50c8123aed0a","name":"GetActiveRecurringBillingBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetActiveRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetActiveRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"f560ae25-147e-4eaf-9146-71a5eac56a5a"},{"name":"GetRecurringBilling","id":"44a1ca40-4c05-44ad-91a4-58764f1ca3ec","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"{{account_number}}\",\n    \"active_only\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetRecurringBilling","description":"<h3 id=\"get-recurring-billing\">Get Recurring Billing</h3>\n<p>Returns recurring billing rows for an account. Set <code>active_only</code> to <code>true</code> to return only rows with active posting status; leave it <code>false</code> to include cancelled and waived rows for account-management review.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/GetRecurringBilling</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required int64. Omega account number.</td>\n</tr>\n<tr>\n<td><em>active_only</em></td>\n<td>Optional boolean. Defaults to <code>false</code>. When <code>true</code>, returns only active recurring billing rows.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetRecurringBilling"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2f7b54d6-6a27-48f3-9dae-86c1ef522566","name":"GetRecurringBilling - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"{{account_number}}\",\n    \"active_only\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Ok\",\n    \"errors\": [],\n    \"data\": [\n        {\n            \"id\": \"00000000-0000-0000-0000-000000000000\",\n            \"transaction_code_id\": \"00000000-0000-0000-0000-000000000000\",\n            \"transaction_code\": \"RF\",\n            \"transaction_code_description\": \"Recurring Fee\",\n            \"billing_amount\": 25.00,\n            \"comment\": \"Monthly recurring fee\",\n            \"billing_frequency\": \"Monthly\",\n            \"first_billing_date\": \"2026-06-15\",\n            \"next_billing_date\": \"2026-07-15\",\n            \"last_billing_date\": \"2026-06-15\",\n            \"end_billing_date\": null,\n            \"days_after_due_date\": 0,\n            \"total_billing_periods\": null,\n            \"periods_completed\": 1,\n            \"billing_status\": \"Active\",\n            \"billing_day\": 15,\n            \"billing_day_2\": null,\n            \"last_transaction_id\": \"00000000-0000-0000-0000-000000000000\",\n            \"updates_payment_amount\": false,\n            \"allow_future_fee_assessment\": false,\n            \"created_date\": \"2026-06-01 09:30:00\",\n            \"row_version\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"fb9216f3-c479-44c5-8434-d30e7bcdee98","name":"GetRecurringBilling - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"0\",\n    \"active_only\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Error\",\n    \"errors\": [\n        \"Invalid account number\"\n    ],\n    \"data\": null\n}"}],"_postman_id":"44a1ca40-4c05-44ad-91a4-58764f1ca3ec"},{"name":"GetRecurringBillingBulk","id":"f405cfd0-b295-49fa-89bf-18f030f6e933","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"active_only\": false\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"active_only\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetRecurringBilling?token={{token}}","description":"<p>Returns recurring-billing records for one to 250 accounts. Each array item requires <code>accountNumberOrId</code> and may independently set <code>active_only</code>. Account numbers and account <code>Id</code> values (Guid) can be mixed. The lower cap bounds collection output. This route reuses the single-account Get Recurring Billing permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetRecurringBilling"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"1b101b32-e772-4b8f-8f65-b81422550009","name":"GetRecurringBillingBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"active_only\":false}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"aa7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [], \"data\": []\n    }]\n  }\n}"},{"id":"d4f6b15e-85e8-4796-bf95-69d6e3b21242","name":"GetRecurringBillingBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"active_only\": false\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"active_only\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"a0b1c1ff-92cd-4b5f-9ff0-33eff8edaf8f","name":"GetRecurringBillingBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"f405cfd0-b295-49fa-89bf-18f030f6e933"},{"name":"InsurancePolicyAdd","id":"f4f3526d-c492-4564-94d3-8697b5d31d48","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n    \"importCode\": \"CP\",\n    \"accountNumber\": \"104609\",\n    \"effectiveDate\": \"2023-01-28T00:00:00Z\",\n    \"expirationDate\": \"2024-01-28T00:00:00Z\",\n    \"premiumAmount\": 0,\n    \"policyFeeAmount\": 0,\n    \"agent\": \"Mike\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/InsurancePolicyAdd","description":"<h1 id=\"insurance-policy-add\">Insurance Policy Add</h1>\n<p>This endpoint allows the client to add an insurance policy.</p>\n<h2 id=\"request-body\">Request Body</h2>\n<ul>\n<li><code>token</code> (string): The token for authentication.</li>\n<li><code>importCode</code> (string): The import code for the insurance policy. In Omega, see Servicing -&gt; Configuration -&gt; Import Insurance Configuration</li>\n<li><code>accountNumber</code> (string): The account number associated with the policy.</li>\n<li><code>policyNumber</code> (string): The policy number of the insurance policy.</li>\n<li><code>effectiveDate</code> (string): The effective date of the policy.</li>\n<li><code>policyTerm</code> (integer): The term of the policy.</li>\n<li><code>expirationDate</code> (string): The expiration date of the policy.</li>\n<li><code>premiumAmount</code> (integer): The premium amount for the policy.</li>\n<li><code>policyFeeAmount</code> (integer): The fee amount associated with the policy.</li>\n<li><code>financeTerm</code> (integer): The finance term for the policy.</li>\n<li><code>agent</code> (string): The agent associated with the policy.</li>\n<li><code>insuredType</code> (string): The type of the insured.</li>\n</ul>\n<h2 id=\"response\">Response</h2>\n<ul>\n<li><code>statusCode</code> (integer): The status code of the response.</li>\n<li><code>result</code> (string): The result of the request.</li>\n<li><code>data</code> (string): Additional data related to the request.</li>\n<li><code>errors</code> (array of strings): Any errors encountered during the request.</li>\n</ul>\n<h3 id=\"example\">Example</h3>\n<h4 id=\"request\">Request</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"token\": \"5b665054-fdce-433a-9a11-33de6e5919c4\",\n    \"importCode\": \"CLSCPLAT6\",\n    \"accountNumber\": \"45962\",\n    \"policyNumber\": \"654321\",\n    \"effectiveDate\": \"2023-10-09T00:00:00Z\",\n    \"policyTerm\": 12,\n    \"expirationDate\": \"2024-10-08T00:00:00Z\",\n    \"premiumAmount\": 500.00,\n    \"policyFeeAmount\": 50.00,\n    \"financeTerm\": 12,\n    \"agent\": \"OptionalAgentName\",\n    \"insuredType\": \"Single\"\n}\n\n</code></pre>\n<h4 id=\"response-1\">Response</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"\",\n    \"errors\": []\n}\n\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","client","account","InsurancePolicyAdd"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fe8cb1b0-9fa5-4b8a-869d-7f0f7a4087f8","name":"InsurancePolicyAdd - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n    \"importCode\": {{import_code}},\n    \"accountNumber\": \"{{account_number}}\",\n    \"policyNumber\": \"654321\",\n    \"effectiveDate\": \"2023-10-09T00:00:00Z\",\n    \"policyTerm\": 12,\n    \"expirationDate\": \"2024-10-08T00:00:00Z\",\n    \"premiumAmount\": 500.00,\n    \"policyFeeAmount\": 50.00,\n    \"financeTerm\": 12,\n    \"agent\": \"\",\n    \"insuredType\": \"Single\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/InsurancePolicyAdd"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RTpcV29ya3NwYWNlc1xvbWVnYVxPbWVnYS5XZWJBcHBcYXBpXGNsaWVudFxJbnN1cmFuY2VQb2xpY3lBZGQ=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 15 Dec 2023 19:19:28 GMT"},{"key":"Content-Length","value":"69"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"\",\n    \"errors\": []\n}"},{"id":"450c8d6f-0b07-4843-8722-68b9b993ddcd","name":"InsurancePolicyAdd - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":true}],"body":{"mode":"raw","raw":"{\n\t\"token\": \"{{token}}\",\n    \"importCode\": \"CLSCPLAT6\",\n    \"accountNumber\": \"{{account_number}}\",\n    \"policyNumber\": \"654321\",\n    \"effectiveDate\": \"2023-10-09T00:00:00Z\",\n    \"policyTerm\": 12,\n    \"expirationDate\": \"2024-10-08T00:00:00Z\",\n    \"premiumAmount\": 500.00,\n    \"policyFeeAmount\": 50.00,\n    \"financeTerm\": 12,\n    \"agent\": \"JDF Test agent\",\n    \"insuredType\": \"Single\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/InsurancePolicyAdd"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RTpcV29ya3NwYWNlc1xvbWVnYVxPbWVnYS5XZWJBcHBcYXBpXGNsaWVudFxJbnN1cmFuY2VQb2xpY3lBZGQ=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 15 Dec 2023 19:40:48 GMT"},{"key":"Content-Length","value":"168"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": \"\",\n    \"errors\": [\n        \"Validation Error: Duplicate Insurance Policy found with Policy Status: Active, Effective Date: 10/9/2023, and Expiration Date: 10/8/2024\"\n    ]\n}"}],"_postman_id":"f4f3526d-c492-4564-94d3-8697b5d31d48"},{"name":"InsurancePolicyAddBulk","id":"fc516487-cc70-4ce9-a175-9bc40ef836dd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"premiumAmount\": 850,\n    \"policyTerm\": 12\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyAdd?token={{token}}","description":"<h3 id=\"insurance-policy-add-bulk\">Insurance Policy Add (bulk)</h3>\n<p>Adds an insurance policy to each of one to 250 accounts through the same insurance import service as the single route. Every item carries its own <code>importCode</code>, policy number, dates, and amounts. An item may identify its account with <code>account_number</code> (as the single route does) or with <code>accountNumberOrId</code>, which also accepts an account ID. Accounts commit independently and Day End is checked before each one. The route reuses the single Insurance Policy Add permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","InsurancePolicyAdd"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5a9cfac8-4f94-49fb-abc1-f61a8a5f8931","name":"InsurancePolicyAddBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"premiumAmount\": 850,\n    \"policyTerm\": 12\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyAdd?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyAdd"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":\"\"}]}}"},{"id":"66ffd7b9-523b-46ad-afbf-e915cc0e33a3","name":"InsurancePolicyAddBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"premiumAmount\": 850,\n    \"policyTerm\": 12\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"premiumAmount\": 850,\n    \"policyTerm\": 12\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyAdd?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyAdd"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": \"\"\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"7dc5d831-4735-4240-a30d-67d930a04dbb","name":"InsurancePolicyAddBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyAdd?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyAdd"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"d861461d-4358-4747-96ac-2c5b1f8b9df6","name":"InsurancePolicyAddBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyAdd?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyAdd"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"fc516487-cc70-4ce9-a175-9bc40ef836dd"},{"name":"InsurancePolicyCancel","id":"f81b4257-e4d2-4e1b-9317-c06dc77bb6ca","protocolProfileBehavior":{"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"importCode\": \"CLSCPLAT6\",\n    \"accountNumber\": \"{{account_number}}\",\n    \"policyNumber\": \"654321\",\n    \"effectiveDate\": \"2023-10-09T00:00:00Z\",\n    \"policyTerm\": 12,\n    \"expirationDate\": \"2024-10-08T00:00:00Z\",\n    \"cancelDate\": \"2023-12-13T00:00:00Z\",\n    \"premiumRefund\": 200.00,\n    \"policyFeeRefund\": 20.00\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/InsurancePolicyCancel","description":"<h3 id=\"insurance-policy-cancel\">Insurance Policy Cancel</h3>\n<p>This endpoint is used to cancel an insurance policy for a client. The HTTP POST request should be sent to <code>https://{{base_url}}/api/client/InsurancePolicyCancel</code>.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<ul>\n<li><code>token</code> (text): The authentication token.</li>\n<li><code>importCode</code> (text): The import code of the policy.</li>\n<li><code>accountNumber</code> (text): The account number associated with the policy.</li>\n<li><code>policyNumber</code> (text): The number of the insurance policy.</li>\n<li><code>effectiveDate</code> (text): The effective date of the policy.</li>\n<li><code>policyTerm</code> (number): The term of the policy.</li>\n<li><code>expirationDate</code> (text): The expiration date of the policy.</li>\n<li><code>cancelDate</code> (text): The date on which the policy is to be cancelled.</li>\n<li><code>premiumRefund</code> (number): The amount of premium refund.</li>\n<li><code>policyFeeRefund</code> (number): The amount of policy fee refund.</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<ul>\n<li><code>statusCode</code> (number): The status code of the response.</li>\n<li><code>result</code> (text): The result of the cancellation request.</li>\n<li><code>data</code> (text): Additional data related to the cancellation.</li>\n<li><code>errors</code> (array): An array of error messages, if any.</li>\n</ul>\n<h4 id=\"example\">Example</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"\",\n    \"errors\": []\n}\n\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","client","account","InsurancePolicyCancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1aadcede-e2d9-406c-b3f9-9ac2ca405b58","name":"InsurancePolicyCancel - Successes","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"importCode\": \"CLSCPLAT6\",\n    \"accountNumber\": \"{{account_number}}\",\n    \"policyNumber\": \"654321\",\n    \"effectiveDate\": \"2023-10-09T00:00:00Z\",\n    \"policyTerm\": 12,\n    \"expirationDate\": \"2024-10-08T00:00:00Z\",\n    \"cancelDate\": \"2023-12-13T00:00:00Z\",\n    \"premiumRefund\": 200.00,\n    \"policyFeeRefund\": 20.00\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/InsurancePolicyCancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RTpcV29ya3NwYWNlc1xvbWVnYVxPbWVnYS5XZWJBcHBcYXBpXGNsaWVudFxJbnN1cmFuY2VQb2xpY3lDYW5jZWw=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 15 Dec 2023 19:22:12 GMT"},{"key":"Content-Length","value":"69"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"\",\n    \"errors\": []\n}"},{"id":"19232f45-62ca-4c4e-9af3-058c95300324","name":"InsurancePolicyCancel - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"importCode\": \"CLSCPLAT6\",\n    \"accountNumber\": \"{{account_number}}\",\n    \"policyNumber\": \"654321\",\n    \"effectiveDate\": \"2023-10-09T00:00:00Z\",\n    \"policyTerm\": 12,\n    \"expirationDate\": \"2024-10-08T00:00:00Z\",\n    \"cancelDate\": \"2023-12-13T00:00:00Z\",\n    \"premiumRefund\": 200.00,\n    \"policyFeeRefund\": 20.00\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/InsurancePolicyCancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RTpcV29ya3NwYWNlc1xvbWVnYVxPbWVnYS5XZWJBcHBcYXBpXGNsaWVudFxJbnN1cmFuY2VQb2xpY3lDYW5jZWw=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 15 Dec 2023 19:42:03 GMT"},{"key":"Content-Length","value":"134"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": \"\",\n    \"errors\": [\n        \"Validation Error: Insurance policy for product 'CLSCPLAT60' not found\"\n    ]\n}"}],"_postman_id":"f81b4257-e4d2-4e1b-9317-c06dc77bb6ca"},{"name":"InsurancePolicyCancelBulk","id":"6a9653e1-3221-48c0-934d-ee202836360c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"cancelDate\": \"{{cancel_date}}\",\n    \"premiumRefund\": 425\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyCancel?token={{token}}","description":"<h3 id=\"insurance-policy-cancel-bulk\">Insurance Policy Cancel (bulk)</h3>\n<p>Cancels an insurance policy on each of one to 250 accounts through the same insurance import service as the single route. Every item carries its own <code>importCode</code>, policy number, cancel date, and refund amounts. An item may identify its account with <code>account_number</code> or with <code>accountNumberOrId</code>, which also accepts an account ID. Accounts commit independently and Day End is checked before each one. The route reuses the single Insurance Policy Cancel permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","InsurancePolicyCancel"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"759c6c7d-018e-4f51-b791-41532d0b7ba2","name":"InsurancePolicyCancelBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"cancelDate\": \"{{cancel_date}}\",\n    \"premiumRefund\": 425\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyCancel?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyCancel"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":\"\"}]}}"},{"id":"05f5a067-1340-4dbf-af28-032ac0825673","name":"InsurancePolicyCancelBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"cancelDate\": \"{{cancel_date}}\",\n    \"premiumRefund\": 425\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"importCode\": \"{{insurance_import_code}}\",\n    \"policyNumber\": \"POL-1001\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"cancelDate\": \"{{cancel_date}}\",\n    \"premiumRefund\": 425\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyCancel?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyCancel"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": \"\"\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"5e3840e2-55f9-425a-93fe-d6b22d8bee23","name":"InsurancePolicyCancelBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyCancel?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyCancel"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"a3147784-824f-4697-91f1-f2e0b7973dde","name":"InsurancePolicyCancelBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/InsurancePolicyCancel?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","InsurancePolicyCancel"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"6a9653e1-3221-48c0-934d-ee202836360c"},{"name":"InterestChangeRate","id":"b7b73e26-a9cd-41b0-9f6a-e718e4247d12","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"new_rate\": \"{{new_rate}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"comments\": \"{{comments}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ChangeInterestRate","description":"<h3 id=\"change-interest-rate\">Change Interest Rate</h3>\n<p>This method changes the interest rate for an interest-bearing account by reusing Omega's existing servicing transaction flow.</p>\n<p><strong>HTTP Method:</strong> POST<br /><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/ChangeInterestRate</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional string. The authentication token assigned to you by the Login method if not using the dynamic signature.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>new_rate</em></td>\n<td>Required decimal. The new annual interest rate as a percentage, for example <code>19.5</code> for 19.5%.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required string. The effective date formatted as YYYY-MM-DD.</td>\n</tr>\n<tr>\n<td><em>comments</em></td>\n<td>Optional string. Comment stored with the servicing transaction.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"notes\">Notes</h4>\n<ul>\n<li>The account must resolve inside the authenticated client context and must be a valid interest-bearing account.</li>\n<li>The requested rate must satisfy the class minimum and maximum rate rules enforced by Omega servicing.</li>\n<li>Authorization remains dynamic through <code>AccountController</code>'s class-level <code>[AuthenticateBySessionIdOrTokenOrApiKey]</code> filter, so no SQL permission seed data, database schema change, or DAL refresh is required for endpoint coverage.</li>\n</ul>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","ChangeInterestRate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d5ce363c-722e-48d0-8c0d-7e71999e5072","name":"ChangeInterestRate - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"new_rate\": 19.5,\n  \"effective_date\": \"2026-06-23\",\n  \"comments\": \"API rate change for borrower request.\",\n  \"accountNumberOrId\": \"30001212\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ChangeInterestRate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"account_number\": 30001212,\n        \"effective_date\": \"2026-06-23\",\n        \"previous_rate\": 18.25,\n        \"new_rate\": 19.5,\n        \"previous_rate_decimal\": 0.1825,\n        \"new_rate_decimal\": 0.195,\n        \"reference_number\": \"14588231\"\n    },\n    \"errors\": []\n}"},{"id":"dc9d71ec-8d92-424d-b6d8-9a0edbd89dab","name":"ChangeInterestRate - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": 30001212,\n  \"new_rate\": 3.5,\n  \"effective_date\": \"2026-06-23\",\n  \"comments\": \"Testing class minimum rate validation.\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ChangeInterestRate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"The new interest rate is below the minimum interest rate required for this class.\"\n    ]\n}"}],"_postman_id":"b7b73e26-a9cd-41b0-9f6a-e718e4247d12"},{"name":"InterestChangeRateBulk","id":"5220f9a6-2d1c-47db-98d3-6c18692c84bf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"new_rate\": 12.5,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API rate change\",\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/ChangeInterestRate?token={{token}}","description":"<h3 id=\"change-interest-rate-bulk\">Change Interest Rate (bulk)</h3>\n<p>Changes the interest rate on one to 250 interest-bearing accounts. Every item supplies its own <code>new_rate</code> (as a percentage), <code>effective_date</code>, and comment. The single route's guards still apply per account: the account must be interest bearing, and the requested rate must fall inside the class minimum and maximum. Accounts commit independently and Day End is checked before each one. The route reuses the single Change Interest Rate permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","ChangeInterestRate"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"74b9cefb-0d01-4d7f-acc8-4be5df3fe5cb","name":"InterestChangeRateBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"new_rate\": 12.5,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API rate change\",\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ChangeInterestRate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ChangeInterestRate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"previous_rate\":14.0,\"new_rate\":12.5,\"reference_number\":\"1001\"}}]}}"},{"id":"43be2c6a-3969-4f13-976f-24cf7b52bec2","name":"InterestChangeRateBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"new_rate\": 12.5,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API rate change\",\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"new_rate\": 12.5,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API rate change\",\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ChangeInterestRate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ChangeInterestRate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"previous_rate\":14.0,\"new_rate\":12.5,\"reference_number\":\"1001\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"b7d8d706-9a16-4e40-aa40-784b2eff12ab","name":"InterestChangeRateBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ChangeInterestRate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ChangeInterestRate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"f4e33ac1-138a-4c04-bbd7-c0e67c2a0ffb","name":"InterestChangeRateBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ChangeInterestRate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ChangeInterestRate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"5220f9a6-2d1c-47db-98d3-6c18692c84bf"},{"name":"JudgmentGet","id":"95ecd3e0-54e7-4411-a38c-36309edf175d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/account/Judgment?token={{token}}&accountNumberOrId={{account_number_or_id}}","description":"<h3 id=\"get-judgment\">Get Judgment</h3>\n<p>Returns the judgment-ready state for an account. Mirrors the initial account lookup phase of <code>Judgment.aspx</code>: account identifiers, current row-version (<code>accountTs</code>), class judgment defaults, the precompute flag, posting start date, current business date, and flags indicating whether a judgment has already been posted, whether sub-account balances exist, and whether active insurance is present.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Judgment</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) to look up.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","Judgment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"accountNumberOrId","value":"{{account_number_or_id}}"}],"variable":[]}},"response":[{"id":"a8ffc372-53c8-41c2-891d-61947ab2dab5","name":"JudgmentGet - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/Judgment?token={{token}}&accountNumberOrId={{account_number}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Judgment"],"query":[{"key":"token","value":"{{token}}"},{"key":"accountNumberOrId","value":"{{account_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"accountTs\": \"AAAAAAAAB9I=\",\n        \"cancelAllInsurance\": true,\n        \"cancelAllInsuranceEditable\": false,\n        \"insuranceCancellationMessage\": \"All active insurance lender policies effective on or before the judgment date are cancelled automatically.\",\n        \"isPrecompute\": false,\n        \"classId\": \"00000000-0000-0000-0000-000000000000\",\n        \"classNumber\": 100,\n        \"disableAcctLateChargeAfterJudgment\": true,\n        \"judgmentAlreadyPosted\": false,\n        \"hasActiveSubAccountBalance\": false,\n        \"hasActiveInsurance\": false,\n        \"postingStartDate\": \"01/01/2024\",\n        \"currentBusinessDate\": \"04/18/2026\",\n        \"defaultFinanceChargeRebateCode\": null,\n        \"defaultFinanceChargeRebateCodeId\": null,\n        \"defaultJudgmentClassNumber\": \"999\",\n        \"defaultJudgmentClassId\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"475f6629-0e7b-4839-8811-33ba844c82d9","name":"JudgmentGet - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/client/account/Judgment?token={{token}}&accountNumberOrId=00000000","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Judgment"],"query":[{"key":"token","value":"{{token}}"},{"key":"accountNumberOrId","value":"00000000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"95ecd3e0-54e7-4411-a38c-36309edf175d"},{"name":"JudgmentGetBulk","id":"a26ae11e-d89c-4bfb-9e54-a38b2a430a1f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetJudgment?token={{token}}","description":"<p>Returns judgment information for one to 250 accounts. Every array item requires <code>accountNumberOrId</code>, which accepts an account number or account ID. The route reuses the single Get Judgment permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetJudgment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"442c51ba-b81b-4574-b4ee-ff67b04ed09b","name":"JudgmentGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"accountNumber\":30001212,\"judgmentDate\":\"2026-08-25\"}}]}}"},{"id":"3d07e4f5-2c71-4b29-95fd-d7ebc11fc0b1","name":"JudgmentGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"4c940117-fbe3-4171-82c4-6116eb9491bd","name":"JudgmentGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"a26ae11e-d89c-4bfb-9e54-a38b2a430a1f"},{"name":"InterestSetUnpaid","id":"faf29543-4bbc-4060-9485-d34a477dc7b8","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"new_unpaid_interest\": \"{{new_unpaid_interest}}\",\n  \"comments\": \"{{comments}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SetUnpaidInterest","description":"<h3 id=\"set-unpaid-interest\">Set Unpaid Interest</h3>\n<p>This method sets unpaid interest for an activated interest-bearing account by following Omega's existing calculate-then-post servicing flow.</p>\n<p><strong>HTTP Method:</strong> POST<br /><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/SetUnpaidInterest</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional string. The authentication token assigned to you by the Login method if not using the dynamic signature.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required string. The effective date formatted as YYYY-MM-DD.</td>\n</tr>\n<tr>\n<td><em>new_unpaid_interest</em></td>\n<td>Required decimal. The new unpaid interest amount, which must be greater than or equal to <code>0</code>.</td>\n</tr>\n<tr>\n<td><em>comments</em></td>\n<td>Optional string. Comment stored with the servicing transaction.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"notes\">Notes</h4>\n<ul>\n<li>The account must be activated, must resolve inside the authenticated client context, and must be a valid interest-bearing account type.</li>\n<li>Omega calculates the servicing adjustment first and then posts the <code>Set_Unpaid_Interest</code> transaction so standard recast, GL, history, and audit behavior are preserved.</li>\n<li>Authorization remains dynamic through <code>AccountController</code>'s class-level <code>[AuthenticateBySessionIdOrTokenOrApiKey]</code> filter, so no SQL permission seed data, database schema change, or DAL refresh is required for endpoint coverage.</li>\n</ul>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","SetUnpaidInterest"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9f94f18d-66e9-43be-a4f2-461f3f9d8124","name":"SetUnpaidInterest - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"2026-06-23\",\n  \"new_unpaid_interest\": 55,\n  \"comments\": \"API unpaid interest correction.\",\n  \"accountNumberOrId\": \"30001212\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SetUnpaidInterest"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"account_number\": 30001212,\n        \"effective_date\": \"2026-06-23\",\n        \"previous_unpaid_interest\": 73.42,\n        \"new_unpaid_interest\": 55.0,\n        \"reference_number\": \"14588245\"\n    },\n    \"errors\": []\n}"},{"id":"20dbe8a8-1b0c-447c-838a-11ed09a6a797","name":"SetUnpaidInterest - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": 30001212,\n  \"effective_date\": \"2026-06-23\",\n  \"new_unpaid_interest\": -5,\n  \"comments\": \"Testing negative unpaid interest validation.\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SetUnpaidInterest"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"New Unpaid Interest Amount must be >= $0.00\"\n    ]\n}"}],"_postman_id":"faf29543-4bbc-4060-9485-d34a477dc7b8"},{"name":"InterestSetUnpaidBulk","id":"5fb65ffe-c3c4-460e-baee-3f2af21df545","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"new_unpaid_interest\": 0,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API unpaid interest reset\",\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/SetUnpaidInterest?token={{token}}","description":"<h3 id=\"set-unpaid-interest-bulk\">Set Unpaid Interest (bulk)</h3>\n<p>Sets the unpaid interest balance on one to 250 interest-bearing accounts. Every item supplies its own <code>new_unpaid_interest</code>, <code>effective_date</code>, and comment. The single route's guards still apply per account: the account must be activated and interest bearing, and the amount must be zero or more. Accounts commit independently and Day End is checked before each one. The route reuses the single Set Unpaid Interest permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","SetUnpaidInterest"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"20b62444-470b-45b1-a630-a5ef9a987f83","name":"InterestSetUnpaidBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"new_unpaid_interest\": 0,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API unpaid interest reset\",\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SetUnpaidInterest?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SetUnpaidInterest"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"previous_unpaid_interest\":142.18,\"new_unpaid_interest\":0.0,\"reference_number\":\"1002\"}}]}}"},{"id":"658b187e-c96a-4ac1-bb84-c72565d23886","name":"InterestSetUnpaidBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"new_unpaid_interest\": 0,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API unpaid interest reset\",\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"new_unpaid_interest\": 0,\n    \"effective_date\": \"{{effective_date}}\",\n    \"comments\": \"Bulk API unpaid interest reset\",\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SetUnpaidInterest?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SetUnpaidInterest"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"previous_unpaid_interest\":142.18,\"new_unpaid_interest\":0.0,\"reference_number\":\"1002\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"5e526433-417a-4438-8f38-2e8d9741841f","name":"InterestSetUnpaidBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SetUnpaidInterest?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SetUnpaidInterest"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"d98cf073-9e1c-41f6-b5a5-1691cd181a4a","name":"InterestSetUnpaidBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SetUnpaidInterest?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SetUnpaidInterest"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"5fb65ffe-c3c4-460e-baee-3f2af21df545"},{"name":"Judgment","id":"34f0948d-cc37-4663-a9fa-3342cf20b05e","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_transaction_code}}\",\n    \"financeChargeRebateCodeOrId\": \"\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newClassNumberOrId\": \"\",\n    \"addRemarkCodeOrId\": \"\",\n    \"newInterestRate\": 0,\n    \"newCurrentBalance\": 0,\n    \"newPaymentAmount\": 0,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"ssnLastFour\": \"{{ssn_last_four}}\",\n    \"accountTs\": \"{{account_ts}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Judgment","description":"<h3 id=\"update-judgment-calculate-and-post\">Update Judgment (Calculate and Post)</h3>\n<p>Calculates a judgment and posts it. Mirrors the <code>PostButton_Click</code> pipeline in <code>Judgment.aspx</code>, including the SSN-last-4 confirmation against the primary customer before the transaction is committed. Returns the posted account identifiers, judgment/filing dates, posted reference numbers, and the new current balance.</p>\n<p>Use this call after <code>POST api/client/account/Judgment</code> has produced an acceptable preview.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Judgment</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Includes every field on the POST preview, plus:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>ssnLastFour</em></td>\n<td>Required string. Last four digits of the primary customer's Social Security Number. Posting fails if this does not match the value stored on the primary customer record.</td>\n</tr>\n</tbody>\n</table>\n</div><p>All other fields are the same as <code>POST api/client/account/Judgment</code>. See that request for the full field reference.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Judgment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"804d96b3-c5d1-43e2-8159-8d261c1309e2","name":"UpdateJudgment - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_transaction_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newCurrentBalance\": 12500.00,\n    \"newInterestRate\": 9.5,\n    \"newPaymentAmount\": 250.00,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"ssnLastFour\": \"{{ssn_last_four}}\",\n    \"accountTs\": \"{{account_ts}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Judgment"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"judgmentDate\": \"04/18/2026\",\n        \"filingDate\": \"04/15/2026\",\n        \"referenceNumbers\": [\"1000046\"],\n        \"newCurrentBalance\": 12500.00\n    }\n}"},{"id":"faad4ab0-e677-40b7-8e14-87a4df322bb0","name":"UpdateJudgment - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_transaction_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newCurrentBalance\": 12500.00,\n    \"newInterestRate\": 9.5,\n    \"newPaymentAmount\": 250.00,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"ssnLastFour\": \"0000\",\n    \"accountTs\": \"{{account_ts}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Judgment"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Please enter the last 4 SSN of the account's primary customer.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"34f0948d-cc37-4663-a9fa-3342cf20b05e"},{"name":"JudgmentUpdateBulk","id":"abb85cf1-2454-46a1-96af-8aca23d5d3e9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"newCurrentBalance\": 12500,\n    \"accountTs\": \"{{account_ts}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/UpdateJudgment?token={{token}}","description":"<h3 id=\"update-judgment-bulk\">Update Judgment (bulk)</h3>\n<p>Updates judgment information for one to 250 accounts through the same service as the single PUT route. Every item is a complete update parameter, so each account carries its own dates, codes, balances, and <code>accountTs</code>. Accounts commit independently and Day End is checked before each one. The route reuses the single Update Judgment permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","UpdateJudgment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f02787c8-a7e3-43b4-959a-b5b4164cdd48","name":"JudgmentUpdateBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"newCurrentBalance\": 12500,\n    \"accountTs\": \"{{account_ts}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"a4ed91ac-ff1c-45f7-a193-16f0e41f533a","name":"JudgmentUpdateBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"newCurrentBalance\": 12500,\n    \"accountTs\": \"{{account_ts}}\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"newCurrentBalance\": 12500,\n    \"accountTs\": \"{{account_ts}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"2e3854d5-7169-4d5a-ab91-0574deeff6c5","name":"JudgmentUpdateBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"b0673fe0-bf54-4eb7-ba5b-7ce109b75dac","name":"JudgmentUpdateBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"abb85cf1-2454-46a1-96af-8aca23d5d3e9"},{"name":"JudgmentPreview","id":"570140d8-2f3d-4a65-9833-affa5dea61fd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_transaction_code}}\",\n    \"financeChargeRebateCodeOrId\": \"\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newClassNumberOrId\": \"\",\n    \"addRemarkCodeOrId\": \"\",\n    \"newInterestRate\": 0,\n    \"newCurrentBalance\": 0,\n    \"newPaymentAmount\": 0,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"accountTs\": \"{{account_ts}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Judgment","description":"<h3 id=\"post-judgment-calculate-preview\">Post Judgment (Calculate Preview)</h3>\n<p>Calculates a judgment preview without posting. Mirrors the <code>ContinueButtonClick</code> and <code>CalculateButtonClick</code> pipeline on <code>Judgment.aspx</code>. Returns the projected new balance, new interest rate, selectable other-balance lines, payments after the filing/judgment date, cancelled insurance preview, and any warnings raised by the calculation.</p>\n<p>Use this call to render a confirmation screen before invoking <code>PUT api/client/account/Judgment</code> to actually post the judgment.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Judgment</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>judgmentDate</em></td>\n<td>Required date. Date the judgment is awarded.</td>\n</tr>\n<tr>\n<td><em>filingDate</em></td>\n<td>Required date. Date the judgment was filed.</td>\n</tr>\n<tr>\n<td><em>contractualBalanceCodeOrId</em></td>\n<td>Optional string. Transaction code or <code>Id</code> used for the contractual balance adjustment leg.</td>\n</tr>\n<tr>\n<td><em>financeChargeRebateCodeOrId</em></td>\n<td>Optional string. Transaction code or <code>Id</code> used for the finance charge rebate leg (precompute accounts).</td>\n</tr>\n<tr>\n<td><em>newAdminStatusOrId</em></td>\n<td>Optional string. Administrative status code or <code>Id</code> to apply to the account after judgment.</td>\n</tr>\n<tr>\n<td><em>newClassNumberOrId</em></td>\n<td>Optional string. Class number or <code>Id</code> to move the account to (defaults to the originating class's <code>DefaultJudgmentClass</code>).</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Remark code or <code>Id</code> added to the account when the judgment is posted.</td>\n</tr>\n<tr>\n<td><em>newInterestRate</em></td>\n<td>Optional decimal. New interest rate (percent) applied to the account.</td>\n</tr>\n<tr>\n<td><em>newCurrentBalance</em></td>\n<td>Required decimal. New current balance to set on the account.</td>\n</tr>\n<tr>\n<td><em>newPaymentAmount</em></td>\n<td>Optional decimal. New scheduled payment amount.</td>\n</tr>\n<tr>\n<td><em>otherBalanceSelections</em></td>\n<td>Optional array of <code>{ id, payBalance }</code> objects. Identifies which other-balance lines should be carried forward.</td>\n</tr>\n<tr>\n<td><em>cancelAllInsurance</em></td>\n<td>Optional boolean (defaults to <code>true</code>). When <code>true</code>, active insurance policies are cancelled as part of the judgment.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record. Use the value returned by the GET above.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","Judgment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8cffa86c-58bc-4d68-968b-b3921a895c8a","name":"JudgmentPreview - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_transaction_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newCurrentBalance\": 12500.00,\n    \"newInterestRate\": 9.5,\n    \"newPaymentAmount\": 250.00,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"accountTs\": \"{{account_ts}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Judgment"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"cancelAllInsurance\": true,\n        \"cancelAllInsuranceEditable\": false,\n        \"insuranceCancellationMessage\": \"All active insurance lender policies effective on or before the judgment date are cancelled automatically.\",\n        \"newCurrentBalance\": 12500.00,\n        \"newInterestRate\": 9.5,\n        \"otherBalances\": [],\n        \"paymentsAfterFilingOrJudgmentDate\": [],\n        \"cancelledInsurance\": [],\n        \"warnings\": []\n    }\n}"},{"id":"f5c5906c-a0bd-4a91-ba01-7814f7fc68ac","name":"JudgmentPreview - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"judgmentDate\": \"{{judgment_date}}\",\n    \"filingDate\": \"{{filing_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_transaction_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newCurrentBalance\": 12500.00,\n    \"newInterestRate\": 9.5,\n    \"newPaymentAmount\": 250.00,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"accountTs\": \"{{account_ts}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Judgment"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A judgment has already been posted on the account.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"570140d8-2f3d-4a65-9833-affa5dea61fd"},{"name":"JudgmentPreviewBulk","id":"41e27118-c3b9-475a-be9a-248cde739c72","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"judgmentDate\": \"{{effective_date}}\",\n    \"filingDate\": \"{{effective_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_code}}\",\n    \"financeChargeRebateCodeOrId\": \"{{finance_charge_rebate_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newClassNumberOrId\": \"{{class_number}}\",\n    \"addRemarkCodeOrId\": \"{{remark_code}}\",\n    \"newCurrentBalance\": 5000.00,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"accountTs\": \"{{account_ts}}\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"judgmentDate\": \"{{effective_date}}\",\n    \"filingDate\": \"{{effective_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_code}}\",\n    \"financeChargeRebateCodeOrId\": \"{{finance_charge_rebate_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newClassNumberOrId\": \"{{class_number}}\",\n    \"addRemarkCodeOrId\": \"{{remark_code}}\",\n    \"newCurrentBalance\": 2500.00,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": false,\n    \"accountTs\": \"{{account_ts}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PreviewJudgment?token={{token}}","description":"<p>Calculates a judgment preview for one to 250 accounts without posting the judgment. Every array item supplies its own account selector, dates, balance/status/class codes, selected other balances, and optional rate/payment changes. The route reuses the single Add Judgment permission; use the existing single Update Judgment route to post a confirmed result.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PreviewJudgment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fc3c58e6-2364-45c1-9981-efe4b4d02e26","name":"JudgmentPreviewBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"judgmentDate\":\"2026-08-25\",\"filingDate\":\"2026-08-25\",\"contractualBalanceCodeOrId\":\"CB\",\"financeChargeRebateCodeOrId\":\"FC\",\"newAdminStatusOrId\":\"JUDG\",\"newClassNumberOrId\":\"1\",\"addRemarkCodeOrId\":\"J\",\"newCurrentBalance\":5000,\"otherBalanceSelections\":[],\"cancelAllInsurance\":true,\"accountTs\":\"AAAAAAA=\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PreviewJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PreviewJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"preview\":true,\"newCurrentBalance\":5000}}]}}"},{"id":"66378826-f21b-4d82-b9aa-5b7a2f0caa96","name":"JudgmentPreviewBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"judgmentDate\": \"{{effective_date}}\",\n    \"filingDate\": \"{{effective_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_code}}\",\n    \"financeChargeRebateCodeOrId\": \"{{finance_charge_rebate_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newClassNumberOrId\": \"{{class_number}}\",\n    \"addRemarkCodeOrId\": \"{{remark_code}}\",\n    \"newCurrentBalance\": 5000,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": true,\n    \"accountTs\": \"{{account_ts}}\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"judgmentDate\": \"{{effective_date}}\",\n    \"filingDate\": \"{{effective_date}}\",\n    \"contractualBalanceCodeOrId\": \"{{contractual_balance_code}}\",\n    \"financeChargeRebateCodeOrId\": \"{{finance_charge_rebate_code}}\",\n    \"newAdminStatusOrId\": \"{{admin_status_code}}\",\n    \"newClassNumberOrId\": \"{{class_number}}\",\n    \"addRemarkCodeOrId\": \"{{remark_code}}\",\n    \"newCurrentBalance\": 2500,\n    \"otherBalanceSelections\": [],\n    \"cancelAllInsurance\": false,\n    \"accountTs\": \"{{account_ts}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PreviewJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PreviewJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"74ac57ea-29c9-4ffd-9a1d-e2d02cae13a8","name":"JudgmentPreviewBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PreviewJudgment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PreviewJudgment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"41e27118-c3b9-475a-be9a-248cde739c72"},{"name":"MiscOtherBalancePost","id":"b448e19c-b3ff-45dc-8b8f-89e4591e6fbb","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"due_date\": \"{{due_date}}\",\n  \"transaction_code\": \"{{misc_other_balance_transaction_code}}\",\n  \"amount\": \"{{misc_other_balance_trans_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostMiscOtherBalance","description":"<p>Posts a miscellaneous other-balance transaction on the supplied account. When <code>report_mode</code> is <code>true</code>, the transaction is calculated and validated only and is not committed.</p>\n<p>This route has no request-level GL field. General ledger posting uses the selected transaction code's GL setup.</p>\n<p>Use a manual transaction code. This route rejects the codes assigned to Late Fee Transaction Code or NSF Fee Transaction Code in Servicing Module Configuration; use a different code of the corresponding type.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Session id, token, or API key accepted by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required date (ISO-8601, e.g. <code>2024-01-28T00:00:00Z</code>). Posting/effective date of the transaction.</td>\n</tr>\n<tr>\n<td><em>due_date</em></td>\n<td>Required date (ISO-8601). Due date assigned to the other-balance item.</td>\n</tr>\n<tr>\n<td><em>transaction_code</em></td>\n<td>Required string. Other-balance transaction code configured in Omega.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal. Transaction amount.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Free-text comment stored with the transaction.</td>\n</tr>\n<tr>\n<td><em>report_mode</em></td>\n<td>Optional boolean (default <code>false</code>). When <code>true</code>, the transaction is previewed/validated but not posted.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostMiscOtherBalance"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fa9d13c2-34cc-41cd-a520-d0b1fc1a1f6b","name":"PostMiscOtherBalance - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"due_date\": \"{{due_date}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"amount\": \"{{amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostMiscOtherBalance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"current_balance\": \"$8,467.18\",\n        \"late_other_fees\": \"$20.00\",\n        \"unpaid_sub_accounts\": \"$0.00\",\n        \"total_balance\": \"$8,487.18\",\n        \"unpaid_interest\": \"$0.00\",\n        \"number_of_late_fees\": \"0\",\n        \"number_of_unpaid_sub_accounts\": \"0\",\n        \"number_of_nsfs\": \"0\",\n        \"payment_extensions\": \"0\",\n        \"over_short_amount\": \"$759.15\"\n    },\n    \"errors\": null\n}"},{"id":"d8fb78ef-941c-4d1e-80ad-fbfdc9e1a1bc","name":"PostMiscOtherBalance - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"due_date\": \"{{due_date}}\",\n  \"transaction_code\": \"{{misc_other_balance_transaction_code}}\",\n  \"amount\": \"{{misc_other_balance_trans_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostMiscOtherBalance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|9d19eabb-d890-4052-9326-203884f44d93|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 30 Nov 2022 19:00:50 GMT"},{"key":"Content-Length","value":"511"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Cannot retrieve this account as of 4/19/2019 12:00:00 AM.  Ensure that your posting date is not prior to 8/16/2021 12:00:00 AM\",\n        \"System.Exception: Cannot retrieve this account as of 4/19/2019 12:00:00 AM.  Ensure that your posting date is not prior to 8/16/2021 12:00:00 AM\\r\\n   at Omega.FinancialCalculations.BLL.Servicing.AccountTransactionsInstallment.GetAccountEntity(String databaseName, Guid accountId, DateTime asOfDate, Nullable`1 transactionId, GetEntityTypes entityType, Guid userId, ProcessDatabaseCache processDatabaseCache) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Business\\\\Omega.FinancialCalculations\\\\Omega.FinancialCalculations.BLL\\\\Servicing\\\\AccountTransactionsInstallment.cs:line 554\\r\\n   at Omega.FinancialCalculations.BLL.Servicing.AccountTransactionsInstallment.ReturnAccountTransactionsInstallment(String databaseName, Guid accountId, DateTime calculationDate, GetEntityTypes entityType, Guid lastChangedByUserId, ProcessDatabaseCache processDatabaseCache) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Business\\\\Omega.FinancialCalculations\\\\Omega.FinancialCalculations.BLL\\\\Servicing\\\\AccountTransactionsInstallment.cs:line 382\\r\\n   at Omega.WebApp.BLL.WebAPI.Client.Controllers.ClientController.PostMiscOtherBalance(PostMiscOtherBalance param) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Omega.WebApp\\\\BLL\\\\WebAPI\\\\Client\\\\Controllers\\\\ClientController.cs:line 1534\"\n    ]\n}"}],"_postman_id":"b448e19c-b3ff-45dc-8b8f-89e4591e6fbb"},{"name":"MiscOtherBalancePostBulk","id":"6737a0c0-73f0-4dc9-941a-580dba6e82f1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"effective_date\": \"{{effective_date}}\",\n    \"due_date\": \"{{due_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 35,\n    \"comment\": \"Bulk API fee\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostMiscOtherBalance?token={{token}}","description":"<h3 id=\"post-misc-other-balance-bulk\">Post Misc Other Balance (bulk)</h3>\n<p>Posts a miscellaneous other-balance transaction to each of one to 250 accounts. Every item supplies its own transaction code, amount, effective date, due date, and comment. Set <code>report_mode</code> to true on an item to calculate and return the resulting balances without posting. Accounts commit independently and Day End is checked before each one. The route reuses the single Post Misc Other Balance permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostMiscOtherBalance"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6db9ced7-bf49-43e6-a030-cb95813ba18c","name":"MiscOtherBalancePostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"effective_date\": \"{{effective_date}}\",\n    \"due_date\": \"{{due_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 35,\n    \"comment\": \"Bulk API fee\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostMiscOtherBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostMiscOtherBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"late_other_fees\":\"$35.00\",\"total_balance\":\"$10,485.22\"}}]}}"},{"id":"97419e71-7495-43d3-b1a5-0d786772ff56","name":"MiscOtherBalancePostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"effective_date\": \"{{effective_date}}\",\n    \"due_date\": \"{{due_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 35,\n    \"comment\": \"Bulk API fee\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"effective_date\": \"{{effective_date}}\",\n    \"due_date\": \"{{due_date}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 35,\n    \"comment\": \"Bulk API fee\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostMiscOtherBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostMiscOtherBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"late_other_fees\":\"$35.00\",\"total_balance\":\"$10,485.22\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"0525feae-a294-49e6-8e78-6338b621996e","name":"MiscOtherBalancePostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostMiscOtherBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostMiscOtherBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"4b58c15d-4090-402a-8510-beb1a69fe36b","name":"MiscOtherBalancePostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostMiscOtherBalance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostMiscOtherBalance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"6737a0c0-73f0-4dc9-941a-580dba6e82f1"},{"name":"NetBalanceWithEarningsGet","id":"385a2aaf-b08f-42ab-ba67-c17ad93e3922","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"{{account_number}}\",\n    \"date\": \"{{date}}\",\n    \"include_late_fee\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/GetNetBalanceWithEarnings","description":"<h3 id=\"get-net-balance-with-earnings\">Get Net Balance With Earnings</h3>\n<p>Returns the account's net balance as of a specific date alongside the payoff and earnings breakdown used to derive it. For precompute accounts the net balance equals <code>CurrentBalance - UnearnedFinanceCharge</code>; for interest-bearing accounts it equals <code>CurrentBalance + UnpaidInterest</code>. Wraps <code>AccountWSServices.CalculatePayoffWithEarnings</code>, which loads the account installment via <code>AccountTransactionsInstallment.ReturnAccountTransactionsInstallment</code> and honors the class's <code>FinanceChargeEarningsMethod</code> / <code>FinanceChargeEarningsBasis</code>. Allowed during day-end.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/GetNetBalanceWithEarnings</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional string. The authentication token assigned by the Login method. Required unless the request is signed with the dynamic-signature headers.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required string. The Omega account number or Guid account id. Resolved through <code>SharedWSServices.GetCommonAccountId</code>; a missing match returns <code>\"Account not found.\"</code>.</td>\n</tr>\n<tr>\n<td><em>date</em></td>\n<td>Required string. The calculation date in a format accepted by <code>DateTime.TryParse</code> (e.g. <code>YYYY-MM-DD</code>). Must be greater than or equal to the client's current branch date or the call fails with <code>\"Please pick the date after current branch date.\"</code>.</td>\n</tr>\n<tr>\n<td><em>include_late_fee</em></td>\n<td>Required boolean. When <code>true</code>, any outstanding late fee is included in the payoff portion of the calculation.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns the standard API wrapper (<code>statusCode</code>, <code>result</code>, <code>data</code>, <code>errors</code>, <code>warnings</code>) with a <code>data</code> block containing: <code>payoff_amount</code>, <code>current_balance</code>, <code>is_precompute</code>, <code>rebate_label</code>, <code>finance_charge_rebate</code>, <code>original_finance_charge</code>, <code>earned_finance_charge</code>, <code>unpaid_interest</code>, <code>date_used</code> (YYYY-MM-DD), and <code>remaining_term</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","GetNetBalanceWithEarnings"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c36b6fc2-d9e3-4e02-b94f-34aee59e3528","name":"GetNetBalanceWithEarnings - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"30001212\",\n    \"date\": \"2026-04-30\",\n    \"include_late_fee\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/GetNetBalanceWithEarnings"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Ok\",\n    \"data\": {\n        \"payoff_amount\": 12845.72,\n        \"current_balance\": 13257.90,\n        \"is_precompute\": true,\n        \"rebate_label\": \"Rule of 78\",\n        \"finance_charge_rebate\": 412.18,\n        \"original_finance_charge\": 1850.00,\n        \"earned_finance_charge\": 1437.82,\n        \"unpaid_interest\": 0.00,\n        \"date_used\": \"2026-04-30\",\n        \"remaining_term\": 36\n    },\n    \"errors\": []\n}"},{"id":"f347adca-8056-453a-838a-e71707e39e3f","name":"GetNetBalanceWithEarnings - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"99999999\",\n    \"date\": \"2026-04-30\",\n    \"include_late_fee\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/GetNetBalanceWithEarnings"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Account not found.\"\n    ]\n}"}],"_postman_id":"385a2aaf-b08f-42ab-ba67-c17ad93e3922"},{"name":"NetBalanceWithEarningsGetBulk","id":"90225eb4-a1f7-416c-978d-e57a3746f2a2","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetNetBalanceWithEarnings?token={{token}}","description":"<p>Calculates net balance and earnings details for one to 250 accounts. Each array item has its own required <code>accountNumberOrId</code> and <code>date</code>, plus optional <code>include_late_fee</code>. The selector accepts an account number or account <code>Id</code> (Guid). The route reuses the single-account Net Balance With Earnings permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetNetBalanceWithEarnings"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"9e33ab8e-3857-4a0b-a6c8-67614e30038a","name":"NetBalanceWithEarningsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"date\":\"2026-09-01\",\"include_late_fee\":true}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNetBalanceWithEarnings?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNetBalanceWithEarnings"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"9a7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"payoff_amount\": 1025.42, \"current_balance\": 1000.00, \"date_used\": \"2026-09-01\", \"remaining_term\": 12 }\n    }]\n  }\n}"},{"id":"2712c341-ade8-40e4-b4c4-94d128528457","name":"NetBalanceWithEarningsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNetBalanceWithEarnings?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNetBalanceWithEarnings"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"2082e060-077a-4dff-b86c-3de89527dba2","name":"NetBalanceWithEarningsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNetBalanceWithEarnings?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNetBalanceWithEarnings"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"90225eb4-a1f7-416c-978d-e57a3746f2a2"},{"name":"NewAccountImportSingle","id":"75588d3a-719c-4ee3-b37f-32f1570b1bea","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\":\"{{token}}\", \r\n\t\"account_import_code\":\"{{account_import_code}}\",\r\n\t\"new_account_import_xml_data\":\"{{new_account_import_xml_data}}\"\r\n}\r\n","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SingleNewAccountImport","description":"<p>This method imports a new, aged or regular conversion account into Omega. The imported account number will be returned upon a successful import. The account_import_code specification's Type selects New Account, Aged Account or Regular Conversion.</p>\n<p>Configure API specifications in Omega:</p>\n<p>Go to Import Account Configuration (Omega, Servicing &gt; Configuration).</p>\n<p>Select Single Account Import from the Import Specification Lookup.</p>\n<p>Select XML Single Account Import (or XML Bulk Account Import) from the Format dropdown. Through the API both XML formats import the one account immediately. XLSX formats are sent to AccountImportFile instead.</p>\n<p>Select New Account, Aged Account or Regular Conversion as the import Type. Submit a SingleAccountImport root containing NewAccount, AgedAccount or Account, respectively, using the corresponding schema below. Aged-account and regular conversion fields include the conversion date, current balances and next due date. A Regular Conversion account is booked like account entry's Conversion type: it activates on import and posts no General Ledger, Accounts Payable or dealer reserve/withhold entries.</p>\n<p>Select API/Webservice from the Import Method Allowed dropdown.</p>\n<p>Set up Triggers and change the Default Settings, if necessary.</p>\n<p>To import several new, aged or regular conversion accounts through the API, use NewAccountImportBulk at\n<code>/api/client/account/bulk/NewAccountImport</code>. This single request keeps its existing URL.</p>\n<p>Convert the account to an XML string that matches the schema for the configured import type.</p>\n<p>Import Schema:</p>\n<p><code>https://[base_url]/Schemas/Import/SingleNewAccountImport.xsd</code></p>\n<p><code>https://[base_url]/Schemas/Import/AgedAccountImport.xsd</code></p>\n<p><code>https://[base_url]/Schemas/Import/ConversionAccountImport.xsd</code></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The token that was assigned to you when you called the Login method</td>\n</tr>\n<tr>\n<td><em>account_import_code</em></td>\n<td>Required string. The account import specification code used to determine the import data rules and restrictions.</td>\n</tr>\n<tr>\n<td><em>new_account_import_xml_data</em></td>\n<td>Required string. The accounts data, in XML format, and adhering to the account import schema. The xml data must be URL encoded before passing it as a field</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","SingleNewAccountImport"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3edbec89-a042-46ef-95c3-ef7fcb853a6d","name":"NewAccountImportSingle - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\":\"{{token}}\", \r\n\t\"account_import_code\":\"{{account_import_code}}\",\r\n\t\"new_account_import_xml_data\":\"{{new_account_import_xml_data}}\"\r\n}\r\n","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SingleNewAccountImport"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|c0c216e2-de06-4e31-840d-fc4093a71371|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 14 Dec 2022 16:16:56 GMT"},{"key":"Content-Length","value":"78"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": 30010315,\n    \"errors\": []\n}"},{"id":"dbda3ee9-ed15-4fd3-9640-fdc812b2f91e","name":"NewAccountImportSingle - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"token\":\"{{token}}\", \r\n\t\"account_import_code\":\"{{account_import_code}}\",\r\n\t\"new_account_import_xml_data\":\"{{new_account_import_xml_data}}\"\r\n}\r\n","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SingleNewAccountImport"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcU2luZ2xlTmV3QWNjb3VudEltcG9ydA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 21:33:35 GMT"},{"key":"Content-Length","value":"363"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error importing account: Account Validation Report\\r\\nDate: 11/30/2021\\r\\n\\r\\n\\r\\nCritical Error Error                                                                                                                                                                                                   \\r\\nInvalid Time Zone Code.<BR/>\\r\\n   at Omega.FAConversion.ConversionAccount.ValidateSingleAccountImport(XmlReader accounts, StreamWriter sw, Guid defaultSourceCodeId) in D:\\\\Workspace\\\\VS 2019\\\\Repos\\\\omega\\\\Business\\\\Omega.FAConversion\\\\ConversionAccount.cs:line 2097\\r\\n   at Omega.FAConversion.ConversionAccount.ValidateConversionAccounts(String xmlFile, Boolean& requireRecast, Boolean schemaCheckOnly) in D:\\\\Workspace\\\\VS 2019\\\\Repos\\\\omega\\\\Business\\\\Omega.FAConversion\\\\ConversionAccount.cs:line 1843\\r\\n\"\n    ]\n}"}],"_postman_id":"75588d3a-719c-4ee3-b37f-32f1570b1bea"},{"name":"NewAccountImportBulk","id":"83e309fa-62ea-44c9-aeb5-414c0eeacb70","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"new_account_import_xml_data\": \"<BulkAccountImport><SingleAccountImport><NewAccount><AccountGeneral><OpenDate>2026-09-01</OpenDate><PaymentFrequency>Monthly</PaymentFrequency><APR>0.100000</APR><FirstDueDate>2026-10-01</FirstDueDate><ActualTerm>48</ActualTerm><Rate>0.100000</Rate><FirstPaymentAmount>400.00</FirstPaymentAmount><RegularPaymentAmount>400.00</RegularPaymentAmount><FinalPaymentAmount>400.00</FinalPaymentAmount><AmortizedTerm>48</AmortizedTerm><InterestStartDate>2026-09-01</InterestStartDate><AmountFinanced>16000.00</AmountFinanced><CashPrice>18000.00</CashPrice><ReferenceNumber>BULK-SAMPLE-001</ReferenceNumber></AccountGeneral><Interest>2400.00</Interest><AccountDirect><AcquisitionFeeAmount>0.00</AcquisitionFeeAmount><PointsAmount>0.00</PointsAmount></AccountDirect><AccountCustomers><Customer><CustomerNumber>{{customer_number}}</CustomerNumber><CustomerType>Primary_Customer</CustomerType></Customer></AccountCustomers></NewAccount></SingleAccountImport><SingleAccountImport><NewAccount><AccountGeneral><OpenDate>2026-09-01</OpenDate><PaymentFrequency>Monthly</PaymentFrequency><APR>0.100000</APR><FirstDueDate>2026-10-01</FirstDueDate><ActualTerm>48</ActualTerm><Rate>0.100000</Rate><FirstPaymentAmount>400.00</FirstPaymentAmount><RegularPaymentAmount>400.00</RegularPaymentAmount><FinalPaymentAmount>400.00</FinalPaymentAmount><AmortizedTerm>48</AmortizedTerm><InterestStartDate>2026-09-01</InterestStartDate><AmountFinanced>16000.00</AmountFinanced><CashPrice>18000.00</CashPrice><ReferenceNumber>BULK-SAMPLE-002</ReferenceNumber></AccountGeneral><Interest>2400.00</Interest><AccountDirect><AcquisitionFeeAmount>0.00</AcquisitionFeeAmount><PointsAmount>0.00</PointsAmount></AccountDirect><AccountCustomers><Customer><CustomerNumber>{{customer_number}}</CustomerNumber><CustomerType>Primary_Customer</CustomerType></Customer></AccountCustomers></NewAccount></SingleAccountImport></BulkAccountImport>\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/bulk/NewAccountImport","description":"<p>Imports one to 250 new, aged or regular conversion accounts from a BulkAccountImport XML document and returns every imported account number plus one result per input record. Records commit independently: an error on one record does not roll back earlier successes or stop later records.</p>\n<p>Configure an active New Account, Aged Account or Regular Conversion XML import specification in Servicing &gt; Configuration &gt; Import Account Configuration. It must allow API/Webservice access (or All). XML Single and XML Bulk formats both require Professional or higher. XLSX workbooks are sent to AccountImportFile instead. A manual-only specification cannot be used to bypass these checks. AutoActivate follows the same immediate import behavior as the single-account API. The caller's API role must permit POST api/Client/Account/SingleNewAccountImport; the bulk route reuses that permission.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Authentication token returned by Login. Required unless using valid publicKey/timeStamp/signature headers. SessionId-only authentication is not supported for this bulk operation.</td>\n</tr>\n<tr>\n<td><em>account_import_code</em></td>\n<td>Required string. Active, API-enabled New Account, Aged Account or Regular Conversion XML import specification code. Its Type selects the schema and conversion behavior for the whole request.</td>\n</tr>\n<tr>\n<td><em>new_account_import_xml_data</em></td>\n<td>Required string. Raw XML or XML URL-encoded exactly once. The root must be BulkAccountImport with one to 250 SingleAccountImport children. JSON-escape quotes and newlines in this string.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The sample uses an existing customer: replace {{customer_number}} with a positive customer number in the target client. It omits the optional Customers block. Replace the synthetic dates, amounts and reference numbers with valid data for that client; schema validity alone does not establish business validity. A record may refer to a customer committed by an earlier record, including one whose later post-import work failed. Duplicate customer definitions are rejected per record. References to failed, uncommitted or later customer definitions return errors on the referencing record.</p>\n<p>Use NewAccount inside each SingleAccountImport for a New Account specification, AgedAccount for an Aged Account specification, or Account for a Regular Conversion specification. All records must match the configured type; send separate requests to import more than one type. Aged and regular conversion accounts require their own schema fields, including conversion date, current balances and next due date; changing the element name alone is insufficient. Regular conversion accounts activate on import and post no General Ledger, Accounts Payable or dealer reserve/withhold entries, the same as account entry's Conversion type.</p>\n<p>New account schema: https://{{base_url}}/Schemas/Import/SingleNewAccountImport.xsd\nAged account schema: https://{{base_url}}/Schemas/Import/AgedAccountImport.xsd\nRegular conversion schema: https://{{base_url}}/Schemas/Import/ConversionAccountImport.xsd\nHelp: https://{{base_url}}/docs/Help/imports/account-import/bulk-account-api-request.md</p>\n<p>The signature method name for API-key authentication is NewAccountImport, derived from the final URL segment, not the Postman display name NewAccountImportBulk.</p>\n<p>The response data contains requested, succeeded, succeededWithError, failed, accountNumbers and results. Each results item contains its 1-based index, referenceNumber (or null), accountNumbers, statusCode and errors. Status codes are 0 (Ok), 50 (Error) and 100 (Successful With Error). Top-level errors identify the input record index.</p>\n<p>Inspect accountNumbers even when statusCode is 100: post-import work can fail after an account was created. Those numbers remain in the response and count as succeededWithError. Do not resubmit records that already returned account numbers; review their post-import errors. ReferenceNumber is a correlation value, not a promise that replay is safe.</p>\n<p>Malformed XML, empty XML or an empty batch, the wrong root or more than 250 records are rejected before any account imports with HTTP 200 and statusCode 50. Invalid or null JSON request models return HTTP 400; unauthenticated requests return HTTP 401. Account-level validation failures are returned per record. See the all-success, mixed-results and request-error examples.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","bulk","NewAccountImport"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"53f3521e-890b-4585-a308-527ecd957e5b","name":"NewAccountImportBulk - All Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"new_account_import_xml_data\": \"<BulkAccountImport><SingleAccountImport><NewAccount><AccountGeneral><OpenDate>2026-09-01</OpenDate><PaymentFrequency>Monthly</PaymentFrequency><APR>0.100000</APR><FirstDueDate>2026-10-01</FirstDueDate><ActualTerm>48</ActualTerm><Rate>0.100000</Rate><FirstPaymentAmount>400.00</FirstPaymentAmount><RegularPaymentAmount>400.00</RegularPaymentAmount><FinalPaymentAmount>400.00</FinalPaymentAmount><AmortizedTerm>48</AmortizedTerm><InterestStartDate>2026-09-01</InterestStartDate><AmountFinanced>16000.00</AmountFinanced><CashPrice>18000.00</CashPrice><ReferenceNumber>BULK-SAMPLE-001</ReferenceNumber></AccountGeneral><Interest>2400.00</Interest><AccountDirect><AcquisitionFeeAmount>0.00</AcquisitionFeeAmount><PointsAmount>0.00</PointsAmount></AccountDirect><AccountCustomers><Customer><CustomerNumber>2001</CustomerNumber><CustomerType>Primary_Customer</CustomerType></Customer></AccountCustomers></NewAccount></SingleAccountImport><SingleAccountImport><NewAccount><AccountGeneral><OpenDate>2026-09-01</OpenDate><PaymentFrequency>Monthly</PaymentFrequency><APR>0.100000</APR><FirstDueDate>2026-10-01</FirstDueDate><ActualTerm>48</ActualTerm><Rate>0.100000</Rate><FirstPaymentAmount>400.00</FirstPaymentAmount><RegularPaymentAmount>400.00</RegularPaymentAmount><FinalPaymentAmount>400.00</FinalPaymentAmount><AmortizedTerm>48</AmortizedTerm><InterestStartDate>2026-09-01</InterestStartDate><AmountFinanced>16000.00</AmountFinanced><CashPrice>18000.00</CashPrice><ReferenceNumber>BULK-SAMPLE-002</ReferenceNumber></AccountGeneral><Interest>2400.00</Interest><AccountDirect><AcquisitionFeeAmount>0.00</AcquisitionFeeAmount><PointsAmount>0.00</PointsAmount></AccountDirect><AccountCustomers><Customer><CustomerNumber>2001</CustomerNumber><CustomerType>Primary_Customer</CustomerType></Customer></AccountCustomers></NewAccount></SingleAccountImport></BulkAccountImport>\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/bulk/NewAccountImport"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"requested\": 2,\n    \"succeeded\": 2,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"accountNumbers\": [\n      30010001,\n      30010002\n    ],\n    \"results\": [\n      {\n        \"index\": 1,\n        \"referenceNumber\": \"BULK-SAMPLE-001\",\n        \"accountNumbers\": [\n          30010001\n        ],\n        \"statusCode\": 0,\n        \"errors\": []\n      },\n      {\n        \"index\": 2,\n        \"referenceNumber\": \"BULK-SAMPLE-002\",\n        \"accountNumbers\": [\n          30010002\n        ],\n        \"statusCode\": 0,\n        \"errors\": []\n      }\n    ]\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"686aba1e-e315-4bc3-8993-107437c6ae8c","name":"NewAccountImportBulk - Mixed Results","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"new_account_import_xml_data\": \"<BulkAccountImport><SingleAccountImport><NewAccount><AccountGeneral><OpenDate>2026-09-01</OpenDate><PaymentFrequency>Monthly</PaymentFrequency><APR>0.100000</APR><FirstDueDate>2026-10-01</FirstDueDate><ActualTerm>48</ActualTerm><Rate>0.100000</Rate><FirstPaymentAmount>400.00</FirstPaymentAmount><RegularPaymentAmount>400.00</RegularPaymentAmount><FinalPaymentAmount>400.00</FinalPaymentAmount><AmortizedTerm>48</AmortizedTerm><InterestStartDate>2026-09-01</InterestStartDate><AmountFinanced>16000.00</AmountFinanced><CashPrice>18000.00</CashPrice><ReferenceNumber>BULK-SAMPLE-001</ReferenceNumber></AccountGeneral><Interest>2400.00</Interest><AccountDirect><AcquisitionFeeAmount>0.00</AcquisitionFeeAmount><PointsAmount>0.00</PointsAmount></AccountDirect><AccountCustomers><Customer><CustomerNumber>2001</CustomerNumber><CustomerType>Primary_Customer</CustomerType></Customer></AccountCustomers></NewAccount></SingleAccountImport><SingleAccountImport><NewAccount><AccountGeneral><OpenDate>2026-09-01</OpenDate><PaymentFrequency>Monthly</PaymentFrequency><APR>0.100000</APR><FirstDueDate>2026-10-01</FirstDueDate><ActualTerm>48</ActualTerm><Rate>0.100000</Rate><FirstPaymentAmount>400.00</FirstPaymentAmount><RegularPaymentAmount>400.00</RegularPaymentAmount><FinalPaymentAmount>400.00</FinalPaymentAmount><AmortizedTerm>48</AmortizedTerm><InterestStartDate>2026-09-01</InterestStartDate><AmountFinanced>16000.00</AmountFinanced><CashPrice>18000.00</CashPrice><ReferenceNumber>BULK-SAMPLE-002</ReferenceNumber></AccountGeneral><Interest>2400.00</Interest><AccountDirect><AcquisitionFeeAmount>0.00</AcquisitionFeeAmount><PointsAmount>0.00</PointsAmount></AccountDirect><AccountCustomers><Customer><CustomerNumber>99999999</CustomerNumber><CustomerType>Primary_Customer</CustomerType></Customer></AccountCustomers></NewAccount></SingleAccountImport><SingleAccountImport><NewAccount><AccountGeneral><OpenDate>2026-09-01</OpenDate><PaymentFrequency>Monthly</PaymentFrequency><APR>0.100000</APR><FirstDueDate>2026-10-01</FirstDueDate><ActualTerm>48</ActualTerm><Rate>0.100000</Rate><FirstPaymentAmount>400.00</FirstPaymentAmount><RegularPaymentAmount>400.00</RegularPaymentAmount><FinalPaymentAmount>400.00</FinalPaymentAmount><AmortizedTerm>48</AmortizedTerm><InterestStartDate>2026-09-01</InterestStartDate><AmountFinanced>16000.00</AmountFinanced><CashPrice>18000.00</CashPrice><ReferenceNumber>BULK-SAMPLE-003</ReferenceNumber></AccountGeneral><Interest>2400.00</Interest><AccountDirect><AcquisitionFeeAmount>0.00</AcquisitionFeeAmount><PointsAmount>0.00</PointsAmount></AccountDirect><AccountCustomers><Customer><CustomerNumber>2001</CustomerNumber><CustomerType>Primary_Customer</CustomerType></Customer></AccountCustomers></NewAccount></SingleAccountImport></BulkAccountImport>\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/bulk/NewAccountImport"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 100,\n  \"result\": \"Successful With Error\",\n  \"data\": {\n    \"requested\": 3,\n    \"succeeded\": 1,\n    \"succeededWithError\": 1,\n    \"failed\": 1,\n    \"accountNumbers\": [\n      30010001,\n      30010003\n    ],\n    \"results\": [\n      {\n        \"index\": 1,\n        \"referenceNumber\": \"BULK-SAMPLE-001\",\n        \"accountNumbers\": [\n          30010001\n        ],\n        \"statusCode\": 0,\n        \"errors\": []\n      },\n      {\n        \"index\": 2,\n        \"referenceNumber\": \"BULK-SAMPLE-002\",\n        \"accountNumbers\": [],\n        \"statusCode\": 50,\n        \"errors\": [\n          \"Customer 99999999 was not found.\"\n        ]\n      },\n      {\n        \"index\": 3,\n        \"referenceNumber\": \"BULK-SAMPLE-003\",\n        \"accountNumbers\": [\n          30010003\n        ],\n        \"statusCode\": 100,\n        \"errors\": [\n          \"Post-import processing failed.\"\n        ]\n      }\n    ]\n  },\n  \"errors\": [\n    \"Record 2: Customer 99999999 was not found.\",\n    \"Record 3: Post-import processing failed.\"\n  ],\n  \"warnings\": []\n}"},{"id":"9ffa81b4-ec21-4901-bd9b-795e60946a54","name":"NewAccountImportBulk - Request Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"new_account_import_xml_data\": \"<SingleAccountImport />\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/bulk/NewAccountImport"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"Expected a BulkAccountImport root element.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"83e309fa-62ea-44c9-aeb5-414c0eeacb70"},{"name":"AccountImportFile","id":"e0bcf5aa-3b0a-410c-9bdc-ef6b1408279a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"file_name\": \"conversion-accounts.xlsx\",\n  \"file_content_base64\": \"{{account_import_file_base64}}\",\n  \"file_includes_headers\": false,\n  \"validate_only\": false,\n  \"folder_path\": \"System/Imports\",\n  \"notification_email\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AccountImportFile","description":"<p>Imports one to 250 regular conversion accounts from an XLSX workbook (layout in the Regular Conversion Import Layout help page). The workbook is converted to one BulkAccountImport document (ConversionAccountImport.xsd) and every account is checked against the schema at once. When nothing has errors, the accounts are queued and imported in the background, one account import file per client at a time: the request returns right away, AccountImportFileRunning shows the progress, and a results file is saved to folder_path. Each account then imports and commits on its own, exactly like NewAccountImportBulk, so an error on one account does not roll back the others.</p>\n<p>Configure an active Regular Conversion import specification in Servicing &gt; Configuration &gt; Import Account Configuration with Format XLSX Single Account Import or XLSX Bulk Account Import. It must allow API/Webservice access (or All). Professional edition or higher is required. An XLSX Single Account Import specification takes a workbook with exactly one account. The caller's API role must permit POST api/Client/Account/SingleNewAccountImport; this route reuses that permission.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Authentication token returned by Login. Required unless using valid publicKey/timeStamp/signature headers. SessionId-only authentication is not supported for this operation.</td>\n</tr>\n<tr>\n<td><em>account_import_code</em></td>\n<td>Required string. Active, API-enabled Regular Conversion XLSX import specification code.</td>\n</tr>\n<tr>\n<td><em>file_name</em></td>\n<td>Optional string. When sent it must end in .xlsx.</td>\n</tr>\n<tr>\n<td><em>file_content_base64</em></td>\n<td>Required string. The workbook bytes, base64 encoded. At most 25 MB before encoding.</td>\n</tr>\n<tr>\n<td><em>file_includes_headers</em></td>\n<td>Optional boolean, default false. Same as \"File includes headers\" on Import Account: true means the Customers, Account Transactions, Account Notes and Pending Payment Amount Change sheets start with 4 header rows, which are skipped.</td>\n</tr>\n<tr>\n<td><em>validate_only</em></td>\n<td>Optional boolean, default false. true only checks the workbook and its accounts; nothing is queued or imported.</td>\n</tr>\n<tr>\n<td><em>folder_path</em></td>\n<td>Required unless validate_only. Document Manager folder for the results file, by its path from the top. A path from GET api/Client/Setup/ReportSetting/Folders, which lists the folders you can save to, works exactly as it is (e.g. \"System / Imports\"), also when a folder name contains / or . Names separated by / or \\ work too (\"System/Imports\"), and \"System\" may be left off. When more than one folder you can save to has the path, the request is refused with \"More than one folder has the path ...\"; rename one of them in Document Manager. You can save to Full Control folders and to folders whose roles give you View and Add. The system user cannot be given roles, so it may use any folder of the client except Temporary Output. A portal API key cannot call the Folders list; send the folder names as Document Manager shows them.</td>\n</tr>\n<tr>\n<td><em>notification_email</em></td>\n<td>Optional string. Address to e-mail when the import finishes.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Workbook sheets: Accounts (required; one row per account under a header row of column names), Customers (customer number in column A), and optionally Account Transactions, Account Notes and Pending Payment Amount Change. A Dealers sheet is ignored. Customer numbers on the Customers sheet identify new customers within the workbook only; Omega assigns their customer numbers. A customer number on the Accounts sheet that is not on the Customers sheet must be an existing Omega customer number.</p>\n<p>Regular conversion accounts are booked like account entry's Conversion type: they activate on import and post no General Ledger, Accounts Payable or dealer reserve/withhold entries. Record the converted balances in the General Ledger separately.</p>\n<p>Regular conversion schema: https://{{base_url}}/Schemas/Import/ConversionAccountImport.xsd\nHelp: https://{{base_url}}/docs/Help/imports/account-import/account-import-file-api-request.md</p>\n<p>The signature method name for API-key authentication is AccountImportFile, the final URL segment.</p>\n<p>Response data: status (Queued, Validated or Not queued), accounts (in the workbook), importsAhead (account import files already running or waiting for the client), folderPath (the results file's folder) and records (one per account: index, referenceNumber, statusCode, errors). statusCode is 0 (Ok) when the workbook was queued or validated and 50 (Error) when it was not; the reason is the first error, and accounts with schema errors are listed in data.records with nothing queued. A workbook that cannot be converted (no Accounts sheet, an unknown column header, a bad row) or that holds more than 250 accounts is also rejected before anything is queued. The results file has one row per account: Record, Reference Number, Status (Imported, Imported with errors, Not imported), Account Numbers and Errors. The calling user gets a Report Saved notification in Omega that links to it (not for a Client Portal API key, which runs as the system user). notification_email, when sent, is e-mailed when the import finishes, when the results file cannot be saved (with the results attached; the accounts stay imported) and when the import cannot start (nothing is imported). Invalid or null JSON request models return HTTP 400; unauthenticated requests return HTTP 401.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","AccountImportFile"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"00ef0ac0-8854-4598-8436-8ce0d1814ecd","name":"AccountImportFile - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"file_name\": \"conversion-accounts.xlsx\",\n  \"file_content_base64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"file_includes_headers\": false,\n  \"validate_only\": false,\n  \"folder_path\": \"System/Imports\",\n  \"notification_email\": \"you@example.com\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AccountImportFile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"status\": \"Queued\",\n    \"accounts\": 2,\n    \"importsAhead\": 0,\n    \"folderPath\": \"System / Imports\",\n    \"records\": [\n      {\n        \"index\": 1,\n        \"referenceNumber\": \"REF-XL-A-001\",\n        \"accountNumbers\": [],\n        \"statusCode\": 0,\n        \"errors\": []\n      },\n      {\n        \"index\": 2,\n        \"referenceNumber\": \"REF-XL-A-002\",\n        \"accountNumbers\": [],\n        \"statusCode\": 0,\n        \"errors\": []\n      }\n    ]\n  },\n  \"errors\": [],\n  \"warnings\": [\n    \"Queued: the accounts are imported in the background. The results file is saved to \\\"System / Imports\\\". GET api/Client/Account/Bulk/AccountImportFile/Running shows the progress.\"\n  ]\n}"},{"id":"cd3e8de7-03e1-481e-b320-660df90c10b6","name":"AccountImportFile - Account Errors","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"file_name\": \"conversion-accounts.xlsx\",\n  \"file_content_base64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"file_includes_headers\": false,\n  \"folder_path\": \"System/Imports\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AccountImportFile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": {\n    \"status\": \"Not queued\",\n    \"accounts\": 2,\n    \"importsAhead\": 0,\n    \"folderPath\": null,\n    \"records\": [\n      {\n        \"index\": 1,\n        \"referenceNumber\": \"REF-XL-A-001\",\n        \"accountNumbers\": [],\n        \"statusCode\": 0,\n        \"errors\": []\n      },\n      {\n        \"index\": 2,\n        \"referenceNumber\": \"REF-XL-A-002\",\n        \"accountNumbers\": [],\n        \"statusCode\": 50,\n        \"errors\": [\n          \"The element 'AccountGeneral' has invalid child element 'Rate'. List of possible elements expected: 'ActualTerm'.\"\n        ]\n      }\n    ]\n  },\n  \"errors\": [\n    \"1 account(s) have errors, so nothing was queued or imported.\",\n    \"Record 2: The element 'AccountGeneral' has invalid child element 'Rate'. List of possible elements expected: 'ActualTerm'.\"\n  ],\n  \"warnings\": []\n}"},{"id":"2546420d-57ce-4ecc-bc49-f98c7b796432","name":"AccountImportFile - Request Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_import_code\": \"{{account_import_code}}\",\n  \"file_name\": \"conversion-accounts.xlsx\",\n  \"file_content_base64\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/AccountImportFile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": {\n    \"status\": \"Not queued\",\n    \"accounts\": 0,\n    \"importsAhead\": 0,\n    \"folderPath\": null,\n    \"records\": []\n  },\n  \"errors\": [\n    \"file_content_base64 is required.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"e0bcf5aa-3b0a-410c-9bdc-ef6b1408279a"},{"name":"AccountImportFileRunning","id":"70138905-59ca-4e60-aced-dffb516bacf0","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/Bulk/AccountImportFile/Running?token={{token}}","description":"<h3 id=\"account-import-file---running\">Account Import File - Running</h3>\n<p>The client's account import files (AccountImportFile) that are running or waiting for their turn, oldest first. Files import one at a time per client; a file no longer listed has finished and its results file is in the folder it was given.</p>\n<p>The caller's API role must permit POST api/Client/Account/SingleNewAccountImport; this route reuses that permission.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/Bulk/AccountImportFile/Running</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list, empty when no account import file is running or waiting. Each item:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid of the run.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td><code>Running</code> or <code>Queued</code> (waiting for the file ahead of it).</td>\n</tr>\n<tr>\n<td><em>userName</em></td>\n<td>The user who sent the file.</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>What it is doing, e.g. <code>Imported 120 of 250 accounts</code> or <code>Queued behind another run of this report; position 1</code>.</td>\n</tr>\n<tr>\n<td><em>processed</em> / <em>total</em></td>\n<td>Accounts done so far and the number in the file (<code>total</code> is null until importing starts).</td>\n</tr>\n<tr>\n<td><em>startedAt</em> / <em>lastActivityAt</em></td>\n<td>Server times the import was queued and last reported progress.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","AccountImportFile","Running"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"204dbf07-09ae-46fe-b778-52175289ae8b","name":"AccountImportFileRunning - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/AccountImportFile/Running?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","AccountImportFile","Running"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"id\": \"6b2f1d7e-0c51-4f3e-9a1d-2f4c8e7b9a10\",\n            \"status\": \"Running\",\n            \"userName\": \"developer\",\n            \"details\": \"Imported 120 of 250 accounts\",\n            \"processed\": 120,\n            \"total\": 250,\n            \"startedAt\": \"2026-10-20T09:14:02.4471203-07:00\",\n            \"lastActivityAt\": \"2026-10-20T09:15:47.0912845-07:00\"\n        },\n        {\n            \"id\": \"c3a8e215-7d94-4b26-8f0e-5a1b9c2d4e63\",\n            \"status\": \"Queued\",\n            \"userName\": \"developer\",\n            \"details\": \"Queued behind another run of this report; position 1\",\n            \"processed\": 0,\n            \"total\": null,\n            \"startedAt\": \"2026-10-20T09:15:10.2286614-07:00\",\n            \"lastActivityAt\": \"2026-10-20T09:15:10.2296720-07:00\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"70138905-59ca-4e60-aced-dffb516bacf0"},{"name":"NextAmountDueBreakDownGet","id":"97c77ddb-0380-4769-b9d8-2473b72e9830","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number_or_id\": \"{{account_number_or_id}}\",\n\t\"calculation_date\": \"{{calculation_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetNextAmountDueBreakDown","description":"<h3 id=\"get-next-amount-due-breakdown\">Get Next Amount Due Breakdown</h3>\n<p>This method is used to retrieve the detailed breakdown of the next amount due for an account as of a specific date.</p>\n<p><strong>HTTP Method:</strong> POST<br /><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/GetNextAmountDueBreakDown</code></p>\n<h4 id=\"request-parameters\">Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional string. The authentication token assigned to you by the Login method if not using the dynamic signature.</td>\n</tr>\n<tr>\n<td><em>account_number_or_id</em></td>\n<td>Required string. The account number or ID associated with the account.</td>\n</tr>\n<tr>\n<td><em>calculation_date</em></td>\n<td>Optional string. The date for which the calculation is to be performed, formatted as YYYY-MM-DD.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetNextAmountDueBreakDown"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0fe6dcd8-bdcd-44bc-be41-4ab35dfbade4","name":"GetNextAmountDueBreakDown - Successful No Calculation Date","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number_or_id\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetNextAmountDueBreakDown"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudFxHZXROZXh0QW1vdW50RHVlQnJlYWtEb3du?="},{"key":"Date","value":"Wed, 03 Sep 2025 18:16:59 GMT"},{"key":"Content-Length","value":"168"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"nextAmountDue\": 196.22,\n        \"nextAmountDueBreakdown\": [\n            {\n                \"Description\": \"Current Payment 11/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 196.22\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": null\n}"},{"id":"bde15078-7b34-4840-b068-f7535c90ff58","name":"GetNextAmountDueBreakDown - Successful Past Due Sub Account","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number_or_id\": \"{{account_number}}\",\n\t\"calculation_date\": \"{{calculation_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetNextAmountDueBreakDown"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudFxHZXROZXh0QW1vdW50RHVlQnJlYWtEb3du?="},{"key":"Date","value":"Wed, 03 Sep 2025 18:19:27 GMT"},{"key":"Content-Length","value":"419"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"nextAmountDue\": 4430.49,\n        \"nextAmountDueBreakdown\": [\n            {\n                \"Description\": \"Current Payment 11/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Current SA_Toll 11/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 16.67\n            },\n            {\n                \"Description\": \"Current SA_Premium_C 11/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 41.67\n            },\n            {\n                \"Description\": \"Payment 2/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 3/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 4/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 5/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 6/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 7/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 8/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 9/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"Payment 10/16/2023\",\n                \"Type\": \"Payment\",\n                \"Amount\": 386.21\n            },\n            {\n                \"Description\": \"COLL 10/16/2023\",\n                \"Type\": \"Other Balance\",\n                \"Amount\": 10\n            },\n            {\n                \"Description\": \"LEGAL 6/3/2023\",\n                \"Type\": \"Other Balance\",\n                \"Amount\": 25\n            },\n            {\n                \"Description\": \"LTC 2/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 1\n            },\n            {\n                \"Description\": \"LTC 3/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"LTC 4/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"LTC 5/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"LTC 6/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"LTC 7/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"LTC 8/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"LTC 9/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"LTC 10/25/2023\",\n                \"Type\": \"Late Fee\",\n                \"Amount\": 15\n            },\n            {\n                \"Description\": \"CONVFEE 7/3/2023\",\n                \"Type\": \"Other Balance\",\n                \"Amount\": 10\n            },\n            {\n                \"Description\": \"SA_Toll 5/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 10.68\n            },\n            {\n                \"Description\": \"SA_Toll 6/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 16.67\n            },\n            {\n                \"Description\": \"SA_Toll 7/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 16.67\n            },\n            {\n                \"Description\": \"SA_Toll 8/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 16.67\n            },\n            {\n                \"Description\": \"SA_Toll 9/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 16.67\n            },\n            {\n                \"Description\": \"SA_Toll 10/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 16.67\n            },\n            {\n                \"Description\": \"SA_Premium_C 5/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 41.67\n            },\n            {\n                \"Description\": \"SA_Premium_C 6/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 41.67\n            },\n            {\n                \"Description\": \"SA_Premium_C 7/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 41.67\n            },\n            {\n                \"Description\": \"SA_Premium_C 8/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 41.67\n            },\n            {\n                \"Description\": \"SA_Premium_C 9/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 41.67\n            },\n            {\n                \"Description\": \"SA_Premium_C 10/16/2023\",\n                \"Type\": \"Sub Account\",\n                \"Amount\": 41.67\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": null\n}"},{"id":"2f25af2f-a5a3-48f6-9ee3-8706cd949231","name":"GetNextAmountDueBreakDown - Successful Past Due Payoff","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number_or_id\": \"{{account_number}}\",\n\t\"calculation_date\": \"{{calculation_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetNextAmountDueBreakDown"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudFxHZXROZXh0QW1vdW50RHVlQnJlYWtEb3du?="},{"key":"Date","value":"Wed, 03 Sep 2025 18:34:08 GMT"},{"key":"Content-Length","value":"188"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"nextAmountDue\": 12246.24,\n        \"nextAmountDueBreakdown\": [\n            {\n                \"Description\": \"Current Balance\",\n                \"Type\": \"Payoff\",\n                \"Amount\": 10000\n            },\n            {\n                \"Description\": \"Unpaid Interest\",\n                \"Type\": \"Payoff\",\n                \"Amount\": 2246.24\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": null\n}"},{"id":"bdf2cf36-d65f-4bb4-a6a7-10116be752df","name":"GetNextAmountDueBreakDown - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number_or_id\": \"{{account_number}}\",\n\t\"calculation_date\": \"{{calculation_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetNextAmountDueBreakDown"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudFxHZXROZXh0QW1vdW50RHVlQnJlYWtEb3du?="},{"key":"Date","value":"Wed, 03 Sep 2025 18:35:24 GMT"},{"key":"Content-Length","value":"104"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Account not found.\"\n    ],\n    \"warnings\": null\n}"}],"_postman_id":"97c77ddb-0380-4769-b9d8-2473b72e9830"},{"name":"NextAmountDueBreakDownGetBulk","id":"50cf53bf-58b7-43e1-b81a-4c2e7abd919e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"calculation_date\": \"2026-08-25\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"calculation_date\": \"2026-09-01\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetNextAmountDueBreakDown?token={{token}}","description":"<p>Calculates the next amount due and its breakdown for one to 250 accounts. Every array item has its own required <code>accountNumberOrId</code> and optional <code>calculation_date</code>; the selector accepts an account number or account <code>Id</code> (Guid). Results are returned per account. The route reuses the single-account Next Amount Due Breakdown permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetNextAmountDueBreakDown"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4f74bbbe-33b0-48d9-bb76-3a4602f3a0a1","name":"NextAmountDueBreakDownGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"calculation_date\":\"2026-08-25\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextAmountDueBreakDown?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextAmountDueBreakDown"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"6a7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"nextAmountDue\": 125.00, \"nextAmountDueBreakdown\": [] }\n    }]\n  }\n}"},{"id":"18537d56-c417-4214-af8f-cd2c09b1955b","name":"NextAmountDueBreakDownGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"calculation_date\": \"2026-08-25\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"calculation_date\": \"2026-09-01\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextAmountDueBreakDown?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextAmountDueBreakDown"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"58856d23-cc29-46ef-970b-498ce6308672","name":"NextAmountDueBreakDownGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextAmountDueBreakDown?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextAmountDueBreakDown"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"50cf53bf-58b7-43e1-b81a-4c2e7abd919e"},{"name":"OldAccountNumberSave","id":"fcf27658-b0e3-453b-ac37-7da5d5f75f40","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"newOldAccountNumber\": \"LEGACY-12345\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Conversion/OldAccountNumber","description":"<h3 id=\"save-old-account-number\">Save Old Account Number</h3>\n<p>Updates the legacy \"old\" account number stored on an existing account (used to preserve a pre-conversion identifier alongside the current Omega account number). Wraps <code>AccountConversionWSServices.SaveOldAccountNumberWS</code>, which resolves <code>accountNumberOrId</code> via <code>SharedWSServices.GetCommonAccountId</code> (Guid-first then account-number lookup), loads the account through <code>AccountServices.ReturnAccountEntity</code>, sets the <code>OldAccountNumber</code> column on <code>Common.Account</code>, and persists inside a <code>UnitOfWork2</code>. The <code>System.Web.HttpContext.Current.Server</code> reference is forwarded to the service so any side-effect file paths can be mapped server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/Conversion/OldAccountNumber</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Account number or Guid for the account being updated. Resolved via <code>SharedWSServices.GetCommonAccountId</code>.</td>\n</tr>\n<tr>\n<td><em>newOldAccountNumber</em></td>\n<td>Optional string. Value written to <code>Common.Account.OldAccountNumber</code>. Pass <code>null</code> or empty to clear the column.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code> with <code>statusCode</code>, <code>result</code>, <code>errors</code>, <code>warnings</code>, and <code>data</code> containing the updated account's Guid. Validation failures (missing <code>accountNumberOrId</code>, account not found, optimistic-concurrency conflict) return HTTP 400 with the same envelope.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","Conversion","OldAccountNumber"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"406e2627-19dc-49d3-955f-50410bf6ad41","name":"SaveOldAccountNumber - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"30001212\",\n    \"newOldAccountNumber\": \"LEGACY-12345\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Conversion/OldAccountNumber"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-0000000000A1\"\n}"},{"id":"9c46eda6-0a24-44e6-8b1b-372732f94cee","name":"SaveOldAccountNumber - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"newOldAccountNumber\": \"LEGACY-12345\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Conversion/OldAccountNumber"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"fcf27658-b0e3-453b-ac37-7da5d5f75f40"},{"name":"OldAccountNumberSaveBulk","id":"014cf31b-ab35-48cd-8007-bad3a65d1f52","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"newOldAccountNumber\": \"LEGACY-1212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/UpdateOldAccountNumber?token={{token}}","description":"<h3 id=\"save-old-account-number-bulk\">Save Old Account Number (bulk)</h3>\n<p>Sets the converted-from (old) account number on one to 250 accounts. Every item supplies <code>accountNumberOrId</code> and <code>newOldAccountNumber</code>. Accounts commit independently and Day End is checked before each one. The route reuses the single Save Old Account Number permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","UpdateOldAccountNumber"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fd395b74-e608-445a-830d-daeff3d6c27a","name":"OldAccountNumberSaveBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newOldAccountNumber\": \"LEGACY-1212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateOldAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateOldAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"5d538616-e0e8-4b20-a367-6e72e6785c76","name":"OldAccountNumberSaveBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newOldAccountNumber\": \"LEGACY-1212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"newOldAccountNumber\": \"LEGACY-1212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateOldAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateOldAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"312b9182-2f15-47ef-abe3-1a538a8f64d8","name":"OldAccountNumberSaveBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateOldAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateOldAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"b5992f84-ba1e-4011-9538-d5ca29959396","name":"OldAccountNumberSaveBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/UpdateOldAccountNumber?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","UpdateOldAccountNumber"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"014cf31b-ab35-48cd-8007-bad3a65d1f52"},{"name":"OtherBalanceAdjustmentPost","id":"dadb6fb1-f286-46b3-94ae-7f087e8600a3","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"transaction_number\": \"{{transaction_number}}\",\n  \"adjustment_amount\": \"{{adjustment_amount}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostOtherBalanceAdjustment","description":"<p>Posts an other-balance adjustment transaction against an existing other-balance transaction on the supplied account. When <code>report_mode</code> is <code>true</code>, the adjustment is calculated and validated only and is not committed.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Session id, token, or API key accepted by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>transaction_number</em></td>\n<td>Required int64. Number of the existing other-balance transaction being adjusted.</td>\n</tr>\n<tr>\n<td><em>adjustment_amount</em></td>\n<td>Required decimal. Signed adjustment amount applied to the other-balance transaction.</td>\n</tr>\n<tr>\n<td><em>report_mode</em></td>\n<td>Optional boolean (default <code>false</code>). When <code>true</code>, the adjustment is previewed/validated but not posted.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostOtherBalanceAdjustment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"920ec542-21b4-403d-b265-fdb219bc40d3","name":"PostOtherBalanceAdjustment - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"transaction_number\": \"{{transaction_number}}\",\n  \"adjustment_amount\": \"{{adjustment_amount}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostOtherBalanceAdjustment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"current_balance\": \"$10,251.00\",\n        \"late_other_fees\": \"$10.00\",\n        \"unpaid_sub_accounts\": \"$0.00\",\n        \"total_balance\": \"$10,261.00\",\n        \"unpaid_interest\": \"$5.62\",\n        \"number_of_late_fees\": \"0\",\n        \"number_of_unpaid_sub_accounts\": \"0\",\n        \"number_of_nsfs\": \"0\",\n        \"payment_extensions\": \"0\",\n        \"over_short_amount\": \"$0.00\"\n    },\n    \"errors\": null\n}"},{"id":"120859ad-f160-4914-8f67-a65996ef3fa1","name":"PostOtherBalanceAdjustment - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"transaction_number\": \"{{transaction_number}}\",\n  \"adjustment_amount\": \"{{adjustment_amount}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostOtherBalanceAdjustment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|712b6317-5547-4ba5-8765-e9ca1f9c9141|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 10 Dec 2022 04:39:57 GMT"},{"key":"Content-Length","value":"396"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Amount Due (100.0000) - Amount Paid To Date (100.0000) + Adjustment (-10) must be >= 0\",\n        \"System.Exception: Amount Due (100.0000) - Amount Paid To Date (100.0000) + Adjustment (-10) must be >= 0\\r\\n   at Omega.FinancialCalculations.BLL.Servicing.AccountTransactionsInstallment.PrivateCalculateOtherBalanceTransactionAdjustment(Guid transId, Decimal adjustmentAmount) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Business\\\\Omega.FinancialCalculations\\\\Omega.FinancialCalculations.BLL\\\\Servicing\\\\AccountTransactionsInstallment.cs:line 6338\\r\\n   at Omega.FinancialCalculations.BLL.Servicing.AccountTransactionsInstallment.CalculateOtherBalanceTransactionAdjustment(Guid transId, Decimal adjustmentAmount) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Business\\\\Omega.FinancialCalculations\\\\Omega.FinancialCalculations.BLL\\\\Servicing\\\\AccountTransactionsInstallment.cs:line 6314\\r\\n   at Omega.WebApp.BLL.WebAPI.Client.Controllers.ClientController.PostOtherBalanceAdjustment(PostOtherBalanceAdjustment param) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Omega.WebApp\\\\BLL\\\\WebAPI\\\\Client\\\\Controllers\\\\ClientController.cs:line 1226\"\n    ]\n}"}],"_postman_id":"dadb6fb1-f286-46b3-94ae-7f087e8600a3"},{"name":"OtherBalanceAdjustmentPostBulk","id":"d9b41be3-973d-496b-bfb7-31e63455d8ba","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"transaction_number\": 1001,\n    \"adjustment_amount\": -25,\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostOtherBalanceAdjustment?token={{token}}","description":"<h3 id=\"post-other-balance-adjustment-bulk\">Post Other Balance Adjustment (bulk)</h3>\n<p>Adjusts one other-balance transaction on each of one to 250 accounts. Every item supplies its own <code>transaction_number</code> and <code>adjustment_amount</code>. Set <code>report_mode</code> to true on an item to calculate and return the resulting balances without posting. Accounts commit independently and Day End is checked before each one. The route reuses the single Post Other Balance Adjustment permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostOtherBalanceAdjustment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a8316b38-66d7-48ac-bdb0-193aaa5e5f3d","name":"OtherBalanceAdjustmentPostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"transaction_number\": 1001,\n    \"adjustment_amount\": -25,\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostOtherBalanceAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostOtherBalanceAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"current_balance\":\"$10,100.22\",\"total_balance\":\"$10,450.22\"}}]}}"},{"id":"c168f0a6-0105-4b22-8708-29e7a20c2360","name":"OtherBalanceAdjustmentPostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"transaction_number\": 1001,\n    \"adjustment_amount\": -25,\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"transaction_number\": 1001,\n    \"adjustment_amount\": -25,\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostOtherBalanceAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostOtherBalanceAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"current_balance\":\"$10,100.22\",\"total_balance\":\"$10,450.22\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"495e43b6-50f6-456e-af8b-5b4231c5184d","name":"OtherBalanceAdjustmentPostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostOtherBalanceAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostOtherBalanceAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"acc9a04f-f98c-4ca5-9e4d-7ebf79e5cb17","name":"OtherBalanceAdjustmentPostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostOtherBalanceAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostOtherBalanceAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"d9b41be3-973d-496b-bfb7-31e63455d8ba"},{"name":"PaymentAmountChange","id":"f7b93cfc-f57e-4a3c-a2cd-a027d279025d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"effectiveNextDueDate\": \"{{effective_next_due_date}}\",\n    \"newPaymentAmount\": \"{{new_payment_amount}}\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangePaymentAmount","description":"<h3 id=\"change-payment-amount\">Change Payment Amount</h3>\n<p>Changes an account's payment amount from a given effective next due date onward. Mirrors the Change Payment Amount account maintenance screen. Returns the posted account identifiers, the baseline current payment used, the applied change, the resulting payment, and the generated reference number.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/ChangePaymentAmount</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being updated.</td>\n</tr>\n<tr>\n<td><em>effectiveNextDueDate</em></td>\n<td>Required date. The next-due date from which the new payment applies. Must be on or after the earliest of the account's posting start date, next due date and earnings first due date.</td>\n</tr>\n<tr>\n<td><em>newPaymentAmount</em></td>\n<td>The payment the account should carry from <em>effectiveNextDueDate</em> onward. Supply this <strong>or</strong> <em>paymentChangeAmount</em>, not both.</td>\n</tr>\n<tr>\n<td><em>paymentChangeAmount</em></td>\n<td>The signed delta to apply to the current payment; negative lowers it. Supply this <strong>or</strong> <em>newPaymentAmount</em>, not both.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"notes\">Notes</h4>\n<p>The baseline the delta is measured against is the account's current payment <strong>plus</strong> any pending payment changes already effective on or before <em>effectiveNextDueDate</em> — the same figure the screen shows in its Current Payment field. The resulting payment must be greater than zero.</p>\n<h4 id=\"bulk-route-multiple-accounts\">Bulk route (multiple accounts)</h4>\n<p>For multiple accounts use <code>POST https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePaymentAmount?token={{token}}</code>. Its request body is an array of <code>ChangePaymentAmountParameter</code> objects, so every account can use its own effective next due date, new payment amount, and <code>accountTs</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Body</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>array</em></td>\n<td>One to 100 objects using the same fields documented above. <code>accountNumberOrId</code> accepts an account number or account <code>Id</code> (Guid). Each item must use <code>newPaymentAmount</code>; the signed <code>paymentChangeAmount</code> form is not supported by the bulk route. Duplicate accounts are collapsed and the first item is used.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-request-body-example\">Bulk request body example</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveNextDueDate\": \"06/15/2026\",\n        \"newPaymentAmount\": 350.00\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveNextDueDate\": \"06/20/2026\",\n        \"newPaymentAmount\": 425.00\n    }\n]\n</code></pre><p>Because the body is an array with no top-level <code>token</code>, pass token authentication in the query string as shown above, or use API key headers. The bulk route reuses this single-account route's API Access permission and is not available on SessionId authentication.</p>\n<p>The bulk form returns <strong>HTTP 200 for any batch that was attempted, including one where every account failed</strong> — check <code>statusCode</code>, not the HTTP status. <code>Ok</code> means all succeeded; <code>Successful_With_Error</code> means some or all did not. Per-account outcomes are in <code>data.accounts</code>, each carrying the submitted <code>accountNumberOrId</code>, the resolved <code>accountNumber</code> when found, and that account's own <code>singleStatusCode</code>, <code>errors</code>, <code>warnings</code> and <code>data</code>. Top-level <code>errors</code> is used only for a request-level failure, where nothing was attempted and the response is a 400.</p>\n<p>The bulk route accepts <strong><code>newPaymentAmount</code> only</strong>. <code>paymentChangeAmount</code> is rejected because re-sending a signed delta after a timeout applies it a second time; the absolute form is safe to retry.\n<strong>Billing:</strong> one bulk request counts as a single API call, regardless of how many accounts it contains. The API meter is incremented once per HTTP request at authentication, so sending 100 accounts in one call is metered as 1, not 100.\nAccounts are processed one at a time and each commits independently, so a failure part-way through leaves earlier accounts committed. Re-running is safe for this operation.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","ChangePaymentAmount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1da6a92e-d208-4c29-975f-0c19d0042b46","name":"ChangePaymentAmount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"effectiveNextDueDate\": \"{{effective_next_due_date}}\",\n    \"newPaymentAmount\": \"{{new_payment_amount}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangePaymentAmount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"effectiveNextDueDate\": \"06/15/2026\",\n        \"currentPaymentAmount\": 325.00,\n        \"paymentChangeAmount\": 25.00,\n        \"newPaymentAmount\": 350.00,\n        \"referenceNumber\": \"1000050\"\n    }\n}"},{"id":"29d5d957-8425-48f4-b1da-137f7da04ede","name":"ChangePaymentAmount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"effectiveNextDueDate\": \"{{effective_next_due_date}}\",\n    \"newPaymentAmount\": \"{{new_payment_amount}}\",\n    \"paymentChangeAmount\": \"{{payment_change_amount}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangePaymentAmount"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Supply either newPaymentAmount or paymentChangeAmount, not both.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f7b93cfc-f57e-4a3c-a2cd-a027d279025d"},{"name":"PaymentAmountChangeBulk","id":"45037ebe-239d-4518-bc99-48f570d2e42b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveNextDueDate\": \"06/15/2026\",\n        \"newPaymentAmount\": 350.00,\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveNextDueDate\": \"06/20/2026\",\n        \"newPaymentAmount\": 425.00,\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePaymentAmount?token={{token}}","description":"<h3 id=\"change-payment-amount-bulk\">Change Payment Amount (bulk)</h3>\n<p>Changes payment amounts for up to 250 accounts. Each array item is a complete <code>ChangePaymentAmountParameter</code>, so every account can use its own effective next due date, payment amount, and optional row version.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePaymentAmount?token={{token}}</code></p>\n<h4 id=\"request-body\">Request body</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>effectiveNextDueDate</em></td>\n<td>Required date. Date from which this account's payment applies.</td>\n</tr>\n<tr>\n<td><em>newPaymentAmount</em></td>\n<td>Required positive amount for this account.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for this account.</td>\n</tr>\n</tbody>\n</table>\n</div><p><code>paymentChangeAmount</code> is not supported by the bulk route because retrying a signed delta could apply it twice. Use the absolute <code>newPaymentAmount</code> value for every item.</p>\n<p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers. This route reuses the single-account Change Payment Amount API Access permission and is unavailable with SessionId authentication.</p>\n<p>A valid attempted batch returns HTTP 200; inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes. Each account commits independently. One bulk request is billed as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","ChangePaymentAmount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a8b7dbca-9c7f-4fc6-a905-7769bb55ce7a","name":"ChangePaymentAmount Bulk - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveNextDueDate\": \"06/15/2026\",\n        \"newPaymentAmount\": 350.00\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveNextDueDate\": \"06/20/2026\",\n        \"newPaymentAmount\": 425.00\n    }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePaymentAmount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangePaymentAmount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n        \"requested\": 2,\n        \"total\": 2,\n        \"succeeded\": 2,\n        \"succeededWithError\": 0,\n        \"failed\": 0,\n        \"skipped\": 0,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30001212,\n                \"accountNumberOrId\": \"30001212\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"accountNumber\": \"30001212\",\n                    \"effectiveNextDueDate\": \"06/15/2026\",\n                    \"currentPaymentAmount\": 325.00,\n                    \"paymentChangeAmount\": 25.00,\n                    \"newPaymentAmount\": 350.00,\n                    \"referenceNumber\": \"1000050\"\n                }\n            },\n            {\n                \"accountNumber\": 30001213,\n                \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                    \"accountNumber\": \"30001213\",\n                    \"effectiveNextDueDate\": \"06/20/2026\",\n                    \"currentPaymentAmount\": 375.00,\n                    \"paymentChangeAmount\": 50.00,\n                    \"newPaymentAmount\": 425.00,\n                    \"referenceNumber\": \"1000051\"\n                }\n            }\n        ]\n    }\n}"},{"id":"50690fab-3e47-4085-aa42-3ba891dbb837","name":"PaymentAmountChangeBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"effectiveNextDueDate\": \"06/15/2026\",\n    \"newPaymentAmount\": 350,\n    \"accountTs\": \"\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"effectiveNextDueDate\": \"06/20/2026\",\n    \"newPaymentAmount\": 425,\n    \"accountTs\": \"\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePaymentAmount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangePaymentAmount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"611d1978-7942-40fa-88c1-849976c726c4","name":"PaymentAmountChangeBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePaymentAmount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangePaymentAmount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"45037ebe-239d-4518-bc99-48f570d2e42b"},{"name":"PaymentNoCustomerValidationPost","id":"4bffedf3-4a93-4b1d-a935-2ff594638b82","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPaymentNoCustomerValidation","description":"<p>This method is used to post a customer payment on an account. Customer number is not required to validate before posting a payment. The primary customer payment settings will be used. A reference number is returned upon a successful payment.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>funds_code</em></td>\n<td>Required string. The Omega funds code that will determine the funds type used during the payment posting.</td>\n</tr>\n<tr>\n<td><em>transaction_code</em></td>\n<td>Required string. Omega payment transaction code used which will determine the payment type and waterfall.</td>\n</tr>\n<tr>\n<td><em>transaction_fee_code</em></td>\n<td>Optional string. Omega other balance transaction code. Required if posting a fee along with the payment.</td>\n</tr>\n<tr>\n<td><em>electronic_transaction_id</em></td>\n<td>Optional string. If passed, this call will fail in any existing transactions with the same funds type have this Electronic Transaction Id. Send the same value to Reverse Payment to reverse this payment.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required datetime. Date to post payment as of</td>\n</tr>\n<tr>\n<td><em>payment_amount</em></td>\n<td>Required decimal. Total payment amount</td>\n</tr>\n<tr>\n<td><em>fee_amount</em></td>\n<td>Optional decimal. Payment fee amount, if applicable</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Payment transaction comment. If not passed, a system generated comment will be used instead</td>\n</tr>\n<tr>\n<td><em>check_number</em></td>\n<td>Optional int. Required for Check, 'Cashiers Check', or 'Money Order' funds types. Ignored for all other funds types</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostPaymentNoCustomerValidation"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dcb97e61-3559-4f40-a712-68abfcd341f7","name":"PostPaymentNoCustomerValidation - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"check_number\": \"{{check_number}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPaymentNoCustomerValidation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcUG9zdFBheW1lbnROb0N1c3RvbWVyVmFsaWRhdGlvbg==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 21:58:48 GMT"},{"key":"Content-Length","value":"217"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"current_balance_before_payment\": \"1004.20\",\n        \"total_current_balance_before_payment\": \"1124.20\",\n        \"reference_number\": 12956,\n        \"past_due\": \"1667.31\",\n        \"current_balance\": \"1004.20\",\n        \"total_current_balance\": \"1124.20\",\n        \"current_payoff\": \"1667.31\"\n    },\n    \"errors\": []\n}"},{"id":"1f91b719-7c0e-4f5a-9b1e-4e6fff0c2ad1","name":"PostPaymentNoCustomerValidation - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"check_number\": \"{{check_number}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPaymentNoCustomerValidation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|a6e96278-bb4e-450a-b53a-5778bb43bce6|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 10 Dec 2022 05:24:08 GMT"},{"key":"Content-Length","value":"117"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error posting payment: Invalid transaction fee code\"\n    ]\n}"}],"_postman_id":"4bffedf3-4a93-4b1d-a935-2ff594638b82"},{"name":"PaymentNoCustomerValidationPostBulk","id":"33f5de4b-ef20-4c9a-94ed-d13138f5b282","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentNoCustomerValidation?token={{token}}","description":"<h3 id=\"post-payment-no-customer-validation-bulk\">Post Payment No Customer Validation (bulk)</h3>\n<p>Posts one payment to each of one to 250 accounts without validating a customer number. Every item is a complete payment parameter. The posting engine commits per account, so a batch is best-effort. Day End is checked before each account. The route reuses the single Post Payment No Customer Validation permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostPaymentNoCustomerValidation"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6a606dd4-2de8-4310-ae58-8cc89d6fdf0b","name":"PaymentNoCustomerValidationPostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentNoCustomerValidation?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentNoCustomerValidation"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"payment_amount\":\"$350.00\"}}]}}"},{"id":"995e1c94-6e85-4f48-bc3d-59fc7729ac60","name":"PaymentNoCustomerValidationPostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentNoCustomerValidation?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentNoCustomerValidation"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"payment_amount\":\"$350.00\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"e2228329-f520-4405-9b58-19bdb828e016","name":"PaymentNoCustomerValidationPostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentNoCustomerValidation?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentNoCustomerValidation"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"ecfd7b05-06dd-4580-9b71-8393ab53a148","name":"PaymentNoCustomerValidationPostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentNoCustomerValidation?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentNoCustomerValidation"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"33f5de4b-ef20-4c9a-94ed-d13138f5b282"},{"name":"PaymentPost","id":"80326eaf-3ef7-47ef-a451-6c85f321ef66","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"check_number\": \"{{check_number}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"customerNumberOrId\": \"{{customer_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPayment","description":"<p>This method is used to post a customer payment on an account. A reference number is returned upon a successful payment.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>customer_number</em></td>\n<td>Legacy int32 customer number. Supply this or <code>customerNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same customer. Existing customer/account checks still apply.</td>\n</tr>\n<tr>\n<td><em>funds_code</em></td>\n<td>Required string. The Omega funds code that will determine the funds type used during the payment posting.</td>\n</tr>\n<tr>\n<td><em>transaction_code</em></td>\n<td>Required string. Omega payment transaction code used which will determine the payment type and waterfall.</td>\n</tr>\n<tr>\n<td><em>transaction_fee_code</em></td>\n<td>Optional string. Omega other balance transaction code. Required if posting a fee along with the payment.</td>\n</tr>\n<tr>\n<td><em>electronic_transaction_id</em></td>\n<td>Optional string. If passed, this call will fail in any existing transactions with the same funds type have this Electronic Transaction Id. Send the same value to Reverse Payment to reverse this payment.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required datetime. Date to post payment as of</td>\n</tr>\n<tr>\n<td><em>payment_amount</em></td>\n<td>Required decimal. Total payment amount</td>\n</tr>\n<tr>\n<td><em>fee_amount</em></td>\n<td>Optional decimal. Payment fee amount, if applicable</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Payment transaction comment. If not passed, a system generated comment will be used instead</td>\n</tr>\n<tr>\n<td><em>check_number</em></td>\n<td>Optional int. Required for Check, 'Cashiers Check', or 'Money Order' funds types. Ignored for all other funds types</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n<tr>\n<td><code>customerNumberOrId</code></td>\n<td><code>customer_number</code></td>\n<td>String. customer number (positive 32-bit integer) or customer GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. The selected customer must belong to the account and satisfy this payment operation's existing customer-status/relationship requirements.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\",\n  \"customerNumberOrId\": \"12345\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostPayment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"20418164-805a-4601-98eb-90e99264d0cc","name":"PostPayment - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"Customer_number\": \"{{customer_number}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"check_number\": \"{{check_number}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcUG9zdFBheW1lbnQ=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 21:57:25 GMT"},{"key":"Content-Length","value":"216"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"current_balance_before_payment\": \"1004.20\",\n        \"total_current_balance_before_payment\": \"1264.20\",\n        \"reference_number\": 12955,\n        \"past_due\": \"1819.43\",\n        \"current_balance\": \"1004.20\",\n        \"total_current_balance\": \"1124.20\",\n        \"current_payoff\": \"1819.43\"\n    },\n    \"errors\": []\n}"},{"id":"0405ae3b-db5f-4ea5-92b2-3e1496e5fe0c","name":"PostPayment - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"customer_number\": \"{{customer_number}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"check_number\": \"{{check_number}}\",\n  \"accountNumberOrId\": null,\n  \"customerNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|91e4df9b-5fd2-455a-8d84-dd8825d09529|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Sat, 10 Dec 2022 05:18:29 GMT"},{"key":"Content-Length","value":"112"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error posting payment: Invalid funds code\"\n    ]\n}"}],"_postman_id":"80326eaf-3ef7-47ef-a451-6c85f321ef66"},{"name":"PaymentPostBulk","id":"2acbb62c-85c6-4947-abb6-20e2b76eba72","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"comment\": \"Bulk API payment\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"customerNumberOrId\": \"1\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostPayment?token={{token}}","description":"<h3 id=\"post-payment-bulk\">Post Payment (bulk)</h3>\n<p>Posts one payment to each of one to 250 accounts through the same posting service as the single route. Every item is a complete payment parameter, so each account carries its own funds code, transaction codes, effective date, amount, fee, comment, and check number. The posting engine commits per account, so a batch is best-effort: earlier accounts stay posted when a later one fails, and every account's own result is reported in its row. Day End is checked before each account. The route reuses the single Post Payment permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n<tr>\n<td><code>customerNumberOrId</code></td>\n<td><code>customer_number</code></td>\n<td>String. customer number (positive 32-bit integer) or customer GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged. The selected customer must belong to the account and satisfy this payment operation's existing customer-status/relationship requirements.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\",\n    \"customerNumberOrId\": \"12345\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostPayment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4431fbb9-b81e-4465-bf3b-4883a0ad361f","name":"PaymentPostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"comment\": \"Bulk API payment\",\n    \"accountNumberOrId\": \"30001212\",\n    \"customerNumberOrId\": \"1\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"payment_amount\":\"$350.00\",\"current_balance\":\"$10,100.22\"}}]}}"},{"id":"dc0c3639-fb08-456d-8bf9-20b7e42f3579","name":"PaymentPostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"customer_number\": 1,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"comment\": \"Bulk API payment\",\n    \"accountNumberOrId\": null,\n    \"customerNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"customer_number\": 1,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"comment\": \"Bulk API payment\",\n    \"accountNumberOrId\": null,\n    \"customerNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"payment_amount\":\"$350.00\",\"current_balance\":\"$10,100.22\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"3b2f9cd4-8717-4697-9dd7-7a12dfc5b97f","name":"PaymentPostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"aa88c00f-7bbc-494a-a0a8-13d94a64ee9a","name":"PaymentPostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"2acbb62c-85c6-4947-abb6-20e2b76eba72"},{"name":"PaymentToBankPost","id":"37267ee9-edc0-4c36-b0a1-f2f2a8e20add","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"bank_account_id\": \"{{bank_account_id}}\",\n  \"branch_id\": \"{{branch_id}}\",\n  \"gl_account_id\": \"{{gl_account_id}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"checkNumber\": \"{{check_number}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"customerNumberOrId\": \"{{customer_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPaymentToBank","description":"<p>Posts a customer payment directly to a caller-selected branch bank account without using a teller drawer. A reference number is returned upon a successful payment.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>customer_number</em></td>\n<td>Legacy int32 customer number. Supply this or <code>customerNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same customer. Existing customer/account checks still apply.</td>\n</tr>\n<tr>\n<td><em>bank_account_id</em></td>\n<td>Required string. The full bank account number known to the client, or the internal <code>AccountsPayable.BankAccount.Id</code> GUID.</td>\n</tr>\n<tr>\n<td><em>branch_id</em></td>\n<td>Required string. The branch number known to the client, or the internal <code>Setup.Branch.Id</code> GUID. It must match the payment account's branch.</td>\n</tr>\n<tr>\n<td><em>gl_account_id</em></td>\n<td>Required string. The general-ledger account number known to the client, or the internal <code>GeneralLedger.Account.Id</code> GUID. Together with <em>bank_account_id</em> and <em>branch_id</em>, this selects the exact branch-bank mapping used for posting.</td>\n</tr>\n<tr>\n<td><em>funds_code</em></td>\n<td>Required string. Omega funds code that determines the funds type. Integrated-vendor funds types must use the appropriate vendor API.</td>\n</tr>\n<tr>\n<td><em>transaction_code</em></td>\n<td>Required string. Omega regular- or extension-payment transaction code that determines the payment waterfall.</td>\n</tr>\n<tr>\n<td><em>transaction_fee_code</em></td>\n<td>Optional string. Omega miscellaneous other-balance transaction code; required when <em>fee_amount</em> is greater than zero.</td>\n</tr>\n<tr>\n<td><em>electronic_transaction_id</em></td>\n<td>Optional string. Unique external payment reference for this funds type. Send the same value to Reverse Payment to reverse this payment.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required datetime. Date on which to post the payment; it cannot be after the current branch date.</td>\n</tr>\n<tr>\n<td><em>payment_amount</em></td>\n<td>Required decimal. Payment amount, greater than zero with at most two decimal places.</td>\n</tr>\n<tr>\n<td><em>fee_amount</em></td>\n<td>Optional decimal. Non-negative payment fee with at most two decimal places.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Payment comment of at most 30 characters; Omega supplies one when omitted.</td>\n</tr>\n<tr>\n<td><em>checkNumber</em></td>\n<td>Optional integer string. Required for funds types that require a check number.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n<tr>\n<td><code>customerNumberOrId</code></td>\n<td><code>customer_number</code></td>\n<td>String. customer number (positive 32-bit integer) or customer GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. The selected customer must belong to the account and satisfy this payment operation's existing customer-status/relationship requirements.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\",\n  \"customerNumberOrId\": \"12345\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostPaymentToBank"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"004f8181-6cb4-47be-8bba-2b1018aadc94","name":"PostPaymentToBank - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"bank_account_id\": \"{{bank_account_id}}\",\n  \"branch_id\": \"{{branch_id}}\",\n  \"gl_account_id\": \"{{gl_account_id}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"transaction_fee_code\": \"{{transaction_fee_code}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"fee_amount\": \"{{fee_amount}}\",\n  \"comment\": \"{{comment}}\",\n  \"checkNumber\": \"{{check_number}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"customerNumberOrId\": \"{{customer_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPaymentToBank"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"current_balance_before_payment\": \"1004.20\",\n    \"total_current_balance_before_payment\": \"1264.20\",\n    \"reference_number\": 12955,\n    \"past_due\": \"1819.43\",\n    \"current_balance\": \"1004.20\",\n    \"total_current_balance\": \"1124.20\",\n    \"current_payoff\": \"1819.43\"\n  },\n  \"errors\": []\n}"},{"id":"da22ed77-8989-4935-8e27-8cbe9f3b910b","name":"PostPaymentToBank - Invalid Bank","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"customer_number\": \"{{customer_number}}\",\n  \"bank_account_id\": \"00000000-0000-0000-0000-000000000000\",\n  \"branch_id\": \"{{branch_id}}\",\n  \"gl_account_id\": \"{{gl_account_id}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"accountNumberOrId\": null,\n  \"customerNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/PostPaymentToBank"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"Error posting payment to bank: Bank account is not configured for the requested branch and GL account\"\n  ]\n}"}],"_postman_id":"37267ee9-edc0-4c36-b0a1-f2f2a8e20add"},{"name":"PaymentToBankPostBulk","id":"3904ff2e-2a2e-434d-9508-05c1e017f5ab","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"bank_account_id\": \"{{bank_account_id}}\",\n    \"branch_id\": \"{{branch_id}}\",\n    \"gl_account_id\": \"{{gl_account_id}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"customerNumberOrId\": \"1\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentToBank?token={{token}}","description":"<h3 id=\"post-payment-to-bank-bulk\">Post Payment To Bank (bulk)</h3>\n<p>Posts one payment to each of one to 250 accounts and directs each to a specific bank account, branch, and GL account. Every item is a complete parameter, so those three targets may differ per account. The posting engine commits per account, so a batch is best-effort. Day End is checked before each account. The route reuses the single Post Payment To Bank permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n<tr>\n<td><code>customerNumberOrId</code></td>\n<td><code>customer_number</code></td>\n<td>String. customer number (positive 32-bit integer) or customer GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged. The selected customer must belong to the account and satisfy this payment operation's existing customer-status/relationship requirements.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\",\n    \"customerNumberOrId\": \"12345\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostPaymentToBank"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ed3c3619-18a9-4a79-8d1f-d351946bb635","name":"PaymentToBankPostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"bank_account_id\": \"{{bank_account_id}}\",\n    \"branch_id\": \"{{branch_id}}\",\n    \"gl_account_id\": \"{{gl_account_id}}\",\n    \"accountNumberOrId\": \"30001212\",\n    \"customerNumberOrId\": \"1\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentToBank?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentToBank"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"payment_amount\":\"$350.00\"}}]}}"},{"id":"97e549b9-551d-4438-9dd6-6a1b13c6ff72","name":"PaymentToBankPostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"customer_number\": 1,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"bank_account_id\": \"{{bank_account_id}}\",\n    \"branch_id\": \"{{branch_id}}\",\n    \"gl_account_id\": \"{{gl_account_id}}\",\n    \"accountNumberOrId\": null,\n    \"customerNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"customer_number\": 1,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"bank_account_id\": \"{{bank_account_id}}\",\n    \"branch_id\": \"{{branch_id}}\",\n    \"gl_account_id\": \"{{gl_account_id}}\",\n    \"accountNumberOrId\": null,\n    \"customerNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentToBank?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentToBank"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"payment_amount\":\"$350.00\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"eee3f984-4914-4bfd-8b01-16baef816c69","name":"PaymentToBankPostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentToBank?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentToBank"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"c7b4f236-4796-47c0-b9c4-b61db044730b","name":"PaymentToBankPostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostPaymentToBank?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostPaymentToBank"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"3904ff2e-2a2e-434d-9508-05c1e017f5ab"},{"name":"PaymentReverse","id":"d9599eca-81d7-4dde-940d-55ab2eacb37c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"reversal_reason\": \"{{reversal_reason}}\",\n  \"is_nsf\": \"{{is_nsf}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"electronic_transaction_id\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/ReversePayment","description":"<h3 id=\"reverse-payment\">Reverse Payment</h3>\n<p>This endpoint allows the client to reverse a payment by providing the necessary details. The payment can be identified in one of two ways.</p>\n<p><strong>By electronic transaction id.</strong> Send the account, <code>electronic_transaction_id</code>, <code>is_nsf</code>, and optionally <code>reversal_reason</code>. The id is the <code>electronic_transaction_id</code> that was sent when the payment was posted with PostPayment, PostPaymentToBank, or PostPaymentNoCustomerValidation. <code>funds_code</code>, <code>transaction_code</code>, <code>effective_date</code>, and <code>payment_amount</code> are optional; any of them that is sent must match the payment the id identifies, or the request is rejected and nothing is reversed.</p>\n<p><strong>By payment details.</strong> Omit <code>electronic_transaction_id</code> and send <code>funds_code</code>, <code>transaction_code</code>, <code>effective_date</code>, and <code>payment_amount</code>. The first active payment on the account matching all four is reversed.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<ul>\n<li><p><code>token</code> (string): The authentication token.</p>\n</li>\n<li><p><code>account_number</code> (string): The account number for the payment reversal.</p>\n</li>\n<li><p><code>electronic_transaction_id</code> (string, optional): The electronic transaction id saved on the payment when it was posted. When sent, it identifies the payment. It cannot be blank; omit it to identify the payment by details instead.</p>\n</li>\n<li><p><code>funds_code</code> (string): The code for the funds involved in the payment. Required when <code>electronic_transaction_id</code> is not sent.</p>\n</li>\n<li><p><code>transaction_code</code> (string): The transaction code associated with the payment. Required when <code>electronic_transaction_id</code> is not sent.</p>\n</li>\n<li><p><code>effective_date</code> (string): The effective date of the payment being reversed. Required when <code>electronic_transaction_id</code> is not sent.</p>\n</li>\n<li><p><code>payment_amount</code> (string): The amount of the payment to be reversed. Required when <code>electronic_transaction_id</code> is not sent.</p>\n</li>\n<li><p><code>reversal_reason</code> (string): The reason for the payment reversal.</p>\n</li>\n<li><p><code>is_nsf</code> (string): Indicates whether the reversal is due to non-sufficient funds.</p>\n</li>\n</ul>\n<h4 id=\"matching-by-electronic-transaction-id\">Matching by electronic transaction id</h4>\n<ul>\n<li>Only payments on the requested account are searched. The id must match exactly, ignoring case and leading or trailing spaces.</li>\n<li>Post-payment rejects a duplicate id only within the same funds type, so one account can hold two payments with the same id. If more than one active payment on the account uses the id, the request is rejected; send <code>funds_code</code> to choose the payment.</li>\n<li>A payment already reversed returns \"Transaction is already reversed on Omega\". An id that is not on the account returns \"Payment not found for electronic_transaction_id ... on account ...\".</li>\n<li>Payments made through an integrated payment vendor cannot be reversed through this endpoint.</li>\n</ul>\n<h4 id=\"other-rules\">Other rules</h4>\n<ul>\n<li>A payment can only be reversed by the API user that posted it.</li>\n<li>A cash payment cannot be reversed as NSF.</li>\n<li>An NSF reversal of a payment that was posted directly to a bank (PostPaymentToBank, or a teller set to post API transactions to the bank) uses that same bank.</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p>The response to the request will contain the status of the payment reversal operation. On success, <code>data</code> includes <code>reversed_transaction_number</code> (the Omega transaction number of the payment that was reversed) and <code>electronic_transaction_id</code> (the id saved on that payment, if any).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","ReversePayment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"171d4ce3-7edc-4c42-9568-d86cb3a4c01d","name":"ReversePayment - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"reversal_reason\": \"{{reversal_reason}}\",\n  \"is_nsf\": \"{{is_nsf}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ReversePayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"reference_number\": 12961,\n        \"reversed_transaction_number\": 42,\n        \"electronic_transaction_id\": null,\n        \"past_due\": \"0.00\",\n        \"current_balance\": \"1264.20\",\n        \"total_current_balance\": \"1264.20\",\n        \"current_payoff\": \"1819.43\",\n        \"branch_id\": \"6f9619ff-8b86-d011-b42d-00cf4fc964ff\",\n        \"current_transaction_id\": \"c1d2e3f4-1111-2222-3333-444455556666\"\n    },\n    \"errors\": []\n}"},{"id":"d087101c-fb94-4399-834e-0d193d3bf893","name":"ReversePayment - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"funds_code\": \"{{funds_code}}\",\n  \"transaction_code\": \"BADCODE\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"payment_amount\": \"{{payment_amount}}\",\n  \"reversal_reason\": \"{{reversal_reason}}\",\n  \"is_nsf\": \"{{is_nsf}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ReversePayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error reversing payment: Invalid transaction code.\"\n    ]\n}"},{"id":"1d6fed73-9c20-408b-9560-34792f1b9c16","name":"ReversePayment - By Electronic Id Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n  \"reversal_reason\": \"{{reversal_reason}}\",\n  \"is_nsf\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ReversePayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"reference_number\": 12963,\n        \"reversed_transaction_number\": 43,\n        \"electronic_transaction_id\": \"MFS-874991\",\n        \"past_due\": \"0.00\",\n        \"current_balance\": \"1265.20\",\n        \"total_current_balance\": \"1265.20\",\n        \"current_payoff\": \"1820.43\",\n        \"branch_id\": \"6f9619ff-8b86-d011-b42d-00cf4fc964ff\",\n        \"current_transaction_id\": \"c1d2e3f4-1111-2222-3333-444455557777\"\n    },\n    \"errors\": []\n}"},{"id":"56718a68-7c41-4cfc-9b23-ee052135f8c3","name":"ReversePayment - By Electronic Id Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumberOrId\": \"{{account_number}}\",\n  \"electronic_transaction_id\": \"NOT-ON-THIS-ACCOUNT\",\n  \"reversal_reason\": \"{{reversal_reason}}\",\n  \"is_nsf\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/ReversePayment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error reversing payment: Payment Reversal API call failed. Payment not found for electronic_transaction_id 'NOT-ON-THIS-ACCOUNT' on account 30011709.\"\n    ]\n}"}],"_postman_id":"d9599eca-81d7-4dde-940d-55ab2eacb37c"},{"name":"PaymentReverseBulk","id":"80ecf782-bae4-4cde-ae0a-98b91218c3fb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"reversal_reason\": \"Bulk API reversal\",\n    \"is_nsf\": false,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  },\n  {\n    \"electronic_transaction_id\": \"{{electronic_transaction_id}}\",\n    \"reversal_reason\": \"Bulk API reversal by electronic id\",\n    \"is_nsf\": false,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/ReversePayment?token={{token}}","description":"<h3 id=\"reverse-payment-bulk\">Reverse Payment (bulk)</h3>\n<p>Reverses one payment on each of one to 250 accounts through the same reversal service as the single route. Each item identifies its payment either by <code>electronic_transaction_id</code> or by funds code, transaction code, effective date, and amount, with its own reason and <code>is_nsf</code> flag, so a batch may mix both forms and mix ordinary reversals with NSF reversals. The matching rules are the same as the single Reverse Payment route. Accounts commit independently and Day End is checked before each one. The route reuses the single Reverse Payment permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","ReversePayment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f556202c-d2e9-4e3a-8089-f051e190efac","name":"PaymentReverseBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"reversal_reason\": \"Bulk API reversal\",\n    \"is_nsf\": false,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ReversePayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ReversePayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"reversal_reference\":\"R-1001\"}}]}}"},{"id":"f3f53c81-0fe4-403a-83a4-4fbb3cc97428","name":"PaymentReverseBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"reversal_reason\": \"Bulk API reversal\",\n    \"is_nsf\": false,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"funds_code\": \"{{funds_code}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"payment_amount\": 350,\n    \"reversal_reason\": \"Bulk API reversal\",\n    \"is_nsf\": false,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ReversePayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ReversePayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"reversal_reference\":\"R-1001\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"f0a4de29-ca48-4d33-9cfb-eb097f40f142","name":"PaymentReverseBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ReversePayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ReversePayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"2840e818-fd63-4af1-bbcd-fe5859ae468f","name":"PaymentReverseBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ReversePayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ReversePayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"80ecf782-bae4-4cde-ae0a-98b91218c3fb"},{"name":"PayOffAmountGet","id":"0c7a42a2-f782-4f50-b554-c4aa0ad0effe","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\": \"{{account_number}}\",\n    \"date\": \"{{date}}\",\n    \"include_late_fee\": \"{{include_late_fee}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetPayOffAmount","description":"<h3 id=\"get-pay-off-amount\">Get Pay Off Amount</h3>\n<p>This method is used to calculate total payoff amount for an account as of a specific date.</p>\n<p><strong>HTTP Method:</strong> POST<br /><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/GetPayOffAmount</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional string. The authentication token assigned to you by the Login method if not using the dynamic signature.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required int64. The Omega account number for which the payoff amount is being requested.</td>\n</tr>\n<tr>\n<td><em>date</em></td>\n<td>Required string. The date for which the calculation is to be performed, formatted as YYYY-MM-DD.</td>\n</tr>\n<tr>\n<td><em>include_late_fee</em></td>\n<td>Required boolean. Indicates whether to include late fees in the payoff amount calculation.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetPayOffAmount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bdebd5d5-44f6-4def-a015-59670e62d928","name":"GetPayOffAmount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\": \"{{account_number}}\",\n    \"date\": \"{{date}}\",\n    \"include_late_fee\": \"{{include_late_fee}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetPayOffAmount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudFxHZXRQYXlPZmZBbW91bnQ=?="},{"key":"Date","value":"Wed, 03 Sep 2025 18:15:47 GMT"},{"key":"Content-Length","value":"80"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Ok\",\n    \"data\": {\n        \"payoff_amount\": \"2028.04\"\n    },\n    \"errors\": []\n}"},{"id":"169495d5-c261-4c24-a56a-63be6aa20e85","name":"GetPayOffAmount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\": \"{{account_number}}\",\n    \"date\": \"{{date}}\",\n    \"include_late_fee\": \"{{include_late_fee}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetPayOffAmount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudFxHZXRQYXlPZmZBbW91bnQ=?="},{"key":"Date","value":"Wed, 03 Sep 2025 18:14:40 GMT"},{"key":"Content-Length","value":"100"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Please pick the date after current branch date.\"\n    ]\n}"}],"_postman_id":"0c7a42a2-f782-4f50-b554-c4aa0ad0effe"},{"name":"PayOffAmountGetBulk","id":"f9e1b516-5bd7-415c-9e08-c95f0fa35448","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmount?token={{token}}","description":"<p>Calculates payoff amounts for one to 250 accounts. Each array item requires <code>accountNumberOrId</code> and <code>date</code>, and may independently set <code>include_late_fee</code>. The selector accepts an account number or account <code>Id</code> (Guid). The route returns per-account results and reuses the single-account Payoff Amount permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetPayOffAmount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"8fbcff04-eacc-4b36-881b-8a9c31826bbb","name":"PayOffAmountGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"date\":\"2026-09-01\",\"include_late_fee\":true}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"7a7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"payoff_amount\": 1025.42 }\n    }]\n  }\n}"},{"id":"bc2dd951-3266-4a89-8466-de9e87f05302","name":"PayOffAmountGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"537ba11f-d70a-4b41-b310-925c7df25736","name":"PayOffAmountGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"f9e1b516-5bd7-415c-9e08-c95f0fa35448"},{"name":"PayOffAmountWithBreakdownGetBulk","id":"dbada154-5ff5-4550-a8e6-f265741b8b74","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithBreakdown?token={{token}}","description":"<p>Calculates payoff amounts and breakdowns for one to 250 accounts. Every array item supplies its own <code>accountNumberOrId</code>, <code>date</code>, and optional <code>include_late_fee</code>. The selector accepts an account number or account <code>Id</code> (Guid). The route reuses the single-account Payoff With Breakdown permission and returns one result row per account.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetPayOffAmountWithBreakdown"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"b7fe9cf9-5c89-48ac-ae92-01357271f64f","name":"PayOffAmountWithBreakdownGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"date\":\"2026-09-01\",\"include_late_fee\":true}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithBreakdown?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmountWithBreakdown"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"ca7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"payoff_amount\": 1025.42, \"date_used\": \"2026-09-01\", \"breakdown_items\": [] }\n    }]\n  }\n}"},{"id":"dadd9a70-2e5e-4faf-a327-2429be200fb4","name":"PayOffAmountWithBreakdownGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithBreakdown?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmountWithBreakdown"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"72ce177d-8f10-447c-b12b-2cbb63dd8a8b","name":"PayOffAmountWithBreakdownGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithBreakdown?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmountWithBreakdown"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"dbada154-5ff5-4550-a8e6-f265741b8b74"},{"name":"PayOffAmountWithEarningsGet","id":"243864d0-f683-4fb4-9c7a-189fec1e4dfa","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"{{account_number}}\",\n    \"date\": \"{{date}}\",\n    \"include_late_fee\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/GetPayOffAmountWithEarnings","description":"<h3 id=\"get-pay-off-amount-with-earnings\">Get Pay Off Amount With Earnings</h3>\n<p>Calculates the total payoff amount for an account as of a specific date and returns the payoff broken down by earned vs. unearned finance-charge components. Wraps <code>AccountWSServices.CalculatePayoffWithEarnings</code>, which loads the account installment via <code>AccountTransactionsInstallment.ReturnAccountTransactionsInstallment</code> and applies the class's <code>FinanceChargeEarningsMethod</code> / <code>FinanceChargeEarningsBasis</code> (precompute vs. interest-bearing, accrual vs. cash basis). Use this instead of <code>GetPayOffAmount</code> when the caller needs the rebate split, earned finance charge, and unpaid interest in addition to the payoff amount.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/GetPayOffAmountWithEarnings</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional string. The authentication token assigned by the Login method. Required unless the request is signed with the dynamic-signature headers (<code>publicKey</code>, <code>timeStamp</code>, <code>signature</code>).</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required string. The Omega account number or Guid account id. Resolved through <code>SharedWSServices.GetCommonAccountId</code>; a missing match returns <code>\"Account not found.\"</code>.</td>\n</tr>\n<tr>\n<td><em>date</em></td>\n<td>Required string. The payoff calculation date in a format accepted by <code>DateTime.TryParse</code> (e.g. <code>YYYY-MM-DD</code>). Must be greater than or equal to the client's current branch date or the call fails with <code>\"Please pick the date after current branch date.\"</code>.</td>\n</tr>\n<tr>\n<td><em>include_late_fee</em></td>\n<td>Required boolean. When <code>true</code>, any outstanding late fee is included in the payoff amount.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns the standard API wrapper (<code>statusCode</code>, <code>result</code>, <code>data</code>, <code>errors</code>, <code>warnings</code>) with a <code>data</code> block containing: <code>payoff_amount</code>, <code>is_precompute</code>, <code>rebate_label</code>, <code>finance_charge_rebate</code>, <code>original_finance_charge</code>, <code>earned_finance_charge</code>, and <code>unpaid_interest</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","GetPayOffAmountWithEarnings"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"05c992df-3444-4482-97de-7f1d999f519f","name":"GetPayOffAmountWithEarnings - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"30001212\",\n    \"date\": \"2026-04-30\",\n    \"include_late_fee\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/GetPayOffAmountWithEarnings"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Ok\",\n    \"data\": {\n        \"payoff_amount\": 12845.72,\n        \"is_precompute\": true,\n        \"rebate_label\": \"Rule of 78\",\n        \"finance_charge_rebate\": 412.18,\n        \"original_finance_charge\": 1850.00,\n        \"earned_finance_charge\": 1437.82,\n        \"unpaid_interest\": 0.00\n    },\n    \"errors\": []\n}"},{"id":"ed54d8bc-5cd0-4f9c-9431-8f63631d9aea","name":"GetPayOffAmountWithEarnings - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": \"99999999\",\n    \"date\": \"2026-04-30\",\n    \"include_late_fee\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/GetPayOffAmountWithEarnings"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Account not found.\"\n    ]\n}"}],"_postman_id":"243864d0-f683-4fb4-9c7a-189fec1e4dfa"},{"name":"PayOffAmountWithEarningsGetBulk","id":"0be1d65f-f3e3-4679-8e88-49dffe9baee8","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithEarnings?token={{token}}","description":"<p>Calculates payoff and earnings details for one to 250 accounts. Every array item supplies its own <code>accountNumberOrId</code>, <code>date</code>, and optional <code>include_late_fee</code>. Account number and account <code>Id</code> (Guid) selectors can be mixed. This route reuses the single-account Payoff With Earnings permission and returns one result row per account.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetPayOffAmountWithEarnings"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c83db1d1-9c71-4de8-9964-7e16a4357803","name":"PayOffAmountWithEarningsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"date\":\"2026-09-01\",\"include_late_fee\":true}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithEarnings?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmountWithEarnings"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"8a7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"payoff_amount\": 1025.42, \"is_precompute\": false, \"earned_finance_charge\": 25.42 }\n    }]\n  }\n}"},{"id":"4a8964cf-75c5-4ee7-9f4e-f62518198afa","name":"PayOffAmountWithEarningsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"date\": \"2026-09-01\",\n    \"include_late_fee\": true\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"date\": \"2026-09-15\",\n    \"include_late_fee\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithEarnings?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmountWithEarnings"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"5d75f667-6ff4-4166-adb1-debd80982403","name":"PayOffAmountWithEarningsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPayOffAmountWithEarnings?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPayOffAmountWithEarnings"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"0be1d65f-f3e3-4679-8e88-49dffe9baee8"},{"name":"PendingPaymentChangeGridGet","id":"6cc32952-d3ba-4bc6-acc4-b3542300ea70","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/{{account_number_or_id}}/Grid?currentPayment=350.00","description":"<h3 id=\"get-pending-payment-change-grid\">Get Pending Payment Change Grid</h3>\n<p>Returns a flattened grid-friendly projection of the pending payment amount changes for the specified account, with a running <code>NewPayment</code> total computed from the supplied <code>currentPayment</code>. Wraps <code>AccountPendingPaymentAmountChangeWSServices.ReturnPendingPaymentChangeGridWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountPendingPaymentAmountChangeServices.ReturnPendingPaymentChangeGrid(accountId, currentPayment, databaseName)</code>. Each row exposes <code>SourceType</code> as the friendly enum name (e.g. <code>Maintenance</code>, <code>Payment</code>, <code>RateChange</code>) from <code>TransactionSource</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/{accountNumberOrId}/Grid?currentPayment={decimal}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>currentPayment</em></td>\n<td>Required. Decimal. The account's current payment amount used as the baseline for computing the running <code>NewPayment</code> total on each grid row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountPendingPaymentAmountChange","{{account_number_or_id}}","Grid"],"host":["{{base_url}}"],"query":[{"key":"currentPayment","value":"350.00"}],"variable":[]}},"response":[{"id":"0e000690-ecad-45d8-be7e-e60717afaf66","name":"GetPendingPaymentChangeGrid - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/30001212/Grid?currentPayment=350.00","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountPendingPaymentAmountChange","30001212","Grid"],"query":[{"key":"currentPayment","value":"350.00"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000B01\",\n            \"Ts\": \"AAAAAAAAB9E=\",\n            \"EffectiveNextDueDate\": \"2026-05-01T00:00:00\",\n            \"PaymentChange\": 25.00,\n            \"NewPayment\": 375.00,\n            \"SourceType\": \"RateChange\",\n            \"Comment\": \"Rate adjustment effective next cycle\"\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000B02\",\n            \"Ts\": \"AAAAAAAAB9I=\",\n            \"EffectiveNextDueDate\": \"2026-06-01T00:00:00\",\n            \"PaymentChange\": -10.00,\n            \"NewPayment\": 365.00,\n            \"SourceType\": \"Payment\",\n            \"Comment\": \"Partial curtailment re-amortization\"\n        }\n    ]\n}"},{"id":"7924040d-ba8e-4910-87ed-1733edf8c04d","name":"GetPendingPaymentChangeGrid - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Account/AccountPendingPaymentAmountChange/99999999/Grid?currentPayment=350.00","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","AccountPendingPaymentAmountChange","99999999","Grid"],"query":[{"key":"currentPayment","value":"350.00"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"6cc32952-d3ba-4bc6-acc4-b3542300ea70"},{"name":"PendingPaymentChangeGridGetBulk","id":"bfe5798f-3b49-435f-9f17-21b5de735c47","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"currentPayment\": 125.00 },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"currentPayment\": 240.00 }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChangeGrid?token={{token}}","description":"<p>Returns the pending-payment-change grid for one to 250 accounts. Every item supplies its own account number or account ID and <code>currentPayment</code> amount. The route reuses the single Pending Payment Change Grid permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetPendingPaymentChangeGrid"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ca5ce168-3993-4459-8cd9-aeb329bef5ad","name":"PendingPaymentChangeGridGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"currentPayment\":125}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChangeGrid?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPendingPaymentChangeGrid"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":[{\"effectiveDate\":\"2026-09-01\",\"paymentAmount\":140}]}]}}"},{"id":"12a2d726-5905-40e4-9ce4-61a840974137","name":"PendingPaymentChangeGridGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"currentPayment\": 125\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"currentPayment\": 240\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChangeGrid?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPendingPaymentChangeGrid"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"e881e053-9d55-4e86-9a5b-9a2e8b01e7fe","name":"PendingPaymentChangeGridGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPendingPaymentChangeGrid?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPendingPaymentChangeGrid"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"bfe5798f-3b49-435f-9f17-21b5de735c47"},{"name":"NextEFTDraftGetBulk","id":"6c9ae26a-2468-496e-8b00-993dd20581a8","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetNextEFTDraft?token={{token}}","description":"<p>Returns the next scheduled EFT draft for one to 250 accounts. Each array item requires <code>accountNumberOrId</code>, accepting an account number or account <code>Id</code> (Guid). Results are returned per account and this route reuses the single-account Next EFT Draft permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetNextEFTDraft"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"53a47848-b03b-4be3-8852-3e9f6494b03d","name":"NextEFTDraftGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextEFTDraft?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextEFTDraft"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"fa7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"nextEFTDraft\": \"2026-09-01T00:00:00\" }\n    }]\n  }\n}"},{"id":"b98951db-43f8-4ddb-bf76-26f877b6b7e7","name":"NextEFTDraftGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextEFTDraft?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextEFTDraft"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"ef87edf2-ed3b-410a-ac6c-f5d24f7a96c7","name":"NextEFTDraftGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextEFTDraft?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextEFTDraft"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"6c9ae26a-2468-496e-8b00-993dd20581a8"},{"name":"NextOneTimePaymentGetBulk","id":"57a4dd01-1ea6-4eae-a68a-fb7648a24bcb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetNextOneTimePayment?token={{token}}","description":"<p>Returns the next scheduled one-time payment and pending count for one to 250 accounts. Each array item requires <code>accountNumberOrId</code>, accepting an account number or account <code>Id</code> (Guid). Results are returned per account and this route reuses the single-account Next One-Time Payment permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetNextOneTimePayment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"55ff0230-b42a-4149-bd80-c165284ccdd2","name":"NextOneTimePaymentGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextOneTimePayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextOneTimePayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"0b7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\", \"errors\": [], \"warnings\": [],\n      \"data\": { \"nextOneTimePayment\": \"2026-09-05T00:00:00\", \"pendingPaymentsCount\": 1 }\n    }]\n  }\n}"},{"id":"9ce51386-4cfd-4ec0-b3ea-111efd21b35b","name":"NextOneTimePaymentGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextOneTimePayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextOneTimePayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"699ef7fe-ebff-4b0c-9a6b-ab5871207fd7","name":"NextOneTimePaymentGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetNextOneTimePayment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetNextOneTimePayment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"57a4dd01-1ea6-4eae-a68a-fb7648a24bcb"},{"name":"PortfolioChange","id":"f04c809f-eefa-4d42-b1f1-cafda91d7b1c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"newPortfolioNumberOrId\": \"{{new_portfolio_number}}\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangePortfolio","description":"<h3 id=\"change-portfolio\">Change Portfolio</h3>\n<p>Changes an account's portfolio assignment. Mirrors the Change Portfolio account maintenance screen. Returns the posted account identifiers, the old and new portfolio IDs, the effective date used, and the generated reference number.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/ChangePortfolio</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being updated.</td>\n</tr>\n<tr>\n<td><em>newPortfolioNumberOrId</em></td>\n<td>Optional string. Portfolio number or portfolio <code>Id</code> (Guid) to assign. Leave blank to clear the portfolio assignment.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date of the portfolio change. When omitted, the current branch date is used.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-route-multiple-accounts\">Bulk route (multiple accounts)</h4>\n<p>For multiple accounts use <code>POST https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePortfolio?token={{token}}</code>. Its request body is an array of <code>ChangePortfolioParameter</code> objects, so every account can use its own portfolio, effective date, and <code>accountTs</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Body</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>array</em></td>\n<td>One to 100 objects using the same fields documented above. <code>accountNumberOrId</code> accepts an account number or account <code>Id</code> (Guid). Duplicate accounts are collapsed and the first item is used.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-request-body-example\">Bulk request body example</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newPortfolioNumberOrId\": \"100\",\n        \"effectiveDate\": \"04/18/2026\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newPortfolioNumberOrId\": \"200\",\n        \"effectiveDate\": \"04/19/2026\"\n    }\n]\n</code></pre><p>Because the body is an array with no top-level <code>token</code>, pass token authentication in the query string as shown above, or use API key headers. The bulk route reuses this single-account route's API Access permission and is not available on SessionId authentication.</p>\n<p>The bulk form returns <strong>HTTP 200 for any batch that was attempted, including one where every account failed</strong> — check <code>statusCode</code>, not the HTTP status. <code>Ok</code> means all succeeded; <code>Successful_With_Error</code> means some or all did not. Per-account outcomes are in <code>data.accounts</code>, each carrying the submitted <code>accountNumberOrId</code>, the resolved <code>accountNumber</code> when found, and that account's own <code>singleStatusCode</code>, <code>errors</code>, <code>warnings</code> and <code>data</code>. Top-level <code>errors</code> is used only for a request-level failure, where nothing was attempted and the response is a 400.</p>\n<p><strong>Billing:</strong> one bulk request counts as a single API call, regardless of how many accounts it contains. The API meter is incremented once per HTTP request at authentication, so sending 100 accounts in one call is metered as 1, not 100.\nAccounts are processed one at a time and each commits independently, so a failure part-way through leaves earlier accounts committed. Re-running is safe for this operation.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","ChangePortfolio"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e7bad0b4-4717-4918-8837-611b5f1866a0","name":"ChangePortfolio - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"newPortfolioNumberOrId\": \"{{new_portfolio_number}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangePortfolio"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"oldPortfolioId\": \"00000000-0000-0000-0000-000000000000\",\n        \"newPortfolioId\": \"00000000-0000-0000-0000-000000000000\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"referenceNumber\": \"1000048\"\n    }\n}"},{"id":"376259cc-ee57-4197-b9d0-e29d8f958363","name":"ChangePortfolio - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"newPortfolioNumberOrId\": \"{{new_portfolio_number}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/ChangePortfolio"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f04c809f-eefa-4d42-b1f1-cafda91d7b1c"},{"name":"PortfolioChangeBulk","id":"54dcd7a4-de69-402c-ab45-85720d8731fd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newPortfolioNumberOrId\": \"100\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newPortfolioNumberOrId\": \"200\",\n        \"effectiveDate\": \"04/19/2026\",\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePortfolio?token={{token}}","description":"<h3 id=\"change-portfolio-bulk\">Change Portfolio (bulk)</h3>\n<p>Changes portfolio assignments for up to 250 accounts. Each array item is a complete <code>ChangePortfolioParameter</code>, so its account, portfolio, effective date, and optional row version are independent from the other items.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePortfolio?token={{token}}</code></p>\n<h4 id=\"request-body\">Request body</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>newPortfolioNumberOrId</em></td>\n<td>Optional string. Portfolio number or <code>Id</code> to assign. Leave blank to clear the portfolio assignment.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Uses the current branch date when omitted.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for this account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers. This route reuses the single-account Change Portfolio API Access permission and is unavailable with SessionId authentication.</p>\n<p>A valid attempted batch returns HTTP 200; inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes. Each account commits independently. One bulk request is billed as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","ChangePortfolio"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"2bb7d376-2b15-45fa-992e-6c36d32e9e0b","name":"ChangePortfolio Bulk - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"newPortfolioNumberOrId\": \"100\",\n        \"effectiveDate\": \"04/18/2026\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"newPortfolioNumberOrId\": \"200\",\n        \"effectiveDate\": \"04/19/2026\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePortfolio?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangePortfolio"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n        \"requested\": 2,\n        \"total\": 2,\n        \"succeeded\": 2,\n        \"succeededWithError\": 0,\n        \"failed\": 0,\n        \"skipped\": 0,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30001212,\n                \"accountNumberOrId\": \"30001212\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"accountNumber\": \"30001212\",\n                    \"oldPortfolioId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"newPortfolioId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"effectiveDate\": \"04/18/2026\",\n                    \"referenceNumber\": \"1000048\"\n                }\n            },\n            {\n                \"accountNumber\": 30001213,\n                \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                    \"accountNumber\": \"30001213\",\n                    \"oldPortfolioId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"newPortfolioId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"effectiveDate\": \"04/19/2026\",\n                    \"referenceNumber\": \"1000049\"\n                }\n            }\n        ]\n    }\n}"},{"id":"c1336fdd-843d-4406-8e5c-1768895461a4","name":"PortfolioChangeBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"newPortfolioNumberOrId\": \"100\",\n    \"effectiveDate\": \"04/18/2026\",\n    \"accountTs\": \"\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"newPortfolioNumberOrId\": \"200\",\n    \"effectiveDate\": \"04/19/2026\",\n    \"accountTs\": \"\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePortfolio?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangePortfolio"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"2b90c599-a807-45ad-a60e-c498d4b00f92","name":"PortfolioChangeBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/ChangePortfolio?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","ChangePortfolio"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"54dcd7a4-de69-402c-ab45-85720d8731fd"},{"name":"PrimaryCustomerSummaryGet","id":"fb79bdb4-48a6-4bf0-a3b1-897bece20c31","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetPrimaryCustomerSummary","description":"<p>This method is used to get the summary details for the primary borrower on an account.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required int64. Omega account number</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","account","GetPrimaryCustomerSummary"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5e845b4d-65a3-4232-aec5-7e93c8fa8097","name":"GetPrimaryCustomerSummary - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetPrimaryCustomerSummary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcR2V0UHJpbWFyeUN1c3RvbWVyU3VtbWFyeQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 20:03:07 GMT"},{"key":"Content-Length","value":"270"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"GetPrimaryCustomerSummary\": {\n            \"CustomerNumber\": \"656\",\n            \"BorrowerType\": \"Primary_Customer\",\n            \"FirstName\": \"John\",\n            \"LastName\": \"Doe\",\n            \"SocialSecurityNumberLast4\": \"1111\",\n            \"Birthday\": \"07/29/1997\",\n            \"Email\": \"JohnDoe123@megasys.net\",\n            \"DriversLicenseNumber\": \"D244233\",\n            \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n            \"MilitaryActiveDuty\": \"False\"\n        }\n    },\n    \"errors\": []\n}"},{"id":"1cf6f74f-573d-40e8-8340-af415db4982e","name":"GetPrimaryCustomerSummary - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/GetPrimaryCustomerSummary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|f1c81f04-e9cb-4dcf-a4a9-b79656fb1e62|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 13 Dec 2022 21:54:02 GMT"},{"key":"Content-Length","value":"118"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error fetching primary customer: Invalid account number\"\n    ]\n}"}],"_postman_id":"fb79bdb4-48a6-4bf0-a3b1-897bece20c31"},{"name":"PrimaryCustomerSummaryGetBulk","id":"df9f5724-c97f-4e2f-aaa7-988f7ebc8d56","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetPrimaryCustomerSummary?token={{token}}","description":"<p>Returns primary-customer summaries for one to 250 accounts. Each array item requires <code>accountNumberOrId</code>, accepting an account number or account <code>Id</code> (Guid). Authentication belongs in the query string or API key headers. Results are returned per account and the route reuses the single-account Primary Customer Summary permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetPrimaryCustomerSummary"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"8f038109-e106-443d-a864-e8b8c4aa96ee","name":"PrimaryCustomerSummaryGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPrimaryCustomerSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPrimaryCustomerSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\", \"result\": \"Ok\", \"errors\": [], \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"5a7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\", \"requested\": 1, \"total\": 1,\n    \"succeeded\": 1, \"succeededWithError\": 0, \"failed\": 0, \"skipped\": 0,\n    \"accounts\": [{\n      \"accountNumber\": 30001212, \"accountNumberOrId\": \"30001212\", \"status\": \"Succeeded\",\n      \"message\": null, \"singleStatusCode\": \"Ok\", \"singleResult\": \"Ok\",\n      \"errors\": [], \"warnings\": [], \"data\": {}\n    }]\n  }\n}"},{"id":"c13ec207-520e-47e6-967d-beec71a50ca9","name":"PrimaryCustomerSummaryGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPrimaryCustomerSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPrimaryCustomerSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"af3bdcd8-650d-463e-9b76-28f55b832041","name":"PrimaryCustomerSummaryGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetPrimaryCustomerSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetPrimaryCustomerSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"df9f5724-c97f-4e2f-aaa7-988f7ebc8d56"},{"name":"PurgeClosed","id":"de149e15-9b2e-4e7b-a913-88224bb48519","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"includeChargeOffs\": false,\n    \"olderThanYears\": 7,\n    \"olderThanMonths\": 0,\n    \"olderThanDays\": 0,\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/PurgeClosed","description":"<h3 id=\"purge-closed-account\">Purge Closed Account</h3>\n<p>Marks a single closed (or charged-off) account for purge. Mirrors the per-account path of the Purge Closed Accounts screen. Returns the posted account identifiers, the previous and new internal statuses, the purge batch ID, and the purge timestamp.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/PurgeClosed</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) of the closed or charged-off account to purge.</td>\n</tr>\n<tr>\n<td><em>includeChargeOffs</em></td>\n<td>Optional boolean. When <code>true</code>, charged-off accounts are eligible for purge in addition to normally closed accounts.</td>\n</tr>\n<tr>\n<td><em>olderThanYears</em></td>\n<td>Optional integer. Minimum age in years since close before the account is eligible for purge.</td>\n</tr>\n<tr>\n<td><em>olderThanMonths</em></td>\n<td>Optional integer. Additional minimum age in months beyond <code>olderThanYears</code>.</td>\n</tr>\n<tr>\n<td><em>olderThanDays</em></td>\n<td>Optional integer. Additional minimum age in days beyond <code>olderThanYears</code> and <code>olderThanMonths</code>.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-route-multiple-accounts\">Bulk route (multiple accounts)</h4>\n<p>For multiple accounts use <code>POST https://{{base_url}}/api/client/account/Maintenance/Bulk/PurgeClosed?token={{token}}</code>. Its request body is an array of <code>PurgeClosedAccountParameter</code> objects, so every account can use its own purge options and <code>accountTs</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Body</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>array</em></td>\n<td>One to 100 objects using the same fields documented above. <code>accountNumberOrId</code> accepts an account number or account <code>Id</code> (Guid). Duplicate accounts are collapsed and the first item is used.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-request-body-example\">Bulk request body example</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"includeChargeOffs\": false,\n        \"olderThanYears\": 7,\n        \"olderThanMonths\": 0,\n        \"olderThanDays\": 0\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"includeChargeOffs\": true,\n        \"olderThanYears\": 5,\n        \"olderThanMonths\": 6,\n        \"olderThanDays\": 0\n    }\n]\n</code></pre><p>Because the body is an array with no top-level <code>token</code>, pass token authentication in the query string as shown above, or use API key headers. The bulk route reuses this single-account route's API Access permission and is not available on SessionId authentication.</p>\n<p>The bulk form returns <strong>HTTP 200 for any batch that was attempted, including one where every account failed</strong> — check <code>statusCode</code>, not the HTTP status. <code>Ok</code> means all succeeded; <code>Successful_With_Error</code> means some or all did not. Per-account outcomes are in <code>data.accounts</code>, each carrying the submitted <code>accountNumberOrId</code>, the resolved <code>accountNumber</code> when found, and that account's own <code>singleStatusCode</code>, <code>errors</code>, <code>warnings</code> and <code>data</code>. Top-level <code>errors</code> is used only for a request-level failure, where nothing was attempted and the response is a 400.</p>\n<p><strong>Billing:</strong> one bulk request counts as a single API call, regardless of how many accounts it contains. The API meter is incremented once per HTTP request at authentication, so sending 100 accounts in one call is metered as 1, not 100.\nAccounts are processed one at a time and each commits independently, so a failure part-way through leaves earlier accounts committed. Re-running is safe for this operation.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","PurgeClosed"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"905772f3-cb0d-4e05-8757-b61b79f37661","name":"PurgeClosed - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"includeChargeOffs\": true,\n    \"olderThanYears\": 7\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/PurgeClosed"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"previousInternalStatus\": \"Closed\",\n        \"newInternalStatus\": \"Purged\",\n        \"purgeBatchId\": \"00000000-0000-0000-0000-000000000000\",\n        \"purgeDateTime\": \"04/18/2026 10:30:15\"\n    }\n}"},{"id":"240b439d-e8ed-414b-b702-094b6fb4817f","name":"PurgeClosed - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"30001212\",\n    \"includeChargeOffs\": false,\n    \"olderThanYears\": 7\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/PurgeClosed"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account '30001212' is not eligible for purge. Internal status must be Closed.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"de149e15-9b2e-4e7b-a913-88224bb48519"},{"name":"PurgeClosedBulk","id":"a39875e5-e8ef-40e9-aaa2-b86013a9b7cd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"includeChargeOffs\": false,\n        \"olderThanYears\": 7,\n        \"olderThanMonths\": 0,\n        \"olderThanDays\": 0,\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"includeChargeOffs\": true,\n        \"olderThanYears\": 5,\n        \"olderThanMonths\": 6,\n        \"olderThanDays\": 0,\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/PurgeClosed?token={{token}}","description":"<h3 id=\"purge-closed-account-bulk\">Purge Closed Account (bulk)</h3>\n<p>Marks up to 250 closed or charged-off accounts for purge. Each array item is a complete <code>PurgeClosedAccountParameter</code>, so every account can use its own eligibility options and optional row version.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/PurgeClosed?token={{token}}</code></p>\n<h4 id=\"request-body\">Request body</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>includeChargeOffs</em></td>\n<td>Optional boolean. Makes charged-off accounts eligible for this item.</td>\n</tr>\n<tr>\n<td><em>olderThanYears</em></td>\n<td>Optional minimum age in years for this item.</td>\n</tr>\n<tr>\n<td><em>olderThanMonths</em></td>\n<td>Optional additional minimum age in months for this item.</td>\n</tr>\n<tr>\n<td><em>olderThanDays</em></td>\n<td>Optional additional minimum age in days for this item.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for this account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers. This route reuses the single-account Purge Closed API Access permission and is unavailable with SessionId authentication.</p>\n<p>A valid attempted batch returns HTTP 200; inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes. Each account commits independently. One bulk request is billed as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","PurgeClosed"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a98bfaea-d1a1-46e3-b42c-dce8806f50ab","name":"PurgeClosed Bulk - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"includeChargeOffs\": false,\n        \"olderThanYears\": 7,\n        \"olderThanMonths\": 0,\n        \"olderThanDays\": 0\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"includeChargeOffs\": true,\n        \"olderThanYears\": 5,\n        \"olderThanMonths\": 6,\n        \"olderThanDays\": 0\n    }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/PurgeClosed?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","PurgeClosed"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n        \"requested\": 2,\n        \"total\": 2,\n        \"succeeded\": 2,\n        \"succeededWithError\": 0,\n        \"failed\": 0,\n        \"skipped\": 0,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30001212,\n                \"accountNumberOrId\": \"30001212\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"accountNumber\": \"30001212\",\n                    \"previousInternalStatus\": \"Closed\",\n                    \"newInternalStatus\": \"Purged\",\n                    \"purgeBatchId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"purgeDateTime\": \"04/18/2026 10:30:15\"\n                }\n            },\n            {\n                \"accountNumber\": 30001213,\n                \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                    \"accountNumber\": \"30001213\",\n                    \"previousInternalStatus\": \"Closed\",\n                    \"newInternalStatus\": \"Purged\",\n                    \"purgeBatchId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"purgeDateTime\": \"04/18/2026 10:30:16\"\n                }\n            }\n        ]\n    }\n}"},{"id":"af298c95-a604-409d-a38f-8ef52fae3050","name":"PurgeClosedBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"includeChargeOffs\": false,\n    \"olderThanYears\": 7,\n    \"olderThanMonths\": 0,\n    \"olderThanDays\": 0,\n    \"accountTs\": \"\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"includeChargeOffs\": true,\n    \"olderThanYears\": 5,\n    \"olderThanMonths\": 6,\n    \"olderThanDays\": 0,\n    \"accountTs\": \"\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/PurgeClosed?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","PurgeClosed"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"a17718b1-eacd-4bb0-8769-64d919af1808","name":"PurgeClosedBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/PurgeClosed?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","PurgeClosed"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"a39875e5-e8ef-40e9-aaa2-b86013a9b7cd"},{"name":"RecentAccountLogDateGet","id":"48711927-e9b6-4060-b481-de353202a197","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/{{account_number_or_id}}/RecentDate","description":"<h3 id=\"get-recent-account-log-date\">Get Recent Account Log Date</h3>\n<p>Returns the most recent <code>Common.AccountLog.CreationServerDate</code> for the specified account. Wraps <code>AccountLogWSServices.ReturnRecentAccountLogDateWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and then calls <code>AccountLogServices.ReturnRecentAccountLogDate(accountId, databaseName)</code>. The response <code>data</code> field is a nullable <code>DateTime</code>; <code>null</code> is returned when the account has no log entries.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLog/{accountNumberOrId}/RecentDate</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the human-readable account number (e.g. <code>30001212</code>) or the Guid primary key of the account. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank, and <code>Account not found</code> when no account matches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLog","{{account_number_or_id}}","RecentDate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"48504363-5d63-4bbf-8f18-e1597fb7dd9d","name":"GetRecentAccountLogDate - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/30001212/RecentDate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"2026-04-18T10:15:00\"\n}"},{"id":"da89e518-c261-4eb0-b8a0-c58a3b09ee58","name":"GetRecentAccountLogDate - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLog/99999999/RecentDate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"48711927-e9b6-4060-b481-de353202a197"},{"name":"RecentAccountLogDateGetBulk","id":"22f61bb6-7270-406c-bb0c-f935f316feaf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/GetRecentAccountLogDate?token={{token}}","description":"<h3 id=\"get-recent-account-log-date-bulk\">Get Recent Account Log Date (bulk)</h3>\n<p>Returns the most recent account-log date for one to 250 accounts. Every item requires an account number or account ID. The route reuses the single Get Recent Account Log Date permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","GetRecentAccountLogDate"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"1718e0ce-15cc-46a6-a793-c5fa3dd21f93","name":"RecentAccountLogDateGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetRecentAccountLogDate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetRecentAccountLogDate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":\"2026-08-25T10:15:00\"}]}}"},{"id":"fdc4a560-a886-4598-b459-8c6341385853","name":"RecentAccountLogDateGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetRecentAccountLogDate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetRecentAccountLogDate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"fbd7c7b6-b27d-4c5b-b2b0-8657b949eea9","name":"RecentAccountLogDateGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/GetRecentAccountLogDate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","GetRecentAccountLogDate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"22f61bb6-7270-406c-bb0c-f935f316feaf"},{"name":"SaveRecurringBilling","id":"efdcd237-48fb-489b-b5c9-f12cf8f91fdb","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"billing_amount\": 30,\n  \"comment\": \"Updated monthly recurring fee\",\n  \"billing_frequency\": \"Monthly\",\n  \"next_billing_date\": \"{{next_billing_date}}\",\n  \"end_billing_date\": null,\n  \"days_after_due_date\": 0,\n  \"total_billing_periods\": null,\n  \"billing_day\": 15,\n  \"billing_day_2\": null,\n  \"confirm_reopen_closed_account\": false,\n  \"row_version\": null,\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SaveRecurringBilling","description":"<h3 id=\"save-recurring-billing\">Save Recurring Billing</h3>\n<p>Updates an existing active recurring billing row. The row is identified by <code>recurring_billing_id</code>. Only active rows can be edited: a cancelled row is final (add a new row instead), and a waived row must be activated first. <code>next_billing_date</code> must be after the row's <code>last_billing_date</code>, so a period Day End has already billed is never billed again.</p>\n<p>Pass the <code>row_version</code> that <code>GetRecurringBilling</code> returned to have the save refused when the row changed after you read it (for example, Day End billed it). Without <code>row_version</code> the server uses the current version.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/SaveRecurringBilling</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Uses the same body fields and validations as <code>AddRecurringBilling</code>, with one required update field:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>recurring_billing_id</em></td>\n<td>Required Guid. Existing recurring billing row to update. Must belong to <code>account_number</code> and must currently be active.</td>\n</tr>\n<tr>\n<td><em>row_version</em></td>\n<td>Optional string. The <code>row_version</code> from <code>GetRecurringBilling</code>. When supplied, the save is refused if the row has changed since.</td>\n</tr>\n</tbody>\n</table>\n</div><p>See <code>AddRecurringBilling</code> for frequency names, billing day rules, days-before-due caps, closed-account reopen confirmation, and the payment-amount update mutex.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","SaveRecurringBilling"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0abcdf04-75c1-41ce-9750-48d0890d547a","name":"SaveRecurringBilling - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"billing_amount\": 30,\n  \"comment\": \"Updated monthly recurring fee\",\n  \"billing_frequency\": \"Monthly\",\n  \"next_billing_date\": \"{{next_billing_date}}\",\n  \"end_billing_date\": null,\n  \"days_after_due_date\": 0,\n  \"total_billing_periods\": null,\n  \"billing_day\": 15,\n  \"billing_day_2\": null,\n  \"confirm_reopen_closed_account\": false,\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SaveRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8f39ec41-3a02-4f74-8acd-0bbf7d86d0fc","name":"SaveRecurringBilling - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"99999999\",\n  \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n  \"transaction_code\": \"{{transaction_code}}\",\n  \"billing_amount\": 30,\n  \"comment\": \"Updated monthly recurring fee\",\n  \"billing_frequency\": \"Monthly\",\n  \"next_billing_date\": \"{{next_billing_date}}\",\n  \"end_billing_date\": null,\n  \"days_after_due_date\": 0,\n  \"total_billing_periods\": null,\n  \"billing_day\": 15,\n  \"billing_day_2\": null,\n  \"confirm_reopen_closed_account\": false,\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/SaveRecurringBilling"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid account number\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"efdcd237-48fb-489b-b5c9-f12cf8f91fdb"},{"name":"SaveRecurringBillingBulk","id":"1c539084-15ee-4449-95cf-13c8ab98e666","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 30,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/SaveRecurringBilling?token={{token}}","description":"<h3 id=\"save-recurring-billing-bulk\">Save Recurring Billing (bulk)</h3>\n<p>Adds or updates a recurring-billing schedule on each of one to 250 accounts. Supply <code>recurring_billing_id</code> on an item to update that account's existing schedule; omit it to create one. Accounts commit independently and Day End is checked before each one. The route reuses the single Save Recurring Billing permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","SaveRecurringBilling"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6cceb3d5-0750-41ee-af97-2b1fa2e70d31","name":"SaveRecurringBillingBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 30,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":null}]}}"},{"id":"51794ebd-1f19-4e1b-9f38-5804dcfc0f8c","name":"SaveRecurringBillingBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 30,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"recurring_billing_id\": \"{{recurring_billing_id}}\",\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"billing_amount\": 30,\n    \"billing_frequency\": \"Monthly\",\n    \"next_billing_date\": \"{{next_billing_date}}\",\n    \"days_after_due_date\": 0,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": null\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"90900e59-5ebd-4693-ba9b-22397466ac84","name":"SaveRecurringBillingBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"813f5f36-ea10-41da-9091-c09e25ba83e1","name":"SaveRecurringBillingBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/SaveRecurringBilling?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","SaveRecurringBilling"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"1c539084-15ee-4449-95cf-13c8ab98e666"},{"name":"SignatureCountGet","id":"b7537317-96d0-4100-924c-2fdc19127fc8","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/SignatureCount/{{account_linked_document_id}}","description":"<h3 id=\"get-signature-count\">Get Signature Count</h3>\n<p>Returns the total number of participants on a signed document package along with how many of them have already signed. Wraps <code>AccountDocuSignServices.ReturnCountOfSignedCustomers</code>, which counts every <code>Common.AccountElectronicSignature</code> row linked to the document and the subset where <code>HasSigned = true</code>. Useful for progress indicators on an OmegaSign session without pulling every participant row.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountElectronicSignature/SignatureCount/{accountLinkedDocumentId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountLinkedDocumentId</em></td>\n<td>Required Guid. <code>Common.AccountLinkedDocument.Id</code> identifying the signed document package. The controller returns <code>BadRequest</code> with the standard invalid parameter message when blank or not a parseable Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-shape\">Response Shape</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>totalSigners</em></td>\n<td>Total number of signature rows linked to the document.</td>\n</tr>\n<tr>\n<td><em>signedCount</em></td>\n<td>Number of those signature rows where <code>HasSigned = true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountElectronicSignature","SignatureCount","{{account_linked_document_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"057c0767-f3ff-4086-a440-41a5cb47221b","name":"GetSignatureCount - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/SignatureCount/00000000-0000-0000-0000-000000000010"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"totalSigners\": 2,\n        \"signedCount\": 1\n    }\n}"},{"id":"d88ef595-4a12-4fb9-ae2e-5bfeae7a66e6","name":"GetSignatureCount - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountElectronicSignature/SignatureCount/00000000-0000-0000-0000-000000000999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving signature count: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b7537317-96d0-4100-924c-2fdc19127fc8"},{"name":"SizeOfAllAccountLinkedDocumentsGet","id":"16457aaf-953c-4282-8fb3-10164c56d04d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/Size/All","description":"<h3 id=\"get-size-of-all-account-linked-documents\">Get Size Of All Account Linked Documents</h3>\n<p>Returns the total storage footprint, in bytes and megabytes, of every <code>Common.AccountLinkedDocument</code> row belonging to the calling client. Wraps <code>AccountLinkedDocumentWSServices.GetSizeOfAllAccountLinkedDocumentsWS</code>, which calls <code>AccountLinkedDocumentServices.GetSizeOfAllAccountLinkedDocuments(databaseName, clientId)</code> and then derives <code>sizeInMB</code> as <code>sizeInBytes / 1024 / 1024</code> (rounded to two decimals).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/AccountLinkedDocument/Size/All</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<p>None. The calling client is resolved from the authenticated <code>LoginInfo</code>.</p>\n<h4 id=\"response-shape\">Response Shape</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>sizeInBytes</em></td>\n<td>Total byte count of every account-linked document stored for the caller's client.</td>\n</tr>\n<tr>\n<td><em>sizeInMB</em></td>\n<td>Same value expressed in megabytes, rounded to two decimal places.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Account","AccountLinkedDocument","Size","All"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"514fff8b-86d2-49fe-80bb-7da87e06d328","name":"GetSizeOfAllAccountLinkedDocuments - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/Size/All"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"sizeInBytes\": 10485760,\n        \"sizeInMB\": 10.0\n    }\n}"},{"id":"368256d2-0d73-4c9e-943c-6b7ee8a9e15d","name":"GetSizeOfAllAccountLinkedDocuments - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Account/AccountLinkedDocument/Size/All"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving document size: Login failed for user.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"16457aaf-953c-4282-8fb3-10164c56d04d"},{"name":"SubAccountAdjustmentPost","id":"ee986b39-7fbd-46ac-b430-e5658d4ae15f","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"sub_account_transaction_code\": \"{{sub_account_trans_code}}\",\n  \"sub_account_adjustment_transaction_code\": \"{{sub_account_adjustment_trans_code}}\",\n  \"adjustment_amount\": \"{{sub_account_adjustment_amount}}\",\n  \"comment\": \"{{sub_account_adjustment_comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostSubAccountAdjustment","description":"<p>Posts a sub-account adjustment transaction on the supplied account. When <code>report_mode</code> is <code>true</code>, the adjustment is calculated and validated only and is not committed.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Session id, token, or API key accepted by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>sub_account_transaction_code</em></td>\n<td>Required string. Transaction code of the existing sub-account being adjusted.</td>\n</tr>\n<tr>\n<td><em>sub_account_adjustment_transaction_code</em></td>\n<td>Required string. Transaction code used to record the adjustment.</td>\n</tr>\n<tr>\n<td><em>adjustment_amount</em></td>\n<td>Required decimal. Signed adjustment amount applied to the sub-account.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Free-text comment stored with the transaction.</td>\n</tr>\n<tr>\n<td><em>report_mode</em></td>\n<td>Optional boolean (default <code>false</code>). When <code>true</code>, the adjustment is previewed/validated but not posted.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostSubAccountAdjustment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"72e08b93-903a-41f0-8bf1-cf95928a7e1f","name":"PostSubAccountAdjustment - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"sub_account_transaction_code\": \"{{sub_account_trans_code}}\",\n  \"sub_account_adjustment_transaction_code\": \"{{sub_account_adjustment_trans_code}}\",\n  \"adjustment_amount\": \"{{sub_account_adjustment_amount}}\",\n  \"comment\": \"{{sub_account_adjustment_comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostSubAccountAdjustment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"before_unpaid_sub_accounts\": \"$240.00\",\n        \"before_total_balance\": \"$1,284.20\",\n        \"before_number_of_unpaid_sub_accounts\": \"1\",\n        \"current_balance\": \"$904.20\",\n        \"late_other_fees\": \"$140.00\",\n        \"unpaid_sub_accounts\": \"$120.00\",\n        \"total_balance\": \"$1,164.20\",\n        \"unpaid_interest\": \"$707.35\",\n        \"number_of_late_fees\": \"10\",\n        \"number_of_unpaid_sub_accounts\": \"1\",\n        \"number_of_nsfs\": \"0\",\n        \"payment_extensions\": \"0\",\n        \"over_short_amount\": \"$0.88\"\n    },\n    \"errors\": null\n}"},{"id":"bbe63aec-cdf9-4c71-b0f8-eb888fdb009c","name":"PostSubAccountAdjustment - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"sub_account_transaction_code\": \"{{sub_account_trans_code}}\",\n  \"sub_account_adjustment_transaction_code\": \"{{sub_account_adjustment_trans_code}}\",\n  \"adjustment_amount\": \"{{sub_account_adjustment_amount}}\",\n  \"comment\": \"{{sub_account_adjustment_comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostSubAccountAdjustment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|e6c1a2f2-a418-4afd-b008-e165366c250d|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 20 Dec 2022 22:23:27 GMT"},{"key":"Content-Length","value":"363"}],"cookie":[],"responseTime":null,"body":"\"Amount Due (120.0000) - Amount Paid To Date (0.0000) + Adjustment (-260) must be >= 0\\r\\n   at Omega.FinancialCalculations.BLL.Servicing.AccountTransactionsInstallment.PrivateCalculateSubAccountAdjustment(Guid transId, Guid transCodeId, Decimal adjustmentAmount, String comment, Guid sourceScreenId) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Business\\\\Omega.FinancialCalculations\\\\Omega.FinancialCalculations.BLL\\\\Servicing\\\\AccountTransactionsInstallment.cs:line 6219\\r\\n   at Omega.FinancialCalculations.BLL.Servicing.AccountTransactionsInstallment.CalculateSubAccountAdjustment(Guid transId, Guid transCodeId, Decimal adjustmentAmount, String comment) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Business\\\\Omega.FinancialCalculations\\\\Omega.FinancialCalculations.BLL\\\\Servicing\\\\AccountTransactionsInstallment.cs:line 6195\\r\\n   at Omega.WebApp.BLL.WebAPI.Client.Controllers.ClientController.PostSubAccountAdjustment(PostSubAccountAdjustment param) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Omega.WebApp\\\\BLL\\\\WebAPI\\\\Client\\\\Controllers\\\\ClientController.cs:line 1876\""}],"_postman_id":"ee986b39-7fbd-46ac-b430-e5658d4ae15f"},{"name":"SubAccountAdjustmentPostBulk","id":"b0f4aa02-162b-42b1-afa7-338758b2170b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"sub_account_transaction_code\": \"{{transaction_code}}\",\n    \"sub_account_adjustment_transaction_code\": \"{{adjustment_transaction_code}}\",\n    \"adjustment_amount\": -50,\n    \"comment\": \"Bulk API sub account adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccountAdjustment?token={{token}}","description":"<h3 id=\"post-sub-account-adjustment-bulk\">Post Sub Account Adjustment (bulk)</h3>\n<p>Adjusts one unpaid sub-account balance on each of one to 250 accounts. Every item supplies the sub-account transaction code to adjust, the adjustment transaction code to record, the amount, and a comment. Set <code>report_mode</code> to true on an item to calculate without posting. Accounts commit independently and Day End is checked before each one. The route reuses the single Post Sub Account Adjustment permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostSubAccountAdjustment"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"40465afd-ac00-4794-9d49-bea2e3b0153a","name":"SubAccountAdjustmentPostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"sub_account_transaction_code\": \"{{transaction_code}}\",\n    \"sub_account_adjustment_transaction_code\": \"{{adjustment_transaction_code}}\",\n    \"adjustment_amount\": -50,\n    \"comment\": \"Bulk API sub account adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccountAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccountAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"unpaid_sub_accounts\":\"$550.00\",\"total_balance\":\"$11,000.22\"}}]}}"},{"id":"481934c5-172b-4faf-b7aa-3e0332cd5aed","name":"SubAccountAdjustmentPostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"sub_account_transaction_code\": \"{{transaction_code}}\",\n    \"sub_account_adjustment_transaction_code\": \"{{adjustment_transaction_code}}\",\n    \"adjustment_amount\": -50,\n    \"comment\": \"Bulk API sub account adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"sub_account_transaction_code\": \"{{transaction_code}}\",\n    \"sub_account_adjustment_transaction_code\": \"{{adjustment_transaction_code}}\",\n    \"adjustment_amount\": -50,\n    \"comment\": \"Bulk API sub account adjustment\",\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccountAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccountAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"unpaid_sub_accounts\":\"$550.00\",\"total_balance\":\"$11,000.22\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"eadcd578-44e7-459f-b66b-ee6fe373e349","name":"SubAccountAdjustmentPostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccountAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccountAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"dd4277a0-9e1b-4739-9224-f3e2988aebca","name":"SubAccountAdjustmentPostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccountAdjustment?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccountAdjustment"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"b0f4aa02-162b-42b1-afa7-338758b2170b"},{"name":"SubAccountPost","id":"48cb0de3-6a00-4165-80eb-86ecdf65775c","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"term\": \"{{sub_account_term}}\",\n  \"transaction_code\": \"{{sub_account_trans_code}}\",\n  \"amount\": \"{{sub_account_trans_amount}}\",\n  \"comment\": \"{{sub_account_trans_comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"post_payment_change\": \"{{sub_account_post_payment_change}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostSubAccount","description":"<p>Posts a sub-account transaction on the supplied account. When <code>report_mode</code> is <code>true</code>, the transaction is calculated and validated only and is not committed.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Session id, token, or API key accepted by the Login method.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Legacy int64 account number. Supply this or <code>accountNumberOrId</code>; both, when supplied with a nonzero legacy value, must identify the same account.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Required date (ISO-8601, e.g. <code>2024-01-28T00:00:00Z</code>). Posting/effective date of the transaction.</td>\n</tr>\n<tr>\n<td><em>term</em></td>\n<td>Required integer. Number of periods (term) over which the sub-account is amortized.</td>\n</tr>\n<tr>\n<td><em>transaction_code</em></td>\n<td>Required string. Sub-account transaction code configured in Omega.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal. Transaction amount.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Free-text comment stored with the transaction.</td>\n</tr>\n<tr>\n<td><em>post_payment_change</em></td>\n<td>Optional boolean (default <code>true</code>). When <code>true</code>, the payment amount is recalculated to absorb the new sub-account.</td>\n</tr>\n<tr>\n<td><em>report_mode</em></td>\n<td>Optional boolean (default <code>false</code>). When <code>true</code>, the transaction is previewed/validated but not posted.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumberOrId\": \"30011709\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","PostSubAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e53a22ca-2422-4a94-84aa-1a3adc685160","name":"PostSubAccount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"term\": \"{{sub_account_term}}\",\n  \"transaction_code\": \"{{sub_account_trans_code}}\",\n  \"amount\": \"{{sub_account_trans_amount}}\",\n  \"comment\": \"{{sub_account_trans_comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": \"{{account_number}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostSubAccount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"before_unpaid_sub_accounts\": \"$0.00\",\n        \"before_total_balance\": \"$1,044.20\",\n        \"before_number_of_unpaid_sub_accounts\": \"0\",\n        \"current_balance\": \"$904.20\",\n        \"late_other_fees\": \"$140.00\",\n        \"unpaid_sub_accounts\": \"$240.00\",\n        \"total_balance\": \"$1,284.20\",\n        \"unpaid_interest\": \"$707.35\",\n        \"number_of_late_fees\": \"10\",\n        \"number_of_unpaid_sub_accounts\": \"1\",\n        \"number_of_nsfs\": \"0\",\n        \"payment_extensions\": \"0\",\n        \"over_short_amount\": \"$0.88\"\n    },\n    \"errors\": null\n}"},{"id":"62b8bf4d-e215-47f5-956a-801383f3f2e9","name":"PostSubAccount - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"account_number\": \"{{account_number}}\",\n  \"effective_date\": \"{{effective_date}}\",\n  \"term\": \"{{sub_account_term}}\",\n  \"transaction_code\": \"{{sub_account_trans_code}}\",\n  \"amount\": \"{{sub_account_trans_amount}}\",\n  \"comment\": \"{{sub_account_trans_comment}}\",\n  \"report_mode\": \"{{report_mode}}\",\n  \"accountNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/account/PostSubAccount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction cannot be posted in the future. Current branch date is 8/18/2021\",\n        \"Megasys.Framework.BLL.Exceptions.ValidationException: Transaction cannot be posted in the future. Current branch date is 8/18/2021\\r\\n   at Omega.FinancialCalculations.BLL.Servicing.AccountTransactionsInstallment.CalculateSubAccountTransaction(Guid transactionCodeId, Decimal transactionAmt, Int32 term, String comment, SubAccountType subAccountType) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Business\\\\Omega.FinancialCalculations\\\\Omega.FinancialCalculations.BLL\\\\Servicing\\\\AccountTransactionsInstallment.cs:line 7420\\r\\n   at Omega.WebApp.BLL.WebAPI.Client.Controllers.ClientController.PostSubAccount(PostSubAccount param) in C:\\\\Workspaces\\\\DailyBuild\\\\omega\\\\Omega.WebApp\\\\BLL\\\\WebAPI\\\\Client\\\\Controllers\\\\ClientController.cs:line 1693\"\n    ]\n}"}],"_postman_id":"48cb0de3-6a00-4165-80eb-86ecdf65775c"},{"name":"SubAccountPostBulk","id":"0fd3bd22-0a2f-4ed3-8124-473d18ae68e8","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"effective_date\": \"{{effective_date}}\",\n    \"term\": 12,\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 600,\n    \"comment\": \"Bulk API sub account\",\n    \"post_payment_change\": true,\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"{{account_number}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccount?token={{token}}","description":"<h3 id=\"post-sub-account-bulk\">Post Sub Account (bulk)</h3>\n<p>Posts a sub-account transaction to each of one to 250 accounts. Every item supplies its own transaction code, amount, term, effective date, comment, and <code>post_payment_change</code> flag. As on the single route, <code>post_payment_change</code> is forced to false — with a per-account warning — when the transaction code includes the sub account in amount due and past due. Set <code>report_mode</code> to true on an item to calculate without posting. Accounts commit independently and Day End is checked before each one. The route reuses the single Post Sub Account permission.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumberOrId</code></td>\n<td><code>account_number</code></td>\n<td>String. account number (positive 64-bit integer) or account GUID. Numbers are strings in this new field; the legacy field remains numeric.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For <code>accountNumberOrId</code> paired with legacy <code>account_number</code>, null, omitted, empty and whitespace values fall back to <code>account_number</code>; a usable account selector is still required. Other new optional aliases treat null/omitted as absent and reject blank strings. In particular, a blank <code>customerNumberOrId</code> is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. These rules apply to each array item. Existing limits, per-item results and duplicate-account behavior remain unchanged.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n  {\n    \"accountNumberOrId\": \"30011709\"\n  }\n]\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","PostSubAccount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ce8f8c82-6734-4cea-8908-8016a0f727b8","name":"SubAccountPostBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"effective_date\": \"{{effective_date}}\",\n    \"term\": 12,\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 600,\n    \"comment\": \"Bulk API sub account\",\n    \"post_payment_change\": true,\n    \"report_mode\": false,\n    \"accountNumberOrId\": \"30001212\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"succeededWithError\":0,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"accountNumberOrId\":\"30001212\",\"status\":\"Succeeded\",\"message\":null,\"singleStatusCode\":\"Ok\",\"singleResult\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"unpaid_sub_accounts\":\"$600.00\",\"total_balance\":\"$11,050.22\"}}]}}"},{"id":"a994cd3c-cac9-4c22-9a63-178eebeab67f","name":"SubAccountPostBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"account_number\": 30001212,\n    \"effective_date\": \"{{effective_date}}\",\n    \"term\": 12,\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 600,\n    \"comment\": \"Bulk API sub account\",\n    \"post_payment_change\": true,\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  },\n  {\n    \"account_number\": 99999999,\n    \"effective_date\": \"{{effective_date}}\",\n    \"term\": 12,\n    \"transaction_code\": \"{{transaction_code}}\",\n    \"amount\": 600,\n    \"comment\": \"Bulk API sub account\",\n    \"post_payment_change\": true,\n    \"report_mode\": false,\n    \"accountNumberOrId\": null\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\"unpaid_sub_accounts\":\"$600.00\",\"total_balance\":\"$11,050.22\"}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"446d362b-7edc-4b04-a777-ef0651339e5d","name":"SubAccountPostBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"0ec0e626-fd54-4c05-a53a-da53831029f7","name":"SubAccountPostBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[ ... 251 items ... ]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/PostSubAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","PostSubAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"0fd3bd22-0a2f-4ed3-8124-473d18ae68e8"},{"name":"Unfreeze","id":"2e99e7d4-5f28-4513-a20c-1a1c47922377","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number_or_id}}\",\n    \"effectiveDate\": \"{{effective_date}}\",\n    \"accountTs\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Unfreeze","description":"<h3 id=\"unfreeze-account\">Unfreeze Account</h3>\n<p>Unfreezes an account's accruals and earnings. Mirrors the Unfreeze action on the View Account screen. Returns the posted account identifiers, a flag confirming the frozen state is cleared, the effective date used, and the previous freeze date.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Unfreeze</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid) for the account being unfrozen.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date of the unfreeze. When omitted, the current branch date is used.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional string. Base64-encoded <code>Ts</code> row-version of the account record at the time of read. When supplied, the call fails if another user has changed the account in the meantime.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-route-multiple-accounts\">Bulk route (multiple accounts)</h4>\n<p>For multiple accounts use <code>POST https://{{base_url}}/api/client/account/Maintenance/Bulk/Unfreeze?token={{token}}</code>. Its request body is an array of <code>UnfreezeAccountParameter</code> objects, so every account can use its own effective date and <code>accountTs</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Body</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>array</em></td>\n<td>One to 100 objects using the same fields documented above. <code>accountNumberOrId</code> accepts an account number or account <code>Id</code> (Guid). Duplicate accounts are collapsed and the first item is used.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-request-body-example\">Bulk request body example</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveDate\": \"04/18/2026\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveDate\": \"04/19/2026\"\n    }\n]\n</code></pre><p>Because the body is an array with no top-level <code>token</code>, pass token authentication in the query string as shown above, or use API key headers. The bulk route reuses this single-account route's API Access permission and is not available on SessionId authentication.</p>\n<p>The bulk form returns <strong>HTTP 200 for any batch that was attempted, including one where every account failed</strong> — check <code>statusCode</code>, not the HTTP status. <code>Ok</code> means all succeeded; <code>Successful_With_Error</code> means some or all did not. Per-account outcomes are in <code>data.accounts</code>, each carrying the submitted <code>accountNumberOrId</code>, the resolved <code>accountNumber</code> when found, and that account's own <code>singleStatusCode</code>, <code>errors</code>, <code>warnings</code> and <code>data</code>. Top-level <code>errors</code> is used only for a request-level failure, where nothing was attempted and the response is a 400.</p>\n<p><strong>Billing:</strong> one bulk request counts as a single API call, regardless of how many accounts it contains. The API meter is incremented once per HTTP request at authentication, so sending 100 accounts in one call is metered as 1, not 100.\nAccounts are processed one at a time and each commits independently, so a failure part-way through leaves earlier accounts committed. Re-running is safe for this operation.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Unfreeze"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1f875062-29e6-46fa-af91-1d3e9761724f","name":"Unfreeze - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Unfreeze"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"accountNumber\": \"30001212\",\n        \"frozen\": false,\n        \"effectiveDate\": \"04/18/2026\",\n        \"previousFreezeDate\": \"01/15/2026\"\n    }\n}"},{"id":"6034ce41-c11d-49ed-9bd9-891ab8391c35","name":"Unfreeze - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"accountNumberOrId\": \"99999999\",\n    \"effectiveDate\": \"{{effective_date}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Unfreeze"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"2e99e7d4-5f28-4513-a20c-1a1c47922377"},{"name":"UnfreezeBulk","id":"9fcbb34f-2d7f-431b-a58b-7d5ac8da801e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveDate\": \"04/18/2026\",\n        \"accountTs\": \"\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveDate\": \"04/19/2026\",\n        \"accountTs\": \"\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Unfreeze?token={{token}}","description":"<h3 id=\"unfreeze-account-bulk\">Unfreeze Account (bulk)</h3>\n<p>Unfreezes up to 250 accounts. Each array item is a complete <code>UnfreezeAccountParameter</code>, so every account can use its own effective date and optional row version.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/account/Maintenance/Bulk/Unfreeze?token={{token}}</code></p>\n<h4 id=\"request-body\">Request body</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Omega account number or account <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Uses the current branch date when omitted.</td>\n</tr>\n<tr>\n<td><em>accountTs</em></td>\n<td>Optional Base64 row version for this account.</td>\n</tr>\n</tbody>\n</table>\n</div><p>The body must be an array containing one to 250 items. Duplicate accounts are processed once using the first item. Because an array has no top-level <code>token</code>, pass the token in the query string as shown above or use API key headers. This route reuses the single-account Unfreeze API Access permission and is unavailable with SessionId authentication.</p>\n<p>A valid attempted batch returns HTTP 200; inspect <code>statusCode</code> and <code>data.accounts</code> for individual outcomes. Each account commits independently. One bulk request is billed as one API call.</p>\n","urlObject":{"protocol":"https","path":["api","client","account","Maintenance","Bulk","Unfreeze"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"84c19a06-10bf-4c85-975c-bc4336ca333e","name":"Unfreeze Bulk - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n    {\n        \"accountNumberOrId\": \"30001212\",\n        \"effectiveDate\": \"04/18/2026\"\n    },\n    {\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"effectiveDate\": \"04/19/2026\"\n    }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Unfreeze?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","Unfreeze"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Ok\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n        \"requested\": 2,\n        \"total\": 2,\n        \"succeeded\": 2,\n        \"succeededWithError\": 0,\n        \"failed\": 0,\n        \"skipped\": 0,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30001212,\n                \"accountNumberOrId\": \"30001212\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n                    \"accountNumber\": \"30001212\",\n                    \"frozen\": false,\n                    \"effectiveDate\": \"04/18/2026\",\n                    \"previousFreezeDate\": \"01/15/2026\"\n                }\n            },\n            {\n                \"accountNumber\": 30001213,\n                \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                \"status\": \"Succeeded\",\n                \"message\": null,\n                \"singleStatusCode\": \"Ok\",\n                \"singleResult\": \"Ok\",\n                \"errors\": [],\n                \"warnings\": [],\n                \"data\": {\n                    \"accountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n                    \"accountNumber\": \"30001213\",\n                    \"frozen\": false,\n                    \"effectiveDate\": \"04/19/2026\",\n                    \"previousFreezeDate\": \"01/20/2026\"\n                }\n            }\n        ]\n    }\n}"},{"id":"a5ec9f3f-a581-4cc2-a333-120e9ce2b8f1","name":"UnfreezeBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"effectiveDate\": \"04/18/2026\",\n    \"accountTs\": \"\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"effectiveDate\": \"04/19/2026\",\n    \"accountTs\": \"\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Unfreeze?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","Unfreeze"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"887d9779-f474-454f-9384-2b06561c62c8","name":"UnfreezeBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/client/account/Maintenance/Bulk/Unfreeze?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","client","account","Maintenance","Bulk","Unfreeze"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"9fcbb34f-2d7f-431b-a58b-7d5ac8da801e"},{"name":"WriteOffAccount","id":"bf55318e-52d8-423a-ad70-1bd76946234d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": {{account_number}},\n    \"close_out_code\": \"{{close_out_code}}\",\n    \"admin_status_code\": \"{{admin_status_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"comment\": \"API write-off request\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/WriteOffAccount","description":"<h3 id=\"write-off-account\">Write Off Account</h3>\n<p>Writes off an active account through the account close-out posting flow. The server resolves the account number, selects a write-off close-out default, resolves the target admin status, calculates the automatic close-out breakdown, and posts the generic close-out transaction.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/WriteOffAccount</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required integer. Account number to write off.</td>\n</tr>\n<tr>\n<td><em>close_out_code</em></td>\n<td>Optional string. Write-off close-out default code. When omitted, the account class write-off default is used.</td>\n</tr>\n<tr>\n<td><em>admin_status_code</em></td>\n<td>Optional string. Admin status code to apply after write-off. When omitted, the servicing external master configuration default write-off status is used.</td>\n</tr>\n<tr>\n<td><em>effective_date</em></td>\n<td>Optional date. Posting effective date. Defaults to the client's current business date.</td>\n</tr>\n<tr>\n<td><em>comment</em></td>\n<td>Optional string. Free-form transaction comment.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the account number, selected close-out/admin status codes, effective date, close-out type, current balance, and total balance after posting.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","WriteOffAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2844c52b-2db6-48b4-a17f-a2e89073b543","name":"WriteOffAccount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": 10001001,\n    \"close_out_code\": \"WO\",\n    \"admin_status_code\": \"WO\",\n    \"effective_date\": \"2026-05-20\",\n    \"comment\": \"API write-off request\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/WriteOffAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"account_number\": 10001001,\n        \"close_out_code\": \"WO\",\n        \"admin_status_code\": \"WO\",\n        \"effective_date\": \"2026-05-20\",\n        \"close_out_type\": \"Write Off\",\n        \"current_balance\": 0.00,\n        \"total_balance\": 0.00\n    }\n}"},{"id":"a9faee9c-4d29-40ad-9754-12ed8d8ce540","name":"WriteOffAccount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": 99999999,\n    \"close_out_code\": \"WO\",\n    \"admin_status_code\": \"WO\",\n    \"effective_date\": \"2026-05-20\",\n    \"comment\": \"API write-off request\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/WriteOffAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error writing off account: Account not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"bf55318e-52d8-423a-ad70-1bd76946234d"},{"name":"WriteOffAccountBulk","id":"b5740a4a-696d-4e3d-92a9-b5a3d3b00c1e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"{{account_number}}\",\n    \"close_out_code\": \"{{close_out_code}}\",\n    \"admin_status_code\": \"{{admin_status_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"comment\": \"Bulk API write-off\"\n  },\n  {\n    \"accountNumberOrId\": \"{{account_id}}\",\n    \"close_out_code\": \"{{close_out_code}}\",\n    \"admin_status_code\": \"{{admin_status_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"comment\": \"Bulk API write-off\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/WriteOffAccount?token={{token}}","description":"<h3 id=\"write-off-account-bulk\">Write Off Account (bulk)</h3>\n<p>Writes off one to 250 accounts through the same close-out posting service as the single endpoint. Every item supplies an account number or account ID plus its own close-out code, admin status, effective date, and comment. Existing active write-offs are refused so replay cannot create a second active write-off. Accounts commit independently and Day End is checked before each one. The route reuses the single Write Off Account permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","WriteOffAccount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"423f6eab-4d24-4496-a4f6-5d76238d82e1","name":"WriteOffAccountBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"close_out_code\":\"WO\",\"admin_status_code\":\"WO\",\"effective_date\":\"2026-08-25\",\"comment\":\"Bulk API write-off\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/WriteOffAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","WriteOffAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"account_number\":30001212,\"close_out_code\":\"WO\",\"admin_status_code\":\"WO\",\"effective_date\":\"2026-08-25\",\"close_out_type\":\"Write Off\"}}]}}"},{"id":"deba85d9-cbd7-415e-b54c-18f56307b467","name":"WriteOffAccountBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"close_out_code\": \"{{close_out_code}}\",\n    \"admin_status_code\": \"{{admin_status_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"comment\": \"Partial-error example\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"close_out_code\": \"{{close_out_code}}\",\n    \"admin_status_code\": \"{{admin_status_code}}\",\n    \"effective_date\": \"{{effective_date}}\",\n    \"comment\": \"Partial-error example\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/WriteOffAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","WriteOffAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"84ecf255-5fe3-4695-a9c6-494459a3dd9d","name":"WriteOffAccountBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/WriteOffAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","WriteOffAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"b5740a4a-696d-4e3d-92a9-b5a3d3b00c1e"},{"name":"WriteOffAccountReversal","id":"0f86796d-e707-4ba1-9154-e8996119da6a","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": {{account_number}},\n    \"admin_status_code\": \"{{admin_status_code}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/ReverseWriteOffAccount","description":"<h3 id=\"reverse-write-off-account\">Reverse Write Off Account</h3>\n<p>Reverses a prior write-off close-out for an account. The server validates that the account is currently a write-off account, resolves the admin status to restore, calculates the reversal transaction, and posts it through the generic transaction flow.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Account/ReverseWriteOffAccount</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required integer. Account number whose write-off should be reversed.</td>\n</tr>\n<tr>\n<td><em>admin_status_code</em></td>\n<td>Optional string. Admin status code to apply after reversal. When omitted, the original write-off admin status is restored.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the account number, admin status code, current balance, total balance, and reversal reference numbers. Older write-off records may also return a warning that fees must be re-added manually after reversal.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","ReverseWriteOffAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"02667e02-7bdd-4985-88c9-2db537306121","name":"WriteOffAccountReversal - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": 10001001,\n    \"admin_status_code\": \"ACT\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/ReverseWriteOffAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"account_number\": 10001001,\n        \"admin_status_code\": \"ACT\",\n        \"current_balance\": 1000.00,\n        \"total_balance\": 1000.00,\n        \"reference_numbers\": [\n            \"WO-REV-0001\"\n        ]\n    }\n}"},{"id":"9d102a43-559e-4ce0-b4bd-c03ae1001332","name":"WriteOffAccountReversal - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"account_number\": 99999999,\n    \"admin_status_code\": \"ACT\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/ReverseWriteOffAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account must be a Write Off account\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"0f86796d-e707-4ba1-9154-e8996119da6a"},{"name":"WriteOffAccountReversalBulk","id":"4d560370-4752-428e-9ef6-772dd58f1203","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"admin_status_code\": \"{{admin_status_code}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"admin_status_code\": \"{{admin_status_code}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Account/Bulk/ReverseWriteOffAccount?token={{token}}","description":"<h3 id=\"write-off-account-reversal-bulk\">Write Off Account Reversal (bulk)</h3>\n<p>Reverses write-off close-outs for one to 250 accounts through the same posting service as the single endpoint. Every item supplies an account number or account ID and may provide its own restored admin status. Accounts that are not currently written off are refused. Accounts commit independently and Day End is checked before each one. The route reuses the single Reverse Write Off Account permission.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Account","Bulk","ReverseWriteOffAccount"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"95ce09ba-dba4-4216-9d9f-a8744d4f6dc2","name":"WriteOffAccountReversalBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"admin_status_code\":\"ACTIVE\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ReverseWriteOffAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ReverseWriteOffAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\"statusCode\":\"Ok\",\"result\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"requested\":1,\"total\":1,\"succeeded\":1,\"failed\":0,\"skipped\":0,\"accounts\":[{\"accountNumber\":30001212,\"status\":\"Succeeded\",\"singleStatusCode\":\"Ok\",\"errors\":[],\"warnings\":[],\"data\":{\"account_number\":30001212,\"admin_status_code\":\"ACTIVE\",\"reference_numbers\":[\"100234\"]}}]}}"},{"id":"c8f11cba-b156-4e6a-a74b-e86915b33458","name":"WriteOffAccountReversalBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"admin_status_code\": \"{{admin_status_code}}\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"admin_status_code\": \"{{admin_status_code}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ReverseWriteOffAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ReverseWriteOffAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {}\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"20f8343a-f51c-451c-9e90-189b109d8351","name":"WriteOffAccountReversalBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Account/Bulk/ReverseWriteOffAccount?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Account","Bulk","ReverseWriteOffAccount"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"4d560370-4752-428e-9ef6-772dd58f1203"}],"id":"a0619b39-e62d-4101-89c7-ac5e082f507f","_postman_id":"a0619b39-e62d-4101-89c7-ac5e082f507f","description":""},{"name":"Accounts Payable","item":[{"name":"BankAccountAdd","id":"44091ea6-3274-4928-b9ae-54e70473647d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankCodeOrId\": \"{{bank_code_or_id}}\",\n    \"bankAccountNumber\": \"1234567890\",\n    \"description\": \"Operating Checking\",\n    \"active\": true,\n    \"lastCheckNumber\": 1000\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount","description":"<h3 id=\"add-bank-account\">Add Bank Account</h3>\n<p>Creates a new AP bank account tied to an existing bank. The referenced bank must be active. Bank account <code>Id</code> is generated server-side and returned in <code>data.Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/BankAccount</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>bankCodeOrId</em></td>\n<td>Required string. Owning bank's code lookup value or <code>Id</code> (Guid). Must resolve to an active bank or the server returns an error.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumber</em></td>\n<td>Required string. Bank account number as displayed on the AP Bank Account screen.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Friendly description shown in pickers.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. When <code>true</code>, the bank account is available for disbursements.</td>\n</tr>\n<tr>\n<td><em>lastCheckNumber</em></td>\n<td>Required long (&gt;= 0). Starting last-check-number used to seed check assignment.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","BankAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c0c1d884-e6a3-418e-85d8-d24f73cc337a","name":"AddBankAccount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankCodeOrId\": \"{{bank_code_or_id}}\",\n    \"bankAccountNumber\": \"1234567890\",\n    \"description\": \"Operating Checking\",\n    \"active\": true,\n    \"lastCheckNumber\": 1000\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"fd8cf4fa-0b8e-4a36-9afc-3f913ebc0220","name":"AddBankAccount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankCodeOrId\": \"NONEXISTENT\",\n    \"bankAccountNumber\": \"1234567890\",\n    \"description\": \"Operating Checking\",\n    \"active\": true,\n    \"lastCheckNumber\": 1000\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"44091ea6-3274-4928-b9ae-54e70473647d"},{"name":"BankAccountCheckNumberUpdate","id":"e6a8e4e2-c41d-485d-b455-a4abfa406ea8","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"lastCheckDate\": \"2026-04-18T00:00:00\",\n    \"newLastCheckNumber\": 1600\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/CheckNumber","description":"<h3 id=\"update-bank-account-check-number\">Update Bank Account Check Number</h3>\n<p>Updates only the last-check-date and last-check-number for an AP bank account. The server resolves the existing bank account by <code>numberOrId</code>, reuses its <code>Ts</code> for optimistic concurrency, and commits the update through a UnitOfWork. Returns <code>data.Id</code> and <code>data.NewLastCheckNumber</code> on success.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/BankAccount/{numberOrId}/CheckNumber</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Bank account number or bank account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>lastCheckDate</em></td>\n<td>Required datetime. New last-check date in ISO 8601 format.</td>\n</tr>\n<tr>\n<td><em>newLastCheckNumber</em></td>\n<td>Required long (&gt;= 0). New last-check-number.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","BankAccount","{{bank_account_number_or_id}}","CheckNumber"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6949fe1d-7068-4208-937e-d75ace1a99a8","name":"UpdateBankAccountCheckNumber - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"lastCheckDate\": \"2026-04-18T00:00:00\",\n    \"newLastCheckNumber\": 1600\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/CheckNumber"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"NewLastCheckNumber\": 1600\n    }\n}"},{"id":"da9c8b11-2faf-42ac-aa69-b3f964d5bb44","name":"UpdateBankAccountCheckNumber - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"lastCheckDate\": \"2026-04-18T00:00:00\",\n    \"newLastCheckNumber\": 1600\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/NONEXISTENT/CheckNumber"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e6a8e4e2-c41d-485d-b455-a4abfa406ea8"},{"name":"BankAccountGet","id":"fd9804be-e855-4d54-a1bf-4d541b28b815","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}","description":"<h3 id=\"get-bank-account\">Get Bank Account</h3>\n<p>Returns a single AP bank account resolved by bank account number or <code>Id</code> (Guid). Returns an error when the bank account cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/BankAccount/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Bank account number or bank account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","BankAccount","{{bank_account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9374a54e-de13-4355-8b56-0f41d57d4a78","name":"GetBankAccount - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Number\": \"1234567890\",\n        \"Description\": \"Operating Checking\",\n        \"IsActive\": true,\n        \"LastCheckNumber\": 1500,\n        \"LastCheckDate\": \"2026-04-01T00:00:00\",\n        \"CreationDate\": \"2025-01-15T00:00:00\"\n    }\n}"},{"id":"3bf06d1b-590f-4744-957e-7c6317212955","name":"GetBankAccount - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"fd9804be-e855-4d54-a1bf-4d541b28b815"},{"name":"BankAccountPositivePayAdd","id":"96ea43f0-d23d-48dc-9fc2-dc1fb6e2a492","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"isActive\": true,\n    \"branchStartDate\": \"2026-01-01\",\n    \"format\": 1,\n    \"fileName\": \"positivepay.csv\",\n    \"remoteId\": \"RMT001\",\n    \"batchId\": \"BATCH001\",\n    \"bankId\": \"BANK001\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay","description":"<h3 id=\"add-bank-account-positive-pay\">Add Bank Account Positive Pay</h3>\n<p>Creates a new Positive Pay configuration linked to an AP bank account. Wraps <code>BankAccountPositivePayWSServices.AddBankAccountPositivePayWS</code>. The referenced bank account is resolved from <code>bankAccountNumberOrId</code> (supports bank account number lookup or <code>Id</code> Guid). Returns the newly created row's Guid in <code>data.Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid) to attach the Positive Pay configuration to.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required boolean. When <code>true</code>, the Positive Pay export runs for this bank account.</td>\n</tr>\n<tr>\n<td><em>branchStartDate</em></td>\n<td>Required date. Branch effective date after which the Positive Pay process begins including disbursements.</td>\n</tr>\n<tr>\n<td><em>format</em></td>\n<td>Required short. Positive Pay file format code used to select the output layout (client-specific enumeration).</td>\n</tr>\n<tr>\n<td><em>fileName</em></td>\n<td>Required string. Output filename template sent to the remote Positive Pay destination.</td>\n</tr>\n<tr>\n<td><em>remoteId</em></td>\n<td>Required string. Remote system / FTP identifier used when transmitting the file.</td>\n</tr>\n<tr>\n<td><em>batchId</em></td>\n<td>Required string. Batch identifier written into the Positive Pay file header.</td>\n</tr>\n<tr>\n<td><em>bankId</em></td>\n<td>Required string. Bank identifier written into the Positive Pay file header (typically the ABA / routing number).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankAccountPositivePay"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5215a488-54e7-44a4-8f20-040cbdccad8c","name":"AddBankAccountPositivePay - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"isActive\": true,\n    \"branchStartDate\": \"2026-01-01\",\n    \"format\": 1,\n    \"fileName\": \"positivepay.csv\",\n    \"remoteId\": \"RMT001\",\n    \"batchId\": \"BATCH001\",\n    \"bankId\": \"BANK001\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"eb00ce9e-654d-4aec-8361-37909ca0c5ac","name":"AddBankAccountPositivePay - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"NONEXISTENT\",\n    \"isActive\": true,\n    \"branchStartDate\": \"2026-01-01\",\n    \"format\": 1,\n    \"fileName\": \"positivepay.csv\",\n    \"remoteId\": \"RMT001\",\n    \"batchId\": \"BATCH001\",\n    \"bankId\": \"BANK001\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"96ea43f0-d23d-48dc-9fc2-dc1fb6e2a492"},{"name":"BankAccountPositivePayGet","id":"a372c14e-1e08-41da-99e9-88134aaff189","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/PositivePay","description":"<h3 id=\"get-bank-account-positive-pay\">Get Bank Account Positive Pay</h3>\n<p>Returns the Positive Pay configuration record linked to the specified AP bank account. Returns an error when the bank account has no Positive Pay configuration.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/BankAccount/{numberOrId}/PositivePay</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Bank account number or bank account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","BankAccount","{{bank_account_number_or_id}}","PositivePay"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9439d2da-d0ef-4434-b3c9-f5029883142f","name":"GetBankAccountPositivePay - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/PositivePay"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"IsActive\": true,\n        \"FileFormat\": \"CSV\",\n        \"DeliveryMethod\": \"SFTP\",\n        \"Notes\": \"Positive Pay export runs nightly\"\n    }\n}"},{"id":"34eb389b-b2ef-47ab-a2d8-4595d932311f","name":"GetBankAccountPositivePay - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/PositivePay"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Positive pay configuration not found for this bank account\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"a372c14e-1e08-41da-99e9-88134aaff189"},{"name":"BankAccountPositivePaysGetAll","id":"d0529158-8b78-400d-ad8b-6682f1b25bc5","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay","description":"<h3 id=\"get-all-bank-account-positive-pays\">Get All Bank Account Positive Pays</h3>\n<p>Returns every AP Bank Account Positive Pay configuration defined for the client. Wraps <code>BankAccountPositivePayWSServices.GetAllBankAccountPositivePaysWS</code> and returns the list directly in <code>data</code> with the usual <code>statusCode</code> / <code>result</code> envelope.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankAccountPositivePay"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ef0264cd-ac74-48fa-a2a9-10611149bb99","name":"GetAllBankAccountPositivePays - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"IsActive\": true,\n            \"BranchStartDate\": \"2026-01-01T00:00:00\",\n            \"Format\": 1,\n            \"FileName\": \"positivepay.csv\",\n            \"RemoteId\": \"RMT001\",\n            \"BatchId\": \"BATCH001\",\n            \"BankId\": \"BANK001\"\n        }\n    ]\n}"},{"id":"01cc0a1a-b1bf-4079-ad85-9afafabdfd58","name":"GetAllBankAccountPositivePays - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authentication failed: No valid authentication method found (SessionId, API Key, or Token)\"\n}"}],"_postman_id":"d0529158-8b78-400d-ad8b-6682f1b25bc5"},{"name":"BankAccountPositivePayUpdate","id":"5af3e397-666a-4418-85eb-f9cfc347da9d","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"isActive\": true,\n    \"branchStartDate\": \"2026-01-01\",\n    \"format\": 1,\n    \"fileName\": \"positivepay.csv\",\n    \"remoteId\": \"RMT001\",\n    \"batchId\": \"BATCH001\",\n    \"bankId\": \"BANK001\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay/{{bank_account_number_or_id}}","description":"<h3 id=\"update-bank-account-positive-pay\">Update Bank Account Positive Pay</h3>\n<p>Updates an existing Positive Pay configuration for the AP bank account identified by the path parameter. Wraps <code>BankAccountPositivePayWSServices.UpdateBankAccountPositivePayWS</code>. The path parameter identifies the bank account whose Positive Pay row is being edited.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay/{bankAccountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid) whose Positive Pay configuration is being updated.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required boolean. When <code>true</code>, the Positive Pay export runs for this bank account.</td>\n</tr>\n<tr>\n<td><em>branchStartDate</em></td>\n<td>Required date. Branch effective date after which the Positive Pay process begins including disbursements.</td>\n</tr>\n<tr>\n<td><em>format</em></td>\n<td>Required short. Positive Pay file format code used to select the output layout.</td>\n</tr>\n<tr>\n<td><em>fileName</em></td>\n<td>Required string. Output filename template.</td>\n</tr>\n<tr>\n<td><em>remoteId</em></td>\n<td>Required string. Remote system / FTP identifier.</td>\n</tr>\n<tr>\n<td><em>batchId</em></td>\n<td>Required string. Batch identifier written into the Positive Pay file header.</td>\n</tr>\n<tr>\n<td><em>bankId</em></td>\n<td>Required string. Bank identifier (typically the ABA / routing number) written into the Positive Pay file header.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankAccountPositivePay","{{bank_account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7e7fbe87-53c0-456c-8a65-1f661fb58720","name":"UpdateBankAccountPositivePay - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"isActive\": true,\n    \"branchStartDate\": \"2026-01-01\",\n    \"format\": 1,\n    \"fileName\": \"positivepay.csv\",\n    \"remoteId\": \"RMT001\",\n    \"batchId\": \"BATCH001\",\n    \"bankId\": \"BANK001\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay/{{bank_account_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"b46c1722-25f4-42c3-8dbc-61ce924c4a58","name":"UpdateBankAccountPositivePay - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"isActive\": true,\n    \"branchStartDate\": \"2026-01-01\",\n    \"format\": 1,\n    \"fileName\": \"positivepay.csv\",\n    \"remoteId\": \"RMT001\",\n    \"batchId\": \"BATCH001\",\n    \"bankId\": \"BANK001\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankAccountPositivePay/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"5af3e397-666a-4418-85eb-f9cfc347da9d"},{"name":"BankAccountsGetAll","id":"773d5234-f3bd-4c56-a5ed-b911b955fc56","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount","description":"<h3 id=\"get-all-bank-accounts\">Get All Bank Accounts</h3>\n<p>Returns every AP bank account for the authenticated client. The response <code>data</code> is a list of bank account entities. Inactive bank accounts are included; filter client-side if only active accounts are needed.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/BankAccount</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","BankAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a646e343-cce0-44cf-851e-66283d48645e","name":"GetAllBankAccounts - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Number\": \"1234567890\",\n            \"Description\": \"Operating Checking\",\n            \"IsActive\": true,\n            \"LastCheckNumber\": 1500,\n            \"LastCheckDate\": \"2026-04-01T00:00:00\",\n            \"CreationDate\": \"2025-01-15T00:00:00\"\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Number\": \"9876543210\",\n            \"Description\": \"Payroll Clearing\",\n            \"IsActive\": true,\n            \"LastCheckNumber\": 8450,\n            \"LastCheckDate\": \"2026-04-10T00:00:00\",\n            \"CreationDate\": \"2024-06-01T00:00:00\"\n        }\n    ]\n}"},{"id":"952df120-c2fb-4cab-8d76-f173c114fea8","name":"GetAllBankAccounts - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authentication failed: No valid authentication method found (SessionId, API Key, or Token)\"\n}"}],"_postman_id":"773d5234-f3bd-4c56-a5ed-b911b955fc56"},{"name":"BankAccountUpdate","id":"7b16bb8a-a909-46a7-8cf9-3f35e2b5d4d5","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankCodeOrId\": \"{{bank_code_or_id}}\",\n    \"bankAccountNumber\": \"1234567890\",\n    \"description\": \"Operating Checking (updated)\",\n    \"active\": true,\n    \"lastCheckNumber\": 1500\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}","description":"<h3 id=\"update-bank-account\">Update Bank Account</h3>\n<p>Updates an existing AP bank account. The route <code>bankAccountNumberOrId</code> identifies the bank account (accepts the bank account number or the bank account <code>Id</code> Guid). The referenced bank must still be active. The server preserves the original creation date and last-check-date and reuses the existing <code>Ts</code> for optimistic concurrency so the body does not need to supply one. Returns <code>data.Id</code> on success.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/BankAccount/{bankAccountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. Bank account number or bank account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>bankCodeOrId</em></td>\n<td>Required string. Owning bank's code lookup value or <code>Id</code> (Guid). Must resolve to an active bank.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumber</em></td>\n<td>Required string. Bank account number.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Friendly description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. When <code>true</code>, the bank account remains available for disbursements.</td>\n</tr>\n<tr>\n<td><em>lastCheckNumber</em></td>\n<td>Required long (&gt;= 0). Updated last-check-number.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","BankAccount","{{bank_account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4ccc2261-c9e5-498f-91ea-99e6aa8219f3","name":"UpdateBankAccount - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankCodeOrId\": \"{{bank_code_or_id}}\",\n    \"bankAccountNumber\": \"1234567890\",\n    \"description\": \"Operating Checking (updated)\",\n    \"active\": true,\n    \"lastCheckNumber\": 1500\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"d23cb75b-aa8a-434f-ad0f-40fce2ad473d","name":"UpdateBankAccount - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankCodeOrId\": \"NONEXISTENT-BANK\",\n    \"bankAccountNumber\": \"1234567890\",\n    \"description\": \"Operating Checking (updated)\",\n    \"active\": true,\n    \"lastCheckNumber\": 1500\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"7b16bb8a-a909-46a7-8cf9-3f35e2b5d4d5"},{"name":"BankAdd","id":"673dd2f6-90fd-4a00-88e5-a7ff7cd4581f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"First National Bank\",\n    \"routingNumber\": \"021000021\",\n    \"active\": true,\n    \"website\": \"https://www.firstnational.example.com\",\n    \"notes\": \"Primary disbursement bank\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/Bank","description":"<h3 id=\"add-bank\">Add Bank</h3>\n<p>Creates a new Accounts Payable bank record. Mirrors the <strong>Add Bank</strong> flow on the AP Bank setup screen. Bank <code>Id</code> is generated server-side and returned in <code>data.Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/Bank</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string. Display name of the bank.</td>\n</tr>\n<tr>\n<td><em>routingNumber</em></td>\n<td>Required string. ABA/routing number for the bank.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. When <code>true</code>, the bank is available for bank account setup; <code>false</code> disables it.</td>\n</tr>\n<tr>\n<td><em>website</em></td>\n<td>Optional string. Public website URL for the bank.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form notes describing the bank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","Bank"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f53fcd68-4beb-4a13-b17d-d940e89b5da3","name":"AddBank - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"First National Bank\",\n    \"routingNumber\": \"021000021\",\n    \"active\": true,\n    \"website\": \"https://www.firstnational.example.com\",\n    \"notes\": \"Primary disbursement bank\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/Bank"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"5d02a6a2-20c3-4a71-a680-aceaaed60926","name":"AddBank - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"\",\n    \"routingNumber\": \"021000021\",\n    \"active\": true,\n    \"website\": \"https://www.firstnational.example.com\",\n    \"notes\": \"Primary disbursement bank\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/Bank"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank name is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"673dd2f6-90fd-4a00-88e5-a7ff7cd4581f"},{"name":"BankRecCategoryCodeAdd","id":"1dae1a8a-f0f2-454a-9cbc-66d77787a6e7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"DEP\",\n    \"description\": \"Deposits\",\n    \"transactionSign\": 1,\n    \"categoryType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode","description":"<h3 id=\"add-bank-rec-category-code\">Add Bank Rec Category Code</h3>\n<p>Creates a new Accounts Payable bank reconciliation <strong>category code</strong>. Category codes group reconciliation transactions by purpose (Deposit / Check / Adjustment / Electronic Check) and direction (positive vs negative). The server generates the <code>Id</code> and returns it in <code>data.Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Short user-facing code for the category.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>transactionSign</em></td>\n<td>Required integer (<code>Omega.AccountsPayable.Types.Enums.TransactionSigns</code>). <code>1</code> = Positive, <code>2</code> = Negative.</td>\n</tr>\n<tr>\n<td><em>categoryType</em></td>\n<td>Required integer (<code>Omega.AccountsPayable.Types.Enums.CategoryTypes</code>). <code>1</code> = Deposit, <code>2</code> = Check, <code>3</code> = Adjustment, <code>4</code> = ElectronicCheck.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecCategoryCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3cf74162-ef6e-4cdd-ab7d-bb3f263acd1c","name":"AddBankRecCategoryCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"DEP\",\n    \"description\": \"Deposits\",\n    \"transactionSign\": 1,\n    \"categoryType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"bf2598d7-5c7d-4960-acc3-13610000b7d6","name":"AddBankRecCategoryCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"\",\n    \"description\": \"Deposits\",\n    \"transactionSign\": 1,\n    \"categoryType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Category code is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"1dae1a8a-f0f2-454a-9cbc-66d77787a6e7"},{"name":"BankRecCategoryCodeUpdate","id":"0531e5bb-245e-450c-aa9d-e5efc0121a82","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"DEP\",\n    \"description\": \"Deposits (updated)\",\n    \"transactionSign\": 1,\n    \"categoryType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode/{{bank_rec_category_code_or_id}}","description":"<h3 id=\"update-bank-rec-category-code\">Update Bank Rec Category Code</h3>\n<p>Updates an existing Accounts Payable bank reconciliation category code. The route <code>codeOrId</code> identifies the category code (accepts either the user-facing <code>Code</code> lookup value or the category code <code>Id</code> Guid). The server re-reads the current <code>Ts</code> for optimistic concurrency so the body does not need to supply one. Returns <code>data.Id</code> on success.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Category code lookup value or category code <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Short user-facing code for the category.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>transactionSign</em></td>\n<td>Required integer (<code>Omega.AccountsPayable.Types.Enums.TransactionSigns</code>). <code>1</code> = Positive, <code>2</code> = Negative.</td>\n</tr>\n<tr>\n<td><em>categoryType</em></td>\n<td>Required integer (<code>Omega.AccountsPayable.Types.Enums.CategoryTypes</code>). <code>1</code> = Deposit, <code>2</code> = Check, <code>3</code> = Adjustment, <code>4</code> = ElectronicCheck.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecCategoryCode","{{bank_rec_category_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ed95284b-d66b-4120-bc02-12e1539845b9","name":"UpdateBankRecCategoryCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"DEP\",\n    \"description\": \"Deposits (updated)\",\n    \"transactionSign\": 1,\n    \"categoryType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode/{{bank_rec_category_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"ade88e73-6a2d-4add-bbbc-c3d5eb29a7c0","name":"UpdateBankRecCategoryCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"NONEXISTENT\",\n    \"description\": \"Deposits (updated)\",\n    \"transactionSign\": 1,\n    \"categoryType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryCode/{{bank_rec_category_code_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec category code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"0531e5bb-245e-450c-aa9d-e5efc0121a82"},{"name":"BankRecCategoryTransactionCodeAdd","id":"eef8525b-f801-4f99-b5e9-454b550193f5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"SVC\",\n    \"description\": \"Service Charge\",\n    \"categoryCodeOrId\": \"ADJ\",\n    \"autoClearTransaction\": false,\n    \"addGltransaction\": true,\n    \"glchartAccountNumberOrId\": \"5000\",\n    \"allowGlchartAccountOverrride\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode","description":"<h3 id=\"add-bank-rec-category-transaction-code\">Add Bank Rec Category Transaction Code</h3>\n<p>Creates a new Accounts Payable bank reconciliation <strong>category transaction code</strong>. Transaction codes belong to a parent <code>BankRecCategoryCode</code> and describe specific reconciliation transaction types within that category (for example a service charge under the Adjustment category). Optionally links to a GL chart account for automatic GL posting. The server generates the <code>Id</code> and returns it in <code>data.Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Short user-facing code for the transaction code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>categoryCodeOrId</em></td>\n<td>Required string. Parent bank rec category code lookup value (<code>Code</code>) or <code>Id</code> (Guid). Resolved server-side via <code>SharedWSServices.GetAccountsPayableBankRecCategoryCodeId</code>.</td>\n</tr>\n<tr>\n<td><em>autoClearTransaction</em></td>\n<td>Required boolean. When <code>true</code>, transactions of this type are auto-cleared during reconciliation.</td>\n</tr>\n<tr>\n<td><em>addGltransaction</em></td>\n<td>Required boolean. When <code>true</code>, posting this transaction also creates a corresponding GL transaction.</td>\n</tr>\n<tr>\n<td><em>glchartAccountNumberOrId</em></td>\n<td>Optional string. GL chart account number or <code>Id</code> (Guid). Required when <code>addGltransaction</code> is <code>true</code>; ignored otherwise. Resolved via <code>SharedWSServices.GetGeneralLedgerAccountId</code>.</td>\n</tr>\n<tr>\n<td><em>allowGlchartAccountOverrride</em></td>\n<td>Required boolean. When <code>true</code>, the user can override the linked GL chart account when posting individual transactions. (Note: parameter name retains the legacy triple-<code>r</code> spelling used by the controller.)</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecCategoryTransactionCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"aee63917-ebb0-402f-9410-8b61a9653808","name":"AddBankRecCategoryTransactionCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"SVC\",\n    \"description\": \"Service Charge\",\n    \"categoryCodeOrId\": \"ADJ\",\n    \"autoClearTransaction\": false,\n    \"addGltransaction\": true,\n    \"glchartAccountNumberOrId\": \"5000\",\n    \"allowGlchartAccountOverrride\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"b73ce71b-f58f-4ebc-a737-8057ab653d74","name":"AddBankRecCategoryTransactionCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"SVC\",\n    \"description\": \"Service Charge\",\n    \"categoryCodeOrId\": \"NON_EXISTENT_CATEGORY\",\n    \"autoClearTransaction\": false,\n    \"addGltransaction\": true,\n    \"glchartAccountNumberOrId\": \"5000\",\n    \"allowGlchartAccountOverrride\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec category code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"eef8525b-f801-4f99-b5e9-454b550193f5"},{"name":"BankRecCategoryTransactionCodeUpdate","id":"fa999f75-4a60-4b25-98ad-e8ed68798ce5","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"SVC\",\n    \"description\": \"Service Charge (updated)\",\n    \"categoryCodeOrId\": \"ADJ\",\n    \"autoClearTransaction\": false,\n    \"addGltransaction\": true,\n    \"glchartAccountNumberOrId\": \"5000\",\n    \"allowGlchartAccountOverrride\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode/{{bank_rec_category_transaction_code_or_id}}","description":"<h3 id=\"update-bank-rec-category-transaction-code\">Update Bank Rec Category Transaction Code</h3>\n<p>Updates an existing Accounts Payable bank reconciliation category transaction code. The route <code>codeOrId</code> identifies the transaction code (accepts either the user-facing <code>Code</code> lookup value or the transaction code <code>Id</code> Guid). The server re-reads the current <code>Ts</code> for optimistic concurrency so the body does not need to supply one. Returns <code>data.Id</code> on success.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Bank rec category transaction code lookup value or transaction code <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Short user-facing code for the transaction code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>categoryCodeOrId</em></td>\n<td>Required string. Parent bank rec category code lookup value (<code>Code</code>) or <code>Id</code> (Guid). Resolved server-side via <code>SharedWSServices.GetAccountsPayableBankRecCategoryCodeId</code>.</td>\n</tr>\n<tr>\n<td><em>autoClearTransaction</em></td>\n<td>Required boolean. When <code>true</code>, transactions of this type are auto-cleared during reconciliation.</td>\n</tr>\n<tr>\n<td><em>addGltransaction</em></td>\n<td>Required boolean. When <code>true</code>, posting this transaction also creates a corresponding GL transaction.</td>\n</tr>\n<tr>\n<td><em>glchartAccountNumberOrId</em></td>\n<td>Optional string. GL chart account number or <code>Id</code> (Guid). Required when <code>addGltransaction</code> is <code>true</code>; ignored otherwise. Resolved via <code>SharedWSServices.GetGeneralLedgerAccountId</code>.</td>\n</tr>\n<tr>\n<td><em>allowGlchartAccountOverrride</em></td>\n<td>Required boolean. When <code>true</code>, the user can override the linked GL chart account when posting individual transactions. (Note: parameter name retains the legacy triple-<code>r</code> spelling used by the controller.)</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecCategoryTransactionCode","{{bank_rec_category_transaction_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6479164b-3545-48dd-b62d-c307074ab30b","name":"UpdateBankRecCategoryTransactionCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"SVC\",\n    \"description\": \"Service Charge (updated)\",\n    \"categoryCodeOrId\": \"ADJ\",\n    \"autoClearTransaction\": false,\n    \"addGltransaction\": true,\n    \"glchartAccountNumberOrId\": \"5000\",\n    \"allowGlchartAccountOverrride\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode/{{bank_rec_category_transaction_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"c7230e84-c15d-4c9a-84a8-2c682f7d661c","name":"UpdateBankRecCategoryTransactionCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"SVC\",\n    \"description\": \"Service Charge (updated)\",\n    \"categoryCodeOrId\": \"ADJ\",\n    \"autoClearTransaction\": false,\n    \"addGltransaction\": true,\n    \"glchartAccountNumberOrId\": \"5000\",\n    \"allowGlchartAccountOverrride\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecCategoryTransactionCode/NON_EXISTENT_CODE"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec category transaction code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"fa999f75-4a60-4b25-98ad-e8ed68798ce5"},{"name":"BankRecStatementAdd","id":"ef6ec3b4-6b9e-4ca9-bbe6-932f30a2054d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"statementDate\": \"2025-01-31\",\n    \"endingBalance\": 0.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement","description":"<h3 id=\"add-bank-rec-statement\">Add Bank Rec Statement</h3>\n<p>Creates a new <strong>Bank Rec Statement</strong> (a single reconciliation statement) for the supplied AP bank account. The server resolves the bank account via <code>SharedWSServices.GetAccountsPayableBankAccountId</code>, looks up the parent <code>BankRecStatementConfig</code> for that bank account via <code>BankAccountServices.ReturnBankRecStatementConfigWithBankId</code>, and wires the parent-child relationship automatically — you do <strong>not</strong> pass a <code>bankRecStatementConfigId</code>. If no statement config exists for the target bank account the call returns <code>BadRequest</code> with <code>\"Bank rec statement config not found for this bank account\"</code>. Wraps <code>BankRecStatementWSServices.AddSaveBankRecStatementWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid). Used to resolve the parent <code>BankRecStatementConfig</code>.</td>\n</tr>\n<tr>\n<td><em>statementDate</em></td>\n<td>Required date (ISO 8601). End date printed on the reconciliation statement.</td>\n</tr>\n<tr>\n<td><em>endingBalance</em></td>\n<td>Required decimal. Closing ledger balance reported on the statement.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatement"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"134997f1-7708-4cdd-bd5d-7ebfd9a75912","name":"AddBankRecStatement - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"statementDate\": \"2025-01-31\",\n    \"endingBalance\": 0.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"7b48500c-5e14-40bb-b4ff-565e5bb05e1a","name":"AddBankRecStatement - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"statementDate\": \"2025-01-31\",\n    \"endingBalance\": 0.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec statement config not found for this bank account\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"ef6ec3b4-6b9e-4ca9-bbe6-932f30a2054d"},{"name":"BankRecStatementCategoryConfigDelete","id":"286d4278-8d29-45e5-a2f9-26009994a09b","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/{{bank_rec_statement_category_config_id}}","description":"<h3 id=\"delete-bank-rec-statement-category-config\">Delete Bank Rec Statement Category Config</h3>\n<p>Removes a single child <strong>Bank Rec Statement Category Config</strong> row from its parent Statement Config. Wraps <code>BankRecStatementConfigWSServices.DeleteBankRecStatementCategoryConfigWS</code>.</p>\n<h4 id=\"related-endpoints\">Related Endpoints</h4>\n<p>POST and PUT for Bank Rec Statement Category Config rows have been consolidated into the parent <code>BankRecStatementConfig</code> endpoints — use the <code>categoryConfigs</code> array on <code>AddBankRecStatementConfig</code> or <code>UpdateBankRecStatementConfig</code> to create or update child rows.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.BankRecStatementCategoryConfig</code> row to delete. Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementCategoryConfig","{{bank_rec_statement_category_config_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"538804e8-994a-4e05-aeb2-a789988ab8b2","name":"DeleteBankRecStatementCategoryConfig - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/{{bank_rec_statement_category_config_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"Deleted\": true\n    }\n}"},{"id":"e127ab08-c39d-4125-b4bb-3c7bf24dcfc5","name":"DeleteBankRecStatementCategoryConfig - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/00000000-0000-0000-0000-000000000000"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec statement category config not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"286d4278-8d29-45e5-a2f9-26009994a09b"},{"name":"BankRecStatementCategoryConfigsByStatementConfigGet","id":"4ef49a90-ffe2-48b7-8a8b-d3debc576a60","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/ByStatementConfig/{{bank_rec_statement_config_id}}","description":"<h3 id=\"get-bank-rec-statement-category-configs-by-statement-config\">Get Bank Rec Statement Category Configs By Statement Config</h3>\n<p>This operation accepts full bank account number or statement-configuration GUID in <code>statementConfigId</code>. The GUID must identify the selected record type. Use the statement-configuration GUID when selecting by ID; a bank-account GUID identifies a different record. A bank number must match exactly one configuration.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/ByStatementConfig/{statementConfigId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statementConfigId</em></td>\n<td>Required string. full bank account number or statement-configuration GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>statementConfigId</code></td>\n<td>full bank account number or statement-configuration GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/AccountsPayable/BankRecStatementCategoryConfig/ByStatementConfig/123456789\n/api/Client/AccountsPayable/BankRecStatementCategoryConfig/ByStatementConfig/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementCategoryConfig","ByStatementConfig","{{bank_rec_statement_config_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"07eb3406-bfc2-49e5-80ef-9981bf8d2623","name":"GetBankRecStatementCategoryConfigsByStatementConfig - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/ByStatementConfig/{{bank_rec_statement_config_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankRecStatementConfigId\": \"00000000-0000-0000-0000-000000000000\",\n            \"SequenceNumber\": 1,\n            \"CategoryCodeId\": \"00000000-0000-0000-0000-000000000000\"\n        }\n    ]\n}"},{"id":"610ac622-b341-4d55-8bde-9e0e3b6ad168","name":"GetBankRecStatementCategoryConfigsByStatementConfig - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementCategoryConfig/ByStatementConfig/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"errors\": [\n    \"statementConfigId: record not found.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"4ef49a90-ffe2-48b7-8a8b-d3debc576a60"},{"name":"BankRecStatementConfigAdd","id":"12fecd19-6bad-4f48-a1ab-d00a44f7df92","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"firstStatementStartDate\": \"2025-01-01\",\n    \"firstStatementStartingBalance\": 0.00,\n    \"apCheckTransactionCodeOrId\": \"{{bank_rec_ap_check_transaction_code_or_id}}\",\n    \"bankDepositTransactionCodeOrId\": \"{{bank_rec_deposit_transaction_code_or_id}}\",\n    \"bankWithdrawalTransactionCodeOrId\": \"{{bank_rec_withdrawal_transaction_code_or_id}}\",\n    \"electronicApCheckTransactionCodeOrId\": \"{{bank_rec_electronic_ap_check_transaction_code_or_id}}\",\n    \"categoryConfigs\": [\n        {\n            \"id\": null,\n            \"sequenceNumber\": 1,\n            \"categoryCodeOrId\": \"{{bank_rec_category_code_or_id}}\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig","description":"<h3 id=\"add-bank-rec-statement-config\">Add Bank Rec Statement Config</h3>\n<p>Creates a new AP Bank Reconciliation <strong>Statement Config</strong> that ties a bank account to its reconciliation settings (first statement start date, starting balance, and the four transaction codes used by the reconciliation engine). Optionally accepts a <code>categoryConfigs</code> array so child <strong>Bank Rec Statement Category Config</strong> rows can be created in the same call (POST / PUT for the child rows has been consolidated into this parent endpoint per the BATCH spec — see the note below). Wraps <code>BankRecStatementConfigWSServices.AddBankRecStatementConfigWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid). Resolved server-side via <code>SharedWSServices.GetAccountsPayableBankAccountId</code>.</td>\n</tr>\n<tr>\n<td><em>firstStatementStartDate</em></td>\n<td>Required date (ISO 8601). Start date of the very first reconciliation statement for this bank account.</td>\n</tr>\n<tr>\n<td><em>firstStatementStartingBalance</em></td>\n<td>Required decimal. Ledger balance at the start of the first reconciliation statement.</td>\n</tr>\n<tr>\n<td><em>apCheckTransactionCodeOrId</em></td>\n<td>Required string. Bank Rec <strong>Category Transaction Code</strong> used for regular AP checks. Accepts a code or Guid <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>bankDepositTransactionCodeOrId</em></td>\n<td>Optional string. Bank Rec Category Transaction Code used for bank deposits. Accepts a code or Guid <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>bankWithdrawalTransactionCodeOrId</em></td>\n<td>Optional string. Bank Rec Category Transaction Code used for bank withdrawals. Accepts a code or Guid <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>electronicApCheckTransactionCodeOrId</em></td>\n<td>Required string. Bank Rec Category Transaction Code used for electronic AP checks. Accepts a code or Guid <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>categoryConfigs</em></td>\n<td>Optional array of child <strong>Category Config</strong> rows to create with this Statement Config. Each element is: <code>{ id, sequenceNumber, categoryCodeOrId }</code> where <code>id</code> is <code>null</code> for new rows, <code>sequenceNumber</code> is the display order, and <code>categoryCodeOrId</code> is the Bank Rec Category Code (code or Guid <code>Id</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"note-on-category-configs\">Note on Category Configs</h4>\n<p>POST and PUT for <code>BankRecStatementCategoryConfig</code> have been consolidated into this parent endpoint. Use the <code>categoryConfigs</code> array on this request (or on <code>UpdateBankRecStatementConfig</code>) to add or update child category configs as part of the parent operation. Use the <code>DELETE api/Client/AccountsPayable/BankRecStatementCategoryConfig/{id}</code> endpoint to remove individual category configs.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementConfig"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d01342f5-a343-4b94-b329-d62ca84038ac","name":"AddBankRecStatementConfig - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"firstStatementStartDate\": \"2025-01-01\",\n    \"firstStatementStartingBalance\": 0.00,\n    \"apCheckTransactionCodeOrId\": \"APCHK\",\n    \"bankDepositTransactionCodeOrId\": \"DEP\",\n    \"bankWithdrawalTransactionCodeOrId\": \"WDR\",\n    \"electronicApCheckTransactionCodeOrId\": \"EAPCHK\",\n    \"categoryConfigs\": [\n        {\n            \"id\": null,\n            \"sequenceNumber\": 1,\n            \"categoryCodeOrId\": \"DEP\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"dcf0b9e1-00ea-43db-9daa-460b6379e1fb","name":"AddBankRecStatementConfig - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"NON_EXISTENT_BANK_ACCOUNT\",\n    \"firstStatementStartDate\": \"2025-01-01\",\n    \"firstStatementStartingBalance\": 0.00,\n    \"apCheckTransactionCodeOrId\": \"APCHK\",\n    \"bankDepositTransactionCodeOrId\": \"DEP\",\n    \"bankWithdrawalTransactionCodeOrId\": \"WDR\",\n    \"electronicApCheckTransactionCodeOrId\": \"EAPCHK\",\n    \"categoryConfigs\": [\n        {\n            \"id\": null,\n            \"sequenceNumber\": 1,\n            \"categoryCodeOrId\": \"DEP\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"12fecd19-6bad-4f48-a1ab-d00a44f7df92"},{"name":"BankRecStatementConfigByBankAccountGet","id":"f2890b53-cb7b-4a76-ad2c-7413aa03ccd6","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/ByBankAccount/{{bank_account_number_or_id}}","description":"<h3 id=\"get-bank-rec-statement-config-by-bank-account\">Get Bank Rec Statement Config By Bank Account</h3>\n<p>Returns the Bank Reconciliation <strong>Statement Config</strong> that belongs to the supplied AP bank account. The path parameter accepts either the bank account number or the bank account Guid <code>Id</code>; the server resolves it via <code>SharedWSServices.GetAccountsPayableBankAccountId</code>. Wraps <code>BankRecStatementConfigWSServices.GetBankRecStatementConfigByBankAccountWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/ByBankAccount/{bankAccountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid). Returns <code>BadRequest</code> when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementConfig","ByBankAccount","{{bank_account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"94ee6ce1-ab99-499a-a8c4-ed2c5e439e06","name":"GetBankRecStatementConfigByBankAccount - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/ByBankAccount/{{bank_account_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"FirstStatementStartDate\": \"2025-01-01T00:00:00\",\n        \"FirstStatementStartingBalance\": 0.00,\n        \"ApCheckTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankDepositTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankWithdrawalTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ElectronicApCheckTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"75fccd45-c8ed-4dcc-b1db-27a84ab330f9","name":"GetBankRecStatementConfigByBankAccount - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/ByBankAccount/{{bank_account_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec statement config not found for this bank account\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f2890b53-cb7b-4a76-ad2c-7413aa03ccd6"},{"name":"BankRecStatementConfigDelete","id":"6ef8e237-cff4-4508-81c4-becfcd8c4eae","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{{bank_rec_statement_config_id}}","description":"<h3 id=\"delete-bank-rec-statement-config\">Delete Bank Rec Statement Config</h3>\n<p>This operation accepts full bank account number or statement-configuration GUID in <code>id</code>. The GUID must identify the selected record type. Use the statement-configuration GUID when selecting by ID; a bank-account GUID identifies a different record. A bank number must match exactly one configuration.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. full bank account number or statement-configuration GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>full bank account number or statement-configuration GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/AccountsPayable/BankRecStatementConfig/123456789\n/api/Client/AccountsPayable/BankRecStatementConfig/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementConfig","{{bank_rec_statement_config_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"658e8662-5ba5-46e5-a70e-89fad7e80c9e","name":"DeleteBankRecStatementConfig - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{{bank_rec_statement_config_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"Deleted\": true\n    }\n}"},{"id":"e1ec8b9f-08b7-4f35-9b4b-6e335d885a26","name":"DeleteBankRecStatementConfig - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"6ef8e237-cff4-4508-81c4-becfcd8c4eae"},{"name":"BankRecStatementConfigGet","id":"84d8c92e-f2ff-454f-87e4-c6a4224cf864","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{{bank_rec_statement_config_id}}","description":"<h3 id=\"get-bank-rec-statement-config\">Get Bank Rec Statement Config</h3>\n<p>This operation accepts full bank account number or statement-configuration GUID in <code>id</code>. The GUID must identify the selected record type. Use the statement-configuration GUID when selecting by ID; a bank-account GUID identifies a different record. A bank number must match exactly one configuration. A configuration with no categories returns an empty category list.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. full bank account number or statement-configuration GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>full bank account number or statement-configuration GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/AccountsPayable/BankRecStatementConfig/123456789\n/api/Client/AccountsPayable/BankRecStatementConfig/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementConfig","{{bank_rec_statement_config_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a68bce43-b42e-4836-9a75-1e281cc1b60d","name":"GetBankRecStatementConfig - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{{bank_rec_statement_config_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"FirstStatementStartDate\": \"2025-01-01T00:00:00\",\n        \"FirstStatementStartingBalance\": 0.00,\n        \"ApCheckTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankDepositTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankWithdrawalTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ElectronicApCheckTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"e449a68b-8a7b-4c0f-96d2-7e75a0f64180","name":"GetBankRecStatementConfig - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"84d8c92e-f2ff-454f-87e4-c6a4224cf864"},{"name":"BankRecStatementConfigsGetAll","id":"3b157e1e-2a32-4e26-9a10-4059fd781528","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig","description":"<h3 id=\"get-all-bank-rec-statement-configs\">Get All Bank Rec Statement Configs</h3>\n<p>Returns every AP Bank Reconciliation <strong>Statement Config</strong> defined for the client. Each Statement Config ties a bank account to its reconciliation settings (first statement start date, starting balance, and the transaction codes used for AP checks, bank deposits, bank withdrawals, and electronic AP checks). Wraps <code>BankRecStatementConfigWSServices.GetAllBankRecStatementConfigsWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementConfig"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"95870d96-8edd-4a66-829a-888f95f8ff20","name":"GetAllBankRecStatementConfigs - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"FirstStatementStartDate\": \"2025-01-01T00:00:00\",\n            \"FirstStatementStartingBalance\": 0.00,\n            \"ApCheckTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankDepositTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankWithdrawalTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"ElectronicApCheckTransactionCodeId\": \"00000000-0000-0000-0000-000000000000\"\n        }\n    ]\n}"},{"id":"fa814493-21be-411b-9e6e-70311cb22bd0","name":"GetAllBankRecStatementConfigs - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving bank rec statement configs: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"3b157e1e-2a32-4e26-9a10-4059fd781528"},{"name":"BankRecStatementConfigUpdate","id":"ef9cee4a-2440-4754-bd50-aee671f07918","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"firstStatementStartDate\": \"2025-01-01\",\n    \"firstStatementStartingBalance\": 0.00,\n    \"apCheckTransactionCodeOrId\": \"{{bank_rec_ap_check_transaction_code_or_id}}\",\n    \"bankDepositTransactionCodeOrId\": \"{{bank_rec_deposit_transaction_code_or_id}}\",\n    \"bankWithdrawalTransactionCodeOrId\": \"{{bank_rec_withdrawal_transaction_code_or_id}}\",\n    \"electronicApCheckTransactionCodeOrId\": \"{{bank_rec_electronic_ap_check_transaction_code_or_id}}\",\n    \"categoryConfigs\": [\n        {\n            \"id\": \"{{bank_rec_statement_category_config_id}}\",\n            \"sequenceNumber\": 1,\n            \"categoryCodeOrId\": \"{{bank_rec_category_code_or_id}}\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{{bank_rec_statement_config_id}}","description":"<h3 id=\"update-bank-rec-statement-config\">Update Bank Rec Statement Config</h3>\n<p>This operation accepts full bank account number or statement-configuration GUID in <code>id</code>. The GUID must identify the selected record type. Use the statement-configuration GUID when selecting by ID; a bank-account GUID identifies a different record. A bank number must match exactly one configuration. Updating a configuration changes its settings and categories, and does not change its bank-account association.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. full bank account number or statement-configuration GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>firstStatementStartDate</em></td>\n<td>Required date (ISO 8601). Start date of the very first reconciliation statement.</td>\n</tr>\n<tr>\n<td><em>firstStatementStartingBalance</em></td>\n<td>Required decimal. Starting ledger balance at the very first reconciliation statement.</td>\n</tr>\n<tr>\n<td><em>apCheckTransactionCodeOrId</em></td>\n<td>Required string. Bank Rec Category Transaction Code used for regular AP checks.</td>\n</tr>\n<tr>\n<td><em>bankDepositTransactionCodeOrId</em></td>\n<td>Optional string. Bank Rec Category Transaction Code used for bank deposits.</td>\n</tr>\n<tr>\n<td><em>bankWithdrawalTransactionCodeOrId</em></td>\n<td>Optional string. Bank Rec Category Transaction Code used for bank withdrawals.</td>\n</tr>\n<tr>\n<td><em>electronicApCheckTransactionCodeOrId</em></td>\n<td>Required string. Bank Rec Category Transaction Code used for electronic AP checks.</td>\n</tr>\n<tr>\n<td><em>categoryConfigs</em></td>\n<td>Optional array of child <strong>Category Config</strong> rows to add or update with this Statement Config. Each element is: <code>{ id, sequenceNumber, categoryCodeOrId }</code>. Elements with a non-null <code>id</code> are treated as updates; elements with <code>id = null</code> are treated as adds. Use <code>DELETE api/Client/AccountsPayable/BankRecStatementCategoryConfig/{id}</code> to remove individual category configs.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>full bank account number or statement-configuration GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/AccountsPayable/BankRecStatementConfig/123456789\n/api/Client/AccountsPayable/BankRecStatementConfig/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementConfig","{{bank_rec_statement_config_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"68af7857-ce3c-4071-9a83-3384d589bd8c","name":"UpdateBankRecStatementConfig - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"firstStatementStartDate\": \"2025-01-01\",\n    \"firstStatementStartingBalance\": 0.00,\n    \"apCheckTransactionCodeOrId\": \"APCHK\",\n    \"bankDepositTransactionCodeOrId\": \"DEP\",\n    \"bankWithdrawalTransactionCodeOrId\": \"WDR\",\n    \"electronicApCheckTransactionCodeOrId\": \"EAPCHK\",\n    \"categoryConfigs\": [\n        {\n            \"id\": \"00000000-0000-0000-0000-000000000000\",\n            \"sequenceNumber\": 1,\n            \"categoryCodeOrId\": \"DEP\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{{bank_rec_statement_config_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"9e482d71-a3ba-4b50-92e1-281c3b318c81","name":"UpdateBankRecStatementConfig - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"firstStatementStartDate\": \"2025-01-01\",\n    \"firstStatementStartingBalance\": 0.00,\n    \"apCheckTransactionCodeOrId\": \"INVALID\",\n    \"bankDepositTransactionCodeOrId\": \"DEP\",\n    \"bankWithdrawalTransactionCodeOrId\": \"WDR\",\n    \"electronicApCheckTransactionCodeOrId\": \"EAPCHK\",\n    \"categoryConfigs\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementConfig/{{bank_rec_statement_config_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec statement config not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"ef9cee4a-2440-4754-bd50-aee671f07918"},{"name":"BankRecStatementDelete","id":"87aeaf9d-26bb-4fc9-8e71-ceded8ad19e1","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/{{bank_rec_statement_id}}","description":"<h3 id=\"delete-bank-rec-statement\">Delete Bank Rec Statement</h3>\n<p>Removes a single <strong>Bank Rec Statement</strong> row (and its dependent reconciliation data) from the parent Statement Config. Wraps <code>BankRecStatementWSServices.DeleteWS</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.BankRecStatement</code> row to delete. Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatement","{{bank_rec_statement_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ee8a887c-9ff2-4b07-8e13-0ba516707751","name":"DeleteBankRecStatement - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/{{bank_rec_statement_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"Deleted\": true\n    }\n}"},{"id":"783b3eb4-53ee-453d-88a1-130b3611f22a","name":"DeleteBankRecStatement - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/{{bank_rec_statement_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank rec statement not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"87aeaf9d-26bb-4fc9-8e71-ceded8ad19e1"},{"name":"BankRecStatementTransactionAdd","id":"476a375f-ff33-45bc-8df4-478210d50f1f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"bankRecTransactionCodeOrId\": \"{{bank_rec_transaction_code_or_id}}\",\n    \"branchBankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n    \"effectiveDate\": \"2025-01-15\",\n    \"description\": \"Sample statement transaction\",\n    \"checkNumber\": null,\n    \"checkNumberOrId\": null,\n    \"amount\": 100.00,\n    \"status\": 1,\n    \"glChartAccountNumberOrId\": null,\n    \"voidBranchDate\": null,\n    \"clearedAmount\": 0.00,\n    \"clearedDate\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction","description":"<h3 id=\"add-bank-rec-statement-transaction\">Add Bank Rec Statement Transaction</h3>\n<p>Creates a new <strong>Bank Rec Statement Transaction</strong> for the supplied AP bank account. The server resolves the bank account via <code>SharedWSServices.GetAccountsPayableBankAccountId</code>, the bank rec transaction code via <code>SharedWSServices.GetAccountsPayableBankRecCategoryTransactionCodeId</code>, the optional GL chart via <code>SharedWSServices.GetGeneralLedgerChartId</code>, and the optional AP check via <code>SharedWSServices.GetAccountsPayableCheckId</code>, then delegates to <code>BankRecStatementTransactionWSServices.AddWS</code>.</p>\n<p>Validation rules:</p>\n<ul>\n<li><code>branchBankAccountId</code> must be a non-empty Guid.</li>\n<li><code>status</code> must be a defined value of <code>Omega.AccountsPayable.Types.Enums.StatementTransactionStatuses</code> (<code>1 = Open</code>, <code>2 = Cleared</code>, <code>3 = Voided</code>).</li>\n<li><code>amount</code> must not be <code>0</code>.</li>\n<li><code>clearedDate</code> is required when <code>status = Cleared</code>.</li>\n<li>When <code>status = Voided</code>, <code>voidBranchDate</code> defaults to the login's <code>CurrentBusinessDate</code> if not supplied.</li>\n<li><code>clearedAmount</code> / <code>clearedDate</code> are only persisted when <code>status = Cleared</code>; for other statuses they are coerced to <code>0</code> / <code>null</code>.</li>\n</ul>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>bankRecTransactionCodeOrId</em></td>\n<td>Required string. Bank rec category transaction code or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>branchBankAccountId</em></td>\n<td>Required Guid. Branch bank account identifier. <code>Guid.Empty</code> is rejected.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Required date (ISO 8601). Transaction effective date.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Free-text transaction description.</td>\n</tr>\n<tr>\n<td><em>checkNumber</em></td>\n<td>Optional long. Numeric check number, when applicable.</td>\n</tr>\n<tr>\n<td><em>checkNumberOrId</em></td>\n<td>Optional string. AP check number or <code>Id</code> (Guid) — when supplied, the server links the transaction to that existing check.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal. Transaction amount. Must be non-zero.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td>Required integer enum. <code>1 = Open</code>, <code>2 = Cleared</code>, <code>3 = Voided</code>.</td>\n</tr>\n<tr>\n<td><em>glChartAccountNumberOrId</em></td>\n<td>Optional string. GL chart account number or <code>Id</code> (Guid) used to post the offset entry.</td>\n</tr>\n<tr>\n<td><em>voidBranchDate</em></td>\n<td>Optional date. Applies only when <code>status = Voided</code>; defaults to the current business date when omitted.</td>\n</tr>\n<tr>\n<td><em>clearedAmount</em></td>\n<td>Optional decimal. Applies only when <code>status = Cleared</code>.</td>\n</tr>\n<tr>\n<td><em>clearedDate</em></td>\n<td>Optional date. Required when <code>status = Cleared</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementTransaction"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8ddc443a-17d9-4a32-b883-d1ee77b7753b","name":"AddBankRecStatementTransaction - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"bankRecTransactionCodeOrId\": \"{{bank_rec_transaction_code_or_id}}\",\n    \"branchBankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n    \"effectiveDate\": \"2025-01-15\",\n    \"description\": \"Sample statement transaction\",\n    \"checkNumber\": null,\n    \"checkNumberOrId\": null,\n    \"amount\": 100.00,\n    \"status\": 1,\n    \"glChartAccountNumberOrId\": null,\n    \"voidBranchDate\": null,\n    \"clearedAmount\": 0.00,\n    \"clearedDate\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"892f0435-eb95-4ee9-b2b0-9aad58a517c7","name":"AddBankRecStatementTransaction - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"bankRecTransactionCodeOrId\": \"{{bank_rec_transaction_code_or_id}}\",\n    \"branchBankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n    \"effectiveDate\": \"2025-01-15\",\n    \"description\": \"Sample statement transaction\",\n    \"checkNumber\": null,\n    \"checkNumberOrId\": null,\n    \"amount\": 100.00,\n    \"status\": 1,\n    \"glChartAccountNumberOrId\": null,\n    \"voidBranchDate\": null,\n    \"clearedAmount\": 0.00,\n    \"clearedDate\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"branchBankAccountId is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"476a375f-ff33-45bc-8df4-478210d50f1f"},{"name":"BankRecStatementTransactionsList","id":"9302dd3d-af9c-4367-82b4-5832dfd40a46","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction?bankAccountNumberOrId={{bank_account_number_or_id}}&statuses=1,2&fetchDetail=true&includeAPCheck=true","description":"<h3 id=\"list-bank-rec-statement-transactions\">List Bank Rec Statement Transactions</h3>\n<p>Returns <strong>Bank Rec Statement Transactions</strong> for the supplied AP bank account, optionally filtered by a comma-separated list of statuses. The server resolves the bank account via <code>SharedWSServices.GetAccountsPayableBankAccountId</code>, validates each status value against <code>Omega.AccountsPayable.Types.Enums.StatementTransactionStatuses</code> (<code>1 = Open</code>, <code>2 = Cleared</code>, <code>3 = Voided</code>), and delegates to <code>BankRecStatementTransactionWSServices.ListWS</code>. Returns <code>BadRequest</code> with <code>\"Bank account not found\"</code> when the bank account cannot be resolved and <code>\"Invalid status value: {value}\"</code> when any entry in <code>statuses</code> is not a recognized enum value.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid). Required; the route returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n<tr>\n<td><em>statuses</em></td>\n<td>Optional string. Comma-separated list of status enum values to include (<code>1</code> = Open, <code>2</code> = Cleared, <code>3</code> = Voided). Omit to include every status.</td>\n</tr>\n<tr>\n<td><em>fetchDetail</em></td>\n<td>Optional boolean. Defaults to <code>true</code>. Controls whether the response includes the per-transaction detail columns (<code>description</code>, <code>checkNumber</code>, <code>effectiveDate</code>, <code>amount</code>, etc.) in addition to the summary fields.</td>\n</tr>\n<tr>\n<td><em>includeAPCheck</em></td>\n<td>Optional boolean. Defaults to <code>true</code>. Controls whether AP-check-linked transactions (<code>AccountsPayable.Check</code>-sourced rows) are included in the result set.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementTransaction"],"host":["{{base_url}}"],"query":[{"key":"bankAccountNumberOrId","value":"{{bank_account_number_or_id}}"},{"key":"statuses","value":"1,2"},{"key":"fetchDetail","value":"true"},{"key":"includeAPCheck","value":"true"}],"variable":[]}},"response":[{"id":"320bfc80-f403-41b5-bc1f-341396988495","name":"ListBankRecStatementTransactions - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction?bankAccountNumberOrId={{bank_account_number_or_id}}&statuses=1,2&fetchDetail=true&includeAPCheck=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","AccountsPayable","BankRecStatementTransaction"],"query":[{"key":"bankAccountNumberOrId","value":"{{bank_account_number_or_id}}"},{"key":"statuses","value":"1,2"},{"key":"fetchDetail","value":"true"},{"key":"includeAPCheck","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": []\n}"},{"id":"5c577de2-bd82-46f1-af43-051279aca497","name":"ListBankRecStatementTransactions - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction?bankAccountNumberOrId=NONEXISTENT&statuses=1,2&fetchDetail=true&includeAPCheck=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","AccountsPayable","BankRecStatementTransaction"],"query":[{"key":"bankAccountNumberOrId","value":"NONEXISTENT"},{"key":"statuses","value":"1,2"},{"key":"fetchDetail","value":"true"},{"key":"includeAPCheck","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"9302dd3d-af9c-4367-82b4-5832dfd40a46"},{"name":"BankRecStatementTransactionUpdate","id":"b644d269-91d3-4f76-8660-408df6d5e752","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Updated statement transaction\",\n    \"checkNumber\": null,\n    \"amount\": 100.00,\n    \"status\": 2,\n    \"voidBranchDate\": null,\n    \"clearedAmount\": 100.00,\n    \"clearedDate\": \"2025-01-31\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction/{{bank_rec_statement_transaction_id}}","description":"<h3 id=\"update-bank-rec-statement-transaction\">Update Bank Rec Statement Transaction</h3>\n<p>Updates an existing <strong>Bank Rec Statement Transaction</strong> identified by its Guid <code>Id</code>. Only a narrow set of editable columns is accepted by this route — <code>bankAccountId</code>, <code>bankRecTransCodeId</code>, <code>branchBankAccountId</code>, and <code>effectiveDate</code> are <strong>not</strong> updatable once the row has been created. Wraps <code>BankRecStatementTransactionWSServices.UpdateWS</code>.</p>\n<p>Validation rules:</p>\n<ul>\n<li>Path <code>id</code> must be a valid Guid; otherwise returns <code>BadRequest</code> with <code>\"Invalid transaction ID format. Must be a valid GUID.\"</code>.</li>\n<li><code>status</code> must be a defined value of <code>Omega.AccountsPayable.Types.Enums.StatementTransactionStatuses</code> (<code>1 = Open</code>, <code>2 = Cleared</code>, <code>3 = Voided</code>).</li>\n<li><code>amount</code> must not be <code>0</code>, except when <code>status = Voided</code>.</li>\n<li><code>clearedDate</code> is required when <code>status = Cleared</code>.</li>\n<li>When <code>status = Voided</code>, <code>voidBranchDate</code> defaults to the login's <code>CurrentBusinessDate</code> if not supplied.</li>\n<li><code>clearedAmount</code> / <code>clearedDate</code> are only persisted when <code>status = Cleared</code>; for other statuses they are coerced to <code>0</code> / <code>null</code>.</li>\n</ul>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.BankRecStatementTransaction</code> row being updated.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Free-text transaction description.</td>\n</tr>\n<tr>\n<td><em>checkNumber</em></td>\n<td>Optional long. Numeric check number, when applicable.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal. Transaction amount. Must be non-zero unless <code>status = Voided</code>.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td>Required integer enum. <code>1 = Open</code>, <code>2 = Cleared</code>, <code>3 = Voided</code>.</td>\n</tr>\n<tr>\n<td><em>voidBranchDate</em></td>\n<td>Optional date. Applies only when <code>status = Voided</code>; defaults to the current business date when omitted.</td>\n</tr>\n<tr>\n<td><em>clearedAmount</em></td>\n<td>Optional decimal. Applies only when <code>status = Cleared</code>.</td>\n</tr>\n<tr>\n<td><em>clearedDate</em></td>\n<td>Optional date. Required when <code>status = Cleared</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatementTransaction","{{bank_rec_statement_transaction_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"85072427-2313-499d-b936-a54b07b18534","name":"UpdateBankRecStatementTransaction - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Updated statement transaction\",\n    \"checkNumber\": null,\n    \"amount\": 100.00,\n    \"status\": 2,\n    \"voidBranchDate\": null,\n    \"clearedAmount\": 100.00,\n    \"clearedDate\": \"2025-01-31\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction/{{bank_rec_statement_transaction_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"28915309-db1a-4189-8ac1-258fbcdd6130","name":"UpdateBankRecStatementTransaction - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Updated statement transaction\",\n    \"checkNumber\": null,\n    \"amount\": 100.00,\n    \"status\": 2,\n    \"voidBranchDate\": null,\n    \"clearedAmount\": 100.00,\n    \"clearedDate\": \"2025-01-31\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatementTransaction/not-a-guid"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid transaction ID format. Must be a valid GUID.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b644d269-91d3-4f76-8660-408df6d5e752"},{"name":"BankRecStatementUpdate","id":"70d72b49-3c5a-43cc-a6f8-d867138a80c3","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"statementDate\": \"2025-01-31\",\n    \"endingBalance\": 0.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/{{bank_rec_statement_id}}","description":"<h3 id=\"update-bank-rec-statement\">Update Bank Rec Statement</h3>\n<p>Updates an existing <strong>Bank Rec Statement</strong> identified by its Guid <code>Id</code>. Only the <code>statementDate</code> and <code>endingBalance</code> are editable via this route; the parent <code>BankRecStatementConfigId</code> is preserved server-side from the existing row. Returns <code>BadRequest</code> with <code>\"Invalid statement ID format. Must be a valid GUID.\"</code> when the path <code>id</code> is not a Guid, and <code>\"Bank rec statement not found\"</code> when the statement row does not exist. Wraps <code>BankRecStatementWSServices.AddSaveBankRecStatementWS</code> with the existing row's <code>Id</code>, <code>Ts</code>, and <code>BankRecStatementConfigId</code> injected server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.BankRecStatement</code> row being updated.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>statementDate</em></td>\n<td>Required date (ISO 8601). End date printed on the reconciliation statement.</td>\n</tr>\n<tr>\n<td><em>endingBalance</em></td>\n<td>Required decimal. Closing ledger balance reported on the statement.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BankRecStatement","{{bank_rec_statement_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"23d4d2a2-e74c-4ecf-a946-40d883149caa","name":"UpdateBankRecStatement - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"statementDate\": \"2025-01-31\",\n    \"endingBalance\": 0.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/{{bank_rec_statement_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"7da3e5c1-76ae-4a66-bb43-0e7f59090423","name":"UpdateBankRecStatement - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"statementDate\": \"2025-01-31\",\n    \"endingBalance\": 0.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BankRecStatement/not-a-guid"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid statement ID format. Must be a valid GUID.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"70d72b49-3c5a-43cc-a6f8-d867138a80c3"},{"name":"BankUpdate","id":"3b5c4a0e-ea30-4583-82a3-87d4537fc311","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"First National Bank\",\n    \"routingNumber\": \"021000021\",\n    \"active\": true,\n    \"website\": \"https://www.firstnational.example.com\",\n    \"notes\": \"Primary disbursement bank (updated)\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/Bank/{{bank_code_or_id}}","description":"<h3 id=\"update-bank\">Update Bank</h3>\n<p>Updates an existing Accounts Payable bank. The route <code>numberOrId</code> identifies the bank (accepts either the bank <code>Code</code> lookup value or the bank <code>Id</code> Guid). The server re-reads the current <code>Ts</code> for optimistic concurrency so the body does not need to supply one. Returns <code>data.Id</code> on success.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/Bank/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Bank code lookup value or bank <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string. Display name of the bank.</td>\n</tr>\n<tr>\n<td><em>routingNumber</em></td>\n<td>Required string. ABA/routing number for the bank.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. When <code>true</code>, the bank remains available for bank account setup.</td>\n</tr>\n<tr>\n<td><em>website</em></td>\n<td>Optional string. Public website URL for the bank.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form notes.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","Bank","{{bank_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"39b34338-daf6-4778-a2d0-73c269d69520","name":"UpdateBank - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"First National Bank\",\n    \"routingNumber\": \"021000021\",\n    \"active\": true,\n    \"website\": \"https://www.firstnational.example.com\",\n    \"notes\": \"Primary disbursement bank (updated)\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/Bank/{{bank_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"6e0c536a-4b07-4fc9-a2cb-21ac3b0fc4b9","name":"UpdateBank - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"First National Bank\",\n    \"routingNumber\": \"021000021\",\n    \"active\": true,\n    \"website\": \"https://www.firstnational.example.com\",\n    \"notes\": \"Primary disbursement bank (updated)\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/accountspayable/Bank/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"3b5c4a0e-ea30-4583-82a3-87d4537fc311"},{"name":"BranchBankAccountAdd","id":"4894951a-d9c5-428f-9c30-0af32ec5af73","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"glAccountNumberOrId\": \"{{gl_account_number_or_id}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"isActive\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount","description":"<h3 id=\"add-branch-bank-account\">Add Branch Bank Account</h3>\n<p>Creates a new Branch Bank Account row, linking a branch to an AP bank account (and optionally a GL account). Wraps <code>BranchBankAccountWSServices.AddBranchBankAccountWS</code>. All <code>*NumberOrId</code> fields accept either the natural number lookup or a Guid <code>Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Required string. Branch number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>glAccountNumberOrId</em></td>\n<td>Optional string. GL account number or <code>Id</code> (Guid) to tie to this branch/bank account link. May be blank when the link is not tied to a specific GL account.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required boolean. When <code>true</code>, the link is usable by AP processes running for this branch.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BranchBankAccount"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"df7f26a9-7529-4213-91ae-d6e1b4779401","name":"AddBranchBankAccount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"glAccountNumberOrId\": \"{{gl_account_number_or_id}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"isActive\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"481d59c8-cd7f-48cf-87e5-631c103929ba","name":"AddBranchBankAccount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"NONEXISTENT\",\n    \"glAccountNumberOrId\": \"{{gl_account_number_or_id}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"isActive\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Branch not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"4894951a-d9c5-428f-9c30-0af32ec5af73"},{"name":"BranchBankAccountDelete","id":"d1886a8e-6aa6-444f-a67c-e594a65f78ae","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}","description":"<h3 id=\"delete-branch-bank-account\">Delete Branch Bank Account</h3>\n<p>Deletes a Branch Bank Account row by its Guid primary key. Wraps <code>BranchBankAccountWSServices.DeleteBranchBankAccountWS</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.BranchBankAccount</code> row to delete. Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BranchBankAccount","{{branch_bank_account_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"003b74ce-5046-4240-8b96-676d73de9a83","name":"DeleteBranchBankAccount - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"Deleted\": true\n    }\n}"},{"id":"b120def6-b82f-4fd7-9f6a-74118e15da6b","name":"DeleteBranchBankAccount - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Branch bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d1886a8e-6aa6-444f-a67c-e594a65f78ae"},{"name":"BranchBankAccountGet","id":"b7f02d3a-5135-449a-9ad6-370dd4f9e8c8","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}","description":"<h3 id=\"get-branch-bank-account\">Get Branch Bank Account</h3>\n<p>Returns a single Branch Bank Account row, which links a branch to an AP bank account (and optionally a GL account). Wraps <code>BranchBankAccountWSServices.GetBranchBankAccountWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.BranchBankAccount</code> row. Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BranchBankAccount","{{branch_bank_account_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"88361e73-d7cc-4430-aeb0-5d8d19bbeeac","name":"GetBranchBankAccount - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"BranchId\": \"00000000-0000-0000-0000-000000000000\",\n        \"GlAccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"IsActive\": true\n    }\n}"},{"id":"42845f0d-ce10-4b35-9fa6-3adc15e970f7","name":"GetBranchBankAccount - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Branch bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b7f02d3a-5135-449a-9ad6-370dd4f9e8c8"},{"name":"BranchBankAccountsByBankAccountGet","id":"35c2aad9-af1c-484e-915a-21e26965c2ce","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/BranchBankAccounts","description":"<h3 id=\"get-branch-bank-accounts-by-bank-account\">Get Branch Bank Accounts By Bank Account</h3>\n<p>Returns every branch-bank-account mapping attached to the specified AP bank account. The response <code>data</code> is a list that includes the related bank account, branch, and chart records so callers can render the mapping without a follow-up lookup.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/client/accountspayable/BankAccount/{numberOrId}/BranchBankAccounts</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Bank account number or bank account <code>Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","accountspayable","BankAccount","{{bank_account_number_or_id}}","BranchBankAccounts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cbd4c3e8-333a-4206-aed6-c5247cd4fff9","name":"GetBranchBankAccountsByBankAccount - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/BranchBankAccounts"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"BranchId\": \"00000000-0000-0000-0000-000000000000\",\n            \"ChartId\": \"00000000-0000-0000-0000-000000000000\",\n            \"BankAccount\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000000\",\n                \"Number\": \"1234567890\",\n                \"Description\": \"Operating Checking\"\n            },\n            \"Branch\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000000\",\n                \"Code\": \"001\",\n                \"Description\": \"Main Branch\"\n            },\n            \"Chart\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000000\",\n                \"Code\": \"1010\",\n                \"Description\": \"Cash - Operating\"\n            }\n        }\n    ]\n}"},{"id":"d6b1d746-8455-457a-b2ac-8113f5db09fc","name":"GetBranchBankAccountsByBankAccount - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/client/accountspayable/BankAccount/{{bank_account_number_or_id}}/BranchBankAccounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"35c2aad9-af1c-484e-915a-21e26965c2ce"},{"name":"BranchBankAccountUpdate","id":"26e5e703-cab7-4e5d-8f02-808c61f7b9e6","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"glAccountNumberOrId\": \"{{gl_account_number_or_id}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"isActive\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}","description":"<h3 id=\"update-branch-bank-account\">Update Branch Bank Account</h3>\n<p>Updates an existing Branch Bank Account row identified by its Guid <code>Id</code>. Wraps <code>BranchBankAccountWSServices.UpdateBranchBankAccountWS</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.BranchBankAccount</code> row being updated.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Required string. Branch number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>glAccountNumberOrId</em></td>\n<td>Optional string. GL account number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required boolean. When <code>true</code>, the link is usable by AP processes running for this branch.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","BranchBankAccount","{{branch_bank_account_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"88e407cd-8ef7-4d4d-9a2b-821bb219fdc1","name":"UpdateBranchBankAccount - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"glAccountNumberOrId\": \"{{gl_account_number_or_id}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"isActive\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"87101cb3-3031-4dcf-815e-830d1bf9fce7","name":"UpdateBranchBankAccount - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"glAccountNumberOrId\": \"{{gl_account_number_or_id}}\",\n    \"bankAccountNumberOrId\": \"INVALID-BANK-ACCOUNT\",\n    \"isActive\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/BranchBankAccount/{{branch_bank_account_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Bank account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"26e5e703-cab7-4e5d-8f02-808c61f7b9e6"},{"name":"CheckDetailByVoucherGet","id":"f53ecddc-e7f3-4ccd-b131-100e563e7355","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByVoucher/{{voucher_number_or_id}}","description":"<h3 id=\"get-check-detail-by-voucher\">Get Check Detail By Voucher</h3>\n<p>Returns the <code>AccountsPayable.CheckDetail</code> row(s) that paid the specified voucher. Wraps <code>CheckDetailWSServices.GetCheckDetailByVoucherWS</code>. Useful for finding which check(s) satisfied a given voucher.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByVoucher/{voucherNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>voucherNumberOrId</em></td>\n<td>Required string. AP voucher number or <code>Id</code> (Guid). Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","CheckDetail","ByVoucher","{{voucher_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fc439519-4176-48c9-8a97-210e35e31619","name":"GetCheckDetailByVoucher - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByVoucher/{{voucher_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"CheckId\": \"00000000-0000-0000-0000-000000000000\",\n            \"VoucherId\": \"00000000-0000-0000-0000-000000000000\",\n            \"DetailAmount\": 125.50\n        }\n    ]\n}"},{"id":"6ab65df0-cac7-41eb-a057-8f63a1734591","name":"GetCheckDetailByVoucher - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByVoucher/{{voucher_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Voucher not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f53ecddc-e7f3-4ccd-b131-100e563e7355"},{"name":"CheckDetailsByCheckGet","id":"e2b44256-740b-41f7-a043-2ee557ca5ca4","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByCheck/{{check_number_or_id}}","description":"<h3 id=\"get-check-details-by-check\">Get Check Details By Check</h3>\n<p>Returns the list of <code>AccountsPayable.CheckDetail</code> rows for a given check. Wraps <code>CheckDetailWSServices.GetCheckDetailsByCheckWS</code>. Each check detail row represents one voucher allocation on the check (one check may pay multiple vouchers).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByCheck/{checkNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>checkNumberOrId</em></td>\n<td>Required string. AP check number or <code>Id</code> (Guid) to fetch detail rows for. Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","CheckDetail","ByCheck","{{check_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"67fc4b32-ba40-4c42-8537-b5b48b667a30","name":"GetCheckDetailsByCheck - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByCheck/{{check_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"CheckId\": \"00000000-0000-0000-0000-000000000000\",\n            \"VoucherId\": \"00000000-0000-0000-0000-000000000000\",\n            \"DetailAmount\": 125.50\n        }\n    ]\n}"},{"id":"73bcf64e-1aa3-4a61-8ab0-53049d0301eb","name":"GetCheckDetailsByCheck - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/CheckDetail/ByCheck/{{check_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Check not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e2b44256-740b-41f7-a043-2ee557ca5ca4"},{"name":"DisburseVouchers","id":"4178e6f0-91b5-4b29-aed0-8d8c2465dc50","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrIds\": [\n        \"{{voucher_number_or_id}}\"\n    ],\n    \"undisburse\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Disburse","description":"<h3 id=\"disburse-vouchers\">Disburse Vouchers</h3>\n<p>Moves one or more AP vouchers from <strong>Open</strong> to <strong>Disbursed</strong> status (or, when <code>undisburse=true</code>, moves Disbursed vouchers back to Open). A voucher must be Disbursed before it can be included on a check print batch (<code>api/Client/AccountsPayable/Check/PrintBatch</code>). Each voucher is resolved by <code>SharedWSServices.GetCommonVoucherId</code> which accepts either the voucher number or the voucher <code>Id</code> (Guid). The server applies the change transactionally — if any voucher fails validation, the entire request is rolled back and <code>errors[]</code> lists the failures. Wraps <code>AccountsPayableWSServices.API_DisburseVouchers</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/Voucher/Disburse</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>voucherNumberOrIds</em></td>\n<td>Required string array. One or more voucher numbers or <code>Id</code> values (Guid) to process.</td>\n</tr>\n<tr>\n<td><em>undisburse</em></td>\n<td>Optional boolean. Defaults to <code>false</code>. When <code>true</code>, the vouchers are reverted from Disbursed back to Open.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response Data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>voucherCount</em></td>\n<td>Number of vouchers processed.</td>\n</tr>\n<tr>\n<td><em>voucherNumbers</em></td>\n<td>Array of the voucher numbers that were processed.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td><code>\"Disbursed\"</code> when <code>undisburse=false</code>, <code>\"Open\"</code> when <code>undisburse=true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","Voucher","Disburse"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"30dcb012-4bda-441a-930c-15fae600dfac","name":"DisburseVouchers - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrIds\": [\n        \"{{voucher_number_or_id}}\"\n    ],\n    \"undisburse\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Disburse"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"voucherCount\": 1,\n        \"voucherNumbers\": [\n            \"100001\"\n        ],\n        \"status\": \"Disbursed\"\n    }\n}"},{"id":"b9cd8452-9d76-4ad9-83c1-84fb035fb5c2","name":"DisburseVouchers - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrIds\": [\n        \"99999999\"\n    ],\n    \"undisburse\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Disburse"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Voucher 99999999 was not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"4178e6f0-91b5-4b29-aed0-8d8c2465dc50"},{"name":"ExternalMasterConfiguration","id":"a48eff3d-c5a7-450b-8005-81ccc1145529","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"glAccountingBasis\": 1,\n    \"checkFormDealerId\": null,\n    \"checkFormLoanId\": null,\n    \"checkFormAccountsPayableId\": null,\n    \"checkFormThriftInterest\": null,\n    \"checkFormThriftWithdrawal\": null,\n    \"checkFormElectronicPayment\": null,\n    \"electronicCheckFormDealerId\": null,\n    \"electronicCheckFormLoanId\": null,\n    \"electronicCheckFormAccountsPayableId\": null,\n    \"defaultCustomerPayeeType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration","description":"<h3 id=\"add-external-master-configuration\">Add External Master Configuration</h3>\n<p>Creates the AP <strong>External Master Configuration</strong> record for the authenticated client. Exactly one configuration exists per client; call this endpoint the first time, then use the <code>PUT</code> endpoint to change it. Sets the GL accounting basis, the default customer payee type, and the default check form IDs used when printing paper and electronic checks for each AP form context (Dealer, Loan, AP, Thrift Interest, Thrift Withdrawal, Electronic Payment). The server commits a new record via <code>ExternalMasterConfigurationServices.AddExternalMasterConfiguration</code>. Wraps <code>AccountsPayableExternalMasterConfigurationWSServices.AddSaveWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>glAccountingBasis</em></td>\n<td>Required integer. GL accounting basis enum (<code>Omega.GeneralLedger.Types.Enums.GeneralLedgerAccountingBasis</code>). Must be a defined enum value.</td>\n</tr>\n<tr>\n<td><em>checkFormDealerId</em></td>\n<td>Optional Guid. Default check form for dealer payouts.</td>\n</tr>\n<tr>\n<td><em>checkFormLoanId</em></td>\n<td>Optional Guid. Default check form for loan disbursements.</td>\n</tr>\n<tr>\n<td><em>checkFormAccountsPayableId</em></td>\n<td>Optional Guid. Default check form for AP vouchers.</td>\n</tr>\n<tr>\n<td><em>checkFormThriftInterest</em></td>\n<td>Optional Guid. Default check form for thrift interest.</td>\n</tr>\n<tr>\n<td><em>checkFormThriftWithdrawal</em></td>\n<td>Optional Guid. Default check form for thrift withdrawals.</td>\n</tr>\n<tr>\n<td><em>checkFormElectronicPayment</em></td>\n<td>Optional Guid. Default check form for electronic payments.</td>\n</tr>\n<tr>\n<td><em>electronicCheckFormDealerId</em></td>\n<td>Optional Guid. Default electronic check form for dealer.</td>\n</tr>\n<tr>\n<td><em>electronicCheckFormLoanId</em></td>\n<td>Optional Guid. Default electronic check form for loan.</td>\n</tr>\n<tr>\n<td><em>electronicCheckFormAccountsPayableId</em></td>\n<td>Optional Guid. Default electronic check form for AP.</td>\n</tr>\n<tr>\n<td><em>defaultCustomerPayeeType</em></td>\n<td>Required integer. Customer payee type enum (<code>Omega.AccountsPayable.Types.Enums.CustomerPayeeType</code>). Must be a defined enum value.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fc9699cf-6ac0-43c5-87e5-ec43541bae50","name":"AddExternalMasterConfiguration - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"glAccountingBasis\": 1,\n    \"checkFormDealerId\": null,\n    \"checkFormLoanId\": null,\n    \"checkFormAccountsPayableId\": null,\n    \"checkFormThriftInterest\": null,\n    \"checkFormThriftWithdrawal\": null,\n    \"checkFormElectronicPayment\": null,\n    \"electronicCheckFormDealerId\": null,\n    \"electronicCheckFormLoanId\": null,\n    \"electronicCheckFormAccountsPayableId\": null,\n    \"defaultCustomerPayeeType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"a0eca877-8cb7-4d9e-abd6-ef5b2c4956cd","name":"AddExternalMasterConfiguration - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"glAccountingBasis\": 99,\n    \"checkFormDealerId\": null,\n    \"checkFormLoanId\": null,\n    \"checkFormAccountsPayableId\": null,\n    \"checkFormThriftInterest\": null,\n    \"checkFormThriftWithdrawal\": null,\n    \"checkFormElectronicPayment\": null,\n    \"electronicCheckFormDealerId\": null,\n    \"electronicCheckFormLoanId\": null,\n    \"electronicCheckFormAccountsPayableId\": null,\n    \"defaultCustomerPayeeType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid GL accounting basis value.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"a48eff3d-c5a7-450b-8005-81ccc1145529"},{"name":"ExternalMasterConfiguration","id":"15b74902-d3a3-49cf-a1e3-4bb14007c7df","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"glAccountingBasis\": 1,\n    \"checkFormDealerId\": null,\n    \"checkFormLoanId\": null,\n    \"checkFormAccountsPayableId\": null,\n    \"checkFormThriftInterest\": null,\n    \"checkFormThriftWithdrawal\": null,\n    \"checkFormElectronicPayment\": null,\n    \"electronicCheckFormDealerId\": null,\n    \"electronicCheckFormLoanId\": null,\n    \"electronicCheckFormAccountsPayableId\": null,\n    \"defaultCustomerPayeeType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration","description":"<h3 id=\"update-external-master-configuration\">Update External Master Configuration</h3>\n<p>Updates the AP <strong>External Master Configuration</strong> record for the authenticated client. The server looks up the existing record via <code>ExternalMasterConfigurationServices.ReturnExternalMasterConfiguration</code> using <code>LoginInfo.ClientId</code> and wires the existing <code>Id</code> and <code>Ts</code> automatically — you do <strong>not</strong> pass them in the body. Returns <code>BadRequest</code> with <code>\"AP master configuration not found\"</code> when no record exists yet (call the <code>POST</code> endpoint first to create it). All fields other than <code>token</code> are overwritten with the values supplied on the request, so send the complete configuration, not a partial patch. Wraps <code>AccountsPayableExternalMasterConfigurationWSServices.AddSaveWS</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>glAccountingBasis</em></td>\n<td>Required integer. GL accounting basis enum (<code>Omega.GeneralLedger.Types.Enums.GeneralLedgerAccountingBasis</code>). Must be a defined enum value.</td>\n</tr>\n<tr>\n<td><em>checkFormDealerId</em></td>\n<td>Optional Guid. Default check form for dealer payouts.</td>\n</tr>\n<tr>\n<td><em>checkFormLoanId</em></td>\n<td>Optional Guid. Default check form for loan disbursements.</td>\n</tr>\n<tr>\n<td><em>checkFormAccountsPayableId</em></td>\n<td>Optional Guid. Default check form for AP vouchers.</td>\n</tr>\n<tr>\n<td><em>checkFormThriftInterest</em></td>\n<td>Optional Guid. Default check form for thrift interest.</td>\n</tr>\n<tr>\n<td><em>checkFormThriftWithdrawal</em></td>\n<td>Optional Guid. Default check form for thrift withdrawals.</td>\n</tr>\n<tr>\n<td><em>checkFormElectronicPayment</em></td>\n<td>Optional Guid. Default check form for electronic payments.</td>\n</tr>\n<tr>\n<td><em>electronicCheckFormDealerId</em></td>\n<td>Optional Guid. Default electronic check form for dealer.</td>\n</tr>\n<tr>\n<td><em>electronicCheckFormLoanId</em></td>\n<td>Optional Guid. Default electronic check form for loan.</td>\n</tr>\n<tr>\n<td><em>electronicCheckFormAccountsPayableId</em></td>\n<td>Optional Guid. Default electronic check form for AP.</td>\n</tr>\n<tr>\n<td><em>defaultCustomerPayeeType</em></td>\n<td>Required integer. Customer payee type enum (<code>Omega.AccountsPayable.Types.Enums.CustomerPayeeType</code>). Must be a defined enum value.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7964338f-16e7-4981-a692-b45ae2401a0e","name":"UpdateExternalMasterConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"glAccountingBasis\": 1,\n    \"checkFormDealerId\": null,\n    \"checkFormLoanId\": null,\n    \"checkFormAccountsPayableId\": null,\n    \"checkFormThriftInterest\": null,\n    \"checkFormThriftWithdrawal\": null,\n    \"checkFormElectronicPayment\": null,\n    \"electronicCheckFormDealerId\": null,\n    \"electronicCheckFormLoanId\": null,\n    \"electronicCheckFormAccountsPayableId\": null,\n    \"defaultCustomerPayeeType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"39cd8b40-be1e-4591-bacf-9d95412e7707","name":"UpdateExternalMasterConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"glAccountingBasis\": 1,\n    \"checkFormDealerId\": null,\n    \"checkFormLoanId\": null,\n    \"checkFormAccountsPayableId\": null,\n    \"checkFormThriftInterest\": null,\n    \"checkFormThriftWithdrawal\": null,\n    \"checkFormElectronicPayment\": null,\n    \"electronicCheckFormDealerId\": null,\n    \"electronicCheckFormLoanId\": null,\n    \"electronicCheckFormAccountsPayableId\": null,\n    \"defaultCustomerPayeeType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"\"AP master configuration not found\""}],"_postman_id":"15b74902-d3a3-49cf-a1e3-4bb14007c7df"},{"name":"ExternalMasterConfiguration","id":"988d4a3c-589b-483f-9ffc-c54e9ef599fc","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration","description":"<h3 id=\"get-external-master-configuration\">Get External Master Configuration</h3>\n<p>Returns the single AP <strong>External Master Configuration</strong> record for the authenticated client. This record holds the GL accounting basis, default customer payee type, and the default check form IDs used when printing paper and electronic checks for Dealer, Loan, AP, Thrift Interest, Thrift Withdrawal, and Electronic Payment form types. The record is resolved server-side via <code>ExternalMasterConfigurationServices.ReturnExternalMasterConfiguration</code> using <code>LoginInfo.ClientId</code> — there is no id in the URL. Returns <code>BadRequest</code> with <code>\"AP master configuration not found\"</code> when the client has no configuration row yet (call the POST endpoint first to create it). Wraps <code>AccountsPayableExternalMasterConfigurationWSServices.GetWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dde454c5-2a1e-42c0-8ed0-a536a476e3e9","name":"GetExternalMasterConfiguration - Successful","originalRequest":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"ClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"GlAccountingBasis\": 1,\n        \"CheckFormDealerId\": \"00000000-0000-0000-0000-000000000000\",\n        \"CheckFormLoanId\": \"00000000-0000-0000-0000-000000000000\",\n        \"CheckFormAccountsPayableId\": \"00000000-0000-0000-0000-000000000000\",\n        \"CheckFormThriftInterest\": null,\n        \"CheckFormThriftWithdrawal\": null,\n        \"CheckFormElectronicPayment\": null,\n        \"ElectronicCheckFormDealerId\": null,\n        \"ElectronicCheckFormLoanId\": null,\n        \"ElectronicCheckFormAccountsPayableId\": null,\n        \"DefaultCustomerPayeeType\": 1,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"ff82b9d2-e2ab-47e0-8b80-0f26afd632af","name":"GetExternalMasterConfiguration - Fail","originalRequest":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/AccountsPayable/ExternalMasterConfiguration"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"\"AP master configuration not found\""}],"_postman_id":"988d4a3c-589b-483f-9ffc-c54e9ef599fc"},{"name":"InstantCheckAdd","id":"8689bfaa-6ce2-4191-8764-dc984ee11d50","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2023\",\r\n    \"receivedDate\":\"2/4/2023\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"Aufderhar - Pacocha\",\r\n    \"bankAccount\":\"98532633\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2023\",\r\n    \"folderPath\":\"System/checks\",\r\n    \"branchNumber\":\"90\",\r\n    \"CustomerNumber\": \"44\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1000\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/AddInstantCheck","description":"<h3 id=\"add-instant-check\">Add Instant Check</h3>\n<p>This endpoint allows you to add a new instant check and returns the check document for printing.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<ul>\n<li><p><code>token</code> (string): The token for authentication.</p>\n</li>\n<li><p><code>invoiceNumber</code> (string): The invoice number.</p>\n</li>\n<li><p><code>purchaseOrderNumber</code> (string): The purchase order number.</p>\n</li>\n<li><p><code>totalAmount</code> (decimal): The total amount of the check.</p>\n</li>\n<li><p><code>invoiceDate</code> (date): The date of the invoice.</p>\n</li>\n<li><p><code>receivedDate</code> (date): The date when the check was received.</p>\n</li>\n<li><p><code>memo1</code> (string): Additional memo information.</p>\n</li>\n<li><p><code>memo2</code> (string): Additional memo information.</p>\n</li>\n<li><p><code>bankName</code> (string): The bank used for the check.</p>\n</li>\n<li><p><code>bankAccount</code> (string): The bank account used for the check. Must exist for the selected branch.</p>\n</li>\n<li><p><code>checkNumber</code> (long): The check number.</p>\n</li>\n<li><p><code>checkDate</code> (date): The date of the check.</p>\n</li>\n<li><p><code>folderPath</code> (string): The folder location. Saves a copy of the check document in Omega &gt; Document Manager (i.e. System/Checks).</p>\n</li>\n<li><p><code>CHECK TYPES</code> Customer, Vendor, One Time, Account</p>\n<ul>\n<li><p>Customer</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The check branch number.</p>\n</li>\n<li><p><code>customerNumber</code> (int): The customer number.</p>\n</li>\n</ul>\n</li>\n<li><p>Vendor</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The check branch number.</p>\n</li>\n<li><p><code>vendorCode</code> (string): The vendor code.</p>\n</li>\n<li><p><code>splitAmongBranches</code> (bool): Available for enterprise only. Use the vendor split branch feature for the payment detail. If true then <code>paymentDetail.glBranchNumber</code> cannot be used.</p>\n</li>\n</ul>\n</li>\n<li><p>One Time</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The check branch number.</p>\n</li>\n<li><p><code>payeeName</code> (string): The name printed on the check.</p>\n</li>\n<li><p><code>phoneNumber</code> (string): The payee phone number.</p>\n</li>\n<li><p><code>addressLine1</code> (string): Payee street address</p>\n</li>\n<li><p><code>addressLine2</code> (string): Payee apt, unit, or suite</p>\n</li>\n<li><p><code>addressLine3</code> (string): Payee PO box or additional information</p>\n</li>\n<li><p><code>city</code> (string): City of the payee address</p>\n</li>\n<li><p><code>state</code> (string): State abbreviation or full name of the payee address</p>\n</li>\n<li><p><code>zipCode</code> (string): Postal code of the payee address</p>\n</li>\n<li><p><code>country</code> (string): Country of the payee address. Options: United States, Canada, Mexico</p>\n</li>\n<li><p><code>language</code> (string): Preferred language. Options: English, Spanish, French</p>\n</li>\n</ul>\n</li>\n<li><p>Account</p>\n<ul>\n<li><p><code>accountNumber</code> (long): The account to apply the check transaction. The account branch will be used for the check.</p>\n</li>\n<li><p><code>transactionCode</code> (string): The transaction code to use when applying the check transaction.</p>\n</li>\n<li><p><code>customerPayeeType</code> (string): The name to print as the payee. Options: Customer_Primary_Only = 1, Customer_Primary_And_Spouse_Or_CoSigner = 2</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p><code>paymentDetail</code> (list): List of general ledger distribution. Total must equal the check amount.</p>\n<ul>\n<li><p><code>paymentDetail.glAccountNumber</code> (int): The GL account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glBranchNumber</code> (int): The branch account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glClassNumber</code> (int): The class account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glPortfolioNumber</code> (int): The portfolio account for the payment detail. System must have portfolio turned on.</p>\n</li>\n<li><p><code>paymentDetail.amount</code> (decimal): The amount for the current payment detail.</p>\n</li>\n</ul>\n</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<ul>\n<li><p><code>Status</code>: 200</p>\n</li>\n<li><p><code>Content-Type</code>: application/json</p>\n</li>\n<li><p>Sample:</p>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n\"statusCode\": \"0\",\n\"status\": \"Ok\",\n\"data\": {\n    \"checkNumber\" : \"1234\",\n    \"voucherNumber\" : \"777\",\n    \"document\": \"base64 string of document\"\n    \"documentType\": \"pdf\"\n  },\n\"errors\": [],\n\"warnings\": []\n}\n\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","client","accountspayable","AddInstantCheck"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bbb28543-2579-43b0-9b51-4c7ba194b9ad","name":"Customer Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"branchNumber\":\"99\",\r\n    \"CustomerNumber\": \"44\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"3\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddInstantCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"voucherNumber\": 948,\n        \"checkNumber\": 4008,\n        \"document\": \"JVBERi0xLjcKJdDExrTOxdSghIKAgAoxIDAgb2JqCjw8DQovQ3JlYXRvciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9Qcm9kdWNlciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9DcmVhdGlvbkRhdGUgKEQ6MjAxODA0MDYwOTAzNTktMDcnMDAnKQovTW9kRGF0ZSAoRDoyMDE4MDQwNjA5MDM1OS0wNycwMCcpCj4+CmVuZG9iagoyIDAgb2JqCjw8DQovQWNyb0Zvcm0gNDAgMCBSCi9OYW1lcyAzMiAwIFIKL0V4dGVuc2lvbnMgPDwNCi9BREJFIDw8DQovRXh0ZW5zaW9uTGV2ZWwgMwovQmFzZVZlcnNpb24gLzEuNwo+Pgo+PgovUGFnZXMgMyAwIFIKL01ldGFkYXRhIDQxIDAgUgovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiAvMS43Ci9PdXRsaW5lcyA0MiAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwNCi9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwo+PgplbmRvYmoKNCAwIG9iago8PA0KL0NvbnRlbnRzIFs1IDAgUiA2IDAgUiA3IDAgUiA4IDAgUiA5IDAgUiAxMCAwIFIgXQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL1QxXzAgMTEgMCBSCj4+Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IF0KL1hPYmplY3QgPDwNCi9CRTQzQzJGNy0xQjFGLTQyQjktOUZCMi1GRDVFMjM3REQ4NTIgMTMgMCBSCi9GMUVCQTZBOC0wQUExLTRDMTEtOUY1OS1DMEI4RERDMjdCMDIgMTQgMCBSCi9GQkNCQjRCQS02OEUxLTQzRDItQTU5Ri01NEEzNTExRDRGNDEgMTUgMCBSCi9GMTE2QTRGRS0zOEEzLTQwNkEtQUE0NC0yQUNEOTlDNjZDRjkgMTYgMCBSCi9EODY4QTUzNC1GQ0M1LTRGQzktOUFBMS1FMEMzOUMxRjEzRDAgMTcgMCBSCi8yQjQzNDRCMC0zNTk0LTRFNDgtODA5Ri02MzhDOTBFOERCQTcgMTggMCBSCi8xNEIzRjc1Qy02QjA2LTRCNUItQkFBNi1DQzYyMzI5ODU4QkMgMTkgMCBSCi9ENURCODFGNS1FMjUyLTQ3RTUtOUI0Ri00Mzg2MTI0NzM4Q0UgMjAgMCBSCi8zQjFDNzk2Ny00MDUzLTRDMDQtOTI1Qy0zRjY5NUE5MDU0NUEgMjEgMCBSCi83MUE4RTI1OC1BNDJFLTQwQTQtQUJGQi1GNjM2QTA4QTUyNTQgMjIgMCBSCi9FMUIwNTRDNi03QzY5LTQ3ODMtQTQ1Mi0xRUZEMDRFMjA3OTEgMjMgMCBSCi9FNjU2OEUzNi01MzYwLTRFNzQtQjQ1OS0wNEUzRTI2QUQ5QkMgMjQgMCBSCi9EOTZEMzZDNy00MTI5LTRENzEtQUUyRS1EQUNBNDdCMjZEOUEgMjUgMCBSCi8zMjlGN0NBRS01QTYyLTQ1MjgtQUFFNy1CRjg5NDgxOTdDMjUgMjYgMCBSCi85RjFDMzRBMy02RTJELTRBNEItOUJCQy02MEI5MUFGMjlFRDIgMjcgMCBSCi8xOUFBNDM1OS02NzMxLTQ4MkUtQTBERS03MjJGN0U4OTJFQUIgMjggMCBSCi84MTNERDRGRS02RTkzLTRGNjctOUZDMy0wMkY1MEY1RTBFMzkgMjkgMCBSCi9BRkQzQUIxMy05RTQ4LTQ2NDgtOEYwNC1DRURDQTc0M0IzNTMgMzAgMCBSCi8wOUIxMzIzQi0wQjNCLTRFMkYtQkZFNS1CQzU1OUMyMTE4NzQgMzEgMCBSCj4+Cj4+Ci9Bbm5vdHMgW10KL01lZGlhQm94IFswIDAgNjEyIDc5MiBdCi9Dcm9wQm94IFswIDAgNjEyIDc5MiBdCi9Sb3RhdGUgMAovVHlwZSAvUGFnZQovUGFyZW50IDMgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8DQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDMxCj4+CnN0cmVhbQp4nFMo5DJUMABCEGluaaSQnAsV0IVQQH4gFwCHXwcOCmVuZHN0cmVhbQplbmRvYmoKNiAwIG9iago8PA0KL0xlbmd0aCA0Cj4+CnN0cmVhbQogcSAKCmVuZHN0cmVhbQplbmRvYmoKNyAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAzNjMKPj4Kc3RyZWFtCkiJpJLBT8IwGMXv/Su+RA5IQmm7zq7exBmjN7HhanBUrdlYLBv++3YIDLeCE7PD2rTv+723vbFCBKrHvqLRRKezwqz0dZ7m1mS6sCYBa9BI0ScCFNQLot+33YtLiTlcCIkFqAz1e4PBuXpHQx5hymFIIxxyUHPUj/Us1XY01Yt5bi+rOwSGLMQMVOw9dXoGLMBcROsB07xM3rSFs+r0Zmt4cusWBogz8QkM7gF9OItrc0CdNSqAixDLKIAkW2syxKnbu1WKHtEDGitE3QR/PMrEZobAxM2oIt4tVrlJ9J4R84O6kzSwgcA0lN24LAgPcuNZof3oWtVAh1XijuiABy10bJbPpV3qTC+KI/xa2uBHBIesI9/974PRr7K8dA56fnytbOBFgEXXL78pDXPV3NLbzTOemjHX1f/WbJ/asWYt7Ck183F/r1kLfUrN9tFxeQxbK5qJJSbyj+3yJe7Wrha+0a4vAQYAQD0mSwplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwNCi9MZW5ndGggNAo+PgpzdHJlYW0KIFEgCgplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwNCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMzEKPj4Kc3RyZWFtCnicUyjkMlQwAEIQaW5ppJCcCxXQhVBAfiAXAIdfBw4KZW5kc3RyZWFtCmVuZG9iagoxMCAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA2OTIKPj4Kc3RyZWFtCnicjZQ7riNHDEVzraI3wHbxW8WwvrkjL2AwoW3Y+w/Mlsav1W/eQIKAVnJxT5GX5PbPzXgzKjttmHVPVDaUXbZ/v29/bH/dcEvxw+1D9O3P229tCndaGbDhAqHm4KsRrKGTOI9RlLbx9237/fbDH3kvL/3vosN/4WzVaoFUK4J0xPBXh55aGaNTbunZX/fCulmx+z857swb0vH9TLlK76zWW5NWwcoMFg+Cqr5ApbIiDlmCJ0vDtsRTs+3pMPKA6NesT9JHXWhV1gQulUGSVahVBKj24d7N+vKTxRkfr/3hUHg3/Jr1WXrARrFSlQVW7wqyeoR0tHOmzt5xIY90DUlot5ch3UWHPzVhkZaA1QVkSoGSonHGpXuaZbSaL/7qKSwp5V95PwSHN0rjlbWDtWQgTRu0Wg16N2LyoqX107vIboybFI+nEUX85l8yLsJ7j3S0gkthkhJIngreJEaaiyFJjlLmT5yY8Pc4D+HB4YY9u+XIXCP4ngScojxe5lo9qWg9OVg2UT6ySLKXQl8yPkSHf8ZaooQCVWgGpArUthosY6spxoBUnvzJ3gF8qA7CxBav7Aa5m0enCgcreoZzjSQzUvWnNSGWNwin6k4wjRVkA2VLMU9ZoEksfbjzJKvDnzNnoTcIp+qetttg65ECUtQwMkKd0a9Re5XcyIY/pSCa3iCcqnvO5Cv3OkGrxTwpRSJ1ZmiruBT03EkvOVPC1zk/RIe/L+wchwls0gCp0mJeW6xJao51kc9B15zfAHyo7psXN0Jio8Eyxzks0Z6axoRMce9ncZq1XXN+TThVB6HE4RnHEbTpsQsrtsJXZ0i0NC2dabJfc35NOFUHoa7BtSGDH0dJ7LhMK1auz9FrFm6sfM35NeFUHYTkYU/cILX4xPiviDiOR+uq3gmx5P/37T9cU4W+CmVuZHN0cmVhbQplbmRvYmoKMTEgMCBvYmoKPDwNCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9TdWJ0eXBlIC9UeXBlMQovRm9udERlc2NyaXB0b3IgMTIgMCBSCi9UeXBlIC9Gb250Ci9CYXNlRm9udCAvTXlyaWFkUHJvLVJlZ3VsYXIKL1dpZHRocyBbNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCAyMTIgMjMwIDMzNyA0OTcgNTEzIDc5MiA2MDUgMTg4IDI4NCAyODQgNDE1IDU5NiAyMDcgMzA3IDIwNyAzNDMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDIwNyAyMDcgNTk2IDU5NiA1OTYgNDA2IDczNyA2MTIgNTQyIDU4MCA2NjYgNDkyIDQ4NyA2NDYgNjUyIDIzOSAzNzAgNTQyIDQ3MiA4MDQgNjU4IDY4OSA1MzIgNjg5IDUzOCA0OTMgNDk3IDY0NyA1NTggODQ2IDU3MSA1NDEgNTUzIDI4NCAzNDEgMjg0IDU5NiA1MDAgMzAwIDQ4MiA1NjkgNDQ4IDU2NCA1MDEgMjkyIDU1OSA1NTUgMjM0IDI0MyA0NjkgMjM2IDgzNCA1NTUgNTQ5IDU2OSA1NjMgMzI3IDM5NiAzMzEgNTUxIDQ4MSA3MzYgNDYzIDQ3MSA0MjggMjg0IDIzOSAyODQgNTk2IDI4MiA1MTMgMjgyIDIwNyA1MTMgMzU2IDEwMDAgNTAwIDUwMCAzMDAgMTE1NiA0OTMgMjU1IDg5NCAyODIgNTUzIDI4MiAyODIgMjA3IDIwNyAzNTQgMzU0IDI4MiA1MDAgMTAwMCAzMDAgNjE5IDM5NiAyNTUgODYzIDI4MiA0MjggNTQxIDIxMiAyMzAgNTEzIDUxMyA1MTMgNTEzIDIzOSA1MTkgMzAwIDY3NyAzNDYgNDE5IDU5NiAzMDcgNDE5IDMwMCAzMTggNTk2IDMxMSAzMDUgMzAwIDU1MyA1MTIgMjA3IDMwMCAyNDQgMzU1IDQxOSA3NTkgNzU5IDc1OSA0MDYgNjEyIDYxMiA2MTIgNjEyIDYxMiA2MTIgNzg4IDU4NSA0OTIgNDkyIDQ5MiA0OTIgMjM5IDIzOSAyMzkgMjM5IDY3MSA2NTggNjg5IDY4OSA2ODkgNjg5IDY4OSA1OTYgNjg5IDY0NyA2NDcgNjQ3IDY0NyA1NDEgNTMxIDU0OCA0ODIgNDgyIDQ4MiA0ODIgNDgyIDQ4MiA3NzMgNDQ3IDUwMSA1MDEgNTAxIDUwMSAyMzQgMjM0IDIzNCAyMzQgNTQxIDU1NSA1NDkgNTQ5IDU0OSA1NDkgNTQ5IDU5NiA1NDkgNTUxIDU1MSA1NTEgNTUxIDQ3MSA1NjkgNDcxIF0KL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciAyNTUKPj4KZW5kb2JqCjEyIDAgb2JqCjw8DQovRm9udFdlaWdodCA0MDAKL1hIZWlnaHQgNDg0Ci9EZXNjZW50IC0yNTAKL0ZvbnROYW1lIC9NeXJpYWRQcm8tUmVndWxhcgovQXNjZW50IDk1MgovQ2FwSGVpZ2h0IDY3NAovRm9udEJCb3ggWy0xNTcgLTI1MCAxMTI2IDk1MiBdCi9Gb250RmFtaWx5IChNeXJpYWQgUHJvKQovRmxhZ3MgMzIKL0ZvbnRTdHJldGNoIC9Ob3JtYWwKL1N0ZW1WIDg4Ci9JdGFsaWNBbmdsZSAwCi9UeXBlIC9Gb250RGVzY3JpcHRvcgo+PgplbmRvYmoKMTMgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0QzOUIzRTc3NTFGMjQyQTQ5NjQ4RkY3OTBENUIzMzM5Ci9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9EMzlCM0U3NzUxRjI0MkE0OTY0OEZGNzkwRDVCMzMzOSkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyMQo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pqmYuVJ0KYhccA40tkpVSBXt25tFt+8sRyi8wW7WRkqfPf5tK1PllB8GnHBHoR/W7Ra1omjndAndIT1Wx9i/xpBohXrOl54o6Yx31A4L8dZxH6cpjtyFZ3yHeUm9olE0efUFqyAf8gplbmRzdHJlYW0KZW5kb2JqCjE0IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV85NEVBODg4MTJDMDY0QTY4ODQyNzU3NTczNkFBQUMxRAovQkJveCBbMCAwIDE3NS4wMjggMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fOTRFQTg4ODEyQzA2NEE2ODg0Mjc1NzU3MzZBQUFDMUQpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMzEKPj4Kc3RyZWFtCnicPcw9C8IwFEbh/f6Kd1SwaT6qxrXSQbAicrFzoLFV2gaCRf33ZtHtOcuRkBhJbddCaps8/K0KUaSUP/TU0EQ5v1HWeyqZ8voT7649x5BdfDcPLkJJ8C1dOpCGEdaAW1qc/AtXH8PkxjA/+xUOR5iN2elMaWOX4AdVTFW6fgEvWSKVCmVuZHN0cmVhbQplbmRvYmoKMTUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0RFRkQxMDFCNzgwNzQwRUE5RDhBNENBQTQzNjEwNzQ4Ci9CQm94IFswIDAgMjkxLjMzIDEyLjMzIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9ERUZEMTAxQjc4MDc0MEVBOUQ4QTRDQUE0MzYxMDc0OCkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyNQo+PgpzdHJlYW0KeJw9zLEKwjAUheH9PMUZdUibplboWi24FEQudC4ktkps4UpB39446HL4hsNvafmAq4usLBPjj4X7boT9a0KPGbm82HQHNIK8e+tt8GddzCWMaxyUNeWaKiPhWGVuv6N4bGTSEHhaZ6/B87jEdH2SNGZLuaMVtKn4Aa0SIj4KZW5kc3RyZWFtCmVuZG9iagoxNiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fOTc0NEIwNUNBNTkwNDdGNzlEMjQ3RDIxMDE0ODFBNkMKL0JCb3ggWzAgMCA2OS4zMzUgMTIuMzMgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzk3NDRCMDVDQTU5MDQ3Rjc5RDI0N0QyMTAxNDgxQTZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTExCj4+CnN0cmVhbQp4nD3MvQqDQBAE4H6eYkotcq53qNgaLAUJC6kFfxIxCRwEkrd3G63mm2JGKHyhrF0IhXE7mHsLq3LqgTveyPTHpruiUWTdPz6HsY+fy21avtsQmQt1tpuF8PSuqgvqiCSIOJGUuqJVtDbfASxgGxAKZW5kc3RyZWFtCmVuZG9iagoxNyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUKL0JCb3ggWzAgMCA4My42MSAxMi4zMyBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTMKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7Vwd2YWdW0jKQMiA9aBaIxEhQVB/94txO7c5gqFd+QUNlo1/6QWUqolf11xwgPR32y6PRpH7D5l6odDea6O5/E194Uq9Eu9jITRwna3pg9YSI6ao4npkn5D62jr4gtlxRtzCmVuZHN0cmVhbQplbmRvYmoKMTggMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0U5OTkwQTg1ODE1RTQ4MjFCMkY1MjQwRTAxOUFBQkNGCi9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9FOTk5MEE4NTgxNUU0ODIxQjJGNTI0MEUwMTlBQUJDRikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pq20c6WbAZELnQONtRIrhBb07c2i23eWIxQ+YZujkbLNjn/b2tQ55Yc7Biwo9M3OndApCvdJsx8v6XW4hmmLPtEK9ZYvE1GyMm1FHbFzftlC5Hle1xj21Ad6RZ8nX/uzHqAKZW5kc3RyZWFtCmVuZG9iagoxOSAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMKL0JCb3ggWzAgMCAyMDcgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjYKPj4Kc3RyZWFtCnicNcw9C4MwFEbh/f6Kd2wH9foB7arBoYNQyoXOwaTaViPECO2/byg4nTM9DMZMBZ9ip3/zKq3i8j4j3clRJh80naJGKOu+/qnN1S/JzQ7bpD1yhjyiMIAKlOm5hBg61Mbg4tagXYAabf9GArWtYZmtP0Je1Aq10fwBICch3wplbmRzdHJlYW0KZW5kb2JqCjIwIDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV80MTM3MkVCNDA1QzY0OTNDOEM0NjU3RThDOTkxRDdDNQovQkJveCBbMCAwIDIyMS4zNjkgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNDEzNzJFQjQwNUM2NDkzQzhDNDY1N0U4Qzk5MUQ3QzUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTYKPj4Kc3RyZWFtCnicPcw9C8IwGEXh/f6KO+pgmo8ida10MyDyQudAY1uJFUIL+u/NottzlqOp+YS1RrnjqTj9bWpVl9Q/TOixoJI3W39GK6j8J89huObX4RbHLYVMoyn3chkJS6caRxmw82HZYuJlXtcU95QHOkFXJl/7gR6gCmVuZHN0cmVhbQplbmRvYmoKMjEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzFDRTU1MTZCRkJERDQxRjVBOEVFNDJCRTlGOENFMTY3Ci9CQm94IFswIDAgMjIxLjM2OSAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8xQ0U1NTE2QkZCREQ0MUY1QThFRTQyQkU5RjhDRTE2NykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zD0LwjAYReH9/oo76mCajyJ1rXQzIPJC50BjW4kVQgv6782i23OWo6n5hLVGueOpOP1talWX1D9M6LGgkjdbf0YrqPwnz2G45tfhFscthUyjKfdyGQlLpxpHGbDzYdli4mVe1xT3lAc6QVcmX/uBHqAKZW5kc3RyZWFtCmVuZG9iagoyMiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMjU4MTk5NkJCMEI2NEYzNEFEMTcxOUE5MkNGMkEwNkMKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzI1ODE5OTZCQjBCNjRGMzRBRDE3MTlBOTJDRjJBMDZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MsQqDQBRE0X6+Ykotsr7VLdbWYCmIPLAWNEYxCgtC8vfZRrszxR2h8AMrznifR2+3rTMuTrnwRo8dmX5ZNU9Uiqz5hWUY23A8umk+tyHQCvUVX2YiZ2F8QR2RlM6n1BW1oo7pH8BbGlUKZW5kc3RyZWFtCmVuZG9iagoyMyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fQ0IzQUZGRUMwODk1NENCRDg3QjU1Njk5NTdFM0FGOUEKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtX0NCM0FGRkVDMDg5NTRDQkQ4N0I1NTY5OTU3RTNBRjlBKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MuwqDQBSE4X6eYsqkcD17KbZWLIUQDlgL3tEEFgLJ27uN6b4p/hEKD1gJJkaXvf9tgwl5yoUFHV4o9cuqrVEpyvaX1n54pHfxHOfP3idaoU75ZSYcvYmeOuBmnQ936oZG0eT2BNndGnoKZW5kc3RyZWFtCmVuZG9iagoyNCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fNkQ0RURDOEQ2NEM4NDcxQ0EzMTY5ODA4MEVFQjBGOUUKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzZENEVEQzhENjRDODQ3MUNBMzE2OTgwODBFRUIwRjlFKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQqDMBRG4f1/in9sB5N7Y4bMiqNQyoXOgta2aAuBgr69WdrtO8sRCleoRJdSKF7+1uhiSfnhgRve8Lax6Vs0Bt/v+TmMl/yprtP8XYZMFdq9XGYisHappo04SfIqPkjQM+2FztCVwwF63RucCmVuZHN0cmVhbQplbmRvYmoKMjUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzM4OTdDOEM1MDg5NTQ0NUM4NjlGODFCQjJEODcyMzczCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8zODk3QzhDNTA4OTU0NDVDODY5RjgxQkIyRDg3MjM3MykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExMgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1KHJvUmGzJWOBZELnQvVqrQKAUHfvlnq9p3lCIUrVJLLOVQvf2tyqabsuGPAC96+bPsTWoPvf+UxTufybi7X+bOMhSq0W73MRGB0OdImHCT7qD5I0CPtic7Q1cMGexUbnwplbmRzdHJlYW0KZW5kb2JqCjI2IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8wRkQ4Nzc3QzczQTQ0REVGQUVEN0FGMzdBQ0IzNEIyQwovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMEZEODc3N0M3M0E0NERFRkFFRDdBRjM3QUNCMzRCMkMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTQKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7XIZDa7xq0jKQMhDFgHEqMSFRYE/Xu3Md25zVUqH3AaJMYqe93sgoSc+scVZzxR2odNd0JjKLtvuo1Tn17FMC/vdUx0Srvky0IcD+Lqil6ip03YeVVR3dPuaA1tXvwAlzEb0gplbmRzdHJlYW0KZW5kb2JqCjI3IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV9FQjkwMkY1MEU5QkM0RDM5QUVFNzg5MkNGMjVBMzVDQQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUI5MDJGNTBFOUJDNEQzOUFFRTc4OTJDRjI1QTM1Q0EpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcyxCoNAFETRfr5iSi2yvtUt1tZgKYg8sBY0RjEKC0Ly99lGuzPFHaHwAyvOeJ9Hb7etMy5OufBGjx2Zflk1T1SKrPmFZRjbcDy6aT63IdAK9RVfZiJnYXxBHZGUzqfUFbWijukfwFsaVQplbmRzdHJlYW0KZW5kb2JqCjI4IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8xREUyOTk1RDYxODI0MUI3ODdGMjFGOURBODNENDY4OQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMURFMjk5NUQ2MTgyNDFCNzg3RjIxRjlEQTgzRDQ2ODkpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcy7CoNAFIThfp5iyqRwPXsptlYshRAOWAve0QQWAsnbu43pvin+EQoPWAkmRpe9/22DCXnKhQUdXij1y6qtUSnK9pfWfnikd/Ec58/eJ1qhTvllJhy9iZ464GadD3fqhkbR5PYE2d0aegplbmRzdHJlYW0KZW5kb2JqCjI5IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV81QThDOTFGREE2REQ0NDUyQTlGRUZGREQ0QkU2QzY3RgovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNUE4QzkxRkRBNkRENDQ1MkE5RkVGRkRENEJFNkM2N0YpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTIKPj4Kc3RyZWFtCnicPcyxCoMwFEbh/X+Kf2wHk3tjhsyKo1DKhc6C1rZoC4GCvr1Z2u07yxEKV6hEl1IoXv7W6GJJ+eGBG97wtrHpWzQG3+/5OYyX/Kmu0/xdhkwV2r1cZiKwdqmmjThJ8io+SNAz7YXO0JXDAXrdG5wKZW5kc3RyZWFtCmVuZG9iagozMCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMzJBNTAyRDMxNjY1NDgzMjhDODZBRDQxOERBOTU1OEQKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzMyQTUwMkQzMTY2NTQ4MzI4Qzg2QUQ0MThEQTk1NThEKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQrCMBRG4f1/in/Uocm9SYbMlY4FkQudC9WqtAoBQd++Wer2neUIhStUkss5VC9/a3Kppuy4Y8AL3r5s+xNag+9/5TFO5/JuLtf5s4yFKrRbvcxEYHQ50iYcJPuoPkjQI+2JztDVwwZ7FRufCmVuZHN0cmVhbQplbmRvYmoKMzEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzc2QkRCNTMxMzBBQTREQzQ5RjNDRUQzNTdGRjYyMzEyCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV83NkJEQjUzMTMwQUE0REM0OUYzQ0VEMzU3RkY2MjMxMikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNAo+PgpzdHJlYW0KeJw9zLEKwkAQRdH+fcUrtchkNrvGrSMpAyEMWAcSoxIVFgT9e7cx3bnNVSofcBokxip73eyChJz6xxVnPFHah013QmMou2+6jVOfXsUwL+91THRKu+TLQhwP4uqKXqKnTdh5VVHd0+5oDW1e/ACXMRvSCmVuZHN0cmVhbQplbmRvYmoKMzIgMCBvYmoKPDwNCi9KYXZhU2NyaXB0IDMzIDAgUgo+PgplbmRvYmoKMzMgMCBvYmoKPDwNCi9OYW1lcyBbKDAwMDAwMCkgMzQgMCBSICgwMDAwMDIpIDM2IDAgUiAoMDAwMDA0KSAzOCAwIFIgXQo+PgplbmRvYmoKMzQgMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzNSAwIFIKPj4KZW5kb2JqCjM1IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQ2MQo+PgpzdHJlYW0KSInUlMFu2zAMhu99CiKnBAj8AkMO3tIWxbqk6JruaMgWnXCVRU9iYvjtR9ldgwbGsB4HGIYh/aQ+/qRFNcylb5HruRwoZvn68/UCViuYHb3Fmjza2eIKAN52YQUeO9iWP7GS+eLTVVrM7vPN7S6/Tbuz681u9rr8TNhhKKIE8vviicRhUuSWS4S8ClwamdbuWmsEizXG6hxx5wWDqYROCDccmgij7E+KRzT2nGKDaPXVFc8YIrEvvsV9yvWkpcDD+gZqUpyAv44UMIJJdWGA06gGrmE8dcyawYOqImy/gjBY7rxjY9UXBKcIUc6BASIi9HzUjz4KNmBsQ56UywiHbLriKdxi6+w75L/Sjn5m8IXbfmgY7B7vwXgLrVEMIK/kA1YZuIsafYE6cn6A772d2pF/sPMN8wfJgY9yqVwOng7JGtODpdg60y+hVGla8CzQcXiBNnCLwfUZfOfmNQIdNuglQkP7gwxaPfJEkUrttdHDnFODHFUvqZMaAw2HZE0KNzKQ6lOK0Yb5/WR/LwbjA+0cxzX8p7bd1TpMaYoweBSo2Hu9AxKllmJOhpxR+RKqZG8yTx3uyLnz35JmkXwUTTfhbHLytwADANKtmaYKZW5kc3RyZWFtCmVuZG9iagozNiAwIG9iago8PA0KL1MgL0phdmFTY3JpcHQKL0pTIDM3IDAgUgo+PgplbmRvYmoKMzcgMCBvYmoKPDwNCi9GaWx0ZXIgWy9GbGF0ZURlY29kZSBdCi9MZW5ndGggMjc0Cj4+CnN0cmVhbQpIidySUUvDMBSF3/srLnkYK0Liq9YikykIUmHTgk/lrrmtwawJbbohzv9uW9xkXQt79jH3fDnccxKVwdR9WjLZdDa/u+cLQkllEqOuKZlVHyR9CENgdSEpUwVJ5nsAMMJCCBnqigJP9XxjRdtzfU/Zcd/fHSIimcRUVsoUfWPY7WCMhRu44pe+99UPdQSFLRQM545ou+eS18VTw7J35+y1EGmuOEqzIp6atagspQq1wLQ0K3SithIdsT/X5dvyMXp4bg1ubcjgAtBabjW6zJTr5sgmm8N401W036/V9EHTWOQ15tSN096Vl6a7Tig7YSxy4H2PPeFZVQ+wp1UPQb2qj77CP6h6IHJb9Y8AAwCXJB2JCmVuZHN0cmVhbQplbmRvYmoKMzggMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzOSAwIFIKPj4KZW5kb2JqCjM5IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQwNQo+PgpzdHJlYW0KSInUU11PwjAUfYZfcd0Ti2QRX1SUBxRJTBSUr+jT0tC70VjKsnagAf67XRmw6UAMTy5L06bnnnvPPbfMg5L6DHDilT484jIhFeEcqQ21GliRoOgxgdSCxQJSuCmGkk1EHip1DTdw7lzaxXkRAJjORILAmTKcYdjTXCa4g4RiaNkxxOASaL1xe++sLt0B4RG6dfmOFE5qoMII7QS6DvmRYLAp4co5s7eoVEAqhnAMVSanVCETvttCpHqZuQmf+yT9MlT0b7RX7Ayd/tSIScdH1e885mhIM2kEnILBdN+6D61muwwe4RLt6wzprk6sGpHCLrdb1DR54gamN/vEuf2AEoXhbpExpbab3k3GwUSgUKX5MLazaj3zyGfCKsOwRcb6/NqsxwfNXrX0IFjLjTJTqlniSnO9T0o9zvuLjPdJ8SFKXbhEXfdLhFJpaBUObU+bUy2pgR6JuMqGHWbxsMcUx9yE5iZuUqHw3cMjh/p3YXuHOmbjJBLD0Was/6TZuPY/J3X9AHPGMfsAk5FeFr8EGAC5qJCpCmVuZHN0cmVhbQplbmRvYmoKNDAgMCBvYmoKPDwNCi9GaWVsZHMgW10KPj4KZW5kb2JqCjQxIDAgb2JqCjw8DQovVHlwZSAvTWV0YWRhdGEKL1N1YnR5cGUgL1hNTAovTGVuZ3RoIDEwODkKPj4Kc3RyZWFtCjw/eHBhY2tldCBiZWdpbj0iIiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA0LjIuMS1jMDQxIj4NCjxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyIgPg0KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj4NCiAgPGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD4NCiAgPGRjOnRpdGxlPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzp0aXRsZT4NCiAgPGRjOmRlc2NyaXB0aW9uPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzpkZXNjcmlwdGlvbj4NCiAgPGRjOmNyZWF0b3I+DQogICAgPHJkZjpTZXE+DQogICAgICA8cmRmOmxpIC8+DQogICAgPC9yZGY6U2VxPg0KICA8L2RjOmNyZWF0b3I+DQo8L3JkZjpEZXNjcmlwdGlvbj4NCjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnBkZj0iaHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyI+DQogIDxwZGY6S2V5d29yZHMgLz4NCiAgPHBkZjpQcm9kdWNlcj5BZG9iZSBMaXZlQ3ljbGUgRGVzaWduZXIgMTEuMDwvcGRmOlByb2R1Y2VyPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iPg0KICA8eG1wOkNyZWF0b3JUb29sPkFkb2JlIExpdmVDeWNsZSBEZXNpZ25lciAxMS4wPC94bXA6Q3JlYXRvclRvb2w+DQogIDx4bXA6Q3JlYXRlRGF0ZT4yMDE4LTA0LTA2VDE2OjAzOjU5KzAwOjAwPC94bXA6Q3JlYXRlRGF0ZT4NCiAgPHhtcDpNb2RpZnlEYXRlPjIwMTgtMDQtMDZUMTY6MDM6NTkrMDA6MDA8L3htcDpNb2RpZnlEYXRlPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8L3JkZjpSREY+DQo8L3g6eG1wbWV0YT4NCjw/eHBhY2tldCBlbmQ9InciPz4NCgplbmRzdHJlYW0KZW5kb2JqCjQyIDAgb2JqCjw8DQovVHlwZSAvT3V0bGluZXMKL0NvdW50IC0xCi9GaXJzdCA0MyAwIFIKL0xhc3QgNDMgMCBSCj4+CmVuZG9iago0MyAwIG9iago8PA0KL0NvdW50IDAKL1RpdGxlIChDaGVja180MDA4IC0gTmV3RG9jUDEgLSBBUENoZWNrc18wMDAwMDAwMCswMDAwKzAwMDArMDAwMCswMDAwMDAwMDAwMDBfQVBETFQxMTEpCi9DIFswIDAgMCBdCi9GIDIKL0EgPDwNCi9OZXh0IFtdCi9TIC9Hb1RvCi9EIFs0IDAgUiAvWFlaIDAgNzkyIDEgXQo+PgovUGFyZW50IDQyIDAgUgo+PgplbmRvYmoKeHJlZgowIDQ0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAyMyAwMDAwMCBuIAowMDAwMDAwMjAzIDAwMDAwIG4gCjAwMDAwMDA0MDAgMDAwMDAgbiAKMDAwMDAwMDQ1OSAwMDAwMCBuIAowMDAwMDAxNTY1IDAwMDAwIG4gCjAwMDAwMDE2NjggMDAwMDAgbiAKMDAwMDAwMTcyMiAwMDAwMCBuIAowMDAwMDAyMTU4IDAwMDAwIG4gCjAwMDAwMDIyMTIgMDAwMDAgbiAKMDAwMDAwMjMxNSAwMDAwMCBuIAowMDAwMDAzMDgxIDAwMDAwIG4gCjAwMDAwMDQyNzYgMDAwMDAgbiAKMDAwMDAwNDUzMyAwMDAwMCBuIAowMDAwMDA1MDA1IDAwMDAwIG4gCjAwMDAwMDU0ODcgMDAwMDAgbiAKMDAwMDAwNTk2MyAwMDAwMCBuIAowMDAwMDA2NDI1IDAwMDAwIG4gCjAwMDAwMDY4ODggMDAwMDAgbiAKMDAwMDAwNzM1NSAwMDAwMCBuIAowMDAwMDA3ODI4IDAwMDAwIG4gCjAwMDAwMDgyOTUgMDAwMDAgbiAKMDAwMDAwODc2MiAwMDAwMCBuIAowMDAwMDA5MjIxIDAwMDAwIG4gCjAwMDAwMDk2ODAgMDAwMDAgbiAKMDAwMDAxMDE0MyAwMDAwMCBuIAowMDAwMDEwNjA2IDAwMDAwIG4gCjAwMDAwMTEwNzEgMDAwMDAgbiAKMDAwMDAxMTUzMCAwMDAwMCBuIAowMDAwMDExOTg5IDAwMDAwIG4gCjAwMDAwMTI0NTIgMDAwMDAgbiAKMDAwMDAxMjkxNSAwMDAwMCBuIAowMDAwMDEzMzgwIDAwMDAwIG4gCjAwMDAwMTM0MjIgMDAwMDAgbiAKMDAwMDAxMzUwMyAwMDAwMCBuIAowMDAwMDEzNTUyIDAwMDAwIG4gCjAwMDAwMTQwOTAgMDAwMDAgbiAKMDAwMDAxNDEzOSAwMDAwMCBuIAowMDAwMDE0NDkwIDAwMDAwIG4gCjAwMDAwMTQ1MzkgMDAwMDAgbiAKMDAwMDAxNTAyMSAwMDAwMCBuIAowMDAwMDE1MDU1IDAwMDAwIG4gCjAwMDAwMTYyMjggMDAwMDAgbiAKMDAwMDAxNjMwNCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDQ0Ci9Sb290IDIgMCBSCi9JbmZvIDEgMCBSCi9JRCBbPDU3MTBENjJBQjIxNjM3OTkxMjIyMEU0RTg2NzFEQThFPjw1NzEwRDYyQUIyMTYzNzk5MTIyMjBFNEU4NjcxREE4RT5dCj4+CnN0YXJ0eHJlZgoxNjUwOQolJUVPRg==\",\n        \"documentType\": \"pdf\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"9f86e770-d638-4b15-bc19-cc85bbbf2ee7","name":"Vendor Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"branchNumber\":\"99\",\r\n    \"VendorCode\": \"v1\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"3\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddInstantCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 948,\r\n        \"checkNumber\": 4008,\r\n        \"document\": \"JVBERi0xLjcKJdDExrTOxdSghIKAgAoxIDAgb2JqCjw8DQovQ3JlYXRvciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9Qcm9kdWNlciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9DcmVhdGlvbkRhdGUgKEQ6MjAxODA0MDYwOTAzNTktMDcnMDAnKQovTW9kRGF0ZSAoRDoyMDE4MDQwNjA5MDM1OS0wNycwMCcpCj4+CmVuZG9iagoyIDAgb2JqCjw8DQovQWNyb0Zvcm0gNDAgMCBSCi9OYW1lcyAzMiAwIFIKL0V4dGVuc2lvbnMgPDwNCi9BREJFIDw8DQovRXh0ZW5zaW9uTGV2ZWwgMwovQmFzZVZlcnNpb24gLzEuNwo+Pgo+PgovUGFnZXMgMyAwIFIKL01ldGFkYXRhIDQxIDAgUgovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiAvMS43Ci9PdXRsaW5lcyA0MiAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwNCi9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwo+PgplbmRvYmoKNCAwIG9iago8PA0KL0NvbnRlbnRzIFs1IDAgUiA2IDAgUiA3IDAgUiA4IDAgUiA5IDAgUiAxMCAwIFIgXQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL1QxXzAgMTEgMCBSCj4+Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IF0KL1hPYmplY3QgPDwNCi9CRTQzQzJGNy0xQjFGLTQyQjktOUZCMi1GRDVFMjM3REQ4NTIgMTMgMCBSCi9GMUVCQTZBOC0wQUExLTRDMTEtOUY1OS1DMEI4RERDMjdCMDIgMTQgMCBSCi9GQkNCQjRCQS02OEUxLTQzRDItQTU5Ri01NEEzNTExRDRGNDEgMTUgMCBSCi9GMTE2QTRGRS0zOEEzLTQwNkEtQUE0NC0yQUNEOTlDNjZDRjkgMTYgMCBSCi9EODY4QTUzNC1GQ0M1LTRGQzktOUFBMS1FMEMzOUMxRjEzRDAgMTcgMCBSCi8yQjQzNDRCMC0zNTk0LTRFNDgtODA5Ri02MzhDOTBFOERCQTcgMTggMCBSCi8xNEIzRjc1Qy02QjA2LTRCNUItQkFBNi1DQzYyMzI5ODU4QkMgMTkgMCBSCi9ENURCODFGNS1FMjUyLTQ3RTUtOUI0Ri00Mzg2MTI0NzM4Q0UgMjAgMCBSCi8zQjFDNzk2Ny00MDUzLTRDMDQtOTI1Qy0zRjY5NUE5MDU0NUEgMjEgMCBSCi83MUE4RTI1OC1BNDJFLTQwQTQtQUJGQi1GNjM2QTA4QTUyNTQgMjIgMCBSCi9FMUIwNTRDNi03QzY5LTQ3ODMtQTQ1Mi0xRUZEMDRFMjA3OTEgMjMgMCBSCi9FNjU2OEUzNi01MzYwLTRFNzQtQjQ1OS0wNEUzRTI2QUQ5QkMgMjQgMCBSCi9EOTZEMzZDNy00MTI5LTRENzEtQUUyRS1EQUNBNDdCMjZEOUEgMjUgMCBSCi8zMjlGN0NBRS01QTYyLTQ1MjgtQUFFNy1CRjg5NDgxOTdDMjUgMjYgMCBSCi85RjFDMzRBMy02RTJELTRBNEItOUJCQy02MEI5MUFGMjlFRDIgMjcgMCBSCi8xOUFBNDM1OS02NzMxLTQ4MkUtQTBERS03MjJGN0U4OTJFQUIgMjggMCBSCi84MTNERDRGRS02RTkzLTRGNjctOUZDMy0wMkY1MEY1RTBFMzkgMjkgMCBSCi9BRkQzQUIxMy05RTQ4LTQ2NDgtOEYwNC1DRURDQTc0M0IzNTMgMzAgMCBSCi8wOUIxMzIzQi0wQjNCLTRFMkYtQkZFNS1CQzU1OUMyMTE4NzQgMzEgMCBSCj4+Cj4+Ci9Bbm5vdHMgW10KL01lZGlhQm94IFswIDAgNjEyIDc5MiBdCi9Dcm9wQm94IFswIDAgNjEyIDc5MiBdCi9Sb3RhdGUgMAovVHlwZSAvUGFnZQovUGFyZW50IDMgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8DQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDMxCj4+CnN0cmVhbQp4nFMo5DJUMABCEGluaaSQnAsV0IVQQH4gFwCHXwcOCmVuZHN0cmVhbQplbmRvYmoKNiAwIG9iago8PA0KL0xlbmd0aCA0Cj4+CnN0cmVhbQogcSAKCmVuZHN0cmVhbQplbmRvYmoKNyAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAzNjMKPj4Kc3RyZWFtCkiJpJLBT8IwGMXv/Su+RA5IQmm7zq7exBmjN7HhanBUrdlYLBv++3YIDLeCE7PD2rTv+723vbFCBKrHvqLRRKezwqz0dZ7m1mS6sCYBa9BI0ScCFNQLot+33YtLiTlcCIkFqAz1e4PBuXpHQx5hymFIIxxyUHPUj/Us1XY01Yt5bi+rOwSGLMQMVOw9dXoGLMBcROsB07xM3rSFs+r0Zmt4cusWBogz8QkM7gF9OItrc0CdNSqAixDLKIAkW2syxKnbu1WKHtEDGitE3QR/PMrEZobAxM2oIt4tVrlJ9J4R84O6kzSwgcA0lN24LAgPcuNZof3oWtVAh1XijuiABy10bJbPpV3qTC+KI/xa2uBHBIesI9/974PRr7K8dA56fnytbOBFgEXXL78pDXPV3NLbzTOemjHX1f/WbJ/asWYt7Ck183F/r1kLfUrN9tFxeQxbK5qJJSbyj+3yJe7Wrha+0a4vAQYAQD0mSwplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwNCi9MZW5ndGggNAo+PgpzdHJlYW0KIFEgCgplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwNCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMzEKPj4Kc3RyZWFtCnicUyjkMlQwAEIQaW5ppJCcCxXQhVBAfiAXAIdfBw4KZW5kc3RyZWFtCmVuZG9iagoxMCAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA2OTIKPj4Kc3RyZWFtCnicjZQ7riNHDEVzraI3wHbxW8WwvrkjL2AwoW3Y+w/Mlsav1W/eQIKAVnJxT5GX5PbPzXgzKjttmHVPVDaUXbZ/v29/bH/dcEvxw+1D9O3P229tCndaGbDhAqHm4KsRrKGTOI9RlLbx9237/fbDH3kvL/3vosN/4WzVaoFUK4J0xPBXh55aGaNTbunZX/fCulmx+z857swb0vH9TLlK76zWW5NWwcoMFg+Cqr5ApbIiDlmCJ0vDtsRTs+3pMPKA6NesT9JHXWhV1gQulUGSVahVBKj24d7N+vKTxRkfr/3hUHg3/Jr1WXrARrFSlQVW7wqyeoR0tHOmzt5xIY90DUlot5ch3UWHPzVhkZaA1QVkSoGSonHGpXuaZbSaL/7qKSwp5V95PwSHN0rjlbWDtWQgTRu0Wg16N2LyoqX107vIboybFI+nEUX85l8yLsJ7j3S0gkthkhJIngreJEaaiyFJjlLmT5yY8Pc4D+HB4YY9u+XIXCP4ngScojxe5lo9qWg9OVg2UT6ySLKXQl8yPkSHf8ZaooQCVWgGpArUthosY6spxoBUnvzJ3gF8qA7CxBav7Aa5m0enCgcreoZzjSQzUvWnNSGWNwin6k4wjRVkA2VLMU9ZoEksfbjzJKvDnzNnoTcIp+qetttg65ECUtQwMkKd0a9Re5XcyIY/pSCa3iCcqnvO5Cv3OkGrxTwpRSJ1ZmiruBT03EkvOVPC1zk/RIe/L+wchwls0gCp0mJeW6xJao51kc9B15zfAHyo7psXN0Jio8Eyxzks0Z6axoRMce9ncZq1XXN+TThVB6HE4RnHEbTpsQsrtsJXZ0i0NC2dabJfc35NOFUHoa7BtSGDH0dJ7LhMK1auz9FrFm6sfM35NeFUHYTkYU/cILX4xPiviDiOR+uq3gmx5P/37T9cU4W+CmVuZHN0cmVhbQplbmRvYmoKMTEgMCBvYmoKPDwNCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9TdWJ0eXBlIC9UeXBlMQovRm9udERlc2NyaXB0b3IgMTIgMCBSCi9UeXBlIC9Gb250Ci9CYXNlRm9udCAvTXlyaWFkUHJvLVJlZ3VsYXIKL1dpZHRocyBbNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCAyMTIgMjMwIDMzNyA0OTcgNTEzIDc5MiA2MDUgMTg4IDI4NCAyODQgNDE1IDU5NiAyMDcgMzA3IDIwNyAzNDMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDIwNyAyMDcgNTk2IDU5NiA1OTYgNDA2IDczNyA2MTIgNTQyIDU4MCA2NjYgNDkyIDQ4NyA2NDYgNjUyIDIzOSAzNzAgNTQyIDQ3MiA4MDQgNjU4IDY4OSA1MzIgNjg5IDUzOCA0OTMgNDk3IDY0NyA1NTggODQ2IDU3MSA1NDEgNTUzIDI4NCAzNDEgMjg0IDU5NiA1MDAgMzAwIDQ4MiA1NjkgNDQ4IDU2NCA1MDEgMjkyIDU1OSA1NTUgMjM0IDI0MyA0NjkgMjM2IDgzNCA1NTUgNTQ5IDU2OSA1NjMgMzI3IDM5NiAzMzEgNTUxIDQ4MSA3MzYgNDYzIDQ3MSA0MjggMjg0IDIzOSAyODQgNTk2IDI4MiA1MTMgMjgyIDIwNyA1MTMgMzU2IDEwMDAgNTAwIDUwMCAzMDAgMTE1NiA0OTMgMjU1IDg5NCAyODIgNTUzIDI4MiAyODIgMjA3IDIwNyAzNTQgMzU0IDI4MiA1MDAgMTAwMCAzMDAgNjE5IDM5NiAyNTUgODYzIDI4MiA0MjggNTQxIDIxMiAyMzAgNTEzIDUxMyA1MTMgNTEzIDIzOSA1MTkgMzAwIDY3NyAzNDYgNDE5IDU5NiAzMDcgNDE5IDMwMCAzMTggNTk2IDMxMSAzMDUgMzAwIDU1MyA1MTIgMjA3IDMwMCAyNDQgMzU1IDQxOSA3NTkgNzU5IDc1OSA0MDYgNjEyIDYxMiA2MTIgNjEyIDYxMiA2MTIgNzg4IDU4NSA0OTIgNDkyIDQ5MiA0OTIgMjM5IDIzOSAyMzkgMjM5IDY3MSA2NTggNjg5IDY4OSA2ODkgNjg5IDY4OSA1OTYgNjg5IDY0NyA2NDcgNjQ3IDY0NyA1NDEgNTMxIDU0OCA0ODIgNDgyIDQ4MiA0ODIgNDgyIDQ4MiA3NzMgNDQ3IDUwMSA1MDEgNTAxIDUwMSAyMzQgMjM0IDIzNCAyMzQgNTQxIDU1NSA1NDkgNTQ5IDU0OSA1NDkgNTQ5IDU5NiA1NDkgNTUxIDU1MSA1NTEgNTUxIDQ3MSA1NjkgNDcxIF0KL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciAyNTUKPj4KZW5kb2JqCjEyIDAgb2JqCjw8DQovRm9udFdlaWdodCA0MDAKL1hIZWlnaHQgNDg0Ci9EZXNjZW50IC0yNTAKL0ZvbnROYW1lIC9NeXJpYWRQcm8tUmVndWxhcgovQXNjZW50IDk1MgovQ2FwSGVpZ2h0IDY3NAovRm9udEJCb3ggWy0xNTcgLTI1MCAxMTI2IDk1MiBdCi9Gb250RmFtaWx5IChNeXJpYWQgUHJvKQovRmxhZ3MgMzIKL0ZvbnRTdHJldGNoIC9Ob3JtYWwKL1N0ZW1WIDg4Ci9JdGFsaWNBbmdsZSAwCi9UeXBlIC9Gb250RGVzY3JpcHRvcgo+PgplbmRvYmoKMTMgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0QzOUIzRTc3NTFGMjQyQTQ5NjQ4RkY3OTBENUIzMzM5Ci9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9EMzlCM0U3NzUxRjI0MkE0OTY0OEZGNzkwRDVCMzMzOSkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyMQo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pqmYuVJ0KYhccA40tkpVSBXt25tFt+8sRyi8wW7WRkqfPf5tK1PllB8GnHBHoR/W7Ra1omjndAndIT1Wx9i/xpBohXrOl54o6Yx31A4L8dZxH6cpjtyFZ3yHeUm9olE0efUFqyAf8gplbmRzdHJlYW0KZW5kb2JqCjE0IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV85NEVBODg4MTJDMDY0QTY4ODQyNzU3NTczNkFBQUMxRAovQkJveCBbMCAwIDE3NS4wMjggMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fOTRFQTg4ODEyQzA2NEE2ODg0Mjc1NzU3MzZBQUFDMUQpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMzEKPj4Kc3RyZWFtCnicPcw9C8IwFEbh/f6Kd1SwaT6qxrXSQbAicrFzoLFV2gaCRf33ZtHtOcuRkBhJbddCaps8/K0KUaSUP/TU0EQ5v1HWeyqZ8voT7649x5BdfDcPLkJJ8C1dOpCGEdaAW1qc/AtXH8PkxjA/+xUOR5iN2elMaWOX4AdVTFW6fgEvWSKVCmVuZHN0cmVhbQplbmRvYmoKMTUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0RFRkQxMDFCNzgwNzQwRUE5RDhBNENBQTQzNjEwNzQ4Ci9CQm94IFswIDAgMjkxLjMzIDEyLjMzIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9ERUZEMTAxQjc4MDc0MEVBOUQ4QTRDQUE0MzYxMDc0OCkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyNQo+PgpzdHJlYW0KeJw9zLEKwjAUheH9PMUZdUibplboWi24FEQudC4ktkps4UpB39446HL4hsNvafmAq4usLBPjj4X7boT9a0KPGbm82HQHNIK8e+tt8GddzCWMaxyUNeWaKiPhWGVuv6N4bGTSEHhaZ6/B87jEdH2SNGZLuaMVtKn4Aa0SIj4KZW5kc3RyZWFtCmVuZG9iagoxNiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fOTc0NEIwNUNBNTkwNDdGNzlEMjQ3RDIxMDE0ODFBNkMKL0JCb3ggWzAgMCA2OS4zMzUgMTIuMzMgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzk3NDRCMDVDQTU5MDQ3Rjc5RDI0N0QyMTAxNDgxQTZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTExCj4+CnN0cmVhbQp4nD3MvQqDQBAE4H6eYkotcq53qNgaLAUJC6kFfxIxCRwEkrd3G63mm2JGKHyhrF0IhXE7mHsLq3LqgTveyPTHpruiUWTdPz6HsY+fy21avtsQmQt1tpuF8PSuqgvqiCSIOJGUuqJVtDbfASxgGxAKZW5kc3RyZWFtCmVuZG9iagoxNyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUKL0JCb3ggWzAgMCA4My42MSAxMi4zMyBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTMKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7Vwd2YWdW0jKQMiA9aBaIxEhQVB/94txO7c5gqFd+QUNlo1/6QWUqolf11xwgPR32y6PRpH7D5l6odDea6O5/E194Uq9Eu9jITRwna3pg9YSI6ao4npkn5D62jr4gtlxRtzCmVuZHN0cmVhbQplbmRvYmoKMTggMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0U5OTkwQTg1ODE1RTQ4MjFCMkY1MjQwRTAxOUFBQkNGCi9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9FOTk5MEE4NTgxNUU0ODIxQjJGNTI0MEUwMTlBQUJDRikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pq20c6WbAZELnQONtRIrhBb07c2i23eWIxQ+YZujkbLNjn/b2tQ55Yc7Biwo9M3OndApCvdJsx8v6XW4hmmLPtEK9ZYvE1GyMm1FHbFzftlC5Hle1xj21Ad6RZ8nX/uzHqAKZW5kc3RyZWFtCmVuZG9iagoxOSAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMKL0JCb3ggWzAgMCAyMDcgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjYKPj4Kc3RyZWFtCnicNcw9C4MwFEbh/f6Kd2wH9foB7arBoYNQyoXOwaTaViPECO2/byg4nTM9DMZMBZ9ip3/zKq3i8j4j3clRJh80naJGKOu+/qnN1S/JzQ7bpD1yhjyiMIAKlOm5hBg61Mbg4tagXYAabf9GArWtYZmtP0Je1Aq10fwBICch3wplbmRzdHJlYW0KZW5kb2JqCjIwIDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV80MTM3MkVCNDA1QzY0OTNDOEM0NjU3RThDOTkxRDdDNQovQkJveCBbMCAwIDIyMS4zNjkgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNDEzNzJFQjQwNUM2NDkzQzhDNDY1N0U4Qzk5MUQ3QzUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTYKPj4Kc3RyZWFtCnicPcw9C8IwGEXh/f6KO+pgmo8ida10MyDyQudAY1uJFUIL+u/NottzlqOp+YS1RrnjqTj9bWpVl9Q/TOixoJI3W39GK6j8J89huObX4RbHLYVMoyn3chkJS6caRxmw82HZYuJlXtcU95QHOkFXJl/7gR6gCmVuZHN0cmVhbQplbmRvYmoKMjEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzFDRTU1MTZCRkJERDQxRjVBOEVFNDJCRTlGOENFMTY3Ci9CQm94IFswIDAgMjIxLjM2OSAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8xQ0U1NTE2QkZCREQ0MUY1QThFRTQyQkU5RjhDRTE2NykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zD0LwjAYReH9/oo76mCajyJ1rXQzIPJC50BjW4kVQgv6782i23OWo6n5hLVGueOpOP1talWX1D9M6LGgkjdbf0YrqPwnz2G45tfhFscthUyjKfdyGQlLpxpHGbDzYdli4mVe1xT3lAc6QVcmX/uBHqAKZW5kc3RyZWFtCmVuZG9iagoyMiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMjU4MTk5NkJCMEI2NEYzNEFEMTcxOUE5MkNGMkEwNkMKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzI1ODE5OTZCQjBCNjRGMzRBRDE3MTlBOTJDRjJBMDZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MsQqDQBRE0X6+Ykotsr7VLdbWYCmIPLAWNEYxCgtC8vfZRrszxR2h8AMrznifR2+3rTMuTrnwRo8dmX5ZNU9Uiqz5hWUY23A8umk+tyHQCvUVX2YiZ2F8QR2RlM6n1BW1oo7pH8BbGlUKZW5kc3RyZWFtCmVuZG9iagoyMyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fQ0IzQUZGRUMwODk1NENCRDg3QjU1Njk5NTdFM0FGOUEKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtX0NCM0FGRkVDMDg5NTRDQkQ4N0I1NTY5OTU3RTNBRjlBKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MuwqDQBSE4X6eYsqkcD17KbZWLIUQDlgL3tEEFgLJ27uN6b4p/hEKD1gJJkaXvf9tgwl5yoUFHV4o9cuqrVEpyvaX1n54pHfxHOfP3idaoU75ZSYcvYmeOuBmnQ936oZG0eT2BNndGnoKZW5kc3RyZWFtCmVuZG9iagoyNCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fNkQ0RURDOEQ2NEM4NDcxQ0EzMTY5ODA4MEVFQjBGOUUKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzZENEVEQzhENjRDODQ3MUNBMzE2OTgwODBFRUIwRjlFKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQqDMBRG4f1/in9sB5N7Y4bMiqNQyoXOgta2aAuBgr69WdrtO8sRCleoRJdSKF7+1uhiSfnhgRve8Lax6Vs0Bt/v+TmMl/yprtP8XYZMFdq9XGYisHappo04SfIqPkjQM+2FztCVwwF63RucCmVuZHN0cmVhbQplbmRvYmoKMjUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzM4OTdDOEM1MDg5NTQ0NUM4NjlGODFCQjJEODcyMzczCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8zODk3QzhDNTA4OTU0NDVDODY5RjgxQkIyRDg3MjM3MykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExMgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1KHJvUmGzJWOBZELnQvVqrQKAUHfvlnq9p3lCIUrVJLLOVQvf2tyqabsuGPAC96+bPsTWoPvf+UxTufybi7X+bOMhSq0W73MRGB0OdImHCT7qD5I0CPtic7Q1cMGexUbnwplbmRzdHJlYW0KZW5kb2JqCjI2IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8wRkQ4Nzc3QzczQTQ0REVGQUVEN0FGMzdBQ0IzNEIyQwovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMEZEODc3N0M3M0E0NERFRkFFRDdBRjM3QUNCMzRCMkMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTQKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7XIZDa7xq0jKQMhDFgHEqMSFRYE/Xu3Md25zVUqH3AaJMYqe93sgoSc+scVZzxR2odNd0JjKLtvuo1Tn17FMC/vdUx0Srvky0IcD+Lqil6ip03YeVVR3dPuaA1tXvwAlzEb0gplbmRzdHJlYW0KZW5kb2JqCjI3IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV9FQjkwMkY1MEU5QkM0RDM5QUVFNzg5MkNGMjVBMzVDQQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUI5MDJGNTBFOUJDNEQzOUFFRTc4OTJDRjI1QTM1Q0EpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcyxCoNAFETRfr5iSi2yvtUt1tZgKYg8sBY0RjEKC0Ly99lGuzPFHaHwAyvOeJ9Hb7etMy5OufBGjx2Zflk1T1SKrPmFZRjbcDy6aT63IdAK9RVfZiJnYXxBHZGUzqfUFbWijukfwFsaVQplbmRzdHJlYW0KZW5kb2JqCjI4IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8xREUyOTk1RDYxODI0MUI3ODdGMjFGOURBODNENDY4OQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMURFMjk5NUQ2MTgyNDFCNzg3RjIxRjlEQTgzRDQ2ODkpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcy7CoNAFIThfp5iyqRwPXsptlYshRAOWAve0QQWAsnbu43pvin+EQoPWAkmRpe9/22DCXnKhQUdXij1y6qtUSnK9pfWfnikd/Ec58/eJ1qhTvllJhy9iZ464GadD3fqhkbR5PYE2d0aegplbmRzdHJlYW0KZW5kb2JqCjI5IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV81QThDOTFGREE2REQ0NDUyQTlGRUZGREQ0QkU2QzY3RgovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNUE4QzkxRkRBNkRENDQ1MkE5RkVGRkRENEJFNkM2N0YpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTIKPj4Kc3RyZWFtCnicPcyxCoMwFEbh/X+Kf2wHk3tjhsyKo1DKhc6C1rZoC4GCvr1Z2u07yxEKV6hEl1IoXv7W6GJJ+eGBG97wtrHpWzQG3+/5OYyX/Kmu0/xdhkwV2r1cZiKwdqmmjThJ8io+SNAz7YXO0JXDAXrdG5wKZW5kc3RyZWFtCmVuZG9iagozMCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMzJBNTAyRDMxNjY1NDgzMjhDODZBRDQxOERBOTU1OEQKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzMyQTUwMkQzMTY2NTQ4MzI4Qzg2QUQ0MThEQTk1NThEKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQrCMBRG4f1/in/Uocm9SYbMlY4FkQudC9WqtAoBQd++Wer2neUIhStUkss5VC9/a3Kppuy4Y8AL3r5s+xNag+9/5TFO5/JuLtf5s4yFKrRbvcxEYHQ50iYcJPuoPkjQI+2JztDVwwZ7FRufCmVuZHN0cmVhbQplbmRvYmoKMzEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzc2QkRCNTMxMzBBQTREQzQ5RjNDRUQzNTdGRjYyMzEyCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV83NkJEQjUzMTMwQUE0REM0OUYzQ0VEMzU3RkY2MjMxMikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNAo+PgpzdHJlYW0KeJw9zLEKwkAQRdH+fcUrtchkNrvGrSMpAyEMWAcSoxIVFgT9e7cx3bnNVSofcBokxip73eyChJz6xxVnPFHah013QmMou2+6jVOfXsUwL+91THRKu+TLQhwP4uqKXqKnTdh5VVHd0+5oDW1e/ACXMRvSCmVuZHN0cmVhbQplbmRvYmoKMzIgMCBvYmoKPDwNCi9KYXZhU2NyaXB0IDMzIDAgUgo+PgplbmRvYmoKMzMgMCBvYmoKPDwNCi9OYW1lcyBbKDAwMDAwMCkgMzQgMCBSICgwMDAwMDIpIDM2IDAgUiAoMDAwMDA0KSAzOCAwIFIgXQo+PgplbmRvYmoKMzQgMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzNSAwIFIKPj4KZW5kb2JqCjM1IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQ2MQo+PgpzdHJlYW0KSInUlMFu2zAMhu99CiKnBAj8AkMO3tIWxbqk6JruaMgWnXCVRU9iYvjtR9ldgwbGsB4HGIYh/aQ+/qRFNcylb5HruRwoZvn68/UCViuYHb3Fmjza2eIKAN52YQUeO9iWP7GS+eLTVVrM7vPN7S6/Tbuz681u9rr8TNhhKKIE8vviicRhUuSWS4S8ClwamdbuWmsEizXG6hxx5wWDqYROCDccmgij7E+KRzT2nGKDaPXVFc8YIrEvvsV9yvWkpcDD+gZqUpyAv44UMIJJdWGA06gGrmE8dcyawYOqImy/gjBY7rxjY9UXBKcIUc6BASIi9HzUjz4KNmBsQ56UywiHbLriKdxi6+w75L/Sjn5m8IXbfmgY7B7vwXgLrVEMIK/kA1YZuIsafYE6cn6A772d2pF/sPMN8wfJgY9yqVwOng7JGtODpdg60y+hVGla8CzQcXiBNnCLwfUZfOfmNQIdNuglQkP7gwxaPfJEkUrttdHDnFODHFUvqZMaAw2HZE0KNzKQ6lOK0Yb5/WR/LwbjA+0cxzX8p7bd1TpMaYoweBSo2Hu9AxKllmJOhpxR+RKqZG8yTx3uyLnz35JmkXwUTTfhbHLytwADANKtmaYKZW5kc3RyZWFtCmVuZG9iagozNiAwIG9iago8PA0KL1MgL0phdmFTY3JpcHQKL0pTIDM3IDAgUgo+PgplbmRvYmoKMzcgMCBvYmoKPDwNCi9GaWx0ZXIgWy9GbGF0ZURlY29kZSBdCi9MZW5ndGggMjc0Cj4+CnN0cmVhbQpIidySUUvDMBSF3/srLnkYK0Liq9YikykIUmHTgk/lrrmtwawJbbohzv9uW9xkXQt79jH3fDnccxKVwdR9WjLZdDa/u+cLQkllEqOuKZlVHyR9CENgdSEpUwVJ5nsAMMJCCBnqigJP9XxjRdtzfU/Zcd/fHSIimcRUVsoUfWPY7WCMhRu44pe+99UPdQSFLRQM545ou+eS18VTw7J35+y1EGmuOEqzIp6atagspQq1wLQ0K3SithIdsT/X5dvyMXp4bg1ubcjgAtBabjW6zJTr5sgmm8N401W036/V9EHTWOQ15tSN096Vl6a7Tig7YSxy4H2PPeFZVQ+wp1UPQb2qj77CP6h6IHJb9Y8AAwCXJB2JCmVuZHN0cmVhbQplbmRvYmoKMzggMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzOSAwIFIKPj4KZW5kb2JqCjM5IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQwNQo+PgpzdHJlYW0KSInUU11PwjAUfYZfcd0Ti2QRX1SUBxRJTBSUr+jT0tC70VjKsnagAf67XRmw6UAMTy5L06bnnnvPPbfMg5L6DHDilT484jIhFeEcqQ21GliRoOgxgdSCxQJSuCmGkk1EHip1DTdw7lzaxXkRAJjORILAmTKcYdjTXCa4g4RiaNkxxOASaL1xe++sLt0B4RG6dfmOFE5qoMII7QS6DvmRYLAp4co5s7eoVEAqhnAMVSanVCETvttCpHqZuQmf+yT9MlT0b7RX7Ayd/tSIScdH1e885mhIM2kEnILBdN+6D61muwwe4RLt6wzprk6sGpHCLrdb1DR54gamN/vEuf2AEoXhbpExpbab3k3GwUSgUKX5MLazaj3zyGfCKsOwRcb6/NqsxwfNXrX0IFjLjTJTqlniSnO9T0o9zvuLjPdJ8SFKXbhEXfdLhFJpaBUObU+bUy2pgR6JuMqGHWbxsMcUx9yE5iZuUqHw3cMjh/p3YXuHOmbjJBLD0Was/6TZuPY/J3X9AHPGMfsAk5FeFr8EGAC5qJCpCmVuZHN0cmVhbQplbmRvYmoKNDAgMCBvYmoKPDwNCi9GaWVsZHMgW10KPj4KZW5kb2JqCjQxIDAgb2JqCjw8DQovVHlwZSAvTWV0YWRhdGEKL1N1YnR5cGUgL1hNTAovTGVuZ3RoIDEwODkKPj4Kc3RyZWFtCjw/eHBhY2tldCBiZWdpbj0iIiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA0LjIuMS1jMDQxIj4NCjxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyIgPg0KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj4NCiAgPGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD4NCiAgPGRjOnRpdGxlPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzp0aXRsZT4NCiAgPGRjOmRlc2NyaXB0aW9uPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzpkZXNjcmlwdGlvbj4NCiAgPGRjOmNyZWF0b3I+DQogICAgPHJkZjpTZXE+DQogICAgICA8cmRmOmxpIC8+DQogICAgPC9yZGY6U2VxPg0KICA8L2RjOmNyZWF0b3I+DQo8L3JkZjpEZXNjcmlwdGlvbj4NCjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnBkZj0iaHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyI+DQogIDxwZGY6S2V5d29yZHMgLz4NCiAgPHBkZjpQcm9kdWNlcj5BZG9iZSBMaXZlQ3ljbGUgRGVzaWduZXIgMTEuMDwvcGRmOlByb2R1Y2VyPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iPg0KICA8eG1wOkNyZWF0b3JUb29sPkFkb2JlIExpdmVDeWNsZSBEZXNpZ25lciAxMS4wPC94bXA6Q3JlYXRvclRvb2w+DQogIDx4bXA6Q3JlYXRlRGF0ZT4yMDE4LTA0LTA2VDE2OjAzOjU5KzAwOjAwPC94bXA6Q3JlYXRlRGF0ZT4NCiAgPHhtcDpNb2RpZnlEYXRlPjIwMTgtMDQtMDZUMTY6MDM6NTkrMDA6MDA8L3htcDpNb2RpZnlEYXRlPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8L3JkZjpSREY+DQo8L3g6eG1wbWV0YT4NCjw/eHBhY2tldCBlbmQ9InciPz4NCgplbmRzdHJlYW0KZW5kb2JqCjQyIDAgb2JqCjw8DQovVHlwZSAvT3V0bGluZXMKL0NvdW50IC0xCi9GaXJzdCA0MyAwIFIKL0xhc3QgNDMgMCBSCj4+CmVuZG9iago0MyAwIG9iago8PA0KL0NvdW50IDAKL1RpdGxlIChDaGVja180MDA4IC0gTmV3RG9jUDEgLSBBUENoZWNrc18wMDAwMDAwMCswMDAwKzAwMDArMDAwMCswMDAwMDAwMDAwMDBfQVBETFQxMTEpCi9DIFswIDAgMCBdCi9GIDIKL0EgPDwNCi9OZXh0IFtdCi9TIC9Hb1RvCi9EIFs0IDAgUiAvWFlaIDAgNzkyIDEgXQo+PgovUGFyZW50IDQyIDAgUgo+PgplbmRvYmoKeHJlZgowIDQ0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAyMyAwMDAwMCBuIAowMDAwMDAwMjAzIDAwMDAwIG4gCjAwMDAwMDA0MDAgMDAwMDAgbiAKMDAwMDAwMDQ1OSAwMDAwMCBuIAowMDAwMDAxNTY1IDAwMDAwIG4gCjAwMDAwMDE2NjggMDAwMDAgbiAKMDAwMDAwMTcyMiAwMDAwMCBuIAowMDAwMDAyMTU4IDAwMDAwIG4gCjAwMDAwMDIyMTIgMDAwMDAgbiAKMDAwMDAwMjMxNSAwMDAwMCBuIAowMDAwMDAzMDgxIDAwMDAwIG4gCjAwMDAwMDQyNzYgMDAwMDAgbiAKMDAwMDAwNDUzMyAwMDAwMCBuIAowMDAwMDA1MDA1IDAwMDAwIG4gCjAwMDAwMDU0ODcgMDAwMDAgbiAKMDAwMDAwNTk2MyAwMDAwMCBuIAowMDAwMDA2NDI1IDAwMDAwIG4gCjAwMDAwMDY4ODggMDAwMDAgbiAKMDAwMDAwNzM1NSAwMDAwMCBuIAowMDAwMDA3ODI4IDAwMDAwIG4gCjAwMDAwMDgyOTUgMDAwMDAgbiAKMDAwMDAwODc2MiAwMDAwMCBuIAowMDAwMDA5MjIxIDAwMDAwIG4gCjAwMDAwMDk2ODAgMDAwMDAgbiAKMDAwMDAxMDE0MyAwMDAwMCBuIAowMDAwMDEwNjA2IDAwMDAwIG4gCjAwMDAwMTEwNzEgMDAwMDAgbiAKMDAwMDAxMTUzMCAwMDAwMCBuIAowMDAwMDExOTg5IDAwMDAwIG4gCjAwMDAwMTI0NTIgMDAwMDAgbiAKMDAwMDAxMjkxNSAwMDAwMCBuIAowMDAwMDEzMzgwIDAwMDAwIG4gCjAwMDAwMTM0MjIgMDAwMDAgbiAKMDAwMDAxMzUwMyAwMDAwMCBuIAowMDAwMDEzNTUyIDAwMDAwIG4gCjAwMDAwMTQwOTAgMDAwMDAgbiAKMDAwMDAxNDEzOSAwMDAwMCBuIAowMDAwMDE0NDkwIDAwMDAwIG4gCjAwMDAwMTQ1MzkgMDAwMDAgbiAKMDAwMDAxNTAyMSAwMDAwMCBuIAowMDAwMDE1MDU1IDAwMDAwIG4gCjAwMDAwMTYyMjggMDAwMDAgbiAKMDAwMDAxNjMwNCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDQ0Ci9Sb290IDIgMCBSCi9JbmZvIDEgMCBSCi9JRCBbPDU3MTBENjJBQjIxNjM3OTkxMjIyMEU0RTg2NzFEQThFPjw1NzEwRDYyQUIyMTYzNzk5MTIyMjBFNEU4NjcxREE4RT5dCj4+CnN0YXJ0eHJlZgoxNjUwOQolJUVPRg==\",\r\n        \"documentType\": \"pdf\"\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"496eada7-9061-4349-b73a-f05034c71592","name":"One Time Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"branchNumber\":\"99\",\r\n    \"payeeName\": \"My Name\",\r\n    \"phoneNumber\": \"9991234567\",\r\n    \"addressLine1\": \"2400 E Katella Ave\",\r\n    \"addressLine2\": \"Suite 550\",\r\n    \"addressLine3\": \"\",\r\n    \"city\": \"Anaheim\",\r\n    \"state\": \"CA\",\r\n    \"zipCode\" : \"92806\",\r\n    \"country\" : \"United States\",\r\n    //English = 1\r\n    //Spanish = 2\r\n    //French = 3\r\n    \"language\" : \"English\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddInstantCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 948,\r\n        \"checkNumber\": 4008,\r\n        \"document\": \"JVBERi0xLjcKJdDExrTOxdSghIKAgAoxIDAgb2JqCjw8DQovQ3JlYXRvciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9Qcm9kdWNlciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9DcmVhdGlvbkRhdGUgKEQ6MjAxODA0MDYwOTAzNTktMDcnMDAnKQovTW9kRGF0ZSAoRDoyMDE4MDQwNjA5MDM1OS0wNycwMCcpCj4+CmVuZG9iagoyIDAgb2JqCjw8DQovQWNyb0Zvcm0gNDAgMCBSCi9OYW1lcyAzMiAwIFIKL0V4dGVuc2lvbnMgPDwNCi9BREJFIDw8DQovRXh0ZW5zaW9uTGV2ZWwgMwovQmFzZVZlcnNpb24gLzEuNwo+Pgo+PgovUGFnZXMgMyAwIFIKL01ldGFkYXRhIDQxIDAgUgovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiAvMS43Ci9PdXRsaW5lcyA0MiAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwNCi9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwo+PgplbmRvYmoKNCAwIG9iago8PA0KL0NvbnRlbnRzIFs1IDAgUiA2IDAgUiA3IDAgUiA4IDAgUiA5IDAgUiAxMCAwIFIgXQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL1QxXzAgMTEgMCBSCj4+Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IF0KL1hPYmplY3QgPDwNCi9CRTQzQzJGNy0xQjFGLTQyQjktOUZCMi1GRDVFMjM3REQ4NTIgMTMgMCBSCi9GMUVCQTZBOC0wQUExLTRDMTEtOUY1OS1DMEI4RERDMjdCMDIgMTQgMCBSCi9GQkNCQjRCQS02OEUxLTQzRDItQTU5Ri01NEEzNTExRDRGNDEgMTUgMCBSCi9GMTE2QTRGRS0zOEEzLTQwNkEtQUE0NC0yQUNEOTlDNjZDRjkgMTYgMCBSCi9EODY4QTUzNC1GQ0M1LTRGQzktOUFBMS1FMEMzOUMxRjEzRDAgMTcgMCBSCi8yQjQzNDRCMC0zNTk0LTRFNDgtODA5Ri02MzhDOTBFOERCQTcgMTggMCBSCi8xNEIzRjc1Qy02QjA2LTRCNUItQkFBNi1DQzYyMzI5ODU4QkMgMTkgMCBSCi9ENURCODFGNS1FMjUyLTQ3RTUtOUI0Ri00Mzg2MTI0NzM4Q0UgMjAgMCBSCi8zQjFDNzk2Ny00MDUzLTRDMDQtOTI1Qy0zRjY5NUE5MDU0NUEgMjEgMCBSCi83MUE4RTI1OC1BNDJFLTQwQTQtQUJGQi1GNjM2QTA4QTUyNTQgMjIgMCBSCi9FMUIwNTRDNi03QzY5LTQ3ODMtQTQ1Mi0xRUZEMDRFMjA3OTEgMjMgMCBSCi9FNjU2OEUzNi01MzYwLTRFNzQtQjQ1OS0wNEUzRTI2QUQ5QkMgMjQgMCBSCi9EOTZEMzZDNy00MTI5LTRENzEtQUUyRS1EQUNBNDdCMjZEOUEgMjUgMCBSCi8zMjlGN0NBRS01QTYyLTQ1MjgtQUFFNy1CRjg5NDgxOTdDMjUgMjYgMCBSCi85RjFDMzRBMy02RTJELTRBNEItOUJCQy02MEI5MUFGMjlFRDIgMjcgMCBSCi8xOUFBNDM1OS02NzMxLTQ4MkUtQTBERS03MjJGN0U4OTJFQUIgMjggMCBSCi84MTNERDRGRS02RTkzLTRGNjctOUZDMy0wMkY1MEY1RTBFMzkgMjkgMCBSCi9BRkQzQUIxMy05RTQ4LTQ2NDgtOEYwNC1DRURDQTc0M0IzNTMgMzAgMCBSCi8wOUIxMzIzQi0wQjNCLTRFMkYtQkZFNS1CQzU1OUMyMTE4NzQgMzEgMCBSCj4+Cj4+Ci9Bbm5vdHMgW10KL01lZGlhQm94IFswIDAgNjEyIDc5MiBdCi9Dcm9wQm94IFswIDAgNjEyIDc5MiBdCi9Sb3RhdGUgMAovVHlwZSAvUGFnZQovUGFyZW50IDMgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8DQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDMxCj4+CnN0cmVhbQp4nFMo5DJUMABCEGluaaSQnAsV0IVQQH4gFwCHXwcOCmVuZHN0cmVhbQplbmRvYmoKNiAwIG9iago8PA0KL0xlbmd0aCA0Cj4+CnN0cmVhbQogcSAKCmVuZHN0cmVhbQplbmRvYmoKNyAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAzNjMKPj4Kc3RyZWFtCkiJpJLBT8IwGMXv/Su+RA5IQmm7zq7exBmjN7HhanBUrdlYLBv++3YIDLeCE7PD2rTv+723vbFCBKrHvqLRRKezwqz0dZ7m1mS6sCYBa9BI0ScCFNQLot+33YtLiTlcCIkFqAz1e4PBuXpHQx5hymFIIxxyUHPUj/Us1XY01Yt5bi+rOwSGLMQMVOw9dXoGLMBcROsB07xM3rSFs+r0Zmt4cusWBogz8QkM7gF9OItrc0CdNSqAixDLKIAkW2syxKnbu1WKHtEDGitE3QR/PMrEZobAxM2oIt4tVrlJ9J4R84O6kzSwgcA0lN24LAgPcuNZof3oWtVAh1XijuiABy10bJbPpV3qTC+KI/xa2uBHBIesI9/974PRr7K8dA56fnytbOBFgEXXL78pDXPV3NLbzTOemjHX1f/WbJ/asWYt7Ck183F/r1kLfUrN9tFxeQxbK5qJJSbyj+3yJe7Wrha+0a4vAQYAQD0mSwplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwNCi9MZW5ndGggNAo+PgpzdHJlYW0KIFEgCgplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwNCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMzEKPj4Kc3RyZWFtCnicUyjkMlQwAEIQaW5ppJCcCxXQhVBAfiAXAIdfBw4KZW5kc3RyZWFtCmVuZG9iagoxMCAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA2OTIKPj4Kc3RyZWFtCnicjZQ7riNHDEVzraI3wHbxW8WwvrkjL2AwoW3Y+w/Mlsav1W/eQIKAVnJxT5GX5PbPzXgzKjttmHVPVDaUXbZ/v29/bH/dcEvxw+1D9O3P229tCndaGbDhAqHm4KsRrKGTOI9RlLbx9237/fbDH3kvL/3vosN/4WzVaoFUK4J0xPBXh55aGaNTbunZX/fCulmx+z857swb0vH9TLlK76zWW5NWwcoMFg+Cqr5ApbIiDlmCJ0vDtsRTs+3pMPKA6NesT9JHXWhV1gQulUGSVahVBKj24d7N+vKTxRkfr/3hUHg3/Jr1WXrARrFSlQVW7wqyeoR0tHOmzt5xIY90DUlot5ch3UWHPzVhkZaA1QVkSoGSonHGpXuaZbSaL/7qKSwp5V95PwSHN0rjlbWDtWQgTRu0Wg16N2LyoqX107vIboybFI+nEUX85l8yLsJ7j3S0gkthkhJIngreJEaaiyFJjlLmT5yY8Pc4D+HB4YY9u+XIXCP4ngScojxe5lo9qWg9OVg2UT6ySLKXQl8yPkSHf8ZaooQCVWgGpArUthosY6spxoBUnvzJ3gF8qA7CxBav7Aa5m0enCgcreoZzjSQzUvWnNSGWNwin6k4wjRVkA2VLMU9ZoEksfbjzJKvDnzNnoTcIp+qetttg65ECUtQwMkKd0a9Re5XcyIY/pSCa3iCcqnvO5Cv3OkGrxTwpRSJ1ZmiruBT03EkvOVPC1zk/RIe/L+wchwls0gCp0mJeW6xJao51kc9B15zfAHyo7psXN0Jio8Eyxzks0Z6axoRMce9ncZq1XXN+TThVB6HE4RnHEbTpsQsrtsJXZ0i0NC2dabJfc35NOFUHoa7BtSGDH0dJ7LhMK1auz9FrFm6sfM35NeFUHYTkYU/cILX4xPiviDiOR+uq3gmx5P/37T9cU4W+CmVuZHN0cmVhbQplbmRvYmoKMTEgMCBvYmoKPDwNCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9TdWJ0eXBlIC9UeXBlMQovRm9udERlc2NyaXB0b3IgMTIgMCBSCi9UeXBlIC9Gb250Ci9CYXNlRm9udCAvTXlyaWFkUHJvLVJlZ3VsYXIKL1dpZHRocyBbNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCAyMTIgMjMwIDMzNyA0OTcgNTEzIDc5MiA2MDUgMTg4IDI4NCAyODQgNDE1IDU5NiAyMDcgMzA3IDIwNyAzNDMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDIwNyAyMDcgNTk2IDU5NiA1OTYgNDA2IDczNyA2MTIgNTQyIDU4MCA2NjYgNDkyIDQ4NyA2NDYgNjUyIDIzOSAzNzAgNTQyIDQ3MiA4MDQgNjU4IDY4OSA1MzIgNjg5IDUzOCA0OTMgNDk3IDY0NyA1NTggODQ2IDU3MSA1NDEgNTUzIDI4NCAzNDEgMjg0IDU5NiA1MDAgMzAwIDQ4MiA1NjkgNDQ4IDU2NCA1MDEgMjkyIDU1OSA1NTUgMjM0IDI0MyA0NjkgMjM2IDgzNCA1NTUgNTQ5IDU2OSA1NjMgMzI3IDM5NiAzMzEgNTUxIDQ4MSA3MzYgNDYzIDQ3MSA0MjggMjg0IDIzOSAyODQgNTk2IDI4MiA1MTMgMjgyIDIwNyA1MTMgMzU2IDEwMDAgNTAwIDUwMCAzMDAgMTE1NiA0OTMgMjU1IDg5NCAyODIgNTUzIDI4MiAyODIgMjA3IDIwNyAzNTQgMzU0IDI4MiA1MDAgMTAwMCAzMDAgNjE5IDM5NiAyNTUgODYzIDI4MiA0MjggNTQxIDIxMiAyMzAgNTEzIDUxMyA1MTMgNTEzIDIzOSA1MTkgMzAwIDY3NyAzNDYgNDE5IDU5NiAzMDcgNDE5IDMwMCAzMTggNTk2IDMxMSAzMDUgMzAwIDU1MyA1MTIgMjA3IDMwMCAyNDQgMzU1IDQxOSA3NTkgNzU5IDc1OSA0MDYgNjEyIDYxMiA2MTIgNjEyIDYxMiA2MTIgNzg4IDU4NSA0OTIgNDkyIDQ5MiA0OTIgMjM5IDIzOSAyMzkgMjM5IDY3MSA2NTggNjg5IDY4OSA2ODkgNjg5IDY4OSA1OTYgNjg5IDY0NyA2NDcgNjQ3IDY0NyA1NDEgNTMxIDU0OCA0ODIgNDgyIDQ4MiA0ODIgNDgyIDQ4MiA3NzMgNDQ3IDUwMSA1MDEgNTAxIDUwMSAyMzQgMjM0IDIzNCAyMzQgNTQxIDU1NSA1NDkgNTQ5IDU0OSA1NDkgNTQ5IDU5NiA1NDkgNTUxIDU1MSA1NTEgNTUxIDQ3MSA1NjkgNDcxIF0KL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciAyNTUKPj4KZW5kb2JqCjEyIDAgb2JqCjw8DQovRm9udFdlaWdodCA0MDAKL1hIZWlnaHQgNDg0Ci9EZXNjZW50IC0yNTAKL0ZvbnROYW1lIC9NeXJpYWRQcm8tUmVndWxhcgovQXNjZW50IDk1MgovQ2FwSGVpZ2h0IDY3NAovRm9udEJCb3ggWy0xNTcgLTI1MCAxMTI2IDk1MiBdCi9Gb250RmFtaWx5IChNeXJpYWQgUHJvKQovRmxhZ3MgMzIKL0ZvbnRTdHJldGNoIC9Ob3JtYWwKL1N0ZW1WIDg4Ci9JdGFsaWNBbmdsZSAwCi9UeXBlIC9Gb250RGVzY3JpcHRvcgo+PgplbmRvYmoKMTMgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0QzOUIzRTc3NTFGMjQyQTQ5NjQ4RkY3OTBENUIzMzM5Ci9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9EMzlCM0U3NzUxRjI0MkE0OTY0OEZGNzkwRDVCMzMzOSkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyMQo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pqmYuVJ0KYhccA40tkpVSBXt25tFt+8sRyi8wW7WRkqfPf5tK1PllB8GnHBHoR/W7Ra1omjndAndIT1Wx9i/xpBohXrOl54o6Yx31A4L8dZxH6cpjtyFZ3yHeUm9olE0efUFqyAf8gplbmRzdHJlYW0KZW5kb2JqCjE0IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV85NEVBODg4MTJDMDY0QTY4ODQyNzU3NTczNkFBQUMxRAovQkJveCBbMCAwIDE3NS4wMjggMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fOTRFQTg4ODEyQzA2NEE2ODg0Mjc1NzU3MzZBQUFDMUQpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMzEKPj4Kc3RyZWFtCnicPcw9C8IwFEbh/f6Kd1SwaT6qxrXSQbAicrFzoLFV2gaCRf33ZtHtOcuRkBhJbddCaps8/K0KUaSUP/TU0EQ5v1HWeyqZ8voT7649x5BdfDcPLkJJ8C1dOpCGEdaAW1qc/AtXH8PkxjA/+xUOR5iN2elMaWOX4AdVTFW6fgEvWSKVCmVuZHN0cmVhbQplbmRvYmoKMTUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0RFRkQxMDFCNzgwNzQwRUE5RDhBNENBQTQzNjEwNzQ4Ci9CQm94IFswIDAgMjkxLjMzIDEyLjMzIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9ERUZEMTAxQjc4MDc0MEVBOUQ4QTRDQUE0MzYxMDc0OCkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyNQo+PgpzdHJlYW0KeJw9zLEKwjAUheH9PMUZdUibplboWi24FEQudC4ktkps4UpB39446HL4hsNvafmAq4usLBPjj4X7boT9a0KPGbm82HQHNIK8e+tt8GddzCWMaxyUNeWaKiPhWGVuv6N4bGTSEHhaZ6/B87jEdH2SNGZLuaMVtKn4Aa0SIj4KZW5kc3RyZWFtCmVuZG9iagoxNiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fOTc0NEIwNUNBNTkwNDdGNzlEMjQ3RDIxMDE0ODFBNkMKL0JCb3ggWzAgMCA2OS4zMzUgMTIuMzMgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzk3NDRCMDVDQTU5MDQ3Rjc5RDI0N0QyMTAxNDgxQTZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTExCj4+CnN0cmVhbQp4nD3MvQqDQBAE4H6eYkotcq53qNgaLAUJC6kFfxIxCRwEkrd3G63mm2JGKHyhrF0IhXE7mHsLq3LqgTveyPTHpruiUWTdPz6HsY+fy21avtsQmQt1tpuF8PSuqgvqiCSIOJGUuqJVtDbfASxgGxAKZW5kc3RyZWFtCmVuZG9iagoxNyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUKL0JCb3ggWzAgMCA4My42MSAxMi4zMyBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTMKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7Vwd2YWdW0jKQMiA9aBaIxEhQVB/94txO7c5gqFd+QUNlo1/6QWUqolf11xwgPR32y6PRpH7D5l6odDea6O5/E194Uq9Eu9jITRwna3pg9YSI6ao4npkn5D62jr4gtlxRtzCmVuZHN0cmVhbQplbmRvYmoKMTggMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0U5OTkwQTg1ODE1RTQ4MjFCMkY1MjQwRTAxOUFBQkNGCi9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9FOTk5MEE4NTgxNUU0ODIxQjJGNTI0MEUwMTlBQUJDRikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pq20c6WbAZELnQONtRIrhBb07c2i23eWIxQ+YZujkbLNjn/b2tQ55Yc7Biwo9M3OndApCvdJsx8v6XW4hmmLPtEK9ZYvE1GyMm1FHbFzftlC5Hle1xj21Ad6RZ8nX/uzHqAKZW5kc3RyZWFtCmVuZG9iagoxOSAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMKL0JCb3ggWzAgMCAyMDcgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjYKPj4Kc3RyZWFtCnicNcw9C4MwFEbh/f6Kd2wH9foB7arBoYNQyoXOwaTaViPECO2/byg4nTM9DMZMBZ9ip3/zKq3i8j4j3clRJh80naJGKOu+/qnN1S/JzQ7bpD1yhjyiMIAKlOm5hBg61Mbg4tagXYAabf9GArWtYZmtP0Je1Aq10fwBICch3wplbmRzdHJlYW0KZW5kb2JqCjIwIDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV80MTM3MkVCNDA1QzY0OTNDOEM0NjU3RThDOTkxRDdDNQovQkJveCBbMCAwIDIyMS4zNjkgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNDEzNzJFQjQwNUM2NDkzQzhDNDY1N0U4Qzk5MUQ3QzUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTYKPj4Kc3RyZWFtCnicPcw9C8IwGEXh/f6KO+pgmo8ida10MyDyQudAY1uJFUIL+u/NottzlqOp+YS1RrnjqTj9bWpVl9Q/TOixoJI3W39GK6j8J89huObX4RbHLYVMoyn3chkJS6caRxmw82HZYuJlXtcU95QHOkFXJl/7gR6gCmVuZHN0cmVhbQplbmRvYmoKMjEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzFDRTU1MTZCRkJERDQxRjVBOEVFNDJCRTlGOENFMTY3Ci9CQm94IFswIDAgMjIxLjM2OSAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8xQ0U1NTE2QkZCREQ0MUY1QThFRTQyQkU5RjhDRTE2NykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zD0LwjAYReH9/oo76mCajyJ1rXQzIPJC50BjW4kVQgv6782i23OWo6n5hLVGueOpOP1talWX1D9M6LGgkjdbf0YrqPwnz2G45tfhFscthUyjKfdyGQlLpxpHGbDzYdli4mVe1xT3lAc6QVcmX/uBHqAKZW5kc3RyZWFtCmVuZG9iagoyMiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMjU4MTk5NkJCMEI2NEYzNEFEMTcxOUE5MkNGMkEwNkMKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzI1ODE5OTZCQjBCNjRGMzRBRDE3MTlBOTJDRjJBMDZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MsQqDQBRE0X6+Ykotsr7VLdbWYCmIPLAWNEYxCgtC8vfZRrszxR2h8AMrznifR2+3rTMuTrnwRo8dmX5ZNU9Uiqz5hWUY23A8umk+tyHQCvUVX2YiZ2F8QR2RlM6n1BW1oo7pH8BbGlUKZW5kc3RyZWFtCmVuZG9iagoyMyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fQ0IzQUZGRUMwODk1NENCRDg3QjU1Njk5NTdFM0FGOUEKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtX0NCM0FGRkVDMDg5NTRDQkQ4N0I1NTY5OTU3RTNBRjlBKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MuwqDQBSE4X6eYsqkcD17KbZWLIUQDlgL3tEEFgLJ27uN6b4p/hEKD1gJJkaXvf9tgwl5yoUFHV4o9cuqrVEpyvaX1n54pHfxHOfP3idaoU75ZSYcvYmeOuBmnQ936oZG0eT2BNndGnoKZW5kc3RyZWFtCmVuZG9iagoyNCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fNkQ0RURDOEQ2NEM4NDcxQ0EzMTY5ODA4MEVFQjBGOUUKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzZENEVEQzhENjRDODQ3MUNBMzE2OTgwODBFRUIwRjlFKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQqDMBRG4f1/in9sB5N7Y4bMiqNQyoXOgta2aAuBgr69WdrtO8sRCleoRJdSKF7+1uhiSfnhgRve8Lax6Vs0Bt/v+TmMl/yprtP8XYZMFdq9XGYisHappo04SfIqPkjQM+2FztCVwwF63RucCmVuZHN0cmVhbQplbmRvYmoKMjUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzM4OTdDOEM1MDg5NTQ0NUM4NjlGODFCQjJEODcyMzczCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8zODk3QzhDNTA4OTU0NDVDODY5RjgxQkIyRDg3MjM3MykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExMgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1KHJvUmGzJWOBZELnQvVqrQKAUHfvlnq9p3lCIUrVJLLOVQvf2tyqabsuGPAC96+bPsTWoPvf+UxTufybi7X+bOMhSq0W73MRGB0OdImHCT7qD5I0CPtic7Q1cMGexUbnwplbmRzdHJlYW0KZW5kb2JqCjI2IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8wRkQ4Nzc3QzczQTQ0REVGQUVEN0FGMzdBQ0IzNEIyQwovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMEZEODc3N0M3M0E0NERFRkFFRDdBRjM3QUNCMzRCMkMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTQKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7XIZDa7xq0jKQMhDFgHEqMSFRYE/Xu3Md25zVUqH3AaJMYqe93sgoSc+scVZzxR2odNd0JjKLtvuo1Tn17FMC/vdUx0Srvky0IcD+Lqil6ip03YeVVR3dPuaA1tXvwAlzEb0gplbmRzdHJlYW0KZW5kb2JqCjI3IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV9FQjkwMkY1MEU5QkM0RDM5QUVFNzg5MkNGMjVBMzVDQQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUI5MDJGNTBFOUJDNEQzOUFFRTc4OTJDRjI1QTM1Q0EpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcyxCoNAFETRfr5iSi2yvtUt1tZgKYg8sBY0RjEKC0Ly99lGuzPFHaHwAyvOeJ9Hb7etMy5OufBGjx2Zflk1T1SKrPmFZRjbcDy6aT63IdAK9RVfZiJnYXxBHZGUzqfUFbWijukfwFsaVQplbmRzdHJlYW0KZW5kb2JqCjI4IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8xREUyOTk1RDYxODI0MUI3ODdGMjFGOURBODNENDY4OQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMURFMjk5NUQ2MTgyNDFCNzg3RjIxRjlEQTgzRDQ2ODkpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcy7CoNAFIThfp5iyqRwPXsptlYshRAOWAve0QQWAsnbu43pvin+EQoPWAkmRpe9/22DCXnKhQUdXij1y6qtUSnK9pfWfnikd/Ec58/eJ1qhTvllJhy9iZ464GadD3fqhkbR5PYE2d0aegplbmRzdHJlYW0KZW5kb2JqCjI5IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV81QThDOTFGREE2REQ0NDUyQTlGRUZGREQ0QkU2QzY3RgovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNUE4QzkxRkRBNkRENDQ1MkE5RkVGRkRENEJFNkM2N0YpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTIKPj4Kc3RyZWFtCnicPcyxCoMwFEbh/X+Kf2wHk3tjhsyKo1DKhc6C1rZoC4GCvr1Z2u07yxEKV6hEl1IoXv7W6GJJ+eGBG97wtrHpWzQG3+/5OYyX/Kmu0/xdhkwV2r1cZiKwdqmmjThJ8io+SNAz7YXO0JXDAXrdG5wKZW5kc3RyZWFtCmVuZG9iagozMCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMzJBNTAyRDMxNjY1NDgzMjhDODZBRDQxOERBOTU1OEQKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzMyQTUwMkQzMTY2NTQ4MzI4Qzg2QUQ0MThEQTk1NThEKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQrCMBRG4f1/in/Uocm9SYbMlY4FkQudC9WqtAoBQd++Wer2neUIhStUkss5VC9/a3Kppuy4Y8AL3r5s+xNag+9/5TFO5/JuLtf5s4yFKrRbvcxEYHQ50iYcJPuoPkjQI+2JztDVwwZ7FRufCmVuZHN0cmVhbQplbmRvYmoKMzEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzc2QkRCNTMxMzBBQTREQzQ5RjNDRUQzNTdGRjYyMzEyCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV83NkJEQjUzMTMwQUE0REM0OUYzQ0VEMzU3RkY2MjMxMikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNAo+PgpzdHJlYW0KeJw9zLEKwkAQRdH+fcUrtchkNrvGrSMpAyEMWAcSoxIVFgT9e7cx3bnNVSofcBokxip73eyChJz6xxVnPFHah013QmMou2+6jVOfXsUwL+91THRKu+TLQhwP4uqKXqKnTdh5VVHd0+5oDW1e/ACXMRvSCmVuZHN0cmVhbQplbmRvYmoKMzIgMCBvYmoKPDwNCi9KYXZhU2NyaXB0IDMzIDAgUgo+PgplbmRvYmoKMzMgMCBvYmoKPDwNCi9OYW1lcyBbKDAwMDAwMCkgMzQgMCBSICgwMDAwMDIpIDM2IDAgUiAoMDAwMDA0KSAzOCAwIFIgXQo+PgplbmRvYmoKMzQgMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzNSAwIFIKPj4KZW5kb2JqCjM1IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQ2MQo+PgpzdHJlYW0KSInUlMFu2zAMhu99CiKnBAj8AkMO3tIWxbqk6JruaMgWnXCVRU9iYvjtR9ldgwbGsB4HGIYh/aQ+/qRFNcylb5HruRwoZvn68/UCViuYHb3Fmjza2eIKAN52YQUeO9iWP7GS+eLTVVrM7vPN7S6/Tbuz681u9rr8TNhhKKIE8vviicRhUuSWS4S8ClwamdbuWmsEizXG6hxx5wWDqYROCDccmgij7E+KRzT2nGKDaPXVFc8YIrEvvsV9yvWkpcDD+gZqUpyAv44UMIJJdWGA06gGrmE8dcyawYOqImy/gjBY7rxjY9UXBKcIUc6BASIi9HzUjz4KNmBsQ56UywiHbLriKdxi6+w75L/Sjn5m8IXbfmgY7B7vwXgLrVEMIK/kA1YZuIsafYE6cn6A772d2pF/sPMN8wfJgY9yqVwOng7JGtODpdg60y+hVGla8CzQcXiBNnCLwfUZfOfmNQIdNuglQkP7gwxaPfJEkUrttdHDnFODHFUvqZMaAw2HZE0KNzKQ6lOK0Yb5/WR/LwbjA+0cxzX8p7bd1TpMaYoweBSo2Hu9AxKllmJOhpxR+RKqZG8yTx3uyLnz35JmkXwUTTfhbHLytwADANKtmaYKZW5kc3RyZWFtCmVuZG9iagozNiAwIG9iago8PA0KL1MgL0phdmFTY3JpcHQKL0pTIDM3IDAgUgo+PgplbmRvYmoKMzcgMCBvYmoKPDwNCi9GaWx0ZXIgWy9GbGF0ZURlY29kZSBdCi9MZW5ndGggMjc0Cj4+CnN0cmVhbQpIidySUUvDMBSF3/srLnkYK0Liq9YikykIUmHTgk/lrrmtwawJbbohzv9uW9xkXQt79jH3fDnccxKVwdR9WjLZdDa/u+cLQkllEqOuKZlVHyR9CENgdSEpUwVJ5nsAMMJCCBnqigJP9XxjRdtzfU/Zcd/fHSIimcRUVsoUfWPY7WCMhRu44pe+99UPdQSFLRQM545ou+eS18VTw7J35+y1EGmuOEqzIp6atagspQq1wLQ0K3SithIdsT/X5dvyMXp4bg1ubcjgAtBabjW6zJTr5sgmm8N401W036/V9EHTWOQ15tSN096Vl6a7Tig7YSxy4H2PPeFZVQ+wp1UPQb2qj77CP6h6IHJb9Y8AAwCXJB2JCmVuZHN0cmVhbQplbmRvYmoKMzggMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzOSAwIFIKPj4KZW5kb2JqCjM5IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQwNQo+PgpzdHJlYW0KSInUU11PwjAUfYZfcd0Ti2QRX1SUBxRJTBSUr+jT0tC70VjKsnagAf67XRmw6UAMTy5L06bnnnvPPbfMg5L6DHDilT484jIhFeEcqQ21GliRoOgxgdSCxQJSuCmGkk1EHip1DTdw7lzaxXkRAJjORILAmTKcYdjTXCa4g4RiaNkxxOASaL1xe++sLt0B4RG6dfmOFE5qoMII7QS6DvmRYLAp4co5s7eoVEAqhnAMVSanVCETvttCpHqZuQmf+yT9MlT0b7RX7Ayd/tSIScdH1e885mhIM2kEnILBdN+6D61muwwe4RLt6wzprk6sGpHCLrdb1DR54gamN/vEuf2AEoXhbpExpbab3k3GwUSgUKX5MLazaj3zyGfCKsOwRcb6/NqsxwfNXrX0IFjLjTJTqlniSnO9T0o9zvuLjPdJ8SFKXbhEXfdLhFJpaBUObU+bUy2pgR6JuMqGHWbxsMcUx9yE5iZuUqHw3cMjh/p3YXuHOmbjJBLD0Was/6TZuPY/J3X9AHPGMfsAk5FeFr8EGAC5qJCpCmVuZHN0cmVhbQplbmRvYmoKNDAgMCBvYmoKPDwNCi9GaWVsZHMgW10KPj4KZW5kb2JqCjQxIDAgb2JqCjw8DQovVHlwZSAvTWV0YWRhdGEKL1N1YnR5cGUgL1hNTAovTGVuZ3RoIDEwODkKPj4Kc3RyZWFtCjw/eHBhY2tldCBiZWdpbj0iIiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA0LjIuMS1jMDQxIj4NCjxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyIgPg0KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj4NCiAgPGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD4NCiAgPGRjOnRpdGxlPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzp0aXRsZT4NCiAgPGRjOmRlc2NyaXB0aW9uPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzpkZXNjcmlwdGlvbj4NCiAgPGRjOmNyZWF0b3I+DQogICAgPHJkZjpTZXE+DQogICAgICA8cmRmOmxpIC8+DQogICAgPC9yZGY6U2VxPg0KICA8L2RjOmNyZWF0b3I+DQo8L3JkZjpEZXNjcmlwdGlvbj4NCjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnBkZj0iaHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyI+DQogIDxwZGY6S2V5d29yZHMgLz4NCiAgPHBkZjpQcm9kdWNlcj5BZG9iZSBMaXZlQ3ljbGUgRGVzaWduZXIgMTEuMDwvcGRmOlByb2R1Y2VyPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iPg0KICA8eG1wOkNyZWF0b3JUb29sPkFkb2JlIExpdmVDeWNsZSBEZXNpZ25lciAxMS4wPC94bXA6Q3JlYXRvclRvb2w+DQogIDx4bXA6Q3JlYXRlRGF0ZT4yMDE4LTA0LTA2VDE2OjAzOjU5KzAwOjAwPC94bXA6Q3JlYXRlRGF0ZT4NCiAgPHhtcDpNb2RpZnlEYXRlPjIwMTgtMDQtMDZUMTY6MDM6NTkrMDA6MDA8L3htcDpNb2RpZnlEYXRlPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8L3JkZjpSREY+DQo8L3g6eG1wbWV0YT4NCjw/eHBhY2tldCBlbmQ9InciPz4NCgplbmRzdHJlYW0KZW5kb2JqCjQyIDAgb2JqCjw8DQovVHlwZSAvT3V0bGluZXMKL0NvdW50IC0xCi9GaXJzdCA0MyAwIFIKL0xhc3QgNDMgMCBSCj4+CmVuZG9iago0MyAwIG9iago8PA0KL0NvdW50IDAKL1RpdGxlIChDaGVja180MDA4IC0gTmV3RG9jUDEgLSBBUENoZWNrc18wMDAwMDAwMCswMDAwKzAwMDArMDAwMCswMDAwMDAwMDAwMDBfQVBETFQxMTEpCi9DIFswIDAgMCBdCi9GIDIKL0EgPDwNCi9OZXh0IFtdCi9TIC9Hb1RvCi9EIFs0IDAgUiAvWFlaIDAgNzkyIDEgXQo+PgovUGFyZW50IDQyIDAgUgo+PgplbmRvYmoKeHJlZgowIDQ0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAyMyAwMDAwMCBuIAowMDAwMDAwMjAzIDAwMDAwIG4gCjAwMDAwMDA0MDAgMDAwMDAgbiAKMDAwMDAwMDQ1OSAwMDAwMCBuIAowMDAwMDAxNTY1IDAwMDAwIG4gCjAwMDAwMDE2NjggMDAwMDAgbiAKMDAwMDAwMTcyMiAwMDAwMCBuIAowMDAwMDAyMTU4IDAwMDAwIG4gCjAwMDAwMDIyMTIgMDAwMDAgbiAKMDAwMDAwMjMxNSAwMDAwMCBuIAowMDAwMDAzMDgxIDAwMDAwIG4gCjAwMDAwMDQyNzYgMDAwMDAgbiAKMDAwMDAwNDUzMyAwMDAwMCBuIAowMDAwMDA1MDA1IDAwMDAwIG4gCjAwMDAwMDU0ODcgMDAwMDAgbiAKMDAwMDAwNTk2MyAwMDAwMCBuIAowMDAwMDA2NDI1IDAwMDAwIG4gCjAwMDAwMDY4ODggMDAwMDAgbiAKMDAwMDAwNzM1NSAwMDAwMCBuIAowMDAwMDA3ODI4IDAwMDAwIG4gCjAwMDAwMDgyOTUgMDAwMDAgbiAKMDAwMDAwODc2MiAwMDAwMCBuIAowMDAwMDA5MjIxIDAwMDAwIG4gCjAwMDAwMDk2ODAgMDAwMDAgbiAKMDAwMDAxMDE0MyAwMDAwMCBuIAowMDAwMDEwNjA2IDAwMDAwIG4gCjAwMDAwMTEwNzEgMDAwMDAgbiAKMDAwMDAxMTUzMCAwMDAwMCBuIAowMDAwMDExOTg5IDAwMDAwIG4gCjAwMDAwMTI0NTIgMDAwMDAgbiAKMDAwMDAxMjkxNSAwMDAwMCBuIAowMDAwMDEzMzgwIDAwMDAwIG4gCjAwMDAwMTM0MjIgMDAwMDAgbiAKMDAwMDAxMzUwMyAwMDAwMCBuIAowMDAwMDEzNTUyIDAwMDAwIG4gCjAwMDAwMTQwOTAgMDAwMDAgbiAKMDAwMDAxNDEzOSAwMDAwMCBuIAowMDAwMDE0NDkwIDAwMDAwIG4gCjAwMDAwMTQ1MzkgMDAwMDAgbiAKMDAwMDAxNTAyMSAwMDAwMCBuIAowMDAwMDE1MDU1IDAwMDAwIG4gCjAwMDAwMTYyMjggMDAwMDAgbiAKMDAwMDAxNjMwNCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDQ0Ci9Sb290IDIgMCBSCi9JbmZvIDEgMCBSCi9JRCBbPDU3MTBENjJBQjIxNjM3OTkxMjIyMEU0RTg2NzFEQThFPjw1NzEwRDYyQUIyMTYzNzk5MTIyMjBFNEU4NjcxREE4RT5dCj4+CnN0YXJ0eHJlZgoxNjUwOQolJUVPRg==\",\r\n        \"documentType\": \"pdf\"\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"b2ac3f03-a49d-4ce1-8240-fabd1253d192","name":"Account Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"accountNumber\": \"1\",\r\n    \"transactionCode\": \"check\",\r\n    //Customer_Primary_Only = 1\r\n    //Customer_Primary_And_Spouse_Or_CoSigner = 2\r\n    \"customerPayeeType\": \"Customer_Primary_And_Spouse_Or_CoSigner\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddInstantCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 948,\r\n        \"checkNumber\": 4008,\r\n        \"document\": \"JVBERi0xLjcKJdDExrTOxdSghIKAgAoxIDAgb2JqCjw8DQovQ3JlYXRvciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9Qcm9kdWNlciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9DcmVhdGlvbkRhdGUgKEQ6MjAxODA0MDYwOTAzNTktMDcnMDAnKQovTW9kRGF0ZSAoRDoyMDE4MDQwNjA5MDM1OS0wNycwMCcpCj4+CmVuZG9iagoyIDAgb2JqCjw8DQovQWNyb0Zvcm0gNDAgMCBSCi9OYW1lcyAzMiAwIFIKL0V4dGVuc2lvbnMgPDwNCi9BREJFIDw8DQovRXh0ZW5zaW9uTGV2ZWwgMwovQmFzZVZlcnNpb24gLzEuNwo+Pgo+PgovUGFnZXMgMyAwIFIKL01ldGFkYXRhIDQxIDAgUgovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiAvMS43Ci9PdXRsaW5lcyA0MiAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwNCi9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwo+PgplbmRvYmoKNCAwIG9iago8PA0KL0NvbnRlbnRzIFs1IDAgUiA2IDAgUiA3IDAgUiA4IDAgUiA5IDAgUiAxMCAwIFIgXQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL1QxXzAgMTEgMCBSCj4+Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IF0KL1hPYmplY3QgPDwNCi9CRTQzQzJGNy0xQjFGLTQyQjktOUZCMi1GRDVFMjM3REQ4NTIgMTMgMCBSCi9GMUVCQTZBOC0wQUExLTRDMTEtOUY1OS1DMEI4RERDMjdCMDIgMTQgMCBSCi9GQkNCQjRCQS02OEUxLTQzRDItQTU5Ri01NEEzNTExRDRGNDEgMTUgMCBSCi9GMTE2QTRGRS0zOEEzLTQwNkEtQUE0NC0yQUNEOTlDNjZDRjkgMTYgMCBSCi9EODY4QTUzNC1GQ0M1LTRGQzktOUFBMS1FMEMzOUMxRjEzRDAgMTcgMCBSCi8yQjQzNDRCMC0zNTk0LTRFNDgtODA5Ri02MzhDOTBFOERCQTcgMTggMCBSCi8xNEIzRjc1Qy02QjA2LTRCNUItQkFBNi1DQzYyMzI5ODU4QkMgMTkgMCBSCi9ENURCODFGNS1FMjUyLTQ3RTUtOUI0Ri00Mzg2MTI0NzM4Q0UgMjAgMCBSCi8zQjFDNzk2Ny00MDUzLTRDMDQtOTI1Qy0zRjY5NUE5MDU0NUEgMjEgMCBSCi83MUE4RTI1OC1BNDJFLTQwQTQtQUJGQi1GNjM2QTA4QTUyNTQgMjIgMCBSCi9FMUIwNTRDNi03QzY5LTQ3ODMtQTQ1Mi0xRUZEMDRFMjA3OTEgMjMgMCBSCi9FNjU2OEUzNi01MzYwLTRFNzQtQjQ1OS0wNEUzRTI2QUQ5QkMgMjQgMCBSCi9EOTZEMzZDNy00MTI5LTRENzEtQUUyRS1EQUNBNDdCMjZEOUEgMjUgMCBSCi8zMjlGN0NBRS01QTYyLTQ1MjgtQUFFNy1CRjg5NDgxOTdDMjUgMjYgMCBSCi85RjFDMzRBMy02RTJELTRBNEItOUJCQy02MEI5MUFGMjlFRDIgMjcgMCBSCi8xOUFBNDM1OS02NzMxLTQ4MkUtQTBERS03MjJGN0U4OTJFQUIgMjggMCBSCi84MTNERDRGRS02RTkzLTRGNjctOUZDMy0wMkY1MEY1RTBFMzkgMjkgMCBSCi9BRkQzQUIxMy05RTQ4LTQ2NDgtOEYwNC1DRURDQTc0M0IzNTMgMzAgMCBSCi8wOUIxMzIzQi0wQjNCLTRFMkYtQkZFNS1CQzU1OUMyMTE4NzQgMzEgMCBSCj4+Cj4+Ci9Bbm5vdHMgW10KL01lZGlhQm94IFswIDAgNjEyIDc5MiBdCi9Dcm9wQm94IFswIDAgNjEyIDc5MiBdCi9Sb3RhdGUgMAovVHlwZSAvUGFnZQovUGFyZW50IDMgMCBSCj4+CmVuZG9iago1IDAgb2JqCjw8DQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDMxCj4+CnN0cmVhbQp4nFMo5DJUMABCEGluaaSQnAsV0IVQQH4gFwCHXwcOCmVuZHN0cmVhbQplbmRvYmoKNiAwIG9iago8PA0KL0xlbmd0aCA0Cj4+CnN0cmVhbQogcSAKCmVuZHN0cmVhbQplbmRvYmoKNyAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAzNjMKPj4Kc3RyZWFtCkiJpJLBT8IwGMXv/Su+RA5IQmm7zq7exBmjN7HhanBUrdlYLBv++3YIDLeCE7PD2rTv+723vbFCBKrHvqLRRKezwqz0dZ7m1mS6sCYBa9BI0ScCFNQLot+33YtLiTlcCIkFqAz1e4PBuXpHQx5hymFIIxxyUHPUj/Us1XY01Yt5bi+rOwSGLMQMVOw9dXoGLMBcROsB07xM3rSFs+r0Zmt4cusWBogz8QkM7gF9OItrc0CdNSqAixDLKIAkW2syxKnbu1WKHtEDGitE3QR/PMrEZobAxM2oIt4tVrlJ9J4R84O6kzSwgcA0lN24LAgPcuNZof3oWtVAh1XijuiABy10bJbPpV3qTC+KI/xa2uBHBIesI9/974PRr7K8dA56fnytbOBFgEXXL78pDXPV3NLbzTOemjHX1f/WbJ/asWYt7Ck183F/r1kLfUrN9tFxeQxbK5qJJSbyj+3yJe7Wrha+0a4vAQYAQD0mSwplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwNCi9MZW5ndGggNAo+PgpzdHJlYW0KIFEgCgplbmRzdHJlYW0KZW5kb2JqCjkgMCBvYmoKPDwNCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMzEKPj4Kc3RyZWFtCnicUyjkMlQwAEIQaW5ppJCcCxXQhVBAfiAXAIdfBw4KZW5kc3RyZWFtCmVuZG9iagoxMCAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCA2OTIKPj4Kc3RyZWFtCnicjZQ7riNHDEVzraI3wHbxW8WwvrkjL2AwoW3Y+w/Mlsav1W/eQIKAVnJxT5GX5PbPzXgzKjttmHVPVDaUXbZ/v29/bH/dcEvxw+1D9O3P229tCndaGbDhAqHm4KsRrKGTOI9RlLbx9237/fbDH3kvL/3vosN/4WzVaoFUK4J0xPBXh55aGaNTbunZX/fCulmx+z857swb0vH9TLlK76zWW5NWwcoMFg+Cqr5ApbIiDlmCJ0vDtsRTs+3pMPKA6NesT9JHXWhV1gQulUGSVahVBKj24d7N+vKTxRkfr/3hUHg3/Jr1WXrARrFSlQVW7wqyeoR0tHOmzt5xIY90DUlot5ch3UWHPzVhkZaA1QVkSoGSonHGpXuaZbSaL/7qKSwp5V95PwSHN0rjlbWDtWQgTRu0Wg16N2LyoqX107vIboybFI+nEUX85l8yLsJ7j3S0gkthkhJIngreJEaaiyFJjlLmT5yY8Pc4D+HB4YY9u+XIXCP4ngScojxe5lo9qWg9OVg2UT6ySLKXQl8yPkSHf8ZaooQCVWgGpArUthosY6spxoBUnvzJ3gF8qA7CxBav7Aa5m0enCgcreoZzjSQzUvWnNSGWNwin6k4wjRVkA2VLMU9ZoEksfbjzJKvDnzNnoTcIp+qetttg65ECUtQwMkKd0a9Re5XcyIY/pSCa3iCcqnvO5Cv3OkGrxTwpRSJ1ZmiruBT03EkvOVPC1zk/RIe/L+wchwls0gCp0mJeW6xJao51kc9B15zfAHyo7psXN0Jio8Eyxzks0Z6axoRMce9ncZq1XXN+TThVB6HE4RnHEbTpsQsrtsJXZ0i0NC2dabJfc35NOFUHoa7BtSGDH0dJ7LhMK1auz9FrFm6sfM35NeFUHYTkYU/cILX4xPiviDiOR+uq3gmx5P/37T9cU4W+CmVuZHN0cmVhbQplbmRvYmoKMTEgMCBvYmoKPDwNCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9TdWJ0eXBlIC9UeXBlMQovRm9udERlc2NyaXB0b3IgMTIgMCBSCi9UeXBlIC9Gb250Ci9CYXNlRm9udCAvTXlyaWFkUHJvLVJlZ3VsYXIKL1dpZHRocyBbNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCAyMTIgMjMwIDMzNyA0OTcgNTEzIDc5MiA2MDUgMTg4IDI4NCAyODQgNDE1IDU5NiAyMDcgMzA3IDIwNyAzNDMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDIwNyAyMDcgNTk2IDU5NiA1OTYgNDA2IDczNyA2MTIgNTQyIDU4MCA2NjYgNDkyIDQ4NyA2NDYgNjUyIDIzOSAzNzAgNTQyIDQ3MiA4MDQgNjU4IDY4OSA1MzIgNjg5IDUzOCA0OTMgNDk3IDY0NyA1NTggODQ2IDU3MSA1NDEgNTUzIDI4NCAzNDEgMjg0IDU5NiA1MDAgMzAwIDQ4MiA1NjkgNDQ4IDU2NCA1MDEgMjkyIDU1OSA1NTUgMjM0IDI0MyA0NjkgMjM2IDgzNCA1NTUgNTQ5IDU2OSA1NjMgMzI3IDM5NiAzMzEgNTUxIDQ4MSA3MzYgNDYzIDQ3MSA0MjggMjg0IDIzOSAyODQgNTk2IDI4MiA1MTMgMjgyIDIwNyA1MTMgMzU2IDEwMDAgNTAwIDUwMCAzMDAgMTE1NiA0OTMgMjU1IDg5NCAyODIgNTUzIDI4MiAyODIgMjA3IDIwNyAzNTQgMzU0IDI4MiA1MDAgMTAwMCAzMDAgNjE5IDM5NiAyNTUgODYzIDI4MiA0MjggNTQxIDIxMiAyMzAgNTEzIDUxMyA1MTMgNTEzIDIzOSA1MTkgMzAwIDY3NyAzNDYgNDE5IDU5NiAzMDcgNDE5IDMwMCAzMTggNTk2IDMxMSAzMDUgMzAwIDU1MyA1MTIgMjA3IDMwMCAyNDQgMzU1IDQxOSA3NTkgNzU5IDc1OSA0MDYgNjEyIDYxMiA2MTIgNjEyIDYxMiA2MTIgNzg4IDU4NSA0OTIgNDkyIDQ5MiA0OTIgMjM5IDIzOSAyMzkgMjM5IDY3MSA2NTggNjg5IDY4OSA2ODkgNjg5IDY4OSA1OTYgNjg5IDY0NyA2NDcgNjQ3IDY0NyA1NDEgNTMxIDU0OCA0ODIgNDgyIDQ4MiA0ODIgNDgyIDQ4MiA3NzMgNDQ3IDUwMSA1MDEgNTAxIDUwMSAyMzQgMjM0IDIzNCAyMzQgNTQxIDU1NSA1NDkgNTQ5IDU0OSA1NDkgNTQ5IDU5NiA1NDkgNTUxIDU1MSA1NTEgNTUxIDQ3MSA1NjkgNDcxIF0KL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciAyNTUKPj4KZW5kb2JqCjEyIDAgb2JqCjw8DQovRm9udFdlaWdodCA0MDAKL1hIZWlnaHQgNDg0Ci9EZXNjZW50IC0yNTAKL0ZvbnROYW1lIC9NeXJpYWRQcm8tUmVndWxhcgovQXNjZW50IDk1MgovQ2FwSGVpZ2h0IDY3NAovRm9udEJCb3ggWy0xNTcgLTI1MCAxMTI2IDk1MiBdCi9Gb250RmFtaWx5IChNeXJpYWQgUHJvKQovRmxhZ3MgMzIKL0ZvbnRTdHJldGNoIC9Ob3JtYWwKL1N0ZW1WIDg4Ci9JdGFsaWNBbmdsZSAwCi9UeXBlIC9Gb250RGVzY3JpcHRvcgo+PgplbmRvYmoKMTMgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0QzOUIzRTc3NTFGMjQyQTQ5NjQ4RkY3OTBENUIzMzM5Ci9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9EMzlCM0U3NzUxRjI0MkE0OTY0OEZGNzkwRDVCMzMzOSkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyMQo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pqmYuVJ0KYhccA40tkpVSBXt25tFt+8sRyi8wW7WRkqfPf5tK1PllB8GnHBHoR/W7Ra1omjndAndIT1Wx9i/xpBohXrOl54o6Yx31A4L8dZxH6cpjtyFZ3yHeUm9olE0efUFqyAf8gplbmRzdHJlYW0KZW5kb2JqCjE0IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV85NEVBODg4MTJDMDY0QTY4ODQyNzU3NTczNkFBQUMxRAovQkJveCBbMCAwIDE3NS4wMjggMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fOTRFQTg4ODEyQzA2NEE2ODg0Mjc1NzU3MzZBQUFDMUQpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMzEKPj4Kc3RyZWFtCnicPcw9C8IwFEbh/f6Kd1SwaT6qxrXSQbAicrFzoLFV2gaCRf33ZtHtOcuRkBhJbddCaps8/K0KUaSUP/TU0EQ5v1HWeyqZ8voT7649x5BdfDcPLkJJ8C1dOpCGEdaAW1qc/AtXH8PkxjA/+xUOR5iN2elMaWOX4AdVTFW6fgEvWSKVCmVuZHN0cmVhbQplbmRvYmoKMTUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0RFRkQxMDFCNzgwNzQwRUE5RDhBNENBQTQzNjEwNzQ4Ci9CQm94IFswIDAgMjkxLjMzIDEyLjMzIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9ERUZEMTAxQjc4MDc0MEVBOUQ4QTRDQUE0MzYxMDc0OCkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyNQo+PgpzdHJlYW0KeJw9zLEKwjAUheH9PMUZdUibplboWi24FEQudC4ktkps4UpB39446HL4hsNvafmAq4usLBPjj4X7boT9a0KPGbm82HQHNIK8e+tt8GddzCWMaxyUNeWaKiPhWGVuv6N4bGTSEHhaZ6/B87jEdH2SNGZLuaMVtKn4Aa0SIj4KZW5kc3RyZWFtCmVuZG9iagoxNiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fOTc0NEIwNUNBNTkwNDdGNzlEMjQ3RDIxMDE0ODFBNkMKL0JCb3ggWzAgMCA2OS4zMzUgMTIuMzMgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzk3NDRCMDVDQTU5MDQ3Rjc5RDI0N0QyMTAxNDgxQTZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTExCj4+CnN0cmVhbQp4nD3MvQqDQBAE4H6eYkotcq53qNgaLAUJC6kFfxIxCRwEkrd3G63mm2JGKHyhrF0IhXE7mHsLq3LqgTveyPTHpruiUWTdPz6HsY+fy21avtsQmQt1tpuF8PSuqgvqiCSIOJGUuqJVtDbfASxgGxAKZW5kc3RyZWFtCmVuZG9iagoxNyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUKL0JCb3ggWzAgMCA4My42MSAxMi4zMyBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMDZDMDAyQTk2MzU4NDVERUI5ODUxOEJDRDdGRkNDNUUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTMKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7Vwd2YWdW0jKQMiA9aBaIxEhQVB/94txO7c5gqFd+QUNlo1/6QWUqolf11xwgPR32y6PRpH7D5l6odDea6O5/E194Uq9Eu9jITRwna3pg9YSI6ao4npkn5D62jr4gtlxRtzCmVuZHN0cmVhbQplbmRvYmoKMTggMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0U5OTkwQTg1ODE1RTQ4MjFCMkY1MjQwRTAxOUFBQkNGCi9CQm94IFswIDAgMTc1LjAyOCAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9FOTk5MEE4NTgxNUU0ODIxQjJGNTI0MEUwMTlBQUJDRikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1MH0pq20c6WbAZELnQONtRIrhBb07c2i23eWIxQ+YZujkbLNjn/b2tQ55Yc7Biwo9M3OndApCvdJsx8v6XW4hmmLPtEK9ZYvE1GyMm1FHbFzftlC5Hle1xj21Ad6RZ8nX/uzHqAKZW5kc3RyZWFtCmVuZG9iagoxOSAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMKL0JCb3ggWzAgMCAyMDcgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUUyMjI1OEU0NkU4NDdDNEFGQUI0RDAzNEE0MjBGMUMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjYKPj4Kc3RyZWFtCnicNcw9C4MwFEbh/f6Kd2wH9foB7arBoYNQyoXOwaTaViPECO2/byg4nTM9DMZMBZ9ip3/zKq3i8j4j3clRJh80naJGKOu+/qnN1S/JzQ7bpD1yhjyiMIAKlOm5hBg61Mbg4tagXYAabf9GArWtYZmtP0Je1Aq10fwBICch3wplbmRzdHJlYW0KZW5kb2JqCjIwIDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV80MTM3MkVCNDA1QzY0OTNDOEM0NjU3RThDOTkxRDdDNQovQkJveCBbMCAwIDIyMS4zNjkgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNDEzNzJFQjQwNUM2NDkzQzhDNDY1N0U4Qzk5MUQ3QzUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTYKPj4Kc3RyZWFtCnicPcw9C8IwGEXh/f6KO+pgmo8ida10MyDyQudAY1uJFUIL+u/NottzlqOp+YS1RrnjqTj9bWpVl9Q/TOixoJI3W39GK6j8J89huObX4RbHLYVMoyn3chkJS6caRxmw82HZYuJlXtcU95QHOkFXJl/7gR6gCmVuZHN0cmVhbQplbmRvYmoKMjEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzFDRTU1MTZCRkJERDQxRjVBOEVFNDJCRTlGOENFMTY3Ci9CQm94IFswIDAgMjIxLjM2OSAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8xQ0U1NTE2QkZCREQ0MUY1QThFRTQyQkU5RjhDRTE2NykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNgo+PgpzdHJlYW0KeJw9zD0LwjAYReH9/oo76mCajyJ1rXQzIPJC50BjW4kVQgv6782i23OWo6n5hLVGueOpOP1talWX1D9M6LGgkjdbf0YrqPwnz2G45tfhFscthUyjKfdyGQlLpxpHGbDzYdli4mVe1xT3lAc6QVcmX/uBHqAKZW5kc3RyZWFtCmVuZG9iagoyMiAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMjU4MTk5NkJCMEI2NEYzNEFEMTcxOUE5MkNGMkEwNkMKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzI1ODE5OTZCQjBCNjRGMzRBRDE3MTlBOTJDRjJBMDZDKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MsQqDQBRE0X6+Ykotsr7VLdbWYCmIPLAWNEYxCgtC8vfZRrszxR2h8AMrznifR2+3rTMuTrnwRo8dmX5ZNU9Uiqz5hWUY23A8umk+tyHQCvUVX2YiZ2F8QR2RlM6n1BW1oo7pH8BbGlUKZW5kc3RyZWFtCmVuZG9iagoyMyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fQ0IzQUZGRUMwODk1NENCRDg3QjU1Njk5NTdFM0FGOUEKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtX0NCM0FGRkVDMDg5NTRDQkQ4N0I1NTY5OTU3RTNBRjlBKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTA4Cj4+CnN0cmVhbQp4nD3MuwqDQBSE4X6eYsqkcD17KbZWLIUQDlgL3tEEFgLJ27uN6b4p/hEKD1gJJkaXvf9tgwl5yoUFHV4o9cuqrVEpyvaX1n54pHfxHOfP3idaoU75ZSYcvYmeOuBmnQ936oZG0eT2BNndGnoKZW5kc3RyZWFtCmVuZG9iagoyNCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fNkQ0RURDOEQ2NEM4NDcxQ0EzMTY5ODA4MEVFQjBGOUUKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzZENEVEQzhENjRDODQ3MUNBMzE2OTgwODBFRUIwRjlFKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQqDMBRG4f1/in9sB5N7Y4bMiqNQyoXOgta2aAuBgr69WdrtO8sRCleoRJdSKF7+1uhiSfnhgRve8Lax6Vs0Bt/v+TmMl/yprtP8XYZMFdq9XGYisHappo04SfIqPkjQM+2FztCVwwF63RucCmVuZHN0cmVhbQplbmRvYmoKMjUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzM4OTdDOEM1MDg5NTQ0NUM4NjlGODFCQjJEODcyMzczCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8zODk3QzhDNTA4OTU0NDVDODY5RjgxQkIyRDg3MjM3MykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExMgo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1KHJvUmGzJWOBZELnQvVqrQKAUHfvlnq9p3lCIUrVJLLOVQvf2tyqabsuGPAC96+bPsTWoPvf+UxTufybi7X+bOMhSq0W73MRGB0OdImHCT7qD5I0CPtic7Q1cMGexUbnwplbmRzdHJlYW0KZW5kb2JqCjI2IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8wRkQ4Nzc3QzczQTQ0REVGQUVEN0FGMzdBQ0IzNEIyQwovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMEZEODc3N0M3M0E0NERFRkFFRDdBRjM3QUNCMzRCMkMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTQKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7XIZDa7xq0jKQMhDFgHEqMSFRYE/Xu3Md25zVUqH3AaJMYqe93sgoSc+scVZzxR2odNd0JjKLtvuo1Tn17FMC/vdUx0Srvky0IcD+Lqil6ip03YeVVR3dPuaA1tXvwAlzEb0gplbmRzdHJlYW0KZW5kb2JqCjI3IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV9FQjkwMkY1MEU5QkM0RDM5QUVFNzg5MkNGMjVBMzVDQQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRUI5MDJGNTBFOUJDNEQzOUFFRTc4OTJDRjI1QTM1Q0EpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcyxCoNAFETRfr5iSi2yvtUt1tZgKYg8sBY0RjEKC0Ly99lGuzPFHaHwAyvOeJ9Hb7etMy5OufBGjx2Zflk1T1SKrPmFZRjbcDy6aT63IdAK9RVfZiJnYXxBHZGUzqfUFbWijukfwFsaVQplbmRzdHJlYW0KZW5kb2JqCjI4IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8xREUyOTk1RDYxODI0MUI3ODdGMjFGOURBODNENDY4OQovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMURFMjk5NUQ2MTgyNDFCNzg3RjIxRjlEQTgzRDQ2ODkpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDgKPj4Kc3RyZWFtCnicPcy7CoNAFIThfp5iyqRwPXsptlYshRAOWAve0QQWAsnbu43pvin+EQoPWAkmRpe9/22DCXnKhQUdXij1y6qtUSnK9pfWfnikd/Ec58/eJ1qhTvllJhy9iZ464GadD3fqhkbR5PYE2d0aegplbmRzdHJlYW0KZW5kb2JqCjI5IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV81QThDOTFGREE2REQ0NDUyQTlGRUZGREQ0QkU2QzY3RgovQkJveCBbMCAwIDEwNC44ODIgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMSAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNUE4QzkxRkRBNkRENDQ1MkE5RkVGRkRENEJFNkM2N0YpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTIKPj4Kc3RyZWFtCnicPcyxCoMwFEbh/X+Kf2wHk3tjhsyKo1DKhc6C1rZoC4GCvr1Z2u07yxEKV6hEl1IoXv7W6GJJ+eGBG97wtrHpWzQG3+/5OYyX/Kmu0/xdhkwV2r1cZiKwdqmmjThJ8io+SNAz7YXO0JXDAXrdG5wKZW5kc3RyZWFtCmVuZG9iagozMCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fMzJBNTAyRDMxNjY1NDgzMjhDODZBRDQxOERBOTU1OEQKL0JCb3ggWzAgMCAxMDQuODgyIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTEgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzMyQTUwMkQzMTY2NTQ4MzI4Qzg2QUQ0MThEQTk1NThEKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEyCj4+CnN0cmVhbQp4nD3MsQrCMBRG4f1/in/Uocm9SYbMlY4FkQudC9WqtAoBQd++Wer2neUIhStUkss5VC9/a3Kppuy4Y8AL3r5s+xNag+9/5TFO5/JuLtf5s4yFKrRbvcxEYHQ50iYcJPuoPkjQI+2JztDVwwZ7FRufCmVuZHN0cmVhbQplbmRvYmoKMzEgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzc2QkRCNTMxMzBBQTREQzQ5RjNDRUQzNTdGRjYyMzEyCi9CQm94IFswIDAgMTA0Ljg4MiAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDExIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV83NkJEQjUzMTMwQUE0REM0OUYzQ0VEMzU3RkY2MjMxMikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExNAo+PgpzdHJlYW0KeJw9zLEKwkAQRdH+fcUrtchkNrvGrSMpAyEMWAcSoxIVFgT9e7cx3bnNVSofcBokxip73eyChJz6xxVnPFHah013QmMou2+6jVOfXsUwL+91THRKu+TLQhwP4uqKXqKnTdh5VVHd0+5oDW1e/ACXMRvSCmVuZHN0cmVhbQplbmRvYmoKMzIgMCBvYmoKPDwNCi9KYXZhU2NyaXB0IDMzIDAgUgo+PgplbmRvYmoKMzMgMCBvYmoKPDwNCi9OYW1lcyBbKDAwMDAwMCkgMzQgMCBSICgwMDAwMDIpIDM2IDAgUiAoMDAwMDA0KSAzOCAwIFIgXQo+PgplbmRvYmoKMzQgMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzNSAwIFIKPj4KZW5kb2JqCjM1IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQ2MQo+PgpzdHJlYW0KSInUlMFu2zAMhu99CiKnBAj8AkMO3tIWxbqk6JruaMgWnXCVRU9iYvjtR9ldgwbGsB4HGIYh/aQ+/qRFNcylb5HruRwoZvn68/UCViuYHb3Fmjza2eIKAN52YQUeO9iWP7GS+eLTVVrM7vPN7S6/Tbuz681u9rr8TNhhKKIE8vviicRhUuSWS4S8ClwamdbuWmsEizXG6hxx5wWDqYROCDccmgij7E+KRzT2nGKDaPXVFc8YIrEvvsV9yvWkpcDD+gZqUpyAv44UMIJJdWGA06gGrmE8dcyawYOqImy/gjBY7rxjY9UXBKcIUc6BASIi9HzUjz4KNmBsQ56UywiHbLriKdxi6+w75L/Sjn5m8IXbfmgY7B7vwXgLrVEMIK/kA1YZuIsafYE6cn6A772d2pF/sPMN8wfJgY9yqVwOng7JGtODpdg60y+hVGla8CzQcXiBNnCLwfUZfOfmNQIdNuglQkP7gwxaPfJEkUrttdHDnFODHFUvqZMaAw2HZE0KNzKQ6lOK0Yb5/WR/LwbjA+0cxzX8p7bd1TpMaYoweBSo2Hu9AxKllmJOhpxR+RKqZG8yTx3uyLnz35JmkXwUTTfhbHLytwADANKtmaYKZW5kc3RyZWFtCmVuZG9iagozNiAwIG9iago8PA0KL1MgL0phdmFTY3JpcHQKL0pTIDM3IDAgUgo+PgplbmRvYmoKMzcgMCBvYmoKPDwNCi9GaWx0ZXIgWy9GbGF0ZURlY29kZSBdCi9MZW5ndGggMjc0Cj4+CnN0cmVhbQpIidySUUvDMBSF3/srLnkYK0Liq9YikykIUmHTgk/lrrmtwawJbbohzv9uW9xkXQt79jH3fDnccxKVwdR9WjLZdDa/u+cLQkllEqOuKZlVHyR9CENgdSEpUwVJ5nsAMMJCCBnqigJP9XxjRdtzfU/Zcd/fHSIimcRUVsoUfWPY7WCMhRu44pe+99UPdQSFLRQM545ou+eS18VTw7J35+y1EGmuOEqzIp6atagspQq1wLQ0K3SithIdsT/X5dvyMXp4bg1ubcjgAtBabjW6zJTr5sgmm8N401W036/V9EHTWOQ15tSN096Vl6a7Tig7YSxy4H2PPeFZVQ+wp1UPQb2qj77CP6h6IHJb9Y8AAwCXJB2JCmVuZHN0cmVhbQplbmRvYmoKMzggMCBvYmoKPDwNCi9TIC9KYXZhU2NyaXB0Ci9KUyAzOSAwIFIKPj4KZW5kb2JqCjM5IDAgb2JqCjw8DQovRmlsdGVyIFsvRmxhdGVEZWNvZGUgXQovTGVuZ3RoIDQwNQo+PgpzdHJlYW0KSInUU11PwjAUfYZfcd0Ti2QRX1SUBxRJTBSUr+jT0tC70VjKsnagAf67XRmw6UAMTy5L06bnnnvPPbfMg5L6DHDilT484jIhFeEcqQ21GliRoOgxgdSCxQJSuCmGkk1EHip1DTdw7lzaxXkRAJjORILAmTKcYdjTXCa4g4RiaNkxxOASaL1xe++sLt0B4RG6dfmOFE5qoMII7QS6DvmRYLAp4co5s7eoVEAqhnAMVSanVCETvttCpHqZuQmf+yT9MlT0b7RX7Ayd/tSIScdH1e885mhIM2kEnILBdN+6D61muwwe4RLt6wzprk6sGpHCLrdb1DR54gamN/vEuf2AEoXhbpExpbab3k3GwUSgUKX5MLazaj3zyGfCKsOwRcb6/NqsxwfNXrX0IFjLjTJTqlniSnO9T0o9zvuLjPdJ8SFKXbhEXfdLhFJpaBUObU+bUy2pgR6JuMqGHWbxsMcUx9yE5iZuUqHw3cMjh/p3YXuHOmbjJBLD0Was/6TZuPY/J3X9AHPGMfsAk5FeFr8EGAC5qJCpCmVuZHN0cmVhbQplbmRvYmoKNDAgMCBvYmoKPDwNCi9GaWVsZHMgW10KPj4KZW5kb2JqCjQxIDAgb2JqCjw8DQovVHlwZSAvTWV0YWRhdGEKL1N1YnR5cGUgL1hNTAovTGVuZ3RoIDEwODkKPj4Kc3RyZWFtCjw/eHBhY2tldCBiZWdpbj0iIiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+DQo8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJBZG9iZSBYTVAgQ29yZSA0LjIuMS1jMDQxIj4NCjxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyIgPg0KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIj4NCiAgPGRjOmZvcm1hdD5hcHBsaWNhdGlvbi9wZGY8L2RjOmZvcm1hdD4NCiAgPGRjOnRpdGxlPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzp0aXRsZT4NCiAgPGRjOmRlc2NyaXB0aW9uPg0KICAgIDxyZGY6QWx0Pg0KICAgICAgPHJkZjpsaSAvPg0KICAgIDwvcmRmOkFsdD4NCiAgPC9kYzpkZXNjcmlwdGlvbj4NCiAgPGRjOmNyZWF0b3I+DQogICAgPHJkZjpTZXE+DQogICAgICA8cmRmOmxpIC8+DQogICAgPC9yZGY6U2VxPg0KICA8L2RjOmNyZWF0b3I+DQo8L3JkZjpEZXNjcmlwdGlvbj4NCjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnBkZj0iaHR0cDovL25zLmFkb2JlLmNvbS9wZGYvMS4zLyI+DQogIDxwZGY6S2V5d29yZHMgLz4NCiAgPHBkZjpQcm9kdWNlcj5BZG9iZSBMaXZlQ3ljbGUgRGVzaWduZXIgMTEuMDwvcGRmOlByb2R1Y2VyPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iPg0KICA8eG1wOkNyZWF0b3JUb29sPkFkb2JlIExpdmVDeWNsZSBEZXNpZ25lciAxMS4wPC94bXA6Q3JlYXRvclRvb2w+DQogIDx4bXA6Q3JlYXRlRGF0ZT4yMDE4LTA0LTA2VDE2OjAzOjU5KzAwOjAwPC94bXA6Q3JlYXRlRGF0ZT4NCiAgPHhtcDpNb2RpZnlEYXRlPjIwMTgtMDQtMDZUMTY6MDM6NTkrMDA6MDA8L3htcDpNb2RpZnlEYXRlPg0KPC9yZGY6RGVzY3JpcHRpb24+DQo8L3JkZjpSREY+DQo8L3g6eG1wbWV0YT4NCjw/eHBhY2tldCBlbmQ9InciPz4NCgplbmRzdHJlYW0KZW5kb2JqCjQyIDAgb2JqCjw8DQovVHlwZSAvT3V0bGluZXMKL0NvdW50IC0xCi9GaXJzdCA0MyAwIFIKL0xhc3QgNDMgMCBSCj4+CmVuZG9iago0MyAwIG9iago8PA0KL0NvdW50IDAKL1RpdGxlIChDaGVja180MDA4IC0gTmV3RG9jUDEgLSBBUENoZWNrc18wMDAwMDAwMCswMDAwKzAwMDArMDAwMCswMDAwMDAwMDAwMDBfQVBETFQxMTEpCi9DIFswIDAgMCBdCi9GIDIKL0EgPDwNCi9OZXh0IFtdCi9TIC9Hb1RvCi9EIFs0IDAgUiAvWFlaIDAgNzkyIDEgXQo+PgovUGFyZW50IDQyIDAgUgo+PgplbmRvYmoKeHJlZgowIDQ0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAyMyAwMDAwMCBuIAowMDAwMDAwMjAzIDAwMDAwIG4gCjAwMDAwMDA0MDAgMDAwMDAgbiAKMDAwMDAwMDQ1OSAwMDAwMCBuIAowMDAwMDAxNTY1IDAwMDAwIG4gCjAwMDAwMDE2NjggMDAwMDAgbiAKMDAwMDAwMTcyMiAwMDAwMCBuIAowMDAwMDAyMTU4IDAwMDAwIG4gCjAwMDAwMDIyMTIgMDAwMDAgbiAKMDAwMDAwMjMxNSAwMDAwMCBuIAowMDAwMDAzMDgxIDAwMDAwIG4gCjAwMDAwMDQyNzYgMDAwMDAgbiAKMDAwMDAwNDUzMyAwMDAwMCBuIAowMDAwMDA1MDA1IDAwMDAwIG4gCjAwMDAwMDU0ODcgMDAwMDAgbiAKMDAwMDAwNTk2MyAwMDAwMCBuIAowMDAwMDA2NDI1IDAwMDAwIG4gCjAwMDAwMDY4ODggMDAwMDAgbiAKMDAwMDAwNzM1NSAwMDAwMCBuIAowMDAwMDA3ODI4IDAwMDAwIG4gCjAwMDAwMDgyOTUgMDAwMDAgbiAKMDAwMDAwODc2MiAwMDAwMCBuIAowMDAwMDA5MjIxIDAwMDAwIG4gCjAwMDAwMDk2ODAgMDAwMDAgbiAKMDAwMDAxMDE0MyAwMDAwMCBuIAowMDAwMDEwNjA2IDAwMDAwIG4gCjAwMDAwMTEwNzEgMDAwMDAgbiAKMDAwMDAxMTUzMCAwMDAwMCBuIAowMDAwMDExOTg5IDAwMDAwIG4gCjAwMDAwMTI0NTIgMDAwMDAgbiAKMDAwMDAxMjkxNSAwMDAwMCBuIAowMDAwMDEzMzgwIDAwMDAwIG4gCjAwMDAwMTM0MjIgMDAwMDAgbiAKMDAwMDAxMzUwMyAwMDAwMCBuIAowMDAwMDEzNTUyIDAwMDAwIG4gCjAwMDAwMTQwOTAgMDAwMDAgbiAKMDAwMDAxNDEzOSAwMDAwMCBuIAowMDAwMDE0NDkwIDAwMDAwIG4gCjAwMDAwMTQ1MzkgMDAwMDAgbiAKMDAwMDAxNTAyMSAwMDAwMCBuIAowMDAwMDE1MDU1IDAwMDAwIG4gCjAwMDAwMTYyMjggMDAwMDAgbiAKMDAwMDAxNjMwNCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDQ0Ci9Sb290IDIgMCBSCi9JbmZvIDEgMCBSCi9JRCBbPDU3MTBENjJBQjIxNjM3OTkxMjIyMEU0RTg2NzFEQThFPjw1NzEwRDYyQUIyMTYzNzk5MTIyMjBFNEU4NjcxREE4RT5dCj4+CnN0YXJ0eHJlZgoxNjUwOQolJUVPRg==\",\r\n        \"documentType\": \"pdf\"\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"ca94c02a-53c3-456f-9f2d-9803c4f17cde","name":"Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"1234\",\n    \"invoiceNumber\": \"\",\n    \"purchaseOrderNumber\": \"\",\n    \"totalAmount\": \"300.00\",\n    \"invoiceDate\": \"2/1/2025\",\n    \"receivedDate\": \"2/4/2025\",\n    \"memo1\": \"\",\n    \"memo2\": \"\",\n    \"bankName\": \"\",\n    \"bankAccount\": \"\",\n    \"checkNumber\": \"111\",\n    \"checkDate\": \"2/4/2025\",\n    \"branchNumber\": \"99\",\n    \"CustomerNumber\": \"44\",\n    \"paymentDetail\": [\n        {\n            \"glAccountNumber\": \"1\",\n            \"amount\": \"200.00\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddInstantCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"The payment detail total must equal the check amount.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"8689bfaa-6ce2-4191-8764-dc984ee11d50"},{"name":"ManualCheckAdd","id":"bf910b62-a4ee-425b-9105-ee05eba6ba08","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"branchNumber\":\"99\",\r\n    \"CustomerNumber\": \"44\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"2\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/AddManualCheck","description":"<h3 id=\"add-manual-check\">Add Manual Check</h3>\n<p>This endpoint allows you to record a manual check that has already been printed for book keeping.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<ul>\n<li><p><code>token</code> (string): The token for authentication.</p>\n</li>\n<li><p><code>invoiceNumber</code> (string): The invoice number.</p>\n</li>\n<li><p><code>purchaseOrderNumber</code> (string): The purchase order number.</p>\n</li>\n<li><p><code>totalAmount</code> (decimal): The total amount of the check.</p>\n</li>\n<li><p><code>invoiceDate</code> (date): The date of the invoice.</p>\n</li>\n<li><p><code>receivedDate</code> (date): The date when the check was received.</p>\n</li>\n<li><p><code>memo1</code> (string): Additional memo information.</p>\n</li>\n<li><p><code>memo2</code> (string): Additional memo information.</p>\n</li>\n<li><p><code>bankName</code> (string): The bank used for the check.</p>\n</li>\n<li><p><code>bankAccount</code> (string): The bank account used for the check. Must exist for the check branch number.</p>\n</li>\n<li><p><code>checkNumber</code> (long): The check number.</p>\n</li>\n<li><p><code>checkDate</code> (date): The date of the check.</p>\n</li>\n<li><p><code>CHECK TYPES</code> Customer, Vendor, One Time, Account</p>\n<ul>\n<li><p>Customer</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The check branch number.</p>\n</li>\n<li><p><code>customerNumber</code> (int): The customer number.</p>\n</li>\n</ul>\n</li>\n<li><p>Vendor</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The check branch number.</p>\n</li>\n<li><p><code>vendorCode</code> (string): The vendor code.</p>\n</li>\n</ul>\n</li>\n<li><p>One Time</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The check branch number.</p>\n</li>\n<li><p><code>payeeName</code> (string): The name printed on the check.</p>\n</li>\n<li><p><code>phoneNumber</code> (string): The payee phone number.</p>\n</li>\n<li><p><code>addressLine1</code> (string): Payee street address</p>\n</li>\n<li><p><code>addressLine2</code> (string): Payee apt, unit, or suite</p>\n</li>\n<li><p><code>addressLine3</code> (string): Payee PO box or additional information</p>\n</li>\n<li><p><code>city</code> (string): City of the payee address</p>\n</li>\n<li><p><code>state</code> (string): State abbreviation or full name of the payee address</p>\n</li>\n<li><p><code>zipCode</code> (string): Postal code of the payee address</p>\n</li>\n<li><p><code>country</code> (string): Country of the payee address. Options: United States, Canada, Mexico</p>\n</li>\n<li><p><code>language</code> (string): Preferred language. Options: English, Spanish, French</p>\n</li>\n</ul>\n</li>\n<li><p>Account</p>\n<ul>\n<li><p><code>accountNumber</code> (long): The account to apply the check transaction. The account branch will be used for the check.</p>\n</li>\n<li><p><code>transactionCode</code> (string): The transaction code to use when applying the check transaction.</p>\n</li>\n<li><p><code>customerPayeeType</code> (string): The name to print as the payee. Options: Customer_Primary_Only = 1, Customer_Primary_And_Spouse_Or_CoSigner = 2</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p><code>paymentDetail</code> (list): List of general ledger distribution. Total must equal the check amount.</p>\n<ul>\n<li><p><code>paymentDetail.glAccountNumber</code> (int): The GL account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glBranchNumber</code> (int): The branch account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glClassNumber</code> (int): The class account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glPortfolioNumber</code> (int): The portfolio account for the payment detail. System must have portfolio turned on.</p>\n</li>\n<li><p><code>paymentDetail.amount</code> (decimal): The amount for the current payment detail.</p>\n</li>\n</ul>\n</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<ul>\n<li><p><code>Status</code>: 200</p>\n</li>\n<li><p><code>Content-Type</code>: application/json</p>\n</li>\n<li><p>Sample:</p>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n\"statusCode\": \"0\",\n\"status\": \"Ok\",\n\"data\": {\n    \"checkNumber\" : \"1234\",\n    \"voucherNumber\" : \"777\"\n  },\n\"errors\": [],\n\"warnings\": []\n}\n\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","client","accountspayable","AddManualCheck"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ef57cce1-947e-4e35-a671-0cb03453fed4","name":"Customer Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"branchNumber\":\"99\",\r\n    \"CustomerNumber\": \"44\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"3\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddManualCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"voucherNumber\": 944,\n        \"checkNumber\": 4004\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"543bb8d3-4de5-4996-8a24-ff2651b77551","name":"Vendor Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"branchNumber\":\"99\",\r\n    \"VendorCode\": \"v1\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"3\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddManualCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 944,\r\n        \"checkNumber\": 4004\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"2be0282a-5ae8-4e72-a000-3ed7834e7047","name":"One Time Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"branchNumber\":\"99\",\r\n    \"payeeName\": \"My Name\",\r\n    \"phoneNumber\": \"9991234567\",\r\n    \"addressLine1\": \"2400 E Katella Ave\",\r\n    \"addressLine2\": \"Suite 550\",\r\n    \"addressLine3\": \"\",\r\n    \"city\": \"Anaheim\",\r\n    \"state\": \"CA\",\r\n    \"zipCode\" : \"92806\",\r\n    \"country\" : \"United States\",\r\n    //English = 1\r\n    //Spanish = 2\r\n    //French = 3\r\n    \"language\" : \"English\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddManualCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 944,\r\n        \"checkNumber\": 4004\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"527e4027-8a7a-4f24-b578-ffe16e1c7a06","name":"Account Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"bankName\":\"\",\r\n    \"bankAccount\":\"\",\r\n    \"checkNumber\":\"111\",\r\n    \"checkDate\":\"2/4/2025\",\r\n    \"accountNumber\": \"1\",\r\n    \"transactionCode\": \"check\",\r\n    //Customer_Primary_Only = 1\r\n    //Customer_Primary_And_Spouse_Or_CoSigner = 2\r\n    \"customerPayeeType\": \"Customer_Primary_And_Spouse_Or_CoSigner\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddManualCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 944,\r\n        \"checkNumber\": 4004\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"0217eeec-862c-4440-afaf-ad7fdd6b8ce8","name":"Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"1234\",\n    \"invoiceNumber\": \"\",\n    \"purchaseOrderNumber\": \"\",\n    \"totalAmount\": \"300.00\",\n    \"invoiceDate\": \"2/1/2025\",\n    \"receivedDate\": \"2/4/2025\",\n    \"memo1\": \"\",\n    \"memo2\": \"\",\n    \"bankName\": \"\",\n    \"bankAccount\": \"\",\n    \"checkNumber\": \"111\",\n    \"checkDate\": \"2/4/2025\",\n    \"branchNumber\": \"99\",\n    \"CustomerNumber\": \"44\",\n    \"paymentDetail\": [\n        {\n            \"glAccountNumber\": \"1\",\n            \"amount\": \"200.00\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddManualCheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"The payment detail total must equal the check amount.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"bf910b62-a4ee-425b-9105-ee05eba6ba08"},{"name":"PositivePayBatchGet","id":"f8737926-95a1-4d93-90fc-f0684d7c3947","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/PositivePayBatch/{{positive_pay_batch_number_or_id}}","description":"<h3 id=\"get-positive-pay-batch\">Get Positive Pay Batch</h3>\n<p>Returns a single <code>AccountsPayable.PositivePayBatch</code> row by its batch number or Guid <code>Id</code>. Wraps <code>PositivePayBatchWSServices.GetPositivePayBatchWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/PositivePayBatch/{batchNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>batchNumberOrId</em></td>\n<td>Required string. Positive Pay batch number or <code>Id</code> (Guid). Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","PositivePayBatch","{{positive_pay_batch_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7074d542-aa9a-459c-b722-9d1f82bf3247","name":"GetPositivePayBatch - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/PositivePayBatch/{{positive_pay_batch_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"BatchNumber\": 100,\n        \"BankAccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"BranchDate\": \"2026-04-18T00:00:00\",\n        \"ServerDt\": \"2026-04-18T12:00:00\",\n        \"CreatedByUserId\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"7f2c44fc-bb55-4132-80f2-7f71db04f41e","name":"GetPositivePayBatch - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/PositivePayBatch/999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Positive pay batch not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f8737926-95a1-4d93-90fc-f0684d7c3947"},{"name":"PrintChecks","id":"69744528-a276-449f-8c88-1075358b95b0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"voucherNumberOrIds\": [\n        \"{{voucher_number_or_id}}\"\n    ],\n    \"startingCheckNumber\": 1001,\n    \"checkDate\": \"2025-01-31\",\n    \"voucherType\": 1,\n    \"description\": \"AP check run 2025-01-31\",\n    \"folderId\": null,\n    \"returnPdf\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Check/PrintBatch","description":"<h3 id=\"print-checks-batch\">Print Checks (Batch)</h3>\n<p>Prints a batch of checks for one or more disbursed AP vouchers. All vouchers referenced in <code>voucherNumberOrIds</code> must already be in <strong>Disbursed</strong> status (call <code>api/Client/AccountsPayable/Voucher/Disburse</code> first) and must belong to the branch identified by <code>branchNumberOrId</code>. The server resolves the bank account via <code>SharedWSServices.GetAccountsPayableBankAccountId</code> and the branch via <code>SharedWSServices.GetSetupBranchId</code>, splits the batch into <strong>paper</strong> and <strong>electronic</strong> vouchers based on each payee's payment method, and prints each group against the check form configured on the AP External Master Configuration. When any paper checks are present, <code>startingCheckNumber</code> is required and the server assigns sequential check numbers starting from that value. This endpoint is gated by permission <code>8C6E5986-8D9F-4A7F-9FE0-3EC7BB4AAECE</code> and serializes concurrent runs per bank account via <code>PrintCheckLockService</code> to prevent check-number collisions. When <code>returnPdf=true</code>, the paper-check PDF is returned as base64 in <code>document</code>; the electronic payment file (when present) is returned in <code>electronicDocument</code>. Wraps <code>AccountsPayableWSServices.API_PrintChecks</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/Check/PrintBatch</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>bankAccountNumberOrId</em></td>\n<td>Required string. AP bank account number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Required string. Branch number or <code>Id</code> (Guid). All selected vouchers must belong to this branch.</td>\n</tr>\n<tr>\n<td><em>voucherNumberOrIds</em></td>\n<td>Required string array. Voucher numbers or <code>Id</code>s to print. Each voucher must be in <code>Disbursed</code> status.</td>\n</tr>\n<tr>\n<td><em>startingCheckNumber</em></td>\n<td>Optional long. Required when any paper checks are present. First check number assigned to the paper batch; subsequent paper checks are numbered sequentially.</td>\n</tr>\n<tr>\n<td><em>checkDate</em></td>\n<td>Optional ISO 8601 date. Check print date. Defaults to the login's current business date when omitted.</td>\n</tr>\n<tr>\n<td><em>voucherType</em></td>\n<td>Optional integer. <code>Omega.AccountsPayable.Types.Enums.VoucherType</code> value. Defaults to <code>Accounts_Payable</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Free-text batch description stored with the printed batch record.</td>\n</tr>\n<tr>\n<td><em>folderId</em></td>\n<td>Optional Guid. <code>Global.Folder</code> <code>Id</code> where the printed document(s) are dropped when <code>returnPdf=false</code>.</td>\n</tr>\n<tr>\n<td><em>returnPdf</em></td>\n<td>Optional boolean. Defaults to <code>true</code>. When <code>true</code>, the check documents are returned inline as base64; when <code>false</code>, they are written to the folder identified by <code>folderId</code> instead.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response Data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>voucherCount</em></td>\n<td>Total number of vouchers processed.</td>\n</tr>\n<tr>\n<td><em>voucherNumbers</em></td>\n<td>Array of voucher numbers that were printed.</td>\n</tr>\n<tr>\n<td><em>paperCheckCount</em></td>\n<td>Number of paper checks printed.</td>\n</tr>\n<tr>\n<td><em>electronicCheckCount</em></td>\n<td>Number of electronic payments generated.</td>\n</tr>\n<tr>\n<td><em>checkNumbers</em></td>\n<td>Array of check numbers assigned to the paper batch.</td>\n</tr>\n<tr>\n<td><em>document</em></td>\n<td>Base64 PDF containing the paper checks (present when <code>returnPdf=true</code> and paper checks exist).</td>\n</tr>\n<tr>\n<td><em>documentType</em></td>\n<td><code>\"pdf\"</code> when <code>document</code> is present.</td>\n</tr>\n<tr>\n<td><em>electronicDocument</em></td>\n<td>Base64 payment file for electronic checks (present when electronic payments exist).</td>\n</tr>\n<tr>\n<td><em>electronicDocumentType</em></td>\n<td>File type of <code>electronicDocument</code> (for example <code>\"txt\"</code> or <code>\"xml\"</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","Check","PrintBatch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d42e47b0-f8da-4962-8e36-70a4d12bd525","name":"PrintChecks - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"voucherNumberOrIds\": [\n        \"{{voucher_number_or_id}}\"\n    ],\n    \"startingCheckNumber\": 1001,\n    \"checkDate\": \"2025-01-31\",\n    \"voucherType\": 1,\n    \"description\": \"AP check run 2025-01-31\",\n    \"folderId\": null,\n    \"returnPdf\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Check/PrintBatch"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"voucherCount\": 1,\n        \"voucherNumbers\": [\n            \"100001\"\n        ],\n        \"paperCheckCount\": 1,\n        \"electronicCheckCount\": 0,\n        \"checkNumbers\": [\n            1001\n        ],\n        \"document\": \"JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PgplbmRvYmoK...\",\n        \"documentType\": \"pdf\",\n        \"electronicDocument\": null,\n        \"electronicDocumentType\": null\n    }\n}"},{"id":"22ce1f55-c32f-40c9-8003-e2077ccba21f","name":"PrintChecks - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"bankAccountNumberOrId\": \"{{bank_account_number_or_id}}\",\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"voucherNumberOrIds\": [\n        \"{{voucher_number_or_id}}\"\n    ],\n    \"startingCheckNumber\": null,\n    \"checkDate\": \"2025-01-31\",\n    \"voucherType\": 1,\n    \"description\": \"AP check run 2025-01-31\",\n    \"folderId\": null,\n    \"returnPdf\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Check/PrintBatch"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Starting check number is required when printing paper checks.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"69744528-a276-449f-8c88-1075358b95b0"},{"name":"ReprintCheck","id":"01b171b9-91a2-4f9c-86c7-d15e51fa47da","request":{"method":"POST","header":[{"key":"publicKey","value":"ca6368a8-c7c4-4181-a026-46f7ba5a99eb"},{"key":"timeStamp","value":"1765484631542"},{"key":"signature","value":"b8f5f1cfb584aece434b170eed362db1219c80eea9f031b2789b437858a2c523c094f192e5186511652e6f6d6ac6e25d4715c1bbbe3e977e25dd140911c488b2"}],"body":{"mode":"raw","raw":"{\r\n    \"bankAccount\":\"98532633\",\r\n    \"checkNumber\": \"65480\",\r\n    \"newCheckNumber\": \"65481\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/ReprintCheck","description":"<h1 id=\"reprintcheck-endpoint\">ReprintCheck Endpoint</h1>\n<h2 id=\"overview\">Overview</h2>\n<p>The ReprintCheck endpoint allows you to reprint an existing check with a new check number. This is useful when a check needs to be reissued due to loss, damage, or other circumstances requiring a replacement check with a different number. The endpoint returns the reprinted check as a PDF document encoded in base64 format.</p>\n<h2 id=\"request-body-parameters\">Request Body Parameters</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>token</code></td>\n<td>string</td>\n<td>No</td>\n<td>Authentication token used to authorize the request. This token is required if not using the dynamic signature method.</td>\n</tr>\n<tr>\n<td><code>bankAccount</code></td>\n<td>string</td>\n<td>Yes</td>\n<td>The full bank account used to print the check.</td>\n</tr>\n<tr>\n<td><code>checkNumber</code></td>\n<td>int64</td>\n<td>Yes</td>\n<td>The original check number that you want to reprint. This identifies the existing check in the system.</td>\n</tr>\n<tr>\n<td><code>newCheckNumber</code></td>\n<td>int64</td>\n<td>Yes</td>\n<td>The new check number to assign to the reprinted check. This will be the check number on the newly generated document.</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"response-structure\">Response Structure</h2>\n<p>The endpoint returns a JSON response with the following structure:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"checkNumber\": 65480,\n    \"originalCheckNumber\": 65478,\n    \"document\": \"JVBERi0xLjcKJdDExrTOxdSghIKAgAoxIDAgb2Jq...\",\n    \"documentType\": \"pdf\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}\n\n</code></pre>\n<h3 id=\"response-fields\">Response Fields</h3>\n<ul>\n<li><p><strong>statusCode</strong> (integer): Status code indicating the result of the operation. <code>0</code> indicates success.</p>\n</li>\n<li><p><strong>result</strong> (string): Human-readable result message (e.g., \"Ok\" for successful operations).</p>\n</li>\n<li><p><strong>data</strong> (object): Contains the check reprint information:</p>\n<ul>\n<li><p><strong>checkNumber</strong> (integer): The new check number assigned to the reprinted check.</p>\n</li>\n<li><p><strong>originalCheckNumber</strong> (integer): The original check number that was reprinted.</p>\n</li>\n<li><p><strong>document</strong> (string): The PDF document of the reprinted check, encoded in <strong>base64 format</strong>. Decode this string to obtain the actual PDF file.</p>\n</li>\n<li><p><strong>documentType</strong> (string): The format of the document (typically \"pdf\").</p>\n</li>\n</ul>\n</li>\n<li><p><strong>errors</strong> (array): Array of error messages. Empty if the operation was successful.</p>\n</li>\n<li><p><strong>warnings</strong> (array): Array of warning messages. Empty if there are no warnings.</p>\n</li>\n</ul>\n<h2 id=\"example-use-case\">Example Use Case</h2>\n<p>A customer reports that check #65478 was lost in the mail. You need to reprint the check with a new check number #65480 to prevent potential fraud from the lost check. Using this endpoint, you can:</p>\n<ol>\n<li><p>Provide the original check number (65478)</p>\n</li>\n<li><p>Specify the new check number (65480)</p>\n</li>\n<li><p>Receive a PDF document of the reprinted check with the new number</p>\n</li>\n<li><p>The system maintains a record linking the original and new check numbers for audit purposes</p>\n</li>\n</ol>\n<h2 id=\"important-notes\">Important Notes</h2>\n<ul>\n<li><p><strong>PDF Document Format</strong>: The <code>document</code> field in the response contains the check PDF encoded in base64 format. You must decode this base64 string to obtain the actual PDF file that can be viewed or printed.</p>\n</li>\n<li><p><strong>Check Number Validation</strong>: Ensure that the new check number is unique and not already in use in the system.</p>\n</li>\n<li><p><strong>Audit Trail</strong>: The system maintains a record of the original check number and the new check number for tracking and auditing purposes.</p>\n</li>\n<li><p><strong>Error Handling</strong>: Always check the <code>errors</code> array in the response. If errors are present, the <code>statusCode</code> will be non-zero and the operation may not have completed successfully.</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","client","accountspayable","ReprintCheck"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b3b2b1d9-b7cd-433e-b9c1-95e35fec3d44","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"publicKey","value":"ca6368a8-c7c4-4181-a026-46f7ba5a99eb"},{"key":"timeStamp","value":"1765484631542"},{"key":"signature","value":"b8f5f1cfb584aece434b170eed362db1219c80eea9f031b2789b437858a2c523c094f192e5186511652e6f6d6ac6e25d4715c1bbbe3e977e25dd140911c488b2"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"cc3468b5-f830-411c-979c-8272121c8e10\",\r\n    \"checkNumber\": \"65478\",\r\n    \"newCheckNumber\": \"65480\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/ReprintCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudHNwYXlhYmxlXFJlcHJpbnRDaGVjaw==?="},{"key":"Date","value":"Thu, 11 Dec 2025 20:12:34 GMT"},{"key":"Content-Length","value":"10438"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"checkNumber\": 65480,\n        \"originalCheckNumber\": 65478,\n        \"document\": \"JVBERi0xLjcKJdDExrTOxdSghIKAgAoxIDAgb2JqCjw8DQovQ3JlYXRvciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9Qcm9kdWNlciAoQWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjApCi9DcmVhdGlvbkRhdGUgKEQ6MjAxMjA5MDQwOTMwNTQtMDcnMDAnKQovTW9kRGF0ZSAoRDoyMDE2MDkyODA4MTQzNi0wNycwMCcpCj4+CmVuZG9iagoyIDAgb2JqCjw8DQovQWNyb0Zvcm0gNDAgMCBSCi9OYW1lcyAzMiAwIFIKL0V4dGVuc2lvbnMgPDwNCi9BREJFIDw8DQovRXh0ZW5zaW9uTGV2ZWwgMwovQmFzZVZlcnNpb24gLzEuNwo+Pgo+PgovUGFnZXMgMyAwIFIKL01ldGFkYXRhIDQxIDAgUgovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiAvMS43Ci9PdXRsaW5lcyA0MiAwIFIKPj4KZW5kb2JqCjMgMCBvYmoKPDwNCi9LaWRzIFs0IDAgUiBdCi9Db3VudCAxCi9UeXBlIC9QYWdlcwo+PgplbmRvYmoKNCAwIG9iago8PA0KL0NvbnRlbnRzIFs1IDAgUiA2IDAgUiA3IDAgUiA4IDAgUiA5IDAgUiAxMCAwIFIgXQovUmVzb3VyY2VzIDw8DQovRm9udCA8PA0KL1QxXzEgMTEgMCBSCi9UMV8wIDEzIDAgUgo+PgovUHJvY1NldCBbL1BERiAvVGV4dCBdCi9YT2JqZWN0IDw8DQovMkI4MUJGODctRTQ4Mi00OEE3LUE5RjYtOEU5QUYzMzg0QUYwIDE1IDAgUgovOUJBNDUwNDctRUVDRS00QkUwLUJGNjgtQzBCOUIwM0Y4QTlDIDE2IDAgUgovNUQyMERDMDAtRjE5OS00REU4LUE2RjktMUNGNDI2QjQ3MjEwIDE3IDAgUgovQjFBM0E3NzQtMTFBRC00QjZFLTlGNEItMEFEMkZBREMwQjZBIDE4IDAgUgovODE2MjUwNDgtN0FBOC00M0UzLTlCQ0UtRkQzN0UxNTI5MTBFIDE5IDAgUgovN0YyODU5QTctMUY0Mi00MkUyLUEzMDYtOTBGMkExNTA5Q0NEIDIwIDAgUgovQjU5MzlCQ0YtODBEMy00RkRGLTgwM0MtRjU3NTZEMkRFNzU1IDIxIDAgUgovMjFDQkVGQjMtOTk3MS00QkM4LTg0M0YtQ0E5N0QyMUVERTZGIDIyIDAgUgovNjQyREZCNDEtMDc0Ny00ODM2LTgyOUMtODI3MTk5NjE4OTdGIDIzIDAgUgovODIxM0Q1OUUtMzA2My00MEZGLTlGQzAtRDE2NzE0RTZDQTY3IDI0IDAgUgovNzVCMjc3ODEtNkRGMS00OTNCLUJBRkEtNjMxNTFDQkI0Mjg5IDI1IDAgUgovOUQzOTFGMzYtMEVBNS00NDJELTlFQ0ItMTZFOTk2OUE4MkVEIDI2IDAgUgovQzI0NjFCODUtODg3Qy00NDZCLUJDODYtNTVEQUY2RjI1NzQ0IDI3IDAgUgovNzgwOTI3QTYtNDVBQi00QTM3LThFRTktRjk0OTMzMzRFQkI4IDI4IDAgUgovNEI4NEYwRkMtQUY1NS00MjVELThCNzktNDk4NDBEQzRENzQ1IDI5IDAgUgovOUY0N0Y3MEQtRkMxQi00ODM2LUEwMTUtQTlBMDFGRjc3RTk2IDMwIDAgUgovNDRDNEJGOTUtOUVCQy00MUQ0LTgxNjgtOEZERjJENjY4ODkxIDMxIDAgUgo+Pgo+PgovQW5ub3RzIFtdCi9NZWRpYUJveCBbMCAwIDYxMiA3OTIgXQovQ3JvcEJveCBbMCAwIDYxMiA3OTIgXQovUm90YXRlIDAKL1R5cGUgL1BhZ2UKL1BhcmVudCAzIDAgUgo+PgplbmRvYmoKNSAwIG9iago8PA0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAzMQo+PgpzdHJlYW0KeJxTKOQyVDAAQhBpbmmkkJwLFdCFUEB+IBcAh18HDgplbmRzdHJlYW0KZW5kb2JqCjYgMCBvYmoKPDwNCi9MZW5ndGggNAo+PgpzdHJlYW0KIHEgCgplbmRzdHJlYW0KZW5kb2JqCjcgMCBvYmoKPDwNCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMzI0Cj4+CnN0cmVhbQpIieRSTUvEMBS8B/wP7+ChFpptvprGm7sVQURwzVGQukaJNFvsh/5903aXLWx13YMnk0NCMvPe8GbmGsXQ7eoVzZamyBv7YRZlUVbWmaayK6gsmmnyGAMB/YLIgPYHEQKnTABXErRDQZY35vxMv/l6EeWYgc5Gj4xjRSVwioWHP6PgNAy794hLnCQKot3PTZmvIbP1U1vVxpl10+E6CWSQ4OszLBXtGyzauimdqTpMAL9cPfg2d+Yo1qH1cPKHlTqlflSCET/9fn5w4cp2GM7l1sTllb9YiDGHT6BwDegdyGAY0BRzIoES70TKYOV6jkOcYcqUvxboHt2NCERQzIXYZ9AEx2KKIWJvDE0ne6Qjxlwj4mVO52qjcxurQ2nQ4b8JwSYDjKrvMmAnDOdCHmn4HuMHwwmWcTrZY2z4lwADAL/X1ZsKZW5kc3RyZWFtCmVuZG9iago4IDAgb2JqCjw8DQovTGVuZ3RoIDQKPj4Kc3RyZWFtCiBRIAoKZW5kc3RyZWFtCmVuZG9iago5IDAgb2JqCjw8DQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDMxCj4+CnN0cmVhbQp4nFMo5DJUMABCEGluaaSQnAsV0IVQQH4gFwCHXwcOCmVuZHN0cmVhbQplbmRvYmoKMTAgMCBvYmoKPDwNCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggNjY5Cj4+CnN0cmVhbQp4nJWVTW4rRwyE9zrFXICTJpvdJJf9x31WOUCQ5XsPL/dfhDOybEuyYQcGPAJUqK+7ikNtvy81b5XrThtK2YXLhrzz9u8/21/bzwtuKf5wexX9/ePyB3XF7iqwWAlYm0Azr6DLmues3Dxt89dl+/Py4o8Sll/5n6LD33rjkjj811jAfSXoXhVG6tZTdm027v1r2uuX/qfo8C+T0hwpgaMZ8FwKrboBDmeqnYXw3flR866MG6vumstWy56JN8I950fMo/agdWy5iTAgthm3qQvMuUNqk7zFOXpt725TrhC7Psni0OFLH8AepAdLsVIkpyCtKXBeGaxHhj6zLCxkmNYbK4tuVXK0auGnj/5vXx/W4qTFomqMkIBpEbScKlhyaliSjTGfQyMu3w7tpj1DK5bj5A6aZgb2eXzKA7xIqZPmklLuRqCYnCOAn9V/FZzji6Mv7xGNCUYhQ0E5O4xmMgnXXNXfvMnOQ2FM//k8bpI/LuRBerAq0/TOCElinllzvCVkI/5JzF5FNXlmZbXvsm7Ss3zCPIstiFois+QegzYSTKyCvOpoVd41VK5pM0lUE5Rqey66YRgyPXX0oD4nonQSUYQ6PXK03KE3b1Azloi4M6k981D5f/Bu6nMtzGzokWBarQBHsmBrdMC6IkprSms+9/ZiYLiTfUZ70B6wQVyxawFVGQGrcbmhFUqZzatTEeYn2C2d78DuktRkJK0Cl9aBW5bYpcvALVLNmVfv+gYrqHvJ9PJuxtLjqh+8vveyA8Nd2ZMPaF4iQCoTtEtsQFOOhcjz2J6vGJZ0l0rYIMsnl3oUn305i0ua4AP7dfZbwhK/FfFwF1lWn3G3XL6Fex8i8+DuVmIoejSGkyHWYbzbsTxo1qpq+IL7D1RecF4KZW5kc3RyZWFtCmVuZG9iagoxMSAwIG9iago8PA0KL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKL1N1YnR5cGUgL1R5cGUxCi9Gb250RGVzY3JpcHRvciAxMiAwIFIKL1R5cGUgL0ZvbnQKL0Jhc2VGb250IC9NeXJpYWRQcm8tQm9sZAovV2lkdGhzIFs1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDIwMiAyNjggMzk3IDU1MCA1NTUgODgwIDY3OCAyMDUgMzE0IDMxNCA0NTQgNTk2IDI2MCAzMjIgMjYwIDMzMSA1NTUgNTU1IDU1NSA1NTUgNTU1IDU1NSA1NTUgNTU1IDU1NSA1NTUgMjYwIDI2MCA1OTYgNTk2IDU5NiA0NDUgNzcwIDY1NiA2MDQgNTk1IDY5NiA1MzQgNTI3IDY4MiA2ODkgMjg1IDQxMSA2MTQgNTExIDg0NiA2OTAgNzE3IDU4MSA3MTcgNTkzIDU0MCA1NDggNjgyIDYzNiA4ODggNjEzIDYwMyA1NzcgMzE0IDMzMCAzMTQgNTk2IDUwMCAzMDAgNTI4IDU5OCA0NTEgNTk2IDUyOCAzNDEgNTg1IDU4NiAyNzQgMjkxIDU0MiAyNzUgODYwIDU4NiA1NzcgNTk4IDU5NSAzODAgNDM0IDM2NyA1ODMgNTMwIDc1OSA1MTkgNTIzIDQ2OSAzMTQgMjgzIDMxNCA1OTYgMzM4IDU1NSAzMzggMjYwIDU1NSA0NTkgMTAwMCA1MjQgNTI0IDMwMCAxMjg1IDU0MCAyNzAgOTM2IDMzOCA1NzcgMzM4IDMzOCAyNjAgMjYwIDQ1NCA0NTQgMzM4IDUwMCAxMDAwIDMwMCA2NTAgNDM0IDI3MCA4NjggMzM4IDQ2OSA2MDMgMjAyIDI2OCA1NTUgNTU1IDU1NSA1NTUgMjgzIDU2MSAzMDAgNjc3IDM3OCA0NjUgNTk2IDMyMiA0NTkgMzAwIDM1NiA1OTYgMzUyIDM0NyAzMDAgNTg1IDU0MiAyNjAgMzAwIDMwMCAzODYgNDY1IDgzMSA4MzEgODMxIDQ0NSA2NTYgNjU2IDY1NiA2NTYgNjU2IDY1NiA4NjggNTk3IDUzNCA1MzQgNTM0IDUzNCAyODUgMjg1IDI4NSAyODUgNzA0IDY5MCA3MTcgNzE3IDcxNyA3MTcgNzE3IDU5NiA3MTcgNjgyIDY4MiA2ODIgNjgyIDYwMyA1ODAgNjAwIDUyOCA1MjggNTI4IDUyOCA1MjggNTI4IDgwMyA0NTEgNTI4IDUyOCA1MjggNTI4IDI3NCAyNzQgMjc0IDI3NCA1NzQgNTg2IDU3NyA1NzcgNTc3IDU3NyA1NzcgNTk2IDU3NyA1ODMgNTgzIDU4MyA1ODMgNTIzIDU5OCA1MjMgXQovRmlyc3RDaGFyIDAKL0xhc3RDaGFyIDI1NQo+PgplbmRvYmoKMTIgMCBvYmoKPDwNCi9Gb250V2VpZ2h0IDcwMAovWEhlaWdodCA0ODkKL0Rlc2NlbnQgLTI1MAovRm9udE5hbWUgL015cmlhZFByby1Cb2xkCi9Bc2NlbnQgOTg5Ci9DYXBIZWlnaHQgNjc0Ci9Gb250QkJveCBbLTE2MyAtMjUwIDEyNTYgOTg5IF0KL0ZvbnRGYW1pbHkgKE15cmlhZCBQcm8pCi9GbGFncyAzMgovRm9udFN0cmV0Y2ggL05vcm1hbAovU3RlbVYgMTUyCi9JdGFsaWNBbmdsZSAwCi9UeXBlIC9Gb250RGVzY3JpcHRvcgo+PgplbmRvYmoKMTMgMCBvYmoKPDwNCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9TdWJ0eXBlIC9UeXBlMQovRm9udERlc2NyaXB0b3IgMTQgMCBSCi9UeXBlIC9Gb250Ci9CYXNlRm9udCAvTXlyaWFkUHJvLVJlZ3VsYXIKL1dpZHRocyBbNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCA1MDAgNTAwIDUwMCAyMTIgMjMwIDMzNyA0OTcgNTEzIDc5MiA2MDUgMTg4IDI4NCAyODQgNDE1IDU5NiAyMDcgMzA3IDIwNyAzNDMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDUxMyA1MTMgNTEzIDIwNyAyMDcgNTk2IDU5NiA1OTYgNDA2IDczNyA2MTIgNTQyIDU4MCA2NjYgNDkyIDQ4NyA2NDYgNjUyIDIzOSAzNzAgNTQyIDQ3MiA4MDQgNjU4IDY4OSA1MzIgNjg5IDUzOCA0OTMgNDk3IDY0NyA1NTggODQ2IDU3MSA1NDEgNTUzIDI4NCAzNDEgMjg0IDU5NiA1MDAgMzAwIDQ4MiA1NjkgNDQ4IDU2NCA1MDEgMjkyIDU1OSA1NTUgMjM0IDI0MyA0NjkgMjM2IDgzNCA1NTUgNTQ5IDU2OSA1NjMgMzI3IDM5NiAzMzEgNTUxIDQ4MSA3MzYgNDYzIDQ3MSA0MjggMjg0IDIzOSAyODQgNTk2IDI4MiA1MTMgMjgyIDIwNyA1MTMgMzU2IDEwMDAgNTAwIDUwMCAzMDAgMTE1NiA0OTMgMjU1IDg5NCAyODIgNTUzIDI4MiAyODIgMjA3IDIwNyAzNTQgMzU0IDI4MiA1MDAgMTAwMCAzMDAgNjE5IDM5NiAyNTUgODYzIDI4MiA0MjggNTQxIDIxMiAyMzAgNTEzIDUxMyA1MTMgNTEzIDIzOSA1MTkgMzAwIDY3NyAzNDYgNDE5IDU5NiAzMDcgNDE5IDMwMCAzMTggNTk2IDMxMSAzMDUgMzAwIDU1MyA1MTIgMjA3IDMwMCAyNDQgMzU1IDQxOSA3NTkgNzU5IDc1OSA0MDYgNjEyIDYxMiA2MTIgNjEyIDYxMiA2MTIgNzg4IDU4NSA0OTIgNDkyIDQ5MiA0OTIgMjM5IDIzOSAyMzkgMjM5IDY3MSA2NTggNjg5IDY4OSA2ODkgNjg5IDY4OSA1OTYgNjg5IDY0NyA2NDcgNjQ3IDY0NyA1NDEgNTMxIDU0OCA0ODIgNDgyIDQ4MiA0ODIgNDgyIDQ4MiA3NzMgNDQ3IDUwMSA1MDEgNTAxIDUwMSAyMzQgMjM0IDIzNCAyMzQgNTQxIDU1NSA1NDkgNTQ5IDU0OSA1NDkgNTQ5IDU5NiA1NDkgNTUxIDU1MSA1NTEgNTUxIDQ3MSA1NjkgNDcxIF0KL0ZpcnN0Q2hhciAwCi9MYXN0Q2hhciAyNTUKPj4KZW5kb2JqCjE0IDAgb2JqCjw8DQovRm9udFdlaWdodCA0MDAKL1hIZWlnaHQgNDg0Ci9EZXNjZW50IC0yNTAKL0ZvbnROYW1lIC9NeXJpYWRQcm8tUmVndWxhcgovQXNjZW50IDk1MgovQ2FwSGVpZ2h0IDY3NAovRm9udEJCb3ggWy0xNTcgLTI1MCAxMTI2IDk1MiBdCi9Gb250RmFtaWx5IChNeXJpYWQgUHJvKQovRmxhZ3MgMzIKL0ZvbnRTdHJldGNoIC9Ob3JtYWwKL1N0ZW1WIDg4Ci9JdGFsaWNBbmdsZSAwCi9UeXBlIC9Gb250RGVzY3JpcHRvcgo+PgplbmRvYmoKMTUgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzBEODQ3OUI2RjY2MzQyNkRBM0U1NzU2ODg2N0MwMzgzCi9CQm94IFswIDAgMTc1Ljc0NSAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDEzIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8wRDg0NzlCNkY2NjM0MjZEQTNFNTc1Njg4NjdDMDM4MykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExOAo+PgpzdHJlYW0KeJw9zLEKwjAYReH9PsUddTBN0oQ6V7pZEPnFOZi2VmKFiKBvbxbdvrMcTc07TONV43xx+ts45UrqH644Y0Elb7b9Dq2g6j95DvGQH5vjML1SyDSaMpbLRFjWaltTIlbGestTmi/Dk/uwxDXlhk7Qlc8XSbseqgplbmRzdHJlYW0KZW5kb2JqCjE2IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8xQTVFRDE3MkMxQjg0RDI4OTQxRDg1NDU0QjEzNjU4RAovQkJveCBbMCAwIDE3NS43NDUgMTQuNCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMyAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMUE1RUQxNzJDMUI4NEQyODk0MUQ4NTQ1NEIxMzY1OEQpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjIKPj4Kc3RyZWFtCnicPczBCoJAFEbh/f8U/7KgxpkcGdeGUJAQcaG1YKlxTRgS6u2bTe2+szmWlhNcKEzwRbL+7bzxKe0PA654IpM3q2aPSpA1nzi23TnO28utX7SNdJZyT5ee2DE3ZU7psDqMqjrNy2vY8HiiD8GVa8oDtaBOry/acR/qCmVuZHN0cmVhbQplbmRvYmoKMTcgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtX0Q2ODkxQjJEOEQ1NzQzQzQ4ODc1NUE1QTlFMTE4MjBGCi9CQm94IFswIDAgMTc1Ljc0NSAxNC40IF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDEzIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9ENjg5MUIyRDhENTc0M0M0ODg3NTVBNUE5RTExODIwRikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExOAo+PgpzdHJlYW0KeJw9zLEKwjAURuH9f4p/1ME0sSl1rhSngMgV50LaWokGLij69mbR7TvLsbS8w7WNaX1TnP523viS9ocrLnigkje7sEcnqMJHlyEeNW9O4/xMg9JZylQuM7FlbXY1JWIVljRljTzzkPJr1DXlhl7Ql88XX/gfjQplbmRzdHJlYW0KZW5kb2JqCjE4IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV9DQUEyNUEyQzY4Mzk0ODg2OTVFRTBGRjk1N0E5M0IxQwovQkJveCBbMCAwIDY1LjMyNCAyMS4zMyBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMyAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fQ0FBMjVBMkM2ODM5NDg4Njk1RUUwRkY5NTdBOTNCMUMpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTMKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7Vwd3bGKLaRlAGRgdSBxBiJCguC/r3baHduc4XCO3ZVMN0WLj9qCmYl5a8rOjwQ/c26PaJ2xPaT53445efmPE6vpc9MQr+UzUQo90EPFX3AKqUoFlXU1vQbGkdTFl+UoxvNCmVuZHN0cmVhbQplbmRvYmoKMTkgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzBDMUMyMkRCRkZFQTRBRTA5ODg4MDUwQUQzMUI1RDM5Ci9CQm94IFswIDAgMjkwLjYxIDEyLjMzIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDEzIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV8wQzFDMjJEQkZGRUE0QUUwOTg4ODA1MEFEMzFCNUQzOSkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEzNAo+PgpzdHJlYW0KeJw9zL0KwjAYheH9u4oz6pA0TbXQtVpxKYh84BxI+iM1gZT4c/dm0e05w3kVFB6kGyXrMnP5sdSyqvJUf010I08Fv9H2B2qZiv4TZ2MvMYirG9NiIhrwkCsjSGMvdb0DW9rwK4CnkFbjLU7z0+GcvI3O4hiWfFsBCLEF36lj6nL9C4PSJpAKZW5kc3RyZWFtCmVuZG9iagoyMCAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fNUM2QkFBRTM1QzMzNDNEMjg1NTE2RUE4Q0FGMzZEMkYKL0JCb3ggWzAgMCA5MCAxOCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMyAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNUM2QkFBRTM1QzMzNDNEMjg1NTE2RUE4Q0FGMzZEMkYpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMDUKPj4Kc3RyZWFtCnicLcy7CoNAFEXR/nzFKZNC584MirYGS0HkgrXgG5PAQCD5e0dItaq9hcInyovjwhbRPyt6vGD0y6p5oFKY5he2YWzDO+mm5XMMgVaoc4wXwjFLc08dcbPWiDdOnL9Td9SKOh5OQ00Y5gplbmRzdHJlYW0KZW5kb2JqCjIxIDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV9GNzVFQTdDMEU4Mjg0NkUxOEY3Qzk0NTFCMEI1REZCQQovQkJveCBbMCAwIDY1LjMyNCAyMS4zMyBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMyAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fRjc1RUE3QzBFODI4NDZFMThGN0M5NDUxQjBCNURGQkEpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTMKPj4Kc3RyZWFtCnicPcyxCsJAEEXR/n3FK7Vwd3bGKLaRlAGRgdSBxBiJCguC/r3baHduc4XCO3ZVMN0WLj9qCmYl5a8rOjwQ/c26PaJ2xPaT53445efmPE6vpc9MQr+UzUQo90EPFX3AKqUoFlXU1vQbGkdTFl+UoxvNCmVuZHN0cmVhbQplbmRvYmoKMjIgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzE2QkI3MjhGNEYxMzQ3QjU4RkE0OUQyMTk3NTVBQjRECi9CQm94IFswIDAgMTcxIDE0LjQgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTMgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzE2QkI3MjhGNEYxMzQ3QjU4RkE0OUQyMTk3NTVBQjREKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTE0Cj4+CnN0cmVhbQp4nDXMzQqCUBRF4fl+ij2sgXqOV0qaZTgUIg40Fv8qLOGioG/fJWi01ugTCt/Qo4aOv2oWZ2HlPw/c8UFiK4vqgsKQVJt/1u3VT9GtG5ax9lSh9UEYiJQuzh2txe7cNPOJTkT1kMqe9kJpKIPyBTjwG3oKZW5kc3RyZWFtCmVuZG9iagoyMyAwIG9iago8PA0KL1R5cGUgL1hPYmplY3QKL1N1YnR5cGUgL0Zvcm0KL05hbWUgL0Zvcm1fRDM1NzQ5MUVDNTkzNDJFNTlBOEYwMjg3NzAxNjJGQzAKL0JCb3ggWzAgMCAxNjUuMzMgMTIuMzMgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTMgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtX0QzNTc0OTFFQzU5MzQyRTU5QThGMDI4NzcwMTYyRkMwKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTE4Cj4+CnN0cmVhbQp4nD3MsQrCQBBF0f59xSu1MJnZJRHtjKQMiAykDomJyqqwKOjfuxamuZzqCoU3aFlk3ieGP9X9GiCzzmhxR25vVs0elSFvPvHSDYf4WB1P0yt0kSq0MW0mwtFl601BG7DY9f1zSy+iWjpZ0q6oDXXafAET0x1BCmVuZHN0cmVhbQplbmRvYmoKMjQgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzc1MDVDMjFGNEZGQjQ4Q0FCNTIzODM5MTk3Nzg2RUQ1Ci9CQm94IFswIDAgMTY1LjMzIDEyLjMzIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDEzIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV83NTA1QzIxRjRGRkI0OENBQjUyMzgzOTE5Nzc4NkVENSkKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDExOAo+PgpzdHJlYW0KeJw9zLEKwkAQRdH+fcUrtTCZ2SUR7YykDIgMpA6JicqqsCjo37sWprmc6gqFN2hZZN4nhj/V/Rogs85ocUdub1bNHpUhbz7x0g2H+FgdT9MrdJEqtDFtJsLRZetNQRuw2PX9c0svolo6WdKuqA112nwBE9MdQQplbmRzdHJlYW0KZW5kb2JqCjI1IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV9EQjE5M0U3MTI2QkU0ODk5QTNBQUJDQTI5NDM2MkUxNwovQkJveCBbMCAwIDE2OS4zNTggMTkuODQyIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDEzIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV9EQjE5M0U3MTI2QkU0ODk5QTNBQUJDQTI5NDM2MkUxNykKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyMQo+PgpzdHJlYW0KeJxFzLEKwjAYReH9PsUdFTRNWlPatVKcAlJ+cC6krZVoIKDo25tJt48zHE3NO0zdqso22eFn06rmUOag/7ziggcKebNzR3SCwn3SOvpzivthWp5hTDSaMufTQpSslbWG4rE5hfia0o5uDXNMfku5oRf0+fMFzR4gWwplbmRzdHJlYW0KZW5kb2JqCjI2IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV85MTU1MDlCREJGQUY0MjNEQkFGQzk3QUZDMjY0MjA2RgovQkJveCBbMCAwIDE2OS4zNTggMTkuODQyIF0KL1Jlc291cmNlcyA8PA0KL1Byb2NTZXQgWy9QREYgL1RleHQgL0ltYWdlQyAvSW1hZ2VCIC9JbWFnZUkgXQovRm9udCA8PA0KL015cmlhZFByby1SZWd1bGFyIDEzIDAgUgo+Pgo+PgovU3JjIChYTzovRm9ybV85MTU1MDlCREJGQUY0MjNEQkFGQzk3QUZDMjY0MjA2RikKL01hdHJpeCBbMSAwIDAgMSAwIDAgXQovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDEyMQo+PgpzdHJlYW0KeJxFzLEKwjAYReH9PsUdFTRNWlPatVKcAlJ+cC6krZVoIKDo25tJt48zHE3NO0zdqso22eFn06rmUOag/7ziggcKebNzR3SCwn3SOvpzivthWp5hTDSaMufTQpSslbWG4rE5hfia0o5uDXNMfku5oRf0+fMFzR4gWwplbmRzdHJlYW0KZW5kb2JqCjI3IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV80NDJGNTlBNDBCMjc0REFFOEM5OTc0NjA4RURDQUE1OQovQkJveCBbMCAwIDkxLjI5OCAxOS44NDIgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTMgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzQ0MkY1OUE0MEIyNzREQUU4Qzk5NzQ2MDhFRENBQTU5KQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEzCj4+CnN0cmVhbQp4nEXMvQrCQBBF4f4+xS21cDOzJiHbRlIGJAykDuRXosKCoG/vNmL3neYIhXcEdT5UifuPGlyV+9Ty54oeD2T2Zt1eUBuy9hO3YbzG56mbltc+RKrQ5jRaCM/SFYXSRhzOIqqllyPthsbQpMEXnbgb+gplbmRzdHJlYW0KZW5kb2JqCjI4IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV84ODU5MkUxNEE5QzI0OUYzQUFCQzcwMUYwNDUwQjU4NwovQkJveCBbMCAwIDkxLjI5OCAxOS44NDIgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTMgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzg4NTkyRTE0QTlDMjQ5RjNBQUJDNzAxRjA0NTBCNTg3KQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTEzCj4+CnN0cmVhbQp4nEXMvQrCQBBF4f4+xS21cDOzJiHbRlIGJAykDuRXosKCoG/vNmL3neYIhXcEdT5UifuPGlyV+9Ty54oeD2T2Zt1eUBuy9hO3YbzG56mbltc+RKrQ5jRaCM/SFYXSRhzOIqqllyPthsbQpMEXnbgb+gplbmRzdHJlYW0KZW5kb2JqCjI5IDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV8yNkFENkFDNEZGRjY0MjVCQTA5QTdGMTU3M0JFMTNGRQovQkJveCBbMCAwIDc1LjQ2OCAxOCBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMyAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fMjZBRDZBQzRGRkY2NDI1QkEwOUE3RjE1NzNCRTEzRkUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTAKPj4Kc3RyZWFtCnicNcy9CoNAFEThfp5iygR0vWrWWCuWQpALqQX/IprAgqBvnwWxmq85IxSueFrzyHLP5WKce8s5E974ItKdRV2iUET14T5t93K/sOnHbWkdY6EO/mAkElqTpdQOtySwIkbkTp1RKSrf/wHGRRojCmVuZHN0cmVhbQplbmRvYmoKMzAgMCBvYmoKPDwNCi9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9Gb3JtCi9OYW1lIC9Gb3JtXzY5MzMwMkYxNzIyMTQxNkJBQkUyMjE4OUVGOUU1RjJFCi9CQm94IFswIDAgNzMuMTQ3IDE5Ljg0MiBdCi9SZXNvdXJjZXMgPDwNCi9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUMgL0ltYWdlQiAvSW1hZ2VJIF0KL0ZvbnQgPDwNCi9NeXJpYWRQcm8tUmVndWxhciAxMyAwIFIKPj4KPj4KL1NyYyAoWE86L0Zvcm1fNjkzMzAyRjE3MjIxNDE2QkFCRTIyMTg5RUY5RTVGMkUpCi9NYXRyaXggWzEgMCAwIDEgMCAwIF0KL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMTcKPj4Kc3RyZWFtCnicRcyxCsJAEEXR/n3FKxV0MrvJZrWNpAxIGEgdiEYlKiwI+vduI3bnNlepvCOW4qqYufzo9rKrfG7984IBDxT2ZtMd0BiK7pOu43RMz21/ml/LmOiUds6jmShr8T6ylhAcbcLKb4KqqK5pN7SGNl++JVMc4AplbmRzdHJlYW0KZW5kb2JqCjMxIDAgb2JqCjw8DQovVHlwZSAvWE9iamVjdAovU3VidHlwZSAvRm9ybQovTmFtZSAvRm9ybV85QTZENUU4Mzc0RkY0NkFDQUQ5QzU1QTBFMTNCMzJCMgovQkJveCBbMCAwIDczLjE0NyAxOS44NDIgXQovUmVzb3VyY2VzIDw8DQovUHJvY1NldCBbL1BERiAvVGV4dCAvSW1hZ2VDIC9JbWFnZUIgL0ltYWdlSSBdCi9Gb250IDw8DQovTXlyaWFkUHJvLVJlZ3VsYXIgMTMgMCBSCj4+Cj4+Ci9TcmMgKFhPOi9Gb3JtXzlBNkQ1RTgzNzRGRjQ2QUNBRDlDNTVBMEUxM0IzMkIyKQovTWF0cml4IFsxIDAgMCAxIDAgMCBdCi9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMTE3Cj4+CnN0cmVhbQp4nEXMsQrCQBBF0f59xSsVdDK7yWa1jaQMSBhIHYhGJSosCPr3biN25zZXqbwjluKqmLn86Payq3xu/fOCAQ8U9mbTHdAYiu6TruN0TM9tf5pfy5jolHbOo5koa/E+spYQHG3Cym+CqqiuaTe0hjZfviVTHOAKZW5kc3RyZWFtCmVuZG9iagozMiAwIG9iago8PA0KL0phdmFTY3JpcHQgMzMgMCBSCj4+CmVuZG9iagozMyAwIG9iago8PA0KL05hbWVzIFsoMDAwMDAwKSAzNCAwIFIgKDAwMDAwMikgMzYgMCBSICgwMDAwMDQpIDM4IDAgUiBdCj4+CmVuZG9iagozNCAwIG9iago8PA0KL1MgL0phdmFTY3JpcHQKL0pTIDM1IDAgUgo+PgplbmRvYmoKMzUgMCBvYmoKPDwNCi9GaWx0ZXIgWy9GbGF0ZURlY29kZSBdCi9MZW5ndGggNDYxCj4+CnN0cmVhbQpIidSUwW7bMAyG730KIqcECPwCQw7e0hbFuqTomu5oyBadcJVFT2Ji+O1H2V2DBsawHgcYhiH9pD7+pEU1zKVvkeu5HChm+frz9QJWK5gdvcWaPNrZ4goA3nZhBR472JY/sZL54tNVWszu883tLr9Nu7PrzW72uvxM2GEoogTy++KJxGFS5JZLhLwKXBqZ1u5aawSLNcbqHHHnBYOphE4INxyaCKPsT4pHNPacYoNo9dUVzxgisS++xX3K9aSlwMP6BmpSnIC/jhQwgkl1YYDTqAauYTx1zJrBg6oibL+CMFjuvGNj1RcEpwhRzoEBIiL0fNSPPgo2YGxDnpTLCIdsuuIp3GLr7Dvkv9KOfmbwhdt+aBjsHu/BeAutUQwgr+QDVhm4ixp9gTpyfoDvvZ3akX+w8w3zB8mBj3KpXA6eDska04Ol2DrTL6FUaVrwLNBxeIE2cIvB9Rl85+Y1Ah026CVCQ/uDDFo98kSRSu210cOcU4McVS+pkxoDDYdkTQo3MpDqU4rRhvn9ZH8vBuMD7RzHNfyntt3VOkxpijB4FKjYe70DEqWWYk6GnFH5EqpkbzJPHe7IufPfkmaRfBRNN+FscvK3AAMA0q2ZpgplbmRzdHJlYW0KZW5kb2JqCjM2IDAgb2JqCjw8DQovUyAvSmF2YVNjcmlwdAovSlMgMzcgMCBSCj4+CmVuZG9iagozNyAwIG9iago8PA0KL0ZpbHRlciBbL0ZsYXRlRGVjb2RlIF0KL0xlbmd0aCAyNzQKPj4Kc3RyZWFtCkiJ3JJRS8MwFIXf+ysueRgrQuKr1iKTKQhSYdOCT+Wuua3BrAltuiHO/25b3GRdC3v2Mfd8OdxzEpXB1H1aMtl0Nr+75wtCSWUSo64pmVUfJH0IQ2B1ISlTBUnmewAwwkIIGeqKAk/1fGNF23N9T9lx398dIiKZxFRWyhR9Y9jtYIyFG7jil7731Q91BIUtFAznjmi755LXxVPDsnfn7LUQaa44SrMinpq1qCylCrXAtDQrdKK2Eh2xP9fl2/IxenhuDW5tyOAC0FpuNbrMlOvmyCabw3jTVbTfr9X0QdNY5DXm1I3T3pWXprtOKDthLHLgfY894VlVD7CnVQ9BvaqPvsI/qHogclv1jwADAJckHYkKZW5kc3RyZWFtCmVuZG9iagozOCAwIG9iago8PA0KL1MgL0phdmFTY3JpcHQKL0pTIDM5IDAgUgo+PgplbmRvYmoKMzkgMCBvYmoKPDwNCi9GaWx0ZXIgWy9GbGF0ZURlY29kZSBdCi9MZW5ndGggNDA1Cj4+CnN0cmVhbQpIidRTXU/CMBR9hl9x3ROLZBFfVJQHFElMFJSv6NPS0LvRWMqydqAB/rtdGbDpQAxPLkvTpueee889t8yDkvoMcOKVPjziMiEV4RypDbUaWJGg6DGB1ILFAlK4KYaSTUQeKnUNN3DuXNrFeREAmM5EgsCZMpxh2NNcJriDhGJo2THE4BJovXF776wu3QHhEbp1+Y4UTmqgwgjtBLoO+ZFgsCnhyjmzt6hUQCqGcAxVJqdUIRO+20Kkepm5CZ/7JP0yVPRvtFfsDJ3+1IhJx0fV7zzmaEgzaQScgsF037oPrWa7DB7hEu3rDOmuTqwakcIut1vUNHniBqY3+8S5/YASheFukTGltpveTcbBRKBQpfkwtrNqPfPIZ8Iqw7BFxvr82qzHB81etfQgWMuNMlOqWeJKc71PSj3O+4uM90nxIUpduERd90uEUmloFQ5tT5tTLamBHom4yoYdZvGwxxTH3ITmJm5SofDdwyOH+ndhe4c6ZuMkEsPRZqz/pNm49j8ndf0Ac8Yx+wCTkV4WvwQYALmokKkKZW5kc3RyZWFtCmVuZG9iago0MCAwIG9iago8PA0KL0ZpZWxkcyBbXQo+PgplbmRvYmoKNDEgMCBvYmoKPDwNCi9UeXBlIC9NZXRhZGF0YQovU3VidHlwZSAvWE1MCi9MZW5ndGggMTA4OQo+PgpzdHJlYW0KPD94cGFja2V0IGJlZ2luPSIiIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4NCjx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDQuMi4xLWMwNDEiPg0KPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIiA+DQo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iPg0KICA8ZGM6Zm9ybWF0PmFwcGxpY2F0aW9uL3BkZjwvZGM6Zm9ybWF0Pg0KICA8ZGM6dGl0bGU+DQogICAgPHJkZjpBbHQ+DQogICAgICA8cmRmOmxpIC8+DQogICAgPC9yZGY6QWx0Pg0KICA8L2RjOnRpdGxlPg0KICA8ZGM6ZGVzY3JpcHRpb24+DQogICAgPHJkZjpBbHQ+DQogICAgICA8cmRmOmxpIC8+DQogICAgPC9yZGY6QWx0Pg0KICA8L2RjOmRlc2NyaXB0aW9uPg0KICA8ZGM6Y3JlYXRvcj4NCiAgICA8cmRmOlNlcT4NCiAgICAgIDxyZGY6bGkgLz4NCiAgICA8L3JkZjpTZXE+DQogIDwvZGM6Y3JlYXRvcj4NCjwvcmRmOkRlc2NyaXB0aW9uPg0KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6cGRmPSJodHRwOi8vbnMuYWRvYmUuY29tL3BkZi8xLjMvIj4NCiAgPHBkZjpLZXl3b3JkcyAvPg0KICA8cGRmOlByb2R1Y2VyPkFkb2JlIExpdmVDeWNsZSBEZXNpZ25lciAxMS4wPC9wZGY6UHJvZHVjZXI+DQo8L3JkZjpEZXNjcmlwdGlvbj4NCjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyI+DQogIDx4bXA6Q3JlYXRvclRvb2w+QWRvYmUgTGl2ZUN5Y2xlIERlc2lnbmVyIDExLjA8L3htcDpDcmVhdG9yVG9vbD4NCiAgPHhtcDpDcmVhdGVEYXRlPjIwMTItMDktMDRUMDk6MzA6NTQtMDc6MDA8L3htcDpDcmVhdGVEYXRlPg0KICA8eG1wOk1vZGlmeURhdGU+MjAxNi0wOS0yOFQwODoxNDozNi0wNzowMDwveG1wOk1vZGlmeURhdGU+DQo8L3JkZjpEZXNjcmlwdGlvbj4NCjwvcmRmOlJERj4NCjwveDp4bXBtZXRhPg0KPD94cGFja2V0IGVuZD0idyI/Pg0KCmVuZHN0cmVhbQplbmRvYmoKNDIgMCBvYmoKPDwNCi9UeXBlIC9PdXRsaW5lcwovQ291bnQgLTEKL0ZpcnN0IDQzIDAgUgovTGFzdCA0MyAwIFIKPj4KZW5kb2JqCjQzIDAgb2JqCjw8DQovQ291bnQgMAovVGl0bGUgKENoZWNrXzY1NDgwIC0gTmV3RG9jUDEgLSBBUENoZWNrc18wMDAwMDAwMCswMDAwKzAwMDArMDAwMCswMDAwMDAwMDAwMDBfZGlyZWN0bG9hbikKL0MgWzAgMCAwIF0KL0YgMgovQSA8PA0KL05leHQgW10KL1MgL0dvVG8KL0QgWzQgMCBSIC9YWVogMCA3OTIgMSBdCj4+Ci9QYXJlbnQgNDIgMCBSCj4+CmVuZG9iagp4cmVmCjAgNDQKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDIzIDAwMDAwIG4gCjAwMDAwMDAyMDMgMDAwMDAgbiAKMDAwMDAwMDQwMCAwMDAwMCBuIAowMDAwMDAwNDU5IDAwMDAwIG4gCjAwMDAwMDE0ODggMDAwMDAgbiAKMDAwMDAwMTU5MSAwMDAwMCBuIAowMDAwMDAxNjQ1IDAwMDAwIG4gCjAwMDAwMDIwNDIgMDAwMDAgbiAKMDAwMDAwMjA5NiAwMDAwMCBuIAowMDAwMDAyMTk5IDAwMDAwIG4gCjAwMDAwMDI5NDIgMDAwMDAgbiAKMDAwMDAwNDEzNCAwMDAwMCBuIAowMDAwMDA0Mzg5IDAwMDAwIG4gCjAwMDAwMDU1ODQgMDAwMDAgbiAKMDAwMDAwNTg0MSAwMDAwMCBuIAowMDAwMDA2MzEwIDAwMDAwIG4gCjAwMDAwMDY3ODMgMDAwMDAgbiAKMDAwMDAwNzI1MiAwMDAwMCBuIAowMDAwMDA3NzE2IDAwMDAwIG4gCjAwMDAwMDgyMDEgMDAwMDAgbiAKMDAwMDAwODY1MCAwMDAwMCBuIAowMDAwMDA5MTE0IDAwMDAwIG4gCjAwMDAwMDk1NzUgMDAwMDAgbiAKMDAwMDAxMDA0NCAwMDAwMCBuIAowMDAwMDEwNTEzIDAwMDAwIG4gCjAwMDAwMTA5ODcgMDAwMDAgbiAKMDAwMDAxMTQ2MSAwMDAwMCBuIAowMDAwMDExOTI2IDAwMDAwIG4gCjAwMDAwMTIzOTEgMDAwMDAgbiAKMDAwMDAxMjg0OSAwMDAwMCBuIAowMDAwMDEzMzE4IDAwMDAwIG4gCjAwMDAwMTM3ODcgMDAwMDAgbiAKMDAwMDAxMzgyOSAwMDAwMCBuIAowMDAwMDEzOTEwIDAwMDAwIG4gCjAwMDAwMTM5NTkgMDAwMDAgbiAKMDAwMDAxNDQ5NyAwMDAwMCBuIAowMDAwMDE0NTQ2IDAwMDAwIG4gCjAwMDAwMTQ4OTcgMDAwMDAgbiAKMDAwMDAxNDk0NiAwMDAwMCBuIAowMDAwMDE1NDI4IDAwMDAwIG4gCjAwMDAwMTU0NjIgMDAwMDAgbiAKMDAwMDAxNjYzNSAwMDAwMCBuIAowMDAwMDE2NzExIDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgNDQKL1Jvb3QgMiAwIFIKL0luZm8gMSAwIFIKL0lEIFs8MTNGRTUxNjI5MEU0QjAzRDcwOUQ4ODZENUVGQ0Q3Q0I+PDEzRkU1MTYyOTBFNEIwM0Q3MDlEODg2RDVFRkNEN0NCPl0KPj4Kc3RhcnR4cmVmCjE2OTE5CiUlRU9G\",\n        \"documentType\": \"pdf\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"9d94286e-3820-4b6b-8fe3-d438866a3865","name":"Error","originalRequest":{"method":"POST","header":[{"key":"publicKey","value":"ca6368a8-c7c4-4181-a026-46f7ba5a99eb"},{"key":"timeStamp","value":"1765484631542"},{"key":"signature","value":"b8f5f1cfb584aece434b170eed362db1219c80eea9f031b2789b437858a2c523c094f192e5186511652e6f6d6ac6e25d4715c1bbbe3e977e25dd140911c488b2"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"059f29ff-bcb2-4acc-9f53-aba756220a5e\",\r\n    \"checkNumber\": \"65479\",\r\n    \"newCheckNumber\": \"65480\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/ReprintCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudHNwYXlhYmxlXFJlcHJpbnRDaGVjaw==?="},{"key":"Date","value":"Thu, 11 Dec 2025 19:59:30 GMT"},{"key":"Content-Length","value":"123"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Check 65479 is voided and cannot be reprinted\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"01b171b9-91a2-4f9c-86c7-d15e51fa47da"},{"name":"VoidCheck","id":"cc71e980-9d99-48b2-89c5-423b97c42451","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"fdf8442b-235f-4fb9-8ce3-845390cb862a\",\r\n    \"bankAccount\":\"98532633\",\r\n    \"checkNumber\": \"65480\",\r\n    \"voidReason\": \"Test void via API\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/VoidCheck","description":"<h1 id=\"voidcheck-api\">VoidCheck API</h1>\n<h2 id=\"overview\">Overview</h2>\n<p>This endpoint voids a check in the accounts payable system. Once a check is voided, it cannot be voided again. The void operation is permanent and requires a reason for audit purposes.</p>\n<h2 id=\"request-body-parameters\">Request Body Parameters</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Required</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>token</code></td>\n<td>string</td>\n<td>No</td>\n<td>Authentication token used to authorize the request. This token is required if not using the dynamic signature method.</td>\n</tr>\n<tr>\n<td><code>bankAccount</code></td>\n<td>string</td>\n<td>Yes</td>\n<td>The full bank account used to print the check.</td>\n</tr>\n<tr>\n<td><code>checkNumber</code></td>\n<td>string</td>\n<td>Yes</td>\n<td>The check number to be voided</td>\n</tr>\n<tr>\n<td><code>voidReason</code></td>\n<td>string</td>\n<td>Yes</td>\n<td>Reason for voiding the check (for audit trail)</td>\n</tr>\n</tbody>\n</table>\n</div><h2 id=\"response-format\">Response Format</h2>\n<p>The API returns a JSON response with the following structure:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"statusCode\": number,\n  \"result\": string,\n  \"data\": object | null,\n  \"errors\": array,\n  \"warnings\": array\n}\n\n</code></pre>\n<h3 id=\"response-fields\">Response Fields</h3>\n<ul>\n<li><p><strong>statusCode</strong>: Numeric status code (50 indicates an error)</p>\n</li>\n<li><p><strong>result</strong>: Text result (\"Success\" or \"Error\")</p>\n</li>\n<li><p><strong>data</strong>: Response data (null for errors)</p>\n</li>\n<li><p><strong>errors</strong>: Array of error messages</p>\n</li>\n<li><p><strong>warnings</strong>: Array of warning messages</p>\n</li>\n</ul>\n<h2 id=\"status-codes\">Status Codes</h2>\n<ul>\n<li><p><strong>200 OK</strong>: Request processed (check <code>statusCode</code> and <code>result</code> fields for actual operation status)</p>\n<ul>\n<li><p><code>statusCode: 0</code> with <code>result: \"Success\"</code> - Check successfully voided</p>\n</li>\n<li><p><code>statusCode: 50</code> with <code>result: \"Error\"</code> - Operation failed (see <code>errors</code> array)</p>\n</li>\n</ul>\n</li>\n</ul>\n<h2 id=\"example-usage\">Example Usage</h2>\n<h3 id=\"successful-void-request\">Successful Void Request</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"token\": \"cc3468b5-f830-411c-979c-8272121c8e10\",\n  \"checkNumber\": \"12345\",\n  \"voidReason\": \"Incorrect payment amount\"\n}\n\n</code></pre>\n<h3 id=\"error-response-already-voided\">Error Response (Already Voided)</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\"Check 65479 is already voided\"],\n  \"warnings\": []\n}\n\n</code></pre>\n<h2 id=\"important-notes\">Important Notes</h2>\n<p>⚠️ <strong>Key Considerations:</strong></p>\n<ul>\n<li><p>A check can only be voided once. Attempting to void an already-voided check will return an error</p>\n</li>\n<li><p>The <code>voidReason</code> parameter is required and should provide a clear explanation for audit purposes</p>\n</li>\n<li><p>The HTTP status code may be 200 even when the operation fails - always check the <code>statusCode</code> and <code>result</code> fields in the response body</p>\n</li>\n<li><p>Ensure you have a valid authentication token before making the request</p>\n</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","client","accountspayable","VoidCheck"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f51cd245-6b32-46be-ac00-f96305deb6a8","name":"Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"059f29ff-bcb2-4acc-9f53-aba756220a5e\",\r\n    \"checkNumber\": \"65479\",\r\n    \"voidReason\": \"Test void via API\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/VoidCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudHNwYXlhYmxlXFZvaWRDaGVjaw==?="},{"key":"Date","value":"Thu, 11 Dec 2025 19:54:30 GMT"},{"key":"Content-Length","value":"101"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"checkNumber\": 65479\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"b5188ae1-e27a-41c3-866f-ba722621412b","name":"Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"cc3468b5-f830-411c-979c-8272121c8e10\",\r\n    \"checkNumber\": \"65479\",\r\n    \"voidReason\": \"Test void via API\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/VoidCheck"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Content-Security-Policy","value":"default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline' https://cdn.form.io; upgrade-insecure-requests"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-SourceFiles","value":"=?UTF-8?B?WjpcUmVwb1xPbWVnYVxvbWVnYTFcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcYWNjb3VudHNwYXlhYmxlXFZvaWRDaGVjaw==?="},{"key":"Date","value":"Thu, 11 Dec 2025 20:11:57 GMT"},{"key":"Content-Length","value":"114"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Check 65479 is already voided\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"cc71e980-9d99-48b2-89c5-423b97c42451"},{"name":"VoucherAdd","id":"6bf4c97f-a594-4b32-954a-2e6388794ff9","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"onHold\":\"false\",\r\n    \"dueDate\":\"2/1/2025\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"branchNumber\":\"99\",\r\n    \"CustomerNumber\": \"44\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/AddVoucher","description":"<h3 id=\"add-voucher\">Add Voucher</h3>\n<p>This endpoint allows you to add a new voucher for accounts payable.</p>\n<h4 id=\"request-body\">Request Body</h4>\n<ul>\n<li><p><code>token</code> (string): The token for authentication.</p>\n</li>\n<li><p><code>invoiceNumber</code> (string): The invoice number.</p>\n</li>\n<li><p><code>purchaseOrderNumber</code> (string): The purchase order number.</p>\n</li>\n<li><p><code>totalAmount</code> (decimal): The total amount of the voucher.</p>\n</li>\n<li><p><code>invoiceDate</code> (date): The date of the invoice.</p>\n</li>\n<li><p><code>receivedDate</code> (date): The date when the voucher was received.</p>\n</li>\n<li><p><code>dueDate</code> (date): The date when the invoice should be disbursed.</p>\n</li>\n<li><p><code>receivedDate</code> (date): The date when the voucher was received.</p>\n</li>\n<li><p><code>onHold</code> (bool): If true the voucher status will be set to On Hold.</p>\n</li>\n<li><p><code>memo1</code> (string): Additional memo information.</p>\n</li>\n<li><p><code>memo2</code> (string): Additional memo information.</p>\n</li>\n<li><p><code>VOUCHER TYPES</code> Customer, Vendor, One Time, Account</p>\n<ul>\n<li><p>Customer</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The voucher branch number.</p>\n</li>\n<li><p><code>customerNumber</code> (int): The customer number.</p>\n</li>\n</ul>\n</li>\n<li><p>Vendor</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The voucher branch number.</p>\n</li>\n<li><p><code>vendorCode</code> (string): The vendor code.</p>\n</li>\n<li><p><code>splitAmongBranches</code> (bool): Available for enterprise only. Use the vendor split branch feature for the payment detail. If true then <code>paymentDetail.glBranchNumber</code> cannot be used.</p>\n</li>\n</ul>\n</li>\n<li><p>One Time</p>\n<ul>\n<li><p><code>branchNumber</code> (int): The voucher branch number.</p>\n</li>\n<li><p><code>payeeName</code> (string): The name printed on the check.</p>\n</li>\n<li><p><code>phoneNumber</code> (string): The payee phone number.</p>\n</li>\n<li><p><code>addressLine1</code> (string): Payee street address</p>\n</li>\n<li><p><code>addressLine2</code> (string): Payee apt, unit, or suite</p>\n</li>\n<li><p><code>addressLine3</code> (string): Payee PO box or additional information</p>\n</li>\n<li><p><code>city</code> (string): City of the payee address</p>\n</li>\n<li><p><code>state</code> (string): State abbreviation or full name of the payee address</p>\n</li>\n<li><p><code>zipCode</code> (string): Postal code of the payee address</p>\n</li>\n<li><p><code>country</code> (string): Country of the payee address. Options: United States, Canada, Mexico</p>\n</li>\n<li><p><code>language</code> (string): Preferred language. Options: English, Spanish, French</p>\n</li>\n</ul>\n</li>\n<li><p>Account</p>\n<ul>\n<li><p><code>accountNumber</code> (long): The account to apply the voucher transaction. The account branch will be used for the voucher.</p>\n</li>\n<li><p><code>transactionCode</code> (string): The transaction code to use when applying the voucher transaction.</p>\n</li>\n<li><p><code>customerPayeeType</code> (string): The name to print as the payee. Options: Customer_Primary_Only = 1, Customer_Primary_And_Spouse_Or_CoSigner = 2</p>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n<li><p><code>paymentDetail</code> (list): List of general ledger distribution. Total must equal the voucher amount.</p>\n<ul>\n<li><p><code>paymentDetail.glAccountNumber</code> (int): The GL account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glBranchNumber</code> (int): The branch account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glClassNumber</code> (int): The class account for the payment detail.</p>\n</li>\n<li><p><code>paymentDetail.glPortfolioNumber</code> (int): The portfolio account for the payment detail. System must have portfolio turned on.</p>\n</li>\n<li><p><code>paymentDetail.amount</code> (decimal): The amount for the current payment detail.</p>\n</li>\n</ul>\n</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<ul>\n<li><p><code>Status</code>: 200</p>\n</li>\n<li><p><code>Content-Type</code>: application/json</p>\n</li>\n<li><p>Sample:</p>\n</li>\n</ul>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n\"statusCode\": \"0\",\n\"status\": \"Ok\",\n\"data\": {\n    \"voucherNumber\" : \"777\"\n  },\n\"errors\": [],\n\"warnings\": []\n}\n\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","client","accountspayable","AddVoucher"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dd588b44-e087-4504-a450-3b2dc7efb57e","name":"Customer Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"123463\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"onHold\":\"false\",\r\n    \"dueDate\":\"2/1/2025\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"branchNumber\":\"99\",\r\n    \"CustomerNumber\": \"44\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddVoucher"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"voucherNumber\": 940\n    },\n    \"errors\": [],\n    \"warnings\": [\n        \"Duplicate Invoice number found, last recent Voucher: #936, Invoice date: 8/10/2021\"\n    ]\n}"},{"id":"4f1ea635-6fa2-4030-80b3-b71d66a273e3","name":"Vendor Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"onHold\":\"false\",\r\n    \"dueDate\":\"2/1/2025\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"branchNumber\":\"99\",\r\n    \"VendorCode\": \"v1\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/AddVoucher"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 940\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"9eb4f888-01fb-4178-8af3-3ad5f7cbbe39","name":"One Time Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"onHold\":\"false\",\r\n    \"dueDate\":\"2/1/2025\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"branchNumber\":\"99\",\r\n    \"payeeName\": \"My Name\",\r\n    \"phoneNumber\": \"9991234567\",\r\n    \"addressLine1\": \"2400 E Katella Ave\",\r\n    \"addressLine2\": \"Suite 550\",\r\n    \"addressLine3\": \"\",\r\n    \"city\": \"Anaheim\",\r\n    \"state\": \"CA\",\r\n    \"zipCode\" : \"92806\",\r\n    \"country\" : \"United States\",\r\n    //English = 1\r\n    //Spanish = 2\r\n    //French = 3\r\n    \"language\" : \"English\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/AddVoucher"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 940\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"76bb1811-1ac6-4d0f-835d-2c15ece35726","name":"Account Payee","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"1234\",\r\n    \"invoiceNumber\":\"\",\r\n    \"purchaseOrderNumber\":\"\",\r\n    \"totalAmount\":\"300.00\",\r\n    \"onHold\":\"false\",\r\n    \"dueDate\":\"2/1/2025\",\r\n    \"invoiceDate\":\"2/1/2025\",\r\n    \"receivedDate\":\"2/4/2025\",\r\n    \"memo1\":\"\",\r\n    \"memo2\":\"\",\r\n    \"accountNumber\": \"1\",\r\n    \"transactionCode\": \"check\",\r\n    //Customer_Primary_Only = 1\r\n    //Customer_Primary_And_Spouse_Or_CoSigner = 2\r\n    \"customerPayeeType\": \"Customer_Primary_And_Spouse_Or_CoSigner\",\r\n    \"paymentDetail\":[\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"200.00\"\r\n        },\r\n        {\r\n        \"glAccountNumber\":\"1\",\r\n        \"glBranchNumber\":\"\",\r\n        \"glClassNumber\":\"\",\r\n        \"glPortfolioNumber\":\"\",\r\n        \"amount\":\"100.00\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/accountspayable/AddVoucher"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 0,\r\n    \"result\": \"Ok\",\r\n    \"data\": {\r\n        \"voucherNumber\": 940\r\n    },\r\n    \"errors\": [],\r\n    \"warnings\": []\r\n}"},{"id":"8bb3ab12-80ba-4811-aa54-9e2ec5ec9e37","name":"Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"token\": \"1234\",\n    \"invoiceNumber\": \"123463\",\n    \"purchaseOrderNumber\": \"\",\n    \"totalAmount\": \"300.00\",\n    \"onHold\": \"false\",\n    \"dueDate\": \"2/1/2025\",\n    \"invoiceDate\": \"2/1/2025\",\n    \"receivedDate\": \"2/4/2025\",\n    \"memo1\": \"\",\n    \"memo2\": \"\",\n    \"branchNumber\": \"99\",\n    \"CustomerNumber\": \"999999\",\n    \"paymentDetail\": [\n        {\n            \"glAccountNumber\": \"1\",\n            \"glBranchNumber\": \"\",\n            \"glClassNumber\": \"\",\n            \"glPortfolioNumber\": \"\",\n            \"amount\": \"200.00\"\n        },\n        {\n            \"glAccountNumber\": \"1\",\n            \"glBranchNumber\": \"\",\n            \"glClassNumber\": \"\",\n            \"glPortfolioNumber\": \"\",\n            \"amount\": \"100.00\"\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:44325/api/client/accountspayable/AddVoucher"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid customer number(999999)\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"6bf4c97f-a594-4b32-954a-2e6388794ff9"},{"name":"VoucherCancel","id":"c4c6fc9a-b773-4c3c-a5df-b48a90ba2361","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Cancel","description":"<h3 id=\"cancel-voucher\">Cancel Voucher</h3>\n<p>Cancels a single AP voucher, moving it to <strong>Cancelled</strong> status and posting any reversal GL transaction required by its prior state. Rejects the request with a <code>BadRequest</code> error when the voucher is already in <code>Cancelled</code> or <code>Closed</code> state — cancellation is only valid from <code>Open</code>, <code>Disbursed</code>, or <code>Printed</code>. When the voucher had already been disbursed or printed, the server creates a reversal transaction and returns its <code>Id</code> as <code>cancellationTransactionId</code>; vouchers cancelled from <code>Open</code> do not produce a reversal. The voucher is resolved by <code>SharedWSServices.GetCommonVoucherId</code> (accepts voucher number or <code>Id</code>). Wraps <code>AccountsPayableWSServices.API_CancelVoucher</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/Voucher/Cancel</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>voucherNumberOrId</em></td>\n<td>Required string. Voucher number or <code>Id</code> (Guid) of the voucher to cancel.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response Data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>voucherId</em></td>\n<td>The voucher <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>voucherNumber</em></td>\n<td>The voucher number.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td>Always <code>\"Cancelled\"</code> on success.</td>\n</tr>\n<tr>\n<td><em>cancellationTransactionId</em></td>\n<td>Reversal transaction <code>Id</code> (Guid) when a reversal was posted; <code>null</code> when cancelling from <code>Open</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","Voucher","Cancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b2d7b1f0-7c6d-4087-a00a-be596262986c","name":"CancelVoucher - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Cancel"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"voucherId\": \"00000000-0000-0000-0000-000000000000\",\n        \"voucherNumber\": \"100001\",\n        \"status\": \"Cancelled\",\n        \"cancellationTransactionId\": null\n    }\n}"},{"id":"a7336903-7554-4ffc-a892-bdc75bb04eaa","name":"CancelVoucher - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Cancel"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Voucher 100001 is already cancelled.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c4c6fc9a-b773-4c3c-a5df-b48a90ba2361"},{"name":"VoucherDetailAdd","id":"58e51721-1e65-4da1-af56-7dbfc8c2eccc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\",\n    \"glChartAccountNumberOrId\": \"{{gl_chart_account_number_or_id}}\",\n    \"detailAmount\": 125.50\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail","description":"<h3 id=\"add-voucher-detail\">Add Voucher Detail</h3>\n<p>Adds a new GL line-item detail row to an existing AP voucher. Wraps <code>VoucherDetailWSServices.AddVoucherDetailWS</code>. Returns the new row's Guid in <code>data.Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>voucherNumberOrId</em></td>\n<td>Required string. Parent AP voucher number or <code>Id</code> (Guid) that the detail row will be attached to.</td>\n</tr>\n<tr>\n<td><em>glChartAccountNumberOrId</em></td>\n<td>Required string. GL chart-of-accounts number or <code>Id</code> (Guid) identifying where the amount should post.</td>\n</tr>\n<tr>\n<td><em>detailAmount</em></td>\n<td>Required decimal. Dollar amount for this GL split. The sum of all <code>detailAmount</code> values across a voucher's detail rows must equal the voucher total.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","VoucherDetail"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"29a4ede6-fe65-405f-a44f-4490d46141fe","name":"AddVoucherDetail - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\",\n    \"glChartAccountNumberOrId\": \"{{gl_chart_account_number_or_id}}\",\n    \"detailAmount\": 125.50\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"dbc78d28-b4cf-4e48-be9b-0c055745a4d6","name":"AddVoucherDetail - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"999999999\",\n    \"glChartAccountNumberOrId\": \"{{gl_chart_account_number_or_id}}\",\n    \"detailAmount\": 125.50\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Voucher not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"58e51721-1e65-4da1-af56-7dbfc8c2eccc"},{"name":"VoucherDetailDelete","id":"feceb4f0-237b-44e3-a748-1be079f8dc3c","request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/{{voucher_detail_id}}","description":"<h3 id=\"delete-voucher-detail\">Delete Voucher Detail</h3>\n<p>Deletes a voucher detail row by its Guid primary key. Wraps <code>VoucherDetailWSServices.DeleteVoucherDetailWS</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.VoucherDetail</code> row to delete. Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","VoucherDetail","{{voucher_detail_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"96b26777-82f6-46e6-bd6f-cfc941504db4","name":"DeleteVoucherDetail - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/{{voucher_detail_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"Deleted\": true\n    }\n}"},{"id":"6b08e32b-cff5-4fdd-b980-cc00a16e779e","name":"DeleteVoucherDetail - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/not-a-guid"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid voucher detail ID format. Must be a valid GUID.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"feceb4f0-237b-44e3-a748-1be079f8dc3c"},{"name":"VoucherDetailsByVoucherGet","id":"abfd0111-090a-4f55-b521-d80a03ac7c72","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/ByVoucher/{{voucher_number_or_id}}","description":"<h3 id=\"get-voucher-details-by-voucher\">Get Voucher Details By Voucher</h3>\n<p>Returns the list of <code>AccountsPayable.VoucherDetail</code> rows (GL line items) for a given voucher. Wraps <code>VoucherDetailWSServices.GetVoucherDetailsByVoucherWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/ByVoucher/{voucherNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>voucherNumberOrId</em></td>\n<td>Required string. AP voucher number or <code>Id</code> (Guid). Returns <code>BadRequest</code> with the standard invalid parameter message when blank.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","VoucherDetail","ByVoucher","{{voucher_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"23b13d7a-8b34-4e04-80e6-95cb6792bcd7","name":"GetVoucherDetailsByVoucher - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/ByVoucher/{{voucher_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"VoucherId\": \"00000000-0000-0000-0000-000000000000\",\n            \"GlChartAccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"DetailAmount\": 125.50\n        }\n    ]\n}"},{"id":"44bba804-0ffb-4715-af9d-8cee724dad26","name":"GetVoucherDetailsByVoucher - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/ByVoucher/0000000000"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Voucher not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"abfd0111-090a-4f55-b521-d80a03ac7c72"},{"name":"VoucherDetailUpdate","id":"4b8652ee-2b58-42b3-82f3-e4cd64ce13c4","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\",\n    \"glChartAccountNumberOrId\": \"{{gl_chart_account_number_or_id}}\",\n    \"detailAmount\": 125.50\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/{{voucher_detail_id}}","description":"<h3 id=\"update-voucher-detail\">Update Voucher Detail</h3>\n<p>Updates an existing voucher detail row identified by its Guid <code>Id</code>. Wraps <code>VoucherDetailWSServices.UpdateVoucherDetailWS</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. Primary key of the <code>AccountsPayable.VoucherDetail</code> row being updated.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>voucherNumberOrId</em></td>\n<td>Required string. Parent AP voucher number or <code>Id</code> (Guid).</td>\n</tr>\n<tr>\n<td><em>glChartAccountNumberOrId</em></td>\n<td>Required string. GL chart-of-accounts number or <code>Id</code> (Guid) identifying where the amount should post.</td>\n</tr>\n<tr>\n<td><em>detailAmount</em></td>\n<td>Required decimal. Dollar amount for this GL split.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","VoucherDetail","{{voucher_detail_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"df6c7a34-bbde-474b-9bbc-578e235b0c30","name":"UpdateVoucherDetail - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\",\n    \"glChartAccountNumberOrId\": \"{{gl_chart_account_number_or_id}}\",\n    \"detailAmount\": 125.50\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/{{voucher_detail_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"8c75ee5f-929e-4813-a69c-8972a40c76d5","name":"UpdateVoucherDetail - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherNumberOrId\": \"{{voucher_number_or_id}}\",\n    \"glChartAccountNumberOrId\": \"{{gl_chart_account_number_or_id}}\",\n    \"detailAmount\": 125.50\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/VoucherDetail/not-a-guid"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid voucher detail ID format. Must be a valid GUID.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"4b8652ee-2b58-42b3-82f3-e4cd64ce13c4"},{"name":"VoucherImport","id":"f8de16e0-c279-4d27-b232-6b9f29670870","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherXmlBase64\": \"{{voucher_xml_base64}}\",\n    \"isZip\": false,\n    \"notificationEmail\": \"{{notification_email}}\",\n    \"folderId\": \"{{folder_id}}\",\n    \"validateOnly\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Import","description":"<h3 id=\"import-voucher\">Import Voucher</h3>\n<p>Imports AP vouchers from an XML payload (optionally inside a zip archive). The endpoint <strong>spawns an async worker thread</strong> and returns immediately — it does not wait for the import to complete. Results, including any validation errors and the count of vouchers created, are delivered by email to <code>notificationEmail</code> and as a file dropped into the folder identified by <code>folderId</code> (Omega Folder). When <code>validateOnly</code> is <code>true</code>, the XML is validated against the conversion import schema but no vouchers are created. Because this is an asynchronous action the success response only confirms that the background import was queued. Wraps <code>AccountsPayableWSServices.API_ImportVoucher</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/AccountsPayable/Voucher/Import</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by the Login method.</td>\n</tr>\n<tr>\n<td><em>voucherXmlBase64</em></td>\n<td>Required string. Base64-encoded voucher XML (or base64-encoded zip when <code>isZip=true</code>). The XML must match the conversion import schema used by <code>ConversionImport</code>.</td>\n</tr>\n<tr>\n<td><em>isZip</em></td>\n<td>Optional boolean. Defaults to <code>false</code>. When <code>true</code>, the base64 payload is a zip archive that contains the XML.</td>\n</tr>\n<tr>\n<td><em>notificationEmail</em></td>\n<td>Required string. Email address that receives the import-result notification when the background worker finishes.</td>\n</tr>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. <code>Global.Folder</code> <code>Id</code> where the result file is dropped.</td>\n</tr>\n<tr>\n<td><em>validateOnly</em></td>\n<td>Optional boolean. Defaults to <code>false</code>. When <code>true</code>, the import validates the XML schema but does not create vouchers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>The success response only confirms that the import was queued. The actual per-voucher results arrive via email and the destination folder.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","AccountsPayable","Voucher","Import"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5d176bbc-0567-43ac-b665-f70ab5551f42","name":"ImportVoucher - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherXmlBase64\": \"{{voucher_xml_base64}}\",\n    \"isZip\": false,\n    \"notificationEmail\": \"{{notification_email}}\",\n    \"folderId\": \"{{folder_id}}\",\n    \"validateOnly\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Import"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"message\": \"Voucher import queued. Results will be emailed to the notification address and dropped into the destination folder.\"\n    }\n}"},{"id":"4edf2e46-3e1a-429d-833c-62310a60f1c0","name":"ImportVoucher - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"voucherXmlBase64\": \"bm90LXZhbGlkLXhtbA==\",\n    \"isZip\": false,\n    \"notificationEmail\": \"{{notification_email}}\",\n    \"folderId\": \"{{folder_id}}\",\n    \"validateOnly\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/AccountsPayable/Voucher/Import"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Data at the root level is invalid. Line 1, position 1.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f8de16e0-c279-4d27-b232-6b9f29670870"}],"id":"affc48e2-038b-40e5-a950-9b48b77750ba","_postman_id":"affc48e2-038b-40e5-a950-9b48b77750ba","description":""},{"name":"Common","item":[{"name":"AccountRemarkCodesGet","id":"7cdfcf37-2f30-4cff-b219-3cbec293bcb9","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/Account/{{account_number_or_id}}","description":"<h3 id=\"get-account-remark-codes\">Get Account Remark Codes</h3>\n<p>Returns all <code>Common.AccountRemarkCode</code> rows attached to the account resolved from the <code>{accountNumberOrId}</code> path segment. The WS layer (<code>RemarkCodeWSServices.ReturnAllAccountRemarkCodesWS</code>) resolves the account via <code>SharedWSServices.GetCommonAccountId</code> (Guid-first, then account-number string, scoped to the caller's client), then calls <code>RemarkCodeServices.ReturnAllAccountRemarkCodes</code> to fetch the account's remark-code entries. Returns <code>400 Bad Request</code> when the segment is empty or the account is not found.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/RemarkCode/Account/{accountNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required. Either the account number string or the account <code>Id</code> Guid. Resolution is Guid-first, then account-number string (client-scoped).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","RemarkCode","Account","{{account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f17c59c9-cbe6-4838-8511-1fb50fd25b49","name":"GetAccountRemarkCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/Account/{{account_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"RemarkCodeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"EffectiveDate\": \"2026-03-01T00:00:00\",\n            \"ExpirationDate\": null,\n            \"Ts\": \"AAAAAAAAB9M=\"\n        }\n    ]\n}"},{"id":"1f771e88-d47c-481c-b62a-95934bb73230","name":"GetAccountRemarkCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/Account/0000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"7cdfcf37-2f30-4cff-b219-3cbec293bcb9"},{"name":"ActionCodeAdd","id":"4ee10d4a-ab4d-4438-9a16-31eb99213c8a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"CALL\",\n    \"description\": \"Phone Call\",\n    \"active\": true,\n    \"resultRequired\": false,\n    \"actionType\": 1,\n    \"actionCodeVisibility\": 1,\n    \"emailDealer\": false,\n    \"isAlert\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ActionCode","description":"<h3 id=\"add-action-code\">Add Action Code</h3>\n<p>Creates a new <code>Common.ActionCode</code> for the caller's client. The controller forwards the payload into <code>ActionCodeWSServices.AddSaveActionCodeChangesWS</code> with <code>id = null</code> and <code>ts = null</code> so the save treats it as an insert. The service rejects the request when another action code with the same <code>code</code> already exists for the client. Returns the new row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ActionCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Unique (per client) short code (e.g. <code>CALL</code>).</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. <code>true</code> makes the code selectable on activity screens.</td>\n</tr>\n<tr>\n<td><em>resultRequired</em></td>\n<td>Required boolean. <code>true</code> forces a follow-up result remark when the code is logged.</td>\n</tr>\n<tr>\n<td><em>actionType</em></td>\n<td>Required int. <code>ActionType</code> enum: <code>1</code> Standard, <code>2</code> System.</td>\n</tr>\n<tr>\n<td><em>actionCodeVisibility</em></td>\n<td>Required int. <code>ActionCodeVisibility</code> enum: <code>1</code> All, <code>2</code> Client, <code>3</code> Dealer, <code>4</code> Agent, <code>5</code> InternalOnly.</td>\n</tr>\n<tr>\n<td><em>emailDealer</em></td>\n<td>Required boolean. Emails the dealer when <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em> / <em>addRemarkCode2OrId</em> / <em>addRemarkCode3OrId</em> / <em>addRemarkCode4OrId</em> / <em>addRemarkCode5OrId</em></td>\n<td>Optional. Remark codes (code or Guid) automatically added when this action code is logged.</td>\n</tr>\n<tr>\n<td><em>removeRemarkCodeOrId</em> / <em>removeRemarkCode2OrId</em> / <em>removeRemarkCode3OrId</em> / <em>removeRemarkCode4OrId</em> / <em>removeRemarkCode5OrId</em></td>\n<td>Optional. Remark codes (code or Guid) automatically cleared when this action code is logged.</td>\n</tr>\n<tr>\n<td><em>isAlert</em></td>\n<td>Required boolean. <code>true</code> surfaces the code as an alert-style activity.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ActionCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a600da68-a8f3-4df8-9df9-341b5433865e","name":"AddActionCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"CALL\",\n    \"description\": \"Phone Call\",\n    \"active\": true,\n    \"resultRequired\": false,\n    \"actionType\": 1,\n    \"actionCodeVisibility\": 1,\n    \"emailDealer\": false,\n    \"isAlert\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ActionCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"aa3ef3ba-4a9e-41ba-bd03-1d6df2debdb0","name":"AddActionCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"CALL\",\n    \"description\": \"Phone Call\",\n    \"active\": true,\n    \"resultRequired\": false,\n    \"actionType\": 1,\n    \"actionCodeVisibility\": 1,\n    \"emailDealer\": false,\n    \"isAlert\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ActionCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Action code with code 'CALL' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"4ee10d4a-ab4d-4438-9a16-31eb99213c8a"},{"name":"ActionCodeGet","id":"460f5047-f011-48eb-a123-d7b44c765160","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ActionCode/{{action_code_or_id}}","description":"<h3 id=\"get-action-code\">Get Action Code</h3>\n<p>Returns a single <code>Common.ActionCode</code> row resolved from the <code>{codeOrId}</code> path segment. Resolution runs through <code>SharedWSServices.GetCommonActionCodeId</code> which tries <code>Guid.TryParse</code> first, then falls back to a client-scoped lookup by <code>ActionCode</code> string via <code>ActionCodeServices.ReturnActionCodeId</code>. Returns <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ActionCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the action-code string (e.g. <code>CALL</code>) or the row <code>Id</code> Guid. Resolution is Guid-first, then code string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ActionCode","{{action_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f1ec2d4d-0edd-4ea7-8fdb-dc6b227d041e","name":"GetActionCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ActionCode/CALL"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Code\": \"CALL\",\n        \"Description\": \"Phone Call\",\n        \"Active\": true,\n        \"ResultRequired\": false,\n        \"ActionType\": 1,\n        \"ActionCodeVisibility\": 1,\n        \"EmailDealer\": false,\n        \"IsAlert\": false,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"39422dc2-cdc4-46ba-87eb-9a86e5e67fd5","name":"GetActionCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ActionCode/NOPE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Action code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"460f5047-f011-48eb-a123-d7b44c765160"},{"name":"ActionCodesGetAll","id":"8998f815-4d1a-4d60-8a54-c4dbacfa0d6e","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ActionCode","description":"<h3 id=\"get-all-action-codes\">Get All Action Codes</h3>\n<p>Returns every action code (<code>Common.ActionCode</code>) for the caller's client. Wraps <code>ActionCodeWSServices.ReturnAllActionCodesWS</code>, which scopes results by <code>OmegaClientId</code> from the authenticated session. Each row carries the enum-backed <code>ActionType</code> (Standard / System) and <code>ActionCodeVisibility</code> (All / Client / Dealer / Agent / InternalOnly) discriminators used on account activity and remark screens.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ActionCode</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ActionCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8199e01d-ac45-481d-b803-21294fdd2f78","name":"GetAllActionCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ActionCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"CALL\",\n            \"Description\": \"Phone Call\",\n            \"Active\": true,\n            \"ResultRequired\": false,\n            \"ActionType\": 1,\n            \"ActionCodeVisibility\": 1,\n            \"EmailDealer\": false,\n            \"IsAlert\": false,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"13378ac5-4894-4f3e-b2df-abaed29f6532","name":"GetAllActionCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/ActionCode"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"8998f815-4d1a-4d60-8a54-c4dbacfa0d6e"},{"name":"ActionCodeUpdate","id":"5e6b7de2-b263-4dc0-8a89-c9a565437c8a","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"CALL\",\n    \"description\": \"Phone Call - Updated\",\n    \"active\": true,\n    \"resultRequired\": true,\n    \"actionType\": 1,\n    \"actionCodeVisibility\": 1,\n    \"emailDealer\": false,\n    \"isAlert\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ActionCode/{{action_code_or_id}}","description":"<h3 id=\"update-action-code\">Update Action Code</h3>\n<p>Updates an existing <code>Common.ActionCode</code> resolved from the <code>{codeOrId}</code> path segment. The controller looks up the row via <code>SharedWSServices.GetCommonActionCodeId</code> (Guid-first, then code string), fetches the current entity to obtain its rowversion (<code>Ts</code>), and then forwards the payload to <code>ActionCodeWSServices.AddSaveActionCodeChangesWS</code> with the resolved <code>id</code> and existing <code>ts</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are supplied server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ActionCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the current action-code string or the row <code>Id</code> Guid. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) action code. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>resultRequired</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>actionType</em></td>\n<td>Required int. <code>ActionType</code> enum: <code>1</code> Standard, <code>2</code> System.</td>\n</tr>\n<tr>\n<td><em>actionCodeVisibility</em></td>\n<td>Required int. <code>ActionCodeVisibility</code> enum: <code>1</code> All, <code>2</code> Client, <code>3</code> Dealer, <code>4</code> Agent, <code>5</code> InternalOnly.</td>\n</tr>\n<tr>\n<td><em>emailDealer</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em> ... <em>addRemarkCode5OrId</em></td>\n<td>Optional remark codes (code or Guid) to add when this action code is logged.</td>\n</tr>\n<tr>\n<td><em>removeRemarkCodeOrId</em> ... <em>removeRemarkCode5OrId</em></td>\n<td>Optional remark codes (code or Guid) to clear when this action code is logged.</td>\n</tr>\n<tr>\n<td><em>isAlert</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ActionCode","{{action_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"745eb096-28a3-414f-86ac-3e7f98d24a6c","name":"UpdateActionCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"CALL\",\n    \"description\": \"Phone Call - Updated\",\n    \"active\": true,\n    \"resultRequired\": true,\n    \"actionType\": 1,\n    \"actionCodeVisibility\": 1,\n    \"emailDealer\": false,\n    \"isAlert\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ActionCode/CALL"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"fb39fe7d-d3a2-48c5-a404-f7eea5d763ee","name":"UpdateActionCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"CALL\",\n    \"description\": \"Phone Call - Updated\",\n    \"active\": true,\n    \"resultRequired\": true,\n    \"actionType\": 1,\n    \"actionCodeVisibility\": 1,\n    \"emailDealer\": false,\n    \"isAlert\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ActionCode/NOPE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Action code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"5e6b7de2-b263-4dc0-8a89-c9a565437c8a"},{"name":"ActiveHoldbackBasesGetAll","id":"c45645f1-5e55-433a-a2f8-1f295a1bdfc9","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis","description":"<h3 id=\"get-all-active-holdback-bases\">Get All Active Holdback Bases</h3>\n<p>Returns every active <code>Common.HoldbackBasis</code> row for the caller's client. The controller calls <code>HoldbackBasisWSServices.GetAllActiveHoldbackBasesWS</code>, which delegates to <code>HoldbackBasisServices.ReturnAllActiveHoldbackBasisByClient</code>. Rows marked unavailable (<code>Available = false</code>) are excluded. The active list drives the reserve / discount / withhold holdback-basis dropdowns on Dealer and Class screens.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/HoldbackBasis</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","HoldbackBasis"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d9da990e-632c-45cf-a6a2-68e9f48d732b","name":"GetAllActiveHoldbackBases - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Cash Price + Fees\",\n            \"Available\": true,\n            \"IncludeCashPrice\": true,\n            \"IncludeDealerInsurance\": false,\n            \"IncludeLenderInsurance\": false,\n            \"IncludeDealerMarkup\": false,\n            \"IncludeOriginationFees\": true,\n            \"IncludeAdvanceAdjustmentFees\": true,\n            \"IncludeDownpayment\": false,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"45cf147d-9ad5-4684-8a2b-1d2639768640","name":"GetAllActiveHoldbackBases - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"c45645f1-5e55-433a-a2f8-1f295a1bdfc9"},{"name":"ActiveRemarkCodesForClientGetAll","id":"05cc5871-5be1-4138-a472-43607ab52376","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/Active","description":"<h3 id=\"get-all-active-remark-codes-for-client\">Get All Active Remark Codes For Client</h3>\n<p>Returns all <code>Common.RemarkCode</code> rows flagged <code>Active = 1</code> for the caller's client. The WS layer (<code>RemarkCodeWSServices.ReturnAllActiveRemarkCodesForClientWS</code>) calls <code>RemarkCodeServices.ReturnAllActiveRemarkCodesForClient</code> which enforces the client scope from <code>LoginInfo.ClientId</code>. The response is a flat list of remark-code entities without the enhanced-row wrapper used by the full <code>/RemarkCode</code> list endpoint.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/RemarkCode/Active</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","RemarkCode","Active"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c857db03-3fdb-4dd5-be8c-fb991ea44a7f","name":"GetAllActiveRemarkCodesForClient - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/Active"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"VIP\",\n            \"Description\": \"VIP Customer\",\n            \"Active\": true,\n            \"Enhanced\": true,\n            \"CodeType\": 1,\n            \"MergeFieldDescription\": \"VIP\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"a83ce6e5-91a7-419b-81c2-7d3a2c0f8433","name":"GetAllActiveRemarkCodesForClient - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/Active"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"05cc5871-5be1-4138-a472-43607ab52376"},{"name":"AdminStatusAdd","id":"7f4bbdfc-8591-4289-9526-9df15d12a7f9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACT\",\n    \"description\": \"Active\",\n    \"active\": true,\n    \"enhanced\": false,\n    \"codeType\": 1,\n    \"collectionsScoreWeight\": 0,\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"isAlert\": false,\n    \"useCaresAct\": false,\n    \"useSecurity\": false,\n    \"allowLateFees\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdminStatus","description":"<h3 id=\"add-admin-status\">Add Admin Status</h3>\n<p>Creates a new <code>Common.AdminStatus</code> for the caller's client. The controller forwards the payload into <code>AdminStatusWSServices.AddSaveAdminStatusWS</code> with <code>id = null</code> and <code>ts = null</code> so the save treats it as an insert. The service rejects the request when another admin status with the same <code>code</code> already exists for the client. Returns the new row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdminStatus</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Unique (per client) short code (e.g. <code>ACT</code>).</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>enhanced</em></td>\n<td>Required boolean. <code>true</code> marks the status as enhanced (drives downstream collection/servicing behavior).</td>\n</tr>\n<tr>\n<td><em>codeType</em></td>\n<td>Required int. <code>AdminStatusCodeType</code> discriminator (e.g. <code>1</code> Open, <code>2</code> Charge-Off, <code>3</code> Closed, etc.).</td>\n</tr>\n<tr>\n<td><em>collectionsScoreWeight</em></td>\n<td>Optional decimal. Weight applied when calculating collection scores.</td>\n</tr>\n<tr>\n<td><em>creditStatus</em></td>\n<td>Optional int. Metro2-style credit status override.</td>\n</tr>\n<tr>\n<td><em>creditComment</em></td>\n<td>Optional int. Metro2-style credit comment override.</td>\n</tr>\n<tr>\n<td><em>allowPayments</em></td>\n<td>Required boolean. <code>true</code> permits payment posting while an account is at this status.</td>\n</tr>\n<tr>\n<td><em>allowTransactions</em></td>\n<td>Required boolean. <code>true</code> permits general account transactions.</td>\n</tr>\n<tr>\n<td><em>allowBilling</em></td>\n<td>Required boolean. <code>true</code> permits billing generation.</td>\n</tr>\n<tr>\n<td><em>allowLate</em></td>\n<td>Required boolean. <code>true</code> permits late-fee assessment logic.</td>\n</tr>\n<tr>\n<td><em>allowGeneralLetters</em></td>\n<td>Required boolean. <code>true</code> permits general letter generation.</td>\n</tr>\n<tr>\n<td><em>isAlert</em></td>\n<td>Required boolean. <code>true</code> surfaces this status as an alert on account screens.</td>\n</tr>\n<tr>\n<td><em>useCaresAct</em></td>\n<td>Required boolean. <code>true</code> enables CARES Act handling.</td>\n</tr>\n<tr>\n<td><em>closingAdminStatusCodeOrId</em></td>\n<td>Optional. Code or Guid of the admin status used when this status is closed.</td>\n</tr>\n<tr>\n<td><em>useSecurity</em></td>\n<td>Required boolean. <code>true</code> gates access via permission checks.</td>\n</tr>\n<tr>\n<td><em>allowLateFees</em></td>\n<td>Required boolean. <code>true</code> permits late fees while at this status.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdminStatus"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c669489f-7045-4fab-9c55-8a96089f5c3b","name":"AddAdminStatus - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACT\",\n    \"description\": \"Active\",\n    \"active\": true,\n    \"enhanced\": false,\n    \"codeType\": 1,\n    \"collectionsScoreWeight\": 0,\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"isAlert\": false,\n    \"useCaresAct\": false,\n    \"useSecurity\": false,\n    \"allowLateFees\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdminStatus"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"fced39c6-a09a-4f39-961a-5aaeeb131b41","name":"AddAdminStatus - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACT\",\n    \"description\": \"Active\",\n    \"active\": true,\n    \"enhanced\": false,\n    \"codeType\": 1,\n    \"collectionsScoreWeight\": 0,\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"isAlert\": false,\n    \"useCaresAct\": false,\n    \"useSecurity\": false,\n    \"allowLateFees\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdminStatus"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Admin status with code 'ACT' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"7f4bbdfc-8591-4289-9526-9df15d12a7f9"},{"name":"AdminStatusesGetAll","id":"b8931b5a-cc13-46f8-929d-d53ddbeac6bb","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdminStatus","description":"<h3 id=\"get-all-admin-statuses\">Get All Admin Statuses</h3>\n<p>Returns every <code>Common.AdminStatus</code> row for the caller's client via <code>AdminStatusWSServices.ReturnAllAdminStatusesWS</code>. An optional <code>activeOnly</code> query flag filters out inactive codes when <code>true</code>; the default (<code>false</code>) returns active and inactive rows together.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdminStatus</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>activeOnly</em></td>\n<td>Optional boolean. <code>true</code> limits the response to rows where <code>Active = 1</code>. Defaults to <code>false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdminStatus"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"96e76432-5cba-4783-bf4e-84bee1a958ad","name":"GetAllAdminStatuses - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdminStatus"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"ACT\",\n            \"Description\": \"Active\",\n            \"Active\": true,\n            \"Enhanced\": false,\n            \"CodeType\": 1,\n            \"CollectionsScoreWeight\": 0.00,\n            \"CreditStatus\": null,\n            \"CreditComment\": null,\n            \"AllowPayments\": true,\n            \"AllowTransactions\": true,\n            \"AllowBilling\": true,\n            \"AllowLate\": true,\n            \"AllowGeneralLetters\": true,\n            \"IsAlert\": false,\n            \"UseCaresAct\": false,\n            \"ClosingAdminStatusId\": null,\n            \"UseSecurity\": false,\n            \"AllowLateFees\": true,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"15ea28bb-5da1-4d32-88ab-18acc9a938c1","name":"GetAllAdminStatuses - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/Client/Common/AdminStatus"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b8931b5a-cc13-46f8-929d-d53ddbeac6bb"},{"name":"AdminStatusGet","id":"4d2d0fbf-a73c-4aa4-836f-e06fbbc2c16f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdminStatus/{{admin_status_code_or_id}}","description":"<h3 id=\"get-admin-status\">Get Admin Status</h3>\n<p>Returns a single <code>Common.AdminStatus</code> row resolved from the <code>{codeOrId}</code> path segment. Resolution runs through <code>SharedWSServices.GetCommonAdminStatusId</code> which tries <code>Guid.TryParse</code> first, then falls back to a client-scoped lookup by admin-status code. Returns <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdminStatus/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the admin-status code string (e.g. <code>ACT</code>) or the row <code>Id</code> Guid. Resolution is Guid-first, then code string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdminStatus","{{admin_status_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2933077a-856f-4208-acdf-a2e22200aa10","name":"GetAdminStatus - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdminStatus/ACT"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Code\": \"ACT\",\n        \"Description\": \"Active\",\n        \"Active\": true,\n        \"Enhanced\": false,\n        \"CodeType\": 1,\n        \"CollectionsScoreWeight\": 0.00,\n        \"CreditStatus\": null,\n        \"CreditComment\": null,\n        \"AllowPayments\": true,\n        \"AllowTransactions\": true,\n        \"AllowBilling\": true,\n        \"AllowLate\": true,\n        \"AllowGeneralLetters\": true,\n        \"IsAlert\": false,\n        \"UseCaresAct\": false,\n        \"ClosingAdminStatusId\": null,\n        \"UseSecurity\": false,\n        \"AllowLateFees\": true,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"97a3a7b8-1765-41b3-b556-fcd8d1a504bc","name":"GetAdminStatus - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdminStatus/ZZZ"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Admin status not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"4d2d0fbf-a73c-4aa4-836f-e06fbbc2c16f"},{"name":"AdminStatusUpdate","id":"57120585-1c0d-4cc4-b731-c8ecc0b9c495","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACT\",\n    \"description\": \"Active - Updated\",\n    \"active\": true,\n    \"enhanced\": false,\n    \"codeType\": 1,\n    \"collectionsScoreWeight\": 0,\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"isAlert\": false,\n    \"useCaresAct\": false,\n    \"useSecurity\": false,\n    \"allowLateFees\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdminStatus/{{admin_status_code_or_id}}","description":"<h3 id=\"update-admin-status\">Update Admin Status</h3>\n<p>Updates an existing <code>Common.AdminStatus</code> resolved from the <code>{codeOrId}</code> path segment. The controller looks up the row via <code>SharedWSServices.GetCommonAdminStatusId</code> (Guid-first, then code string), fetches the current entity to obtain its rowversion (<code>Ts</code>), and then forwards the payload to <code>AdminStatusWSServices.AddSaveAdminStatusWS</code> with the resolved <code>id</code> and existing <code>ts</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are supplied server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdminStatus/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the current admin-status code string or the row <code>Id</code> Guid. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) admin-status code. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>enhanced</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>codeType</em></td>\n<td>Required int. <code>AdminStatusCodeType</code> discriminator.</td>\n</tr>\n<tr>\n<td><em>collectionsScoreWeight</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>creditStatus</em></td>\n<td>Optional int. Metro2-style credit status override.</td>\n</tr>\n<tr>\n<td><em>creditComment</em></td>\n<td>Optional int. Metro2-style credit comment override.</td>\n</tr>\n<tr>\n<td><em>allowPayments</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>allowTransactions</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>allowBilling</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>allowLate</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>allowGeneralLetters</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>isAlert</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>useCaresAct</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>closingAdminStatusCodeOrId</em></td>\n<td>Optional. Code or Guid of the admin status used when this status is closed.</td>\n</tr>\n<tr>\n<td><em>useSecurity</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>allowLateFees</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdminStatus","{{admin_status_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a7a4ba6b-a5f5-4e96-870d-04daf70e7a65","name":"UpdateAdminStatus - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACT\",\n    \"description\": \"Active - Updated\",\n    \"active\": true,\n    \"enhanced\": false,\n    \"codeType\": 1,\n    \"collectionsScoreWeight\": 0,\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"isAlert\": false,\n    \"useCaresAct\": false,\n    \"useSecurity\": false,\n    \"allowLateFees\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdminStatus/ACT"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"22d8557b-b194-46d6-8e28-5a1ef41ad58d","name":"UpdateAdminStatus - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ZZZ\",\n    \"description\": \"Active - Updated\",\n    \"active\": true,\n    \"enhanced\": false,\n    \"codeType\": 1,\n    \"collectionsScoreWeight\": 0,\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"isAlert\": false,\n    \"useCaresAct\": false,\n    \"useSecurity\": false,\n    \"allowLateFees\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdminStatus/ZZZ"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Admin status not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"57120585-1c0d-4cc4-b731-c8ecc0b9c495"},{"name":"AdvanceAdjustmentFeeAdd","id":"e956e916-ac4b-4754-a587-43540ec1ab4c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Title Fee\",\n    \"active\": true,\n    \"glAccountNumberOrId\": \"1000\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee","description":"<h3 id=\"add-advance-adjustment-fee\">Add Advance Adjustment Fee</h3>\n<p>Creates a new <code>Common.AdvanceAdjustmentFee</code> for the caller's client. The controller forwards the payload into <code>AdvanceAdjustmentFeeWSServices.AddSaveAdvanceAdjustmentFeeWS</code> with <code>id = null</code> and <code>ts = null</code> so the save treats it as an insert. The service rejects the request when another fee with the same <code>description</code> already exists for the client. Returns the new row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Unique (per client) description (e.g. <code>Title Fee</code>).</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. <code>true</code> makes the fee selectable on advance adjustment transactions.</td>\n</tr>\n<tr>\n<td><em>glAccountNumberOrId</em></td>\n<td>Required. GL account number string or Guid where the fee is booked.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdvanceAdjustmentFee"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9d6d455e-64cb-456a-89ed-4b44816542ac","name":"AddAdvanceAdjustmentFee - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Title Fee\",\n    \"active\": true,\n    \"glAccountNumberOrId\": \"1000\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"4d8dc265-5f85-4649-bfd3-16dc99aff139","name":"AddAdvanceAdjustmentFee - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Title Fee\",\n    \"active\": true,\n    \"glAccountNumberOrId\": \"1000\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Advance adjustment fee with description 'Title Fee' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e956e916-ac4b-4754-a587-43540ec1ab4c"},{"name":"AdvanceAdjustmentFeeGet","id":"120ca4cc-58bc-492b-90f8-3117ad8ed933","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/{{description_or_id}}","description":"<h3 id=\"get-advance-adjustment-fee\">Get Advance Adjustment Fee</h3>\n<p>Returns a single <code>Common.AdvanceAdjustmentFee</code> row resolved from the <code>{descriptionOrId}</code> path segment. Resolution runs <code>Guid.TryParse</code> first and falls back to a client-scoped lookup by description string via <code>AdvanceAdjustmentFeeServices.ReturnAdvanceAdjustmentFee</code>. Returns <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/{descriptionOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required. Either the fee description string (e.g. <code>Title Fee</code>) or the row <code>Id</code> Guid. Resolution is Guid-first, then description string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdvanceAdjustmentFee","{{description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"92a5ef91-dfb7-4a41-a36a-262a911a4ae9","name":"GetAdvanceAdjustmentFee - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/Title%20Fee"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Title Fee\",\n        \"Active\": true,\n        \"GLAccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"ffeed956-775f-4713-ae67-e19b7b05135c","name":"GetAdvanceAdjustmentFee - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/Nonexistent%20Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Advance adjustment fee not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"120ca4cc-58bc-492b-90f8-3117ad8ed933"},{"name":"AdvanceAdjustmentFeesGetAll","id":"870774f6-1f88-47fe-a1ab-776b5484b514","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee","description":"<h3 id=\"get-all-advance-adjustment-fees\">Get All Advance Adjustment Fees</h3>\n<p>Returns every <code>Common.AdvanceAdjustmentFee</code> row for the caller's client via <code>AdvanceAdjustmentFeeWSServices.ReturnAllAdvanceAdjustmentFeesWS</code>. Each row is the description-scoped fee definition used on advance adjustment transactions, with the GL account it posts to.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdvanceAdjustmentFee"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cc7bcdcc-d103-4981-ba9e-5996f3c3a277","name":"GetAllAdvanceAdjustmentFees - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Title Fee\",\n            \"Active\": true,\n            \"GLAccountId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"42df3c67-6368-4bf6-b805-6fd9e20a6c12","name":"GetAllAdvanceAdjustmentFees - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"870774f6-1f88-47fe-a1ab-776b5484b514"},{"name":"AdvanceAdjustmentFeeUpdate","id":"237cbcc5-67cd-49b0-ae69-40efccfc071b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Title Fee - Updated\",\n    \"active\": true,\n    \"glAccountNumberOrId\": \"1000\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/{{description_or_id}}","description":"<h3 id=\"update-advance-adjustment-fee\">Update Advance Adjustment Fee</h3>\n<p>Updates an existing <code>Common.AdvanceAdjustmentFee</code> resolved from the <code>{descriptionOrId}</code> path segment. The controller tries <code>Guid.TryParse</code> first, then falls back to a client-scoped description lookup, fetches the current entity to obtain its rowversion (<code>Ts</code>), and forwards the payload to <code>AdvanceAdjustmentFeeWSServices.AddSaveAdvanceAdjustmentFeeWS</code> with the resolved <code>id</code> and existing <code>ts</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are supplied server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/{descriptionOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required. Either the current fee description string or the row <code>Id</code> Guid. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New (or unchanged) description. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>glAccountNumberOrId</em></td>\n<td>Required. GL account number string or Guid where the fee is booked.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","AdvanceAdjustmentFee","{{description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fe01bab4-c057-4e2d-ae71-6081278269ed","name":"UpdateAdvanceAdjustmentFee - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Title Fee - Updated\",\n    \"active\": true,\n    \"glAccountNumberOrId\": \"1000\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/Title%20Fee"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"93695878-7afe-42b2-a082-b03ba73b5614","name":"UpdateAdvanceAdjustmentFee - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Title Fee - Updated\",\n    \"active\": true,\n    \"glAccountNumberOrId\": \"1000\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/AdvanceAdjustmentFee/Nonexistent%20Fee"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Advance adjustment fee not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"237cbcc5-67cd-49b0-ae69-40efccfc071b"},{"name":"CheckProvinceRuleInUse","id":"bbeb1021-ebba-4e12-ba8f-3a9a8944ebdc","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/{{province_rule_id}}/InUse","description":"<h3 id=\"check-province-rule-in-use\">Check Province Rule In Use</h3>\n<p>Checks whether a <code>Common.ProvinceRule</code> is referenced by any account entity. The controller resolves <code>{id}</code> with <code>SharedWSServices.GetCommonProvinceRuleId</code> and returns an object in <code>data</code> with a boolean <code>inUse</code> field.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ProvinceRule/{id}/InUse</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required. Province rule Guid or client-scoped description/code value.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ProvinceRule","{{province_rule_id}}","InUse"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e4c6a715-b49c-4f4d-ad17-8d07228ba49c","name":"CheckProvinceRuleInUse - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/00000000-0000-0000-0000-000000000000/InUse"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"inUse\": false\n    }\n}"},{"id":"07f2ba5a-3d34-4747-9fa8-79b0c0cbabdf","name":"CheckProvinceRuleInUse - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/NOPE/InUse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid province rule ID or code\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"bbeb1021-ebba-4e12-ba8f-3a9a8944ebdc"},{"name":"ClassAdd","id":"60f6e916-f81a-41e5-989d-2472b595110d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"number\": 1,\n  \"description\": \"Standard Auto\",\n  \"active\": true,\n  \"earningsStartDateOption\": 1,\n  \"allowedPaymentFrequencies\": 1,\n  \"wholeDollarPayments\": false,\n  \"allowSameAsCash\": false,\n  \"sameAsCashDefaultMethod\": 0,\n  \"generatePaymentReceiptForAllPayments\": false,\n  \"amortizationMethod\": 1,\n  \"convertMatured\": false,\n  \"allowRefinancing\": false,\n  \"availableCreditCalculationMethod\": 0,\n  \"saveIndirect\": false,\n  \"saveInstallmentPreComp\": false,\n  \"defaultJudgmentClass\": null,\n  \"disableAcctLateChargeAfterJudgment\": false,\n  \"useAccrualFreeze\": false,\n  \"paymentVisionFeeTransactionCodeOrId\": null,\n  \"defaultOneTimePaymentCodeOrId\": null,\n  \"defaultOneTimeFundsCodeDescriptionOrId\": null,\n  \"paymentVisionTransactionCodeOrId\": null,\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": null,\n  \"externalPaymentCodeOrId\": null,\n  \"externalPvFeeCodeOrId\": null,\n  \"externalACHFundsCodeDescriptionOrId\": null,\n  \"externalCCFundsCodeDescriptionOrId\": null,\n  \"externalDebitFundsCodeDescriptionOrId\": null,\n  \"pvCashFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultQuickPaymentCodeOrId\": null,\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultRecurringPaymentCodeOrId\": null,\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedPaymentCodeOrId\": null,\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultQuickPaymentCodeOrId\": null,\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultRecurringPaymentCodeOrId\": null,\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedPaymentCodeOrId\": null,\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"defaultJudgmentClassNumberOrId\": null,\n  \"custProvidedPropertyProductCodeOrId\": null,\n  \"paymentReceiptFormCodeOrId\": null,\n  \"chargeOffCodeOrId\": null,\n  \"unwindCodeOrId\": null,\n  \"buybackCodeOrId\": null,\n  \"writeoffCodeOrId\": null,\n  \"payoffPaymentTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Class","description":"<h3 id=\"add-class\">Add Class</h3>\n<p>Creates a new <code>Common.Class</code> for the caller's client. The controller maps the payload through <code>ClassController.MapToAddSaveParameter</code>, sets <code>id = null</code> and <code>ts = null</code>, and forwards it to <code>ClassWSServices.AddSaveClassWS</code>. The service rejects the request when another class with the same <code>number</code> already exists for the client. Returns the new row's Guid in <code>data</code>.</p>\n<p>Class payloads are broad — they drive header, installment, refinance, indirect, precomp, matured-conversion, electronic-payment, portal, and judgment/freeze behavior. Fields are grouped below.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Class</code></p>\n<h4 id=\"request-body-parameters--header\">Request Body Parameters — Header</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>number</em></td>\n<td>Required int. Unique (per client) class number.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. Defaults to <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>minDaysTo1stPmt</em> / <em>maxDaysTo1stPmt</em></td>\n<td>Optional int range for allowable days to first payment.</td>\n</tr>\n<tr>\n<td><em>minPrincipal</em> / <em>maxPrincipal</em></td>\n<td>Optional decimal range for principal.</td>\n</tr>\n<tr>\n<td><em>minSameAsCashExpDay</em> / <em>maxSameAsCashExpDay</em></td>\n<td>Optional int range for same-as-cash expiration days.</td>\n</tr>\n<tr>\n<td><em>provinceRuleCodeOrId</em> / <em>collateralCodeOrId</em> / <em>customFieldSetCodeOrId</em> / <em>paymentReceiptFormCodeOrId</em> / <em>custProvidedPropertyProductCodeOrId</em></td>\n<td>Optional keys or GUIDs; receipt forms use the filename, and products use the product code.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>nextDueDateUpdatePercent</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>earningsStartDateOption</em></td>\n<td>Required int enum.</td>\n</tr>\n<tr>\n<td><em>allowedPaymentFrequencies</em></td>\n<td>Required int bitmask (payment frequencies enum).</td>\n</tr>\n<tr>\n<td><em>wholeDollarPayments</em> / <em>allowSameAsCash</em> / <em>generatePaymentReceiptForAllPayments</em></td>\n<td>Required booleans.</td>\n</tr>\n<tr>\n<td><em>sameAsCashDefaultMethod</em></td>\n<td>Required int enum.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--installment\">Request Body Parameters — Installment</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>minTerm</em> / <em>maxTerm</em> / <em>minAmortizedTerm</em> / <em>maxAmortizedTerm</em></td>\n<td>Optional int ranges.</td>\n</tr>\n<tr>\n<td><em>amortizationMethod</em></td>\n<td>Required int enum.</td>\n</tr>\n<tr>\n<td><em>aprMethod</em></td>\n<td>Optional int enum.</td>\n</tr>\n<tr>\n<td><em>convertMatured</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>chargeOffCodeOrId</em> / <em>unwindCodeOrId</em> / <em>buybackCodeOrId</em> / <em>writeoffCodeOrId</em></td>\n<td>Optional codes or Guids.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--refinance\">Request Body Parameters — Refinance</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>allowRefinancing</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>maxNumberOfRollovers</em> / <em>minDaysActiveBeforeRefi</em> / <em>classRefinanceMaxNumberOfACQFees</em> / <em>classRefinanceNumberOfDaysForACQFees</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>minAvailableCredit</em> / <em>acqFeeRefiAmountFinanced</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>payoffPaymentTransactionCodeOrId</em></td>\n<td>Optional code or Guid.</td>\n</tr>\n<tr>\n<td><em>showAvailableCredit</em></td>\n<td>Optional boolean.</td>\n</tr>\n<tr>\n<td><em>availableCreditCalculationMethod</em></td>\n<td>Required int enum.</td>\n</tr>\n<tr>\n<td><em>acqFeeRefiUpToAmtFinLessThanXMonths</em> / <em>acqFeeRefiMoreThanAmtFinLessThanXMonths</em></td>\n<td>Optional int.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--indirect--precomp--matured\">Request Body Parameters — Indirect / Precomp / Matured</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>saveIndirect</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>yieldCalcMethod</em> / <em>discountEarningMethod</em> / <em>discountEarningsBasis</em> / <em>outOfToleranceAPR</em></td>\n<td>Optional int / decimal as appropriate.</td>\n</tr>\n<tr>\n<td><em>saveInstallmentPreComp</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>pcFinanceChargeEarningsMethod</em> / <em>pcFinanceChargeEarningsBasis</em> / <em>pcFinanceChargeRebateMethod</em> / <em>pcRemainingTermMethod</em> / <em>pcRemainingTermDays</em></td>\n<td>Optional int enums / day counts.</td>\n</tr>\n<tr>\n<td><em>daysAfterMaturityToConvert</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>newClassCodeOrId</em> / <em>newAdminStatusCodeOrId</em> / <em>addRemarkCodeOrId</em></td>\n<td>Optional codes or Guids.</td>\n</tr>\n<tr>\n<td><em>newRate</em></td>\n<td>Optional decimal.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--electronic--portal--judgment\">Request Body Parameters — Electronic / Portal / Judgment</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>defaultOmegaElectronicPayment</em> / <em>availableElectronicPaymentTypes</em> / <em>includeInternalPaymentPVFee</em> / <em>includeExternalPaymentPVFee</em></td>\n<td>Optional flags.</td>\n</tr>\n<tr>\n<td><em>paymentVisionFeeTransactionCode</em> / <em>defaultOneTimePaymentCode</em> / <em>defaultOneTimeFundsCodeId</em> / <em>defaultOneTimeFeeAmount</em> / <em>paymentVisionTransactionCode</em> / <em>defaultElectronicPaymentFundsCodeId</em> / <em>defaultRecurringFeeAmount</em> / <em>externalPaymentCode</em> / <em>externalPvFeeCodeId</em> / <em>externalACHFundsCode</em> / <em>externalCCFundsCode</em> / <em>externalDebitFundsCode</em> / <em>pvCashFundsCodeId</em></td>\n<td>Optional PaymentVision / external-payment wiring.</td>\n</tr>\n<tr>\n<td><em>allowPNMPayment</em> / <em>pnmDefaultQuickPaymentCode</em> / <em>pnmDefaultQuickFundsCode</em> / <em>pnmDefaultRecurringPaymentCode</em> / <em>pnmDefaultRecurringFundsCode</em> / <em>pnmRetrievedPaymentCode</em> / <em>pnmRetrievedCashFundsCode</em> / <em>pnmRetrievedCreditCardFundsCode</em> / <em>pnmRetrievedAchFundsCode</em> / <em>pnmRetrievedDebitFundsCode</em></td>\n<td>Optional PaymentsNowMobile wiring.</td>\n</tr>\n<tr>\n<td><em>allowExpiTransPayment</em> / <em>expiTransDefaultQuickPaymentFeeAmount</em> / <em>expiTransDefaultQuickPaymentCode</em> / <em>expiTransDefaultQuickFundsCode</em> / <em>expiTransDefaultRecurringPaymentCode</em> / <em>expiTransDefaultRecurringFundsCode</em> / <em>expiTransDefaultRecurringFeeAmount</em> / <em>expiTransRetrievedPaymentCode</em> / <em>expiTransRetrievedCreditCardFundsCode</em> / <em>expiTransRetrievedAchFundsCode</em> / <em>expiTransRetrievedDebitFundsCode</em></td>\n<td>Optional Expi-Trans wiring.</td>\n</tr>\n<tr>\n<td><em>primaryCreditBureauProvider</em></td>\n<td>Optional int enum.</td>\n</tr>\n<tr>\n<td><em>collateralValue1Label</em> / <em>collateralValue2Label</em> / <em>collateralValue3Label</em> / <em>collateralValue1Provider</em> / <em>collateralValue2Provider</em> / <em>collateralValue3Provider</em></td>\n<td>Optional collateral valuation labels / providers.</td>\n</tr>\n<tr>\n<td><em>allowPortalPayments</em> / <em>allowPortalUserChangePaymentApplied</em> / <em>allowFutureOneTimePortalPayments</em> / <em>allowRecurringPortalPayments</em></td>\n<td>Optional portal payment flags.</td>\n</tr>\n<tr>\n<td><em>portalMinimumFixedAmount</em> / <em>defaultPortalPaymentAmount</em> / <em>maxPaymentAmountDaily</em></td>\n<td>Optional decimals.</td>\n</tr>\n<tr>\n<td><em>minDays</em> / <em>maxActiveAccounts</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>defaultJudgmentClass</em></td>\n<td>Optional judgment-class GUID; alternatively use <code>defaultJudgmentClassNumberOrId</code>.</td>\n</tr>\n<tr>\n<td><em>disableAcctLateChargeAfterJudgment</em> / <em>useAccrualFreeze</em></td>\n<td>Required booleans.</td>\n</tr>\n<tr>\n<td><em>daysPastDueToTriggerFreeze</em> / <em>daysPastDueToTriggerUnFreeze</em></td>\n<td>Optional int.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>paymentVisionFeeTransactionCodeOrId</code></td>\n<td><code>paymentVisionFeeTransactionCode</code></td>\n<td>String. miscellaneous other-balance journal transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOneTimePaymentCodeOrId</code></td>\n<td><code>defaultOneTimePaymentCode</code></td>\n<td>String. regular or extension non-journal payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOneTimeFundsCodeDescriptionOrId</code></td>\n<td><code>defaultOneTimeFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>paymentVisionTransactionCodeOrId</code></td>\n<td><code>paymentVisionTransactionCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultElectronicPaymentFundsCodeDescriptionOrId</code></td>\n<td><code>defaultElectronicPaymentFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalPaymentCodeOrId</code></td>\n<td><code>externalPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalPvFeeCodeOrId</code></td>\n<td><code>externalPvFeeCodeId</code></td>\n<td>String. miscellaneous other-balance journal transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalACHFundsCodeDescriptionOrId</code></td>\n<td><code>externalACHFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalCCFundsCodeDescriptionOrId</code></td>\n<td><code>externalCCFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalDebitFundsCodeDescriptionOrId</code></td>\n<td><code>externalDebitFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pvCashFundsCodeDescriptionOrId</code></td>\n<td><code>pvCashFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultQuickPaymentCodeOrId</code></td>\n<td><code>pnmDefaultQuickPaymentCode</code></td>\n<td>String. regular or extension non-journal payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultQuickFundsCodeDescriptionOrId</code></td>\n<td><code>pnmDefaultQuickFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultRecurringPaymentCodeOrId</code></td>\n<td><code>pnmDefaultRecurringPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultRecurringFundsCodeDescriptionOrId</code></td>\n<td><code>pnmDefaultRecurringFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedPaymentCodeOrId</code></td>\n<td><code>pnmRetrievedPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedCashFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedCashFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedCreditCardFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedCreditCardFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedAchFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedAchFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedDebitFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedDebitFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultQuickPaymentCodeOrId</code></td>\n<td><code>expiTransDefaultQuickPaymentCode</code></td>\n<td>String. regular or extension non-journal payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultQuickFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransDefaultQuickFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultRecurringPaymentCodeOrId</code></td>\n<td><code>expiTransDefaultRecurringPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultRecurringFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransDefaultRecurringFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedPaymentCodeOrId</code></td>\n<td><code>expiTransRetrievedPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedCreditCardFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransRetrievedCreditCardFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedAchFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransRetrievedAchFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedDebitFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransRetrievedDebitFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultJudgmentClassNumberOrId</code></td>\n<td><code>defaultJudgmentClass</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>custProvidedPropertyProductCodeOrId</code></td>\n<td><code>custProvidedPropertyProductCodeOrId</code></td>\n<td>String. customer-tracking insurance product code or matching product GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>paymentReceiptFormCodeOrId</code></td>\n<td><code>paymentReceiptFormCodeOrId</code></td>\n<td>String. payment-receipt merge-form filename or matching form GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>chargeOffCodeOrId</code></td>\n<td><code>chargeOffCodeOrId</code></td>\n<td>String. charge-off close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>unwindCodeOrId</code></td>\n<td><code>unwindCodeOrId</code></td>\n<td>String. unwind close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>buybackCodeOrId</code></td>\n<td><code>buybackCodeOrId</code></td>\n<td>String. repurchase or repurchase-like close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>writeoffCodeOrId</code></td>\n<td><code>writeoffCodeOrId</code></td>\n<td>String. write-off close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>payoffPaymentTransactionCodeOrId</code></td>\n<td><code>payoffPaymentTransactionCodeOrId</code></td>\n<td>String. regular journal-payment transaction code or matching transaction-code GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. Existing optional key-or-GUID fields listed above retain blank-to-clear behavior; a nonblank unknown key now fails instead of clearing the setting.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"paymentVisionFeeTransactionCodeOrId\": \"FEE\",\n  \"defaultOneTimePaymentCodeOrId\": \"QPM\",\n  \"defaultOneTimeFundsCodeDescriptionOrId\": \"Check\",\n  \"paymentVisionTransactionCodeOrId\": \"EPM\",\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": \"Check\",\n  \"externalPaymentCodeOrId\": \"EPM\",\n  \"externalPvFeeCodeOrId\": \"FEE\",\n  \"externalACHFundsCodeDescriptionOrId\": \"Check\",\n  \"externalCCFundsCodeDescriptionOrId\": \"Check\",\n  \"externalDebitFundsCodeDescriptionOrId\": \"Check\",\n  \"pvCashFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmDefaultQuickPaymentCodeOrId\": \"QPM\",\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmDefaultRecurringPaymentCodeOrId\": \"EPM\",\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedPaymentCodeOrId\": \"EPM\",\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransDefaultQuickPaymentCodeOrId\": \"QPM\",\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransDefaultRecurringPaymentCodeOrId\": \"EPM\",\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransRetrievedPaymentCodeOrId\": \"EPM\",\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": \"Check\",\n  \"defaultJudgmentClassNumberOrId\": \"1\",\n  \"custProvidedPropertyProductCodeOrId\": \"CPPI\",\n  \"paymentReceiptFormCodeOrId\": \"Payment Receipt\",\n  \"chargeOffCodeOrId\": \"CO\",\n  \"unwindCodeOrId\": \"UNW\",\n  \"buybackCodeOrId\": \"RP\",\n  \"writeoffCodeOrId\": \"WO\",\n  \"payoffPaymentTransactionCodeOrId\": \"PYC\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","Class"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8be73d2b-4101-4307-a1ef-1227c4d6bffe","name":"AddClass - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"number\": 1,\n  \"description\": \"Standard Auto\",\n  \"active\": true,\n  \"earningsStartDateOption\": 1,\n  \"allowedPaymentFrequencies\": 1,\n  \"wholeDollarPayments\": false,\n  \"allowSameAsCash\": false,\n  \"sameAsCashDefaultMethod\": 0,\n  \"generatePaymentReceiptForAllPayments\": false,\n  \"amortizationMethod\": 1,\n  \"convertMatured\": false,\n  \"allowRefinancing\": false,\n  \"availableCreditCalculationMethod\": 0,\n  \"saveIndirect\": false,\n  \"saveInstallmentPreComp\": false,\n  \"defaultJudgmentClass\": null,\n  \"disableAcctLateChargeAfterJudgment\": false,\n  \"useAccrualFreeze\": false,\n  \"paymentVisionFeeTransactionCodeOrId\": null,\n  \"defaultOneTimePaymentCodeOrId\": null,\n  \"defaultOneTimeFundsCodeDescriptionOrId\": null,\n  \"paymentVisionTransactionCodeOrId\": null,\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": null,\n  \"externalPaymentCodeOrId\": null,\n  \"externalPvFeeCodeOrId\": null,\n  \"externalACHFundsCodeDescriptionOrId\": null,\n  \"externalCCFundsCodeDescriptionOrId\": null,\n  \"externalDebitFundsCodeDescriptionOrId\": null,\n  \"pvCashFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultQuickPaymentCodeOrId\": null,\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultRecurringPaymentCodeOrId\": null,\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedPaymentCodeOrId\": null,\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultQuickPaymentCodeOrId\": null,\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultRecurringPaymentCodeOrId\": null,\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedPaymentCodeOrId\": null,\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"defaultJudgmentClassNumberOrId\": null,\n  \"custProvidedPropertyProductCodeOrId\": null,\n  \"paymentReceiptFormCodeOrId\": null,\n  \"chargeOffCodeOrId\": null,\n  \"unwindCodeOrId\": null,\n  \"buybackCodeOrId\": null,\n  \"writeoffCodeOrId\": null,\n  \"payoffPaymentTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Class"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"a7b0eb5b-27bf-449d-8e51-b96163a144f7","name":"AddClass - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"number\": 0,\n  \"description\": \"Standard Auto\",\n  \"active\": true,\n  \"earningsStartDateOption\": 1,\n  \"allowedPaymentFrequencies\": 1,\n  \"wholeDollarPayments\": false,\n  \"allowSameAsCash\": false,\n  \"sameAsCashDefaultMethod\": 0,\n  \"generatePaymentReceiptForAllPayments\": false,\n  \"amortizationMethod\": 1,\n  \"convertMatured\": false,\n  \"allowRefinancing\": false,\n  \"availableCreditCalculationMethod\": 0,\n  \"saveIndirect\": false,\n  \"saveInstallmentPreComp\": false,\n  \"defaultJudgmentClass\": null,\n  \"disableAcctLateChargeAfterJudgment\": false,\n  \"useAccrualFreeze\": false,\n  \"paymentVisionFeeTransactionCodeOrId\": null,\n  \"defaultOneTimePaymentCodeOrId\": null,\n  \"defaultOneTimeFundsCodeDescriptionOrId\": null,\n  \"paymentVisionTransactionCodeOrId\": null,\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": null,\n  \"externalPaymentCodeOrId\": null,\n  \"externalPvFeeCodeOrId\": null,\n  \"externalACHFundsCodeDescriptionOrId\": null,\n  \"externalCCFundsCodeDescriptionOrId\": null,\n  \"externalDebitFundsCodeDescriptionOrId\": null,\n  \"pvCashFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultQuickPaymentCodeOrId\": null,\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultRecurringPaymentCodeOrId\": null,\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedPaymentCodeOrId\": null,\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultQuickPaymentCodeOrId\": null,\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultRecurringPaymentCodeOrId\": null,\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedPaymentCodeOrId\": null,\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"defaultJudgmentClassNumberOrId\": null,\n  \"custProvidedPropertyProductCodeOrId\": null,\n  \"paymentReceiptFormCodeOrId\": null,\n  \"chargeOffCodeOrId\": null,\n  \"unwindCodeOrId\": null,\n  \"buybackCodeOrId\": null,\n  \"writeoffCodeOrId\": null,\n  \"payoffPaymentTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Class"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Class number is required and must be greater than zero\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"60f6e916-f81a-41e5-989d-2472b595110d"},{"name":"ClassesGetAll","id":"e2e81333-8f5c-4b13-b56d-36790a423b06","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Class","description":"<h3 id=\"get-all-classes\">Get All Classes</h3>\n<p>Returns every <code>Common.Class</code> row for the caller's client via <code>ClassWSServices.GetAllClassesWS</code>. Each row is the loan-class configuration that drives underwriting, servicing, refinance, precomp, and portal-payment behavior on accounts assigned to it.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Class</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","Class"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"697549be-54b4-4829-b2a8-3898ec786ae2","name":"GetAllClasses - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Class"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Number\": 1,\n            \"Description\": \"Standard Auto\",\n            \"Active\": true,\n            \"EarningsStartDateOption\": 1,\n            \"AllowedPaymentFrequencies\": 1,\n            \"WholeDollarPayments\": false,\n            \"AllowSameAsCash\": false,\n            \"SameAsCashDefaultMethod\": 0,\n            \"GeneratePaymentReceiptForAllPayments\": false,\n            \"AmortizationMethod\": 1,\n            \"ConvertMatured\": false,\n            \"AllowRefinancing\": false,\n            \"AvailableCreditCalculationMethod\": 0,\n            \"SaveIndirect\": false,\n            \"SaveInstallmentPreComp\": false,\n            \"DefaultJudgmentClass\": false,\n            \"DisableAcctLateChargeAfterJudgment\": false,\n            \"UseAccrualFreeze\": false,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"b412005e-e098-4846-ac7a-0b8f20b9525b","name":"GetAllClasses - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/Class"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed: invalid or missing session id, token, or API key\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e2e81333-8f5c-4b13-b56d-36790a423b06"},{"name":"ClassGet","id":"02e56b47-0292-430d-9c62-444987776806","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Class/{{class_number_or_id}}","description":"<h3 id=\"get-class\">Get Class</h3>\n<p>Returns a single <code>Common.Class</code> row resolved from the <code>{classNumberOrId}</code> path segment. <code>ClassWSServices.GetClassWS</code> calls <code>SharedWSServices.GetCommonClassId</code> which tries <code>Guid.TryParse</code> first and then falls back to a client-scoped lookup by class number (integer). Returns <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Class/{classNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>classNumberOrId</em></td>\n<td>Required. Either the class number as a string (e.g. <code>1</code>) or the row <code>Id</code> Guid. Resolution is Guid-first, then integer class number.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","Class","{{class_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"71621c08-a34e-4503-b6f7-9e29b2f39818","name":"GetClass - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Class/1"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Number\": 1,\n        \"Description\": \"Standard Auto\",\n        \"Active\": true,\n        \"EarningsStartDateOption\": 1,\n        \"AllowedPaymentFrequencies\": 1,\n        \"WholeDollarPayments\": false,\n        \"AllowSameAsCash\": false,\n        \"SameAsCashDefaultMethod\": 0,\n        \"GeneratePaymentReceiptForAllPayments\": false,\n        \"AmortizationMethod\": 1,\n        \"ConvertMatured\": false,\n        \"AllowRefinancing\": false,\n        \"AvailableCreditCalculationMethod\": 0,\n        \"SaveIndirect\": false,\n        \"SaveInstallmentPreComp\": false,\n        \"DefaultJudgmentClass\": false,\n        \"DisableAcctLateChargeAfterJudgment\": false,\n        \"UseAccrualFreeze\": false,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"cb309f47-7fb8-4f97-808f-4599c3d74c06","name":"GetClass - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Class/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Class not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"02e56b47-0292-430d-9c62-444987776806"},{"name":"ClassUpdate","id":"836c56b6-3a79-456b-bbe2-b1550c769560","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"number\": 1,\n  \"description\": \"Standard Auto - Updated\",\n  \"active\": true,\n  \"earningsStartDateOption\": 1,\n  \"allowedPaymentFrequencies\": 1,\n  \"wholeDollarPayments\": false,\n  \"allowSameAsCash\": false,\n  \"sameAsCashDefaultMethod\": 0,\n  \"generatePaymentReceiptForAllPayments\": false,\n  \"amortizationMethod\": 1,\n  \"convertMatured\": false,\n  \"allowRefinancing\": false,\n  \"availableCreditCalculationMethod\": 0,\n  \"saveIndirect\": false,\n  \"saveInstallmentPreComp\": false,\n  \"defaultJudgmentClass\": null,\n  \"disableAcctLateChargeAfterJudgment\": false,\n  \"useAccrualFreeze\": false,\n  \"paymentVisionFeeTransactionCodeOrId\": null,\n  \"defaultOneTimePaymentCodeOrId\": null,\n  \"defaultOneTimeFundsCodeDescriptionOrId\": null,\n  \"paymentVisionTransactionCodeOrId\": null,\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": null,\n  \"externalPaymentCodeOrId\": null,\n  \"externalPvFeeCodeOrId\": null,\n  \"externalACHFundsCodeDescriptionOrId\": null,\n  \"externalCCFundsCodeDescriptionOrId\": null,\n  \"externalDebitFundsCodeDescriptionOrId\": null,\n  \"pvCashFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultQuickPaymentCodeOrId\": null,\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultRecurringPaymentCodeOrId\": null,\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedPaymentCodeOrId\": null,\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultQuickPaymentCodeOrId\": null,\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultRecurringPaymentCodeOrId\": null,\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedPaymentCodeOrId\": null,\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"defaultJudgmentClassNumberOrId\": null,\n  \"custProvidedPropertyProductCodeOrId\": null,\n  \"paymentReceiptFormCodeOrId\": null,\n  \"chargeOffCodeOrId\": null,\n  \"unwindCodeOrId\": null,\n  \"buybackCodeOrId\": null,\n  \"writeoffCodeOrId\": null,\n  \"payoffPaymentTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Class/{{class_number_or_id}}","description":"<h3 id=\"update-class\">Update Class</h3>\n<p>Updates an existing <code>Common.Class</code> resolved from the <code>{classNumberOrId}</code> path segment. The controller looks up the row via <code>SharedWSServices.GetCommonClassId</code> (Guid-first, then integer class number), fetches the current entity to obtain its rowversion (<code>Ts</code>), maps the payload through <code>ClassController.MapToAddSaveParameter</code>, and forwards it to <code>ClassWSServices.AddSaveClassWS</code> with the resolved <code>id</code> and existing <code>ts</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are supplied server-side. The same grouped field list from Add Class applies.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Class/{classNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>classNumberOrId</em></td>\n<td>Required. Either the current class number as a string or the row <code>Id</code> Guid. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Section</strong></th>\n<th><strong>Fields</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Header</td>\n<td><code>token</code>, <code>number</code>, <code>description</code>, <code>active</code>, <code>minDaysTo1stPmt</code>, <code>maxDaysTo1stPmt</code>, <code>minPrincipal</code>, <code>maxPrincipal</code>, <code>minSameAsCashExpDay</code>, <code>maxSameAsCashExpDay</code>, <code>provinceRuleCodeOrId</code>, <code>collateralCodeOrId</code>, <code>notes</code>, <code>nextDueDateUpdatePercent</code>, <code>customFieldSetCodeOrId</code>, <code>paymentReceiptFormCodeOrId</code>, <code>custProvidedPropertyProductCodeOrId</code>, <code>earningsStartDateOption</code>, <code>allowedPaymentFrequencies</code>, <code>wholeDollarPayments</code>, <code>allowSameAsCash</code>, <code>sameAsCashDefaultMethod</code>, <code>generatePaymentReceiptForAllPayments</code></td>\n</tr>\n<tr>\n<td>Installment</td>\n<td><code>minTerm</code>, <code>maxTerm</code>, <code>minAmortizedTerm</code>, <code>maxAmortizedTerm</code>, <code>amortizationMethod</code>, <code>aprMethod</code>, <code>convertMatured</code>, <code>chargeOffCodeOrId</code>, <code>unwindCodeOrId</code>, <code>buybackCodeOrId</code>, <code>writeoffCodeOrId</code></td>\n</tr>\n<tr>\n<td>Refinance</td>\n<td><code>allowRefinancing</code>, <code>maxNumberOfRollovers</code>, <code>minAvailableCredit</code>, <code>minDaysActiveBeforeRefi</code>, <code>payoffPaymentTransactionCodeOrId</code>, <code>showAvailableCredit</code>, <code>classRefinanceMaxNumberOfACQFees</code>, <code>classRefinanceNumberOfDaysForACQFees</code>, <code>availableCreditCalculationMethod</code>, <code>acqFeeRefiAmountFinanced</code>, <code>acqFeeRefiUpToAmtFinLessThanXMonths</code>, <code>acqFeeRefiMoreThanAmtFinLessThanXMonths</code></td>\n</tr>\n<tr>\n<td>Indirect</td>\n<td><code>saveIndirect</code>, <code>yieldCalcMethod</code>, <code>discountEarningMethod</code>, <code>discountEarningsBasis</code>, <code>outOfToleranceAPR</code></td>\n</tr>\n<tr>\n<td>Precomp</td>\n<td><code>saveInstallmentPreComp</code>, <code>pcFinanceChargeEarningsMethod</code>, <code>pcFinanceChargeEarningsBasis</code>, <code>pcFinanceChargeRebateMethod</code>, <code>pcRemainingTermMethod</code>, <code>pcRemainingTermDays</code></td>\n</tr>\n<tr>\n<td>Matured Conversion</td>\n<td><code>daysAfterMaturityToConvert</code>, <code>newClassCodeOrId</code>, <code>newRate</code>, <code>newAdminStatusCodeOrId</code>, <code>addRemarkCodeOrId</code></td>\n</tr>\n<tr>\n<td>Omega / PaymentVision</td>\n<td><code>defaultOmegaElectronicPayment</code>, <code>availableElectronicPaymentTypes</code>, <code>includeInternalPaymentPVFee</code>, <code>paymentVisionFeeTransactionCode</code>, <code>defaultOneTimePaymentCode</code>, <code>defaultOneTimeFundsCodeId</code>, <code>defaultOneTimeFeeAmount</code>, <code>paymentVisionTransactionCode</code>, <code>defaultElectronicPaymentFundsCodeId</code>, <code>defaultRecurringFeeAmount</code>, <code>externalPaymentCode</code>, <code>includeExternalPaymentPVFee</code>, <code>externalPvFeeCodeId</code>, <code>externalACHFundsCode</code>, <code>externalCCFundsCode</code>, <code>externalDebitFundsCode</code>, <code>pvCashFundsCodeId</code></td>\n</tr>\n<tr>\n<td>PNM</td>\n<td><code>allowPNMPayment</code>, <code>pnmDefaultQuickPaymentCode</code>, <code>pnmDefaultQuickFundsCode</code>, <code>pnmDefaultRecurringPaymentCode</code>, <code>pnmDefaultRecurringFundsCode</code>, <code>pnmRetrievedPaymentCode</code>, <code>pnmRetrievedCashFundsCode</code>, <code>pnmRetrievedCreditCardFundsCode</code>, <code>pnmRetrievedAchFundsCode</code>, <code>pnmRetrievedDebitFundsCode</code></td>\n</tr>\n<tr>\n<td>Expi-Trans</td>\n<td><code>allowExpiTransPayment</code>, <code>expiTransDefaultQuickPaymentFeeAmount</code>, <code>expiTransDefaultQuickPaymentCode</code>, <code>expiTransDefaultQuickFundsCode</code>, <code>expiTransDefaultRecurringPaymentCode</code>, <code>expiTransDefaultRecurringFundsCode</code>, <code>expiTransDefaultRecurringFeeAmount</code>, <code>expiTransRetrievedPaymentCode</code>, <code>expiTransRetrievedCreditCardFundsCode</code>, <code>expiTransRetrievedAchFundsCode</code>, <code>expiTransRetrievedDebitFundsCode</code></td>\n</tr>\n<tr>\n<td>Collateral</td>\n<td><code>primaryCreditBureauProvider</code>, <code>collateralValue1Label</code>, <code>collateralValue2Label</code>, <code>collateralValue3Label</code>, <code>collateralValue1Provider</code>, <code>collateralValue2Provider</code>, <code>collateralValue3Provider</code></td>\n</tr>\n<tr>\n<td>Portal Payments</td>\n<td><code>allowPortalPayments</code>, <code>allowPortalUserChangePaymentApplied</code>, <code>portalMinimumFixedAmount</code>, <code>defaultPortalPaymentAmount</code>, <code>minDays</code>, <code>maxActiveAccounts</code>, <code>allowFutureOneTimePortalPayments</code>, <code>allowRecurringPortalPayments</code>, <code>maxPaymentAmountDaily</code></td>\n</tr>\n<tr>\n<td>Judgment / Freeze</td>\n<td><code>defaultJudgmentClass</code>, <code>disableAcctLateChargeAfterJudgment</code>, <code>useAccrualFreeze</code>, <code>daysPastDueToTriggerFreeze</code>, <code>daysPastDueToTriggerUnFreeze</code></td>\n</tr>\n</tbody>\n</table>\n</div><p>Refer to the Add Class documentation for per-field semantics (required vs optional, enum ranges, code vs Guid resolution).</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>paymentVisionFeeTransactionCodeOrId</code></td>\n<td><code>paymentVisionFeeTransactionCode</code></td>\n<td>String. miscellaneous other-balance journal transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOneTimePaymentCodeOrId</code></td>\n<td><code>defaultOneTimePaymentCode</code></td>\n<td>String. regular or extension non-journal payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOneTimeFundsCodeDescriptionOrId</code></td>\n<td><code>defaultOneTimeFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>paymentVisionTransactionCodeOrId</code></td>\n<td><code>paymentVisionTransactionCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultElectronicPaymentFundsCodeDescriptionOrId</code></td>\n<td><code>defaultElectronicPaymentFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalPaymentCodeOrId</code></td>\n<td><code>externalPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalPvFeeCodeOrId</code></td>\n<td><code>externalPvFeeCodeId</code></td>\n<td>String. miscellaneous other-balance journal transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalACHFundsCodeDescriptionOrId</code></td>\n<td><code>externalACHFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalCCFundsCodeDescriptionOrId</code></td>\n<td><code>externalCCFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>externalDebitFundsCodeDescriptionOrId</code></td>\n<td><code>externalDebitFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pvCashFundsCodeDescriptionOrId</code></td>\n<td><code>pvCashFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultQuickPaymentCodeOrId</code></td>\n<td><code>pnmDefaultQuickPaymentCode</code></td>\n<td>String. regular or extension non-journal payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultQuickFundsCodeDescriptionOrId</code></td>\n<td><code>pnmDefaultQuickFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultRecurringPaymentCodeOrId</code></td>\n<td><code>pnmDefaultRecurringPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmDefaultRecurringFundsCodeDescriptionOrId</code></td>\n<td><code>pnmDefaultRecurringFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedPaymentCodeOrId</code></td>\n<td><code>pnmRetrievedPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedCashFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedCashFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedCreditCardFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedCreditCardFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedAchFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedAchFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pnmRetrievedDebitFundsCodeDescriptionOrId</code></td>\n<td><code>pnmRetrievedDebitFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultQuickPaymentCodeOrId</code></td>\n<td><code>expiTransDefaultQuickPaymentCode</code></td>\n<td>String. regular or extension non-journal payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultQuickFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransDefaultQuickFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultRecurringPaymentCodeOrId</code></td>\n<td><code>expiTransDefaultRecurringPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransDefaultRecurringFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransDefaultRecurringFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedPaymentCodeOrId</code></td>\n<td><code>expiTransRetrievedPaymentCode</code></td>\n<td>String. regular, non-journal electronic payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedCreditCardFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransRetrievedCreditCardFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedAchFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransRetrievedAchFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>expiTransRetrievedDebitFundsCodeDescriptionOrId</code></td>\n<td><code>expiTransRetrievedDebitFundsCode</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultJudgmentClassNumberOrId</code></td>\n<td><code>defaultJudgmentClass</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>custProvidedPropertyProductCodeOrId</code></td>\n<td><code>custProvidedPropertyProductCodeOrId</code></td>\n<td>String. customer-tracking insurance product code or matching product GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>paymentReceiptFormCodeOrId</code></td>\n<td><code>paymentReceiptFormCodeOrId</code></td>\n<td>String. payment-receipt merge-form filename or matching form GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>chargeOffCodeOrId</code></td>\n<td><code>chargeOffCodeOrId</code></td>\n<td>String. charge-off close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>unwindCodeOrId</code></td>\n<td><code>unwindCodeOrId</code></td>\n<td>String. unwind close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>buybackCodeOrId</code></td>\n<td><code>buybackCodeOrId</code></td>\n<td>String. repurchase or repurchase-like close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>writeoffCodeOrId</code></td>\n<td><code>writeoffCodeOrId</code></td>\n<td>String. write-off close-out code or matching close-out GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n<tr>\n<td><code>payoffPaymentTransactionCodeOrId</code></td>\n<td><code>payoffPaymentTransactionCodeOrId</code></td>\n<td>String. regular journal-payment transaction code or matching transaction-code GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. Existing optional key-or-GUID fields listed above retain blank-to-clear behavior; a nonblank unknown key now fails instead of clearing the setting.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"paymentVisionFeeTransactionCodeOrId\": \"FEE\",\n  \"defaultOneTimePaymentCodeOrId\": \"QPM\",\n  \"defaultOneTimeFundsCodeDescriptionOrId\": \"Check\",\n  \"paymentVisionTransactionCodeOrId\": \"EPM\",\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": \"Check\",\n  \"externalPaymentCodeOrId\": \"EPM\",\n  \"externalPvFeeCodeOrId\": \"FEE\",\n  \"externalACHFundsCodeDescriptionOrId\": \"Check\",\n  \"externalCCFundsCodeDescriptionOrId\": \"Check\",\n  \"externalDebitFundsCodeDescriptionOrId\": \"Check\",\n  \"pvCashFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmDefaultQuickPaymentCodeOrId\": \"QPM\",\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmDefaultRecurringPaymentCodeOrId\": \"EPM\",\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedPaymentCodeOrId\": \"EPM\",\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": \"Check\",\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransDefaultQuickPaymentCodeOrId\": \"QPM\",\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransDefaultRecurringPaymentCodeOrId\": \"EPM\",\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransRetrievedPaymentCodeOrId\": \"EPM\",\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": \"Check\",\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": \"Check\",\n  \"defaultJudgmentClassNumberOrId\": \"1\",\n  \"custProvidedPropertyProductCodeOrId\": \"CPPI\",\n  \"paymentReceiptFormCodeOrId\": \"Payment Receipt\",\n  \"chargeOffCodeOrId\": \"CO\",\n  \"unwindCodeOrId\": \"UNW\",\n  \"buybackCodeOrId\": \"RP\",\n  \"writeoffCodeOrId\": \"WO\",\n  \"payoffPaymentTransactionCodeOrId\": \"PYC\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","Class","{{class_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0a7b8411-440c-4418-b091-ff3eb512162d","name":"UpdateClass - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"number\": 1,\n  \"description\": \"Standard Auto - Updated\",\n  \"active\": true,\n  \"earningsStartDateOption\": 1,\n  \"allowedPaymentFrequencies\": 1,\n  \"wholeDollarPayments\": false,\n  \"allowSameAsCash\": false,\n  \"sameAsCashDefaultMethod\": 0,\n  \"generatePaymentReceiptForAllPayments\": false,\n  \"amortizationMethod\": 1,\n  \"convertMatured\": false,\n  \"allowRefinancing\": false,\n  \"availableCreditCalculationMethod\": 0,\n  \"saveIndirect\": false,\n  \"saveInstallmentPreComp\": false,\n  \"defaultJudgmentClass\": null,\n  \"disableAcctLateChargeAfterJudgment\": false,\n  \"useAccrualFreeze\": false,\n  \"paymentVisionFeeTransactionCodeOrId\": null,\n  \"defaultOneTimePaymentCodeOrId\": null,\n  \"defaultOneTimeFundsCodeDescriptionOrId\": null,\n  \"paymentVisionTransactionCodeOrId\": null,\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": null,\n  \"externalPaymentCodeOrId\": null,\n  \"externalPvFeeCodeOrId\": null,\n  \"externalACHFundsCodeDescriptionOrId\": null,\n  \"externalCCFundsCodeDescriptionOrId\": null,\n  \"externalDebitFundsCodeDescriptionOrId\": null,\n  \"pvCashFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultQuickPaymentCodeOrId\": null,\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultRecurringPaymentCodeOrId\": null,\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedPaymentCodeOrId\": null,\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultQuickPaymentCodeOrId\": null,\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultRecurringPaymentCodeOrId\": null,\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedPaymentCodeOrId\": null,\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"defaultJudgmentClassNumberOrId\": null,\n  \"custProvidedPropertyProductCodeOrId\": null,\n  \"paymentReceiptFormCodeOrId\": null,\n  \"chargeOffCodeOrId\": null,\n  \"unwindCodeOrId\": null,\n  \"buybackCodeOrId\": null,\n  \"writeoffCodeOrId\": null,\n  \"payoffPaymentTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Class/1"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"36940df1-1a80-44ee-9013-c28aef0952f7","name":"UpdateClass - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"number\": 999999,\n  \"description\": \"Standard Auto - Updated\",\n  \"active\": true,\n  \"earningsStartDateOption\": 1,\n  \"allowedPaymentFrequencies\": 1,\n  \"wholeDollarPayments\": false,\n  \"allowSameAsCash\": false,\n  \"sameAsCashDefaultMethod\": 0,\n  \"generatePaymentReceiptForAllPayments\": false,\n  \"amortizationMethod\": 1,\n  \"convertMatured\": false,\n  \"allowRefinancing\": false,\n  \"availableCreditCalculationMethod\": 0,\n  \"saveIndirect\": false,\n  \"saveInstallmentPreComp\": false,\n  \"defaultJudgmentClass\": null,\n  \"disableAcctLateChargeAfterJudgment\": false,\n  \"useAccrualFreeze\": false,\n  \"paymentVisionFeeTransactionCodeOrId\": null,\n  \"defaultOneTimePaymentCodeOrId\": null,\n  \"defaultOneTimeFundsCodeDescriptionOrId\": null,\n  \"paymentVisionTransactionCodeOrId\": null,\n  \"defaultElectronicPaymentFundsCodeDescriptionOrId\": null,\n  \"externalPaymentCodeOrId\": null,\n  \"externalPvFeeCodeOrId\": null,\n  \"externalACHFundsCodeDescriptionOrId\": null,\n  \"externalCCFundsCodeDescriptionOrId\": null,\n  \"externalDebitFundsCodeDescriptionOrId\": null,\n  \"pvCashFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultQuickPaymentCodeOrId\": null,\n  \"pnmDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"pnmDefaultRecurringPaymentCodeOrId\": null,\n  \"pnmDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedPaymentCodeOrId\": null,\n  \"pnmRetrievedCashFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"pnmRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultQuickPaymentCodeOrId\": null,\n  \"expiTransDefaultQuickFundsCodeDescriptionOrId\": null,\n  \"expiTransDefaultRecurringPaymentCodeOrId\": null,\n  \"expiTransDefaultRecurringFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedPaymentCodeOrId\": null,\n  \"expiTransRetrievedCreditCardFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedAchFundsCodeDescriptionOrId\": null,\n  \"expiTransRetrievedDebitFundsCodeDescriptionOrId\": null,\n  \"defaultJudgmentClassNumberOrId\": null,\n  \"custProvidedPropertyProductCodeOrId\": null,\n  \"paymentReceiptFormCodeOrId\": null,\n  \"chargeOffCodeOrId\": null,\n  \"unwindCodeOrId\": null,\n  \"buybackCodeOrId\": null,\n  \"writeoffCodeOrId\": null,\n  \"payoffPaymentTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Class/999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Class not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"836c56b6-3a79-456b-bbe2-b1550c769560"},{"name":"CustomFieldSetAdd","id":"de0f70bc-ab6a-4184-838e-63ba6f0068e5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACCT\",\n    \"description\": \"Account Custom Fields\",\n    \"details\": [\n        {\n            \"description\": \"Reference Number\",\n            \"dataType\": 1,\n            \"fieldLength\": 50,\n            \"fieldNumber\": 1,\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet","description":"<h3 id=\"add-custom-field-set\">Add Custom Field Set</h3>\n<p>Creates a new <code>Common.CustomFieldSet</code> plus its <code>CustomFieldSetDetail</code> rows for the caller's client. The controller maps the payload into <code>AddSaveCustomFieldSetParameter</code> with <code>id = null</code> and <code>ts = null</code> so the save treats it as an insert, then forwards to <code>CustomFieldSetWSServices.AddSaveCustomFieldSetWS</code>. The service rejects the request when another custom field set with the same <code>code</code> already exists for the client. Returns the new row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/CustomFieldSet</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Unique (per client) short code for the set.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>Optional array of detail rows. Each row describes one screen field.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"detail-row-fields-details\">Detail Row Fields (<code>details[]</code>)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Optional Guid. Omit for new rows.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional base-64 rowversion. Omit for new rows.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Field label shown on the screen.</td>\n</tr>\n<tr>\n<td><em>dataType</em></td>\n<td>Required int. Data-type discriminator used by the Custom Fields renderer (text, number, date, etc.).</td>\n</tr>\n<tr>\n<td><em>fieldLength</em></td>\n<td>Optional int. Max length for text-type fields.</td>\n</tr>\n<tr>\n<td><em>fieldNumber</em></td>\n<td>Required int. Ordinal position of the field within the set.</td>\n</tr>\n<tr>\n<td><em>display</em></td>\n<td>Required boolean. <code>true</code> surfaces the field on the hosting screen. Defaults to <code>true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","CustomFieldSet"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dcb63f09-a0bc-44aa-a4c4-9ff1ddb9b0c7","name":"AddCustomFieldSet - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACCT\",\n    \"description\": \"Account Custom Fields\",\n    \"details\": [\n        {\n            \"description\": \"Reference Number\",\n            \"dataType\": 1,\n            \"fieldLength\": 50,\n            \"fieldNumber\": 1,\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"cfb7c2b3-651b-4e34-a94f-de846a9566af","name":"AddCustomFieldSet - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACCT\",\n    \"description\": \"Account Custom Fields\",\n    \"details\": [\n        {\n            \"description\": \"Reference Number\",\n            \"dataType\": 1,\n            \"fieldLength\": 50,\n            \"fieldNumber\": 1,\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A custom field set with code 'ACCT' already exists\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"de0f70bc-ab6a-4184-838e-63ba6f0068e5"},{"name":"CustomFieldSetGet","id":"1b41d1ad-e3e2-4fb4-bdbc-77f663b40fe5","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet/{{custom_field_set_code_or_id}}","description":"<h3 id=\"get-custom-field-set\">Get Custom Field Set</h3>\n<p>Returns a single <code>Common.CustomFieldSet</code> plus its ordered <code>CustomFieldSetDetail</code> rows, resolved from the <code>{codeOrId}</code> path segment. Resolution runs through <code>SharedWSServices.GetCommonCustomFieldSetId</code> which tries <code>Guid.TryParse</code> first, then falls back to a client-scoped lookup by <code>Code</code> via <code>CustomFieldServices.ReturnCustomFieldSetId</code>. The controller then calls <code>CustomFieldServices.ReturnCustomFieldSet</code> for the header and <code>CustomFieldServices.ReturnCustomFieldSetDetail</code> for the detail rows, returning them as <code>{ customFieldSet, details }</code>. Returns <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/CustomFieldSet/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the custom-field-set code string (e.g. <code>ACCT</code>) or the row <code>Id</code> Guid. Resolution is Guid-first, then code string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","CustomFieldSet","{{custom_field_set_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a9a32ea7-1354-4bdd-8c86-ed1fea985c8b","name":"GetCustomFieldSet - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"customFieldSet\": {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"ACCT\",\n            \"Description\": \"Account Custom Fields\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        },\n        \"details\": [\n            {\n                \"Id\": \"00000000-0000-0000-0000-000000000000\",\n                \"CommonCustomFieldSetId\": \"00000000-0000-0000-0000-000000000000\",\n                \"Description\": \"Reference Number\",\n                \"DataType\": 1,\n                \"FieldLength\": 50,\n                \"FieldNumber\": 1,\n                \"Display\": true,\n                \"Ts\": \"AAAAAAAAB9I=\"\n            }\n        ]\n    }\n}"},{"id":"bbd81913-73f3-4296-848f-463f6ec426c9","name":"GetCustomFieldSet - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Custom field set not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"1b41d1ad-e3e2-4fb4-bdbc-77f663b40fe5"},{"name":"CustomFieldSetsGetAll","id":"e0cce6af-2a78-4fea-b025-e71a8c1bc032","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet","description":"<h3 id=\"get-all-custom-field-sets\">Get All Custom Field Sets</h3>\n<p>Returns every <code>Common.CustomFieldSet</code> for the caller's client. Wraps <code>CustomFieldSetWSServices.ReturnAllCustomFieldSetsWS</code>, which scopes results by <code>OmegaClientId</code> from the authenticated session. Custom field sets define the user-configurable screen fields that surface on accounts, dealers, customers, etc.; the detail rows (<code>CustomFieldSetDetail</code>) are not returned by this list endpoint — call <code>GET /api/Client/Common/CustomFieldSet/{codeOrId}</code> to retrieve the detail definitions for a single set.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/CustomFieldSet</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","CustomFieldSet"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e18e9db5-031f-4897-88b5-04017bb1dcbd","name":"GetAllCustomFieldSets - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"ACCT\",\n            \"Description\": \"Account Custom Fields\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"0daecbe5-d8d2-4133-a3f8-0b601534fecf","name":"GetAllCustomFieldSets - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed: invalid or missing session id, token, or API key\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e0cce6af-2a78-4fea-b025-e71a8c1bc032"},{"name":"CustomFieldSetUpdate","id":"531130ba-859b-4c0d-bab8-8237b7304fa6","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACCT\",\n    \"description\": \"Account Custom Fields - Updated\",\n    \"details\": [\n        {\n            \"id\": \"00000000-0000-0000-0000-000000000000\",\n            \"ts\": \"AAAAAAAAB9I=\",\n            \"description\": \"Reference Number\",\n            \"dataType\": 1,\n            \"fieldLength\": 50,\n            \"fieldNumber\": 1,\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet/{{custom_field_set_code_or_id}}","description":"<h3 id=\"update-custom-field-set\">Update Custom Field Set</h3>\n<p>Updates an existing <code>Common.CustomFieldSet</code> resolved from the <code>{customFieldSetCodeOrId}</code> path segment. The controller looks up the row via <code>SharedWSServices.GetCommonCustomFieldSetId</code> (Guid-first, then code string), fetches the current entity via <code>CustomFieldServices.ReturnCustomFieldSet</code> to obtain its rowversion (<code>Ts</code>), maps the payload into <code>AddSaveCustomFieldSetParameter</code> with the resolved <code>id</code> and existing <code>ts</code>, and forwards to <code>CustomFieldSetWSServices.AddSaveCustomFieldSetWS</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are supplied server-side. Detail rows sent in <code>details[]</code> that include an <code>id</code> / <code>ts</code> are updated; rows without an <code>id</code> are inserted; existing rows not present in the payload are deleted.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/CustomFieldSet/{customFieldSetCodeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customFieldSetCodeOrId</em></td>\n<td>Required. Either the current custom-field-set code string or the row <code>Id</code> Guid. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) code. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>Required array of detail rows. See detail schema below.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"detail-row-fields-details\">Detail Row Fields (<code>details[]</code>)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Optional Guid. Provide to update an existing detail row; omit to insert a new one.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional base-64 rowversion. Required when updating an existing row.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Field label shown on the screen.</td>\n</tr>\n<tr>\n<td><em>dataType</em></td>\n<td>Required int. Data-type discriminator.</td>\n</tr>\n<tr>\n<td><em>fieldLength</em></td>\n<td>Optional int. Max length for text-type fields.</td>\n</tr>\n<tr>\n<td><em>fieldNumber</em></td>\n<td>Required int. Ordinal position of the field within the set.</td>\n</tr>\n<tr>\n<td><em>display</em></td>\n<td>Required boolean. <code>true</code> surfaces the field on the hosting screen.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","CustomFieldSet","{{custom_field_set_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4919e213-36d8-4180-a33f-3eeb6f92af51","name":"UpdateCustomFieldSet - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"ACCT\",\n    \"description\": \"Account Custom Fields - Updated\",\n    \"details\": [\n        {\n            \"id\": \"00000000-0000-0000-0000-000000000000\",\n            \"ts\": \"AAAAAAAAB9I=\",\n            \"description\": \"Reference Number\",\n            \"dataType\": 1,\n            \"fieldLength\": 50,\n            \"fieldNumber\": 1,\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"1db8f258-a528-4d9c-93aa-fe352e825460","name":"UpdateCustomFieldSet - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"NOTFOUND\",\n    \"description\": \"Account Custom Fields - Updated\",\n    \"details\": [\n        {\n            \"id\": \"00000000-0000-0000-0000-000000000000\",\n            \"ts\": \"AAAAAAAAB9I=\",\n            \"description\": \"Reference Number\",\n            \"dataType\": 1,\n            \"fieldLength\": 50,\n            \"fieldNumber\": 1,\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/CustomFieldSet/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Custom field set not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"531130ba-859b-4c0d-bab8-8237b7304fa6"},{"name":"DealerAdd","id":"63072c76-adbf-4557-b086-7e5b38bc39a4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"vendorId\": \"00000000-0000-0000-0000-000000000000\",\n  \"provinceLicenseNumber\": \"PL-12345\",\n  \"chargeOffRecoveryOptions\": 0,\n  \"allowOverride\": true,\n  \"defaultTransmissionType\": 0,\n  \"allowDealerTrackEntry\": false,\n  \"displayReports\": true,\n  \"vendorCodeOrId\": null,\n  \"repUserLoginOrId\": null,\n  \"primaryTerritorialRepLoginOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"discountBasisDescriptionOrId\": null,\n  \"reserveBasisDescriptionOrId\": null,\n  \"withholdBasisDescriptionOrId\": null,\n  \"newApplicationGroupNumberOrId\": null,\n  \"dtGroupNumberOrId\": null,\n  \"dtRetailClassNumberOrId\": null,\n  \"dealerPermissionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Dealer","description":"<h3 id=\"add-dealer\">Add Dealer</h3>\n<p>Creates a new <code>Common.Dealer</code> for an existing <code>Common.Vendor</code> within the caller's client. The controller forwards the payload to <code>DealerWSServices.AddDealerWS</code>, which generates a fresh <code>dealerId</code> (Guid) and calls <code>DealerServices.AddSaveDealer</code> with <code>ts = null</code>. The target vendor is resolved by <code>vendorId</code> — the vendor row must already exist before this endpoint is called. Returns the new dealer's Guid in <code>data</code>.</p>\n<p>Dealer payloads are wide because they drive holdback / reserve / withhold configuration, recourse / advance / amount limits, and DealerTrack wiring. Fields are grouped below; omitted optional fields fall through as <code>NULL</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Dealer</code></p>\n<h4 id=\"request-body-parameters--identity\">Request Body Parameters — Identity</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>vendorId</em></td>\n<td>Required Guid. <code>Common.Vendor.Id</code> the dealer row will hang off.</td>\n</tr>\n<tr>\n<td><em>provinceLicenseNumber</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>licenseExpirationDate</em></td>\n<td>Optional date.</td>\n</tr>\n<tr>\n<td><em>repUserId</em> / <em>primaryTerritorialRepId</em></td>\n<td>Optional Guids for sales / territorial rep assignments.</td>\n</tr>\n<tr>\n<td><em>defaultClassId</em></td>\n<td>Optional Guid. Default <code>Common.Class</code> for applications booked under this dealer.</td>\n</tr>\n<tr>\n<td><em>dealerPermissionId</em></td>\n<td>Optional Guid. Dealer-specific permission record.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--holdback--withhold\">Request Body Parameters — Holdback / Withhold</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>chargeOffRecoveryOptions</em></td>\n<td>Required int enum.</td>\n</tr>\n<tr>\n<td><em>withholdAccrualMethod</em> / <em>withholdNumberOfPayments</em> / <em>withholdPercentOfPayments</em></td>\n<td>Optional withhold-accrual configuration.</td>\n</tr>\n<tr>\n<td><em>minimumReserve</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>reserveRatio</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>discountBasis</em> / <em>discountPercent</em> / <em>discountAmount</em></td>\n<td>Optional discount holdback configuration.</td>\n</tr>\n<tr>\n<td><em>reserveBasis</em> / <em>reservePercent</em> / <em>reserveAmount</em></td>\n<td>Optional reserve holdback configuration.</td>\n</tr>\n<tr>\n<td><em>withholdBasis</em> / <em>withholdPercent</em> / <em>withholdAmount</em></td>\n<td>Optional withhold holdback configuration.</td>\n</tr>\n<tr>\n<td><em>allowOverride</em></td>\n<td>Required boolean. Controls per-contract override of holdback percent/amount.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--term--amount-limits\">Request Body Parameters — Term / Amount Limits</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>defaultRecourseTerm</em></td>\n<td>Optional int (months).</td>\n</tr>\n<tr>\n<td><em>minTerm</em> / <em>maxTerm</em></td>\n<td>Optional int range for allowable term.</td>\n</tr>\n<tr>\n<td><em>minAdvanceAmount</em> / <em>maxAdvanceAmount</em></td>\n<td>Optional decimal range.</td>\n</tr>\n<tr>\n<td><em>minAmountFinanced</em> / <em>maxAmountFinanced</em></td>\n<td>Optional decimal range.</td>\n</tr>\n<tr>\n<td><em>minPaymentAmount</em> / <em>maxPaymentAmount</em></td>\n<td>Optional decimal range.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--application--dealertrack\">Request Body Parameters — Application / DealerTrack</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>defaultTransmissionType</em></td>\n<td>Required int. Default application transmission mode.</td>\n</tr>\n<tr>\n<td><em>customFieldsXML</em></td>\n<td>Optional string. Custom-field payload persisted on the dealer.</td>\n</tr>\n<tr>\n<td><em>newApplicationGroupId</em></td>\n<td>Optional Guid. Default application group for dealer submissions.</td>\n</tr>\n<tr>\n<td><em>allowDealerTrackEntry</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>dtDealerId</em></td>\n<td>Optional string. DealerTrack dealer ID.</td>\n</tr>\n<tr>\n<td><em>dtGroupId</em> / <em>dtRetailClassId</em></td>\n<td>Optional Guids for DealerTrack group / retail class mapping.</td>\n</tr>\n<tr>\n<td><em>displayReports</em></td>\n<td>Required boolean. Gates dealer-portal report visibility.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>vendorCodeOrId</code></td>\n<td><code>vendorId</code></td>\n<td>String. non-dealer vendor code or vendor GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>repUserLoginOrId</code></td>\n<td><code>repUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>primaryTerritorialRepLoginOrId</code></td>\n<td><code>primaryTerritorialRepId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultClassNumberOrId</code></td>\n<td><code>defaultClassId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>discountBasisDescriptionOrId</code></td>\n<td><code>discountBasis</code></td>\n<td>String. holdback-basis description or holdback-basis GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>reserveBasisDescriptionOrId</code></td>\n<td><code>reserveBasis</code></td>\n<td>String. holdback-basis description or holdback-basis GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>withholdBasisDescriptionOrId</code></td>\n<td><code>withholdBasis</code></td>\n<td>String. holdback-basis description or holdback-basis GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>newApplicationGroupNumberOrId</code></td>\n<td><code>newApplicationGroupId</code></td>\n<td>String. origination-group number or group GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>dtGroupNumberOrId</code></td>\n<td><code>dtGroupId</code></td>\n<td>String. origination-group number or group GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>dtRetailClassNumberOrId</code></td>\n<td><code>dtRetailClassId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>dealerPermissionCodeOrId</code></td>\n<td><code>dealerPermissionId</code></td>\n<td>String. dealer-permission code or dealer-permission GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"vendorCodeOrId\": \"VENDOR1\",\n  \"repUserLoginOrId\": \"collector.login\",\n  \"primaryTerritorialRepLoginOrId\": \"collector.login\",\n  \"defaultClassNumberOrId\": \"1\",\n  \"discountBasisDescriptionOrId\": \"Standard Holdback\",\n  \"reserveBasisDescriptionOrId\": \"Standard Holdback\",\n  \"withholdBasisDescriptionOrId\": \"Standard Holdback\",\n  \"newApplicationGroupNumberOrId\": \"1\",\n  \"dtGroupNumberOrId\": \"1\",\n  \"dtRetailClassNumberOrId\": \"1\",\n  \"dealerPermissionCodeOrId\": \"VIEW\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","Dealer"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"abd08554-5ae6-43ad-b509-00a98ab7f73b","name":"AddDealer - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"vendorId\": \"00000000-0000-0000-0000-000000000000\",\n  \"provinceLicenseNumber\": \"PL-12345\",\n  \"chargeOffRecoveryOptions\": 0,\n  \"allowOverride\": true,\n  \"defaultTransmissionType\": 0,\n  \"allowDealerTrackEntry\": false,\n  \"displayReports\": true,\n  \"vendorCodeOrId\": null,\n  \"repUserLoginOrId\": null,\n  \"primaryTerritorialRepLoginOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"discountBasisDescriptionOrId\": null,\n  \"reserveBasisDescriptionOrId\": null,\n  \"withholdBasisDescriptionOrId\": null,\n  \"newApplicationGroupNumberOrId\": null,\n  \"dtGroupNumberOrId\": null,\n  \"dtRetailClassNumberOrId\": null,\n  \"dealerPermissionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Dealer"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"5bd4c4f4-d294-4401-bb84-80f3171fd450","name":"AddDealer - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"vendorId\": \"11111111-1111-1111-1111-111111111111\",\n  \"provinceLicenseNumber\": \"PL-12345\",\n  \"chargeOffRecoveryOptions\": 0,\n  \"allowOverride\": true,\n  \"defaultTransmissionType\": 0,\n  \"allowDealerTrackEntry\": false,\n  \"displayReports\": true,\n  \"vendorCodeOrId\": null,\n  \"repUserLoginOrId\": null,\n  \"primaryTerritorialRepLoginOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"discountBasisDescriptionOrId\": null,\n  \"reserveBasisDescriptionOrId\": null,\n  \"withholdBasisDescriptionOrId\": null,\n  \"newApplicationGroupNumberOrId\": null,\n  \"dtGroupNumberOrId\": null,\n  \"dtRetailClassNumberOrId\": null,\n  \"dealerPermissionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Dealer"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error adding dealer: Vendor not found for the supplied vendorId\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"63072c76-adbf-4557-b086-7e5b38bc39a4"},{"name":"DealerGet","id":"a0931fbc-befe-4b6a-999b-899bfaae253e","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Dealer/{{dealer_code_or_id}}","description":"<h3 id=\"get-dealer\">Get Dealer</h3>\n<p>Returns a single dealer in its projected, \"dealer + vendor\" shape. The <code>{dealerCodeOrId}</code> path segment is resolved by <code>DealerWSServices</code>: <code>Guid.TryParse</code> first, otherwise a client-scoped vendor-code lookup through <code>DealerServices.ReturnDealer(databaseName, clientId, code)</code> that returns the first dealer row hanging off the matching <code>Common.Vendor</code>. The controller then calls <code>DealerServices.ReturnDealer(databaseName, dealerId, true)</code> and projects the entity into a flat response that includes <code>VendorId</code>, <code>VendorCode</code>, <code>VendorName</code>, <code>Ts</code>, plus holdback / withhold / term / DealerTrack fields.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Dealer/{dealerCodeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>dealerCodeOrId</em></td>\n<td>Required. Either the dealer's <code>Common.Vendor.Code</code> or the <code>Common.Dealer.Id</code> Guid. Resolution is Guid-first, then vendor-code. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","Dealer","{{dealer_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e33fd910-6a83-476f-9de6-057a74b10803","name":"GetDealer - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Dealer/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"VendorId\": \"00000000-0000-0000-0000-000000000000\",\n        \"VendorCode\": \"DLR001\",\n        \"VendorName\": \"Main Street Auto\",\n        \"ProvinceLicenseNumber\": \"PL-12345\",\n        \"PrimarySalesRepId\": null,\n        \"PrimaryTerritorialRepId\": null,\n        \"DefaultClassId\": null,\n        \"LicenseExpirationDate\": null,\n        \"MinimumReserve\": null,\n        \"DefaultRecourseTerm\": null,\n        \"ChargeOffRecoveryOption\": 0,\n        \"WithholdAccrualMethod\": null,\n        \"WithholdNumberOfPayments\": null,\n        \"WithholdPercentOfPayments\": null,\n        \"ReserveRatio\": null,\n        \"DiscountHoldbackBasisId\": null,\n        \"DiscountPercent\": null,\n        \"DiscountAmount\": null,\n        \"ReserveHoldbackBasisId\": null,\n        \"ReservePercent\": null,\n        \"ReserveAmount\": null,\n        \"WithholdHoldbackBasisId\": null,\n        \"WithholdPercent\": null,\n        \"WithholdAmount\": null,\n        \"AllowHoldbackOverride\": true,\n        \"DefaultTransmissionType\": 0,\n        \"MinActualTerm\": null,\n        \"MaxActualTerm\": null,\n        \"MinAdvanceAmount\": null,\n        \"MaxAdvanceAmount\": null,\n        \"MinAmountFinanced\": null,\n        \"MaxAmountFinanced\": null,\n        \"MinPaymentAmount\": null,\n        \"MaxPaymentAmount\": null,\n        \"AllowDealerTrackEntry\": false,\n        \"DealerTrackDealerId\": null,\n        \"DealerTrackGroupId\": null,\n        \"DtretailClassId\": null,\n        \"DisplayReports\": true,\n        \"DealerPermissionId\": null,\n        \"LastContractDate\": null,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"b75eae5b-a666-4440-95b7-0245b1b46434","name":"GetDealer - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Dealer/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Dealer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"a0931fbc-befe-4b6a-999b-899bfaae253e"},{"name":"DealerPortalConfiguration","id":"69a18097-50ea-4948-a8c5-8a35b76b95e9","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"allowDealerAccess\": true,\n    \"logoImageUrl\": \"https://example.com/logo.png\",\n    \"allowAppEntry\": true,\n    \"newApplicationGroupNumberOrId\": \"DEFAULT\",\n    \"existingApplicantUpdateOption\": 1,\n    \"allowViewingDocuments\": true,\n    \"allowUploadingDocuments\": true,\n    \"notesActionCodeOrId\": \"NOTE\",\n    \"noteReceivedTaskTemplateNumberOrId\": \"1001\",\n    \"noteReceivedAssignedToUserLoginOrId\": \"developer\",\n    \"noteReceivedAssignedToRoleNameOrId\": null,\n    \"applicationReceivedTaskTemplateNumberOrId\": \"1002\",\n    \"applicationReceivedAssignedToUserLoginOrId\": null,\n    \"applicationReceivedAssignedToRoleNameOrId\": \"Loan Officer\",\n    \"documentReceivedTaskTemplateNumberOrId\": \"1003\",\n    \"documentReceivedAssignedToUserLoginOrId\": \"developer\",\n    \"documentReceivedAssignedToRoleNameOrId\": null,\n    \"showLegalDisclaimer\": true,\n    \"legalDisclaimer\": \"By logging in, you agree to the terms of service.\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/DealerPortalConfiguration","description":"<h3 id=\"update-dealer-portal-configuration\">Update Dealer Portal Configuration</h3>\n<p>Inserts or updates the caller client's dealer-portal configuration. The controller resolves the supplied <code>*NumberOrId</code> / <code>*LoginOrId</code> / <code>*NameOrId</code> strings via <code>SharedWSServices</code> helpers (<code>GetOriginationsGroupId</code>, <code>GetCommonActionCodeId</code>, <code>GetCommonTaskTemplateId</code>, <code>GetSetupUserId</code>, <code>GetSetupRoleId</code> — each is Guid-first, then the friendly code/login/name), packs them into <code>AddSaveDealerPortalConfigurationParameter</code>, and forwards to <code>DealerPortalConfigurationWSServices.AddSaveDealerPortalConfigurationWS</code>. That helper loads any existing row (one per client + <code>PortalTypes.Dealer</code>) to reuse its Guid and rowversion, validates the task-template / role / legal-disclaimer rules, and calls <code>Omega.Common.BLL.PortalConfigurationServices.AddSavePortalConfiguration</code>. The body does not carry <code>id</code> or <code>ts</code> — both are resolved server-side.</p>\n<p><strong>Validation rules enforced server-side:</strong></p>\n<ul>\n<li><p>When any of <code>noteReceivedTaskTemplateNumberOrId</code>,\n<code>applicationReceivedTaskTemplateNumberOrId</code>, or\n<code>documentReceivedTaskTemplateNumberOrId</code> resolve to a Guid, the matching\n<code>*AssignedToUserLoginOrId</code> <strong>or</strong> <code>*AssignedToRoleNameOrId</code> must also\nresolve to a Guid.</p>\n</li>\n<li><p>When <code>showLegalDisclaimer = true</code>, <code>legalDisclaimer</code> must be non-empty.</p>\n</li>\n</ul>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/DealerPortalConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>allowDealerAccess</em></td>\n<td>Required boolean. Master switch that enables dealer portal logins for the client.</td>\n</tr>\n<tr>\n<td><em>logoImageUrl</em></td>\n<td>Optional string. Absolute URL of the logo to display in the dealer portal.</td>\n</tr>\n<tr>\n<td><em>allowAppEntry</em></td>\n<td>Required boolean. <code>true</code> lets dealers submit new applications.</td>\n</tr>\n<tr>\n<td><em>newApplicationGroupNumberOrId</em></td>\n<td>Optional. Originations group number or Guid that new applications land in. Resolved via <code>SharedWSServices.GetOriginationsGroupId</code>.</td>\n</tr>\n<tr>\n<td><em>existingApplicantUpdateOption</em></td>\n<td>Required int. Cast to <code>Omega.Originations.Types.PortalExistingApplicantUpdateTypes</code>. Controls how re-submitted applicants are merged with existing records.</td>\n</tr>\n<tr>\n<td><em>allowViewingDocuments</em></td>\n<td>Required boolean. <code>true</code> exposes client-uploaded documents to the dealer.</td>\n</tr>\n<tr>\n<td><em>allowUploadingDocuments</em></td>\n<td>Required boolean. <code>true</code> allows dealers to upload documents.</td>\n</tr>\n<tr>\n<td><em>notesActionCodeOrId</em></td>\n<td>Optional. Action-code code or Guid applied to notes entered from the dealer portal. Resolved via <code>SharedWSServices.GetCommonActionCodeId</code>.</td>\n</tr>\n<tr>\n<td><em>noteReceivedTaskTemplateNumberOrId</em></td>\n<td>Optional. Task template to raise when a dealer posts a note. Resolved via <code>SharedWSServices.GetCommonTaskTemplateId</code>.</td>\n</tr>\n<tr>\n<td><em>noteReceivedAssignedToUserLoginOrId</em></td>\n<td>Optional. Setup user login or Guid that receives the note task. Resolved via <code>SharedWSServices.GetSetupUserId</code>.</td>\n</tr>\n<tr>\n<td><em>noteReceivedAssignedToRoleNameOrId</em></td>\n<td>Optional. Setup role name or Guid that receives the note task. Resolved via <code>SharedWSServices.GetSetupRoleId</code>.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedTaskTemplateNumberOrId</em></td>\n<td>Optional. Task template raised when a dealer submits an application.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedAssignedToUserLoginOrId</em></td>\n<td>Optional. User that receives the application task.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedAssignedToRoleNameOrId</em></td>\n<td>Optional. Role that receives the application task.</td>\n</tr>\n<tr>\n<td><em>documentReceivedTaskTemplateNumberOrId</em></td>\n<td>Optional. Task template raised when a dealer uploads a document.</td>\n</tr>\n<tr>\n<td><em>documentReceivedAssignedToUserLoginOrId</em></td>\n<td>Optional. User that receives the document task.</td>\n</tr>\n<tr>\n<td><em>documentReceivedAssignedToRoleNameOrId</em></td>\n<td>Optional. Role that receives the document task.</td>\n</tr>\n<tr>\n<td><em>showLegalDisclaimer</em></td>\n<td>Required boolean. <code>true</code> surfaces the legal-disclaimer text on the dealer portal landing screen.</td>\n</tr>\n<tr>\n<td><em>legalDisclaimer</em></td>\n<td>Required when <code>showLegalDisclaimer</code> is <code>true</code>. The disclaimer text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","DealerPortalConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e587864b-1406-42ba-8d89-badce7760187","name":"UpdateDealerPortalConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"allowDealerAccess\": true,\n    \"logoImageUrl\": \"https://example.com/logo.png\",\n    \"allowAppEntry\": true,\n    \"newApplicationGroupNumberOrId\": \"DEFAULT\",\n    \"existingApplicantUpdateOption\": 1,\n    \"allowViewingDocuments\": true,\n    \"allowUploadingDocuments\": true,\n    \"notesActionCodeOrId\": \"NOTE\",\n    \"noteReceivedTaskTemplateNumberOrId\": \"1001\",\n    \"noteReceivedAssignedToUserLoginOrId\": \"developer\",\n    \"noteReceivedAssignedToRoleNameOrId\": null,\n    \"applicationReceivedTaskTemplateNumberOrId\": \"1002\",\n    \"applicationReceivedAssignedToUserLoginOrId\": null,\n    \"applicationReceivedAssignedToRoleNameOrId\": \"Loan Officer\",\n    \"documentReceivedTaskTemplateNumberOrId\": \"1003\",\n    \"documentReceivedAssignedToUserLoginOrId\": \"developer\",\n    \"documentReceivedAssignedToRoleNameOrId\": null,\n    \"showLegalDisclaimer\": true,\n    \"legalDisclaimer\": \"By logging in, you agree to the terms of service.\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/DealerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"a71cbb5d-0dec-4b7c-8f8f-f6092bd35fd4","name":"UpdateDealerPortalConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"allowDealerAccess\": true,\n    \"logoImageUrl\": \"https://example.com/logo.png\",\n    \"allowAppEntry\": true,\n    \"newApplicationGroupNumberOrId\": \"DEFAULT\",\n    \"existingApplicantUpdateOption\": 1,\n    \"allowViewingDocuments\": true,\n    \"allowUploadingDocuments\": true,\n    \"notesActionCodeOrId\": \"NOTE\",\n    \"noteReceivedTaskTemplateNumberOrId\": null,\n    \"noteReceivedAssignedToUserLoginOrId\": null,\n    \"noteReceivedAssignedToRoleNameOrId\": null,\n    \"applicationReceivedTaskTemplateNumberOrId\": null,\n    \"applicationReceivedAssignedToUserLoginOrId\": null,\n    \"applicationReceivedAssignedToRoleNameOrId\": null,\n    \"documentReceivedTaskTemplateNumberOrId\": null,\n    \"documentReceivedAssignedToUserLoginOrId\": null,\n    \"documentReceivedAssignedToRoleNameOrId\": null,\n    \"showLegalDisclaimer\": true,\n    \"legalDisclaimer\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/DealerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Legal Disclaimer must be completed.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"69a18097-50ea-4948-a8c5-8a35b76b95e9"},{"name":"DealerPortalConfiguration","id":"57950d9a-e4ae-4d97-a3d9-cd626e5bcc51","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/DealerPortalConfiguration","description":"<h3 id=\"get-dealer-portal-configuration\">Get Dealer Portal Configuration</h3>\n<p>Returns the caller client's dealer-portal configuration (there is one row per client + portal type). Wraps <code>DealerPortalConfigurationWSServices.GetDealerPortalConfigurationWS</code>, which calls <code>Omega.Common.BLL.PortalConfigurationServices.ReturnPortalConfiguration</code> with <code>PortalTypes.Dealer</code>. Returns <code>data = null</code> when no configuration row exists yet; otherwise returns a flat object describing dealer-portal access flags, the default originations group, task-template assignments for note / application / document events, and the legal-disclaimer settings.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/DealerPortalConfiguration</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","DealerPortalConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9cc4b718-c330-47da-b072-f74030b1148a","name":"GetDealerPortalConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/DealerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"id\": \"00000000-0000-0000-0000-000000000000\",\n        \"ts\": \"AAAAAAAAB9E=\",\n        \"portalType\": 1,\n        \"omegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"allowDealerAccess\": true,\n        \"logoImageUrl\": \"https://example.com/logo.png\",\n        \"allowAppEntry\": true,\n        \"newApplicationGroupId\": \"00000000-0000-0000-0000-000000000000\",\n        \"existingApplicantUpdateOption\": 1,\n        \"allowViewingDocuments\": true,\n        \"allowUploadingDocuments\": true,\n        \"notesActionCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"noteReceivedTaskTemplateId\": \"00000000-0000-0000-0000-000000000000\",\n        \"noteReceivedAssignedToUserId\": \"00000000-0000-0000-0000-000000000000\",\n        \"noteReceivedAssignedToRoleId\": null,\n        \"applicationReceivedTaskTemplateId\": \"00000000-0000-0000-0000-000000000000\",\n        \"applicationReceivedAssignedToUserId\": null,\n        \"applicationReceivedAssignedToRoleId\": \"00000000-0000-0000-0000-000000000000\",\n        \"documentReceivedTaskTemplateId\": \"00000000-0000-0000-0000-000000000000\",\n        \"documentReceivedAssignedToUserId\": \"00000000-0000-0000-0000-000000000000\",\n        \"documentReceivedAssignedToRoleId\": null,\n        \"showLegalDisclaimer\": true,\n        \"legalDisclaimer\": \"By logging in, you agree to the terms of service.\"\n    }\n}"},{"id":"1c508f01-3103-4394-9fa7-f60b103025d8","name":"GetDealerPortalConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"INVALID_TOKEN"}],"url":"https://{{base_url}}/api/Client/Common/DealerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving dealer portal configuration: Invalid session or token\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"57950d9a-e4ae-4d97-a3d9-cd626e5bcc51"},{"name":"DealersGetAll","id":"763c2d71-0ddb-4a41-a752-87f94433bea7","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Dealer","description":"<h3 id=\"get-all-dealers\">Get All Dealers</h3>\n<p>Returns every <code>Common.Dealer</code> row for the caller's client. The controller delegates to <code>DealerWSServices.ReturnAllDealersWS</code>, which loads rows via <code>DealerServices.ReturnAllDealers</code> and projects each row to a slim shape (<code>Id</code>, <code>ProvinceLicenseNumber</code>, <code>DealerTrackDealerId</code>, <code>Ts</code>). The response is wrapped by <code>GenericUpdateResultObject</code>, with the list in <code>data</code>. An empty list is returned (not a <code>404</code>) when the client has no dealers configured.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Dealer</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","Dealer"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a9f20eba-a7c1-4d3b-805c-d20d18f1047f","name":"GetAllDealers - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Dealer"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"ProvinceLicenseNumber\": \"PL-12345\",\n            \"DealerTrackDealerId\": \"DT0001\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"6007d122-d312-47e4-9fe2-34e475f52cd8","name":"GetAllDealers - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"INVALID_TOKEN"}],"url":"https://{{base_url}}/api/Client/Common/Dealer"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving dealers: Invalid session or token\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"763c2d71-0ddb-4a41-a752-87f94433bea7"},{"name":"DealerUpdate","id":"c827b2c7-bfaa-4a01-971d-7befbe7595eb","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"provinceLicenseNumber\": \"PL-12345\",\n  \"chargeOffRecoveryOptions\": 0,\n  \"allowOverride\": true,\n  \"defaultTransmissionType\": 0,\n  \"allowDealerTrackEntry\": false,\n  \"displayReports\": true,\n  \"repUserLoginOrId\": null,\n  \"primaryTerritorialRepLoginOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"discountBasisDescriptionOrId\": null,\n  \"reserveBasisDescriptionOrId\": null,\n  \"withholdBasisDescriptionOrId\": null,\n  \"newApplicationGroupNumberOrId\": null,\n  \"dtGroupNumberOrId\": null,\n  \"dtRetailClassNumberOrId\": null,\n  \"dealerPermissionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Dealer/{{dealer_code_or_id}}","description":"<h3 id=\"update-dealer\">Update Dealer</h3>\n<p>Updates an existing <code>Common.Dealer</code> resolved from the <code>{dealerCodeOrId}</code> path segment. The controller resolves the dealer via <code>Guid.TryParse</code> first; otherwise it calls <code>DealerServices.ReturnDealer(databaseName, clientId, code)</code> and uses the first matching <code>Common.Dealer.Id</code>. The resolved Guid is forwarded to <code>DealerWSServices.UpdateDealerWS</code>, which calls <code>DealerServices.AddSaveDealer</code> with the existing dealer id and its rowversion. The payload does <strong>not</strong> carry <code>vendorId</code>, <code>id</code>, or <code>ts</code> — all three are supplied server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Dealer/{dealerCodeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>dealerCodeOrId</em></td>\n<td>Required. Either the dealer's <code>Common.Vendor.Code</code> or the <code>Common.Dealer.Id</code> Guid. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--identity\">Request Body Parameters — Identity</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>provinceLicenseNumber</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>licenseExpirationDate</em></td>\n<td>Optional date.</td>\n</tr>\n<tr>\n<td><em>repUserId</em> / <em>primaryTerritorialRepId</em></td>\n<td>Optional Guids.</td>\n</tr>\n<tr>\n<td><em>defaultClassId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>dealerPermissionId</em></td>\n<td>Optional Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--holdback--withhold\">Request Body Parameters — Holdback / Withhold</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>chargeOffRecoveryOptions</em></td>\n<td>Required int enum.</td>\n</tr>\n<tr>\n<td><em>withholdAccrualMethod</em> / <em>withholdNumberOfPayments</em> / <em>withholdPercentOfPayments</em></td>\n<td>Optional.</td>\n</tr>\n<tr>\n<td><em>minimumReserve</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>reserveRatio</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>discountBasis</em> / <em>discountPercent</em> / <em>discountAmount</em></td>\n<td>Optional discount holdback configuration.</td>\n</tr>\n<tr>\n<td><em>reserveBasis</em> / <em>reservePercent</em> / <em>reserveAmount</em></td>\n<td>Optional reserve holdback configuration.</td>\n</tr>\n<tr>\n<td><em>withholdBasis</em> / <em>withholdPercent</em> / <em>withholdAmount</em></td>\n<td>Optional withhold holdback configuration.</td>\n</tr>\n<tr>\n<td><em>allowOverride</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--term--amount-limits\">Request Body Parameters — Term / Amount Limits</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>defaultRecourseTerm</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>minTerm</em> / <em>maxTerm</em></td>\n<td>Optional int range.</td>\n</tr>\n<tr>\n<td><em>minAdvanceAmount</em> / <em>maxAdvanceAmount</em></td>\n<td>Optional decimal range.</td>\n</tr>\n<tr>\n<td><em>minAmountFinanced</em> / <em>maxAmountFinanced</em></td>\n<td>Optional decimal range.</td>\n</tr>\n<tr>\n<td><em>minPaymentAmount</em> / <em>maxPaymentAmount</em></td>\n<td>Optional decimal range.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--application--dealertrack\">Request Body Parameters — Application / DealerTrack</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>defaultTransmissionType</em></td>\n<td>Required int.</td>\n</tr>\n<tr>\n<td><em>customFieldsXML</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>newApplicationGroupId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>allowDealerTrackEntry</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>dtDealerId</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>dtGroupId</em> / <em>dtRetailClassId</em></td>\n<td>Optional Guids.</td>\n</tr>\n<tr>\n<td><em>displayReports</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>repUserLoginOrId</code></td>\n<td><code>repUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>primaryTerritorialRepLoginOrId</code></td>\n<td><code>primaryTerritorialRepId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultClassNumberOrId</code></td>\n<td><code>defaultClassId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>discountBasisDescriptionOrId</code></td>\n<td><code>discountBasis</code></td>\n<td>String. holdback-basis description or holdback-basis GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>reserveBasisDescriptionOrId</code></td>\n<td><code>reserveBasis</code></td>\n<td>String. holdback-basis description or holdback-basis GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>withholdBasisDescriptionOrId</code></td>\n<td><code>withholdBasis</code></td>\n<td>String. holdback-basis description or holdback-basis GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>newApplicationGroupNumberOrId</code></td>\n<td><code>newApplicationGroupId</code></td>\n<td>String. origination-group number or group GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>dtGroupNumberOrId</code></td>\n<td><code>dtGroupId</code></td>\n<td>String. origination-group number or group GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>dtRetailClassNumberOrId</code></td>\n<td><code>dtRetailClassId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>dealerPermissionCodeOrId</code></td>\n<td><code>dealerPermissionId</code></td>\n<td>String. dealer-permission code or dealer-permission GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"repUserLoginOrId\": \"collector.login\",\n  \"primaryTerritorialRepLoginOrId\": \"collector.login\",\n  \"defaultClassNumberOrId\": \"1\",\n  \"discountBasisDescriptionOrId\": \"Standard Holdback\",\n  \"reserveBasisDescriptionOrId\": \"Standard Holdback\",\n  \"withholdBasisDescriptionOrId\": \"Standard Holdback\",\n  \"newApplicationGroupNumberOrId\": \"1\",\n  \"dtGroupNumberOrId\": \"1\",\n  \"dtRetailClassNumberOrId\": \"1\",\n  \"dealerPermissionCodeOrId\": \"VIEW\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","Dealer","{{dealer_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ca23580f-2881-4330-b843-c907afc3ed69","name":"UpdateDealer - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"provinceLicenseNumber\": \"PL-12345\",\n  \"chargeOffRecoveryOptions\": 0,\n  \"allowOverride\": true,\n  \"defaultTransmissionType\": 0,\n  \"allowDealerTrackEntry\": false,\n  \"displayReports\": true,\n  \"repUserLoginOrId\": null,\n  \"primaryTerritorialRepLoginOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"discountBasisDescriptionOrId\": null,\n  \"reserveBasisDescriptionOrId\": null,\n  \"withholdBasisDescriptionOrId\": null,\n  \"newApplicationGroupNumberOrId\": null,\n  \"dtGroupNumberOrId\": null,\n  \"dtRetailClassNumberOrId\": null,\n  \"dealerPermissionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Dealer/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"a62edb2e-0464-4852-8d6c-12555c05a838","name":"UpdateDealer - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"provinceLicenseNumber\": \"PL-12345\",\n  \"chargeOffRecoveryOptions\": 0,\n  \"allowOverride\": true,\n  \"defaultTransmissionType\": 0,\n  \"allowDealerTrackEntry\": false,\n  \"displayReports\": true,\n  \"repUserLoginOrId\": null,\n  \"primaryTerritorialRepLoginOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"discountBasisDescriptionOrId\": null,\n  \"reserveBasisDescriptionOrId\": null,\n  \"withholdBasisDescriptionOrId\": null,\n  \"newApplicationGroupNumberOrId\": null,\n  \"dtGroupNumberOrId\": null,\n  \"dtRetailClassNumberOrId\": null,\n  \"dealerPermissionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Dealer/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Dealer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c827b2c7-bfaa-4a01-971d-7befbe7595eb"},{"name":"DocumentQueueDelete","id":"8a85b244-846d-4010-b22a-97df9885803d","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/DocumentQueue/{{document_queue_id}}","description":"<h3 id=\"delete-document-queue-entry\">Delete Document Queue Entry</h3>\n<p>Removes a single queued document by Guid. Wraps <code>DocumentQueueWSServices.DeleteWS</code>, which loads the matching <code>Common.DocumentQueue</code> row and removes it inside a <code>UnitOfWork2</code>. The controller rejects <code>Guid.Empty</code> with a 400 before reaching the service.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/DocumentQueue/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. The <code>Common.DocumentQueue.Id</code> of the row to remove. <code>Guid.Empty</code> returns a 400.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","DocumentQueue","{{document_queue_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"16eb3f07-ba54-4e5a-a292-5a5e0b0ea4f5","name":"DeleteDocumentQueue - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/DocumentQueue/11111111-1111-1111-1111-111111111111"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"11111111-1111-1111-1111-111111111111\"\n}"},{"id":"5d7c0aec-453e-46c8-9eb1-f13c5083ed67","name":"DeleteDocumentQueue - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/DocumentQueue/99999999-9999-9999-9999-999999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Document queue record not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"8a85b244-846d-4010-b22a-97df9885803d"},{"name":"DocumentQueueGet","id":"622f9d54-116a-4828-8183-acdbf3efde0f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/DocumentQueue?throughDate=2026-04-30T23:59:59&pageNumber=1&pageSize=50","description":"<h3 id=\"get-document-queue\">Get Document Queue</h3>\n<p>Returns a paged list of queued documents waiting to be printed/sent. Wraps <code>DocumentQueueWSServices.ListWS</code>, which queries the <code>Common.DocumentQueue</code> table (and joined letter, creator, and branch records) using the supplied filters. The controller maps the FromUri arrays into the underlying <code>ListDocumentQueueParameter</code> lists; omitting an array leaves that filter unrestricted.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/DocumentQueue</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>throughDate</em></td>\n<td>Optional ISO 8601 datetime. Upper-bound (inclusive) cutoff for queued documents. Omit to include everything.</td>\n</tr>\n<tr>\n<td><em>pageNumber</em></td>\n<td>Optional int. 1-based page index. Defaults to <code>1</code>.</td>\n</tr>\n<tr>\n<td><em>pageSize</em></td>\n<td>Optional int. Page size. Defaults to <code>50</code>.</td>\n</tr>\n<tr>\n<td><em>letterIds</em></td>\n<td>Optional Guid[]. Repeated <code>letterIds=...</code> values restrict to specific letter templates.</td>\n</tr>\n<tr>\n<td><em>creatorIds</em></td>\n<td>Optional Guid[]. Repeated <code>creatorIds=...</code> values restrict to specific creating users.</td>\n</tr>\n<tr>\n<td><em>branchIds</em></td>\n<td>Optional Guid[]. Repeated <code>branchIds=...</code> values restrict to specific branches.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Query field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>branchNumbersOrIds</code></td>\n<td><code>branchIds</code></td>\n<td>Repeated query parameter; each value is a branch number or branch GUID.</td>\n</tr>\n<tr>\n<td><code>creatorLoginsOrIds</code></td>\n<td><code>creatorIds</code></td>\n<td>Repeated query parameter; each value is a user login or user GUID.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Omit filters to leave them unrestricted. Explicitly blank new filters fail. Use repeated parameters, for example <code>branchNumbersOrIds=90&amp;branchNumbersOrIds=11111111-1111-4111-8111-111111111111&amp;creatorLoginsOrIds=collector.login</code>. Choose one form of each list; supplying old and new lists together fails.</p>\n<p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","DocumentQueue"],"host":["{{base_url}}"],"query":[{"key":"throughDate","value":"2026-04-30T23:59:59"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"50"}],"variable":[]}},"response":[{"id":"af11674f-4e01-40d3-a226-18b17f040819","name":"GetDocumentQueue - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/DocumentQueue?throughDate=2026-04-30T23:59:59&pageNumber=1&pageSize=50","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","DocumentQueue"],"query":[{"key":"throughDate","value":"2026-04-30T23:59:59"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"pageNumber\": 1,\n        \"pageSize\": 50,\n        \"totalRecords\": 2,\n        \"items\": [\n            {\n                \"Id\": \"11111111-1111-1111-1111-111111111111\",\n                \"AccountNumber\": \"30001212\",\n                \"LetterId\": \"22222222-2222-2222-2222-222222222222\",\n                \"LetterDescription\": \"Welcome Letter\",\n                \"BranchId\": \"33333333-3333-3333-3333-333333333333\",\n                \"BranchDescription\": \"Main Office\",\n                \"CreatorId\": \"44444444-4444-4444-4444-444444444444\",\n                \"CreatorName\": \"developer\",\n                \"QueuedDate\": \"2026-04-15T10:32:11\"\n            },\n            {\n                \"Id\": \"55555555-5555-5555-5555-555555555555\",\n                \"AccountNumber\": \"30001213\",\n                \"LetterId\": \"22222222-2222-2222-2222-222222222222\",\n                \"LetterDescription\": \"Welcome Letter\",\n                \"BranchId\": \"33333333-3333-3333-3333-333333333333\",\n                \"BranchDescription\": \"Main Office\",\n                \"CreatorId\": \"44444444-4444-4444-4444-444444444444\",\n                \"CreatorName\": \"developer\",\n                \"QueuedDate\": \"2026-04-16T08:14:55\"\n            }\n        ]\n    }\n}"},{"id":"1dfbbc43-a542-4c33-9922-acfb560c171d","name":"GetDocumentQueue - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-or-expired-token"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/DocumentQueue?throughDate=2026-04-30T23:59:59&pageNumber=1&pageSize=50","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","DocumentQueue"],"query":[{"key":"throughDate","value":"2026-04-30T23:59:59"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving document queue: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"622f9d54-116a-4828-8183-acdbf3efde0f"},{"name":"EMailTemplateAdd","id":"ac5efa26-e3a5-44a3-a41b-02503942b37a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Payment Reminder\",\n    \"subject\": \"Your payment is due soon\",\n    \"body\": \"<p>Hello {{customerName}}, your payment is due on {{dueDate}}.</p>\",\n    \"templateType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EMailTemplate","description":"<h3 id=\"add-email-template\">Add EMail Template</h3>\n<p>Creates a new <code>Common.EMailTemplate</code> row for the caller's client. The controller forwards the payload to <code>EMailTemplateWSServices.AddEMailTemplateWS</code>, which assigns a fresh Guid, calls <code>Omega.Common.BLL.EMailTemplateServices.AddSaveEmailTemplate</code> with <code>ts = null</code> (insert), and returns the new Guid in <code>data.Id</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/EMailTemplate</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable template description.</td>\n</tr>\n<tr>\n<td><em>subject</em></td>\n<td>Required string. E-mail subject line.</td>\n</tr>\n<tr>\n<td><em>body</em></td>\n<td>Required string. E-mail body (HTML or plain text).</td>\n</tr>\n<tr>\n<td><em>templateType</em></td>\n<td>Required int. Cast to <code>Omega.Common.Types.Enums.EMailTemplateType</code>. Pick the integer that matches the desired template type (see the enum for the up-to-date list of categories).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","EMailTemplate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b2f4452a-0dbd-405e-b015-29d5979f2c2f","name":"AddEMailTemplate - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Payment Reminder\",\n    \"subject\": \"Your payment is due soon\",\n    \"body\": \"<p>Hello {{customerName}}, your payment is due on {{dueDate}}.</p>\",\n    \"templateType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EMailTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"3442e962-e7af-4f44-a012-29de95e3cc03","name":"AddEMailTemplate - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"\",\n    \"subject\": \"Your payment is due soon\",\n    \"body\": \"<p>Hello {{customerName}}, your payment is due on {{dueDate}}.</p>\",\n    \"templateType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EMailTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"ac5efa26-e3a5-44a3-a41b-02503942b37a"},{"name":"EMailTemplateGet","id":"3ccaadf7-54bf-456f-afa9-bd78c8160f7f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/EMailTemplate/{{template_id}}","description":"<h3 id=\"get-email-template\">Get EMail Template</h3>\n<p>Returns a single <code>Common.EMailTemplate</code> resolved from the <code>{templateId}</code> path segment. The controller calls <code>Guid.TryParse</code> on the segment and responds <code>400 Bad Request</code> with <code>\"Invalid template ID format\"</code> when parsing fails. Valid Guids are passed to <code>EMailTemplateWSServices.ReturnEMailTemplateWS</code>, which loads the row via <code>Omega.Common.BLL.EMailTemplateServices.ReturnEmailTemplate</code> and projects it to <code>{ Id, OmegaClientId, Description, Subject, Body, TemplateType, Ts }</code>. Returns a <code>400</code> with <code>\"EMail template not found\"</code> when the template does not exist for the caller's client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/EMailTemplate/{templateId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>templateId</em></td>\n<td>Required Guid. <code>Common.EMailTemplate.Id</code>. <code>400 Bad Request</code> when the value is not a valid Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","EMailTemplate","{{template_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b84c74cf-0012-4a1a-86a6-32b17aa312f4","name":"GetEMailTemplate - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/EMailTemplate/{{template_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Payment Reminder\",\n        \"Subject\": \"Your payment is due soon\",\n        \"Body\": \"<p>Hello {{customerName}}, your payment is due on {{dueDate}}.</p>\",\n        \"TemplateType\": 1,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"cc651d97-b95a-4b94-925f-cb4b44d7f71e","name":"GetEMailTemplate - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/EMailTemplate/99999999-9999-9999-9999-999999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"EMail template not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"3ccaadf7-54bf-456f-afa9-bd78c8160f7f"},{"name":"EMailTemplatesGetAll","id":"14b6830d-e5c6-4563-a341-c38348a6fa7b","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/EMailTemplate","description":"<h3 id=\"get-all-email-templates\">Get All EMail Templates</h3>\n<p>Returns every <code>Common.EMailTemplate</code> row for the caller's client. The controller calls <code>EMailTemplateWSServices.ReturnAllEMailTemplatesWS</code>, which delegates to <code>Omega.Common.BLL.EMailTemplateServices.ReturnAllEmailTemplates</code> and projects each row to <code>{ Id, OmegaClientId, Description, Subject, Body, TemplateType, Ts }</code> with <code>Ts</code> emitted as a base-64 rowversion. Result is scoped by <code>LoginInfo.ClientId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/EMailTemplate</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","EMailTemplate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"22d3fc3c-ee44-49c9-a8c4-ce9325eb2bc3","name":"GetAllEMailTemplates - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/EMailTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Payment Reminder\",\n            \"Subject\": \"Your payment is due soon\",\n            \"Body\": \"<p>Hello {{customerName}}, your payment is due on {{dueDate}}.</p>\",\n            \"TemplateType\": 1,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"2a3e105a-5718-498b-b37a-60720fda2149","name":"GetAllEMailTemplates - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/Client/Common/EMailTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving email templates: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"14b6830d-e5c6-4563-a341-c38348a6fa7b"},{"name":"EMailTemplateUpdate","id":"05612212-bb79-4534-bed0-0dc2030a2dd0","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Payment Reminder - Updated\",\n    \"subject\": \"Reminder: payment is due soon\",\n    \"body\": \"<p>Hello {{customerName}}, your payment of {{amount}} is due on {{dueDate}}.</p>\",\n    \"templateType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EMailTemplate/{{template_id}}","description":"<h3 id=\"update-email-template\">Update EMail Template</h3>\n<p>Updates an existing <code>Common.EMailTemplate</code> resolved from the <code>{templateId}</code> path segment. The controller validates that <code>templateId</code> is a Guid (returning <code>400 Bad Request</code> otherwise) and forwards to <code>EMailTemplateWSServices.UpdateEMailTemplateWS</code>. That helper re-fetches the existing row via <code>Omega.Common.BLL.EMailTemplateServices.ReturnEmailTemplate</code> to obtain its rowversion (<code>Ts</code>), then calls <code>Omega.Common.BLL.EMailTemplateServices.AddSaveEmailTemplate</code> with the existing timestamp to drive an update. The request body does not carry <code>id</code> or <code>ts</code> — both are supplied server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/EMailTemplate/{templateId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>templateId</em></td>\n<td>Required Guid. <code>Common.EMailTemplate.Id</code>. <code>400 Bad Request</code> when the value is not a valid Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable template description.</td>\n</tr>\n<tr>\n<td><em>subject</em></td>\n<td>Required string. E-mail subject line.</td>\n</tr>\n<tr>\n<td><em>body</em></td>\n<td>Required string. E-mail body (HTML or plain text).</td>\n</tr>\n<tr>\n<td><em>templateType</em></td>\n<td>Required int. Cast to <code>Omega.Common.Types.Enums.EMailTemplateType</code>. Pick the integer that matches the desired template type (see the enum for the up-to-date list of categories).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","EMailTemplate","{{template_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fbe10dd6-5a0f-4271-9395-dba36edbc1ec","name":"UpdateEMailTemplate - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Payment Reminder - Updated\",\n    \"subject\": \"Reminder: payment is due soon\",\n    \"body\": \"<p>Hello {{customerName}}, your payment of {{amount}} is due on {{dueDate}}.</p>\",\n    \"templateType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EMailTemplate/{{template_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"b35b0d3c-a361-46b9-9d11-139e6b1dd507","name":"UpdateEMailTemplate - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Payment Reminder - Updated\",\n    \"subject\": \"Reminder: payment is due soon\",\n    \"body\": \"<p>Hello {{customerName}}, your payment of {{amount}} is due on {{dueDate}}.</p>\",\n    \"templateType\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EMailTemplate/99999999-9999-9999-9999-999999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"EMail template not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"05612212-bb79-4534-bed0-0dc2030a2dd0"},{"name":"EnterpriseInternalIntegrationConfiguration","id":"ff14d226-dc16-48e7-940c-b840ba9c266e","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"viewAccountUrl1Description\": \"Servicing Portal\",\n    \"viewAccountUrl1\": \"https://servicing.example.com/account/{accountNumber}\",\n    \"viewAccountUrl2Description\": \"Collections Console\",\n    \"viewAccountUrl2\": \"https://collections.example.com/lookup?acct={accountNumber}\",\n    \"viewAccountUrl3Description\": null,\n    \"viewAccountUrl3\": null,\n    \"viewAccountUrl4Description\": null,\n    \"viewAccountUrl4\": null,\n    \"viewAccountUrl5Description\": null,\n    \"viewAccountUrl5\": null,\n    \"viewAccountUrl6Description\": null,\n    \"viewAccountUrl6\": null,\n    \"viewAccountUrl7Description\": null,\n    \"viewAccountUrl7\": null,\n    \"viewAccountUrl8Description\": null,\n    \"viewAccountUrl8\": null,\n    \"viewAccountUrl9Description\": null,\n    \"viewAccountUrl9\": null,\n    \"viewAccountUrl10Description\": null,\n    \"viewAccountUrl10\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration","description":"<h3 id=\"update-enterprise-internal-integration-configuration\">Update Enterprise Internal Integration Configuration</h3>\n<p>Inserts or updates the caller client's enterprise internal-integration configuration row (one per client). The controller calls <code>Omega.Common.BLL.EnterpriseExternalIntegrationConfigurationServices.ReturnEnterpriseExternalIntegrationConfiguration</code> to load any existing row's <code>Id</code> and <code>Ts</code>, packs the body into <code>AddSaveEnterpriseInternalIntegrationParameter</code>, and forwards to <code>EnterpriseInternalIntegrationWSServices.AddSaveWS</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are resolved server-side. Configuration is keyed by <code>LoginInfo.ClientId</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Ten paired View-Account launch links (slot N=1..10):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>viewAccountUrl{N}Description</em></td>\n<td>Optional string. Display label for slot N (1..10).</td>\n</tr>\n<tr>\n<td><em>viewAccountUrl{N}</em></td>\n<td>Optional string. URL template launched for slot N.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","EnterpriseInternalIntegrationConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c79fb2c6-04ca-4175-b2e8-4664a5a7421c","name":"UpdateEnterpriseInternalIntegrationConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"viewAccountUrl1Description\": \"Servicing Portal\",\n    \"viewAccountUrl1\": \"https://servicing.example.com/account/{accountNumber}\",\n    \"viewAccountUrl2Description\": \"Collections Console\",\n    \"viewAccountUrl2\": \"https://collections.example.com/lookup?acct={accountNumber}\",\n    \"viewAccountUrl3Description\": null,\n    \"viewAccountUrl3\": null,\n    \"viewAccountUrl4Description\": null,\n    \"viewAccountUrl4\": null,\n    \"viewAccountUrl5Description\": null,\n    \"viewAccountUrl5\": null,\n    \"viewAccountUrl6Description\": null,\n    \"viewAccountUrl6\": null,\n    \"viewAccountUrl7Description\": null,\n    \"viewAccountUrl7\": null,\n    \"viewAccountUrl8Description\": null,\n    \"viewAccountUrl8\": null,\n    \"viewAccountUrl9Description\": null,\n    \"viewAccountUrl9\": null,\n    \"viewAccountUrl10Description\": null,\n    \"viewAccountUrl10\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"2eef5b42-d3af-4e2a-b1bf-14882c534865","name":"UpdateEnterpriseInternalIntegrationConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"invalid-token\",\n    \"viewAccountUrl1Description\": \"Servicing Portal\",\n    \"viewAccountUrl1\": \"https://servicing.example.com/account/{accountNumber}\",\n    \"viewAccountUrl2Description\": null,\n    \"viewAccountUrl2\": null,\n    \"viewAccountUrl3Description\": null,\n    \"viewAccountUrl3\": null,\n    \"viewAccountUrl4Description\": null,\n    \"viewAccountUrl4\": null,\n    \"viewAccountUrl5Description\": null,\n    \"viewAccountUrl5\": null,\n    \"viewAccountUrl6Description\": null,\n    \"viewAccountUrl6\": null,\n    \"viewAccountUrl7Description\": null,\n    \"viewAccountUrl7\": null,\n    \"viewAccountUrl8Description\": null,\n    \"viewAccountUrl8\": null,\n    \"viewAccountUrl9Description\": null,\n    \"viewAccountUrl9\": null,\n    \"viewAccountUrl10Description\": null,\n    \"viewAccountUrl10\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error saving enterprise internal integration configuration: Invalid token\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"ff14d226-dc16-48e7-940c-b840ba9c266e"},{"name":"EnterpriseInternalIntegrationConfiguration","id":"106a6f80-3851-4022-a5f5-2ce93a548541","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration","description":"<h3 id=\"get-enterprise-internal-integration-configuration\">Get Enterprise Internal Integration Configuration</h3>\n<p>Returns the caller client's enterprise internal-integration configuration row (one per client). Wraps <code>EnterpriseInternalIntegrationWSServices.GetWS</code>, which calls <code>Omega.Common.BLL.EnterpriseExternalIntegrationConfigurationServices.ReturnEnterpriseExternalIntegrationConfiguration</code> and returns the underlying <code>MyCommonEnterpriseExternalIntegrationConfigurationEntity</code> as <code>apiResults.data</code>. The row exposes ten paired <code>ViewAccountUrl{N}Description</code> / <code>ViewAccountUrl{N}</code> columns used by the client to publish \"View Account\" launch links into other internal systems.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","EnterpriseInternalIntegrationConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c4b071b0-04a8-4cd6-91f5-2fb677e5007b","name":"GetEnterpriseInternalIntegrationConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ViewAccountUrl1Description\": \"Servicing Portal\",\n        \"ViewAccountUrl1\": \"https://servicing.example.com/account/{accountNumber}\",\n        \"ViewAccountUrl2Description\": \"Collections Console\",\n        \"ViewAccountUrl2\": \"https://collections.example.com/lookup?acct={accountNumber}\",\n        \"ViewAccountUrl3Description\": null,\n        \"ViewAccountUrl3\": null,\n        \"ViewAccountUrl4Description\": null,\n        \"ViewAccountUrl4\": null,\n        \"ViewAccountUrl5Description\": null,\n        \"ViewAccountUrl5\": null,\n        \"ViewAccountUrl6Description\": null,\n        \"ViewAccountUrl6\": null,\n        \"ViewAccountUrl7Description\": null,\n        \"ViewAccountUrl7\": null,\n        \"ViewAccountUrl8Description\": null,\n        \"ViewAccountUrl8\": null,\n        \"ViewAccountUrl9Description\": null,\n        \"ViewAccountUrl9\": null,\n        \"ViewAccountUrl10Description\": null,\n        \"ViewAccountUrl10\": null,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"5444c531-36c6-4887-a164-ce3f271b4e17","name":"GetEnterpriseInternalIntegrationConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-token"}],"url":"https://{{base_url}}/api/Client/Common/EnterpriseInternalIntegrationConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving enterprise internal integration configuration: Invalid session\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"106a6f80-3851-4022-a5f5-2ce93a548541"},{"name":"ExternalMasterConfiguration","id":"1dbdee04-3ed2-400c-b001-ce40ed2f684a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"defaultAdminStatusCodeOrId\": \"AC\",\n    \"defaultSourceCodeOrId\": \"WEB\",\n    \"defaultExistingSourceCodeOrId\": \"WEB\",\n    \"requireCustomerSSN\": true,\n    \"allowDuplicateSSN\": false,\n    \"applicationExpirationDays\": 30,\n    \"dealerCustomFieldSetCodeOrId\": null,\n    \"restrictCollateralColors\": false,\n    \"linkedDocumentLocation\": \"C:\\\\OmegaDocs\",\n    \"importFilePath\": \"C:\\\\OmegaImports\",\n    \"accountNumberAssignmentMethod\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration","description":"<h3 id=\"add-external-master-configuration\">Add External Master Configuration</h3>\n<p>Inserts the caller client's Common external master configuration row when one does not yet exist. Wraps <code>CommonExternalMasterConfigurationWSServices.AddSaveWS</code> after the controller resolves the friendly <code>*CodeOrId</code> strings via <code>SharedWSServices.GetCommonAdminStatusId</code>, <code>SharedWSServices.GetCommonSourceCodeId</code>, and <code>SharedWSServices.GetCommonCustomFieldSetId</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are resolved server-side. Configuration is keyed by <code>LoginInfo.ClientId</code>; only one row exists per client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>defaultAdminStatusCodeOrId</em></td>\n<td>Required. Common admin-status code or Guid resolved via <code>SharedWSServices.GetCommonAdminStatusId</code>.</td>\n</tr>\n<tr>\n<td><em>defaultSourceCodeOrId</em></td>\n<td>Required. Common source code or Guid resolved via <code>SharedWSServices.GetCommonSourceCodeId</code>.</td>\n</tr>\n<tr>\n<td><em>defaultExistingSourceCodeOrId</em></td>\n<td>Required. Source code or Guid used for existing-customer flows.</td>\n</tr>\n<tr>\n<td><em>requireCustomerSSN</em></td>\n<td>Required boolean. Force customer SSN entry.</td>\n</tr>\n<tr>\n<td><em>allowDuplicateSSN</em></td>\n<td>Required boolean. Permit two customers to share a SSN.</td>\n</tr>\n<tr>\n<td><em>applicationExpirationDays</em></td>\n<td>Required int. Default expiration window for new applications.</td>\n</tr>\n<tr>\n<td><em>dealerCustomFieldSetCodeOrId</em></td>\n<td>Optional. Custom-field-set code or Guid for dealer screens. Resolved via <code>SharedWSServices.GetCommonCustomFieldSetId</code>.</td>\n</tr>\n<tr>\n<td><em>restrictCollateralColors</em></td>\n<td>Required boolean. Limit collateral color picker to the configured list.</td>\n</tr>\n<tr>\n<td><em>linkedDocumentLocation</em></td>\n<td>Optional string. Path used by linked-document storage.</td>\n</tr>\n<tr>\n<td><em>importFilePath</em></td>\n<td>Optional string. Path used by import jobs.</td>\n</tr>\n<tr>\n<td><em>accountNumberAssignmentMethod</em></td>\n<td>Required int. <code>Omega.Common.Types.AccountNumberAssignmentMethods</code> enum.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8c167dcf-7fb5-4a52-965a-0f08bd757234","name":"AddExternalMasterConfiguration - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"defaultAdminStatusCodeOrId\": \"AC\",\n    \"defaultSourceCodeOrId\": \"WEB\",\n    \"defaultExistingSourceCodeOrId\": \"WEB\",\n    \"requireCustomerSSN\": true,\n    \"allowDuplicateSSN\": false,\n    \"applicationExpirationDays\": 30,\n    \"dealerCustomFieldSetCodeOrId\": null,\n    \"restrictCollateralColors\": false,\n    \"linkedDocumentLocation\": \"C:\\\\OmegaDocs\",\n    \"importFilePath\": \"C:\\\\OmegaImports\",\n    \"accountNumberAssignmentMethod\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"532f940d-2ebf-4145-a2a2-358bf6279668","name":"AddExternalMasterConfiguration - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"defaultAdminStatusCodeOrId\": \"INVALID\",\n    \"defaultSourceCodeOrId\": \"WEB\",\n    \"defaultExistingSourceCodeOrId\": \"WEB\",\n    \"requireCustomerSSN\": true,\n    \"allowDuplicateSSN\": false,\n    \"applicationExpirationDays\": 30,\n    \"dealerCustomFieldSetCodeOrId\": null,\n    \"restrictCollateralColors\": false,\n    \"linkedDocumentLocation\": \"C:\\\\OmegaDocs\",\n    \"importFilePath\": \"C:\\\\OmegaImports\",\n    \"accountNumberAssignmentMethod\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Unable to resolve defaultAdminStatusCodeOrId 'INVALID'\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"1dbdee04-3ed2-400c-b001-ce40ed2f684a"},{"name":"ExternalMasterConfiguration","id":"3dd2995e-72d3-4f87-a58e-a7ebd4b53928","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"defaultAdminStatusCodeOrId\": \"AC\",\n    \"defaultSourceCodeOrId\": \"WEB\",\n    \"defaultExistingSourceCodeOrId\": \"WEB\",\n    \"requireCustomerSSN\": true,\n    \"allowDuplicateSSN\": false,\n    \"applicationExpirationDays\": 45,\n    \"dealerCustomFieldSetCodeOrId\": null,\n    \"restrictCollateralColors\": true,\n    \"linkedDocumentLocation\": \"C:\\\\OmegaDocs\",\n    \"importFilePath\": \"C:\\\\OmegaImports\",\n    \"accountNumberAssignmentMethod\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration","description":"<h3 id=\"update-external-master-configuration\">Update External Master Configuration</h3>\n<p>Updates the caller client's Common external master configuration row. The controller calls <code>Omega.Common.BLL.ExternalMasterConfigurationServices.ReturnMasterConfig</code> to load the existing row's <code>Id</code> and <code>Ts</code>, returning a <code>BadRequest</code> with <code>\"Common master configuration not found\"</code> when none exists. Friendly <code>*CodeOrId</code> fields are resolved through <code>SharedWSServices.GetCommonAdminStatusId</code>, <code>SharedWSServices.GetCommonSourceCodeId</code>, and <code>SharedWSServices.GetCommonCustomFieldSetId</code> before being forwarded to <code>CommonExternalMasterConfigurationWSServices.AddSaveWS</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are resolved server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>defaultAdminStatusCodeOrId</em></td>\n<td>Required. Common admin-status code or Guid resolved via <code>SharedWSServices.GetCommonAdminStatusId</code>.</td>\n</tr>\n<tr>\n<td><em>defaultSourceCodeOrId</em></td>\n<td>Required. Common source code or Guid resolved via <code>SharedWSServices.GetCommonSourceCodeId</code>.</td>\n</tr>\n<tr>\n<td><em>defaultExistingSourceCodeOrId</em></td>\n<td>Required. Source code or Guid used for existing-customer flows.</td>\n</tr>\n<tr>\n<td><em>requireCustomerSSN</em></td>\n<td>Required boolean. Force customer SSN entry.</td>\n</tr>\n<tr>\n<td><em>allowDuplicateSSN</em></td>\n<td>Required boolean. Permit two customers to share a SSN.</td>\n</tr>\n<tr>\n<td><em>applicationExpirationDays</em></td>\n<td>Required int. Default expiration window for new applications.</td>\n</tr>\n<tr>\n<td><em>dealerCustomFieldSetCodeOrId</em></td>\n<td>Optional. Custom-field-set code or Guid for dealer screens. Resolved via <code>SharedWSServices.GetCommonCustomFieldSetId</code>.</td>\n</tr>\n<tr>\n<td><em>restrictCollateralColors</em></td>\n<td>Required boolean. Limit collateral color picker to the configured list.</td>\n</tr>\n<tr>\n<td><em>linkedDocumentLocation</em></td>\n<td>Optional string. Path used by linked-document storage.</td>\n</tr>\n<tr>\n<td><em>importFilePath</em></td>\n<td>Optional string. Path used by import jobs.</td>\n</tr>\n<tr>\n<td><em>accountNumberAssignmentMethod</em></td>\n<td>Required int. <code>Omega.Common.Types.AccountNumberAssignmentMethods</code> enum.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"af58e6ec-6b11-4ab1-9f09-7390f0b7900d","name":"UpdateExternalMasterConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"defaultAdminStatusCodeOrId\": \"AC\",\n    \"defaultSourceCodeOrId\": \"WEB\",\n    \"defaultExistingSourceCodeOrId\": \"WEB\",\n    \"requireCustomerSSN\": true,\n    \"allowDuplicateSSN\": false,\n    \"applicationExpirationDays\": 45,\n    \"dealerCustomFieldSetCodeOrId\": null,\n    \"restrictCollateralColors\": true,\n    \"linkedDocumentLocation\": \"C:\\\\OmegaDocs\",\n    \"importFilePath\": \"C:\\\\OmegaImports\",\n    \"accountNumberAssignmentMethod\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"7535620b-a8f3-4a6b-aa1b-4d78f44222d0","name":"UpdateExternalMasterConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"defaultAdminStatusCodeOrId\": \"AC\",\n    \"defaultSourceCodeOrId\": \"WEB\",\n    \"defaultExistingSourceCodeOrId\": \"WEB\",\n    \"requireCustomerSSN\": true,\n    \"allowDuplicateSSN\": false,\n    \"applicationExpirationDays\": 45,\n    \"dealerCustomFieldSetCodeOrId\": null,\n    \"restrictCollateralColors\": true,\n    \"linkedDocumentLocation\": \"C:\\\\OmegaDocs\",\n    \"importFilePath\": \"C:\\\\OmegaImports\",\n    \"accountNumberAssignmentMethod\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Common master configuration not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"3dd2995e-72d3-4f87-a58e-a7ebd4b53928"},{"name":"ExternalMasterConfiguration","id":"d2a5965e-a224-435f-b674-faf2bfca099f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration","description":"<h3 id=\"get-external-master-configuration\">Get External Master Configuration</h3>\n<p>Returns the caller client's Common external master configuration row (one row per client). Wraps <code>CommonExternalMasterConfigurationWSServices.GetWS</code>, which calls <code>Omega.Common.BLL.ExternalMasterConfigurationServices.ReturnMasterConfig</code> and returns the underlying <code>MyCommonMasterConfigurationEntity</code> as <code>apiResults.data</code> — exposing the configuration columns maintained on <code>Common.MasterConfiguration</code> (default admin status, default and existing default source codes, customer SSN policy, application expiration days, dealer custom field set, collateral color restriction, linked-document location, import file path, account-number assignment method, etc.). Returns <code>400</code> with <code>\"Common master configuration not found\"</code> when the client has no row yet.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"47eb060f-5656-4b41-8b9e-c02b93dd074a","name":"GetExternalMasterConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"DefaultAdminStatusCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"DefaultSourceCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"DefaultExistingSourceCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"RequireCustomerSSN\": true,\n        \"AllowDuplicateSSN\": false,\n        \"ApplicationExpirationDays\": 30,\n        \"DealerCustomFieldSetId\": null,\n        \"RestrictCollateralColors\": false,\n        \"LinkedDocumentLocation\": \"C:\\\\OmegaDocs\",\n        \"ImportFilePath\": \"C:\\\\OmegaImports\",\n        \"AccountNumberAssignmentMethod\": 1,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"e537160d-d064-4197-9cd6-0a21f425a091","name":"GetExternalMasterConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Common master configuration not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d2a5965e-a224-435f-b674-faf2bfca099f"},{"name":"GenericRateTableAdd","id":"919758ff-a032-4412-8566-30f265960e6c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"isGlobal\": false,\n    \"code\": \"RATE1\",\n    \"description\": \"Standard Rate Table\",\n    \"tableType\": 1,\n    \"tableFormat\": 1,\n    \"jsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.99},{\\\"term\\\":48,\\\"rate\\\":6.49},{\\\"term\\\":60,\\\"rate\\\":6.99}]}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/GenericRateTable","description":"<h3 id=\"add-generic-rate-table\">Add Generic Rate Table</h3>\n<p>Creates a new <code>Common.GenericRateTable</code> row for the caller's client. The controller forwards to <code>GenericRateTableWSServices.AddGenericRateTableWS</code>, which enforces that <code>code</code> is non-empty, assigns a fresh Guid, and calls <code>Omega.Common.BLL.GenericRateTableServices.AddSaveGenericRateTableEntity</code> with <code>ts = null</code> (insert). Returns the new Guid in <code>data.Id</code>.</p>\n<p><code>tableType</code> is cast to <code>Omega.Common.Types.Enums.GenericRateTableType</code> and <code>tableFormat</code> is cast to <code>GenericRateTableFormatType</code>. Use the integer that matches the desired category/format from those enums. Neither value can be changed later — the update endpoint preserves the existing <code>TableType</code> and <code>TableFormat</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/GenericRateTable</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>isGlobal</em></td>\n<td>Required boolean. <code>true</code> makes the rate table available across scopes that honor the global flag.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Client-scoped unique code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>tableType</em></td>\n<td>Required int. Cast to <code>GenericRateTableType</code>. Category of rate table.</td>\n</tr>\n<tr>\n<td><em>tableFormat</em></td>\n<td>Required int. Cast to <code>GenericRateTableFormatType</code>. Payload layout.</td>\n</tr>\n<tr>\n<td><em>jsonData</em></td>\n<td>Required string. JSON-encoded payload holding the table rows/rates. Structure depends on the chosen <code>tableType</code> + <code>tableFormat</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","GenericRateTable"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"66bb6eeb-a0e3-455e-a79e-236f2c365eec","name":"AddGenericRateTable - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"isGlobal\": false,\n    \"code\": \"RATE1\",\n    \"description\": \"Standard Rate Table\",\n    \"tableType\": 1,\n    \"tableFormat\": 1,\n    \"jsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.99},{\\\"term\\\":48,\\\"rate\\\":6.49},{\\\"term\\\":60,\\\"rate\\\":6.99}]}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/GenericRateTable"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"df80fc45-6749-4adf-818f-936cb38475a3","name":"AddGenericRateTable - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"isGlobal\": false,\n    \"code\": \"\",\n    \"description\": \"Standard Rate Table\",\n    \"tableType\": 1,\n    \"tableFormat\": 1,\n    \"jsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.99},{\\\"term\\\":48,\\\"rate\\\":6.49},{\\\"term\\\":60,\\\"rate\\\":6.99}]}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/GenericRateTable"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Rate table code is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"919758ff-a032-4412-8566-30f265960e6c"},{"name":"GenericRateTableGet","id":"d5c4a201-7453-408b-92f1-97baf3b39799","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/GenericRateTable/{{rate_table_id}}","description":"<h3 id=\"get-generic-rate-table\">Get Generic Rate Table</h3>\n<p>This operation accepts rate-table code or rate-table GUID in <code>rateTableId</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/GenericRateTable/{rateTableId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>rateTableId</em></td>\n<td>Required string. rate-table code or rate-table GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>rateTableId</code></td>\n<td>rate-table code or rate-table GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Common/GenericRateTable/AUTO\n/api/Client/Common/GenericRateTable/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Common","GenericRateTable","{{rate_table_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1fa0c0db-f9e3-4ac5-8d8a-b811a758c65a","name":"GetGenericRateTable - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/GenericRateTable/{{rate_table_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Code\": \"RATE1\",\n        \"Description\": \"Standard Rate Table\",\n        \"IsGlobal\": false,\n        \"TableType\": 1,\n        \"TableFormat\": 1,\n        \"JsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.99},{\\\"term\\\":48,\\\"rate\\\":6.49},{\\\"term\\\":60,\\\"rate\\\":6.99}]}\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"3050f40a-7e47-46b8-b6ff-074a432cd64d","name":"GetGenericRateTable - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/GenericRateTable/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"errors\": [\n    \"rateTableId: record not found.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"d5c4a201-7453-408b-92f1-97baf3b39799"},{"name":"GenericRateTablesGetAll","id":"67fdee77-06ee-4600-bf65-f4636b920522","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/GenericRateTable","description":"<h3 id=\"get-all-generic-rate-tables\">Get All Generic Rate Tables</h3>\n<p>Lists all rate tables when <code>rateTableId</code> is omitted. Supply its code or GUID in that optional query parameter to select one table. An explicitly blank value is rejected.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/GenericRateTable</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>rateTableId</code></td>\n<td>rate-table code or rate-table GUID. Omit to list all tables; blank is invalid.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Common/GenericRateTable?rateTableId=AUTO\n/api/Client/Common/GenericRateTable?rateTableId=11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Common","GenericRateTable"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2ac923b0-572e-4cc1-b275-5c9ec95cc321","name":"GetAllGenericRateTables - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/GenericRateTable"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"RATE1\",\n            \"Description\": \"Standard Rate Table\",\n            \"IsGlobal\": false,\n            \"TableType\": 1,\n            \"TableFormat\": 1,\n            \"JsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.99},{\\\"term\\\":48,\\\"rate\\\":6.49},{\\\"term\\\":60,\\\"rate\\\":6.99}]}\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"51859bbe-6c3c-4110-a86c-5245c4a921e0","name":"GetAllGenericRateTables - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/GenericRateTable"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving generic rate tables\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"67fdee77-06ee-4600-bf65-f4636b920522"},{"name":"GenericRateTableUpdate","id":"134fa3e9-22d8-496d-99fe-d296243e29cc","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"RATE1\",\n    \"description\": \"Standard Rate Table - Updated\",\n    \"jsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.49},{\\\"term\\\":48,\\\"rate\\\":5.99},{\\\"term\\\":60,\\\"rate\\\":6.49}]}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/GenericRateTable/{{rate_table_id}}","description":"<h3 id=\"update-generic-rate-table\">Update Generic Rate Table</h3>\n<p>This operation accepts rate-table code or rate-table GUID in <code>rateTableId</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/GenericRateTable/{rateTableId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>rateTableId</em></td>\n<td>Required string. rate-table code or rate-table GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) code. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>jsonData</em></td>\n<td>Required string. JSON-encoded payload holding the rate-table rows. Structure must still match the original <code>tableType</code> + <code>tableFormat</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>rateTableId</code></td>\n<td>rate-table code or rate-table GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Common/GenericRateTable/AUTO\n/api/Client/Common/GenericRateTable/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Common","GenericRateTable","{{rate_table_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6a1e7b13-4ff7-4225-aa08-dd6a414109a1","name":"UpdateGenericRateTable - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"RATE1\",\n    \"description\": \"Standard Rate Table - Updated\",\n    \"jsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.49},{\\\"term\\\":48,\\\"rate\\\":5.99},{\\\"term\\\":60,\\\"rate\\\":6.49}]}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/GenericRateTable/{{rate_table_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"4474ac9a-4d8a-4cb0-8193-41f7b7fffa47","name":"UpdateGenericRateTable - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"RATE1\",\n    \"description\": \"Standard Rate Table - Updated\",\n    \"jsonData\": \"{\\\"rows\\\":[{\\\"term\\\":36,\\\"rate\\\":5.49},{\\\"term\\\":48,\\\"rate\\\":5.99},{\\\"term\\\":60,\\\"rate\\\":6.49}]}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/GenericRateTable/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"errors\": [\n    \"rateTableId: record not found.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"134fa3e9-22d8-496d-99fe-d296243e29cc"},{"name":"HoldbackBasisAdd","id":"d2cc8165-0c85-463c-9620-c38db33d3119","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Cash Price + Fees\",\n    \"available\": true,\n    \"includeCashPrice\": true,\n    \"includeDealerInsurance\": false,\n    \"includeLenderInsurance\": false,\n    \"includeDealerMarkup\": false,\n    \"includeOriginationFees\": true,\n    \"includeAdvanceAdjustmentFees\": true,\n    \"includeDownpayment\": false,\n    \"originationFees\": [],\n    \"advanceAdjustmentFees\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis","description":"<h3 id=\"add-holdback-basis\">Add Holdback Basis</h3>\n<p>Creates a new <code>Common.HoldbackBasis</code> for the caller's client. The controller maps the payload into <code>AddSaveHoldbackBasisParameter</code> with <code>id = null</code> and <code>ts = null</code> and forwards it to <code>HoldbackBasisWSServices.AddSaveHoldbackBasisWS</code>. A holdback basis captures which contract buckets (cash price, dealer insurance, lender insurance, dealer markup, origination fees, advance-adjustment fees, downpayment) contribute to the holdback calculation. Fee-link arrays let the caller anchor the basis to specific <code>OriginationFee</code> and <code>AdvanceAdjustmentFee</code> rows. Returns the new row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/HoldbackBasis</code></p>\n<h4 id=\"request-body-parameters--header\">Request Body Parameters — Header</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Label shown on holdback-basis dropdowns.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required boolean. Gates the row on active-holdback-basis lookups.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--inclusion-flags\">Request Body Parameters — Inclusion Flags</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>includeCashPrice</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>includeDealerInsurance</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>includeLenderInsurance</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>includeDealerMarkup</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>includeOriginationFees</em></td>\n<td>Required boolean. Master switch for the <code>originationFees[]</code> array.</td>\n</tr>\n<tr>\n<td><em>includeAdvanceAdjustmentFees</em></td>\n<td>Required boolean. Master switch for the <code>advanceAdjustmentFees[]</code> array.</td>\n</tr>\n<tr>\n<td><em>includeDownpayment</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--fee-links\">Request Body Parameters — Fee Links</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>originationFees</em></td>\n<td>Array of <code>{ id?: Guid, originationFeeId: Guid }</code>. Links the basis to specific origination-fee rows. <code>id</code> is optional on insert; omit to let the server assign a new child-row Guid.</td>\n</tr>\n<tr>\n<td><em>advanceAdjustmentFees</em></td>\n<td>Array of <code>{ id?: Guid, advanceAdjustmentFeeId: Guid }</code>. Links the basis to specific advance-adjustment-fee rows. <code>id</code> is optional on insert.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>advanceAdjustmentFees[].advanceAdjustmentFeeDescriptionOrId</code></td>\n<td><code>advanceAdjustmentFees[].advanceAdjustmentFeeId</code></td>\n<td>String. advance/adjustment-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>originationFees[].originationFeeDescriptionOrId</code></td>\n<td><code>originationFees[].originationFeeId</code></td>\n<td>String. origination-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"advanceAdjustmentFees\": [\n    {\n      \"advanceAdjustmentFeeDescriptionOrId\": \"Advance Fee\"\n    }\n  ],\n  \"originationFees\": [\n    {\n      \"originationFeeDescriptionOrId\": \"Origination Fee\"\n    }\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","HoldbackBasis"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9d18cdfc-48bf-4245-b3bc-cea180a0049b","name":"AddHoldbackBasis - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Cash Price + Fees\",\n    \"available\": true,\n    \"includeCashPrice\": true,\n    \"includeDealerInsurance\": false,\n    \"includeLenderInsurance\": false,\n    \"includeDealerMarkup\": false,\n    \"includeOriginationFees\": true,\n    \"includeAdvanceAdjustmentFees\": true,\n    \"includeDownpayment\": false,\n    \"originationFees\": [],\n    \"advanceAdjustmentFees\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"5857576f-78b7-4510-9c5b-2791d5eac5cb","name":"AddHoldbackBasis - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"\",\n    \"available\": true,\n    \"includeCashPrice\": true,\n    \"includeDealerInsurance\": false,\n    \"includeLenderInsurance\": false,\n    \"includeDealerMarkup\": false,\n    \"includeOriginationFees\": true,\n    \"includeAdvanceAdjustmentFees\": true,\n    \"includeDownpayment\": false,\n    \"originationFees\": [],\n    \"advanceAdjustmentFees\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d2cc8165-0c85-463c-9620-c38db33d3119"},{"name":"HoldbackBasisGet","id":"c2501463-55cc-4eac-b222-23569cf07f77","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis/{{id}}?fetchAdvanceAdjustmentFees=false&fetchOriginationFees=false","description":"<h3 id=\"get-holdback-basis\">Get Holdback Basis</h3>\n<p>This operation accepts holdback-basis description or holdback-basis GUID in <code>id</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/HoldbackBasis/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. holdback-basis description or holdback-basis GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchAdvanceAdjustmentFees</em></td>\n<td>Optional boolean. Defaults to <code>false</code>. When <code>true</code>, eager-loads linked <code>AdvanceAdjustmentFee</code> rows.</td>\n</tr>\n<tr>\n<td><em>fetchOriginationFees</em></td>\n<td>Optional boolean. Defaults to <code>false</code>. When <code>true</code>, eager-loads linked <code>OriginationFee</code> rows.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>holdback-basis description or holdback-basis GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Common/HoldbackBasis/Standard%20Holdback\n/api/Client/Common/HoldbackBasis/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Common","HoldbackBasis","{{id}}"],"host":["{{base_url}}"],"query":[{"key":"fetchAdvanceAdjustmentFees","value":"false"},{"key":"fetchOriginationFees","value":"false"}],"variable":[]}},"response":[{"id":"33cee5f6-138b-4b9a-b098-98988e18418a","name":"GetHoldbackBasis - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/HoldbackBasis/{{id}}?fetchAdvanceAdjustmentFees=false&fetchOriginationFees=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","HoldbackBasis","{{id}}"],"query":[{"key":"fetchAdvanceAdjustmentFees","value":"false"},{"key":"fetchOriginationFees","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Cash Price + Fees\",\n        \"Available\": true,\n        \"IncludeCashPrice\": true,\n        \"IncludeDealerInsurance\": false,\n        \"IncludeLenderInsurance\": false,\n        \"IncludeDealerMarkup\": false,\n        \"IncludeOriginationFees\": true,\n        \"IncludeAdvanceAdjustmentFees\": true,\n        \"IncludeDownpayment\": false,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"1cef2b6e-77ac-45c5-896d-a00aebe36ac9","name":"GetHoldbackBasis - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/HoldbackBasis/11111111-1111-4111-8111-111111111111?fetchAdvanceAdjustmentFees=false&fetchOriginationFees=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","HoldbackBasis","11111111-1111-4111-8111-111111111111"],"query":[{"key":"fetchAdvanceAdjustmentFees","value":"false"},{"key":"fetchOriginationFees","value":"false"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"c2501463-55cc-4eac-b222-23569cf07f77"},{"name":"HoldbackBasisUpdate","id":"a0cd2c8e-6ba2-4be9-9efc-32b941967242","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Cash Price + Fees - Updated\",\n    \"available\": true,\n    \"includeCashPrice\": true,\n    \"includeDealerInsurance\": false,\n    \"includeLenderInsurance\": false,\n    \"includeDealerMarkup\": false,\n    \"includeOriginationFees\": true,\n    \"includeAdvanceAdjustmentFees\": true,\n    \"includeDownpayment\": false,\n    \"originationFees\": [],\n    \"advanceAdjustmentFees\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis/{{id}}","description":"<h3 id=\"update-holdback-basis\">Update Holdback Basis</h3>\n<p>This operation accepts holdback-basis description or holdback-basis GUID in <code>id</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/HoldbackBasis/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. holdback-basis description or holdback-basis GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--header\">Request Body Parameters — Header</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--inclusion-flags\">Request Body Parameters — Inclusion Flags</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>includeCashPrice</em> / <em>includeDealerInsurance</em> / <em>includeLenderInsurance</em> / <em>includeDealerMarkup</em> / <em>includeOriginationFees</em> / <em>includeAdvanceAdjustmentFees</em> / <em>includeDownpayment</em></td>\n<td>Required booleans. Same semantics as the add endpoint.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters--fee-links\">Request Body Parameters — Fee Links</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>originationFees</em></td>\n<td>Array of <code>{ id?: Guid, originationFeeId: Guid }</code>. Include <code>id</code> to update an existing child row; omit to insert. Missing rows are deleted.</td>\n</tr>\n<tr>\n<td><em>advanceAdjustmentFees</em></td>\n<td>Array of <code>{ id?: Guid, advanceAdjustmentFeeId: Guid }</code>. Same add / update / delete semantics.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>holdback-basis description or holdback-basis GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>advanceAdjustmentFees[].advanceAdjustmentFeeDescriptionOrId</code></td>\n<td><code>advanceAdjustmentFees[].advanceAdjustmentFeeId</code></td>\n<td>String. advance/adjustment-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>originationFees[].originationFeeDescriptionOrId</code></td>\n<td><code>originationFees[].originationFeeId</code></td>\n<td>String. origination-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"advanceAdjustmentFees\": [\n    {\n      \"advanceAdjustmentFeeDescriptionOrId\": \"Advance Fee\"\n    }\n  ],\n  \"originationFees\": [\n    {\n      \"originationFeeDescriptionOrId\": \"Origination Fee\"\n    }\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Common/HoldbackBasis/Standard%20Holdback\n/api/Client/Common/HoldbackBasis/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Common","HoldbackBasis","{{id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c8e473c1-2c3c-4dee-9fd9-551bf5fc135e","name":"UpdateHoldbackBasis - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Cash Price + Fees - Updated\",\n    \"available\": true,\n    \"includeCashPrice\": true,\n    \"includeDealerInsurance\": false,\n    \"includeLenderInsurance\": false,\n    \"includeDealerMarkup\": false,\n    \"includeOriginationFees\": true,\n    \"includeAdvanceAdjustmentFees\": true,\n    \"includeDownpayment\": false,\n    \"originationFees\": [],\n    \"advanceAdjustmentFees\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"2bfed407-1d21-4111-ac3d-b69441b239d7","name":"UpdateHoldbackBasis - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Cash Price + Fees - Updated\",\n    \"available\": true,\n    \"includeCashPrice\": true,\n    \"includeDealerInsurance\": false,\n    \"includeLenderInsurance\": false,\n    \"includeDealerMarkup\": false,\n    \"includeOriginationFees\": true,\n    \"includeAdvanceAdjustmentFees\": true,\n    \"includeDownpayment\": false,\n    \"originationFees\": [],\n    \"advanceAdjustmentFees\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/HoldbackBasis/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"}],"_postman_id":"a0cd2c8e-6ba2-4be9-9efc-32b941967242"},{"name":"MergeDuplicateCustomers","id":"a06d550f-7fe8-4146-9a19-c2367a607295","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"primaryCustomerNumberOrId\": \"100001\",\n    \"secondaryCustomerNumberOrId\": \"100002\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MergeDuplicateCustomers","description":"<h3 id=\"merge-duplicate-customers\">Merge Duplicate Customers</h3>\n<p>Merges a secondary customer into a primary customer. Wraps <code>CustomerMergeWSServices.MergeDuplicateCustomersWS</code>, which resolves both identifiers via <code>SharedWSServices.GetCommonCustomerId</code> (Guid-first then customer-number lookup), then performs the consolidation server-side: account-customer links are repointed at the primary, child records (logs, notes, addresses, phones, employments, references, documents) are re-parented, and the secondary customer is soft-deleted. The <code>System.Web.HttpContext.Current.Server</code> reference is forwarded so the underlying service can map any linked-document file paths during the move.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/MergeDuplicateCustomers</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>primaryCustomerNumberOrId</em></td>\n<td>Required string. Customer number or Guid for the customer that survives the merge. Resolved via <code>SharedWSServices.GetCommonCustomerId</code>.</td>\n</tr>\n<tr>\n<td><em>secondaryCustomerNumberOrId</em></td>\n<td>Required string. Customer number or Guid for the customer that gets merged into the primary and removed.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","MergeDuplicateCustomers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"347f4133-6eba-4bd0-8271-72542e3f50fe","name":"MergeDuplicateCustomers - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"primaryCustomerNumberOrId\": \"100001\",\n    \"secondaryCustomerNumberOrId\": \"100002\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MergeDuplicateCustomers"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"be7517e1-7776-4654-be47-9b6539f8d8a6","name":"MergeDuplicateCustomers - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"primaryCustomerNumberOrId\": \"999999999\",\n    \"secondaryCustomerNumberOrId\": \"100002\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MergeDuplicateCustomers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Primary customer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"a06d550f-7fe8-4146-9a19-c2367a607295"},{"name":"OriginationFeeGet","id":"77b08272-261d-42b6-8629-c52772af20c6","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/OriginationFee/{{description_or_id}}","description":"<h3 id=\"get-origination-fee\">Get Origination Fee</h3>\n<p>Returns a single <code>Common.OriginationFee</code> resolved from the <code>{descriptionOrId}</code> path segment. The controller parses the segment with <code>Guid.TryParse</code> first; on success it calls <code>OriginationFeeServices.ReturnOriginationFee(databaseName, id)</code>. When the segment is not a Guid, it falls back to a client-scoped description lookup via <code>OriginationFeeServices.ReturnOriginationFee(databaseName, clientId, description)</code>. The matching <code>MyCommonOriginationFeeEntity</code> is returned directly in <code>data</code>; <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/OriginationFee/{descriptionOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required. Either the fee <code>Description</code> string (client-scoped lookup) or the row <code>Id</code> Guid. Resolution is Guid-first, then description.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","OriginationFee","{{description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2c2f801f-7d47-4928-acdd-6e215140ab0d","name":"GetOriginationFee - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/OriginationFee/{{description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Document Fee\",\n        \"Available\": true,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"3318509b-1220-49e1-ad1a-b4f9a1e4d514","name":"GetOriginationFee - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/OriginationFee/{{description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Origination fee not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"77b08272-261d-42b6-8629-c52772af20c6"},{"name":"OriginationFeesGetAll","id":"a4e36c03-4527-41ee-a503-46874cc53ee1","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/OriginationFee?availableOnly=false","description":"<h3 id=\"get-all-origination-fees\">Get All Origination Fees</h3>\n<p>Returns every <code>Common.OriginationFee</code> row for the caller's client. The controller forwards to <code>OriginationFeeWSServices.ReturnAllOriginationFeesWS</code>, which calls <code>OriginationFeeServices.ReturnOriginationFees(databaseName, clientId, availableOnly)</code>. Pass <code>availableOnly=true</code> to filter out rows with <code>Available = false</code> (useful for hydrating dropdowns on screens that should not expose retired fees).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/OriginationFee</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>availableOnly</em></td>\n<td>Optional boolean. Defaults to <code>false</code>. When <code>true</code>, excludes rows where <code>Available = false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","OriginationFee"],"host":["{{base_url}}"],"query":[{"key":"availableOnly","value":"false"}],"variable":[]}},"response":[{"id":"fdd18504-78b1-43d1-9820-342a9631402c","name":"GetAllOriginationFees - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/OriginationFee?availableOnly=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","OriginationFee"],"query":[{"key":"availableOnly","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Document Fee\",\n            \"Available\": true,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ]\n}"},{"id":"55d5303b-ab3a-489c-9023-fb7caf324a98","name":"GetAllOriginationFees - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/OriginationFee?availableOnly=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","OriginationFee"],"query":[{"key":"availableOnly","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving origination fees: Authentication failed\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"a4e36c03-4527-41ee-a503-46874cc53ee1"},{"name":"PhoneNumberStatusCodeAdd","id":"0f10fd08-7e8c-468c-8e8e-0a5bd888d738","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"API Sweep Phone Status\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode","description":"<h3 id=\"add-phone-number-status-code\">Add Phone Number Status Code</h3>\n<p>Creates a new <code>Common.PhoneNumberStatus</code> row for the caller's client through <code>PhoneNumberStatusCodeWSServices.AddPhoneNumberStatusCodeWS</code>. The service requires a non-empty <code>description</code>, rejects duplicate descriptions for the client, writes the <code>available</code> flag, and returns the new Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped phone status description; must be unique for the client.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required boolean. Whether this phone status is selectable for phone records.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","PhoneNumberStatusCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b6c6cd08-ad56-4e0d-8ab7-775bb22b6475","name":"AddPhoneNumberStatusCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"API Sweep Phone Status\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"eef07c02-799f-46c5-a448-8537541a3d18","name":"AddPhoneNumberStatusCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"0f10fd08-7e8c-468c-8e8e-0a5bd888d738"},{"name":"PhoneNumberStatusCodeGet","id":"77d33251-26e2-4ead-915e-efc0e612db9e","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/{{phone_number_status_description_or_id}}","description":"<h3 id=\"get-phone-number-status-code\">Get Phone Number Status Code</h3>\n<p>Returns a single <code>Common.PhoneNumberStatus</code> row resolved from <code>{descriptionOrId}</code>. The WS layer (<code>ReturnPhoneNumberStatusCodeWS</code>) attempts Guid resolution first and then falls back to a client-scoped description lookup. Unresolved values return <code>400 Bad Request</code> with <code>\"Phone number status code not found\"</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/{descriptionOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required. Either the status row Guid or its client-scoped description.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","PhoneNumberStatusCode","{{phone_number_status_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1a923d62-3d49-4948-b3f8-1791cc4c3a2c","name":"GetPhoneNumberStatusCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/Primary"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Primary\",\n        \"Available\": true,\n        \"Ts\": \"AAAAAAAAB9U=\"\n    }\n}"},{"id":"e0add065-88c6-4137-9bd1-89023d05a6d8","name":"GetPhoneNumberStatusCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/{{phone_number_status_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Phone number status code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"77d33251-26e2-4ead-915e-efc0e612db9e"},{"name":"PhoneNumberStatusCodesGetAll","id":"8cb81f55-ec1c-4e67-8fe4-6ae0fb1cc746","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode","description":"<h3 id=\"get-all-phone-number-status-codes\">Get All Phone Number Status Codes</h3>\n<p>Returns all <code>Common.PhoneNumberStatus</code> rows for the caller's client via <code>PhoneNumberStatusCodeWSServices.ReturnAllPhoneNumberStatusCodesWS</code>. The controller shares the route with single-row lookup; omitting <code>{descriptionOrId}</code> runs the list form.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","PhoneNumberStatusCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"046dcea7-e02b-4baf-a59b-7e1dfe916e68","name":"GetAllPhoneNumberStatusCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Primary\",\n            \"Available\": true,\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ]\n}"},{"id":"433a2876-4922-4ff0-b1c7-136c150639cb","name":"GetAllPhoneNumberStatusCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"8cb81f55-ec1c-4e67-8fe4-6ae0fb1cc746"},{"name":"PhoneNumberStatusCodeUpdate","id":"af22d4b6-82db-4149-9fdf-de7ffb57eadd","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"API Sweep Phone Status Updated\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/{{phone_number_status_description_or_id}}","description":"<h3 id=\"update-phone-number-status-code\">Update Phone Number Status Code</h3>\n<p>Updates an existing <code>Common.PhoneNumberStatus</code> row resolved from the <code>{descriptionOrId}</code> path segment. The controller copies the route value into <code>UpdatePhoneNumberStatusCodeParameter.descriptionOrId</code>; the service resolves the row, reuses its current timestamp, saves <code>description</code> and <code>available</code>, and returns the row Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/{descriptionOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required. Existing phone status Guid or description.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New or unchanged description.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required boolean. Whether the status is selectable.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","PhoneNumberStatusCode","{{phone_number_status_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9cc711f5-99e2-442d-9681-c0bd0a0f3eb0","name":"UpdatePhoneNumberStatusCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Primary Updated\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/Primary"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"12117680-a339-4643-bac0-e0615e489fc2","name":"UpdatePhoneNumberStatusCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"API Sweep Phone Status Updated\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/PhoneNumberStatusCode/{{phone_number_status_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Phone number status code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"af22d4b6-82db-4149-9fdf-de7ffb57eadd"},{"name":"ProvinceRuleAdd","id":"b8988cd7-be00-49f4-b5b3-a4c6f25f1a1e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"provinceId\": \"{{province_id}}\",\n  \"accountType\": 1,\n  \"active\": true,\n  \"nsfFee\": 25,\n  \"description\": \"API Sweep Province Rule\",\n  \"allowRepossession\": true,\n  \"daysToNotify\": 10,\n  \"minDaysBeforeSaleInvoluntary\": 15,\n  \"minDaysBeforeSaleVoluntary\": 10,\n  \"stateReportingRequirement\": 0,\n  \"provinceAbbreviationOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ProvinceRule","description":"<h3 id=\"add-province-rule\">Add Province Rule</h3>\n<p>Creates a new <code>Common.ProvinceRule</code> row for the caller's client through <code>ProvinceRuleWSServices.AddSaveProvinceRuleWS</code>. The controller maps the request body into <code>AddSaveProvinceRuleParameter</code> with a new Guid and no timestamp, so the service inserts rather than updates.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ProvinceRule</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>provinceId</em></td>\n<td>Required Guid. <code>Global.Province.Id</code> used by the rule.</td>\n</tr>\n<tr>\n<td><em>accountType</em></td>\n<td>Required int. <code>CommonAccountType</code> enum value scoped by the BLL.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. Whether the rule is active.</td>\n</tr>\n<tr>\n<td><em>nsfFee</em></td>\n<td>Optional number. NSF fee amount for the rule.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Rule description.</td>\n</tr>\n<tr>\n<td><em>allowRepossession</em></td>\n<td>Required boolean. Whether repossession is permitted under this rule.</td>\n</tr>\n<tr>\n<td><em>daysToNotify</em></td>\n<td>Optional int. Notice days.</td>\n</tr>\n<tr>\n<td><em>minDaysBeforeSaleInvoluntary</em></td>\n<td>Optional int. Minimum days before involuntary sale.</td>\n</tr>\n<tr>\n<td><em>minDaysBeforeSaleVoluntary</em></td>\n<td>Optional int. Minimum days before voluntary sale.</td>\n</tr>\n<tr>\n<td><em>stateReportingRequirement</em></td>\n<td>Required int. State-reporting requirement enum value.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>provinceAbbreviationOrId</code></td>\n<td><code>provinceId</code></td>\n<td>String. province/state abbreviation or province/state GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"provinceAbbreviationOrId\": \"CA\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","ProvinceRule"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"eba2e91a-9adc-4a04-a2e4-ed1aa4ae4cab","name":"AddProvinceRule - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"provinceId\": \"00000000-0000-0000-0000-000000000000\",\n  \"accountType\": 1,\n  \"active\": true,\n  \"nsfFee\": 25,\n  \"description\": \"API Sweep Province Rule\",\n  \"allowRepossession\": true,\n  \"daysToNotify\": 10,\n  \"minDaysBeforeSaleInvoluntary\": 15,\n  \"minDaysBeforeSaleVoluntary\": 10,\n  \"stateReportingRequirement\": 0,\n  \"provinceAbbreviationOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ProvinceRule"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"83946955-53cb-4ed3-8e46-648439fb9552","name":"AddProvinceRule - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"provinceId\": \"00000000-0000-0000-0000-000000000000\",\n  \"accountType\": 1,\n  \"active\": true,\n  \"nsfFee\": 25,\n  \"description\": \"API Sweep Province Rule\",\n  \"allowRepossession\": true,\n  \"daysToNotify\": 10,\n  \"minDaysBeforeSaleInvoluntary\": 15,\n  \"minDaysBeforeSaleVoluntary\": 10,\n  \"stateReportingRequirement\": 0,\n  \"provinceAbbreviationOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ProvinceRule"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid province ID\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b8988cd7-be00-49f4-b5b3-a4c6f25f1a1e"},{"name":"ProvinceRuleGet","id":"a96328b6-009b-4cee-91db-2b17809e6e09","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/{{province_rule_id}}?fetchProvince=false&fetchCountry=false&fetchProvinceRuleInstallment=false&fetchProvinceRuleDirect=false","description":"<h3 id=\"get-province-rule\">Get Province Rule</h3>\n<p>Returns a single <code>Common.ProvinceRule</code> resolved from <code>{id}</code>. The WS layer uses <code>SharedWSServices.GetCommonProvinceRuleId</code>, which accepts the row Guid or client-scoped description/code value, then loads the rule through <code>ProvinceRuleServices.ReturnProvinceRule</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ProvinceRule/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required. Province rule Guid or client-scoped description/code value.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchProvince</em> / <em>fetchCountry</em> / <em>fetchProvinceRuleInstallment</em> / <em>fetchProvinceRuleDirect</em></td>\n<td>Optional booleans controlling related data expansion.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ProvinceRule","{{province_rule_id}}"],"host":["{{base_url}}"],"query":[{"key":"fetchProvince","value":"false"},{"key":"fetchCountry","value":"false"},{"key":"fetchProvinceRuleInstallment","value":"false"},{"key":"fetchProvinceRuleDirect","value":"false"}],"variable":[]}},"response":[{"id":"ee782a00-e6eb-475f-af00-b730a07efeb2","name":"GetProvinceRule - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/ProvinceRule/00000000-0000-0000-0000-000000000000?fetchProvince=false&fetchCountry=false&fetchProvinceRuleInstallment=false&fetchProvinceRuleDirect=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","ProvinceRule","00000000-0000-0000-0000-000000000000"],"query":[{"key":"fetchProvince","value":"false"},{"key":"fetchCountry","value":"false"},{"key":"fetchProvinceRuleInstallment","value":"false"},{"key":"fetchProvinceRuleDirect","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ProvinceId\": \"00000000-0000-0000-0000-000000000000\",\n        \"AccountType\": 1,\n        \"Active\": true,\n        \"Description\": \"Default Province Rule\",\n        \"NsfFee\": 25.0,\n        \"AllowRepossession\": true,\n        \"Ts\": \"AAAAAAAAB9U=\"\n    }\n}"},{"id":"eeb6cbaf-93a8-40a8-95bb-9c9876cf20e7","name":"GetProvinceRule - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/ProvinceRule/00000000-0000-0000-0000-000000000000?fetchProvince=false&fetchCountry=false&fetchProvinceRuleInstallment=false&fetchProvinceRuleDirect=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","ProvinceRule","00000000-0000-0000-0000-000000000000"],"query":[{"key":"fetchProvince","value":"false"},{"key":"fetchCountry","value":"false"},{"key":"fetchProvinceRuleInstallment","value":"false"},{"key":"fetchProvinceRuleDirect","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid province rule ID or code\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"a96328b6-009b-4cee-91db-2b17809e6e09"},{"name":"ProvinceRulesGetAll","id":"c0b156a2-de56-422a-8e3f-12b1810ebc5c","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule?fetchProvince=false&fetchCountry=false&fetchProvinceRuleInstallment=false&fetchProvinceRuleDirect=false","description":"<h3 id=\"get-all-province-rules\">Get All Province Rules</h3>\n<p>Returns all <code>Common.ProvinceRule</code> rows for the caller's client via <code>ProvinceRuleWSServices.GetProvinceRulesWS</code>. Optional query flags control whether related province, country, installment, and direct rule data are fetched with the result set.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ProvinceRule</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchProvince</em></td>\n<td>Optional boolean. Include the related <code>Global.Province</code>.</td>\n</tr>\n<tr>\n<td><em>fetchCountry</em></td>\n<td>Optional boolean. Include country data when province data is fetched.</td>\n</tr>\n<tr>\n<td><em>fetchProvinceRuleInstallment</em></td>\n<td>Optional boolean. Include installment rule details.</td>\n</tr>\n<tr>\n<td><em>fetchProvinceRuleDirect</em></td>\n<td>Optional boolean. Include direct rule details.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ProvinceRule"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>Include related province.</p>\n","type":"text/plain"},"key":"fetchProvince","value":"false"},{"description":{"content":"<p>Include related country.</p>\n","type":"text/plain"},"key":"fetchCountry","value":"false"},{"description":{"content":"<p>Include installment rule details.</p>\n","type":"text/plain"},"key":"fetchProvinceRuleInstallment","value":"false"},{"description":{"content":"<p>Include direct rule details.</p>\n","type":"text/plain"},"key":"fetchProvinceRuleDirect","value":"false"}],"variable":[]}},"response":[{"id":"87a1d389-6069-4779-8d75-0bde1e20da27","name":"GetAllProvinceRules - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/ProvinceRule?fetchProvince=false&fetchCountry=false&fetchProvinceRuleInstallment=false&fetchProvinceRuleDirect=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","ProvinceRule"],"query":[{"key":"fetchProvince","value":"false","description":"Include related province."},{"key":"fetchCountry","value":"false","description":"Include related country."},{"key":"fetchProvinceRuleInstallment","value":"false","description":"Include installment rule details."},{"key":"fetchProvinceRuleDirect","value":"false","description":"Include direct rule details."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"ProvinceId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AccountType\": 1,\n            \"Active\": true,\n            \"Description\": \"Default Province Rule\",\n            \"NsfFee\": 25.0,\n            \"AllowRepossession\": true,\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ]\n}"},{"id":"6cb78c4a-0c39-466d-88e2-de8f98f6c151","name":"GetAllProvinceRules - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/Common/ProvinceRule?fetchProvince=false&fetchCountry=false&fetchProvinceRuleInstallment=false&fetchProvinceRuleDirect=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Common","ProvinceRule"],"query":[{"key":"fetchProvince","value":"false","description":"Include related province."},{"key":"fetchCountry","value":"false","description":"Include related country."},{"key":"fetchProvinceRuleInstallment","value":"false","description":"Include installment rule details."},{"key":"fetchProvinceRuleDirect","value":"false","description":"Include direct rule details."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c0b156a2-de56-422a-8e3f-12b1810ebc5c"},{"name":"ProvinceRuleStepRatesGet","id":"8cc3967f-86a7-4c5b-8b29-a67153b3fe1c","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/{{province_rule_id}}/StepRates","description":"<h3 id=\"get-province-rule-step-rates\">Get Province Rule Step Rates</h3>\n<p>Returns step-rate detail rows tied to a <code>Common.ProvinceRule</code>. The controller resolves <code>{id}</code> with <code>SharedWSServices.GetCommonProvinceRuleId</code> and delegates to <code>ProvinceRuleServices.ReturnProvinceRuleStepRateDetails</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ProvinceRule/{id}/StepRates</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required. Province rule Guid or client-scoped description/code value.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ProvinceRule","{{province_rule_id}}","StepRates"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"473b8842-0060-4bd6-9c7a-c5101b784b94","name":"GetProvinceRuleStepRates - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/00000000-0000-0000-0000-000000000000/StepRates"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": []\n}"},{"id":"201647b6-8dc0-476f-b30c-aa4ec4e18d7d","name":"GetProvinceRuleStepRates - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/00000000-0000-0000-0000-000000000000/StepRates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid province rule ID or code\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"8cc3967f-86a7-4c5b-8b29-a67153b3fe1c"},{"name":"ProvinceRuleUpdate","id":"5cdcaa71-d44f-4b11-9363-7b710d6c173b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"nsfFee\": 25.00,\n    \"description\": \"API Sweep Province Rule Updated\",\n    \"allowRepossession\": true,\n    \"daysToNotify\": 10,\n    \"minDaysBeforeSaleInvoluntary\": 15,\n    \"minDaysBeforeSaleVoluntary\": 10,\n    \"stateReportingRequirement\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/{{province_rule_id}}","description":"<h3 id=\"update-province-rule\">Update Province Rule</h3>\n<p>Updates an existing <code>Common.ProvinceRule</code> resolved from <code>{id}</code>. The controller resolves the rule with <code>SharedWSServices.GetCommonProvinceRuleId</code>, re-reads the current row and timestamp, preserves the original <code>provinceId</code> and <code>accountType</code>, then saves the mutable rule fields through <code>ProvinceRuleWSServices.AddSaveProvinceRuleWS</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ProvinceRule/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required. Existing province rule Guid or client-scoped description/code value.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>nsfFee</em></td>\n<td>Optional number.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>allowRepossession</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>daysToNotify</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>minDaysBeforeSaleInvoluntary</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>minDaysBeforeSaleVoluntary</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>stateReportingRequirement</em></td>\n<td>Required int.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ProvinceRule","{{province_rule_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"311946f1-509f-4b5d-b86a-c8e14491afd8","name":"UpdateProvinceRule - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"nsfFee\": 25.00,\n    \"description\": \"API Sweep Province Rule Updated\",\n    \"allowRepossession\": true,\n    \"daysToNotify\": 10,\n    \"minDaysBeforeSaleInvoluntary\": 15,\n    \"minDaysBeforeSaleVoluntary\": 10,\n    \"stateReportingRequirement\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"111d7de0-3d31-4546-9518-e0d51ddec8cc","name":"UpdateProvinceRule - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"nsfFee\": 25.00,\n    \"description\": \"API Sweep Province Rule Updated\",\n    \"allowRepossession\": true,\n    \"daysToNotify\": 10,\n    \"minDaysBeforeSaleInvoluntary\": 15,\n    \"minDaysBeforeSaleVoluntary\": 10,\n    \"stateReportingRequirement\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ProvinceRule/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid province rule ID or code\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"5cdcaa71-d44f-4b11-9363-7b710d6c173b"},{"name":"RemarkCodeAdd","id":"6445fee5-d645-4a9b-a1a1-62b6a40511f0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"VIP\",\n    \"description\": \"VIP Customer\",\n    \"active\": true,\n    \"enhanced\": true,\n    \"codeType\": 1,\n    \"mergeFieldDescription\": \"VIP\",\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"isAlert\": false,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/RemarkCode","description":"<h3 id=\"add-remark-code\">Add Remark Code</h3>\n<p>Creates a new <code>Common.RemarkCode</code> for the caller's client and its paired <code>Common.RemarkCodeEnhanced</code> row in a single transaction. The WS layer (<code>RemarkCodeWSServices.AddRemarkCodeWS</code>) rejects the request when <code>code</code> or <code>description</code> is empty or when another remark code with the same <code>code</code> already exists for the client. On success the controller returns the new remark code's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/RemarkCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Unique (per client) short code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. <code>true</code> makes the remark selectable on activity screens.</td>\n</tr>\n<tr>\n<td><em>enhanced</em></td>\n<td>Required boolean. Reserved flag carried on the remark-code row itself; the enhanced record is always created as well.</td>\n</tr>\n<tr>\n<td><em>codeType</em></td>\n<td>Required int. <code>CodeTypes</code> enum: <code>1</code> Client, <code>2</code> System, etc.</td>\n</tr>\n<tr>\n<td><em>mergeFieldDescription</em></td>\n<td>Optional string. Override label used when the remark is rendered in merge fields/letters.</td>\n</tr>\n<tr>\n<td><em>allowPayments</em></td>\n<td>Optional boolean. Written to the enhanced row; defaults to <code>true</code> when omitted.</td>\n</tr>\n<tr>\n<td><em>allowTransactions</em></td>\n<td>Optional boolean. Enhanced row; default <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>isAlert</em></td>\n<td>Optional boolean. Enhanced row; default <code>false</code>. Surfaces the remark as an alert-style indicator.</td>\n</tr>\n<tr>\n<td><em>allowBilling</em></td>\n<td>Optional boolean. Enhanced row; default <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>allowLate</em></td>\n<td>Optional boolean. Enhanced row; default <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>allowGeneralLetters</em></td>\n<td>Optional boolean. Enhanced row; default <code>true</code>.</td>\n</tr>\n<tr>\n<td><em>useSecurity</em></td>\n<td>Optional boolean. Enhanced row; default <code>false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","RemarkCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"fec2f71c-ff8d-4d77-8223-f6075d07991e","name":"AddRemarkCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"VIP\",\n    \"description\": \"VIP Customer\",\n    \"active\": true,\n    \"enhanced\": true,\n    \"codeType\": 1,\n    \"mergeFieldDescription\": \"VIP\",\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"isAlert\": false,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/RemarkCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"5a1d0dcd-5eab-492e-af53-45140c251adf","name":"AddRemarkCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"VIP\",\n    \"description\": \"VIP Customer\",\n    \"active\": true,\n    \"enhanced\": true,\n    \"codeType\": 1,\n    \"mergeFieldDescription\": \"VIP\",\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"isAlert\": false,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/RemarkCode"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Remark code with code 'VIP' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"6445fee5-d645-4a9b-a1a1-62b6a40511f0"},{"name":"RemarkCodeDelete","id":"0db6c1bd-62ff-402f-aa63-93f94f1b308d","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{remark_code_or_id}}","description":"<h3 id=\"delete-remark-code\">Delete Remark Code</h3>\n<p>Deletes the paired <code>Common.RemarkCodeEnhanced</code> row for the remark code resolved from the <code>{codeOrId}</code> path segment. The <code>Common.RemarkCode</code> row itself is <strong>not</strong> removed. The WS layer (<code>RemarkCodeWSServices.DeleteRemarkCodeWS</code>) resolves the remark code via <code>SharedWSServices.GetCommonRemarkCodeId</code> (Guid-first, then code string), fetches the enhanced row via <code>RemarkCodeServices.ReturnRemarkCodeEnhancedByRemarkCode</code>, and deletes it by the enhanced row's <code>Id</code> and <code>Ts</code> in a single transaction. Returns the deleted enhanced row's <code>Id</code> in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/RemarkCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the remark-code string or the row <code>Id</code> Guid. <code>400 Bad Request</code> when empty, when the remark code is not found, or when no paired enhanced row exists.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","RemarkCode","{{remark_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4568d486-caf5-4a57-8031-e22da876b0c7","name":"DeleteRemarkCode - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"119e5985-f95e-4706-9688-2543ea684402","name":"DeleteRemarkCode - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{code_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Remark code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"0db6c1bd-62ff-402f-aa63-93f94f1b308d"},{"name":"RemarkCodeGet","id":"657bb77e-a5f6-4ced-b187-332c4c399936","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{remark_code_or_id}}","description":"<h3 id=\"get-remark-code\">Get Remark Code</h3>\n<p>Returns a single <code>Common.RemarkCode</code> row resolved from the <code>{codeOrId}</code> path segment. Resolution runs through <code>SharedWSServices.GetCommonRemarkCodeId</code> which tries <code>Guid.TryParse</code> first, then falls back to a client-scoped lookup by the remark-code string. The paired enhanced row is fetched and attached under <code>enhancedData</code> with service defaults when no enhanced row exists. Returns <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/RemarkCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the remark-code string or the row <code>Id</code> Guid. Resolution is Guid-first, then code string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","RemarkCode","{{remark_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9f194dfc-d81b-4d46-b2e8-70e64ba057f6","name":"GetRemarkCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"remarkCode\": {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"VIP\",\n            \"Description\": \"VIP Customer\",\n            \"Active\": true,\n            \"Enhanced\": true,\n            \"CodeType\": 1,\n            \"MergeFieldDescription\": \"VIP\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        },\n        \"enhancedData\": {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"RemarkCodeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AllowPayments\": true,\n            \"AllowTransactions\": true,\n            \"IsAlert\": false,\n            \"AllowBilling\": true,\n            \"AllowLate\": true,\n            \"AllowGeneralLetters\": true,\n            \"UseSecurity\": false,\n            \"Ts\": \"AAAAAAAAB9I=\"\n        }\n    }\n}"},{"id":"b151d2bd-cf12-42eb-ba4e-6d31fd6fe9be","name":"GetRemarkCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{code_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Remark code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"657bb77e-a5f6-4ced-b187-332c4c399936"},{"name":"RemarkCodesGetAll","id":"bdf340f2-0765-43b7-87c7-e23a9e4de130","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode","description":"<h3 id=\"get-all-remark-codes\">Get All Remark Codes</h3>\n<p>Returns every <code>Common.RemarkCode</code> row for the caller's client via <code>RemarkCodeWSServices.ReturnAllRemarkCodesWS</code>. Each element is wrapped so the response carries both the core remark-code fields and the paired <code>enhancedData</code> block (<code>AllowPayments</code>, <code>AllowTransactions</code>, <code>IsAlert</code>, <code>AllowBilling</code>, <code>AllowLate</code>, <code>AllowGeneralLetters</code>, <code>UseSecurity</code>). Remark codes without a saved enhanced row fall back to the service defaults. The controller routes both <code>/api/Client/Common/RemarkCode</code> and <code>/api/Client/Common/RemarkCode/{codeOrId}</code> to <code>GetRemarkCode</code>; when the path has no segment the list form runs.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/RemarkCode</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","RemarkCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"47d3b3c4-1666-492e-b2de-1e908f8622fd","name":"GetAllRemarkCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"remarkCode\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000000\",\n                \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n                \"Code\": \"VIP\",\n                \"Description\": \"VIP Customer\",\n                \"Active\": true,\n                \"Enhanced\": true,\n                \"CodeType\": 1,\n                \"MergeFieldDescription\": \"VIP\",\n                \"Ts\": \"AAAAAAAAB9E=\"\n            },\n            \"enhancedData\": {\n                \"Id\": \"00000000-0000-0000-0000-000000000000\",\n                \"RemarkCodeId\": \"00000000-0000-0000-0000-000000000000\",\n                \"AllowPayments\": true,\n                \"AllowTransactions\": true,\n                \"IsAlert\": false,\n                \"AllowBilling\": true,\n                \"AllowLate\": true,\n                \"AllowGeneralLetters\": true,\n                \"UseSecurity\": false,\n                \"Ts\": \"AAAAAAAAB9I=\"\n            }\n        }\n    ]\n}"},{"id":"acb94a87-6ece-436e-9c6a-0996dfb8e7c1","name":"GetAllRemarkCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/RemarkCode"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving remark codes for client: Invalid session\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"bdf340f2-0765-43b7-87c7-e23a9e4de130"},{"name":"RemarkCodeUpdate","id":"09c68a62-97fe-4be3-bddb-c80ba5869af0","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"VIP\",\n    \"description\": \"VIP Customer - Updated\",\n    \"active\": true,\n    \"enhanced\": true,\n    \"codeType\": 1,\n    \"mergeFieldDescription\": \"VIP\",\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"isAlert\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{remark_code_or_id}}","description":"<h3 id=\"update-remark-code\">Update Remark Code</h3>\n<p>Updates an existing <code>Common.RemarkCode</code> resolved from the <code>{codeOrId}</code> path segment. The WS layer (<code>RemarkCodeWSServices.SaveRemarkCodeChangesWS</code>) resolves the row via <code>SharedWSServices.GetCommonRemarkCodeId</code> (Guid-first, then code string), re-reads the row's current <code>Ts</code> server-side, and then saves the remark-code fields plus the paired enhanced row in one transaction. The enhanced row is (re)saved whenever any enhanced flag is supplied in the body or when an enhanced row already exists. Omitted nullable enhanced flags keep their existing value, falling back to the service default when no existing value exists. The request body does not carry <code>id</code> or <code>ts</code> — both are supplied server-side.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/RemarkCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the current remark-code string or the row <code>Id</code> Guid. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) remark code. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>enhanced</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>codeType</em></td>\n<td>Required int. <code>CodeTypes</code> enum.</td>\n</tr>\n<tr>\n<td><em>mergeFieldDescription</em></td>\n<td>Optional string. Merge-field label override.</td>\n</tr>\n<tr>\n<td><em>allowPayments</em> / <em>allowTransactions</em> / <em>isAlert</em> / <em>allowBilling</em> / <em>allowLate</em> / <em>allowGeneralLetters</em> / <em>useSecurity</em></td>\n<td>Optional booleans for the enhanced row. Omitted values inherit the existing enhanced row (or service default).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","RemarkCode","{{remark_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b2505a0f-e878-407c-bc94-b1dd2aa4c26d","name":"UpdateRemarkCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"VIP\",\n    \"description\": \"VIP Customer - Updated\",\n    \"active\": true,\n    \"enhanced\": true,\n    \"codeType\": 1,\n    \"mergeFieldDescription\": \"VIP\",\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"isAlert\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"d139c806-43d0-4b83-b04a-abd4f2e2f29f","name":"UpdateRemarkCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"VIP\",\n    \"description\": \"VIP Customer - Updated\",\n    \"active\": true,\n    \"enhanced\": true,\n    \"codeType\": 1,\n    \"mergeFieldDescription\": \"VIP\",\n    \"allowPayments\": true,\n    \"allowTransactions\": true,\n    \"isAlert\": true,\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/RemarkCode/{{code_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Remark code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"09c68a62-97fe-4be3-bddb-c80ba5869af0"},{"name":"ResultCodeAdd","id":"72da6ec6-e45c-4f41-b297-542dc4afade5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"PTP\",\n  \"description\": \"Promise To Pay\",\n  \"codeType\": 1,\n  \"active\": true,\n  \"promiseToPay\": true,\n  \"defaultDays\": 7,\n  \"maxDays\": 30,\n  \"contactTypeId\": null,\n  \"closeSchedFUP\": false,\n  \"schedFUP\": true,\n  \"templateId\": null,\n  \"addRemarkCode\": \"VIP\",\n  \"removeRemarkCode\": null,\n  \"paymentRequired\": true,\n  \"contactTypeCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCode","description":"<h3 id=\"add-result-code\">Add Result Code</h3>\n<p>Creates a new <code>Common.ResultCode</code> row for the caller's client. The controller (<code>ResultCodeController.AddResultCode</code>) remaps the inbound <code>AddResultCodeParameter</code> to an <code>AddSaveResultCodeParameter</code> with <code>isUpdate = false</code>, so <code>AddSaveResultCodeWS</code> performs an insert. Each supplied add/remove remark-code string is resolved through <code>SharedWSServices.GetCommonRemarkCodeId</code>; an unresolved remark code returns <code>400 Bad Request</code> before any row is written. A duplicate code (per client) also returns <code>400 Bad Request</code>. The transaction is committed via <code>UnitOfWork2</code> and the new row <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Result code. Must be unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>codeType</em></td>\n<td>Required int. <code>CodeTypes</code> enum.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>promiseToPay</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>defaultDays</em> / <em>maxDays</em></td>\n<td>Optional int. Follow-up day windows.</td>\n</tr>\n<tr>\n<td><em>contactTypeId</em></td>\n<td>Optional Guid. <code>Common.ResultCodeContactType</code> row.</td>\n</tr>\n<tr>\n<td><em>closeSchedFUP</em> / <em>schedFUP</em></td>\n<td>Required boolean. Controls scheduled follow-up behavior.</td>\n</tr>\n<tr>\n<td><em>templateId</em></td>\n<td>Optional Guid. Associated template.</td>\n</tr>\n<tr>\n<td><em>addRemarkCode</em>, <em>addRemarkCode2_–_addRemarkCode5</em></td>\n<td>Optional strings. Remark-code strings or Guid to add on result application. Resolved server-side.</td>\n</tr>\n<tr>\n<td><em>removeRemarkCode</em>, <em>removeRemarkCode2_–_removeRemarkCode5</em></td>\n<td>Optional strings. Remark-code strings or Guid to remove on result application. Resolved server-side.</td>\n</tr>\n<tr>\n<td><em>paymentRequired</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>contactTypeCodeOrId</code></td>\n<td><code>contactTypeId</code></td>\n<td>String. contact-type code or contact-type GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"contactTypeCodeOrId\": \"PHONE\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"181e3ac6-56dd-4665-b212-f66fbfe8d351","name":"AddResultCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"PTP\",\n  \"description\": \"Promise To Pay\",\n  \"codeType\": 1,\n  \"active\": true,\n  \"promiseToPay\": true,\n  \"defaultDays\": 7,\n  \"maxDays\": 30,\n  \"contactTypeId\": null,\n  \"closeSchedFUP\": false,\n  \"schedFUP\": true,\n  \"templateId\": null,\n  \"addRemarkCode\": \"VIP\",\n  \"removeRemarkCode\": null,\n  \"paymentRequired\": true,\n  \"contactTypeCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"6f150da2-6ae9-424b-8e6b-0241b6b9a8e9","name":"AddResultCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"PTP\",\n  \"description\": \"Promise To Pay\",\n  \"codeType\": 1,\n  \"active\": true,\n  \"promiseToPay\": true,\n  \"defaultDays\": 7,\n  \"maxDays\": 30,\n  \"contactTypeId\": null,\n  \"closeSchedFUP\": false,\n  \"schedFUP\": true,\n  \"templateId\": null,\n  \"addRemarkCode\": \"BADCODE\",\n  \"removeRemarkCode\": null,\n  \"paymentRequired\": true,\n  \"contactTypeCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCode"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Add remark code 'BADCODE' not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"72da6ec6-e45c-4f41-b297-542dc4afade5"},{"name":"ResultCodeContactTypeAdd","id":"d1c582f3-72ae-4a2b-ac30-a9b128057b2e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"PHONE\",\n    \"description\": \"Phone Contact\",\n    \"isSuccessfulContact\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType","description":"<h3 id=\"add-result-code-contact-type\">Add Result Code Contact Type</h3>\n<p>Creates a new <code>Common.ResultCodeContactType</code> row for the caller's client. The controller (<code>ResultCodeContactTypeController.AddResultCodeContactType</code>) remaps the inbound <code>AddResultCodeContactTypeParameter</code> to an <code>AddSaveResultCodeContactTypeParameter</code> with <code>id = null</code> and <code>ts = null</code>, so <code>AddSaveResultCodeContactTypeWS</code> treats the call as an insert. The WS layer rejects duplicate codes (per client) before generating a new <code>Id</code> and committing via <code>UnitOfWork2</code>. The new row <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCodeContactType</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Contact-type code. Must be unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>isSuccessfulContact</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCodeContactType"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d4f7ba8b-7b11-4992-bf96-90d614c780e4","name":"AddResultCodeContactType - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"PHONE\",\n    \"description\": \"Phone Contact\",\n    \"isSuccessfulContact\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"1365cf98-7b57-4afc-9eef-b94a1e010e90","name":"AddResultCodeContactType - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"PHONE\",\n    \"description\": \"Phone Contact\",\n    \"isSuccessfulContact\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Result code contact type with code 'PHONE' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d1c582f3-72ae-4a2b-ac30-a9b128057b2e"},{"name":"ResultCodeContactTypeCountGet","id":"4d7cabf5-2c4c-4dfb-bd28-aa6374c02a30","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/Count","description":"<h3 id=\"get-result-code-contact-type-count\">Get Result Code Contact Type Count</h3>\n<p>Returns a single integer — the count of <code>Common.ResultCodeContactType</code> rows for the caller's client. The WS layer (<code>ResultCodeContactTypeWSServices.ReturnResultCodeContactTypeCountWS</code>) delegates to <code>ResultCodeContactTypeServices.ReturnResultCodeContactTypeCount</code> with <code>LoginInfo.ClientId</code> for client scoping. The value lands in the <code>data</code> field as a plain number.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCodeContactType/Count</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCodeContactType","Count"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"06a9dc09-1492-40bc-a6dc-597323de0596","name":"GetResultCodeContactTypeCount - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/Count"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": 5\n}"},{"id":"dc992375-ac52-4613-94ea-fe0db53c7632","name":"GetResultCodeContactTypeCount - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/Count"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"4d7cabf5-2c4c-4dfb-bd28-aa6374c02a30"},{"name":"ResultCodeContactTypeGet","id":"bf9bbda8-e1c8-4acd-967a-723845178273","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/{{result_code_contact_type_code_or_id}}","description":"<h3 id=\"get-result-code-contact-type\">Get Result Code Contact Type</h3>\n<p>Returns a single <code>Common.ResultCodeContactType</code> row resolved from the <code>{codeOrId}</code> path segment. The controller (<code>ResultCodeContactTypeController.GetResultCodeContactType</code>) resolves the row through <code>SharedWSServices.GetCommonResultCodeContactTypeId</code> (Guid-first, then code string, client-scoped), then fetches the entity directly via <code>ResultCodeContactTypeServices.ReturnResultCodeContactType</code> and assigns the entity to <code>data</code>. Returns <code>400 Bad Request</code> when the segment is empty or cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCodeContactType/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the contact-type code string or the row <code>Id</code> Guid. Resolution is Guid-first, then code string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCodeContactType","{{result_code_contact_type_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a6e25983-46c7-4ce0-9683-ec99e642db79","name":"GetResultCodeContactType - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Code\": \"PHONE\",\n        \"Description\": \"Phone Contact\",\n        \"IsSuccessfulContact\": true,\n        \"Ts\": \"AAAAAAAAB9Q=\"\n    }\n}"},{"id":"3dab742e-302d-4cfc-8f20-660072a49811","name":"GetResultCodeContactType - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/NOPE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Result code contact type not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"bf9bbda8-e1c8-4acd-967a-723845178273"},{"name":"ResultCodeContactTypesGetAll","id":"c9a3348f-4070-46bb-9a86-c6456edb6a75","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType","description":"<h3 id=\"get-all-result-code-contact-types\">Get All Result Code Contact Types</h3>\n<p>Returns all <code>Common.ResultCodeContactType</code> rows for the caller's client. The controller (<code>ResultCodeContactTypeController.GetResultCodeContactType</code>) shares its route template with the single-row GET — when the optional <code>{codeOrId}</code> segment is omitted, the controller calls <code>ResultCodeContactTypeWSServices.ReturnAllResultCodeContactTypesWS</code> which delegates to <code>ResultCodeContactTypeServices.ReturnAllResultCodeContactTypes</code> with <code>LoginInfo.ClientId</code> for client scoping.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCodeContactType</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCodeContactType"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e9584d4f-5195-40ee-9ddc-3689c1eb1984","name":"GetAllResultCodeContactTypes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"PHONE\",\n            \"Description\": \"Phone Contact\",\n            \"IsSuccessfulContact\": true,\n            \"Ts\": \"AAAAAAAAB9Q=\"\n        }\n    ]\n}"},{"id":"0381ce9b-bc0c-4530-82ae-b19214c2f437","name":"GetAllResultCodeContactTypes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"c9a3348f-4070-46bb-9a86-c6456edb6a75"},{"name":"ResultCodeContactTypeUpdate","id":"e76cb709-c245-43f1-a42a-4df71d342e77","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"PHONE\",\n    \"description\": \"Phone Contact - Updated\",\n    \"isSuccessfulContact\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/{{result_code_contact_type_code_or_id}}","description":"<h3 id=\"update-result-code-contact-type\">Update Result Code Contact Type</h3>\n<p>Updates an existing <code>Common.ResultCodeContactType</code> row resolved from the <code>{codeOrId}</code> path segment. The controller (<code>ResultCodeContactTypeController.UpdateResultCodeContactType</code>) resolves the row via <code>SharedWSServices.GetCommonResultCodeContactTypeId</code> (Guid-first, then code string), re-reads the current row's <code>Ts</code> server-side, and builds an <code>AddSaveResultCodeContactTypeParameter</code> with <code>id</code> and <code>ts</code> populated so <code>AddSaveResultCodeContactTypeWS</code> treats the call as an update. Returns <code>400 Bad Request</code> when the segment is empty, the row cannot be resolved, or the row no longer exists.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCodeContactType/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the current contact-type code string or the row <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) contact-type code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>isSuccessfulContact</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCodeContactType","{{result_code_contact_type_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"65f394fc-0aa9-4a98-aee5-d3d3f8a6e86b","name":"UpdateResultCodeContactType - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"PHONE\",\n    \"description\": \"Phone Contact - Updated\",\n    \"isSuccessfulContact\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"5ad2752d-5257-433b-a53a-4c923dfe31c2","name":"UpdateResultCodeContactType - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"PHONE\",\n    \"description\": \"Phone Contact - Updated\",\n    \"isSuccessfulContact\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCodeContactType/NOPE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Result code contact type not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e76cb709-c245-43f1-a42a-4df71d342e77"},{"name":"ResultCodeGet","id":"827f31ee-9e24-4d80-a873-03b414fcd0ad","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCode/{{result_code_or_id}}","description":"<h3 id=\"get-result-code\">Get Result Code</h3>\n<p>Returns a single <code>Common.ResultCode</code> row resolved from the <code>{codeOrId}</code> path segment. The WS layer (<code>ResultCodeWSServices.ReturnResultCodeWS</code>) attempts <code>Guid.TryParse</code> first and calls <code>ResultCodeServices.ReturnResultCode(databaseName, id)</code>; on failure it falls back to <code>ResultCodeServices.ReturnResultCode(databaseName, clientId, code)</code> for the client-scoped code lookup. Returns <code>400 Bad Request</code> when the segment is empty or the row cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the result-code string or the row <code>Id</code> Guid. Resolution is Guid-first, then code string (client-scoped).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCode","{{result_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c4697d0d-4a83-4bea-bd55-10bee955c559","name":"GetResultCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCode/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Code\": \"PTP\",\n        \"Description\": \"Promise To Pay\",\n        \"CodeType\": 1,\n        \"Active\": true,\n        \"PromiseToPay\": true,\n        \"DefaultDays\": 7,\n        \"MaxDays\": 30,\n        \"ContactTypeId\": null,\n        \"CloseSchedFUP\": false,\n        \"SchedFUP\": true,\n        \"TemplateId\": null,\n        \"AddRemarkCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"AddRemarkCode2Id\": null,\n        \"AddRemarkCode3Id\": null,\n        \"AddRemarkCode4Id\": null,\n        \"AddRemarkCode5Id\": null,\n        \"RemoveRemarkCodeId\": null,\n        \"RemoveRemarkCode2Id\": null,\n        \"RemoveRemarkCode3Id\": null,\n        \"RemoveRemarkCode4Id\": null,\n        \"RemoveRemarkCode5Id\": null,\n        \"PaymentRequired\": true,\n        \"Ts\": \"AAAAAAAAB9U=\"\n    }\n}"},{"id":"428c980e-8482-48d6-9ad4-cee9157772e4","name":"GetResultCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCode/NOPE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Result code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"827f31ee-9e24-4d80-a873-03b414fcd0ad"},{"name":"ResultCodesGetAll","id":"eced7394-28a9-4e4c-af75-5265d9e18767","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCode","description":"<h3 id=\"get-all-result-codes\">Get All Result Codes</h3>\n<p>Returns all <code>Common.ResultCode</code> rows for the caller's client. The controller (<code>ResultCodeController.GetResultCode</code>) shares its route template with the single-row GET — when the optional <code>{codeOrId}</code> segment is omitted, the controller calls <code>ResultCodeWSServices.ReturnAllResultCodesWS</code>, which delegates to <code>ResultCodeServices.ReturnAllResultCodes</code> with <code>LoginInfo.ClientId</code> for client scoping.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCode</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3e34eb66-e351-4a51-a848-3b6ce4d06892","name":"GetAllResultCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ResultCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"PTP\",\n            \"Description\": \"Promise To Pay\",\n            \"CodeType\": 1,\n            \"Active\": true,\n            \"PromiseToPay\": true,\n            \"DefaultDays\": 7,\n            \"MaxDays\": 30,\n            \"ContactTypeId\": null,\n            \"CloseSchedFUP\": false,\n            \"SchedFUP\": true,\n            \"TemplateId\": null,\n            \"AddRemarkCodeId\": \"00000000-0000-0000-0000-000000000000\",\n            \"AddRemarkCode2Id\": null,\n            \"AddRemarkCode3Id\": null,\n            \"AddRemarkCode4Id\": null,\n            \"AddRemarkCode5Id\": null,\n            \"RemoveRemarkCodeId\": null,\n            \"RemoveRemarkCode2Id\": null,\n            \"RemoveRemarkCode3Id\": null,\n            \"RemoveRemarkCode4Id\": null,\n            \"RemoveRemarkCode5Id\": null,\n            \"PaymentRequired\": true,\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ]\n}"},{"id":"3413befc-836b-4d7a-98dd-0897ec92755b","name":"GetAllResultCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/Client/Common/ResultCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving result codes: Authentication failed\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"eced7394-28a9-4e4c-af75-5265d9e18767"},{"name":"ResultCodeUpdate","id":"d2b10066-f33b-4051-9176-972860457004","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"PTP\",\n  \"description\": \"Promise To Pay - Updated\",\n  \"codeType\": 1,\n  \"active\": true,\n  \"promiseToPay\": true,\n  \"defaultDays\": 10,\n  \"maxDays\": 30,\n  \"contactTypeId\": null,\n  \"closeSchedFUP\": false,\n  \"schedFUP\": true,\n  \"templateId\": null,\n  \"addRemarkCode\": \"VIP\",\n  \"removeRemarkCode\": null,\n  \"paymentRequired\": true,\n  \"contactTypeCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCode/{{result_code_or_id}}","description":"<h3 id=\"update-result-code\">Update Result Code</h3>\n<p>Updates an existing <code>Common.ResultCode</code> row resolved from the <code>{codeOrId}</code> path segment. The controller (<code>ResultCodeController.UpdateResultCode</code>) remaps the inbound <code>UpdateResultCodeParameter</code> to an <code>AddSaveResultCodeParameter</code> with <code>isUpdate = true</code> and supplies <code>codeOrId</code> from the route — the request body does not carry it. The WS layer resolves the row via <code>SharedWSServices.GetCommonResultCodeId</code>, re-reads the current <code>Ts</code> server-side, resolves every supplied add/remove remark-code string through <code>SharedWSServices.GetCommonRemarkCodeId</code>, and commits via <code>UnitOfWork2</code>. Any unresolved remark-code string returns <code>400 Bad Request</code> before the update is attempted.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ResultCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the current result-code string or the row <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) result code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>codeType</em></td>\n<td>Required int. <code>CodeTypes</code> enum.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>promiseToPay</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>defaultDays</em> / <em>maxDays</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>contactTypeId</em></td>\n<td>Optional Guid. <code>Common.ResultCodeContactType</code> row.</td>\n</tr>\n<tr>\n<td><em>closeSchedFUP</em> / <em>schedFUP</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>templateId</em></td>\n<td>Optional Guid. Associated template.</td>\n</tr>\n<tr>\n<td><em>addRemarkCode</em>, <em>addRemarkCode2_–_addRemarkCode5</em></td>\n<td>Optional strings. Remark codes or Guid. Resolved server-side.</td>\n</tr>\n<tr>\n<td><em>removeRemarkCode</em>, <em>removeRemarkCode2_–_removeRemarkCode5</em></td>\n<td>Optional strings. Remark codes or Guid. Resolved server-side.</td>\n</tr>\n<tr>\n<td><em>paymentRequired</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>contactTypeCodeOrId</code></td>\n<td><code>contactTypeId</code></td>\n<td>String. contact-type code or contact-type GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"contactTypeCodeOrId\": \"PHONE\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","ResultCode","{{result_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4e96bef9-f12a-4728-8a86-5a99b5b1ebab","name":"UpdateResultCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"PTP\",\n  \"description\": \"Promise To Pay - Updated\",\n  \"codeType\": 1,\n  \"active\": true,\n  \"promiseToPay\": true,\n  \"defaultDays\": 10,\n  \"maxDays\": 30,\n  \"contactTypeId\": null,\n  \"closeSchedFUP\": false,\n  \"schedFUP\": true,\n  \"templateId\": null,\n  \"addRemarkCode\": \"VIP\",\n  \"removeRemarkCode\": null,\n  \"paymentRequired\": true,\n  \"contactTypeCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCode/{{code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"f892fe50-995a-42d8-88b2-74dde4f52377","name":"UpdateResultCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"PTP\",\n  \"description\": \"Promise To Pay - Updated\",\n  \"codeType\": 1,\n  \"active\": true,\n  \"promiseToPay\": true,\n  \"defaultDays\": 10,\n  \"maxDays\": 30,\n  \"contactTypeId\": null,\n  \"closeSchedFUP\": false,\n  \"schedFUP\": true,\n  \"templateId\": null,\n  \"addRemarkCode\": \"DOESNOTEXIST\",\n  \"removeRemarkCode\": null,\n  \"paymentRequired\": true,\n  \"contactTypeCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ResultCode/{{result_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Add remark code 'DOESNOTEXIST' not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d2b10066-f33b-4051-9176-972860457004"},{"name":"RunMassOptIn","id":"c377bc41-938e-427d-a630-d2961b2724a5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrIds\": null,\n    \"accountNumberOrIds\": null,\n    \"customerNumberOrIds\": null,\n    \"folderId\": \"00000000-0000-0000-0000-0000000000B1\",\n    \"format\": \"PDF\",\n    \"notificationEmail\": \"developer@example.com\",\n    \"description\": \"April SMS opt-in invitation\",\n    \"includePrimary\": true,\n    \"includeSpouse\": false,\n    \"includeCoBorrowers\": false,\n    \"reportOnly\": false,\n    \"activeOnly\": true,\n    \"includeActiveStatus\": true,\n    \"includeClosedStatus\": false,\n    \"includeChargeOffStatus\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MassCommunication/OptIn","description":"<h3 id=\"run-mass-opt-in-async-batch\">Run Mass Opt-In (Async Batch)</h3>\n<p>Queues a mass SMS opt-in invitation batch. Wraps <code>MassCommunicationWSServices.RunMassOptInWS</code>.</p>\n<p><strong>Async acceptance semantics:</strong> the request is validated synchronously, a background worker thread is dispatched to run the batch, and the response returns immediately. A 200 with a job/status payload only confirms the batch was accepted — completion is reported out-of-band via the optional <code>notificationEmail</code>. A <code>folderId</code> controls where any generated artifacts (preview reports, exception listings) are dropped. Clients should not treat the 200 response as proof that opt-in invitations have been delivered.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/MassCommunication/OptIn</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Population filters (all optional; omit to match everything):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrIds</em></td>\n<td>Optional string[]. Branch numbers or Guids.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrIds</em></td>\n<td>Optional string[]. Account numbers or Guids.</td>\n</tr>\n<tr>\n<td><em>customerNumberOrIds</em></td>\n<td>Optional string[]. Customer numbers or Guids.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Batch configuration:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. Document folder for batch artifacts.</td>\n</tr>\n<tr>\n<td><em>format</em></td>\n<td>Optional string. Output format requested for the batch artifact.</td>\n</tr>\n<tr>\n<td><em>notificationEmail</em></td>\n<td>Optional string. Email notified when the worker thread completes.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Free-text label persisted on the batch entry.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Recipient selection within each account:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>includePrimary</em></td>\n<td>Required boolean. Include the primary borrower.</td>\n</tr>\n<tr>\n<td><em>includeSpouse</em></td>\n<td>Required boolean. Include the spouse customer.</td>\n</tr>\n<tr>\n<td><em>includeCoBorrowers</em></td>\n<td>Required boolean. Include co-borrower customers.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Run mode and account-status filters:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>reportOnly</em></td>\n<td>Required boolean. <code>true</code> produces the preview report without sending invitations.</td>\n</tr>\n<tr>\n<td><em>activeOnly</em></td>\n<td>Required boolean. Restrict to active-status accounts.</td>\n</tr>\n<tr>\n<td><em>includeActiveStatus</em></td>\n<td>Required boolean. Include accounts in active admin status.</td>\n</tr>\n<tr>\n<td><em>includeClosedStatus</em></td>\n<td>Required boolean. Include closed accounts.</td>\n</tr>\n<tr>\n<td><em>includeChargeOffStatus</em></td>\n<td>Required boolean. Include charge-off accounts.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code> with <code>statusCode = \"Ok\"</code> once the batch is accepted; the worker runs asynchronously. Validation errors (missing required field, invalid enum value, no recipients selected) return HTTP 400 with the same envelope.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","MassCommunication","OptIn"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"97d14767-ee63-4840-916e-e1faf7d8869d","name":"RunMassOptIn - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrIds\": null,\n    \"accountNumberOrIds\": null,\n    \"customerNumberOrIds\": null,\n    \"folderId\": \"00000000-0000-0000-0000-0000000000B1\",\n    \"format\": \"PDF\",\n    \"notificationEmail\": \"developer@example.com\",\n    \"description\": \"April SMS opt-in invitation\",\n    \"includePrimary\": true,\n    \"includeSpouse\": false,\n    \"includeCoBorrowers\": false,\n    \"reportOnly\": false,\n    \"activeOnly\": true,\n    \"includeActiveStatus\": true,\n    \"includeClosedStatus\": false,\n    \"includeChargeOffStatus\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MassCommunication/OptIn"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"jobId\": \"00000000-0000-0000-0000-0000000000C2\",\n        \"status\": \"Accepted\"\n    }\n}"},{"id":"53be0493-e489-4e64-bb8b-9b403393833d","name":"RunMassOptIn - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrIds\": null,\n    \"accountNumberOrIds\": null,\n    \"customerNumberOrIds\": null,\n    \"folderId\": \"00000000-0000-0000-0000-000000000000\",\n    \"format\": \"PDF\",\n    \"notificationEmail\": \"developer@example.com\",\n    \"description\": \"April SMS opt-in invitation\",\n    \"includePrimary\": true,\n    \"includeSpouse\": false,\n    \"includeCoBorrowers\": false,\n    \"reportOnly\": false,\n    \"activeOnly\": true,\n    \"includeActiveStatus\": true,\n    \"includeClosedStatus\": false,\n    \"includeChargeOffStatus\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MassCommunication/OptIn"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"folderId is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c377bc41-938e-427d-a630-d2961b2724a5"},{"name":"RunMassTextMessage","id":"9ea3fba8-1447-4642-b7c5-4658f18b8065","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrIds\": null,\n    \"accountNumberOrIds\": null,\n    \"customerNumberOrIds\": null,\n    \"folderId\": \"00000000-0000-0000-0000-0000000000B1\",\n    \"format\": \"PDF\",\n    \"notificationEmail\": \"developer@example.com\",\n    \"description\": \"April past-due reminder\",\n    \"mergeFormId\": \"00000000-0000-0000-0000-0000000000B2\",\n    \"includePrimary\": true,\n    \"includeSpouse\": false,\n    \"includeCoBorrowers\": false,\n    \"billingLateType\": 1,\n    \"billingDays\": 5,\n    \"includeFutureBilling\": false,\n    \"lateDays\": 5,\n    \"textThreadOptInType\": 1,\n    \"reportOnly\": false,\n    \"excludePendingPromiseToPay\": true,\n    \"excludeActiveScheduledFollowUp\": false,\n    \"activeOnly\": true,\n    \"includeActiveStatus\": true,\n    \"includeClosedStatus\": false,\n    \"includeChargeOffStatus\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MassCommunication/TextMessage","description":"<h3 id=\"run-mass-text-message-async-batch\">Run Mass Text Message (Async Batch)</h3>\n<p>Queues a mass text-message batch. Wraps <code>MassCommunicationWSServices.RunMassTextMessageWS</code>.</p>\n<p><strong>Async acceptance semantics:</strong> the request is validated synchronously, a background worker thread is dispatched to run the batch, and the response returns immediately. A 200 with a job/status payload only confirms the batch was accepted — completion is reported out-of-band via the optional <code>notificationEmail</code>. A <code>folderId</code> controls where any generated artifacts (preview reports, exception listings) are dropped. Clients should not treat the 200 response as proof that messages have been delivered.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/MassCommunication/TextMessage</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Population filters (all optional; omit to match everything):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrIds</em></td>\n<td>Optional string[]. Branch numbers or Guids; resolved per entry.</td>\n</tr>\n<tr>\n<td><em>accountNumberOrIds</em></td>\n<td>Optional string[]. Account numbers or Guids; resolved per entry.</td>\n</tr>\n<tr>\n<td><em>customerNumberOrIds</em></td>\n<td>Optional string[]. Customer numbers or Guids; resolved per entry.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Batch configuration:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. Document folder for batch artifacts (preview report, exception listing).</td>\n</tr>\n<tr>\n<td><em>format</em></td>\n<td>Optional string. Output format requested for the batch artifact.</td>\n</tr>\n<tr>\n<td><em>notificationEmail</em></td>\n<td>Optional string. Email notified when the worker thread completes.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Free-text label persisted on the batch entry.</td>\n</tr>\n<tr>\n<td><em>mergeFormId</em></td>\n<td>Optional Guid. Merge form / template id used to build the message body.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Recipient selection within each account:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>includePrimary</em></td>\n<td>Required boolean. Include the primary borrower.</td>\n</tr>\n<tr>\n<td><em>includeSpouse</em></td>\n<td>Required boolean. Include the spouse customer.</td>\n</tr>\n<tr>\n<td><em>includeCoBorrowers</em></td>\n<td>Required boolean. Include co-borrower customers.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Delinquency / billing window:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>billingLateType</em></td>\n<td>Required int. <code>Omega.Common.Types.BillingLateTypes</code> enum (off / due / late / etc.).</td>\n</tr>\n<tr>\n<td><em>billingDays</em></td>\n<td>Required int. Days offset for the billing-late filter.</td>\n</tr>\n<tr>\n<td><em>includeFutureBilling</em></td>\n<td>Required boolean. Include accounts with billing in the future.</td>\n</tr>\n<tr>\n<td><em>lateDays</em></td>\n<td>Required int. Minimum days late for inclusion.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Text-thread opt-in / pending logic:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>textThreadOptInType</em></td>\n<td>Required int. <code>Omega.Common.Types.TextThreadOptInTypes</code> enum (any / opted-in only / not-yet-asked / etc.).</td>\n</tr>\n<tr>\n<td><em>reportOnly</em></td>\n<td>Required boolean. <code>true</code> produces the preview report without sending messages.</td>\n</tr>\n<tr>\n<td><em>excludePendingPromiseToPay</em></td>\n<td>Required boolean. Skip accounts with an open promise-to-pay.</td>\n</tr>\n<tr>\n<td><em>excludeActiveScheduledFollowUp</em></td>\n<td>Optional boolean. Skip accounts that have any incomplete Scheduled Follow-Up task, regardless of due date. Defaults to false.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Account status filters:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>activeOnly</em></td>\n<td>Required boolean. Restrict to active-status accounts.</td>\n</tr>\n<tr>\n<td><em>includeActiveStatus</em></td>\n<td>Required boolean. Include accounts in active admin status.</td>\n</tr>\n<tr>\n<td><em>includeClosedStatus</em></td>\n<td>Required boolean. Include closed accounts.</td>\n</tr>\n<tr>\n<td><em>includeChargeOffStatus</em></td>\n<td>Required boolean. Include charge-off accounts.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code> with <code>statusCode = \"Ok\"</code> once the batch is accepted; the worker runs asynchronously. Validation errors (missing required field, invalid enum value, no recipients selected) return HTTP 400 with the same envelope.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","MassCommunication","TextMessage"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"024c3692-8aeb-44e0-bd8a-b25815a8019d","name":"RunMassTextMessage - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrIds\": null,\n    \"accountNumberOrIds\": null,\n    \"customerNumberOrIds\": null,\n    \"folderId\": \"00000000-0000-0000-0000-0000000000B1\",\n    \"format\": \"PDF\",\n    \"notificationEmail\": \"developer@example.com\",\n    \"description\": \"April past-due reminder\",\n    \"mergeFormId\": \"00000000-0000-0000-0000-0000000000B2\",\n    \"includePrimary\": true,\n    \"includeSpouse\": false,\n    \"includeCoBorrowers\": false,\n    \"billingLateType\": 1,\n    \"billingDays\": 5,\n    \"includeFutureBilling\": false,\n    \"lateDays\": 5,\n    \"textThreadOptInType\": 1,\n    \"reportOnly\": false,\n    \"excludePendingPromiseToPay\": true,\n    \"excludeActiveScheduledFollowUp\": false,\n    \"activeOnly\": true,\n    \"includeActiveStatus\": true,\n    \"includeClosedStatus\": false,\n    \"includeChargeOffStatus\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MassCommunication/TextMessage"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"jobId\": \"00000000-0000-0000-0000-0000000000C1\",\n        \"status\": \"Accepted\"\n    }\n}"},{"id":"313082e3-36ac-4213-97f5-3144300a7226","name":"RunMassTextMessage - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrIds\": null,\n    \"accountNumberOrIds\": null,\n    \"customerNumberOrIds\": null,\n    \"folderId\": \"00000000-0000-0000-0000-0000000000B1\",\n    \"format\": \"PDF\",\n    \"notificationEmail\": \"developer@example.com\",\n    \"description\": \"April past-due reminder\",\n    \"mergeFormId\": \"00000000-0000-0000-0000-0000000000B2\",\n    \"includePrimary\": false,\n    \"includeSpouse\": false,\n    \"includeCoBorrowers\": false,\n    \"billingLateType\": 1,\n    \"billingDays\": 5,\n    \"includeFutureBilling\": false,\n    \"lateDays\": 5,\n    \"textThreadOptInType\": 1,\n    \"reportOnly\": false,\n    \"excludePendingPromiseToPay\": true,\n    \"excludeActiveScheduledFollowUp\": false,\n    \"activeOnly\": true,\n    \"includeActiveStatus\": true,\n    \"includeClosedStatus\": false,\n    \"includeChargeOffStatus\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/MassCommunication/TextMessage"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"At least one of includePrimary, includeSpouse, or includeCoBorrowers must be true\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"9ea3fba8-1447-4642-b7c5-4658f18b8065"},{"name":"SourceCodeAdd","id":"1fbf8c08-db7c-4fc9-b836-3caf5a5d24c1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"WEB\",\n    \"description\": \"Web Application\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/SourceCode","description":"<h3 id=\"add-source-code\">Add Source Code</h3>\n<p>Creates a new <code>Common.SourceCode</code> row for the caller's client. The controller (<code>SourceCodeController.AddSourceCode</code>) remaps the inbound <code>AddSourceCodeParameter</code> into an <code>AddSaveSourceCodeParameter</code> with <code>id = null</code> and <code>ts = null</code>, so <code>SourceCodeWSServices.AddSaveSourceCodeWS</code> treats the call as an insert. A duplicate <code>code</code> (per client) returns <code>400 Bad Request</code> via <code>SourceCodeServices.ReturnSourceCodeEntityByCode</code>. On success a new Guid is generated, the row is committed via <code>UnitOfWork2</code>, and the new <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/SourceCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Source code. Must be unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required boolean. Controls whether the source code is selectable.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","SourceCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"11f8408a-a495-45ae-b1d5-456fe689be0e","name":"AddSourceCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"WEB\",\n    \"description\": \"Web Application\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/SourceCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"cb47f5dc-9f9a-4af2-a986-dccf3214ded4","name":"AddSourceCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"WEB\",\n    \"description\": \"Web Application\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/SourceCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Source code with code 'WEB' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"1fbf8c08-db7c-4fc9-b836-3caf5a5d24c1"},{"name":"SourceCodeGet","id":"71c6be6b-41d7-45e0-a82c-e58c4a59d219","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/SourceCode/{{source_code_or_id}}","description":"<h3 id=\"get-source-code\">Get Source Code</h3>\n<p>Returns a single <code>Common.SourceCode</code> row resolved from the <code>{codeOrId}</code> path segment. The WS layer (<code>SourceCodeWSServices.ReturnSourceCodeWS</code>) attempts <code>Guid.TryParse</code> first and calls <code>SourceCodeServices.ReturnSourceCodeEntity(databaseName, id)</code>; on failure it falls back to <code>SourceCodeServices.ReturnSourceCodeEntityByCode(databaseName, code, clientId)</code> for the client-scoped code lookup. Returns <code>400 Bad Request</code> when the segment is empty or the row cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/SourceCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the source-code string or the row <code>Id</code> Guid. Resolution is Guid-first, then code string (client-scoped).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","SourceCode","{{source_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"971b9a9d-13f0-4469-8dc9-42f947dc9714","name":"GetSourceCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/SourceCode/WEB"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Code\": \"WEB\",\n        \"Description\": \"Web Application\",\n        \"IsAvailable\": true,\n        \"Ts\": \"AAAAAAAAB9U=\"\n    }\n}"},{"id":"3927ea99-26bb-42d5-8942-717401f75245","name":"GetSourceCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/SourceCode/DOESNOTEXIST"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Source code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"71c6be6b-41d7-45e0-a82c-e58c4a59d219"},{"name":"SourceCodesGetAll","id":"84d0a62e-819f-4740-8f9f-6046b800b02a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/SourceCode","description":"<h3 id=\"get-all-source-codes\">Get All Source Codes</h3>\n<p>Returns all <code>Common.SourceCode</code> rows for the caller's client. The controller (<code>SourceCodeController.GetSourceCode</code>) shares its route template with the single-row GET — when the optional <code>{codeOrId}</code> segment is omitted, the controller calls <code>SourceCodeWSServices.ReturnAllSourceCodesWS</code>, which delegates to <code>SourceCodeServices.ReturnAllSourceCodes</code> with <code>LoginInfo.ClientId</code> for client scoping.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/SourceCode</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","SourceCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f15dbdf3-d76b-4c83-9fd0-9938f624ba78","name":"GetAllSourceCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/SourceCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"WEB\",\n            \"Description\": \"Web Application\",\n            \"IsAvailable\": true,\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ]\n}"},{"id":"9a12889a-fa01-448e-b28c-7c3406fe1ae1","name":"GetAllSourceCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/SourceCode"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"84d0a62e-819f-4740-8f9f-6046b800b02a"},{"name":"SourceCodeUpdate","id":"fa4f7611-7c1b-4cd4-a0a6-ffe361582ea2","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"WEB\",\n    \"description\": \"Web Application - Updated\",\n    \"isAvailable\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/SourceCode/{{source_code_or_id}}","description":"<h3 id=\"update-source-code\">Update Source Code</h3>\n<p>Updates an existing <code>Common.SourceCode</code> row resolved from the <code>{codeOrId}</code> path segment. The controller (<code>SourceCodeController.UpdateSourceCode</code>) resolves the row via <code>SharedWSServices.GetCommonSourceCodeId</code>, re-reads the current <code>Ts</code> server-side via <code>SourceCodeServices.ReturnSourceCodeEntity</code>, and remaps the inbound <code>UpdateSourceCodeParameter</code> into an <code>AddSaveSourceCodeParameter</code> carrying the resolved <code>id</code> and existing <code>ts</code>. <code>SourceCodeWSServices.AddSaveSourceCodeWS</code> detects update mode from the non-null timestamp and commits via <code>UnitOfWork2</code>. Unresolved <code>{codeOrId}</code> returns <code>400 Bad Request</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/SourceCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the current source-code string or the row <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) source code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required boolean.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","SourceCode","{{source_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5ca2a4a3-fe64-4dc8-8d25-efeec1eb6774","name":"UpdateSourceCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"WEB\",\n    \"description\": \"Web Application - Updated\",\n    \"isAvailable\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/SourceCode/WEB"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"b442bbfd-4571-4105-bcce-5ad46ee29ddd","name":"UpdateSourceCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"INVALID_CODE\",\n    \"description\": \"Web Application - Updated\",\n    \"isAvailable\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/SourceCode/INVALID_CODE"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Source code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"fa4f7611-7c1b-4cd4-a0a6-ffe361582ea2"},{"name":"TaskCreate","id":"30b45063-d700-4b60-af78-08d13adc64c2","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"token\": \"{{token}}\",\r\n\t\"login_name\": \"{{login_name}}\",\r\n\t\"role_name\": \"{{role_name}}\",\r\n\t\"template_number_or_name\": \"{{template_number_or_name}}\",\r\n\t\"due_date\":\"{{due_date}}\",\r\n\t\"account_number\": \"{{account_number}}\",\r\n\t\"vendor_name\": \"{{vendor_name}}\",\r\n\t\"voucher_number\":\"{{voucher_number}}\",\r\n    \"notes\":\"{{notes}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/common/CreateTask","description":"<p>Creates a task from a task template and assigns it to a user or a role. The task must be assigned to either <code>login_name</code> or <code>role_name</code>. Depending on what the template targets, supply the matching parent identifier (<code>account_number</code>, <code>vendor_name</code>, or <code>voucher_number</code>).</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Session id, token, or API key accepted by the Login method.</td>\n</tr>\n<tr>\n<td><em>login_name</em></td>\n<td>Required unless <code>role_name</code> is supplied. User login the task is assigned to.</td>\n</tr>\n<tr>\n<td><em>role_name</em></td>\n<td>Required unless <code>login_name</code> is supplied. Role the task is assigned to.</td>\n</tr>\n<tr>\n<td><em>template_number_or_name</em></td>\n<td>Required string. Task template number or name to create the task from.</td>\n</tr>\n<tr>\n<td><em>due_date</em></td>\n<td>Required date (ISO-8601, e.g. <code>2024-01-28T00:00:00Z</code>). Date the task is due.</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Optional int64. Required when the template targets an account.</td>\n</tr>\n<tr>\n<td><em>vendor_name</em></td>\n<td>Optional string. Required when the template targets a vendor.</td>\n</tr>\n<tr>\n<td><em>voucher_number</em></td>\n<td>Optional integer. Required when the template targets a voucher.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-text notes added to the created task.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","common","CreateTask"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2b30a72d-79c3-406b-8218-c9f688e11631","name":"New Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"template_number_or_name\": \"3\",\r\n    \"login_name\": \"{{user_name}}\",\r\n    \"due_date\": \"2024-10-01T13:45:00\",\r\n    \"account_number\": \"{{account_number}}\",\r\n    \"notes\": \"task api test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/common/CreateTask"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 27 Sep 2024 23:05:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"69"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"X-StackifyID","value":"V2|9b9ed1aa-3c39-49fe-82c6-1c0befb15e25|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"\",\n    \"errors\": []\n}"},{"id":"ce75112c-7231-4819-b909-9db16f760cf7","name":"CreateTask - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"template_number_or_name\": \"999999\",\r\n    \"login_name\": \"{{user_name}}\",\r\n    \"due_date\": \"2024-10-01T13:45:00\",\r\n    \"account_number\": \"{{account_number}}\",\r\n    \"notes\": \"task api test\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/common/CreateTask"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": \"\",\n    \"errors\": [\n        \"Task Template was not found\"\n    ]\n}"}],"_postman_id":"30b45063-d700-4b60-af78-08d13adc64c2"},{"name":"TaskTemplateAdd","id":"c04a1b3a-7433-41a9-9929-724bde77ce0c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"sendEmail\": false,\n    \"description\": \"Call Customer\",\n    \"screen\": 0,\n    \"autoCloseTask\": false,\n    \"defaultDueDaysInFuture\": 3,\n    \"maxDueDaysInFuture\": 14,\n    \"instructions\": \"Contact customer about overdue account.\",\n    \"customScreenId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TaskTemplate","description":"<h3 id=\"add-task-template\">Add Task Template</h3>\n<p>Creates a new <code>Common.TaskTemplate</code> row for the caller's client. The controller (<code>TaskTemplateController.AddTaskTemplate</code>) remaps the inbound <code>AddTaskTemplateParameter</code> into an <code>AddSaveTaskTemplateParameter</code> with <code>id = null</code> and <code>ts = null</code>, so <code>TaskTemplateWSServices.AddSaveTaskTemplateWS</code> treats the call as an insert. The WS layer auto-generates the next client-scoped <code>Number</code>, commits via <code>UnitOfWork2</code>, and returns the new row <code>Id</code> in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TaskTemplate</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>sendEmail</em></td>\n<td>Required boolean. Sends an email to the assigned contact when the task is created.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Task template description.</td>\n</tr>\n<tr>\n<td><em>screen</em></td>\n<td>Required int. <code>Screen</code> enum identifying where the template applies.</td>\n</tr>\n<tr>\n<td><em>autoCloseTask</em></td>\n<td>Required boolean. Auto-closes tasks created from this template when the triggering event completes.</td>\n</tr>\n<tr>\n<td><em>defaultDueDaysInFuture</em></td>\n<td>Required int. Default number of days in the future for the task due date.</td>\n</tr>\n<tr>\n<td><em>maxDueDaysInFuture</em></td>\n<td>Required int. Maximum allowed days in the future.</td>\n</tr>\n<tr>\n<td><em>instructions</em></td>\n<td>Optional string. Free-form task instructions.</td>\n</tr>\n<tr>\n<td><em>customScreenId</em></td>\n<td>Optional Guid. <code>Global.CustomScreen</code> row for a custom form linked to the task.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TaskTemplate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"83404f96-a949-45e1-979d-afd575b69312","name":"AddTaskTemplate - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"sendEmail\": false,\n    \"description\": \"Call Customer\",\n    \"screen\": 0,\n    \"autoCloseTask\": false,\n    \"defaultDueDaysInFuture\": 3,\n    \"maxDueDaysInFuture\": 14,\n    \"instructions\": \"Contact customer about overdue account.\",\n    \"customScreenId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TaskTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"2821012a-4330-4224-9010-57f1b8d28d07","name":"AddTaskTemplate - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"sendEmail\": false,\n    \"description\": \"\",\n    \"screen\": 0,\n    \"autoCloseTask\": false,\n    \"defaultDueDaysInFuture\": 3,\n    \"maxDueDaysInFuture\": 14,\n    \"instructions\": \"Contact customer about overdue account.\",\n    \"customScreenId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TaskTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Required Field Error: description\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c04a1b3a-7433-41a9-9929-724bde77ce0c"},{"name":"TaskTemplateGet","id":"ff36915c-2992-4ec7-83f0-166875a24bc2","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TaskTemplate/{{number_or_id}}","description":"<h3 id=\"get-task-template\">Get Task Template</h3>\n<p>Returns a single <code>Common.TaskTemplate</code> row resolved from the <code>{numberOrId}</code> path segment. The controller (<code>TaskTemplateController.GetTaskTemplate</code>) resolves the row via <code>SharedWSServices.GetCommonTaskTemplateId</code>, which attempts <code>Guid.TryParse</code> first, then falls back to a client-scoped number lookup. Returns <code>400 Bad Request</code> when the segment is empty or the row cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TaskTemplate/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required. Either the task template <code>Number</code> or the row <code>Id</code> Guid. Resolution is Guid-first, then number (client-scoped).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TaskTemplate","{{number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"52a65b93-46dc-441f-a1d6-1817e8e1d11e","name":"GetTaskTemplate - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TaskTemplate/1"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Number\": 1,\n        \"Active\": true,\n        \"SendEmail\": false,\n        \"Description\": \"Call Customer\",\n        \"Screen\": 0,\n        \"AutoCloseTask\": false,\n        \"DefaultDueDaysInFuture\": 3,\n        \"MaxDueDaysInFuture\": 14,\n        \"Instructions\": \"Contact customer about overdue account.\",\n        \"CustomScreenId\": null,\n        \"Ts\": \"AAAAAAAAB9U=\"\n    }\n}"},{"id":"da5a260e-4f5c-4129-ba31-3c964f73b062","name":"GetTaskTemplate - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TaskTemplate/999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Task template not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"ff36915c-2992-4ec7-83f0-166875a24bc2"},{"name":"TaskTemplatesGetAll","id":"c5de3a9a-5b14-4f2d-b311-84574605eb3a","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TaskTemplate","description":"<h3 id=\"get-all-task-templates\">Get All Task Templates</h3>\n<p>Returns all <code>Common.TaskTemplate</code> rows for the caller's client. The controller (<code>TaskTemplateController.GetAllTaskTemplates</code>) calls <code>TaskTemplateWSServices.ReturnAllTaskTemplatesWS</code>, which delegates to <code>TaskTemplateServices.ReturnAllTaskTemplates</code> with <code>LoginInfo.ClientId</code> for client scoping.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TaskTemplate</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TaskTemplate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b0e76100-e1a7-402a-8bb5-bc83c9f6edbc","name":"GetAllTaskTemplates - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TaskTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Number\": 1,\n            \"Active\": true,\n            \"SendEmail\": false,\n            \"Description\": \"Call Customer\",\n            \"Screen\": 0,\n            \"AutoCloseTask\": false,\n            \"DefaultDueDaysInFuture\": 3,\n            \"MaxDueDaysInFuture\": 14,\n            \"Instructions\": \"Contact customer about overdue account.\",\n            \"CustomScreenId\": null,\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ]\n}"},{"id":"3634117e-d05e-4e9e-bb81-1478f968910d","name":"GetAllTaskTemplates - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TaskTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving task templates: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c5de3a9a-5b14-4f2d-b311-84574605eb3a"},{"name":"TaskTemplateUpdate","id":"dfb37059-f3ec-44f6-b877-33dbeff16cff","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"sendEmail\": true,\n    \"description\": \"Call Customer - Urgent\",\n    \"screen\": 0,\n    \"autoCloseTask\": false,\n    \"defaultDueDaysInFuture\": 1,\n    \"maxDueDaysInFuture\": 7,\n    \"instructions\": \"Contact customer immediately regarding overdue balance.\",\n    \"customScreenId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TaskTemplate/{{number_or_id}}","description":"<h3 id=\"update-task-template\">Update Task Template</h3>\n<p>Updates an existing <code>Common.TaskTemplate</code> row resolved from the <code>{numberOrId}</code> path segment. The controller (<code>TaskTemplateController.UpdateTaskTemplate</code>) resolves the row via <code>SharedWSServices.GetCommonTaskTemplateId</code>, re-reads the current <code>Ts</code> server-side via <code>TaskTemplateServices.ReturnTaskTemplate</code>, and remaps the inbound <code>UpdateTaskTemplateParameter</code> into an <code>AddSaveTaskTemplateParameter</code> carrying the resolved <code>id</code> and existing <code>ts</code>. <code>TaskTemplateWSServices.AddSaveTaskTemplateWS</code> detects update mode from the non-null timestamp and commits via <code>UnitOfWork2</code>. Unresolved <code>{numberOrId}</code> returns <code>400 Bad Request</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TaskTemplate/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required. Either the current task template <code>Number</code> or the row <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>sendEmail</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>screen</em></td>\n<td>Required int. <code>Screen</code> enum.</td>\n</tr>\n<tr>\n<td><em>autoCloseTask</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>defaultDueDaysInFuture</em></td>\n<td>Required int.</td>\n</tr>\n<tr>\n<td><em>maxDueDaysInFuture</em></td>\n<td>Required int.</td>\n</tr>\n<tr>\n<td><em>instructions</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>customScreenId</em></td>\n<td>Optional Guid. <code>Global.CustomScreen</code> row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TaskTemplate","{{number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5ece46b0-e89f-453c-ad74-d859b4c4e59c","name":"UpdateTaskTemplate - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"sendEmail\": true,\n    \"description\": \"Call Customer - Urgent\",\n    \"screen\": 0,\n    \"autoCloseTask\": false,\n    \"defaultDueDaysInFuture\": 1,\n    \"maxDueDaysInFuture\": 7,\n    \"instructions\": \"Contact customer immediately regarding overdue balance.\",\n    \"customScreenId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TaskTemplate/1"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"21e6bde6-ecb9-4d7b-9a7e-f9b8f0f2bb99","name":"UpdateTaskTemplate - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"active\": true,\n    \"sendEmail\": true,\n    \"description\": \"Call Customer - Urgent\",\n    \"screen\": 0,\n    \"autoCloseTask\": false,\n    \"defaultDueDaysInFuture\": 1,\n    \"maxDueDaysInFuture\": 7,\n    \"instructions\": \"Contact customer immediately regarding overdue balance.\",\n    \"customScreenId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TaskTemplate/999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Task template not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"dfb37059-f3ec-44f6-b877-33dbeff16cff"},{"name":"ThirdPartyConfiguration","id":"94f1371f-6a5b-4502-b871-dd51f58cd74f","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"experianActiveStatus\": true,\n    \"equifaxActiveStatus\": false,\n    \"transunionActiveStatus\": false,\n    \"blackBookActive\": true,\n    \"blackBookLogin\": \"client_login\",\n    \"blackBookPassword\": \"client_password\",\n    \"blueBookActive\": false,\n    \"blueBookLogin\": null,\n    \"blueBookPassword\": null,\n    \"vehicleAccessories\": true,\n    \"vehicleCondition\": 1,\n    \"faxingActive\": false,\n    \"outgoingEMailRequest\": true,\n    \"solutionsByTextActive\": false,\n    \"solutionsByTextAPIKey\": null,\n    \"solutionsByTextClientOrgCode\": null,\n    \"solutionsByTextDivOrgCode\": null,\n    \"solutionsByTextGroupOrgCode\": null,\n    \"sbtLastOptOutRetrieval\": null,\n    \"solutionsByTextAutoOptIn\": false,\n    \"acceptablePaymentType\": 1,\n    \"pvLogin\": null,\n    \"pvPassword\": null,\n    \"pvAPIKey\": null,\n    \"pvToken\": null,\n    \"pvPaymentRetrievalStartDate\": null,\n    \"sendPaymentVisionPaymentReversal\": false,\n    \"payNearMeSiteIdentifier\": null,\n    \"payNearMeSignatureKey\": null,\n    \"sendPayNearMeReversal\": false,\n    \"pnmAPIVersion\": 2,\n    \"expiTransUserName\": null,\n    \"expiTransTranKey\": null,\n    \"expiTransSbUserName\": null,\n    \"expiTransSbTranKey\": null,\n    \"expiTransProductionUrl\": null,\n    \"expiTransSandboxUrl\": null,\n    \"sendExpiTransPaymentReversal\": false,\n    \"goldStarLogin\": null,\n    \"goldStarPassword\": null,\n    \"allisonClientNumber\": null,\n    \"allisonServiceSequence\": null,\n    \"dealerTrackActive\": true,\n    \"dealerTrackLienHolderID\": \"LH1234\",\n    \"dealerTrackSentTitleStatusCodeOrId\": \"DTSENT\",\n    \"dealerTrackPaperReceivedTitleStatusCodeOrId\": \"DTPAPER\",\n    \"dealerTrackElectronicReceivedTitleStatusCodeOrId\": \"DTELEC\",\n    \"dealerTrackApplicationActive\": false,\n    \"dealerTrackLenderId\": null,\n    \"dealerTrackUser\": null,\n    \"dealerTrackPassWord\": null,\n    \"dealerTrackAckUrl\": null,\n    \"dealerTrackDecUrl\": null,\n    \"sbDealerTrackUser\": null,\n    \"sbDealerTrackPassWord\": null,\n    \"sbDealerTrackAckUrl\": null,\n    \"sbDealerTrackDecUrl\": null,\n    \"passTimeDealerNumber\": null,\n    \"recurringACHFailureOption\": 1,\n    \"oneTimeACHFailureOption\": 1,\n    \"docuSignIntergrationKey\": null,\n    \"docuSignSecretKey\": null,\n    \"docuSignAccessToken\": null,\n    \"outboundPaymentVendor\": 0,\n    \"eSignatureVendor\": 0,\n    \"enablePaymentAccountCreation\": false,\n    \"creditInquiryVendor\": 0,\n    \"creditInquiryDaysBeforeAdditionalPull\": 30,\n    \"vendorConfigurations\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration","description":"<h3 id=\"update-third-party-configuration\">Update Third Party Configuration</h3>\n<p>Inserts or updates the caller client's third-party/company configuration row (one per client). The controller resolves the three DealerTrack title-status <code>*CodeOrId</code> strings via <code>SharedWSServices.GetCollateralTitleStatusCodeId</code> (Guid-first, then code lookup), packs everything into <code>AddSaveThirdPartyConfigurationParameter</code>, and forwards to <code>ThirdPartyConfigurationWSServices.AddSaveThirdPartyConfigurationWS</code>. That helper calls <code>Omega.Common.BLL.ThirdPartyConfigurationServices.ReturnCompanyConfiguration</code> to load any existing row (to reuse its <code>Id</code>, <code>Ts</code>, and the DocuSign <code>DocuSignTokenType</code> / <code>DocuSignRefreshToken</code> / <code>DocuSignExpires</code> values — these three fields are never overwritten from the request) and then persists via <code>AddSaveCompanyConfiguration</code>. The request body does not carry <code>id</code> or <code>ts</code> — both are resolved server-side.</p>\n<p><strong>Server-side behavior:</strong></p>\n<ul>\n<li><p>DealerTrack title-status <code>*CodeOrId</code> values may be empty, a Guid, or a\nfriendly title-status code.</p>\n</li>\n<li><p>DocuSign token type, refresh token, and expiration stored on the existing\nrow are always preserved — only <code>docuSignIntergrationKey</code>,\n<code>docuSignSecretKey</code>, and <code>docuSignAccessToken</code> from the body are applied.</p>\n</li>\n<li><p><code>vendorConfigurations[]</code> is a child collection of <code>CommonVendorConfiguration</code>\nrows. Each entry with a non-null <code>id</code> + <code>ts</code> updates an existing row; a\nnull <code>id</code> inserts a new row. Use <code>display=false</code> to mark an entry as\nremoved (handled server-side via the standard UnitOfWork soft-delete\npattern).</p>\n</li>\n</ul>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Credit bureau switches:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>experianActiveStatus</em></td>\n<td>Required boolean. Enables Experian credit-bureau pulls.</td>\n</tr>\n<tr>\n<td><em>equifaxActiveStatus</em></td>\n<td>Required boolean. Enables Equifax credit-bureau pulls.</td>\n</tr>\n<tr>\n<td><em>transunionActiveStatus</em></td>\n<td>Required boolean. Enables TransUnion credit-bureau pulls.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Vehicle valuation:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>blackBookActive</em></td>\n<td>Required boolean. Enables Black Book valuation lookups.</td>\n</tr>\n<tr>\n<td><em>blackBookLogin</em></td>\n<td>Optional string. Black Book account login.</td>\n</tr>\n<tr>\n<td><em>blackBookPassword</em></td>\n<td>Optional string. Black Book account password.</td>\n</tr>\n<tr>\n<td><em>blueBookActive</em></td>\n<td>Required boolean. Enables Kelley Blue Book valuation lookups.</td>\n</tr>\n<tr>\n<td><em>blueBookLogin</em></td>\n<td>Optional string. Blue Book account login.</td>\n</tr>\n<tr>\n<td><em>blueBookPassword</em></td>\n<td>Optional string. Blue Book account password.</td>\n</tr>\n<tr>\n<td><em>vehicleAccessories</em></td>\n<td>Required boolean. Include vehicle accessories in valuation requests.</td>\n</tr>\n<tr>\n<td><em>vehicleCondition</em></td>\n<td>Required int. <code>Omega.Common.Types.VehicleConditions</code> enum used for valuation requests.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Communication settings:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>faxingActive</em></td>\n<td>Required boolean. Enables fax delivery for documents.</td>\n</tr>\n<tr>\n<td><em>outgoingEMailRequest</em></td>\n<td>Required boolean. Enables outbound email delivery.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Solutions By Text (SMS vendor):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>solutionsByTextActive</em></td>\n<td>Required boolean. Enables Solutions By Text SMS integration.</td>\n</tr>\n<tr>\n<td><em>solutionsByTextAPIKey</em></td>\n<td>Optional string. Solutions By Text API key.</td>\n</tr>\n<tr>\n<td><em>solutionsByTextClientOrgCode</em></td>\n<td>Optional string. Solutions By Text client-level org code.</td>\n</tr>\n<tr>\n<td><em>solutionsByTextDivOrgCode</em></td>\n<td>Optional string. Solutions By Text division-level org code.</td>\n</tr>\n<tr>\n<td><em>solutionsByTextGroupOrgCode</em></td>\n<td>Optional string. Solutions By Text group-level org code.</td>\n</tr>\n<tr>\n<td><em>sbtLastOptOutRetrieval</em></td>\n<td>Optional datetime. Last-successful opt-out retrieval cursor.</td>\n</tr>\n<tr>\n<td><em>solutionsByTextAutoOptIn</em></td>\n<td>Required boolean. Auto opt-in new customers to SMS.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Payments:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>acceptablePaymentType</em></td>\n<td>Optional int. <code>Omega.Common.Types.AcceptablePaymentTypes</code> enum (card / ACH / both).</td>\n</tr>\n<tr>\n<td><em>pvLogin</em></td>\n<td>Optional string. PaymentVision login.</td>\n</tr>\n<tr>\n<td><em>pvPassword</em></td>\n<td>Optional string. PaymentVision password.</td>\n</tr>\n<tr>\n<td><em>pvAPIKey</em></td>\n<td>Optional string. PaymentVision API key.</td>\n</tr>\n<tr>\n<td><em>pvToken</em></td>\n<td>Optional string. PaymentVision integration token.</td>\n</tr>\n<tr>\n<td><em>pvPaymentRetrievalStartDate</em></td>\n<td>Optional datetime. First date to pull PaymentVision payment history from.</td>\n</tr>\n<tr>\n<td><em>sendPaymentVisionPaymentReversal</em></td>\n<td>Required boolean. Send reversal notifications to PaymentVision.</td>\n</tr>\n<tr>\n<td><em>payNearMeSiteIdentifier</em></td>\n<td>Optional string. PayNearMe site identifier.</td>\n</tr>\n<tr>\n<td><em>payNearMeSignatureKey</em></td>\n<td>Optional string. PayNearMe signature key.</td>\n</tr>\n<tr>\n<td><em>sendPayNearMeReversal</em></td>\n<td>Required boolean. Send reversal notifications to PayNearMe.</td>\n</tr>\n<tr>\n<td><em>pnmAPIVersion</em></td>\n<td>Required int. PayNearMe API version selector.</td>\n</tr>\n<tr>\n<td><em>expiTransUserName</em></td>\n<td>Optional string. ExpiTrans production user name.</td>\n</tr>\n<tr>\n<td><em>expiTransTranKey</em></td>\n<td>Optional string. ExpiTrans production transaction key.</td>\n</tr>\n<tr>\n<td><em>expiTransSbUserName</em></td>\n<td>Optional string. ExpiTrans sandbox user name.</td>\n</tr>\n<tr>\n<td><em>expiTransSbTranKey</em></td>\n<td>Optional string. ExpiTrans sandbox transaction key.</td>\n</tr>\n<tr>\n<td><em>expiTransProductionUrl</em></td>\n<td>Optional string. ExpiTrans production endpoint URL.</td>\n</tr>\n<tr>\n<td><em>expiTransSandboxUrl</em></td>\n<td>Optional string. ExpiTrans sandbox endpoint URL.</td>\n</tr>\n<tr>\n<td><em>sendExpiTransPaymentReversal</em></td>\n<td>Required boolean. Send reversal notifications to ExpiTrans.</td>\n</tr>\n</tbody>\n</table>\n</div><p>GPS / starter-interrupt vendors:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>goldStarLogin</em></td>\n<td>Optional string. GoldStar GPS login.</td>\n</tr>\n<tr>\n<td><em>goldStarPassword</em></td>\n<td>Optional string. GoldStar GPS password.</td>\n</tr>\n<tr>\n<td><em>allisonClientNumber</em></td>\n<td>Optional string. Allison Legal client number.</td>\n</tr>\n<tr>\n<td><em>allisonServiceSequence</em></td>\n<td>Optional string. Allison Legal service sequence.</td>\n</tr>\n<tr>\n<td><em>passTimeDealerNumber</em></td>\n<td>Optional int. PassTime dealer number.</td>\n</tr>\n</tbody>\n</table>\n</div><p>DealerTrack (title and credit application routing):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>dealerTrackActive</em></td>\n<td>Required boolean. Enables DealerTrack title integration.</td>\n</tr>\n<tr>\n<td><em>dealerTrackLienHolderID</em></td>\n<td>Optional string. DealerTrack lienholder identifier.</td>\n</tr>\n<tr>\n<td><em>dealerTrackSentTitleStatusCodeOrId</em></td>\n<td>Optional. Title-status code or Guid assigned when DealerTrack returns \"sent\". Resolved via <code>SharedWSServices.GetCollateralTitleStatusCodeId</code>.</td>\n</tr>\n<tr>\n<td><em>dealerTrackPaperReceivedTitleStatusCodeOrId</em></td>\n<td>Optional. Title-status code or Guid assigned when DealerTrack reports a paper title was received.</td>\n</tr>\n<tr>\n<td><em>dealerTrackElectronicReceivedTitleStatusCodeOrId</em></td>\n<td>Optional. Title-status code or Guid assigned when DealerTrack reports an electronic title was received.</td>\n</tr>\n<tr>\n<td><em>dealerTrackApplicationActive</em></td>\n<td>Required boolean. Enables DealerTrack credit-application routing.</td>\n</tr>\n<tr>\n<td><em>dealerTrackLenderId</em></td>\n<td>Optional string. DealerTrack lender identifier for credit applications.</td>\n</tr>\n<tr>\n<td><em>dealerTrackUser</em></td>\n<td>Optional string. DealerTrack production user login.</td>\n</tr>\n<tr>\n<td><em>dealerTrackPassWord</em></td>\n<td>Optional string. DealerTrack production password.</td>\n</tr>\n<tr>\n<td><em>dealerTrackAckUrl</em></td>\n<td>Optional string. DealerTrack production ACK (accept) URL.</td>\n</tr>\n<tr>\n<td><em>dealerTrackDecUrl</em></td>\n<td>Optional string. DealerTrack production DEC (decline) URL.</td>\n</tr>\n<tr>\n<td><em>sbDealerTrackUser</em></td>\n<td>Optional string. DealerTrack sandbox user login.</td>\n</tr>\n<tr>\n<td><em>sbDealerTrackPassWord</em></td>\n<td>Optional string. DealerTrack sandbox password.</td>\n</tr>\n<tr>\n<td><em>sbDealerTrackAckUrl</em></td>\n<td>Optional string. DealerTrack sandbox ACK URL.</td>\n</tr>\n<tr>\n<td><em>sbDealerTrackDecUrl</em></td>\n<td>Optional string. DealerTrack sandbox DEC URL.</td>\n</tr>\n</tbody>\n</table>\n</div><p>ACH failure handling:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>recurringACHFailureOption</em></td>\n<td>Required int. <code>Omega.Common.Types.ACHFailureOptions</code> enum controlling recurring-ACH failure behavior.</td>\n</tr>\n<tr>\n<td><em>oneTimeACHFailureOption</em></td>\n<td>Required int. <code>Omega.Common.Types.ACHFailureOptions</code> enum controlling one-time-ACH failure behavior.</td>\n</tr>\n</tbody>\n</table>\n</div><p>DocuSign integration (tokens only — refresh token / expiration preserved server-side):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>docuSignIntergrationKey</em></td>\n<td>Optional string. DocuSign integration key.</td>\n</tr>\n<tr>\n<td><em>docuSignSecretKey</em></td>\n<td>Optional string. DocuSign secret key.</td>\n</tr>\n<tr>\n<td><em>docuSignAccessToken</em></td>\n<td>Optional string. DocuSign access token.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Vendor selector enums:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>outboundPaymentVendor</em></td>\n<td>Required int. <code>Omega.Common.Types.OutboundPaymentVendors</code> enum (e.g., none, ACHWorks, PaymentVision).</td>\n</tr>\n<tr>\n<td><em>eSignatureVendor</em></td>\n<td>Required int. <code>Omega.Common.Types.ESignatureVendors</code> enum (e.g., none, DocuSign).</td>\n</tr>\n<tr>\n<td><em>enablePaymentAccountCreation</em></td>\n<td>Required boolean. Allows customers to self-create payment accounts.</td>\n</tr>\n<tr>\n<td><em>creditInquiryVendor</em></td>\n<td>Required int. <code>Omega.Common.Types.CreditInquiryVendors</code> enum.</td>\n</tr>\n<tr>\n<td><em>creditInquiryDaysBeforeAdditionalPull</em></td>\n<td>Required int. Days between repeat credit pulls.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Child <code>vendorConfigurations[]</code> (CommonVendorConfiguration rows):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>display</em></td>\n<td>Required boolean. <code>false</code> marks the row for removal.</td>\n</tr>\n<tr>\n<td><em>id</em></td>\n<td>Optional Guid. Null to insert a new row; existing Guid to update.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional rowversion. Required with <code>id</code> when updating.</td>\n</tr>\n<tr>\n<td><em>vendorType</em></td>\n<td>Required int. <code>Omega.Common.Types.VendorTypes</code> enum identifying the integration.</td>\n</tr>\n<tr>\n<td><em>parentId</em></td>\n<td>Optional Guid. Parent vendor configuration when vendors are nested.</td>\n</tr>\n<tr>\n<td><em>userName</em>, <em>password</em>, <em>key</em>, <em>productionUrl</em></td>\n<td>Optional. Production credentials / endpoint.</td>\n</tr>\n<tr>\n<td><em>sandboxUserName</em>, <em>sandboxPassword</em>, <em>sandboxKey</em>, <em>sandboxUrl</em></td>\n<td>Optional. Sandbox credentials / endpoint.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ThirdPartyConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c18bf88f-3568-4bae-bfe8-8eace1bd41f2","name":"UpdateThirdPartyConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"experianActiveStatus\": true,\n    \"equifaxActiveStatus\": false,\n    \"transunionActiveStatus\": false,\n    \"blackBookActive\": true,\n    \"blackBookLogin\": \"client_login\",\n    \"blackBookPassword\": \"client_password\",\n    \"blueBookActive\": false,\n    \"blueBookLogin\": null,\n    \"blueBookPassword\": null,\n    \"vehicleAccessories\": true,\n    \"vehicleCondition\": 1,\n    \"faxingActive\": false,\n    \"outgoingEMailRequest\": true,\n    \"solutionsByTextActive\": false,\n    \"solutionsByTextAPIKey\": null,\n    \"solutionsByTextClientOrgCode\": null,\n    \"solutionsByTextDivOrgCode\": null,\n    \"solutionsByTextGroupOrgCode\": null,\n    \"sbtLastOptOutRetrieval\": null,\n    \"solutionsByTextAutoOptIn\": false,\n    \"acceptablePaymentType\": 1,\n    \"pvLogin\": null,\n    \"pvPassword\": null,\n    \"pvAPIKey\": null,\n    \"pvToken\": null,\n    \"pvPaymentRetrievalStartDate\": null,\n    \"sendPaymentVisionPaymentReversal\": false,\n    \"payNearMeSiteIdentifier\": null,\n    \"payNearMeSignatureKey\": null,\n    \"sendPayNearMeReversal\": false,\n    \"pnmAPIVersion\": 2,\n    \"expiTransUserName\": null,\n    \"expiTransTranKey\": null,\n    \"expiTransSbUserName\": null,\n    \"expiTransSbTranKey\": null,\n    \"expiTransProductionUrl\": null,\n    \"expiTransSandboxUrl\": null,\n    \"sendExpiTransPaymentReversal\": false,\n    \"goldStarLogin\": null,\n    \"goldStarPassword\": null,\n    \"allisonClientNumber\": null,\n    \"allisonServiceSequence\": null,\n    \"dealerTrackActive\": true,\n    \"dealerTrackLienHolderID\": \"LH1234\",\n    \"dealerTrackSentTitleStatusCodeOrId\": \"DTSENT\",\n    \"dealerTrackPaperReceivedTitleStatusCodeOrId\": \"DTPAPER\",\n    \"dealerTrackElectronicReceivedTitleStatusCodeOrId\": \"DTELEC\",\n    \"dealerTrackApplicationActive\": false,\n    \"dealerTrackLenderId\": null,\n    \"dealerTrackUser\": null,\n    \"dealerTrackPassWord\": null,\n    \"dealerTrackAckUrl\": null,\n    \"dealerTrackDecUrl\": null,\n    \"sbDealerTrackUser\": null,\n    \"sbDealerTrackPassWord\": null,\n    \"sbDealerTrackAckUrl\": null,\n    \"sbDealerTrackDecUrl\": null,\n    \"passTimeDealerNumber\": null,\n    \"recurringACHFailureOption\": 1,\n    \"oneTimeACHFailureOption\": 1,\n    \"docuSignIntergrationKey\": null,\n    \"docuSignSecretKey\": null,\n    \"docuSignAccessToken\": null,\n    \"outboundPaymentVendor\": 0,\n    \"eSignatureVendor\": 0,\n    \"enablePaymentAccountCreation\": false,\n    \"creditInquiryVendor\": 0,\n    \"creditInquiryDaysBeforeAdditionalPull\": 30,\n    \"vendorConfigurations\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"2d346141-e826-4a28-a132-1fbd60d4c228","name":"UpdateThirdPartyConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"experianActiveStatus\": true,\n    \"equifaxActiveStatus\": false,\n    \"transunionActiveStatus\": false,\n    \"blackBookActive\": true,\n    \"blackBookLogin\": \"client_login\",\n    \"blackBookPassword\": \"client_password\",\n    \"blueBookActive\": false,\n    \"blueBookLogin\": null,\n    \"blueBookPassword\": null,\n    \"vehicleAccessories\": true,\n    \"vehicleCondition\": 1,\n    \"faxingActive\": false,\n    \"outgoingEMailRequest\": true,\n    \"solutionsByTextActive\": false,\n    \"solutionsByTextAPIKey\": null,\n    \"solutionsByTextClientOrgCode\": null,\n    \"solutionsByTextDivOrgCode\": null,\n    \"solutionsByTextGroupOrgCode\": null,\n    \"sbtLastOptOutRetrieval\": null,\n    \"solutionsByTextAutoOptIn\": false,\n    \"acceptablePaymentType\": 1,\n    \"pvLogin\": null,\n    \"pvPassword\": null,\n    \"pvAPIKey\": null,\n    \"pvToken\": null,\n    \"pvPaymentRetrievalStartDate\": null,\n    \"sendPaymentVisionPaymentReversal\": false,\n    \"payNearMeSiteIdentifier\": null,\n    \"payNearMeSignatureKey\": null,\n    \"sendPayNearMeReversal\": false,\n    \"pnmAPIVersion\": 2,\n    \"expiTransUserName\": null,\n    \"expiTransTranKey\": null,\n    \"expiTransSbUserName\": null,\n    \"expiTransSbTranKey\": null,\n    \"expiTransProductionUrl\": null,\n    \"expiTransSandboxUrl\": null,\n    \"sendExpiTransPaymentReversal\": false,\n    \"goldStarLogin\": null,\n    \"goldStarPassword\": null,\n    \"allisonClientNumber\": null,\n    \"allisonServiceSequence\": null,\n    \"dealerTrackActive\": true,\n    \"dealerTrackLienHolderID\": \"LH1234\",\n    \"dealerTrackSentTitleStatusCodeOrId\": \"DTSENT\",\n    \"dealerTrackPaperReceivedTitleStatusCodeOrId\": \"DTPAPER\",\n    \"dealerTrackElectronicReceivedTitleStatusCodeOrId\": \"DTELEC\",\n    \"dealerTrackApplicationActive\": false,\n    \"dealerTrackLenderId\": null,\n    \"dealerTrackUser\": null,\n    \"dealerTrackPassWord\": null,\n    \"dealerTrackAckUrl\": null,\n    \"dealerTrackDecUrl\": null,\n    \"sbDealerTrackUser\": null,\n    \"sbDealerTrackPassWord\": null,\n    \"sbDealerTrackAckUrl\": null,\n    \"sbDealerTrackDecUrl\": null,\n    \"passTimeDealerNumber\": null,\n    \"recurringACHFailureOption\": 1,\n    \"oneTimeACHFailureOption\": 1,\n    \"docuSignIntergrationKey\": null,\n    \"docuSignSecretKey\": null,\n    \"docuSignAccessToken\": null,\n    \"outboundPaymentVendor\": 0,\n    \"eSignatureVendor\": 0,\n    \"enablePaymentAccountCreation\": false,\n    \"creditInquiryVendor\": 0,\n    \"creditInquiryDaysBeforeAdditionalPull\": 30,\n    \"vendorConfigurations\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Company configuration not found\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"94f1371f-6a5b-4502-b871-dd51f58cd74f"},{"name":"ThirdPartyConfiguration","id":"172fdaf4-39e3-452b-b3d6-ba3a9083a6fb","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration","description":"<h3 id=\"get-third-party-configuration\">Get Third Party Configuration</h3>\n<p>Returns the caller client's third-party/company configuration row (one per client). Wraps <code>ThirdPartyConfigurationWSServices.GetThirdPartyConfigurationWS</code>, which calls <code>Omega.Common.BLL.ThirdPartyConfigurationServices.ReturnCompanyConfiguration</code> and returns the underlying <code>MyCommonCompanyConfigurationEntity</code> as <code>apiResults.data</code> — so the response exposes every configuration column maintained on <code>Common.CompanyConfiguration</code> (credit-bureau switches, Black Book / Blue Book credentials, Solutions By Text credentials, PaymentVision, PayNearMe, ExpiTrans, GoldStar, Allison, DealerTrack ACK/title-status settings, PassTime, ACH-failure options, DocuSign tokens, outbound payment / eSignature / credit-inquiry vendor enumerations, and the child <code>CommonVendorConfiguration</code> rows). Returns a <code>400</code> with <code>\"Company configuration not found\"</code> when the client has no row yet.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","ThirdPartyConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5cb7b1e7-779d-4cb0-9343-16c6c863bfe4","name":"GetThirdPartyConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ExperianActiveStatus\": true,\n        \"EquifaxActiveStatus\": false,\n        \"TransunionActiveStatus\": false,\n        \"BlackBookActive\": true,\n        \"BlackBookLogin\": \"client_login\",\n        \"BlueBookActive\": false,\n        \"VehicleAccessories\": true,\n        \"VehicleCondition\": 1,\n        \"FaxingActive\": false,\n        \"OutgoingEMailRequest\": true,\n        \"SolutionsByTextActive\": false,\n        \"SolutionsByTextAutoOptIn\": false,\n        \"AcceptablePaymentType\": 1,\n        \"PNMAPIVersion\": 2,\n        \"DealerTrackActive\": true,\n        \"DealerTrackApplicationActive\": false,\n        \"DealerTrackSentTitleStatusCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"DealerTrackPaperReceivedTitleStatusCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"DealerTrackElectronicReceivedTitleStatusCodeId\": \"00000000-0000-0000-0000-000000000000\",\n        \"RecurringACHFailureOption\": 1,\n        \"OneTimeACHFailureOption\": 1,\n        \"OutboundPaymentVendor\": 0,\n        \"ESignatureVendor\": 0,\n        \"EnablePaymentAccountCreation\": false,\n        \"CreditInquiryVendor\": 0,\n        \"CreditInquiryDaysBeforeAdditionalPull\": 30,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"aa6120b6-3f49-4683-adfc-5f5a54720135","name":"GetThirdPartyConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/ThirdPartyConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Company configuration not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"172fdaf4-39e3-452b-b3d6-ba3a9083a6fb"},{"name":"TimeZoneAdd","id":"f6fd1712-43be-4909-936d-6d9970df2abb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"EST\",\n    \"description\": \"Eastern Standard Time\",\n    \"timeZoneId\": \"Eastern Standard Time\",\n    \"gmtOffset\": -5,\n    \"observesDaylightSavingTime\": true,\n    \"callBeforeTime\": \"08:00:00\",\n    \"callAfterTime\": \"21:00:00\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TimeZone","description":"<h3 id=\"add-time-zone\">Add Time Zone</h3>\n<p>Creates a new <code>Common.TimeZone</code> row for the caller's client. The controller (<code>TimeZoneController.AddTimeZone</code>) remaps the inbound <code>AddTimeZoneParameter</code> into an <code>AddSaveTimeZoneParameter</code> with <code>id = null</code> and <code>ts = null</code>, so <code>TimeZoneWSServices.AddSaveTimeZoneWS</code> treats the call as an insert. A duplicate <code>code</code> (per client) returns <code>400 Bad Request</code>. On success the row is committed via <code>UnitOfWork2</code> and the new <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TimeZone</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Time zone code. Must be unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>timeZoneId</em></td>\n<td>Required string. Windows time-zone identifier (for example <code>Eastern Standard Time</code>).</td>\n</tr>\n<tr>\n<td><em>gmtOffset</em></td>\n<td>Required int. Hours offset from GMT (for example <code>-5</code>).</td>\n</tr>\n<tr>\n<td><em>observesDaylightSavingTime</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>callBeforeTime</em></td>\n<td>Optional <code>TimeSpan</code> (<code>HH:mm:ss</code>). Earliest contact time in the zone.</td>\n</tr>\n<tr>\n<td><em>callAfterTime</em></td>\n<td>Optional <code>TimeSpan</code> (<code>HH:mm:ss</code>). Latest contact time in the zone.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TimeZone"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"086e7365-ff4b-42eb-ae0f-d5e488d2eeb0","name":"AddTimeZone - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"EST\",\n    \"description\": \"Eastern Standard Time\",\n    \"timeZoneId\": \"Eastern Standard Time\",\n    \"gmtOffset\": -5,\n    \"observesDaylightSavingTime\": true,\n    \"callBeforeTime\": \"08:00:00\",\n    \"callAfterTime\": \"21:00:00\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TimeZone"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"2a66eeb7-1d5a-4846-956e-073d6b189f2f","name":"AddTimeZone - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"EST\",\n    \"description\": \"Eastern Standard Time\",\n    \"timeZoneId\": \"Eastern Standard Time\",\n    \"gmtOffset\": -5,\n    \"observesDaylightSavingTime\": true,\n    \"callBeforeTime\": \"08:00:00\",\n    \"callAfterTime\": \"21:00:00\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TimeZone"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Time zone with code 'EST' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"f6fd1712-43be-4909-936d-6d9970df2abb"},{"name":"TimeZoneGet","id":"b8e6dc37-7895-446f-a2f1-d81ddf5062ef","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TimeZone/{{time_zone_code_or_id}}","description":"<h3 id=\"get-time-zone\">Get Time Zone</h3>\n<p>Returns a single <code>Common.TimeZone</code> row resolved from the <code>{codeOrId}</code> path segment. The controller (<code>TimeZoneController.GetTimeZone</code>) resolves the row via <code>SharedWSServices.GetCommonTimeZoneId</code>, which attempts <code>Guid.TryParse</code> first and falls back to a client-scoped code lookup, then loads the entity with <code>TimeZoneServices.ReturnTimeZone</code>. Returns <code>400 Bad Request</code> when the segment is empty or the row cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TimeZone/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the time-zone code string or the row <code>Id</code> Guid. Resolution is Guid-first, then code string (client-scoped).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TimeZone","{{time_zone_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"57190b1c-a3e7-45d8-915e-eaec5242e612","name":"GetTimeZone - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TimeZone/EST"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Code\": \"EST\",\n        \"Description\": \"Eastern Standard Time\",\n        \"TimeZoneId\": \"Eastern Standard Time\",\n        \"GmtOffset\": -5,\n        \"ObservesDaylightSavingTime\": true,\n        \"CallBeforeTime\": \"08:00:00\",\n        \"CallAfterTime\": \"21:00:00\",\n        \"Ts\": \"AAAAAAAAB9U=\"\n    }\n}"},{"id":"e9982c95-808a-46a4-a441-d2a831ec56dc","name":"GetTimeZone - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TimeZone/XYZ"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Time zone not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b8e6dc37-7895-446f-a2f1-d81ddf5062ef"},{"name":"TimeZonesGetAll","id":"661c1b49-beaf-483d-9d56-ab81320d58d2","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TimeZone","description":"<h3 id=\"get-all-time-zones\">Get All Time Zones</h3>\n<p>Returns all <code>Common.TimeZone</code> rows for the caller's client. The controller (<code>TimeZoneController.GetAllTimeZones</code>) calls <code>TimeZoneWSServices.ReturnAllTimeZonesWS</code>, which delegates to <code>TimeZoneServices.ReturnAllTimeZones</code> with <code>LoginInfo.ClientId</code> for client scoping.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TimeZone</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TimeZone"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1a0f3143-bbb5-45e0-af41-fe4a8bcee043","name":"GetAllTimeZones - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/TimeZone"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Code\": \"EST\",\n            \"Description\": \"Eastern Standard Time\",\n            \"TimeZoneId\": \"Eastern Standard Time\",\n            \"GmtOffset\": -5,\n            \"ObservesDaylightSavingTime\": true,\n            \"CallBeforeTime\": \"08:00:00\",\n            \"CallAfterTime\": \"21:00:00\",\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ]\n}"},{"id":"480936df-02f4-4336-9330-361e3d24c83d","name":"GetAllTimeZones - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Common/TimeZone"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"661c1b49-beaf-483d-9d56-ab81320d58d2"},{"name":"TimeZoneUpdate","id":"c251e0ea-bb4a-49a7-9468-e6dab9d7dd7a","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"EST\",\n    \"description\": \"Eastern Standard Time - Updated\",\n    \"timeZoneId\": \"Eastern Standard Time\",\n    \"gmtOffset\": -5,\n    \"observesDaylightSavingTime\": true,\n    \"callBeforeTime\": \"09:00:00\",\n    \"callAfterTime\": \"20:00:00\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TimeZone/{{time_zone_code_or_id}}","description":"<h3 id=\"update-time-zone\">Update Time Zone</h3>\n<p>Updates an existing <code>Common.TimeZone</code> row resolved from the <code>{codeOrId}</code> path segment. The controller (<code>TimeZoneController.UpdateTimeZone</code>) resolves the row via <code>SharedWSServices.GetCommonTimeZoneId</code>, re-reads the current <code>Ts</code> server-side via <code>TimeZoneServices.ReturnTimeZone</code>, and remaps the inbound <code>UpdateTimeZoneParameter</code> into an <code>AddSaveTimeZoneParameter</code> carrying the resolved <code>id</code> and existing <code>ts</code>. <code>TimeZoneWSServices.AddSaveTimeZoneWS</code> detects update mode from the non-null timestamp and commits via <code>UnitOfWork2</code>. Unresolved <code>{codeOrId}</code> returns <code>400 Bad Request</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/TimeZone/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the current time-zone code string or the row <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. New (or unchanged) time-zone code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>timeZoneId</em></td>\n<td>Required string. Windows time-zone identifier.</td>\n</tr>\n<tr>\n<td><em>gmtOffset</em></td>\n<td>Required int. Hours offset from GMT.</td>\n</tr>\n<tr>\n<td><em>observesDaylightSavingTime</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>callBeforeTime</em></td>\n<td>Optional <code>TimeSpan</code> (<code>HH:mm:ss</code>).</td>\n</tr>\n<tr>\n<td><em>callAfterTime</em></td>\n<td>Optional <code>TimeSpan</code> (<code>HH:mm:ss</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","TimeZone","{{time_zone_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"64f3debe-01c5-4747-b4a8-9434c4fcf259","name":"UpdateTimeZone - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"EST\",\n    \"description\": \"Eastern Standard Time - Updated\",\n    \"timeZoneId\": \"Eastern Standard Time\",\n    \"gmtOffset\": -5,\n    \"observesDaylightSavingTime\": true,\n    \"callBeforeTime\": \"09:00:00\",\n    \"callAfterTime\": \"20:00:00\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TimeZone/EST"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"92c3f58b-7406-4e70-9899-fd4a99d8eeb9","name":"UpdateTimeZone - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"code\": \"EST\",\n    \"description\": \"Eastern Standard Time - Updated\",\n    \"timeZoneId\": \"Eastern Standard Time\",\n    \"gmtOffset\": -5,\n    \"observesDaylightSavingTime\": true,\n    \"callBeforeTime\": \"09:00:00\",\n    \"callAfterTime\": \"20:00:00\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/TimeZone/XYZ"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Time zone not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c251e0ea-bb4a-49a7-9468-e6dab9d7dd7a"},{"name":"VendorAdd","id":"37ad33a2-04d4-48f7-9118-034b39ca3dae","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"ACME\",\n  \"name\": \"ACME Supplies Inc.\",\n  \"isDealer\": false,\n  \"isAvailable\": true,\n  \"creationDate\": null,\n  \"print1099TaxForm\": false,\n  \"taxIdNumber\": null,\n  \"yearToDatePayments\": 0,\n  \"webAddress\": \"https://www.acme.example\",\n  \"notes\": null,\n  \"primaryBranchId\": \"00000000-0000-0000-0000-000000000000\",\n  \"defaultExpenseGlAccountId\": null,\n  \"accountNumber\": null,\n  \"corporateDbaName\": null,\n  \"masterVendorId\": null,\n  \"useMasterNameOnCheck\": false,\n  \"maxNumberOfVouchersPerCheck\": 1,\n  \"defaultNumberOfVoucherDueDays\": 30,\n  \"maxNumberOfVoucherDueDays\": 90,\n  \"defaultPaymentMethod\": 0,\n  \"lastCheckDate\": null,\n  \"language\": 0,\n  \"defaultOutboundVendor\": 0,\n  \"useMasterAddressOnCheck\": false,\n  \"useMasterVendor\": false,\n  \"insuranceCompanyId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"defaultExpenseGlAccountNumberOrId\": null,\n  \"masterVendorCodeOrId\": null,\n  \"insuranceCompanyNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Vendor","description":"<h3 id=\"add-vendor\">Add Vendor</h3>\n<p>Creates a new <code>Common.Vendor</code> row for the caller's client. The controller (<code>VendorController.AddVendor</code>) remaps the inbound <code>AddVendorParameter</code> into an <code>AddSaveVendorParameter</code> with <code>id = null</code> and <code>ts = null</code>, so <code>VendorWSServices.AddVendorWS</code> treats the call as an insert. The WS layer validates that <code>code</code>, <code>name</code>, and <code>primaryBranchId</code> are populated, checks for a duplicate <code>code</code> (per client) via <code>VendorServices.ReturnVendorId</code>, and commits via <code>UnitOfWork2</code>. The new row <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Vendor</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Optional. May also be supplied via <code>Authorization</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Vendor code. Must be unique per client.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>primaryBranchId</em></td>\n<td>Required Guid. <code>SetupInternal.Branch</code> row.</td>\n</tr>\n<tr>\n<td><em>isDealer</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>creationDate</em></td>\n<td>Optional DateTime.</td>\n</tr>\n<tr>\n<td><em>print1099TaxForm</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>taxIdNumber</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>yearToDatePayments</em></td>\n<td>Required decimal.</td>\n</tr>\n<tr>\n<td><em>webAddress</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>defaultExpenseGlAccountId</em></td>\n<td>Optional Guid. <code>GeneralLedger.Account</code> row.</td>\n</tr>\n<tr>\n<td><em>accountNumber</em></td>\n<td>Optional string. Vendor-assigned account number for the caller.</td>\n</tr>\n<tr>\n<td><em>corporateDbaName</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>masterVendorId</em></td>\n<td>Optional Guid. <code>Common.Vendor</code> row for a master vendor hierarchy.</td>\n</tr>\n<tr>\n<td><em>useMasterNameOnCheck</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>maxNumberOfVouchersPerCheck</em></td>\n<td>Required int.</td>\n</tr>\n<tr>\n<td><em>defaultNumberOfVoucherDueDays</em></td>\n<td>Required int.</td>\n</tr>\n<tr>\n<td><em>maxNumberOfVoucherDueDays</em></td>\n<td>Required int.</td>\n</tr>\n<tr>\n<td><em>defaultPaymentMethod</em></td>\n<td>Required int. <code>PaymentMethodTypes</code> enum.</td>\n</tr>\n<tr>\n<td><em>lastCheckDate</em></td>\n<td>Optional DateTime.</td>\n</tr>\n<tr>\n<td><em>language</em></td>\n<td>Required int. <code>UserLanguageTypes</code> enum.</td>\n</tr>\n<tr>\n<td><em>defaultOutboundVendor</em></td>\n<td>Required int. <code>OutboundElectronicPaymentTypes</code> enum.</td>\n</tr>\n<tr>\n<td><em>useMasterAddressOnCheck</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>useMasterVendor</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>insuranceCompanyId</em></td>\n<td>Optional Guid. Linked insurance company row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>primaryBranchNumberOrId</code></td>\n<td><code>primaryBranchId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultExpenseGlAccountNumberOrId</code></td>\n<td><code>defaultExpenseGlAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>masterVendorCodeOrId</code></td>\n<td><code>masterVendorId</code></td>\n<td>String. non-dealer vendor code or vendor GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>insuranceCompanyNameOrId</code></td>\n<td><code>insuranceCompanyId</code></td>\n<td>String. insurance-company name or company GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"primaryBranchNumberOrId\": \"90\",\n  \"defaultExpenseGlAccountNumberOrId\": \"1000-90\",\n  \"masterVendorCodeOrId\": \"VENDOR1\",\n  \"insuranceCompanyNameOrId\": \"Example Insurance\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","Vendor"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ab6b8646-5c2a-4150-98b8-861623f8778f","name":"AddVendor - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"ACME\",\n  \"name\": \"ACME Supplies Inc.\",\n  \"isDealer\": false,\n  \"isAvailable\": true,\n  \"creationDate\": null,\n  \"print1099TaxForm\": false,\n  \"taxIdNumber\": null,\n  \"yearToDatePayments\": 0,\n  \"webAddress\": \"https://www.acme.example\",\n  \"notes\": null,\n  \"primaryBranchId\": \"00000000-0000-0000-0000-000000000000\",\n  \"defaultExpenseGlAccountId\": null,\n  \"accountNumber\": null,\n  \"corporateDbaName\": null,\n  \"masterVendorId\": null,\n  \"useMasterNameOnCheck\": false,\n  \"maxNumberOfVouchersPerCheck\": 1,\n  \"defaultNumberOfVoucherDueDays\": 30,\n  \"maxNumberOfVoucherDueDays\": 90,\n  \"defaultPaymentMethod\": 0,\n  \"lastCheckDate\": null,\n  \"language\": 0,\n  \"defaultOutboundVendor\": 0,\n  \"useMasterAddressOnCheck\": false,\n  \"useMasterVendor\": false,\n  \"insuranceCompanyId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"defaultExpenseGlAccountNumberOrId\": null,\n  \"masterVendorCodeOrId\": null,\n  \"insuranceCompanyNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Vendor"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"94ddddcc-6505-4bc9-8ccf-05b1cf040c56","name":"AddVendor - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"ACME\",\n  \"name\": \"ACME Supplies Inc.\",\n  \"isDealer\": false,\n  \"isAvailable\": true,\n  \"creationDate\": null,\n  \"print1099TaxForm\": false,\n  \"taxIdNumber\": null,\n  \"yearToDatePayments\": 0,\n  \"webAddress\": \"https://www.acme.example\",\n  \"notes\": null,\n  \"primaryBranchId\": \"00000000-0000-0000-0000-000000000000\",\n  \"defaultExpenseGlAccountId\": null,\n  \"accountNumber\": null,\n  \"corporateDbaName\": null,\n  \"masterVendorId\": null,\n  \"useMasterNameOnCheck\": false,\n  \"maxNumberOfVouchersPerCheck\": 1,\n  \"defaultNumberOfVoucherDueDays\": 30,\n  \"maxNumberOfVoucherDueDays\": 90,\n  \"defaultPaymentMethod\": 0,\n  \"lastCheckDate\": null,\n  \"language\": 0,\n  \"defaultOutboundVendor\": 0,\n  \"useMasterAddressOnCheck\": false,\n  \"useMasterVendor\": false,\n  \"insuranceCompanyId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"defaultExpenseGlAccountNumberOrId\": null,\n  \"masterVendorCodeOrId\": null,\n  \"insuranceCompanyNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Vendor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Vendor with code 'ACME' already exists for this client\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"37ad33a2-04d4-48f7-9118-034b39ca3dae"},{"name":"VendorDelete","id":"35005a37-fcf4-41a9-aeea-d37d3addb1ad","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Vendor/{{vendor_code_or_id}}","description":"<h3 id=\"delete-vendor\">Delete Vendor</h3>\n<p>Deletes a <code>Common.Vendor</code> row resolved from the <code>{vendorCodeOrId}</code> path segment. The controller (<code>VendorController.DeleteVendor</code>) calls <code>VendorWSServices.DeleteVendorWS</code>, which resolves the vendor via <code>SharedWSServices.GetCommonVendorId</code> (Guid-first, then client-scoped code), then delegates to <code>VendorServices.DeleteVendor</code>. The delete is committed via <code>UnitOfWork2</code>. Unresolved <code>{vendorCodeOrId}</code> — or an attempt to delete a vendor that has associated rows — returns <code>400 Bad Request</code> with the failure reason in <code>errors</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Vendor/{vendorCodeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>vendorCodeOrId</em></td>\n<td>Required. Either the vendor <code>Code</code> string or the row <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Common","Vendor","{{vendor_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2557f9fb-51b9-4828-9827-6f864ddbe535","name":"DeleteVendor - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Vendor/ACME"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": null\n}"},{"id":"be6e37b0-4e90-4bef-8eac-7aacda9d3031","name":"DeleteVendor - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Common/Vendor/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Vendor not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"35005a37-fcf4-41a9-aeea-d37d3addb1ad"},{"name":"VendorUpdate","id":"89ff0f2b-afc6-4a1e-9bf5-0b962afe526c","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"ACME\",\n  \"name\": \"ACME Supplies Inc. - Updated\",\n  \"isDealer\": false,\n  \"isAvailable\": true,\n  \"creationDate\": null,\n  \"print1099TaxForm\": true,\n  \"taxIdNumber\": \"12-3456789\",\n  \"yearToDatePayments\": 0,\n  \"webAddress\": \"https://www.acme.example\",\n  \"notes\": \"Primary supplier\",\n  \"primaryBranchId\": \"00000000-0000-0000-0000-000000000000\",\n  \"defaultExpenseGlAccountId\": null,\n  \"accountNumber\": null,\n  \"corporateDbaName\": null,\n  \"masterVendorId\": null,\n  \"useMasterNameOnCheck\": false,\n  \"maxNumberOfVouchersPerCheck\": 1,\n  \"defaultNumberOfVoucherDueDays\": 30,\n  \"maxNumberOfVoucherDueDays\": 90,\n  \"defaultPaymentMethod\": 0,\n  \"language\": 0,\n  \"defaultOutboundVendor\": 0,\n  \"secCode\": null,\n  \"useMasterAddressOnCheck\": false,\n  \"useMasterVendor\": false,\n  \"insuranceCompanyId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"defaultExpenseGlAccountNumberOrId\": null,\n  \"masterVendorCodeOrId\": null,\n  \"insuranceCompanyNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Vendor/{{vendor_code_or_id}}","description":"<h3 id=\"update-vendor\">Update Vendor</h3>\n<p>Updates an existing <code>Common.Vendor</code> row resolved from the <code>{vendorCodeOrId}</code> path segment. The controller (<code>VendorController.UpdateVendor</code>) remaps the inbound <code>UpdateVendorParameter</code> into an <code>AddSaveVendorParameter</code> and calls <code>VendorWSServices.UpdateVendorWS</code>. The WS layer resolves the vendor via <code>SharedWSServices.GetCommonVendorId</code> (Guid-first, then client-scoped code), re-reads the current <code>Ts</code> server-side, validates that <code>code</code>, <code>name</code>, and <code>primaryBranchId</code> are populated, and commits via <code>UnitOfWork2</code>. Unresolved <code>{vendorCodeOrId}</code> returns <code>400 Bad Request</code>.</p>\n<p><code>secCode</code> (<code>AuthorizationType</code> enum) is accepted only on update; it is not part of the add payload. <code>lastCheckDate</code> is omitted from the update payload — the value is not overwritten on update.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Common/Vendor/{vendorCodeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>vendorCodeOrId</em></td>\n<td>Required. Either the current vendor <code>Code</code> string or the row <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same as add plus <code>secCode</code> (optional int <code>AuthorizationType</code>). <code>lastCheckDate</code> is not accepted on update.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>primaryBranchNumberOrId</code></td>\n<td><code>primaryBranchId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultExpenseGlAccountNumberOrId</code></td>\n<td><code>defaultExpenseGlAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>masterVendorCodeOrId</code></td>\n<td><code>masterVendorId</code></td>\n<td>String. non-dealer vendor code or vendor GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>insuranceCompanyNameOrId</code></td>\n<td><code>insuranceCompanyId</code></td>\n<td>String. insurance-company name or company GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"primaryBranchNumberOrId\": \"90\",\n  \"defaultExpenseGlAccountNumberOrId\": \"1000-90\",\n  \"masterVendorCodeOrId\": \"VENDOR1\",\n  \"insuranceCompanyNameOrId\": \"Example Insurance\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Common","Vendor","{{vendor_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f3411356-2895-410a-9153-247d7290d89b","name":"UpdateVendor - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"ACME\",\n  \"name\": \"ACME Supplies Inc. - Updated\",\n  \"isDealer\": false,\n  \"isAvailable\": true,\n  \"creationDate\": null,\n  \"print1099TaxForm\": true,\n  \"taxIdNumber\": \"12-3456789\",\n  \"yearToDatePayments\": 0,\n  \"webAddress\": \"https://www.acme.example\",\n  \"notes\": \"Primary supplier\",\n  \"primaryBranchId\": \"00000000-0000-0000-0000-000000000000\",\n  \"defaultExpenseGlAccountId\": null,\n  \"accountNumber\": null,\n  \"corporateDbaName\": null,\n  \"masterVendorId\": null,\n  \"useMasterNameOnCheck\": false,\n  \"maxNumberOfVouchersPerCheck\": 1,\n  \"defaultNumberOfVoucherDueDays\": 30,\n  \"maxNumberOfVoucherDueDays\": 90,\n  \"defaultPaymentMethod\": 0,\n  \"language\": 0,\n  \"defaultOutboundVendor\": 0,\n  \"secCode\": null,\n  \"useMasterAddressOnCheck\": false,\n  \"useMasterVendor\": false,\n  \"insuranceCompanyId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"defaultExpenseGlAccountNumberOrId\": null,\n  \"masterVendorCodeOrId\": null,\n  \"insuranceCompanyNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Vendor/ACME"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"115b4894-3921-4147-a8a2-8cf4aa0c7994","name":"UpdateVendor - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"ACME\",\n  \"name\": \"ACME Supplies Inc. - Updated\",\n  \"isDealer\": false,\n  \"isAvailable\": true,\n  \"creationDate\": null,\n  \"print1099TaxForm\": true,\n  \"taxIdNumber\": \"12-3456789\",\n  \"yearToDatePayments\": 0,\n  \"webAddress\": \"https://www.acme.example\",\n  \"notes\": \"Primary supplier\",\n  \"primaryBranchId\": \"00000000-0000-0000-0000-000000000000\",\n  \"defaultExpenseGlAccountId\": null,\n  \"accountNumber\": null,\n  \"corporateDbaName\": null,\n  \"masterVendorId\": null,\n  \"useMasterNameOnCheck\": false,\n  \"maxNumberOfVouchersPerCheck\": 1,\n  \"defaultNumberOfVoucherDueDays\": 30,\n  \"maxNumberOfVoucherDueDays\": 90,\n  \"defaultPaymentMethod\": 0,\n  \"language\": 0,\n  \"defaultOutboundVendor\": 0,\n  \"secCode\": null,\n  \"useMasterAddressOnCheck\": false,\n  \"useMasterVendor\": false,\n  \"insuranceCompanyId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"defaultExpenseGlAccountNumberOrId\": null,\n  \"masterVendorCodeOrId\": null,\n  \"insuranceCompanyNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Common/Vendor/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Vendor not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"89ff0f2b-afc6-4a1e-9bf5-0b962afe526c"}],"id":"c9d9cc7e-83c5-481d-87a8-0e0b018cd25d","_postman_id":"c9d9cc7e-83c5-481d-87a8-0e0b018cd25d","description":""},{"name":"Customer","item":[{"name":"Customer - Update Time ZoneUpdate","id":"c95e1e55-03f5-42fd-a9d8-9d286baffbeb","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"TimeZone\",\r\n    \"update_customer_call_between_times\": true,\r\n    \"data\": [\r\n        {\r\n            \"customerNumber\": \"230\",\r\n            \"valueToUpdate\": \"qc_test\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/customer/updatecustomers","description":"<h6 id=\"this-method-with-type-set-as-timezone-will-set-the-time-zone-for-a-given-customer\">This method with <strong>\"</strong><em><strong>Type</strong></em><strong>\"</strong> set as <code>TimeZone</code> will set the time zone for a given customer.</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required. Token to identify your login access provided by the Login method.</td>\n</tr>\n<tr>\n<td><em>type</em></td>\n<td>Required. Must be set to <code>TimeZone</code></td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>Required. The list of customer time zone to set.</td>\n</tr>\n<tr>\n<td><em>customerNumber</em></td>\n<td>Required. Must be a valid int32 greater than 0. This field must match a customer number in the Omega system.</td>\n</tr>\n<tr>\n<td><em>valueToUpdate</em></td>\n<td>Required. String with max length of 10. Must be a valid <a href=\"https://%7B%7Bbase_url%7D%7D/Client/Setup/TimeZoneMaintenance.aspx\">time zone code</a> from the Omega system.</td>\n</tr>\n<tr>\n<td>update_customer_call_between_times</td>\n<td>Optional. Boolean - defaults to false. Send a value of true to update customer call between times with the defaults for the new timezone - required to display 'DO NOT CALL' on view account in Omega.</td>\n</tr>\n</tbody>\n</table>\n</div><p>API Access: the caller's API Access role needs the UpdateCustomers endpoint, or its <strong>Time Zone</strong> operation. Types added later are granted separately.</p>\n","urlObject":{"protocol":"https","path":["api","client","customer","updatecustomers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7ac8bf78-4082-4992-b188-31b9ce23b5ba","name":"Set Time Zone - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"TimeZone\",\r\n    \"data\": [\r\n        {\r\n            \"customerNumber\": 155,\r\n            \"valueToUpdate\": \"Arizona\"\r\n        },\r\n        {\r\n            \"customerNumber\": 27,\r\n            \"valueToUpdate\": \"Pacific Time\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/customer/updatecustomers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"},{"id":"b0bd2773-9f3b-4dba-acb9-8774b28bb172","name":"Set Time Zone - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"TimeZone\",\r\n    \"data\": [\r\n        {\r\n            \"customerNumber\": 155,\r\n            \"valueToUpdate\": \"Arizona\"\r\n        },\r\n        {\r\n            \"customerNumber\": 27,\r\n            \"valueToUpdate\": \"Pacific Time\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/customer/updatecustomers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 50,\r\n    \"result\": \"Error\",\r\n    \"errors\": [\r\n        \"Record 1 Customer 155: Customer not found.\",\r\n        \"Record 2 Customer 27: Time zone 'Pacific Time' not found.\"\r\n    ]\r\n}"},{"id":"f7059a86-1632-4c6c-9273-372201a0434c","name":"UpdateCustomer-SetTimeZone","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"type\": \"TimeZone\",\r\n    \"update_customer_call_between_times\": true,\r\n    \"data\": [\r\n        {\r\n            \"customerNumber\": \"230\",\r\n            \"valueToUpdate\": \"qc_test\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/customer/updatecustomers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|2e097edd-5614-468b-84d5-be630f24a5f1|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Date","value":"Tue, 12 Mar 2024 23:56:46 GMT"},{"key":"Content-Length","value":"74"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"}],"_postman_id":"c95e1e55-03f5-42fd-a9d8-9d286baffbeb"},{"name":"CustomerCreditScore - Add Credit ScoreUpdate","id":"3afca9c2-27f4-4408-80d8-b3b953e9d159","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"data\": [\r\n        {\r\n            \"customerNumber\": \"{{customer_number}}\",\r\n            \"score\": \"{{credit_score}}\",\r\n            \"date\": \"{{credit_score_ms_json_date}}\",\r\n            \"comment\": \"{{credit_score_comment}}\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/customer/updatecustomercreditscore","description":"<h6 id=\"this-method-will-add-a-custom-credit-score-to-a-given-customer\">This method will add a custom credit score to a given customer.</h6>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Token</em></td>\n<td>Required. Token to identify your login access provided by the Login method.</td>\n</tr>\n<tr>\n<td><em>Data</em></td>\n<td>Required. The list of customer credit scores to add.</td>\n</tr>\n<tr>\n<td><em>CustomerNumber</em></td>\n<td>Required. Must be a valid int32 greater than 0. This field must match a customer number in the Omega system.</td>\n</tr>\n<tr>\n<td><em>Score</em></td>\n<td>Required. Must be a valid int32 greater than 0.</td>\n</tr>\n<tr>\n<td><em>Date</em></td>\n<td>Required. Set a valid date (yyyy-mm-dd).  The date the score was received.</td>\n</tr>\n<tr>\n<td><em>Comment</em></td>\n<td>Optional. String with max length of 250.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","customer","updatecustomercreditscore"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c80e5f21-dfc5-471e-874f-262f5221e085","name":"Add Credit Score - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"data\": [\r\n        {\r\n            \"customerNumber\": 42,\r\n            \"score\": 580,\r\n            \"date\":\"2021-02-27\",\r\n            \"comment\":\"My Custom Credit Score 1\"\r\n        },\r\n        {\r\n            \"customerNumber\": 57,\r\n            \"score\": 640,\r\n            \"date\":\"2021-07-16\",\r\n            \"comment\":\"My Custom Credit Score 1\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/customer/updatecustomercreditscore"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": []\n}"},{"id":"949365f9-ac39-4b18-a922-e1bd738673c8","name":"Add Credit Score - Fail","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n    \"token\": \"{{token}}\",\r\n    \"data\": [\r\n        {\r\n            \"customerNumber\": 42,\r\n            \"score\": 580,\r\n            \"date\":\"2021-02-27\",\r\n            \"comment\":\"My Custom Credit Score 1\"\r\n        },\r\n        {\r\n            \"customerNumber\": 57,\r\n            \"score\": 0,\r\n            \"date\":\"2021-07-16\",\r\n            \"comment\":\"My Custom Credit Score 1\"\r\n        }\r\n    ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/client/customer/updatecustomercreditscore"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n    \"statusCode\": 50,\r\n    \"result\": \"Error\",\r\n    \"errors\": [\r\n        \"Record 1 Customer 42: Customer not found.\",\r\n        \"Record 2 Customer 57: Invalid score 0.\"\r\n    ]\r\n}"}],"_postman_id":"3afca9c2-27f4-4408-80d8-b3b953e9d159"},{"name":"CustomerEmployerAdd","id":"81427b3c-c6ce-416a-a9ea-9266ee898b4d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"employerName\": \"ACME Corporation\",\n    \"startDate\": \"2022-01-15\",\n    \"endDate\": null,\n    \"isActive\": true,\n    \"salary\": 65000.00,\n    \"salaryFrequency\": 2,\n    \"salaryHours\": 40,\n    \"occupation\": \"Software Engineer\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Employer?token={{token}}","description":"<h3 id=\"add-customer-employer\">Add Customer Employer</h3>\n<p>Inserts a new <code>Common.CustomerEmployer</code> row for the specified customer. The controller (<code>CustomerEmployerController.AddCustomerEmployer</code>) resolves <code>customerIdOrNumber</code> to the underlying <code>Common.Customer.Id</code> via <code>SharedWSServices.GetCommonCustomerId</code>, then delegates to <code>CustomerEmployerWSServices.AddCustomerEmployerWS</code> which calls <code>CustomerEmployerServices.AddCustomerEmployer</code> and commits via <code>UnitOfWork2</code>. The new <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Employer</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n<tr>\n<td><em>employerName</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>startDate</em></td>\n<td>Optional DateTime. Employment start date.</td>\n</tr>\n<tr>\n<td><em>endDate</em></td>\n<td>Optional DateTime. Employment end date.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>salary</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>salaryFrequency</em></td>\n<td>Required int. <code>IncomePaymentFrequencyType</code> enum: 0=Unknown, 1=Daily, 2=Annually, 3=Semi_Annually, 4=Quarterly, 5=Monthly, 6=Semi_Monthly, 7=Bi_Weekly, 8=Weekly, 9=Hourly.</td>\n</tr>\n<tr>\n<td><em>salaryHours</em></td>\n<td>Optional int. Hours per pay period.</td>\n</tr>\n<tr>\n<td><em>occupation</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>address</em></td>\n<td>Optional object for the employer's single address: <code>addrLine1</code>, <code>addrLine2</code>, <code>addrLine3</code>, <code>city</code>, <code>zipCode</code>, either <code>provinceId</code> or <code>provinceAbbreviation</code>, and an optional <code>addressType</code>. Omit the object to leave the stored address alone.</td>\n</tr>\n<tr>\n<td><em>phone</em></td>\n<td>Optional object for the employer's single Work phone number: <code>phoneNumber</code>. Send an empty string to remove it, or omit the object to leave it alone.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Employer name and start date</td>\n<td>Both must be supplied together, matching <code>EmployerRequiredFields_CustomValidation1</code> on the screen.</td>\n</tr>\n<tr>\n<td>Active</td>\n<td>Derived from the end date - an employer with an end date is inactive. The <code>isActive</code> field in the body is ignored. It marks a current versus a former employer and is not a soft delete: the employment row is kept either way. Use <code>DELETE api/Client/Customer/Employer/{employerId}</code> to remove an employer.</td>\n</tr>\n<tr>\n<td>End date</td>\n<td>Cannot be earlier than the start date.</td>\n</tr>\n<tr>\n<td>Name and occupation</td>\n<td>Printable ASCII, 50 characters.</td>\n</tr>\n<tr>\n<td>Salary and hours</td>\n<td>Salary is zero or greater; salary hours are 0 to 168 and only stored when the frequency is Hourly.</td>\n</tr>\n<tr>\n<td>Employer address</td>\n<td>One per employer, and always primary for that employer - the screen sets it unconditionally, so there is no primary flag to send. Lines and city are printable ASCII up to 50 characters and the zip code follows the country's format.</td>\n</tr>\n<tr>\n<td>Employer phone</td>\n<td>One per employer, always typed Work and always primary for that employer - the screen hides both options. Send an empty <code>phoneNumber</code> to remove it.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Employer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5fcaa443-89b2-4939-b3b3-b37bbccbf793","name":"AddCustomerEmployer - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"656\",\n    \"employerName\": \"ACME Corporation\",\n    \"startDate\": \"2022-01-15\",\n    \"endDate\": null,\n    \"isActive\": true,\n    \"salary\": 65000.00,\n    \"salaryFrequency\": 2,\n    \"salaryHours\": 40,\n    \"occupation\": \"Software Engineer\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Employer"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\"\n    }\n}"},{"id":"ae4540d9-f279-4134-a395-9f8ecf56b569","name":"AddCustomerEmployer - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"999999999\",\n    \"employerName\": \"ACME Corporation\",\n    \"startDate\": \"2022-01-15\",\n    \"endDate\": null,\n    \"isActive\": true,\n    \"salary\": 65000.00,\n    \"salaryFrequency\": 2,\n    \"salaryHours\": 40,\n    \"occupation\": \"Software Engineer\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Employer"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Customer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"81427b3c-c6ce-416a-a9ea-9266ee898b4d"},{"name":"CustomerAddressesGetAll","id":"05235427-62f8-41c8-8646-570d8d344a09","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Address/{{customer_number_or_id}}?includeInactive=false&includePrevious=false","description":"<h3 id=\"get-all-customer-addresses\">Get All Customer Addresses</h3>\n<p>Returns <code>Common.Address</code> rows for the supplied customer. By default only active addresses are returned. Pass <code>includeInactive=true</code> to include deactivated history rows, and/or <code>includePrevious=true</code> to include previous addresses. Each row includes <code>Id</code>, <code>CustomerId</code>, lines, <code>City</code>, <code>ZipCode</code>, <code>ProvinceId</code>, <code>ProvinceAbbreviation</code>, <code>AddressType</code> (1=Physical, 2=Mailing), <code>Primary</code>, <code>Active</code>, and <code>PreviousAddress</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>includeInactive</em></td>\n<td>Optional bool (default false). Include inactive history rows.</td>\n</tr>\n<tr>\n<td><em>includePrevious</em></td>\n<td>Optional bool (default false). Include previous-address rows.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"includeInactive","value":"false"},{"key":"includePrevious","value":"false"}],"variable":[]}},"response":[],"_postman_id":"05235427-62f8-41c8-8646-570d8d344a09"},{"name":"CustomerEmployerByIdGet","id":"e330ad2a-f9a9-410d-bcea-621d621e2596","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Employer/ById/{{employer_id}}?token={{token}}","description":"<h3 id=\"get-customer-employer-by-id\">Get Customer Employer By Id</h3>\n<p>Returns a single <code>Common.CustomerEmployer</code> row by its primary key. The controller (<code>CustomerEmployerController.GetCustomerEmployerById</code>) validates that <code>employerId</code> is a valid GUID, then delegates to <code>CustomerEmployerWSServices.ReturnCustomerEmployerByIdWS</code> which calls <code>CustomerEmployerServices.ReturnCustomerEmployerByEmployerId</code>. If the row does not exist the response is a 400 with <code>errors: [\"Employer not found\"]</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Employer/ById/{employerId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>employerId</em></td>\n<td>Required Guid. Primary key of the <code>Common.CustomerEmployer</code> row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Employer","ById","{{employer_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e311a7ee-18da-4492-937a-c60426e33e58","name":"GetCustomerEmployerById - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/ById/11111111-1111-1111-1111-111111111111"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"11111111-1111-1111-1111-111111111111\",\n        \"CustomerId\": \"22222222-2222-2222-2222-222222222222\",\n        \"EmployerName\": \"ACME Corporation\",\n        \"StartDate\": \"2022-01-15T00:00:00\",\n        \"EndDate\": null,\n        \"IsActive\": true,\n        \"Salary\": 65000.00,\n        \"SalaryFrequency\": 2,\n        \"SalaryHours\": 40,\n        \"Occupation\": \"Software Engineer\",\n        \"Ts\": \"AAAAAAAAH3Y=\"\n    }\n}"},{"id":"04195c76-05bf-4069-b1bc-5603e20730e5","name":"GetCustomerEmployerById - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/ById/99999999-9999-9999-9999-999999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Employer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e330ad2a-f9a9-410d-bcea-621d621e2596"},{"name":"CustomerAddressByIdGet","id":"91929acc-5539-41ff-ae39-fe6e8167e228","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Address/ById/{{address_id}}","description":"<h3 id=\"get-customer-address-by-id\">Get Customer Address By Id</h3>\n<p>Returns a single <code>Common.Address</code> by primary key. The parent must be a customer belonging to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/ById/{addressId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>addressId</em></td>\n<td>Required Guid. Primary key of the <code>Common.Address</code> row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","ById","{{address_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"91929acc-5539-41ff-ae39-fe6e8167e228"},{"name":"CustomerAddressAdd","id":"dcb6749e-7cf6-4a55-9c63-d7370300e20b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"addressType\": 1,\n    \"addrLine1\": \"123 Main St\",\n    \"addrLine2\": \"Apt 4\",\n    \"addrLine3\": null,\n    \"city\": \"Los Angeles\",\n    \"zipCode\": \"90001\",\n    \"provinceAbbreviation\": \"CA\",\n    \"primary\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Address/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"add-customer-address\">Add Customer Address</h3>\n<p>Inserts the Physical (<code>addressType=1</code>) or Mailing (<code>addressType=2</code>) address a customer does not have yet, using the same history/deactivation semantics as ViewAccount (<code>ApplyCustomerAddressChanges</code>). A customer carries one address of each type, so this is rejected when that type is already on file - change an existing address with PUT instead. Physical addresses are always primary. Adding a mailing address sets <code>IsBillAddressSameAsPrimary=false</code> when it was previously true. Provide either <code>provinceId</code> or <code>provinceAbbreviation</code>. The new address <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>addressType</em></td>\n<td>Required int. <code>1</code>=Physical, <code>2</code>=Mailing.</td>\n</tr>\n<tr>\n<td><em>addrLine1</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>addrLine2</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>addrLine3</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>city</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>zipCode</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>provinceId</em></td>\n<td>Optional Guid. Required if <code>provinceAbbreviation</code> is omitted.</td>\n</tr>\n<tr>\n<td><em>provinceAbbreviation</em></td>\n<td>Optional string (e.g. <code>CA</code>). Required if <code>provinceId</code> is omitted.</td>\n</tr>\n<tr>\n<td><em>primary</em></td>\n<td>Optional bool. Physical addresses are always primary; a mailing address can never be primary, so sending true on one is rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>One primary address</td>\n<td>The physical address is always the primary address and a mailing address never is, so sending <code>primary</code> as true on a mailing address is rejected.</td>\n</tr>\n<tr>\n<td>One address per type</td>\n<td>The screen has a single physical slot and a single mailing slot. Adding a second address of a type the customer already has is rejected - use PUT on the existing address, which keeps the previous values in address history.</td>\n</tr>\n<tr>\n<td>Address fields</td>\n<td>Lines and city are printable ASCII up to 50 characters.</td>\n</tr>\n<tr>\n<td>Zip code</td>\n<td>Follows the country's format: six alphanumerics for Canada, 5 or 10 digits for Mexico, 5 or 9 digits otherwise.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"dcb6749e-7cf6-4a55-9c63-d7370300e20b"},{"name":"CustomerAddressUpdate","id":"e5b0b2d4-a07d-49f6-bde2-be6e3dfdcc43","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"addrLine1\": \"456 Oak Ave\",\n    \"addrLine2\": null,\n    \"addrLine3\": null,\n    \"city\": \"San Diego\",\n    \"zipCode\": \"92101\",\n    \"provinceAbbreviation\": \"CA\",\n    \"primary\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Address/{{address_id}}?token={{token}}","description":"<h3 id=\"update-customer-address\">Update Customer Address</h3>\n<p>Updates an existing customer address identified by <code>addressId</code>. Active Physical/Mailing updates use ViewAccount history semantics: the prior row is deactivated and a <strong>new</strong> address Id is inserted. The response <code>data.id</code> is the new active address Guid (not the request path Id) after a history insert. Previous-address edits remain in place (<code>Active=false</code>). Provide either <code>provinceId</code> or <code>provinceAbbreviation</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/{addressId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>addressId</em></td>\n<td>Required Guid. Primary key of the address to update.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>addrLine1</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>addrLine2</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>addrLine3</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>city</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>zipCode</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>provinceId</em></td>\n<td>Optional Guid. Required if <code>provinceAbbreviation</code> is omitted.</td>\n</tr>\n<tr>\n<td><em>provinceAbbreviation</em></td>\n<td>Optional string. Required if <code>provinceId</code> is omitted.</td>\n</tr>\n<tr>\n<td><em>primary</em></td>\n<td>Optional bool. Physical addresses are always primary; a mailing address can never be primary, so sending true on one is rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>One primary address</td>\n<td>The physical address is always the primary address and a mailing address never is, so sending <code>primary</code> as true on a mailing address is rejected.</td>\n</tr>\n<tr>\n<td>Address fields</td>\n<td>Lines and city are printable ASCII up to 50 characters.</td>\n</tr>\n<tr>\n<td>Zip code</td>\n<td>Follows the country's format: six alphanumerics for Canada, 5 or 10 digits for Mexico, 5 or 9 digits otherwise.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","{{address_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"e5b0b2d4-a07d-49f6-bde2-be6e3dfdcc43"},{"name":"CustomerAddressDelete","id":"457e3528-9b00-40cb-969f-73911052e901","request":{"method":"DELETE","header":[],"url":"https://{{base_url}}/api/Client/Customer/Address/{{address_id}}?token={{token}}","description":"<h3 id=\"delete-customer-address\">Delete Customer Address</h3>\n<p>Deletes/deactivates a customer address by Id with ViewAccount semantics:</p>\n<ul>\n<li><p><strong>Active mailing</strong> — deactivate and set customer <code>IsBillAddressSameAsPrimary=true</code>\n(billing same as physical).</p>\n</li>\n<li><p><strong>Previous address</strong> — hard-remove via <code>DeleteAddressEntity</code>.</p>\n</li>\n<li><p><strong>Active physical</strong> — rejected; use PUT to replace the physical address.</p>\n</li>\n</ul>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/{addressId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>addressId</em></td>\n<td>Required Guid. Primary key of the address to delete/deactivate.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"behavior\">Behavior</h4>\n<p>The active physical address is the customer's primary address and Omega requires every customer to have one, so it cannot be deleted even as the last address on file. Change it instead with PUT, which keeps the old values in address history.\nDeleting the active mailing address sets <code>isBillAddressSameAsPrimary</code> on the customer, matching the screen. Previous-address rows are better maintained through <code>DELETE api/Client/Customer/Address/Previous/{customerIdOrNumber}</code>, which also clears the as-of date. #### Headers</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","{{address_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"457e3528-9b00-40cb-969f-73911052e901"},{"name":"CustomerPreviousAddressGet","id":"5eac0a4e-984a-42e5-bd8d-9179b85e2680","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Address/Previous/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-previous-address\">Get Customer Previous Address</h3>\n<p>Returns the customer entry screen's previous-address slot: the \"Set Previous Address\" block inside the Addresses group box. Omega stores it as a single inactive Physical <code>Common.Address</code> row flagged <code>PreviousAddress</code>, paired with <code>Common.Customer.PreviousAddressAsOfDate</code>, so both come back together along with the primary address as-of date for comparison.\n<code>hasPreviousAddress</code> is false and <code>address</code> is null when the customer has no previous address.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/Previous/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","Previous","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"5eac0a4e-984a-42e5-bd8d-9179b85e2680"},{"name":"CustomerPreviousAddressUpdate","id":"db073d91-44c2-4bf0-a179-c332303c042b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"addrLine1\": \"17 Elm Court\",\n    \"city\": \"Chula Vista\",\n    \"zipCode\": \"91910\",\n    \"provinceAbbreviation\": \"CA\",\n    \"previousAddressAsOfDate\": \"2018-03-01\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Address/Previous/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"set-customer-previous-address\">Set Customer Previous Address</h3>\n<p>Creates or replaces the customer's previous address together with its as-of date - the same write the screen performs when \"Set Previous Address\" is checked and the customer is saved. The row is stored inactive, as Physical with <code>PreviousAddress</code> set, which is why it is not reachable through the general <code>api/Client/Customer/Address</code> routes.\nMerge semantics: a field left out of the body keeps the stored value, so a follow-up call can change one line without resending the whole address. On a first call every required address field must be supplied.\nKeeps the screen's two guards: the as-of date is required whenever a previous address exists, and it cannot be later than the primary address as-of date.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/Previous/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>addrLine1</em></td>\n<td>Required on a first call, optional afterwards.</td>\n</tr>\n<tr>\n<td><em>addrLine2</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>addrLine3</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>city</em></td>\n<td>Required on a first call, optional afterwards.</td>\n</tr>\n<tr>\n<td><em>zipCode</em></td>\n<td>Required on a first call, optional afterwards.</td>\n</tr>\n<tr>\n<td><em>provinceId</em></td>\n<td>Optional Guid. Required on a first call unless <code>provinceAbbreviation</code> is sent.</td>\n</tr>\n<tr>\n<td><em>provinceAbbreviation</em></td>\n<td>Optional string, an alternative to <code>provinceId</code>.</td>\n</tr>\n<tr>\n<td><em>previousAddressAsOfDate</em></td>\n<td>Required unless already stored. Must be on or before the primary address as-of date.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>As-of date</td>\n<td>Required whenever a previous address exists, and never later than the primary address as-of date.</td>\n</tr>\n<tr>\n<td>Address fields</td>\n<td>Lines and city are printable ASCII up to 50 characters.</td>\n</tr>\n<tr>\n<td>Zip code</td>\n<td>Follows the country's format: six alphanumerics for Canada, 5 or 10 digits for Mexico, 5 or 9 digits otherwise.</td>\n</tr>\n<tr>\n<td>Merged values</td>\n<td>Format rules are applied to the fields you send, so a stored value that predates these rules does not block an unrelated edit.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","Previous","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"db073d91-44c2-4bf0-a179-c332303c042b"},{"name":"CustomerPreviousAddressDelete","id":"b6a30c72-b881-4f17-8199-1f2d86448c74","request":{"method":"DELETE","header":[],"url":"https://{{base_url}}/api/Client/Customer/Address/Previous/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"delete-customer-previous-address\">Delete Customer Previous Address</h3>\n<p>Removes the customer's previous address and clears <code>PreviousAddressAsOfDate</code>, the same result as clearing \"Set Previous Address\" on the screen and saving.\n<strong>HTTP Method:</strong> DELETE\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Address/Previous/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Address","Previous","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"b6a30c72-b881-4f17-8199-1f2d86448c74"},{"name":"CustomerEmployerDelete","id":"9bbcc84c-5c7c-4303-bf05-0d5589386337","request":{"method":"DELETE","header":[],"url":"https://{{base_url}}/api/Client/Customer/Employer/{{employer_id}}?token={{token}}","description":"<h3 id=\"delete-customer-employer\">Delete Customer Employer</h3>\n<p>Deletes an existing <code>Common.CustomerEmployer</code> row identified by the <code>employerId</code> route parameter. The controller (<code>CustomerEmployerController.DeleteCustomerEmployer</code>) validates the GUID and delegates to <code>CustomerEmployerWSServices.DeleteCustomerEmployerWS</code>. The WS layer fetches the existing row to obtain the latest <code>Ts</code> timestamp for optimistic concurrency, then calls <code>CustomerEmployerServices.DeleteCustomerEmployer</code> and commits via <code>UnitOfWork2</code>. The response <code>data</code> contains <code>Id</code> and <code>Deleted: true</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Employer/{employerId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>employerId</em></td>\n<td>Required Guid. Primary key of the <code>Common.CustomerEmployer</code> row to delete.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"behavior\">Behavior</h4>\n<p>Removes the employment row outright. Its address and phone number rows are deleted with it, the way removing an employer on the customer entry screen does, so nothing is left orphaned under the employer id.\nThis is separate from the active flag: an employer with an end date is a former employer and stays on the customer's employment history. Delete only when the row should not exist at all. #### Headers</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Employer","{{employer_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"960ee528-4ce8-4b8c-8cf1-029c77b749f3","name":"DeleteCustomerEmployer - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/11111111-1111-1111-1111-111111111111"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"11111111-1111-1111-1111-111111111111\",\n        \"Deleted\": true\n    }\n}"},{"id":"4dee750b-e1d3-44a7-b007-19381038214f","name":"DeleteCustomerEmployer - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/99999999-9999-9999-9999-999999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Employer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"9bbcc84c-5c7c-4303-bf05-0d5589386337"},{"name":"CustomerEmployersGetAll","id":"5b6f3448-fa61-4aa5-b031-03a5c4c189ea","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/{{customer_number_or_id}}","description":"<h3 id=\"get-all-customer-employers\">Get All Customer Employers</h3>\n<p>Returns every <code>Common.CustomerEmployer</code> row for the supplied customer. The controller (<code>CustomerEmployerController.GetAllCustomerEmployers</code>) resolves <code>customerIdOrNumber</code> (GUID <code>Id</code> or numeric <code>CustomerNumber</code>) via <code>SharedWSServices.GetCommonCustomerId</code>, then delegates to <code>CustomerEmployerWSServices.ReturnAllCustomerEmployersWS</code> which calls <code>CustomerEmployerServices.ReturnAllCustomerEmployers</code>. Each row is projected with <code>Id</code>, <code>CustomerId</code>, <code>EmployerName</code>, <code>StartDate</code>, <code>EndDate</code>, <code>IsActive</code>, <code>Salary</code>, <code>SalaryFrequency</code>, <code>SalaryHours</code>, <code>Occupation</code>, and a base64 <code>Ts</code> timestamp used for optimistic concurrency on update/delete.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Employer/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Employer","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4c938e1b-45d4-4d00-9351-354f76c37495","name":"GetAllCustomerEmployers - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/656"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-1111-1111-111111111111\",\n            \"CustomerId\": \"22222222-2222-2222-2222-222222222222\",\n            \"EmployerName\": \"ACME Corporation\",\n            \"StartDate\": \"2022-01-15T00:00:00\",\n            \"EndDate\": null,\n            \"IsActive\": true,\n            \"Salary\": 65000.00,\n            \"SalaryFrequency\": 2,\n            \"SalaryHours\": 40,\n            \"Occupation\": \"Software Engineer\",\n            \"Ts\": \"AAAAAAAAH3Y=\"\n        }\n    ]\n}"},{"id":"1af67d70-a9be-46d4-bc37-a5675bdb9b64","name":"GetAllCustomerEmployers - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Customer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"5b6f3448-fa61-4aa5-b031-03a5c4c189ea"},{"name":"CustomerEmployerUpdate","id":"c1c880f8-adcc-4cbc-b5ef-d35b54c4b3fa","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"employerName\": \"ACME Corporation (Promoted)\",\n    \"startDate\": \"2022-01-15\",\n    \"endDate\": null,\n    \"isActive\": true,\n    \"salary\": 75000.00,\n    \"salaryFrequency\": 2,\n    \"salaryHours\": 40,\n    \"occupation\": \"Senior Software Engineer\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Employer/{{employer_id}}?token={{token}}","description":"<h3 id=\"update-customer-employer\">Update Customer Employer</h3>\n<p>Updates an existing <code>Common.CustomerEmployer</code> row identified by the <code>employerId</code> route parameter. The controller (<code>CustomerEmployerController.UpdateCustomerEmployer</code>) validates the GUID and delegates to <code>CustomerEmployerWSServices.UpdateCustomerEmployerWS</code>. The WS layer fetches the existing row to obtain the latest <code>Ts</code> timestamp for optimistic concurrency, then calls <code>CustomerEmployerServices.SaveCustomerEmployer</code> and commits via <code>UnitOfWork2</code>. The body does <strong>not</strong> include <code>customerIdOrNumber</code> — the customer association cannot be changed via this endpoint.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Employer/{employerId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>employerId</em></td>\n<td>Required Guid. Primary key of the <code>Common.CustomerEmployer</code> row to update.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>employerName</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>startDate</em></td>\n<td>Optional DateTime. Employment start date.</td>\n</tr>\n<tr>\n<td><em>endDate</em></td>\n<td>Optional DateTime. Employment end date.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>salary</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>salaryFrequency</em></td>\n<td>Required int. <code>IncomePaymentFrequencyType</code> enum: 0=Unknown, 1=Daily, 2=Annually, 3=Semi_Annually, 4=Quarterly, 5=Monthly, 6=Semi_Monthly, 7=Bi_Weekly, 8=Weekly, 9=Hourly.</td>\n</tr>\n<tr>\n<td><em>salaryHours</em></td>\n<td>Optional int. Hours per pay period.</td>\n</tr>\n<tr>\n<td><em>occupation</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>address</em></td>\n<td>Optional object for the employer's single address: <code>addrLine1</code>, <code>addrLine2</code>, <code>addrLine3</code>, <code>city</code>, <code>zipCode</code>, either <code>provinceId</code> or <code>provinceAbbreviation</code>, and an optional <code>addressType</code>. Omit the object to leave the stored address alone.</td>\n</tr>\n<tr>\n<td><em>phone</em></td>\n<td>Optional object for the employer's single Work phone number: <code>phoneNumber</code>. Send an empty string to remove it, or omit the object to leave it alone.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Employer name and start date</td>\n<td>Both must be supplied together, matching <code>EmployerRequiredFields_CustomValidation1</code> on the screen.</td>\n</tr>\n<tr>\n<td>Active</td>\n<td>Derived from the end date - an employer with an end date is inactive. The <code>isActive</code> field in the body is ignored. It marks a current versus a former employer and is not a soft delete: the employment row is kept either way. Use <code>DELETE api/Client/Customer/Employer/{employerId}</code> to remove an employer.</td>\n</tr>\n<tr>\n<td>End date</td>\n<td>Cannot be earlier than the start date.</td>\n</tr>\n<tr>\n<td>Name and occupation</td>\n<td>Printable ASCII, 50 characters.</td>\n</tr>\n<tr>\n<td>Salary and hours</td>\n<td>Salary is zero or greater; salary hours are 0 to 168 and only stored when the frequency is Hourly.</td>\n</tr>\n<tr>\n<td>Employer address</td>\n<td>One per employer, and always primary for that employer - the screen sets it unconditionally, so there is no primary flag to send. Lines and city are printable ASCII up to 50 characters and the zip code follows the country's format.</td>\n</tr>\n<tr>\n<td>Employer phone</td>\n<td>One per employer, always typed Work and always primary for that employer - the screen hides both options. Send an empty <code>phoneNumber</code> to remove it.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Employer","{{employer_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6f38ea70-8b78-4846-aadb-1c4c9872f0b5","name":"UpdateCustomerEmployer - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"employerName\": \"ACME Corporation (Promoted)\",\n    \"startDate\": \"2022-01-15\",\n    \"endDate\": null,\n    \"isActive\": true,\n    \"salary\": 75000.00,\n    \"salaryFrequency\": 2,\n    \"salaryHours\": 40,\n    \"occupation\": \"Senior Software Engineer\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Employer/11111111-1111-1111-1111-111111111111"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"11111111-1111-1111-1111-111111111111\"\n    }\n}"},{"id":"92940638-c5f6-45ee-9064-84e44f575478","name":"UpdateCustomerEmployer - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"employerName\": \"ACME Corporation (Promoted)\",\n    \"startDate\": \"2022-01-15\",\n    \"endDate\": null,\n    \"isActive\": true,\n    \"salary\": 75000.00,\n    \"salaryFrequency\": 2,\n    \"salaryHours\": 40,\n    \"occupation\": \"Senior Software Engineer\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Employer/99999999-9999-9999-9999-999999999999"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Employer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"c1c880f8-adcc-4cbc-b5ef-d35b54c4b3fa"},{"name":"CustomerOtherIncomeAdd","id":"8c971058-43cf-45fd-96fb-64fe7ce5de60","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"source\": \"Rental Property\",\n    \"frequency\": 5,\n    \"amount\": 1500.00,\n    \"hours\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/OtherIncome?token={{token}}","description":"<h3 id=\"add-customer-other-income\">Add Customer Other Income</h3>\n<p>Inserts a new <code>Common.CustomerOtherIncome</code> row for the specified customer. The controller (<code>CustomerOtherIncomeController.AddCustomerOtherIncome</code>) resolves <code>customerIdOrNumber</code> to the underlying <code>Common.Customer.Id</code> via <code>SharedWSServices.GetCommonCustomerId</code>, then delegates to <code>CustomerOtherIncomeWSServices.AddCustomerOtherIncomeWS</code> which calls <code>CustomerOtherIncomeServices.AddCustomerOtherIncome</code> and commits via <code>UnitOfWork2</code>. The new <code>Id</code> is returned in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/OtherIncome</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n<tr>\n<td><em>source</em></td>\n<td>Required string. Income source description (e.g., \"Rental Property\").</td>\n</tr>\n<tr>\n<td><em>frequency</em></td>\n<td>Required int. <code>IncomePaymentFrequencyType</code> enum: 0=Unknown, 1=Daily, 2=Annually, 3=Semi_Annually, 4=Quarterly, 5=Monthly, 6=Semi_Monthly, 7=Bi_Weekly, 8=Weekly, 9=Hourly.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal. Income amount per <code>frequency</code> interval.</td>\n</tr>\n<tr>\n<td><em>hours</em></td>\n<td>Optional int. Hours per interval (used for Hourly frequency).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Source</td>\n<td>Required, printable ASCII, 50 characters.</td>\n</tr>\n<tr>\n<td>Amount</td>\n<td>Zero or greater.</td>\n</tr>\n<tr>\n<td>Frequency</td>\n<td>Must be a defined <code>IncomePaymentFrequencyType</code>.</td>\n</tr>\n<tr>\n<td>Hours</td>\n<td>0 to 168, and only stored when the frequency is Hourly - the screen shows the hours box for Hourly income only.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","OtherIncome"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"3d08882b-55bb-4b56-8f5e-98c8a9683316","name":"AddCustomerOtherIncome - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"656\",\n    \"source\": \"Rental Property\",\n    \"frequency\": 5,\n    \"amount\": 1500.00,\n    \"hours\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/OtherIncome"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"33333333-3333-3333-3333-333333333333\"\n    }\n}"},{"id":"384f03b5-4c34-4ef5-98de-3b69883e37d3","name":"AddCustomerOtherIncome - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"999999999\",\n    \"source\": \"Rental Property\",\n    \"frequency\": 5,\n    \"amount\": 1500.00,\n    \"hours\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/OtherIncome"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Customer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"8c971058-43cf-45fd-96fb-64fe7ce5de60"},{"name":"CustomerOtherIncomeDelete","id":"16e5ecbc-daa2-4035-a2e9-9979e2618063","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/{{other_income_id}}","description":"<h3 id=\"delete-customer-other-income\">Delete Customer Other Income</h3>\n<p>Deletes an existing <code>Common.CustomerOtherIncome</code> row identified by the <code>otherIncomeId</code> route parameter. The controller (<code>CustomerOtherIncomeController.DeleteCustomerOtherIncome</code>) validates the GUID and delegates to <code>CustomerOtherIncomeWSServices.DeleteCustomerOtherIncomeWS</code>. The WS layer fetches the existing row to obtain the latest <code>Ts</code> timestamp for optimistic concurrency, then calls <code>CustomerOtherIncomeServices.DeleteCustomerOtherIncome</code> and commits via <code>UnitOfWork2</code>. The response <code>data</code> contains <code>Id</code> and <code>Deleted: true</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/OtherIncome/{otherIncomeId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>otherIncomeId</em></td>\n<td>Required Guid. Primary key of the <code>Common.CustomerOtherIncome</code> row to delete.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","OtherIncome","{{other_income_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a94b9244-2c4c-488e-bdf8-e9fbd06dcbc1","name":"DeleteCustomerOtherIncome - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/33333333-3333-3333-3333-333333333333"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"33333333-3333-3333-3333-333333333333\",\n        \"Deleted\": true\n    }\n}"},{"id":"f0b60ab4-01b0-4947-826f-d0d64a613c3b","name":"DeleteCustomerOtherIncome - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/not-a-guid"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid other income ID format\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"16e5ecbc-daa2-4035-a2e9-9979e2618063"},{"name":"CustomerOtherIncomeUpdate","id":"ab83dba2-d10e-4337-b78b-26dbd7711a9c","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"source\": \"Rental Property (Updated)\",\n    \"frequency\": 5,\n    \"amount\": 1750.00,\n    \"hours\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/{{other_income_id}}?token={{token}}","description":"<h3 id=\"update-customer-other-income\">Update Customer Other Income</h3>\n<p>Updates an existing <code>Common.CustomerOtherIncome</code> row identified by the <code>otherIncomeId</code> route parameter. The controller (<code>CustomerOtherIncomeController.UpdateCustomerOtherIncome</code>) validates the GUID and resolves <code>customerIdOrNumber</code> from the body via <code>SharedWSServices.GetCommonCustomerId</code>, then delegates to <code>CustomerOtherIncomeWSServices.UpdateCustomerOtherIncomeWS</code>. The WS layer fetches the existing row to obtain the latest <code>Ts</code> timestamp for optimistic concurrency, then calls <code>CustomerOtherIncomeServices.SaveCustomerOtherIncome</code> and commits via <code>UnitOfWork2</code>. Note: unlike <code>Update Customer Employer</code>, <code>customerIdOrNumber</code> IS required in the body because the underlying save method also accepts <code>customerId</code> and may re-associate the row.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/OtherIncome/{otherIncomeId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>otherIncomeId</em></td>\n<td>Required Guid. Primary key of the <code>Common.CustomerOtherIncome</code> row to update.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n<tr>\n<td><em>source</em></td>\n<td>Required string. Income source description.</td>\n</tr>\n<tr>\n<td><em>frequency</em></td>\n<td>Required int. <code>IncomePaymentFrequencyType</code> enum: 0=Unknown, 1=Daily, 2=Annually, 3=Semi_Annually, 4=Quarterly, 5=Monthly, 6=Semi_Monthly, 7=Bi_Weekly, 8=Weekly, 9=Hourly.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal.</td>\n</tr>\n<tr>\n<td><em>hours</em></td>\n<td>Optional int.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Source</td>\n<td>Required, printable ASCII, 50 characters.</td>\n</tr>\n<tr>\n<td>Amount</td>\n<td>Zero or greater.</td>\n</tr>\n<tr>\n<td>Frequency</td>\n<td>Must be a defined <code>IncomePaymentFrequencyType</code>.</td>\n</tr>\n<tr>\n<td>Hours</td>\n<td>0 to 168, and only stored when the frequency is Hourly - the screen shows the hours box for Hourly income only.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","OtherIncome","{{other_income_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"084aa1fe-1143-4396-b813-e5618c873d15","name":"UpdateCustomerOtherIncome - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"656\",\n    \"source\": \"Rental Property (Updated)\",\n    \"frequency\": 5,\n    \"amount\": 1750.00,\n    \"hours\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/33333333-3333-3333-3333-333333333333"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"33333333-3333-3333-3333-333333333333\"\n    }\n}"},{"id":"5e7121ff-0d60-47cb-ad8f-69135415f6f1","name":"UpdateCustomerOtherIncome - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"customerIdOrNumber\": \"999999999\",\n    \"source\": \"Rental Property (Updated)\",\n    \"frequency\": 5,\n    \"amount\": 1750.00,\n    \"hours\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/33333333-3333-3333-3333-333333333333"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Customer not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"ab83dba2-d10e-4337-b78b-26dbd7711a9c"},{"name":"CustomerSummaryGet","id":"c656e9a3-9baa-4e73-b08e-bed924478bc1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\":\"{{account_number}}\",\n\t\"include_all_active_borrowers\":\"{{include_all_active_borrowers}}\"\n}\n","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/customer/GetCustomerSummary","description":"<p>This method is used to get the summary details for the primary or all borrowers on an account.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. The authentication token assigned to you by the Login method</td>\n</tr>\n<tr>\n<td><em>account_number</em></td>\n<td>Required int64. Omega account number</td>\n</tr>\n<tr>\n<td><em>include_all_active_borrowers</em></td>\n<td>Required boolean. Return primary customer only or all active borrowers</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","client","customer","GetCustomerSummary"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c6e0fc63-191c-4305-94b7-99fe95c4f055","name":"GetCustomerSummary - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\":\"{{account_number}}\",\n\t\"include_all_active_borrowers\":\"{{include_all_active_borrowers}}\"\n}\n","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/customer/GetCustomerSummary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcV29ya3NwYWNlXFZTIDIwMTlcUmVwb3Ncb21lZ2FcT21lZ2EuV2ViQXBwXGFwaVxjbGllbnRcR2V0Q3VzdG9tZXJTdW1tYXJ5?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 30 Nov 2021 19:58:09 GMT"},{"key":"Content-Length","value":"347"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"GetCustomerSummary\": {\n            \"Borrower\": [\n                {\n                    \"CustomerNumber\": \"656\",\n                    \"BorrowerType\": \"Primary_Customer\",\n                    \"FirstName\": \"John\",\n                    \"LastName\": \"Doe\",\n                    \"SocialSecurityNumberLast4\": \"1111\",\n                    \"Birthday\": \"07/29/1997\",\n                    \"Email\": \"JohnDoe123@megasys.net\",\n                    \"DriversLicenseNumber\": \"D244233\",\n                    \"PrimaryPhoneNumber\": \"(714) 952-4490\",\n                    \"MilitaryActiveDuty\": \"False\"\n                },\n                {\n                    \"CustomerNumber\": \"538\",\n                    \"BorrowerType\": \"Co_Signer\",\n                    \"FirstName\": \"Hallie\",\n                    \"LastName\": \"Auer\",\n                    \"SocialSecurityNumberLast4\": \"4730\",\n                    \"Birthday\": \"09/12/1991\",\n                    \"Email\": null,\n                    \"DriversLicenseNumber\": \"Z446614\",\n                    \"PrimaryPhoneNumber\": \"(477) 773-8622\",\n                    \"MilitaryActiveDuty\": \"False\"\n                }\n            ]\n        }\n    },\n    \"errors\": []\n}"},{"id":"31f2d8b0-2512-4b42-a4d9-234c160a2be5","name":"GetCustomerSummary - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"token\":\"{{token}}\",\n\t\"account_number\":\"{{account_number}}\",\n\t\"include_all_active_borrowers\":\"{{include_all_active_borrowers}}\"\n}\n","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/client/customer/GetCustomerSummary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-StackifyID","value":"V2|fadc2aa0-2817-40a8-b826-bad8a6727a6b|C72862|CD33"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 13 Dec 2022 21:51:25 GMT"},{"key":"Content-Length","value":"161"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error fetching customers: Your authentication token is invalid or has expired. Call the Login method to retrieve a new token.\"\n    ]\n}"}],"_postman_id":"c656e9a3-9baa-4e73-b08e-bed924478bc1"},{"name":"MostRecentCustomerEmployerGet","id":"20b1aa4a-61b3-45ee-8314-ba7b3938d35b","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/{{customer_number_or_id}}/MostRecent","description":"<h3 id=\"get-most-recent-customer-employer\">Get Most Recent Customer Employer</h3>\n<p>Returns the most recent <code>Common.CustomerEmployer</code> row for the supplied customer (typically the active employer with the latest <code>StartDate</code>). The controller (<code>CustomerEmployerController.GetMostRecentCustomerEmployer</code>) resolves <code>customerIdOrNumber</code> (GUID <code>Id</code> or numeric <code>CustomerNumber</code>) via <code>SharedWSServices.GetCommonCustomerId</code>, then delegates to <code>CustomerEmployerWSServices.ReturnMostRecentCustomerEmployerWS</code> which calls <code>CustomerEmployerServices.ReturnCustomerMostRecentEmployer</code>. Returns a single object (not an array). If the customer has no employer rows the response is a 400 with <code>errors: [\"No employer found for this customer\"]</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Employer/{customerIdOrNumber}/MostRecent</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Employer","{{customer_number_or_id}}","MostRecent"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d80892c2-a4f6-465e-ba5c-485bfbdaf8d6","name":"GetMostRecentCustomerEmployer - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/656/MostRecent"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"11111111-1111-1111-1111-111111111111\",\n        \"CustomerId\": \"22222222-2222-2222-2222-222222222222\",\n        \"EmployerName\": \"ACME Corporation\",\n        \"StartDate\": \"2022-01-15T00:00:00\",\n        \"EndDate\": null,\n        \"IsActive\": true,\n        \"Salary\": 65000.00,\n        \"SalaryFrequency\": 2,\n        \"SalaryHours\": 40,\n        \"Occupation\": \"Software Engineer\",\n        \"Ts\": \"AAAAAAAAH3Y=\"\n    }\n}"},{"id":"1f1b151d-6451-4a5f-ae63-4cee15793e69","name":"GetMostRecentCustomerEmployer - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Customer/Employer/656/MostRecent"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"No employer found for this customer\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"20b1aa4a-61b3-45ee-8314-ba7b3938d35b"},{"name":"CustomerInformationGet","id":"4ac9add6-7184-4a1d-b20f-24fe5e81186a","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Information/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-information-all-fields\">Get Customer Information (all fields)</h3>\n<p>Returns the whole <code>Common.Customer</code> record in one response - every field the five per-group routes return, nested under <code>general</code>, <code>residence</code>, <code>timeZone</code>, <code>communication</code> and <code>expense</code>.\nOne customer fetch instead of five, and the province, home branch and time zone lookups are done once rather than repeated per group route.\nChild records are not included. Addresses, phone numbers, references, employers and other income are collections with their own add/update/delete semantics, so they keep their own endpoints.\nThe full social security number is deliberately never returned - only <code>socialSecurityNumberLast4</code>. Updates use merge semantics, so it never has to be round-tripped.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Information/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Group</strong></th>\n<th><strong>Contents</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>(top level)</em></td>\n<td><code>id</code>, <code>customerNumber</code>, <code>ts</code>.</td>\n</tr>\n<tr>\n<td><em>general</em></td>\n<td>Identity and demographics from the General group box, plus <code>languageCode</code> and <code>numberOfDependents</code>. Enum fields carry a matching <code>*Description</code>.</td>\n</tr>\n<tr>\n<td><em>residence</em></td>\n<td><code>primaryAddressAsOfDate</code>, <code>previousAddressAsOfDate</code>, <code>isBillAddressSameAsPrimary</code>.</td>\n</tr>\n<tr>\n<td><em>timeZone</em></td>\n<td><code>timeZoneId</code>, <code>timeZoneCode</code>, <code>timeZoneDescription</code>, <code>callAfterTime</code>, <code>callBeforeTime</code>.</td>\n</tr>\n<tr>\n<td><em>communication</em></td>\n<td><code>emailAddress</code>, <code>emailOk</code> (read only - set by the unsubscribe handling), the five <code>allow*</code> flags, and <code>defaultTransmissionType</code>.</td>\n</tr>\n<tr>\n<td><em>expense</em></td>\n<td><code>expenseRent</code>, <code>expenseUtilities</code>, <code>expenseOther</code>, <code>expenseOtherDescription</code>, <code>expenseCreditBureau</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Information","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"4ac9add6-7184-4a1d-b20f-24fe5e81186a"},{"name":"CustomerInformationUpdate","id":"475f3d6f-5a96-4ee9-87e3-9daf9c2bad03","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"general\": {\n        \"firstName\": \"Jordan\",\n        \"middleName\": \"A\",\n        \"lastName\": \"Reyes\",\n        \"suffix\": 1,\n        \"maritalStatus\": 2,\n        \"isHomeOwner\": true,\n        \"numberOfDependents\": 2,\n        \"languageCode\": 1,\n        \"driversLicenseNumber\": \"D1234567\",\n        \"driversLicenseProvinceAbbreviation\": \"CA\",\n        \"driversLicenseExpirationDate\": \"2029-04-30\"\n    },\n    \"residence\": {\n        \"primaryAddressAsOfDate\": \"2023-06-01\",\n        \"previousAddressAsOfDate\": \"2018-09-01\"\n    },\n    \"timeZone\": {\n        \"timeZoneCode\": \"PST\",\n        \"callAfterTime\": \"08:00\",\n        \"callBeforeTime\": \"20:00\"\n    },\n    \"communication\": {\n        \"emailAddress\": \"jordan.reyes@example.com\",\n        \"allowBilling\": true,\n        \"allowLate\": true,\n        \"allowTransactions\": true,\n        \"allowPayments\": true,\n        \"defaultTransmissionType\": 1\n    },\n    \"expense\": {\n        \"expenseRent\": 1850.00,\n        \"expenseUtilities\": 240.00,\n        \"expenseOther\": 325.00,\n        \"expenseOtherDescription\": \"Storage unit\"\n    }\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Information/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"update-customer-information-all-fields\">Update Customer Information (all fields)</h3>\n<p>Updates every customer field in one call - what the customer entry screen's Save does for the <code>Common.Customer</code> record, instead of the five separate PUTs it would otherwise take.</p>\n<h4 id=\"why-this-exists\">Why this exists</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th></th>\n<th>Five per-group PUTs</th>\n<th>This route</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Customer fetches</td>\n<td>5</td>\n<td><strong>1</strong></td>\n</tr>\n<tr>\n<td>Commits</td>\n<td>5</td>\n<td><strong>1</strong></td>\n</tr>\n<tr>\n<td><code>Account_Change_Customer_Information</code> log rows</td>\n<td>up to 5</td>\n<td><strong>1</strong></td>\n</tr>\n<tr>\n<td>Veritec re-report decisions</td>\n<td>up to 5</td>\n<td><strong>1</strong></td>\n</tr>\n<tr>\n<td>Partially applied on a validation failure</td>\n<td>possible</td>\n<td><strong>no</strong></td>\n</tr>\n<tr>\n<td>Validation is identical to the per-group routes because the same appliers run - the field rules, the messages and the screen-parity guards are one copy of the code, not two.</td>\n<td></td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"semantics\">Semantics</h4>\n<p>Supply the groups you want changed. Omit a group and none of its fields are touched; inside a supplied group the usual merge semantics apply, so a property left out (or sent as <code>null</code>) is not changed, and each nullable value the screen can blank has its matching <code>clear*</code> flag.\nNothing is written unless every supplied group validates. The appliers run against the in-memory customer and the first failure returns before the commit, so a request carrying one bad field does not half-apply the rest. The error names the group it came from, for example <code>residence: Previous address as of date must be less than the primary address as of date</code>.\nThe groups are independent - none of them writes a field another one reads - so sending several together gives the same result as sending them one at a time, just in one transaction instead of five.\nChild records are not here. Addresses, phone numbers, references, employers and other income are collections with their own add/update/delete semantics and their own endpoints.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Information/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>At least one group is required.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>general</em></td>\n<td>Identity and demographics. Same body as <code>PUT api/Client/Customer/General/{customerIdOrNumber}</code> - see that request for every field and its rules.</td>\n</tr>\n<tr>\n<td><em>residence</em></td>\n<td>As-of dates and the mailing-same-as-physical flag. Same body as <code>PUT .../Residence/{customerIdOrNumber}</code>.</td>\n</tr>\n<tr>\n<td><em>timeZone</em></td>\n<td>Time zone plus call-between times. Same body as <code>PUT .../TimeZone/{customerIdOrNumber}</code>.</td>\n</tr>\n<tr>\n<td><em>communication</em></td>\n<td>E-mail address and delivery preferences. Same body as <code>PUT .../Communication/{customerIdOrNumber}</code>.</td>\n</tr>\n<tr>\n<td><em>expense</em></td>\n<td>Expense amounts. Same body as <code>PUT .../Expense/{customerIdOrNumber}</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation-highlights\">Validation highlights</h4>\n<p>Every rule the per-group routes enforce still applies. The ones most often hit:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Group</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>SSN is nine digits, clearable only when the client does not require one, never a duplicate unless the client allows duplicates</td>\n<td>general</td>\n</tr>\n<tr>\n<td>Name fields accept letters, numbers, spaces and hyphens only</td>\n<td>general</td>\n</tr>\n<tr>\n<td>Previous address as-of date can never be later than the primary one</td>\n<td>residence</td>\n</tr>\n<tr>\n<td>Setting <code>isBillAddressSameAsPrimary</code> true is refused while an active mailing address is on file</td>\n<td>residence</td>\n</tr>\n<tr>\n<td>Both call times go together and sit inside the time zone's window</td>\n<td>timeZone</td>\n</tr>\n<tr>\n<td>EMail delivery needs an address the customer has not opted out of; fax delivery needs a fax number; <code>allowPayments</code> implies <code>allowTransactions</code></td>\n<td>communication</td>\n</tr>\n<tr>\n<td>Money fields are zero or greater</td>\n<td>expense</td>\n</tr>\n<tr>\n<td>Changing SSN, first name or last name queues a Veritec customer update when the client reports to Veritec - once for the whole request, not once per group.</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Information","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"475f3d6f-5a96-4ee9-87e3-9daf9c2bad03"},{"name":"CustomerGeneralGet","id":"82395b2d-abbe-4599-b9b4-100c3f519d12","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/General/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-general-information\">Get Customer General Information</h3>\n<p>Returns the <code>Common.Customer</code> identity and demographic fields from the General group box of the customer entry screen, plus the Language and Dependents fields shown alongside it. Includes the resolved driver's license province abbreviation and the home branch number and name.\nThe full social security number is deliberately <strong>not</strong> returned - only <code>socialSecurityNumberLast4</code>. Updates merge, so the SSN never has to be round-tripped.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/General/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","General","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"82395b2d-abbe-4599-b9b4-100c3f519d12"},{"name":"CustomerGeneralUpdate","id":"2a5b16ce-a6ec-4a72-8bec-dac2bbaf37bd","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"firstName\": \"Jordan\",\n    \"middleName\": \"A\",\n    \"lastName\": \"Reyes\",\n    \"suffix\": 1,\n    \"maritalStatus\": 2,\n    \"isHomeOwner\": true,\n    \"numberOfDependents\": 2,\n    \"driversLicenseNumber\": \"D1234567\",\n    \"driversLicenseProvinceAbbreviation\": \"CA\",\n    \"driversLicenseExpirationDate\": \"2029-04-30\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/General/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"update-customer-general-information\">Update Customer General Information</h3>\n<p>Updates the <code>Common.Customer</code> identity and demographic fields from the General group box of the customer entry screen. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag.\nKeeps the screen's rules: a changed SSN is checked for duplicates unless the client allows duplicate SSNs, <code>socialSecurityNumberLast4</code> is recalculated, and a change to SSN, first name or last name queues a Veritec customer update when the client reports to Veritec.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/General/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>socialSecurityNumber</em></td>\n<td>Optional string. Send <code>\"\"</code> to clear. Checked for duplicates.</td>\n</tr>\n<tr>\n<td><em>ssnCountryCode</em></td>\n<td>Optional int.</td>\n</tr>\n<tr>\n<td><em>firstName</em></td>\n<td>Optional string. Cannot be set blank.</td>\n</tr>\n<tr>\n<td><em>middleName</em></td>\n<td>Optional string. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>lastName</em></td>\n<td>Optional string. Cannot be set blank.</td>\n</tr>\n<tr>\n<td><em>akaName</em></td>\n<td>Optional string. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>suffix</em></td>\n<td>Optional int. <code>Omega.Common.Types.Enums.Suffix</code> (1 Blank, 2 Jr, 3 Sr, 12 I, 4 II, 5 III, 6 IV, 7 V, 8 VI, 9 VII, 10 VIII, 11 IX).</td>\n</tr>\n<tr>\n<td><em>driversLicenseNumber</em></td>\n<td>Optional string. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>driversLicenseProvinceId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>driversLicenseProvinceAbbreviation</em></td>\n<td>Optional string, an alternative to <code>driversLicenseProvinceId</code>.</td>\n</tr>\n<tr>\n<td><em>clearDriversLicenseProvince</em></td>\n<td>Optional bool. Removes the license province.</td>\n</tr>\n<tr>\n<td><em>driversLicenseExpirationDate</em></td>\n<td>Optional date.</td>\n</tr>\n<tr>\n<td><em>clearDriversLicenseExpirationDate</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>birthday</em></td>\n<td>Optional date.</td>\n</tr>\n<tr>\n<td><em>clearBirthday</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>sex</em></td>\n<td>Optional int. <code>Gender</code> (1 Male, 2 Female, 3 Not Selected).</td>\n</tr>\n<tr>\n<td><em>maritalStatus</em></td>\n<td>Optional int. <code>MaritalStatuses</code> (1 Single, 2 Married, 3 Domestic Partnership, 4 Other, 5 Not Selected, 6 Separated).</td>\n</tr>\n<tr>\n<td><em>isHomeOwner</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>lastOfacCheckDate</em></td>\n<td>Optional date.</td>\n</tr>\n<tr>\n<td><em>clearLastOfacCheckDate</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>languageCode</em></td>\n<td>Optional int. <code>UserLanguageTypes</code> (1 English, 2 Spanish, 3 French).</td>\n</tr>\n<tr>\n<td><em>numberOfDependents</em></td>\n<td>Optional int, zero or more.</td>\n</tr>\n<tr>\n<td><em>clearNumberOfDependents</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>homeBranchId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>homeBranchNumber</em></td>\n<td>Optional int, an alternative to <code>homeBranchId</code>.</td>\n</tr>\n<tr>\n<td><em>clearHomeBranch</em></td>\n<td>Optional bool.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<p>Mirrors the customer entry screen's own input rules:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Social security number</td>\n<td>Nine digits, with or without dashes, stored unformatted. Whether it can be cleared with an empty string follows the client's <code>ExternalMasterConfiguration.RequireCustomerSsn</code>, the same setting <code>CustomerServices.AddSaveCustomer</code> checks.</td>\n</tr>\n<tr>\n<td>Name characters</td>\n<td><code>firstName</code>, <code>middleName</code>, <code>lastName</code> and <code>akaName</code> accept letters, numbers, spaces and hyphens only.</td>\n</tr>\n<tr>\n<td>Driver's licence number</td>\n<td>Printable ASCII, 20 characters.</td>\n</tr>\n<tr>\n<td>Dependents</td>\n<td>0 to 999.</td>\n</tr>\n<tr>\n<td>Duplicate SSN</td>\n<td>Rejected unless the client's master configuration allows duplicate SSNs (<code>CheckExistingCustomerByWholeSSN</code> honours <code>AllowDuplicateSsn</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","General","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"2a5b16ce-a6ec-4a72-8bec-dac2bbaf37bd"},{"name":"CustomerResidenceGet","id":"3dd2b077-1e96-4736-9d9b-6f29cdeab1e8","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Residence/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-residence-dates\">Get Customer Residence Dates</h3>\n<p>Returns the residence-timeline values from the Addresses group box of the customer entry screen: the primary address as-of date, the previous address as-of date, and whether the mailing address is the same as the physical address. The address rows themselves are maintained through <code>api/Client/Customer/Address</code>.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Residence/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Residence","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"3dd2b077-1e96-4736-9d9b-6f29cdeab1e8"},{"name":"CustomerResidenceUpdate","id":"41023421-4f8c-4727-aa8e-fcefa7e53769","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"primaryAddressAsOfDate\": \"2021-06-01\",\n    \"previousAddressAsOfDate\": \"2018-03-01\",\n    \"isBillAddressSameAsPrimary\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Residence/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"update-customer-residence-dates\">Update Customer Residence Dates</h3>\n<p>Updates the residence-timeline values from the Addresses group box. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag.\nKeeps the screen's guard that the previous address as-of date cannot be later than the primary address as-of date.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Residence/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>primaryAddressAsOfDate</em></td>\n<td>Optional date. When the customer moved to the current physical address.</td>\n</tr>\n<tr>\n<td><em>previousAddressAsOfDate</em></td>\n<td>Optional date. Must be on or before <code>primaryAddressAsOfDate</code>.</td>\n</tr>\n<tr>\n<td><em>clearPreviousAddressAsOfDate</em></td>\n<td>Optional bool. Removes the previous address as-of date.</td>\n</tr>\n<tr>\n<td><em>isBillAddressSameAsPrimary</em></td>\n<td>Optional bool. Mailing address matches the physical address.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Previous address as-of date</td>\n<td>Never later than the primary address as-of date.</td>\n</tr>\n<tr>\n<td>Mailing address flag</td>\n<td>Setting <code>isBillAddressSameAsPrimary</code> to true while an active mailing address is on file is rejected; delete the mailing address first, the way checking the box on the screen removes it.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Residence","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"41023421-4f8c-4727-aa8e-fcefa7e53769"},{"name":"CustomerTimeZoneGet","id":"09ba76de-868e-40f7-a0c5-67730ed1cf31","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/TimeZone/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-time-zone\">Get Customer Time Zone</h3>\n<p>Returns the Time Zone group box values from the customer entry screen: the assigned time zone (id, code and description) and the call-between times, formatted as <code>HH:mm:ss</code>.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/TimeZone/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","TimeZone","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"09ba76de-868e-40f7-a0c5-67730ed1cf31"},{"name":"CustomerTimeZoneUpdate","id":"f80b3bad-a8ef-47d1-a77a-59b4b52bc20e","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"timeZoneCode\": \"PST\",\n    \"useTimeZoneCallBetweenTimes\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/TimeZone/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"update-customer-time-zone\">Update Customer Time Zone</h3>\n<p>Sets one customer's time zone and call-between times. This is the per-customer REST form of the bulk <code>api/Client/Customer/UpdateCustomers</code> time zone operation. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag.\nKeeps the screen's rules: clearing the time zone also clears both call times, and while a time zone is set both call times must be present together.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/TimeZone/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>timeZoneId</em></td>\n<td>Optional Guid of a <code>Common.TimeZone</code> row for this client.</td>\n</tr>\n<tr>\n<td><em>timeZoneCode</em></td>\n<td>Optional string, an alternative to <code>timeZoneId</code> (for example <code>PST</code>).</td>\n</tr>\n<tr>\n<td><em>clearTimeZone</em></td>\n<td>Optional bool. Removes the time zone and both call times.</td>\n</tr>\n<tr>\n<td><em>callAfterTime</em></td>\n<td>Optional string, <code>HH:mm</code> or <code>HH:mm:ss</code>. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>callBeforeTime</em></td>\n<td>Optional string, <code>HH:mm</code> or <code>HH:mm:ss</code>. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>useTimeZoneCallBetweenTimes</em></td>\n<td>Optional bool. Copies both call times off the selected time zone instead of supplying them.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<p>Mirrors the screen's Time Zone save path:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Both times together</td>\n<td>With a time zone set, both call times must be present.</td>\n</tr>\n<tr>\n<td>Default window</td>\n<td>When neither call time is stored or supplied, the time zone's own window is copied in, the way the screen does.</td>\n</tr>\n<tr>\n<td>Within the time zone window</td>\n<td>The customer's call window is checked against the time zone's allowed window (<code>CustomerServices.ValidateCustomerTimeZoneRestriction</code>).</td>\n</tr>\n<tr>\n<td>Clearing</td>\n<td><code>clearTimeZone</code> removes the time zone and both call times together.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","TimeZone","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"f80b3bad-a8ef-47d1-a77a-59b4b52bc20e"},{"name":"CustomerCommunicationGet","id":"0eb798b8-0dd8-45b0-8633-b4634db3b329","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Communication/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-communication-preferences\">Get Customer Communication Preferences</h3>\n<p>Returns the customer entry screen's e-mail row together with its Advanced group box: the e-mail address and its Email OK flag, the allow-billing / late / general-letters / transactions / payments flags, the default transmission method, and the customer portal delivery method.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Communication/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Communication","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"0eb798b8-0dd8-45b0-8633-b4634db3b329"},{"name":"CustomerCommunicationUpdate","id":"a7ce417d-0885-4d03-a6a1-a22484eebaae","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"emailAddress\": \"jordan.reyes@example.com\",\n    \"allowBilling\": true,\n    \"allowLate\": true,\n    \"allowGeneralLetters\": true,\n    \"allowPayments\": true,\n    \"defaultTransmissionType\": 1,\n    \"customerPortalDeliveryMethod\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Communication/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"update-customer-communication-preferences\">Update Customer Communication Preferences</h3>\n<p>Updates the e-mail address and the Advanced group box delivery preferences. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag.\nEmail OK is display only on the screen (the unsubscribe and bounce handling owns it), so the GET returns it but it cannot be set here.\nKeeps the screen's save-time guards: the e-mail address must parse, the EMail transmission method requires an address the customer has not opted out of, and the fax transmission method requires the customer to have a fax phone number. Turning on <code>allowPayments</code> also turns on <code>allowTransactions</code>.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Communication/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>emailAddress</em></td>\n<td>Optional string. Comma or semicolon separated addresses are accepted. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>allowBilling</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>allowLate</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>allowGeneralLetters</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>allowTransactions</em></td>\n<td>Optional bool. Forced on when <code>allowPayments</code> is on.</td>\n</tr>\n<tr>\n<td><em>allowPayments</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>defaultTransmissionType</em></td>\n<td>Optional int. <code>Omega.DocSafe.Types.Enums.TransmissionMethods</code> (1 Print, 2 Fax, 4 Add To Queue, 5 Electronic Document, 6 EMail, 7 Allison, 8 Mobile Text, 9 OmegaMailer).</td>\n</tr>\n<tr>\n<td><em>customerPortalDeliveryMethod</em></td>\n<td>Optional int. <code>CustomerPortalDeliveryMethods</code> (1 Opted Out, 2 Opted In).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Communication","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"a7ce417d-0885-4d03-a6a1-a22484eebaae"},{"name":"CustomerExpenseGet","id":"eac29357-e8e5-4b8c-be0c-7c820c87463b","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Expense/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-expenses\">Get Customer Expenses</h3>\n<p>Returns the monthly expense amounts the <code>CustomerExpenseControl</code> renders inside the customer entry screen: rent, utilities, other (with its description), and the credit-bureau figure.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Expense/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Expense","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"eac29357-e8e5-4b8c-be0c-7c820c87463b"},{"name":"CustomerExpenseUpdate","id":"3ead57a2-19d8-4c1e-9044-7813ee8ddd18","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"expenseRent\": 1450.00,\n    \"expenseUtilities\": 210.00,\n    \"expenseOther\": 75.00,\n    \"expenseOtherDescription\": \"Storage unit\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Expense/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"update-customer-expenses\">Update Customer Expenses</h3>\n<p>Updates the customer expense amounts. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag. Amounts cannot be negative.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Expense/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>expenseRent</em></td>\n<td>Optional decimal, zero or more.</td>\n</tr>\n<tr>\n<td><em>expenseUtilities</em></td>\n<td>Optional decimal, zero or more.</td>\n</tr>\n<tr>\n<td><em>expenseOther</em></td>\n<td>Optional decimal, zero or more.</td>\n</tr>\n<tr>\n<td><em>expenseOtherDescription</em></td>\n<td>Optional string. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>expenseCreditBureau</em></td>\n<td>Optional decimal, zero or more. Normally written by a credit report pull.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<p><code>CustomerExpenseControl</code> rules: every amount is zero or greater, and <code>expenseOtherDescription</code> is printable ASCII up to 50 characters.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Expense","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"3ead57a2-19d8-4c1e-9044-7813ee8ddd18"},{"name":"CustomerPhonesGetAll","id":"1858cfb6-8a73-4585-9cb7-eddb59380268","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Phone/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-all-customer-phone-numbers\">Get All Customer Phone Numbers</h3>\n<p>Returns every <code>Common.PhoneNumber</code> row under the customer - the Phone Numbers group box on the customer entry screen. Each row includes <code>id</code>, <code>phoneNumber</code>, <code>phoneNumberType</code> with its description, <code>primary</code>, <code>callOk</code>, <code>textOk</code>, the phone number status (id and description), the text opt-in and opt-out dates, and the created-by audit values.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Phone/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Phone","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"1858cfb6-8a73-4585-9cb7-eddb59380268"},{"name":"CustomerPhoneByIdGet","id":"7cd97904-4ec8-47bc-b488-a76ea7ffed94","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Phone/ById/{{phone_id}}?token={{token}}","description":"<h3 id=\"get-customer-phone-number-by-id\">Get Customer Phone Number By Id</h3>\n<p>Returns one <code>Common.PhoneNumber</code> row by its own primary key. The row must belong to a customer in the caller's client, otherwise the request is rejected.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Phone/ById/{phoneId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>phoneId</em></td>\n<td>Required Guid. Primary key of the phone number row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Phone","ById","{{phone_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"7cd97904-4ec8-47bc-b488-a76ea7ffed94"},{"name":"CustomerPhoneAdd","id":"30062abd-d6bd-4a9e-9d6b-5a1457c08f58","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"phoneNumber\": \"6195550142\",\n    \"phoneNumberType\": 4,\n    \"primary\": true,\n    \"callOk\": true,\n    \"textOk\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Phone/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"add-customer-phone-number\">Add Customer Phone Number</h3>\n<p>Adds a phone number to the customer, the way the (+) button on the Phone Numbers group box does.\nThe screen requires exactly one primary phone per customer, so this endpoint keeps that invariant: sending <code>primary</code> as true demotes the customer's other phone numbers, and the very first phone number a customer gets is stored as primary regardless of what was sent. <code>textOk</code> is only kept for Cell numbers and is forced off for every other type.\n<strong>HTTP Method:</strong> POST\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Phone/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>phoneNumber</em></td>\n<td>Required string. Formatted by Omega on save.</td>\n</tr>\n<tr>\n<td><em>phoneNumberType</em></td>\n<td>Required int. <code>PhoneNumberTypes</code> (1 Phone, 2 Fax, 3 Cell, 4 Home, 5 Work, 6 Other, 7 Landline, 8 VoIP).</td>\n</tr>\n<tr>\n<td><em>primary</em></td>\n<td>Optional bool. Promoting this row demotes the customer's other rows.</td>\n</tr>\n<tr>\n<td><em>callOk</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>textOk</em></td>\n<td>Optional bool. Not a direct write - see Validation below.</td>\n</tr>\n<tr>\n<td><em>phoneNumberStatusId</em></td>\n<td>Optional Guid from <code>api/Client/Common/PhoneNumberStatusCode</code>.</td>\n</tr>\n<tr>\n<td><em>phoneNumberStatusDescription</em></td>\n<td>Optional string, an alternative to <code>phoneNumberStatusId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>One primary</td>\n<td>Sending <code>primary</code> as true demotes the customer's other rows. A customer's first phone number is always stored as primary.</td>\n</tr>\n<tr>\n<td>Phone number</td>\n<td>Printable ASCII, 50 characters.</td>\n</tr>\n<tr>\n<td>Text OK</td>\n<td>Asking for true does not set it directly. The number is offered to the client's text provider first, the way the screen does, and the flag is saved from what the provider answered. A rejected opt-in - or one the customer still has to reply to, when the client requires an opt-in response - saves the number with text messaging off and returns the reason in <code>warnings</code>. Requires a Cell number, and the customer must be on an account - the opt-in message carries that account's branch details, resolved the way the customer portal resolves it.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Phone","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"30062abd-d6bd-4a9e-9d6b-5a1457c08f58"},{"name":"CustomerPhoneUpdate","id":"820c6ddb-b622-4858-884c-a891c25a8036","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"phoneNumber\": \"6195550199\",\n    \"phoneNumberType\": 3,\n    \"callOk\": true,\n    \"textOk\": true,\n    \"phoneNumberStatusDescription\": \"Good\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Phone/{{phone_id}}?token={{token}}","description":"<h3 id=\"update-customer-phone-number\">Update Customer Phone Number</h3>\n<p>Updates one customer phone number. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag.\nPromoting this row to primary demotes the customer's other rows. Clearing <code>primary</code> on the only primary row is refused, because the screen requires a customer with phone numbers to have exactly one primary. Leaving <code>primary</code> out of the body leaves every row's flag alone. <code>textOk</code> is only kept for Cell numbers.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Phone/{phoneId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>phoneId</em></td>\n<td>Required Guid. Primary key of the phone number row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>phoneNumber</em></td>\n<td>Optional string. Cannot be set blank - use DELETE to remove the row.</td>\n</tr>\n<tr>\n<td><em>phoneNumberType</em></td>\n<td>Optional int. <code>PhoneNumberTypes</code> (1 Phone, 2 Fax, 3 Cell, 4 Home, 5 Work, 6 Other, 7 Landline, 8 VoIP).</td>\n</tr>\n<tr>\n<td><em>primary</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>callOk</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>textOk</em></td>\n<td>Optional bool. Not a direct write - see Validation below.</td>\n</tr>\n<tr>\n<td><em>phoneNumberStatusId</em></td>\n<td>Optional Guid from <code>api/Client/Common/PhoneNumberStatusCode</code>.</td>\n</tr>\n<tr>\n<td><em>phoneNumberStatusDescription</em></td>\n<td>Optional string, an alternative to <code>phoneNumberStatusId</code>.</td>\n</tr>\n<tr>\n<td><em>clearPhoneNumberStatus</em></td>\n<td>Optional bool. Removes the phone number status.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>One primary</td>\n<td>Sending <code>primary</code> as true demotes the customer's other rows; clearing it on the only primary is refused. Leaving it out changes no flags.</td>\n</tr>\n<tr>\n<td>Phone number</td>\n<td>Printable ASCII, 50 characters. Cannot be set blank - use DELETE.</td>\n</tr>\n<tr>\n<td>Text OK</td>\n<td>Turning it off is recorded as an opt-out. Turning it on offers the number to the client's text provider first, the way the screen does, and saves the flag from what the provider answered - a rejected or still-pending opt-in saves the number with text messaging off and returns the reason in <code>warnings</code>. A number already opted in is left as is with no message sent. Requires a Cell number, and the customer must be on an account - the opt-in message carries that account's branch details, resolved the way the customer portal resolves it.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Phone","{{phone_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"820c6ddb-b622-4858-884c-a891c25a8036"},{"name":"CustomerPhoneDelete","id":"aa67bf8e-0704-447b-a1fc-ac59a1d76d81","request":{"method":"DELETE","header":[],"url":"https://{{base_url}}/api/Client/Customer/Phone/{{phone_id}}?token={{token}}","description":"<h3 id=\"delete-customer-phone-number\">Delete Customer Phone Number</h3>\n<p>Removes one customer phone number and writes the same customer-information change log the screen writes.\nThe primary phone number cannot be deleted while the customer still has other phone numbers: the request is rejected until another row has been promoted to primary. Deleting the primary is allowed only when it is the customer's last remaining phone number.\n<strong>HTTP Method:</strong> DELETE\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Phone/{phoneId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>phoneId</em></td>\n<td>Required Guid. Primary key of the phone number row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Phone","{{phone_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"aa67bf8e-0704-447b-a1fc-ac59a1d76d81"},{"name":"CustomerReferencesGetAll","id":"5e6ae2b8-9e9e-4984-a825-204cd4b4d813","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Reference/{{customer_number_or_id}}?includeInactive=false&token={{token}}","description":"<h3 id=\"get-all-customer-references\">Get All Customer References</h3>\n<p>Returns the customer's references - the References group box on the customer entry screen. A reference is a <code>Common.Contact</code> row under the customer; each one is returned with its single address and all of its phone numbers.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Reference/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>includeInactive</em></td>\n<td>Optional bool (default false). Include references that are no longer active.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Reference","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"includeInactive","value":"false"},{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"5e6ae2b8-9e9e-4984-a825-204cd4b4d813"},{"name":"CustomerReferenceByIdGet","id":"51d4e88b-41d9-4248-858c-cb65cf3f55fa","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/Reference/ById/{{reference_id}}?token={{token}}","description":"<h3 id=\"get-customer-reference-by-id\">Get Customer Reference By Id</h3>\n<p>Returns one customer reference by its <code>Common.Contact</code> primary key, with its address and phone numbers. The contact must hang off a customer in the caller's client.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Reference/ById/{referenceId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>referenceId</em></td>\n<td>Required Guid. Primary key of the reference (contact) row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Reference","ById","{{reference_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"51d4e88b-41d9-4248-858c-cb65cf3f55fa"},{"name":"CustomerReferenceAdd","id":"2c902e06-7d4d-4f1d-9be8-c2c9cc909213","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"Alex Morgan\",\n    \"contactType\": 4,\n    \"emailAddress\": \"alex.morgan@example.com\",\n    \"address\": {\n        \"addrLine1\": \"88 Oak Street\",\n        \"city\": \"San Diego\",\n        \"zipCode\": \"92101\",\n        \"provinceAbbreviation\": \"CA\"\n    },\n    \"phoneNumbers\": [\n        {\n            \"phoneNumber\": \"6195550177\",\n            \"phoneNumberType\": 4,\n            \"primary\": true,\n            \"callOk\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Reference/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"add-customer-reference\">Add Customer Reference</h3>\n<p>Adds a reference to the customer, together with its address and phone numbers in one request - the way the References group box saves a row.\nThe screen hides Billing (1), Banker (2), General (3) and OmegaSign (21) from the reference type list, so those <code>contactType</code> values are rejected here as well.\n<strong>HTTP Method:</strong> POST\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Reference/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>name</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>contactType</em></td>\n<td>Required int. <code>Omega.Common.Types.Enums.ContactTypes</code>, for example 4 Relative, 5 Friend, 8 Landlord, 12 Domestic Partner, 16 Mother.</td>\n</tr>\n<tr>\n<td><em>emailAddress</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>birthDate</em></td>\n<td>Optional date.</td>\n</tr>\n<tr>\n<td><em>address</em></td>\n<td>Optional object for the reference's single address: <code>addrLine1</code>, <code>addrLine2</code>, <code>addrLine3</code>, <code>city</code>, <code>zipCode</code>, and either <code>provinceId</code> or <code>provinceAbbreviation</code>. Omit the whole object to leave the stored address alone.</td>\n</tr>\n<tr>\n<td><em>phoneNumbers</em></td>\n<td>Optional array of phone rows. Rows that are not listed keep their stored values. Each row: <code>id</code> (Guid, omit to add a new row), <code>phoneNumber</code>, <code>phoneNumberType</code>, <code>primary</code>, <code>callOk</code>, <code>textOk</code>, <code>phoneNumberStatusId</code> or <code>phoneNumberStatusDescription</code>, <code>clearPhoneNumberStatus</code>, and <code>delete</code> to remove the row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Contact type</td>\n<td>Billing (1), Banker (2), General (3) and OmegaSign (21) are excluded, matching the screen's reference type list.</td>\n</tr>\n<tr>\n<td>Name and e-mail</td>\n<td>Printable ASCII, 50 and 255 characters.</td>\n</tr>\n<tr>\n<td>One primary phone</td>\n<td>The first listed primary wins and any extra primary flags are cleared. A reference can carry several phone numbers, and when it has any, exactly one is primary; the first supplied number is taken as primary when none is marked, matching the screen's seeded row.</td>\n</tr>\n<tr>\n<td>Text OK</td>\n<td>Cannot be turned on for a reference phone number: texting consent is recorded by the opt-in flow when the provider confirms it, and the business layer clears <code>TextOk</code> whenever it saves an existing contact phone. <code>textOk</code> true is rejected.</td>\n</tr>\n<tr>\n<td>Address</td>\n<td>Lines and city are printable ASCII up to 50 characters; the zip code follows the country's format (six alphanumerics for Canada, 5 or 10 digits for Mexico, 5 or 9 digits otherwise).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Reference","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"2c902e06-7d4d-4f1d-9be8-c2c9cc909213"},{"name":"CustomerReferenceUpdate","id":"9d74dd4b-5df1-487d-9ade-fdf1e6ba39d7","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"Alex Morgan\",\n    \"contactType\": 5,\n    \"address\": {\n        \"addrLine1\": \"90 Oak Street\",\n        \"city\": \"San Diego\",\n        \"zipCode\": \"92101\",\n        \"provinceAbbreviation\": \"CA\"\n    },\n    \"phoneNumbers\": [\n        {\n            \"id\": \"cccccccc-cccc-cccc-cccc-cccccccccccc\",\n            \"phoneNumber\": \"6195550188\",\n            \"callOk\": false\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Reference/{{reference_id}}?token={{token}}","description":"<h3 id=\"update-customer-reference\">Update Customer Reference</h3>\n<p>Updates one customer reference and, in the same request, its address and phone numbers. Merge semantics: a field left out of the body (or sent as <code>null</code>) is not changed. Each nullable value the screen can blank has a matching <code>clear*</code> flag.\nThe <code>address</code> object is only touched when it is supplied. Phone rows that are not listed keep their stored values; a listed row without an <code>id</code> is added; a listed row flagged <code>delete</code> is removed.\n<strong>HTTP Method:</strong> PUT\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Reference/{referenceId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>referenceId</em></td>\n<td>Required Guid. Primary key of the reference (contact) row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>name</em></td>\n<td>Optional string. Cannot be set blank.</td>\n</tr>\n<tr>\n<td><em>contactType</em></td>\n<td>Optional int. Billing (1), Banker (2), General (3) and OmegaSign (21) are not selectable for references.</td>\n</tr>\n<tr>\n<td><em>emailAddress</em></td>\n<td>Optional string. Send <code>\"\"</code> to clear.</td>\n</tr>\n<tr>\n<td><em>birthDate</em></td>\n<td>Optional date.</td>\n</tr>\n<tr>\n<td><em>clearBirthDate</em></td>\n<td>Optional bool.</td>\n</tr>\n<tr>\n<td><em>address</em></td>\n<td>Optional object for the reference's single address: <code>addrLine1</code>, <code>addrLine2</code>, <code>addrLine3</code>, <code>city</code>, <code>zipCode</code>, and either <code>provinceId</code> or <code>provinceAbbreviation</code>. Omit the whole object to leave the stored address alone.</td>\n</tr>\n<tr>\n<td><em>phoneNumbers</em></td>\n<td>Optional array of phone rows. Rows that are not listed keep their stored values. Each row: <code>id</code> (Guid, omit to add a new row), <code>phoneNumber</code>, <code>phoneNumberType</code>, <code>primary</code>, <code>callOk</code>, <code>textOk</code>, <code>phoneNumberStatusId</code> or <code>phoneNumberStatusDescription</code>, <code>clearPhoneNumberStatus</code>, and <code>delete</code> to remove the row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Rule</strong></th>\n<th><strong>Detail</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Contact type</td>\n<td>Billing (1), Banker (2), General (3) and OmegaSign (21) are excluded, matching the screen's reference type list.</td>\n</tr>\n<tr>\n<td>Inactive references</td>\n<td>An inactive reference cannot be updated, because inactive plus no-history means delete in the business layer.</td>\n</tr>\n<tr>\n<td>Name and e-mail</td>\n<td>Printable ASCII, 50 and 255 characters.</td>\n</tr>\n<tr>\n<td>One primary phone</td>\n<td>The first listed primary wins and any extra primary flags are cleared. A reference that has phone numbers must have exactly one primary, matching <code>SingleContactControl.ReturnPhoneNumbers</code>, which throws \"A primary contact phone number must be selected\".</td>\n</tr>\n<tr>\n<td>Removing the primary phone</td>\n<td>Rejected unless the same request sets <code>primary</code> on one of the remaining rows, or the row being removed is the reference's last phone number.</td>\n</tr>\n<tr>\n<td>Reference with phones but no primary</td>\n<td>Rejected rather than picked for you, so the choice is always explicit. A reference that had no phone numbers before the request takes its first supplied number as primary, matching the screen's seeded row.</td>\n</tr>\n<tr>\n<td>Text OK</td>\n<td>Cannot be turned on for a reference phone number: texting consent is recorded by the opt-in flow when the provider confirms it, and the business layer clears <code>TextOk</code> whenever it saves an existing contact phone. <code>textOk</code> true is rejected.</td>\n</tr>\n<tr>\n<td>Untouched phone rows</td>\n<td>Rows you do not list are not written at all, so an edit to the reference's own fields never disturbs their text opt-in or opt-out dates.</td>\n</tr>\n<tr>\n<td>Address</td>\n<td>Format rules are applied to the fields you send, so a stored value that predates these rules does not block an unrelated edit.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Reference","{{reference_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"9d74dd4b-5df1-487d-9ade-fdf1e6ba39d7"},{"name":"CustomerReferenceDelete","id":"bfc053fd-279d-4edd-b133-40c06a77a616","request":{"method":"DELETE","header":[],"url":"https://{{base_url}}/api/Client/Customer/Reference/{{reference_id}}?token={{token}}","description":"<h3 id=\"delete-customer-reference\">Delete Customer Reference</h3>\n<p>Removes one customer reference along with its address and phone numbers. The References group box keeps no contact history, so this is a hard delete, the same as removing the row on the screen.\n<strong>HTTP Method:</strong> DELETE\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Reference/{referenceId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>referenceId</em></td>\n<td>Required Guid. Primary key of the reference (contact) row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Reference","{{reference_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"bfc053fd-279d-4edd-b133-40c06a77a616"},{"name":"CustomerOtherIncomeGetAll","id":"bc19779f-118d-4a6b-8541-f2fde65f9426","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-all-customer-other-income\">Get All Customer Other Income</h3>\n<p>Returns every <code>Common.CustomerOtherIncome</code> row for the customer - the Other Income group box on the customer entry screen. Each row includes the source, amount, frequency with its description, and hours per week.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/OtherIncome/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","OtherIncome","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"bc19779f-118d-4a6b-8541-f2fde65f9426"},{"name":"CustomerOtherIncomeByIdGet","id":"87f15d18-7e9b-4dc7-9c93-43572570ada7","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/OtherIncome/ById/{{other_income_id}}?token={{token}}","description":"<h3 id=\"get-customer-other-income-by-id\">Get Customer Other Income By Id</h3>\n<p>Returns one <code>Common.CustomerOtherIncome</code> row by its primary key. The row must belong to a customer in the caller's client.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/OtherIncome/ById/{otherIncomeId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>otherIncomeId</em></td>\n<td>Required Guid. Primary key of the other income row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","OtherIncome","ById","{{other_income_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"87f15d18-7e9b-4dc7-9c93-43572570ada7"},{"name":"CustomerPortalProfileGet","id":"409d6226-eb9b-40ad-9b4f-a0ce62432ce7","request":{"method":"GET","header":[],"url":"https://{{base_url}}/api/Client/Customer/PortalProfile/{{customer_number_or_id}}?token={{token}}","description":"<h3 id=\"get-customer-portal-profile\">Get Customer Portal Profile</h3>\n<p>Returns the \"Customer Portal - Customer Selected Options\" group box from the customer entry screen: the portal login e-mail, the paperless opt-in flag, and the new-document notify method, plus the portal user, lockout and last-login values from the customer record.\nRead only, matching the screen - all three controls in that group box are ReadOnly because the customer picks these options in the portal. When a customer has never used the portal, <code>hasProfile</code> is false and the screen defaults are returned.\n<strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/PortalProfile/{customerIdOrNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerIdOrNumber</em></td>\n<td>Required string. Customer GUID <code>Id</code> or numeric <code>CustomerNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","PortalProfile","{{customer_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"409d6226-eb9b-40ad-9b4f-a0ce62432ce7"},{"name":"CustomerInformationGetBulk","id":"a4c3f06b-3a1f-4a6b-8e72-edeef7599ef7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomer?token={{token}}","description":"<h3 id=\"get-customer-information-all-fields-bulk\">Get Customer Information (all fields) (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Information/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"a4c3f06b-3a1f-4a6b-8e72-edeef7599ef7"},{"name":"CustomerInformationUpdateBulk","id":"52407f82-0233-4833-9f03-d61e69a88fb5","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"general\": {\n      \"firstName\": \"Jordan\",\n      \"lastName\": \"Reyes\",\n      \"maritalStatus\": 2,\n      \"numberOfDependents\": 2\n    },\n    \"residence\": {\n      \"primaryAddressAsOfDate\": \"2023-06-01\"\n    },\n    \"communication\": {\n      \"emailAddress\": \"jordan.reyes@example.com\",\n      \"allowBilling\": true\n    },\n    \"expense\": {\n      \"expenseRent\": 1850.00\n    }\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"timeZone\": {\n      \"timeZoneCode\": \"EST\",\n      \"callAfterTime\": \"09:00\",\n      \"callBeforeTime\": \"19:00\"\n    }\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomer?token={{token}}","description":"<h3 id=\"update-customer-information-all-fields-bulk\">Update Customer Information (all fields) (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Information/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"52407f82-0233-4833-9f03-d61e69a88fb5"},{"name":"CustomerGeneralGetBulk","id":"78454da0-f889-4520-8203-bc9e7fc3b1a3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerGeneral?token={{token}}","description":"<h3 id=\"get-customer-general-information-bulk\">Get Customer General Information (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/General/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / General (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerGeneral</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerGeneral"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"78454da0-f889-4520-8203-bc9e7fc3b1a3"},{"name":"CustomerGeneralUpdateBulk","id":"6c7f27ef-36ba-4ff1-b9bc-19713e69cffe","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"firstName\": \"Jordan\",\n    \"lastName\": \"Reyes\",\n    \"maritalStatus\": 2,\n    \"numberOfDependents\": 2\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"isHomeOwner\": true,\n    \"languageCode\": 2\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerGeneral?token={{token}}","description":"<h3 id=\"update-customer-general-information-bulk\">Update Customer General Information (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/General/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / General (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerGeneral</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerGeneral"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"6c7f27ef-36ba-4ff1-b9bc-19713e69cffe"},{"name":"CustomerResidenceGetBulk","id":"c4b43522-98e8-47d2-b43c-af2819b58605","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerResidence?token={{token}}","description":"<h3 id=\"get-customer-residence-dates-bulk\">Get Customer Residence Dates (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Residence/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / Residence (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerResidence</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerResidence"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"c4b43522-98e8-47d2-b43c-af2819b58605"},{"name":"CustomerResidenceUpdateBulk","id":"38e4576a-fee7-4577-b982-80bdce137456","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"primaryAddressAsOfDate\": \"2023-06-01\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"primaryAddressAsOfDate\": \"2021-02-15\",\n    \"previousAddressAsOfDate\": \"2018-09-01\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerResidence?token={{token}}","description":"<h3 id=\"update-customer-residence-dates-bulk\">Update Customer Residence Dates (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Residence/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Residence (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerResidence</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerResidence"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"38e4576a-fee7-4577-b982-80bdce137456"},{"name":"CustomerTimeZoneGetBulk","id":"b4e470e0-eefe-4ce9-8f67-2b8ff411694f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerTimeZone?token={{token}}","description":"<h3 id=\"get-customer-time-zone-bulk\">Get Customer Time Zone (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/TimeZone/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / TimeZone (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerTimeZone</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerTimeZone"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"b4e470e0-eefe-4ce9-8f67-2b8ff411694f"},{"name":"CustomerTimeZoneUpdateBulk","id":"38b32933-b0b9-4203-98c7-2da8ebb0c00f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"timeZoneId\": \"Pacific Standard Time\",\n    \"callBetweenStartTime\": \"08:00\",\n    \"callBetweenEndTime\": \"20:00\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"timeZoneId\": \"Eastern Standard Time\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerTimeZone?token={{token}}","description":"<h3 id=\"update-customer-time-zone-bulk\">Update Customer Time Zone (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/TimeZone/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / TimeZone (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerTimeZone</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerTimeZone"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"38b32933-b0b9-4203-98c7-2da8ebb0c00f"},{"name":"CustomerCommunicationGetBulk","id":"d0a14b32-5993-41db-a624-4f2babd61691","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerCommunication?token={{token}}","description":"<h3 id=\"get-customer-communication-preferences-bulk\">Get Customer Communication Preferences (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Communication/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / Communication (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerCommunication</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerCommunication"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"d0a14b32-5993-41db-a624-4f2babd61691"},{"name":"CustomerCommunicationUpdateBulk","id":"819dbdc6-f416-49e3-b694-3364a252aff6","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"emailAddress\": \"jordan.reyes@example.com\",\n    \"transmissionMethod\": 2,\n    \"eStatements\": true\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"doNotCall\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerCommunication?token={{token}}","description":"<h3 id=\"update-customer-communication-preferences-bulk\">Update Customer Communication Preferences (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Communication/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Communication (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerCommunication</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerCommunication"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"819dbdc6-f416-49e3-b694-3364a252aff6"},{"name":"CustomerExpenseGetBulk","id":"88f4d569-f269-4a6e-a6b6-21b745a44d96","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerExpense?token={{token}}","description":"<h3 id=\"get-customer-expenses-bulk\">Get Customer Expenses (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Expense/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / Expense (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerExpense</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerExpense"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"88f4d569-f269-4a6e-a6b6-21b745a44d96"},{"name":"CustomerExpenseUpdateBulk","id":"277b9c8c-d5ec-4744-a7e7-07d242133b0f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"rentOrMortgagePayment\": 1850.00,\n    \"otherMonthlyExpense\": 325.00\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"rentOrMortgagePayment\": 0\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerExpense?token={{token}}","description":"<h3 id=\"update-customer-expenses-bulk\">Update Customer Expenses (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Expense/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Expense (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerExpense</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerExpense"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"277b9c8c-d5ec-4744-a7e7-07d242133b0f"},{"name":"CustomerPortalProfileGetBulk","id":"51a439ca-9eb1-4abf-8065-51734c15f8cd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPortalProfile?token={{token}}","description":"<h3 id=\"get-customer-portal-profile-bulk\">Get Customer Portal Profile (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/PortalProfile/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / PortalProfile (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPortalProfile</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerPortalProfile"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"51a439ca-9eb1-4abf-8065-51734c15f8cd"},{"name":"CustomerAddressesGetAllBulk","id":"861b4e61-bfcc-4e35-b7b4-baae46803c3d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"includeInactive\": false,\n    \"includePrevious\": true\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerAddresses?token={{token}}","description":"<h3 id=\"get-customer-addresses-bulk\">Get Customer Addresses (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Address/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment, and the <code>includeInactive</code> / <code>includePrevious</code> options the single route takes as query string. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Customer / Address (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerAddresses</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerAddresses"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"861b4e61-bfcc-4e35-b7b4-baae46803c3d"},{"name":"CustomerAddressByIdGetBulk","id":"b6622ae2-86d5-42f5-8822-fdd1e0fe7127","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"addressId\": \"{{address_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"addressId\": \"{{address_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerAddress?token={{token}}","description":"<h3 id=\"get-customer-address-by-id-bulk\">Get Customer Address by Id (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Address/ById/{addressId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>addressId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Customer / Address / ById (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerAddress</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerAddress"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"b6622ae2-86d5-42f5-8822-fdd1e0fe7127"},{"name":"CustomerAddressAddBulk","id":"6e91c2d0-ba8f-4592-89f6-4dcb776cd3b1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"addressType\": 1,\n    \"addrLine1\": \"123 Main St\",\n    \"city\": \"Los Angeles\",\n    \"zipCode\": \"90001\",\n    \"provinceAbbreviation\": \"CA\",\n    \"primary\": true\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"addressType\": 2,\n    \"addrLine1\": \"PO Box 44\",\n    \"city\": \"San Diego\",\n    \"zipCode\": \"92101\",\n    \"provinceAbbreviation\": \"CA\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerAddress?token={{token}}","description":"<h3 id=\"add-customer-address-bulk\">Add Customer Address (bulk)</h3>\n<p>Runs <code>POST api/Client/Customer/Address/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Address (POST)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerAddress</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","AddCustomerAddress"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"6e91c2d0-ba8f-4592-89f6-4dcb776cd3b1"},{"name":"CustomerAddressUpdateBulk","id":"a613cd75-7693-4452-9203-884854e8594a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"addressId\": \"{{address_id}}\",\n    \"addrLine1\": \"456 Second Ave\",\n    \"city\": \"Los Angeles\",\n    \"zipCode\": \"90002\",\n    \"provinceAbbreviation\": \"CA\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerAddress?token={{token}}","description":"<h3 id=\"update-customer-address-bulk\">Update Customer Address (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Address/{addressId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>addressId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Address (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerAddress</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerAddress"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"a613cd75-7693-4452-9203-884854e8594a"},{"name":"CustomerAddressDeleteBulk","id":"75e79e70-ff1e-43eb-8957-222ab50f69ce","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"addressId\": \"{{address_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerAddress?token={{token}}","description":"<h3 id=\"delete-customer-address-bulk\">Delete Customer Address (bulk)</h3>\n<p>Runs <code>DELETE api/Client/Customer/Address/{addressId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>addressId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Address (DELETE)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerAddress</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","DeleteCustomerAddress"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"75e79e70-ff1e-43eb-8957-222ab50f69ce"},{"name":"CustomerPreviousAddressGetBulk","id":"079863fa-4449-40ed-8ca7-31ea200a39e6","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPreviousAddress?token={{token}}","description":"<h3 id=\"get-customer-previous-address-bulk\">Get Customer Previous Address (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Address/Previous/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / Address / Previous (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPreviousAddress</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerPreviousAddress"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"079863fa-4449-40ed-8ca7-31ea200a39e6"},{"name":"CustomerPreviousAddressUpdateBulk","id":"10e9266d-1ad5-42ad-a1ac-c60636ce8694","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"addrLine1\": \"77 Former Road\",\n    \"city\": \"Riverside\",\n    \"zipCode\": \"92501\",\n    \"provinceAbbreviation\": \"CA\",\n    \"previousAddressAsOfDate\": \"2018-09-01\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerPreviousAddress?token={{token}}","description":"<h3 id=\"update-customer-previous-address-bulk\">Update Customer Previous Address (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Address/Previous/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Address / Previous (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerPreviousAddress</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerPreviousAddress"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"10e9266d-1ad5-42ad-a1ac-c60636ce8694"},{"name":"CustomerPreviousAddressDeleteBulk","id":"7a6eb109-e0aa-41ba-8e62-efb7e0159f3b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerPreviousAddress?token={{token}}","description":"<h3 id=\"delete-customer-previous-address-bulk\">Delete Customer Previous Address (bulk)</h3>\n<p>Runs <code>DELETE api/Client/Customer/Address/Previous/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Address / Previous (DELETE)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerPreviousAddress</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","DeleteCustomerPreviousAddress"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"7a6eb109-e0aa-41ba-8e62-efb7e0159f3b"},{"name":"CustomerPhonesGetAllBulk","id":"10ce1592-e513-4917-84db-105b32f98794","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPhones?token={{token}}","description":"<h3 id=\"get-customer-phone-numbers-bulk\">Get Customer Phone Numbers (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Phone/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / Phone (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPhones</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerPhones"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"10ce1592-e513-4917-84db-105b32f98794"},{"name":"CustomerPhoneByIdGetBulk","id":"3058a319-0c84-4bea-8f2f-9389c3659d93","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"phoneId\": \"{{phone_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPhone?token={{token}}","description":"<h3 id=\"get-customer-phone-number-by-id-bulk\">Get Customer Phone Number by Id (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Phone/ById/{phoneId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>phoneId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Customer / Phone / ById (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerPhone</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerPhone"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"3058a319-0c84-4bea-8f2f-9389c3659d93"},{"name":"CustomerPhoneAddBulk","id":"72ac849f-8055-46a8-929a-4c2d47891b8b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"phoneNumber\": \"6195550142\",\n    \"phoneNumberType\": 4,\n    \"primary\": true,\n    \"callOk\": true\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"phoneNumber\": \"6195550188\",\n    \"phoneNumberType\": 3,\n    \"callOk\": true,\n    \"textOk\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerPhone?token={{token}}","description":"<h3 id=\"add-customer-phone-number-bulk\">Add Customer Phone Number (bulk)</h3>\n<p>Runs <code>POST api/Client/Customer/Phone/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Phone (POST)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerPhone</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","AddCustomerPhone"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"72ac849f-8055-46a8-929a-4c2d47891b8b"},{"name":"CustomerPhoneUpdateBulk","id":"23aadaf3-4c7a-4aa7-af51-8dff55de8de9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"phoneId\": \"{{phone_id}}\",\n    \"primary\": true,\n    \"callOk\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerPhone?token={{token}}","description":"<h3 id=\"update-customer-phone-number-bulk\">Update Customer Phone Number (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Phone/{phoneId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>phoneId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Phone (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerPhone</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerPhone"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"23aadaf3-4c7a-4aa7-af51-8dff55de8de9"},{"name":"CustomerPhoneDeleteBulk","id":"f3fe5bb0-8dc9-4de1-b152-f3930efae8d9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"phoneId\": \"{{phone_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerPhone?token={{token}}","description":"<h3 id=\"delete-customer-phone-number-bulk\">Delete Customer Phone Number (bulk)</h3>\n<p>Runs <code>DELETE api/Client/Customer/Phone/{phoneId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>phoneId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Phone (DELETE)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerPhone</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","DeleteCustomerPhone"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"f3fe5bb0-8dc9-4de1-b152-f3930efae8d9"},{"name":"CustomerReferencesGetAllBulk","id":"ceaa8758-2ed8-4d9b-83b5-6c6f7317f252","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"includeInactive\": false\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\",\n    \"includeInactive\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerReferences?token={{token}}","description":"<h3 id=\"get-customer-references-bulk\">Get Customer References (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Reference/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment, and the <code>includeInactive</code> option the single route takes as query string. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Customer / Reference (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerReferences</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerReferences"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"ceaa8758-2ed8-4d9b-83b5-6c6f7317f252"},{"name":"CustomerReferenceByIdGetBulk","id":"c42b4053-05c3-43f1-8264-2cf65285b6ea","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"referenceId\": \"{{reference_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerReference?token={{token}}","description":"<h3 id=\"get-customer-reference-by-id-bulk\">Get Customer Reference by Id (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Reference/ById/{referenceId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>referenceId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Customer / Reference / ById (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerReference</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerReference"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"c42b4053-05c3-43f1-8264-2cf65285b6ea"},{"name":"CustomerReferenceAddBulk","id":"e2d89eee-64e9-4673-ba57-25dc80f3434d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"name\": \"Alex Morgan\",\n    \"contactType\": 4,\n    \"emailAddress\": \"alex.morgan@example.com\",\n    \"address\": {\n      \"addrLine1\": \"88 Oak Street\",\n      \"city\": \"San Diego\",\n      \"zipCode\": \"92101\",\n      \"provinceAbbreviation\": \"CA\"\n    },\n    \"phoneNumbers\": [\n      {\n        \"phoneNumber\": \"6195550177\",\n        \"phoneNumberType\": 4,\n        \"primary\": true,\n        \"callOk\": true\n      }\n    ]\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerReference?token={{token}}","description":"<h3 id=\"add-customer-reference-bulk\">Add Customer Reference (bulk)</h3>\n<p>Runs <code>POST api/Client/Customer/Reference/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Reference (POST)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerReference</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","AddCustomerReference"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"e2d89eee-64e9-4673-ba57-25dc80f3434d"},{"name":"CustomerReferenceUpdateBulk","id":"adf73a7e-aca7-40a2-8da1-4076a0ec31b3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"referenceId\": \"{{reference_id}}\",\n    \"contactType\": 5,\n    \"emailAddress\": \"alex.morgan@example.com\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerReference?token={{token}}","description":"<h3 id=\"update-customer-reference-bulk\">Update Customer Reference (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Reference/{referenceId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>referenceId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Reference (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerReference</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerReference"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"adf73a7e-aca7-40a2-8da1-4076a0ec31b3"},{"name":"CustomerReferenceDeleteBulk","id":"87f3be0e-6b30-4ab2-9db2-0e6194ef5654","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"referenceId\": \"{{reference_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerReference?token={{token}}","description":"<h3 id=\"delete-customer-reference-bulk\">Delete Customer Reference (bulk)</h3>\n<p>Runs <code>DELETE api/Client/Customer/Reference/{referenceId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>referenceId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Reference (DELETE)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerReference</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","DeleteCustomerReference"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"87f3be0e-6b30-4ab2-9db2-0e6194ef5654"},{"name":"CustomerEmployersGetAllBulk","id":"001a2676-7f8d-48cf-920b-409b99a85c4e","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerEmployers?token={{token}}","description":"<h3 id=\"get-customer-employers-bulk\">Get Customer Employers (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Employer/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / Employer (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerEmployers</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerEmployers"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"001a2676-7f8d-48cf-920b-409b99a85c4e"},{"name":"MostRecentCustomerEmployerGetBulk","id":"76861041-782c-473a-bb8b-527cba5fe5cf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetMostRecentCustomerEmployer?token={{token}}","description":"<h3 id=\"get-most-recent-customer-employer-bulk\">Get Most Recent Customer Employer (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Employer/{customerIdOrNumber}/MostRecent</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / Employer / MostRecent (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetMostRecentCustomerEmployer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetMostRecentCustomerEmployer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"76861041-782c-473a-bb8b-527cba5fe5cf"},{"name":"CustomerEmployerByIdGetBulk","id":"0891b704-a728-494f-a722-e88b49cea654","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"employerId\": \"{{employer_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerEmployer?token={{token}}","description":"<h3 id=\"get-customer-employer-by-id-bulk\">Get Customer Employer by Id (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/Employer/ById/{employerId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>employerId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Customer / Employer / ById (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerEmployer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerEmployer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"0891b704-a728-494f-a722-e88b49cea654"},{"name":"CustomerEmployerAddBulk","id":"e6e77ab5-b196-455a-95f2-016511a30bcc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"employerName\": \"Acme Manufacturing\",\n    \"startDate\": \"2021-03-15\",\n    \"salary\": 68000,\n    \"salaryFrequency\": 5,\n    \"occupation\": \"Machinist\",\n    \"address\": {\n      \"addrLine1\": \"900 Industrial Way\",\n      \"city\": \"Los Angeles\",\n      \"zipCode\": \"90021\",\n      \"provinceAbbreviation\": \"CA\"\n    },\n    \"phone\": {\n      \"phoneNumber\": \"2135550190\"\n    }\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerEmployer?token={{token}}","description":"<h3 id=\"add-customer-employer-bulk\">Add Customer Employer (bulk)</h3>\n<p>Runs <code>POST api/Client/Customer/Employer</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code>, which the single route already takes in its body. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Employer (POST)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerEmployer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","AddCustomerEmployer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"e6e77ab5-b196-455a-95f2-016511a30bcc"},{"name":"CustomerEmployerUpdateBulk","id":"0c0ade7b-b240-4992-bf32-c7da71bf3f46","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"employerId\": \"{{employer_id}}\",\n    \"salary\": 72000,\n    \"salaryFrequency\": 5,\n    \"endDate\": \"2026-01-31\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerEmployer?token={{token}}","description":"<h3 id=\"update-customer-employer-bulk\">Update Customer Employer (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/Employer/{employerId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>employerId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Employer (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerEmployer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerEmployer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"0c0ade7b-b240-4992-bf32-c7da71bf3f46"},{"name":"CustomerEmployerDeleteBulk","id":"04f20f0a-cecd-4c99-8ddc-ccd72e903afe","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"employerId\": \"{{employer_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerEmployer?token={{token}}","description":"<h3 id=\"delete-customer-employer-bulk\">Delete Customer Employer (bulk)</h3>\n<p>Runs <code>DELETE api/Client/Customer/Employer/{employerId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>employerId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / Employer (DELETE)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerEmployer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","DeleteCustomerEmployer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"04f20f0a-cecd-4c99-8ddc-ccd72e903afe"},{"name":"CustomerOtherIncomeGetAllBulk","id":"7f21d613-40c3-4c73-8eab-6ddfc920fd65","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\"\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerOtherIncome?token={{token}}","description":"<h3 id=\"get-customer-other-income-bulk\">Get Customer Other Income (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/OtherIncome/{customerIdOrNumber}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Repeat selectors naming the same customer are collapsed, so each customer is processed once using its first item.</p>\n<p>Reuses the <strong>Customer / OtherIncome (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerOtherIncome</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerOtherIncome"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"7f21d613-40c3-4c73-8eab-6ddfc920fd65"},{"name":"CustomerOtherIncomeByIdGetBulk","id":"b243efbb-9434-41e7-9cc3-fc7324e16dad","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"otherIncomeId\": \"{{other_income_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerOtherIncomeById?token={{token}}","description":"<h3 id=\"get-customer-other-income-by-id-bulk\">Get Customer Other Income by Id (bulk)</h3>\n<p>Runs <code>GET api/Client/Customer/OtherIncome/ById/{otherIncomeId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>otherIncomeId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Customer / OtherIncome / ById (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetCustomerOtherIncomeById</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetCustomerOtherIncomeById"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"b243efbb-9434-41e7-9cc3-fc7324e16dad"},{"name":"CustomerOtherIncomeAddBulk","id":"2ae9c356-5b3e-4570-ab4f-8f8f99dcf565","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"source\": \"Rental property\",\n    \"frequency\": 6,\n    \"amount\": 950.00\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerOtherIncome?token={{token}}","description":"<h3 id=\"add-customer-other-income-bulk\">Add Customer Other Income (bulk)</h3>\n<p>Runs <code>POST api/Client/Customer/OtherIncome</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code>, which the single route already takes in its body. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / OtherIncome (POST)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/AddCustomerOtherIncome</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","AddCustomerOtherIncome"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"2ae9c356-5b3e-4570-ab4f-8f8f99dcf565"},{"name":"CustomerOtherIncomeUpdateBulk","id":"81f024fa-feeb-4f4c-8a16-ccf9908840bf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"otherIncomeId\": \"{{other_income_id}}\",\n    \"source\": \"Rental property\",\n    \"frequency\": 6,\n    \"amount\": 1025.00\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerOtherIncome?token={{token}}","description":"<h3 id=\"update-customer-other-income-bulk\">Update Customer Other Income (bulk)</h3>\n<p>Runs <code>PUT api/Client/Customer/OtherIncome/{otherIncomeId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>otherIncomeId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / OtherIncome (PUT)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/UpdateCustomerOtherIncome</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","UpdateCustomerOtherIncome"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"81f024fa-feeb-4f4c-8a16-ccf9908840bf"},{"name":"CustomerOtherIncomeDeleteBulk","id":"0446df4f-6f9e-4df4-b035-70c8ca8b6170","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"otherIncomeId\": \"{{other_income_id}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerOtherIncome?token={{token}}","description":"<h3 id=\"delete-customer-other-income-bulk\">Delete Customer Other Income (bulk)</h3>\n<p>Runs <code>DELETE api/Client/Customer/OtherIncome/{otherIncomeId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>otherIncomeId</code> in place of the URL path segment, plus <code>customerIdOrNumber</code> naming the customer the row is reported under. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Day End is checked before every item; if it starts mid-batch the remaining items are reported as <code>Skipped</code> rather than committed.</p>\n<p>Reuses the <strong>Customer / OtherIncome (DELETE)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/DeleteCustomerOtherIncome</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","DeleteCustomerOtherIncome"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"0446df4f-6f9e-4df4-b035-70c8ca8b6170"},{"name":"AccountsByCustomerGetBulk","id":"f3335004-9e7b-4322-aab7-2b82cc2af524","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id}}\",\n    \"fetchAccount\": true,\n    \"activatedAccountsOnly\": true,\n    \"includeClosed\": false\n  },\n  {\n    \"customerIdOrNumber\": \"{{customer_number_or_id_2}}\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Customer/Bulk/GetAccountsByCustomer?token={{token}}","description":"<h3 id=\"get-accounts-by-customer-bulk\">Get Accounts by Customer (bulk)</h3>\n<p>Runs <code>GET api/Client/Account/AccountCustomer/ByCustomer/{customerNumberOrId}</code> once per item, for up to 250 customers in one request. Each item carries the single route's own body plus <code>customerIdOrNumber</code> in place of the URL path segment, and the <code>fetchAccount</code> / <code>activatedAccountsOnly</code> / <code>includeClosed</code> options the single route takes as query string. Every item is reported as its own row under <code>data.customers</code>, carrying that item's single-route response verbatim, so one failure does not stop the batch.</p>\n<p>Items naming the same customer are <strong>not</strong> collapsed. Each item is a distinct request, so the same customer may appear more than once - several phone numbers, several references, or the same customer read with different options.</p>\n<p>Reuses the <strong>Account / AccountCustomer / ByCustomer (GET)</strong> permission - granting the single endpoint grants its bulk form - and counts as <strong>one</strong> API call for billing no matter how many items it carries. Requires token or API key authentication; session authentication is refused.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Customer/Bulk/GetAccountsByCustomer</code></p>\n<h4 id=\"request-body\">Request Body</h4>\n<p>A JSON <strong>array</strong> of 1 to 250 items. See the single request for the meaning and validation of every field; the rules are identical because the same service runs per item.</p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authentication</em></td>\n<td>Required, by any one of three methods: a <code>token</code> query-string parameter on the URL (or a <code>token</code> property in the JSON body on POST and PUT); an API key sent as the <code>publicKey</code>, <code>timeStamp</code> and <code>signature</code> headers; or a <code>SessionId</code> header. The token is therefore optional when an API key or session is supplied. There is no Authorization header.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Customer","Bulk","GetAccountsByCustomer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[],"_postman_id":"f3335004-9e7b-4322-aab7-2b82cc2af524"}],"id":"de7efac6-0577-4296-a571-5efc0a0b0f1a","_postman_id":"de7efac6-0577-4296-a571-5efc0a0b0f1a","description":""},{"name":"Custom Screen Fields","item":[{"name":"Screen Builder","item":[{"name":"Get Form","id":"2104a46f-ee9f-4499-a28c-0faf25b0462d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetForm?componentId={{componentId}}","description":"<p><strong>Get Form</strong></p>\n<ul>\n<li><p><strong>Method</strong>: GET</p>\n</li>\n<li><p><strong>Path</strong>: <code>/GetForm</code></p>\n</li>\n<li><p><strong>Parameters</strong>:</p>\n<ul>\n<li><code>componentId</code> (query): GUID of the component to retrieve</li>\n</ul>\n</li>\n<li><p><strong>Description</strong>: Retrieves a custom screen form by component ID</p>\n</li>\n<li><p><strong>Response</strong>: Returns form JSON data</p>\n</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetForm"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>GUID of the component to retrieve</p>\n","type":"text/plain"},"key":"componentId","value":"{{componentId}}"}],"variable":[]}},"response":[{"id":"95fae1df-ef1f-4095-b8cf-d6ae2c778e98","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetForm?componentId=12345678-1234-1234-1234-123456789012","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetForm"],"query":[{"key":"componentId","value":"12345678-1234-1234-1234-123456789012"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": \"{\\\"formData\\\": \\\"...\\\"}\"\n}"},{"id":"54b66b54-2970-4961-84cf-5ef56f00c26d","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetForm?componentId=00000000-0000-0000-0000-000000000000","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetForm"],"query":[{"key":"componentId","value":"00000000-0000-0000-0000-000000000000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"SaveCustomScreen: Screen form not found\",\n    \"System.Exception: Screen form not found\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"2104a46f-ee9f-4499-a28c-0faf25b0462d"},{"name":"Get Forms","id":"e0a0cd19-8196-4cc6-b9f3-b908dca2b76b","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetForms","description":"<p><strong>Get Forms</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetForms</code></li>\n<li><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</li>\n<li><strong>Description</strong>: Retrieves all custom screen forms</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetForms"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"135b0125-004e-4f98-ba02-9d3a7ab91ad0","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetForms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": \"12345678-1234-1234-1234-123456789012\",\n      \"Name\": \"Form Name\",\n      \"Description\": \"Form Description\",\n      \"Json\": \"{...}\",\n      \"ParentType\": 1\n    }\n  ]\n}"},{"id":"2fb89347-5dcd-4be8-909a-bb7fdc2035b5","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetForms"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"e0a0cd19-8196-4cc6-b9f3-b908dca2b76b"},{"name":"Get Forms by IDs","id":"76f1c166-332c-4971-bb57-a3abe7864828","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetFormsByIds?componentIds={{componentIds}}","description":"<p><strong>Get Forms by IDs</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetFormsByIds</code></li>\n<li><strong>Parameters</strong>:<ul>\n<li><code>componentIds</code> (query): JSON array of component GUIDs</li>\n</ul>\n</li>\n<li><strong>Description</strong>: Retrieves multiple custom screen forms by their IDs</li>\n<li><strong>Example</strong>: <code>componentIds=[\"12345678-1234-1234-1234-123456789012\",\"87654321-4321-4321-4321-210987654321\"]</code></li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetFormsByIds"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>JSON array of component GUIDs</p>\n","type":"text/plain"},"key":"componentIds","value":"{{componentIds}}"}],"variable":[]}},"response":[{"id":"9bdbce14-6446-420a-91de-6195165e9261","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetFormsByIds?componentIds=[\"12345678-1234-1234-1234-123456789012\",\"87654321-4321-4321-4321-210987654321\"]","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetFormsByIds"],"query":[{"key":"componentIds","value":"[\"12345678-1234-1234-1234-123456789012\",\"87654321-4321-4321-4321-210987654321\"]"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": \"12345678-1234-1234-1234-123456789012\",\n      \"Name\": \"Form Name\",\n      \"Description\": \"Form Description\",\n      \"Json\": \"{...}\",\n      \"ParentType\": 1\n    }\n  ]\n}"},{"id":"568256e4-0445-4001-b938-6e98b72aa0d5","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetFormsByIds?componentIds=[]","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetFormsByIds"],"query":[{"key":"componentIds","value":"[]"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"SaveCustomScreen: Empty componentIds\",\n    \"System.Exception: Empty componentIds\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"76f1c166-332c-4971-bb57-a3abe7864828"},{"name":"Get Many to One Parent Types","id":"77594829-3203-45f6-8d8e-c09061223f2d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetManyToOneParentTypes","description":"<p><strong>Get Many to One Parent Types</strong></p>\n<ul>\n<li><p><strong>Method</strong>: GET</p>\n</li>\n<li><p><strong>Path</strong>: <code>/GetManyToOneParentTypes</code></p>\n</li>\n<li><p><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</p>\n</li>\n<li><p><strong>Description</strong>: Retrieves many-to-one parent types</p>\n</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetManyToOneParentTypes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b67dc762-154f-4525-870c-b7b6e5e30571","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetManyToOneParentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"Many to One Parent Type 1\"\n    }\n  ]\n}"},{"id":"121f743e-ef86-4bad-9568-a8166e88866a","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetManyToOneParentTypes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"77594829-3203-45f6-8d8e-c09061223f2d"},{"name":"Get Many to One Selection Options","id":"5dd9a49f-13b6-4fb2-8349-03394462e2d3","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetManyToOneSelectionOptions","description":"<p><strong>Get Many to One Selection Options</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetManyToOneSelectionOptions</code></li>\n<li><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</li>\n<li><strong>Description</strong>: Retrieves many-to-one selection options</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetManyToOneSelectionOptions"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3cb51aae-3124-42a4-bcd8-ac7ccbbadf7b","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetManyToOneSelectionOptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"Selection Option 1\"\n    }\n  ]\n}"},{"id":"2a130402-2a0a-47ee-a9c7-fa25c856d937","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetManyToOneSelectionOptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"5dd9a49f-13b6-4fb2-8349-03394462e2d3"},{"name":"Get Omega Custom Form Fields","id":"a860c517-b8c1-44d3-b776-90a0cec842c0","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetOmegaCustomFormFields?parentEntityType={{parentEntityType}}","description":"<p><strong>Get Omega Custom Form Fields</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetOmegaCustomFormFields</code></li>\n<li><strong>Parameters</strong>:<ul>\n<li><code>parentEntityType</code> (query): Parent entity type (integer)</li>\n</ul>\n</li>\n<li><strong>Description</strong>: Retrieves Omega custom form fields for a specific parent entity type</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetOmegaCustomFormFields"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>Parent entity type (integer)</p>\n","type":"text/plain"},"key":"parentEntityType","value":"{{parentEntityType}}"}],"variable":[]}},"response":[{"id":"19a1b335-c82e-4ad4-b5a7-bfe33bfe0db2","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetOmegaCustomFormFields?parentEntityType=1","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetOmegaCustomFormFields"],"query":[{"key":"parentEntityType","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"entityName\": \"CommonAccount\",\n      \"fieldsList\": [\n        {\n          \"Name\": \"AccountNumber\",\n          \"DataType\": \"String\",\n          \"MaxLength\": 50,\n          \"Precision\": 0,\n          \"values\": []\n        }\n      ]\n    }\n  ]\n}"},{"id":"553e9149-8fcc-4bcd-9480-8d1379fcee44","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetOmegaCustomFormFields?parentEntityType=abc","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetOmegaCustomFormFields"],"query":[{"key":"parentEntityType","value":"abc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"GetOmegaCustomFormFields: Input string was not in a correct format.\",\n    \"System.FormatException: Input string was not in a correct format.\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"a860c517-b8c1-44d3-b776-90a0cec842c0"},{"name":"Get Parent Types","id":"cc36d961-42f1-4a71-941a-2b39ef41d884","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetParentTypes","description":"<p><strong>Get Parent Types</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetParentTypes</code></li>\n<li><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</li>\n<li><strong>Description</strong>: Retrieves all available parent types</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetParentTypes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f01ea4c1-7144-47b8-9585-10120cc907bf","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetParentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"Account\"\n    },\n    {\n      \"Id\": 2,\n      \"Name\": \"Customer\"\n    }\n  ]\n}"},{"id":"8fa59379-d483-4811-8963-1b960b7a28fc","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetParentTypes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"cc36d961-42f1-4a71-941a-2b39ef41d884"},{"name":"Get Screen","id":"0eec1bcd-de6b-4029-9b2e-34fc0d6b4d8d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreen?screenId={{screenId}}","description":"<p><strong>Get Screen</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetScreen</code></li>\n<li><strong>Parameters</strong>:<ul>\n<li><code>screenId</code> (query): GUID of the screen to retrieve</li>\n</ul>\n</li>\n<li><strong>Description</strong>: Retrieves a custom screen by screen ID</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetScreen"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>GUID of the screen to retrieve</p>\n","type":"text/plain"},"key":"screenId","value":"{{screenId}}"}],"variable":[]}},"response":[{"id":"7ae6cc44-c39e-4969-a85c-d3d658afc477","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetScreen?screenId=12345678-1234-1234-1234-123456789012","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetScreen"],"query":[{"key":"screenId","value":"12345678-1234-1234-1234-123456789012"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": {\n    \"Id\": \"12345678-1234-1234-1234-123456789012\",\n    \"Name\": \"Screen Name\",\n    \"Description\": \"Screen Description\",\n    \"Json\": \"{...}\",\n    \"IsForm\": false,\n    \"History\": \"{...}\"\n  }\n}"},{"id":"3ea63a63-fadc-428d-89a8-27b4018211cb","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetScreen?screenId=00000000-0000-0000-0000-000000000000","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetScreen"],"query":[{"key":"screenId","value":"00000000-0000-0000-0000-000000000000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"SaveForm: Screen Not Found\",\n    \"System.Exception: Screen Not Found\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"0eec1bcd-de6b-4029-9b2e-34fc0d6b4d8d"},{"name":"Get Screens","id":"59c98367-ba95-467a-98a3-21ab48bd894e","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreens","description":"<p><strong>Get Screens</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetScreens</code></li>\n<li><strong>Parameters</strong>:<ul>\n<li><code>excludeFormTypeScreen</code> (query, optional): Boolean to exclude form type screens</li>\n</ul>\n</li>\n<li><strong>Description</strong>: Retrieves all custom screens with optional filtering</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetScreens"],"host":["{{base_url}}"],"query":[{"disabled":true,"description":{"content":"<p>Boolean to exclude form type screens (optional)</p>\n","type":"text/plain"},"key":"excludeFormTypeScreen","value":"{{excludeFormTypeScreen}}"}],"variable":[]}},"response":[{"id":"b8a3de55-c94b-41e7-8bce-b1ad47ffdb39","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetScreens","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetScreens"],"query":[{"key":"excludeFormTypeScreen","value":"{{excludeFormTypeScreen}}","description":"Boolean to exclude form type screens (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": \"12345678-1234-1234-1234-123456789012\",\n      \"Name\": \"Screen Name\",\n      \"Description\": \"Screen Description\",\n      \"Json\": \"{...}\",\n      \"IsForm\": false\n    }\n  ]\n}"},{"id":"4fda4991-4628-40a9-bb11-f12d6cc6f81c","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetScreens","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetScreens"],"query":[{"key":"excludeFormTypeScreen","value":"{{excludeFormTypeScreen}}","description":"Boolean to exclude form type screens (optional)","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"59c98367-ba95-467a-98a3-21ab48bd894e"},{"name":"Save Form","id":"020fb627-6cb3-4538-bb2f-18e5371165dc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"{{custom_screen_form_id}}\",\n  \"Name\": \"Form Name\",\n  \"Description\": \"Form Description\",\n  \"ParentType\": \"Account\",\n  \"Json\": {\n    \"formFields\": [\n      {\n        \"fieldName\": \"field1\",\n        \"fieldType\": \"text\",\n        \"required\": true\n      }\n    ]\n  }\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveForm","description":"<p><strong>Save Form</strong></p>\n<ul>\n<li><p><strong>Method</strong>: POST</p>\n</li>\n<li><p><strong>Path</strong>: <code>/SaveForm</code></p>\n</li>\n<li><p><strong>Description</strong>: Saves (creates or updates) a custom form</p>\n</li>\n</ul>\n<p><strong>Body</strong> (<code>FormObject</code>):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Optional Guid. Existing form id to update; omit or send an empty Guid to create a new form.</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>Required string. Form name.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>Optional string. Form description.</td>\n</tr>\n<tr>\n<td><em>ParentType</em></td>\n<td>Required. Parent entity type the form applies to, as the enum name (e.g. <code>Account</code>, <code>Customer</code>, <code>Collateral</code>) or its integer value.</td>\n</tr>\n<tr>\n<td><em>Json</em></td>\n<td>Required object. Form definition JSON (fields, layout, and validation).</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","Client","CustomScreens","SaveForm"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1552533d-bb3d-4d85-aedb-de3cbeab38d4","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"12345678-1234-1234-1234-123456789012\",\n  \"Name\": \"Form Name\",\n  \"Description\": \"Form Description\",\n  \"ParentType\": 1,\n  \"Json\": {\n    \"formFields\": [\n      {\n        \"fieldName\": \"field1\",\n        \"fieldType\": \"text\",\n        \"required\": true\n      }\n    ]\n  }\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveForm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": []\n}"},{"id":"83cf19a3-ac19-4fbc-b00c-d1a98462a5b4","name":"Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"00000000-0000-0000-0000-000000000000\",\n  \"Name\": \"Form Name\",\n  \"Description\": \"Form Description\",\n  \"ParentType\": 1,\n  \"Json\": null\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveForm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"SaveForm: Invalid parameter data\",\n    \"System.Exception: Invalid parameter data\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"020fb627-6cb3-4538-bb2f-18e5371165dc"},{"name":"Save Screen","id":"a96811af-bb1b-48d9-a0b3-9b806ef920eb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"{{custom_screen_id}}\",\n  \"Name\": \"Screen Name\",\n  \"Description\": \"Screen Description\",\n  \"IsForm\": false,\n  \"Json\": {\n    \"rows\": {}\n  }\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveScreen","description":"<p><strong>Save Screen</strong></p>\n<ul>\n<li><p><strong>Method</strong>: POST</p>\n</li>\n<li><p><strong>Path</strong>: <code>/SaveScreen</code></p>\n</li>\n<li><p><strong>Description</strong>: Saves (creates or updates) a custom screen</p>\n</li>\n</ul>\n<p><strong>Body</strong> (<code>CustomScreenObject</code>):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Optional Guid. Existing screen id to update; omit or send an empty Guid to create a new screen.</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>Required string. Screen name.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>Optional string. Screen description.</td>\n</tr>\n<tr>\n<td><em>IsForm</em></td>\n<td>Required boolean. <code>true</code> marks the screen as a form-type screen; <code>false</code> for a standard screen.</td>\n</tr>\n<tr>\n<td><em>Json</em></td>\n<td>Required object. Screen layout JSON (rows/columns and the components placed in them).</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","Client","CustomScreens","SaveScreen"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"aee3242a-4c8f-4532-a6fa-2141821113db","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"12345678-1234-1234-1234-123456789012\",\n  \"Name\": \"Screen Name\",\n  \"Description\": \"Screen Description\",\n  \"IsForm\": false,\n  \"Json\": {\n    \"rows\": {\n      \"1\": {\n        \"columns\": {\n          \"1\": {\n            \"formId\": \"87654321-4321-4321-4321-210987654321\",\n            \"manyToOneOption\": \"0\"\n          }\n        }\n      }\n    }\n  }\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveScreen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": []\n}"},{"id":"087ff494-abdc-4892-9299-5379c12c21c7","name":"Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"00000000-0000-0000-0000-000000000000\",\n  \"Name\": \"Screen Name\",\n  \"Description\": \"Screen Description\",\n  \"IsForm\": false,\n  \"Json\": null\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveScreen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"SaveCustomScreen: Invalid parameter data\",\n    \"System.Exception: Invalid parameter data\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"a96811af-bb1b-48d9-a0b3-9b806ef920eb"},{"name":"Get Screen Usage","id":"6caa672a-2ac8-49cd-9463-b04ab5e4665c","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenUsage?screenId={{screenId}}","description":"<p><strong>Get Screen Usage</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetScreenUsage</code></li>\n<li><strong>Parameters</strong>:<ul>\n<li><code>screenId</code> (query): GUID of the standard (non-form) screen to check</li>\n</ul>\n</li>\n<li><strong>Description</strong>: Reports whether a custom screen is still referenced by task templates or screen links, without deleting anything. <code>data.InUse</code> is <code>true</code> when <code>data.References</code> lists any consumer; <code>data.Deleted</code> is always <code>false</code> for this call. Form-type screens return an error and are reviewed from Custom Form Setup (<code>GetFormUsage</code>) instead.</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetScreenUsage"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>GUID of the standard (non-form) screen to check</p>\n","type":"text/plain"},"key":"screenId","value":"{{screenId}}"}],"variable":[]}},"response":[{"id":"d3216297-9a3c-46fc-a72e-b6cd6dc722d3","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetScreenUsage?screenId=12345678-1234-1234-1234-123456789012","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetScreenUsage"],"query":[{"key":"screenId","value":"12345678-1234-1234-1234-123456789012"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": {\n    \"Deleted\": false,\n    \"InUse\": true,\n    \"Message\": \"Screen \\\"Collateral Review\\\" is in use by task template \\\"Repo follow-up\\\" and cannot be deleted.\",\n    \"References\": [\n      \"task template \\\"Repo follow-up\\\"\"\n    ]\n  }\n}"},{"id":"1cfeaa70-3b46-4c63-90e3-0c5b5d117c6d","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetScreenUsage?screenId=00000000-0000-0000-0000-000000000000","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetScreenUsage"],"query":[{"key":"screenId","value":"00000000-0000-0000-0000-000000000000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"GetScreenUsage: Screen Id is required.\",\n    \"System.Exception: Screen Id is required.\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"6caa672a-2ac8-49cd-9463-b04ab5e4665c"},{"name":"Delete Screen","id":"e291252f-478d-4d96-8bab-777e34724b20","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"{{screenId}}\"\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/DeleteScreen","description":"<p><strong>Delete Screen</strong></p>\n<ul>\n<li><strong>Method</strong>: POST</li>\n<li><strong>Path</strong>: <code>/DeleteScreen</code></li>\n<li><strong>Description</strong>: Deletes a standard (non-form) custom screen when nothing references it. When task templates or screen links still use the screen, nothing is deleted and the response lists the consumers (<code>data.InUse</code> = <code>true</code>, <code>data.Deleted</code> = <code>false</code>). Form-type screens cannot be deleted here; delete the form with <code>DeleteForm</code> instead.</li>\n</ul>\n<p><strong>Body</strong> (<code>DeleteCustomDefinitionRequest</code>):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Required Guid. Screen id to delete.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","Client","CustomScreens","DeleteScreen"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d0538b3e-644d-4a2d-b60c-78556858023e","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"12345678-1234-1234-1234-123456789012\"\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/DeleteScreen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": {\n    \"Deleted\": true,\n    \"InUse\": false,\n    \"Message\": \"Screen \\\"Collateral Review\\\" was deleted.\",\n    \"References\": []\n  }\n}"},{"id":"0c37100a-d886-4258-805b-e822e5edc7a0","name":"Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"12345678-1234-1234-1234-123456789012\"\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/DeleteScreen"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": {\n    \"Deleted\": false,\n    \"InUse\": true,\n    \"Message\": \"Screen \\\"Collateral Review\\\" is in use by task template \\\"Repo follow-up\\\", screen link \\\"View Account\\\" and cannot be deleted.\",\n    \"References\": [\n      \"task template \\\"Repo follow-up\\\"\",\n      \"screen link \\\"View Account\\\"\"\n    ]\n  }\n}"}],"_postman_id":"e291252f-478d-4d96-8bab-777e34724b20"},{"name":"Get Form Usage","id":"b2b937fa-6bc6-4840-9879-3ce5a05d200d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetFormUsage?formId={{componentId}}","description":"<p><strong>Get Form Usage</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetFormUsage</code></li>\n<li><strong>Parameters</strong>:<ul>\n<li><code>formId</code> (query): GUID of the custom form (component) to check</li>\n</ul>\n</li>\n<li><strong>Description</strong>: Reports whether a custom form is still in use, without deleting anything. References include standard screens that place the form, consumers of any form-type wrapper screen (task templates, screen links), and saved field values stored under custom field keys that only this form defines for its parent type (values under keys another form of the same parent type still defines stay reachable and are not counted). <code>data.InUse</code> is <code>true</code> when <code>data.References</code> is non-empty; <code>data.Deleted</code> is always <code>false</code> for this call.</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetFormUsage"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>GUID of the custom form to check</p>\n","type":"text/plain"},"key":"formId","value":"{{componentId}}"}],"variable":[]}},"response":[{"id":"5c531d09-1a21-4197-a8a9-8e3f0e1d8729","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetFormUsage?formId=12345678-1234-1234-1234-123456789012","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetFormUsage"],"query":[{"key":"formId","value":"12345678-1234-1234-1234-123456789012"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": {\n    \"Deleted\": false,\n    \"InUse\": true,\n    \"Message\": \"Form \\\"Collateral Condition\\\" is in use by screen \\\"Collateral Review\\\", 12 saved field values and cannot be deleted.\",\n    \"References\": [\n      \"screen \\\"Collateral Review\\\"\",\n      \"12 saved field values\"\n    ]\n  }\n}"},{"id":"45e98767-645f-40a4-9a8a-5ada805f2ddf","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/GetFormUsage?formId=00000000-0000-0000-0000-000000000000","host":["{{base_url}}"],"path":["api","Client","CustomScreens","GetFormUsage"],"query":[{"key":"formId","value":"00000000-0000-0000-0000-000000000000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"GetFormUsage: Form Id is required.\",\n    \"System.Exception: Form Id is required.\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"b2b937fa-6bc6-4840-9879-3ce5a05d200d"},{"name":"Delete Form","id":"bef1ad7b-173b-4e2e-9bda-faf11c5e6eda","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"{{componentId}}\"\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/DeleteForm","description":"<p><strong>Delete Form</strong></p>\n<ul>\n<li><strong>Method</strong>: POST</li>\n<li><strong>Path</strong>: <code>/DeleteForm</code></li>\n<li><strong>Description</strong>: Deletes a custom form (component) together with its form-type wrapper screens when nothing uses it. When standard screens, task templates, screen links, or saved field values that only this form's keys reach still reference the form, nothing is deleted and the response lists the consumers (<code>data.InUse</code> = <code>true</code>, <code>data.Deleted</code> = <code>false</code>). Check first with <code>GetFormUsage</code>.</li>\n</ul>\n<p><strong>Body</strong> (<code>DeleteCustomDefinitionRequest</code>):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Required Guid. Form id to delete.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","Client","CustomScreens","DeleteForm"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"28721586-c678-428f-ba5a-e4117570593f","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"12345678-1234-1234-1234-123456789012\"\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/DeleteForm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": {\n    \"Deleted\": true,\n    \"InUse\": false,\n    \"Message\": \"Form \\\"Collateral Condition\\\" was deleted.\",\n    \"References\": []\n  }\n}"},{"id":"ba0e9954-507c-4ae7-8a67-dde306dabd0e","name":"Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"Id\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/DeleteForm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"DeleteCustomScreenForm: Form Id is required.\",\n    \"System.Exception: Form Id is required.\"\n  ],\n  \"data\": null\n}"}],"_postman_id":"bef1ad7b-173b-4e2e-9bda-faf11c5e6eda"}],"id":"3ae4593b-23bf-4b26-81f9-1149de30149b","description":"<p>Endpoints for managing custom screen forms and screens. Includes form creation, retrieval, and screen management functionality.</p>\n","_postman_id":"3ae4593b-23bf-4b26-81f9-1149de30149b"},{"name":"Custom Fields","item":[{"name":"Get Custom Form Fields","id":"ea34c744-e317-4b88-a2a0-340c4dd75c5d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/CustomFormFields?parentEntityType={{parentEntityType}}&parentEntityId={{parentEntityId}}","description":"<p><strong>Get Custom Form Fields</strong></p>\n<ul>\n<li><p><strong>Method</strong>: GET</p>\n</li>\n<li><p><strong>Path</strong>: <code>/CustomFormFields</code></p>\n</li>\n<li><p><strong>Parameters</strong>:</p>\n<ul>\n<li><p><code>parentEntityType</code> (query): Parent entity type (integer)</p>\n</li>\n<li><p><code>parentEntityId</code> (query): Parent entity identifier - can be GUID, account number, code, etc. (converted based on ParentType)</p>\n</li>\n</ul>\n</li>\n<li><p><strong>Description</strong>: Retrieves custom form fields for a parent entity</p>\n</li>\n<li><p><strong>Identifier Examples</strong>:</p>\n<ul>\n<li><p>Account: Use account number (e.g., \"123456\")</p>\n</li>\n<li><p>Customer: Use customer ID or number</p>\n</li>\n<li><p>Branch: Use branch number</p>\n</li>\n<li><p>Vendor/Dealer: Use vendor code or name</p>\n</li>\n<li><p>User: Use user login or ID</p>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","CustomFormFields"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>Parent entity type (integer)</p>\n","type":"text/plain"},"key":"parentEntityType","value":"{{parentEntityType}}"},{"description":{"content":"<p>Parent entity identifier - can be GUID, account number, code, etc. (converted based on ParentType)</p>\n","type":"text/plain"},"key":"parentEntityId","value":"{{parentEntityId}}"}],"variable":[]}},"response":[{"id":"f3439aa4-102b-4440-990d-bf808a5836d8","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/CustomFormFields?parentEntityType=1&parentEntityId=12345678-1234-1234-1234-123456789012","host":["{{base_url}}"],"path":["api","Client","CustomScreens","CustomFormFields"],"query":[{"key":"parentEntityType","value":"1"},{"key":"parentEntityId","value":"12345678-1234-1234-1234-123456789012"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Key\": \"field1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"Label\": \"field label\"\n    }\n  ]\n}"},{"id":"db6bdda3-8901-495e-a703-ad3f161dc283","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/CustomFormFields?parentEntityType=1&parentEntityId=INVALID","host":["{{base_url}}"],"path":["api","Client","CustomScreens","CustomFormFields"],"query":[{"key":"parentEntityType","value":"1"},{"key":"parentEntityId","value":"INVALID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"Invalid parent entity ID or unable to convert to GUID\"\n  ]\n}"}],"_postman_id":"ea34c744-e317-4b88-a2a0-340c4dd75c5d"},{"name":"Get Custom Form Omega Fields","id":"6d93758b-1c76-4044-be17-b0700dfb11e4","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields?parentEntityType={{parentEntityType}}&parentEntityId={{parentEntityId}}&omegaFields={{omegaFields}}","description":"<p><strong>Get Custom Form Omega Fields</strong></p>\n<p><strong>HTTP Method:</strong> GET\n<strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields</code></p>\n<ul>\n<li><strong>Parameters</strong>:<ul>\n<li><code>parentEntityType</code> (query): Parent entity type (integer)</li>\n<li><code>parentEntityId</code> (query): Parent entity identifier - can be GUID, account number, code, etc. (converted based on ParentType)</li>\n<li><code>omegaFields</code> (query): Comma-separated list of Omega field names</li>\n</ul>\n</li>\n<li><strong>Description</strong>: Retrieves Omega database field values for custom form fields</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","CustomFormOmegaFields"],"host":["{{base_url}}"],"query":[{"description":{"content":"<p>Parent entity type (integer)</p>\n","type":"text/plain"},"key":"parentEntityType","value":"{{parentEntityType}}"},{"description":{"content":"<p>Parent entity identifier - can be GUID, account number, code, etc. (converted based on ParentType)</p>\n","type":"text/plain"},"key":"parentEntityId","value":"{{parentEntityId}}"},{"description":{"content":"<p>Comma-separated list of Omega field names</p>\n","type":"text/plain"},"key":"omegaFields","value":"{{omegaFields}}"}],"variable":[]}},"response":[{"id":"dc55c875-479d-4476-9b72-ca7eef671763","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields?parentEntityType=1&parentEntityId=12345678-1234-1234-1234-123456789012&omegaFields=AccountNumber,Description","host":["{{base_url}}"],"path":["api","Client","CustomScreens","CustomFormOmegaFields"],"query":[{"key":"parentEntityType","value":"1"},{"key":"parentEntityId","value":"12345678-1234-1234-1234-123456789012"},{"key":"omegaFields","value":"AccountNumber,Description"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Key\": \"AccountNumber\",\n      \"Type\": \"text\",\n      \"Value\": \"12345\"\n    },\n    {\n      \"Key\": \"Description\",\n      \"Type\": \"text\",\n      \"Value\": \"Account Description\"\n    }\n  ]\n}"},{"id":"86df923b-a9af-41d0-b46c-a6ff57a1508a","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields?parentEntityType=1&parentEntityId=INVALID&omegaFields=AccountNumber,Description","host":["{{base_url}}"],"path":["api","Client","CustomScreens","CustomFormOmegaFields"],"query":[{"key":"parentEntityType","value":"1"},{"key":"parentEntityId","value":"INVALID"},{"key":"omegaFields","value":"AccountNumber,Description"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"Invalid parent entity ID or unable to convert to GUID\"\n  ]\n}"}],"_postman_id":"6d93758b-1c76-4044-be17-b0700dfb11e4"},{"name":"Save Custom Form Fields","id":"e91a3233-70ab-4b82-9d6b-44c1a451ce4f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ParentType\": 1,\n  \"ParentEntityId\": \"ACC123456\",\n  \"Fields\": [\n    {\n      \"Key\": \"field1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"Label\": \"field label\"\n    },\n    {\n      \"Key\": \"field2\",\n      \"Type\": \"number\",\n      \"Value\": \"123\",\n      \"Label\": \"field label\"\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/CustomFormFields","description":"<p><strong>Save Custom Form Fields</strong></p>\n<ul>\n<li><p><strong>Method</strong>: POST</p>\n</li>\n<li><p><strong>Path</strong>: <code>/CustomFormFields</code></p>\n</li>\n<li><p><strong>Description</strong>: Saves custom form field values for a parent entity</p>\n</li>\n</ul>\n<p><strong>Body</strong> (<code>CustomFormFieldRequest</code>):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>ComponentId</em></td>\n<td>Optional Guid. Custom screen/form component the fields belong to.</td>\n</tr>\n<tr>\n<td><em>ParentType</em></td>\n<td>Required. Parent entity type, as the enum name or its integer value (e.g. <code>1</code> = Account).</td>\n</tr>\n<tr>\n<td><em>ParentEntityId</em></td>\n<td>Required string. Parent entity identifier — a Guid or a natural key (e.g. account number) that is resolved to the entity server-side.</td>\n</tr>\n<tr>\n<td><em>Fields</em></td>\n<td>Required array. Field objects to save; each item has <code>Key</code>, <code>Type</code>, <code>Value</code>, and <code>Label</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","Client","CustomScreens","CustomFormFields"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"30fd5716-f98e-4533-b547-9b2e1c7a9314","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ParentType\": 1,\n  \"ParentEntityId\": \"123456\",\n  \"Fields\": [\n    {\n      \"Key\": \"field1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"Label\": \"field label\",\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/CustomFormFields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": []\n}"},{"id":"5ae69382-1c21-4822-b35b-59b894c5b490","name":"Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ParentType\": 1,\n  \"ParentEntityId\": \"INVALID\",\n  \"Fields\": [\n    {\n      \"Key\": \"field1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"Label\": \"field label\"\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/CustomFormFields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"Invalid parent entity ID or unable to convert to GUID\"\n  ]\n}"}],"_postman_id":"e91a3233-70ab-4b82-9d6b-44c1a451ce4f"},{"name":"Save Custom Form Omega Fields","id":"4fe41f24-94ec-4c63-a67c-34af6ba63617","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ComponentId\": \"00000000-0000-0000-0000-000000000000\",\n  \"ParentType\": 1,\n  \"ParentEntityId\": \"ACC123456\",\n  \"Fields\": [\n    {\n      \"Key\": \"OmegaFieldName1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"Label\": \"field label\"\n    },\n    {\n      \"Key\": \"OmegaFieldName2\",\n      \"Type\": \"number\",\n      \"Value\": \"123\",\n      \"Label\": \"field label\"\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields","description":"<p><strong>Save Custom Form Omega Fields</strong></p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields</code></p>\n<ul>\n<li><p><strong>Body</strong>: CustomFormOmegaFieldRequest</p>\n</li>\n<li><p><strong>Description</strong>: Saves Omega database field values driven by a custom\nform/component for the given parent entity. The server resolves\n<code>ParentEntityId</code> to the underlying entity (account number, customer id,\nbranch number, vendor code, user login, etc.) based on <code>ParentType</code>, then\napplies the field updates via <code>CustomScreenOmegaFieldUpdateServices.SaveOmegaFields</code>.</p>\n</li>\n<li><p><strong>Body fields</strong>:</p>\n<ul>\n<li><p><code>ComponentId</code> (Guid, required): Custom component definition this save targets.</p>\n</li>\n<li><p><code>ParentType</code> (integer, required): Parent entity type enum value.</p>\n</li>\n<li><p><code>ParentEntityId</code> (string, required): Parent entity identifier. Format\ndepends on <code>ParentType</code> (account number, customer id/number, branch\nnumber, vendor/dealer code, user login, etc.).</p>\n</li>\n<li><p><code>Fields</code> (array, required): List of field objects to save. Each item is\na key/type/value/label record matching the component's Omega field\ndefinitions.</p>\n</li>\n</ul>\n</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","CustomFormOmegaFields"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b352622c-2934-4085-84f7-71991c395780","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ComponentId\": \"12345678-1234-1234-1234-123456789012\",\n  \"ParentType\": 1,\n  \"ParentEntityId\": \"123456\",\n  \"Fields\": [\n    {\n      \"Key\": \"OmegaFieldName1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"Label\": \"field label\"\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Key\": \"OmegaFieldName1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"CanEdit\": true,\n      \"EditBlockedReason\": null\n    }\n  ]\n}"},{"id":"c09d6355-9218-4f43-b5d1-b2c69fffe373","name":"Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ComponentId\": \"12345678-1234-1234-1234-123456789012\",\n  \"ParentType\": 1,\n  \"ParentEntityId\": \"INVALID\",\n  \"Fields\": [\n    {\n      \"Key\": \"OmegaFieldName1\",\n      \"Type\": \"text\",\n      \"Value\": \"field value\",\n      \"Label\": \"field label\"\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/CustomFormOmegaFields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"Invalid parent entity ID or unable to convert to GUID\"\n  ]\n}"}],"_postman_id":"4fe41f24-94ec-4c63-a67c-34af6ba63617"}],"id":"89eaaef7-40a2-4a9f-834b-efd4f26ca336","description":"<p>Endpoints for managing custom form fields. Supports various parent entity types with flexible identifier conversion (GUIDs, account numbers, codes, etc.).</p>\n","_postman_id":"89eaaef7-40a2-4a9f-834b-efd4f26ca336"},{"name":"Screen Links","item":[{"name":"Get Screen Link Parent Entities","id":"072ca07b-72e2-480a-948a-e442d6adde49","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinkParentEntities","description":"<p><strong>Get Screen Link Parent Entities</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetScreenLinkParentEntities</code></li>\n<li><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</li>\n<li><strong>Description</strong>: Retrieves screen link parent entities</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetScreenLinkParentEntities"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f66d7a53-1463-4f65-8aea-650356fee1bd","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinkParentEntities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": {\n    \"1\": [\n      {\n        \"Id\": \"12345678-1234-1234-1234-123456789012\",\n        \"Name\": \"Entity Name\",\n        \"Desc\": \"Entity Description\"\n      }\n    ]\n  }\n}"},{"id":"1712747a-f2fc-46b5-bc98-c39676e09733","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinkParentEntities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"GetScreenLinkParentEntities: Object reference not set to an instance of an object.\"\n  ]\n}"}],"_postman_id":"072ca07b-72e2-480a-948a-e442d6adde49"},{"name":"Get Screen Link Parent Types","id":"4d645816-7260-4c0f-a3de-98c9d3a5538a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinkParentTypes","description":"<p><strong>Get Screen Link Parent Types</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetScreenLinkParentTypes</code></li>\n<li><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</li>\n<li><strong>Description</strong>: Retrieves screen link parent types</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetScreenLinkParentTypes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e7794e77-b89b-4fb5-b65f-56167ab97645","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinkParentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"Screen Link Parent Type 1\"\n    }\n  ]\n}"},{"id":"252b171c-35e2-4cfc-b932-4cddc1641526","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinkParentTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"GetScreenLinkParentTypes: Object reference not set to an instance of an object.\"\n  ]\n}"}],"_postman_id":"4d645816-7260-4c0f-a3de-98c9d3a5538a"},{"name":"Get Screen Links","id":"b751cbc1-bc59-4e07-8e46-1d3bc6f9c09b","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinks","description":"<p><strong>Get Screen Links</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetScreenLinks</code></li>\n<li><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</li>\n<li><strong>Description</strong>: Retrieves all screen links</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetScreenLinks"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"40177114-a157-46fd-9335-8b125967deb0","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"ScreenType\": 1,\n      \"Json\": \"{...}\"\n    }\n  ]\n}"},{"id":"fca3abd0-0707-4084-89c4-998b9e3c6a00","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenLinks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"GetScreenLinks: Object reference not set to an instance of an object.\"\n  ]\n}"}],"_postman_id":"b751cbc1-bc59-4e07-8e46-1d3bc6f9c09b"},{"name":"Get Screen Types","id":"4d434ab9-526b-41a0-a7ad-39db4bed2261","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenTypes","description":"<p><strong>Get Screen Types</strong></p>\n<ul>\n<li><strong>Method</strong>: GET</li>\n<li><strong>Path</strong>: <code>/GetScreenTypes</code></li>\n<li><strong>Parameters</strong>: None. Requires only authentication (token, <code>SessionId</code> header, or signed API headers).</li>\n<li><strong>Description</strong>: Retrieves all available screen types</li>\n</ul>\n","urlObject":{"path":["api","Client","CustomScreens","GetScreenTypes"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"61c9f2b5-c67d-4352-a7de-927c119dd3a7","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": [],\n  \"data\": [\n    {\n      \"Id\": 1,\n      \"Name\": \"Screen Type 1\"\n    }\n  ]\n}"},{"id":"245e7694-1aeb-4b96-b7e5-8d7514f0a4da","name":"Fail Response","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/api/Client/CustomScreens/GetScreenTypes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"GetScreenTypes: Object reference not set to an instance of an object.\"\n  ]\n}"}],"_postman_id":"4d434ab9-526b-41a0-a7ad-39db4bed2261"},{"name":"Save Screen Link","id":"b2edcadd-56c1-4396-bec6-9152529db2bb","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ScreenType\": 1,\n  \"Json\": {\n    \"screenLinkData\": {\n      \"parentType\": 1,\n      \"parentId\": \"12345678-1234-1234-1234-123456789012\",\n      \"screenId\": \"87654321-4321-4321-4321-210987654321\"\n    }\n  }\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveScreenLink","description":"<p><strong>Save Screen Link</strong></p>\n<ul>\n<li><p><strong>Method</strong>: POST</p>\n</li>\n<li><p><strong>Path</strong>: <code>/SaveScreenLink</code></p>\n</li>\n<li><p><strong>Description</strong>: Saves a screen link (associates a custom screen with a parent record/type)</p>\n</li>\n</ul>\n<p><strong>Body</strong> (<code>ScreenLinkObject</code>):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>ScreenType</em></td>\n<td>Required. Screen type the link applies to, as the enum name or its integer value.</td>\n</tr>\n<tr>\n<td><em>Json</em></td>\n<td>Required object. Screen-link definition JSON; includes <code>parentType</code>, <code>parentId</code>, and <code>screenId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["api","Client","CustomScreens","SaveScreenLink"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2fbe69b2-d04f-4bd2-ac27-45f103b3899e","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ScreenType\": 1,\n  \"Json\": {\n    \"screenLinkData\": {\n      \"parentType\": 1,\n      \"parentId\": \"12345678-1234-1234-1234-123456789012\",\n      \"screenId\": \"87654321-4321-4321-4321-210987654321\"\n    }\n  }\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveScreenLink"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Ok\",\n  \"errors\": []\n}"},{"id":"0db59384-fdfb-4f8b-9739-84b357df5f78","name":"Fail Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ScreenType\": 1,\n  \"Json\": null\n}","options":{"raw":{"language":"text"}}},"url":"{{base_url}}/api/Client/CustomScreens/SaveScreenLink"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": \"Error\",\n  \"errors\": [\n    \"SaveScreenLink: Invalid parameter data\"\n  ]\n}"}],"_postman_id":"b2edcadd-56c1-4396-bec6-9152529db2bb"}],"id":"11628560-f1d4-419e-b3be-5aa133f9fa0e","description":"<p>Endpoints for managing screen links and associations. Handles screen linking functionality and parent entity relationships.</p>\n","_postman_id":"11628560-f1d4-419e-b3be-5aa133f9fa0e"}],"id":"1176423f-2c8a-4c75-9520-94637e909b95","_postman_id":"1176423f-2c8a-4c75-9520-94637e909b95","description":""},{"name":"Alerts","item":[{"name":"CheckUnconfirmedPaymentReversals","id":"5d5ffa45-d3b2-480d-834f-f402dabf352a","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/check","description":"<h3 id=\"check-unconfirmed-payment-reversals\">Check Unconfirmed Payment Reversals</h3>\n<p>Returns a boolean indicating whether any unconfirmed (transmission-error) payment reversals exist for the current client. Intended to drive the alert badge/icon in the UI — use the <code>count/{fundsType}</code> variant to retrieve a funds-type-scoped count, and the <code>{id}</code> variant to retrieve a single transmission record.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/check</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response Data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>hasUnpostedReversals</em></td>\n<td>Boolean. <code>true</code> when at least one unconfirmed payment reversal transmission exists for the current client.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Alerts","UnconfirmedPaymentReversal","check"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"eb44422a-382d-47c0-93d8-dc4d1eb025cb","name":"CheckUnconfirmedPaymentReversals - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/check"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"hasUnpostedReversals\": true\n    }\n}"},{"id":"efd5b73a-d017-4ade-9e2d-5d6617677aee","name":"CheckUnconfirmedPaymentReversals - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error checking unconfirmed payment reversals: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"5d5ffa45-d3b2-480d-834f-f402dabf352a"},{"name":"CheckUnpostedPayments","id":"42316b37-15c5-4b7d-9cf2-83c3c17bf559","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/check","description":"<h3 id=\"check-unposted-payments\">Check Unposted Payments</h3>\n<p>Returns a boolean indicating whether any unposted payments exist for the current client. Intended to drive the alert badge/icon in the UI — use the <code>count/{fundsType}</code> variant to retrieve a funds-type-scoped count, and the <code>{id}</code> variant to retrieve a single unposted payment record.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Alerts/UnpostedPayment/check</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response Data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>hasUnpostedPayments</em></td>\n<td>Boolean. <code>true</code> when at least one unposted payment exists for the current client.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Alerts","UnpostedPayment","check"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b7747e2c-2676-47ca-9978-fbbb5bdf90a0","name":"CheckUnpostedPayments - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/check"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"hasUnpostedPayments\": true\n    }\n}"},{"id":"cfe9e153-8e79-4886-837e-9ea77d915ed2","name":"CheckUnpostedPayments - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error checking unposted payments: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"42316b37-15c5-4b7d-9cf2-83c3c17bf559"},{"name":"UnconfirmedPaymentReversalCountGet","id":"b3b01cdb-6ebf-4a22-9d3f-896b0bdce9af","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/count/{{funds_type}}","description":"<h3 id=\"get-unconfirmed-payment-reversal-count\">Get Unconfirmed Payment Reversal Count</h3>\n<p>Returns the count of unconfirmed (transmission-error) payment reversals for the current client, scoped to a single funds type. Use the <code>check</code> variant for a plain boolean indicator, and the <code>{id}</code> variant to retrieve a single transmission record.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/count/{fundsType}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fundsType</em></td>\n<td>Required int. <code>Omega.Servicing.Types.Enums.FundsType</code> value — Cash=1, Check=2, Money_Order=3, Cashiers_Check=4, ACH=5, Credit_Card=6, InterPoynt=11, PayNearMe_Cash=12, Money_Transfer=13, Payment_Vision_Credit_Card=15, Payment_Vision_ACH=16, etc.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response Data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>count</em></td>\n<td>Integer. Number of unconfirmed payment reversal transmissions matching the supplied funds type for the current client.</td>\n</tr>\n<tr>\n<td><em>fundsType</em></td>\n<td>Integer. Echo of the funds type value passed in the route.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Alerts","UnconfirmedPaymentReversal","count","{{funds_type}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a4497c26-0bda-436b-acea-531c84ca3bf9","name":"GetUnconfirmedPaymentReversalCount - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/count/15"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"count\": 3,\n        \"fundsType\": 15\n    }\n}"},{"id":"7a7fd425-f867-43da-afbe-9e09bb74eb03","name":"GetUnconfirmedPaymentReversalCount - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/count/999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error getting unconfirmed payment reversal count: 999 is not a valid value for FundsType.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b3b01cdb-6ebf-4a22-9d3f-896b0bdce9af"},{"name":"UnconfirmedPaymentReversalGet","id":"f244fb5b-fd47-40a5-82b3-9b3e3842a2de","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/{{unconfirmed_payment_reversal_id}}","description":"<h3 id=\"get-unconfirmed-payment-reversal\">Get Unconfirmed Payment Reversal</h3>\n<p>Returns a single unconfirmed payment reversal transmission record (<code>Servicing.UnconfirmedPaymentReversalTransmission</code>) resolved by <code>Id</code> (Guid). Returns <code>BadRequest</code> with <code>Unconfirmed payment reversal not found</code> when the id cannot be resolved. Use the <code>check</code> variant for a plain boolean indicator, and the <code>count/{fundsType}</code> variant to retrieve a funds-type-scoped count.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. <code>Servicing.UnconfirmedPaymentReversalTransmission.Id</code>. Must be a valid Guid or the endpoint returns <code>INVALID_PARAMETER_ERROR_MESSAGE</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Alerts","UnconfirmedPaymentReversal","{{unconfirmed_payment_reversal_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6834f4de-9471-41d0-9d69-989a9185cad3","name":"GetUnconfirmedPaymentReversal - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/{{unconfirmed_payment_reversal_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"PaymentTransactionId\": \"00000000-0000-0000-0000-000000000000\",\n        \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"ElectronicPaymentId\": \"PV-REV-1234567\",\n        \"FundsType\": 15,\n        \"ReverseType\": 1,\n        \"RecordType\": 1,\n        \"CalculationDate\": \"2026-04-17T00:00:00\",\n        \"Comment\": \"Transmission error contacting Payment Vision reversal endpoint.\",\n        \"AddNsf\": false,\n        \"CreationServerDt\": \"2026-04-17T14:32:10\"\n    }\n}"},{"id":"3afc42b5-b590-4a01-977e-599c37b469ad","name":"GetUnconfirmedPaymentReversal - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnconfirmedPaymentReversal/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Unconfirmed payment reversal not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"f244fb5b-fd47-40a5-82b3-9b3e3842a2de"},{"name":"UnpostedPaymentCountGet","id":"91615f3e-78ef-4f69-a28b-63efde0a5772","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/count/{{funds_type}}","description":"<h3 id=\"get-unposted-payment-count\">Get Unposted Payment Count</h3>\n<p>Returns the count of unposted payments for the current client, scoped to a single funds type. Use the <code>check</code> variant for a plain boolean indicator, and the <code>{id}</code> variant to retrieve a single unposted payment record.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Alerts/UnpostedPayment/count/{fundsType}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fundsType</em></td>\n<td>Required int. <code>Omega.Servicing.Types.Enums.FundsType</code> value — Cash=1, Check=2, Money_Order=3, Cashiers_Check=4, ACH=5, Credit_Card=6, InterPoynt=11, PayNearMe_Cash=12, Money_Transfer=13, Payment_Vision_Credit_Card=15, Payment_Vision_ACH=16, etc.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-data\">Response Data</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>count</em></td>\n<td>Integer. Number of unposted payments matching the supplied funds type for the current client.</td>\n</tr>\n<tr>\n<td><em>fundsType</em></td>\n<td>Integer. Echo of the funds type value passed in the route.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Alerts","UnpostedPayment","count","{{funds_type}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"814381c8-2cf9-4df3-9763-e19495267f1c","name":"GetUnpostedPaymentCount - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/count/15"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"count\": 2,\n        \"fundsType\": 15\n    }\n}"},{"id":"2199777e-19e0-4466-9e14-bd0f1d92b0b4","name":"GetUnpostedPaymentCount - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/count/999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error getting unposted payment count: 999 is not a valid value for FundsType.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"91615f3e-78ef-4f69-a28b-63efde0a5772"},{"name":"UnpostedPaymentGet","id":"3daa6179-ba85-4ce1-8be9-57371fd1a86f","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/{{unposted_payment_id}}","description":"<h3 id=\"get-unposted-payment\">Get Unposted Payment</h3>\n<p>Returns a single unposted payment record (<code>Servicing.AccountUnpostedPayments</code>) resolved by <code>Id</code> (Guid). Returns <code>BadRequest</code> with <code>Unposted payment not found</code> when the id cannot be resolved. Use the <code>check</code> variant for a plain boolean indicator, and the <code>count/{fundsType}</code> variant to retrieve a funds-type-scoped count.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Alerts/UnpostedPayment/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. <code>Servicing.AccountUnpostedPayments.Id</code>. Must be a valid Guid or the endpoint returns <code>INVALID_PARAMETER_ERROR_MESSAGE</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Alerts","UnpostedPayment","{{unposted_payment_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e1335b71-9bf3-4fe5-a9fa-1dcbd9f0ff3e","name":"GetUnpostedPayment - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/{{unposted_payment_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"AccountId\": \"00000000-0000-0000-0000-000000000000\",\n        \"FundsType\": 15,\n        \"Amount\": 250.00,\n        \"TransmissionId\": \"PV-1234567\",\n        \"TransmissionDt\": \"2026-04-17T14:32:10\",\n        \"Comment\": \"Pending confirmation from Payment Vision.\",\n        \"CreationServerDt\": \"2026-04-17T14:32:10\"\n    }\n}"},{"id":"be5cb1d3-80e5-481c-8cc9-d91d732a8a1f","name":"GetUnpostedPayment - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Alerts/UnpostedPayment/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Unposted payment not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"3daa6179-ba85-4ce1-8be9-57371fd1a86f"}],"id":"fd8fc954-556c-40f4-9fb9-b09f019525e9","_postman_id":"fd8fc954-556c-40f4-9fb9-b09f019525e9","description":""},{"name":"Collateral","item":[{"name":"CollateralCodeAdd","id":"d100a1a2-db42-4bcc-b5e6-4951efa52e62","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"description\": \"Auto - Used\",\n  \"active\": true,\n  \"type\": 1,\n  \"note\": \"Used automobile collateral\",\n  \"showTitle\": true,\n  \"titleStatus\": null,\n  \"accountTypeOverride\": 100,\n  \"titleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/AddCollateralCode","description":"<h3 id=\"add-collateral-code\">Add Collateral Code</h3>\n<p>Creates a new Collateral code (<code>Common.CollateralCode</code>). Wraps <code>CollateralCodeWSServices.AddCollateralCodeWS</code>, which rejects the request when another Collateral code already exists with the same <code>description</code> for the caller's client. Returns the newly generated row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/AddCollateralCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Unique (per client) collateral description. Rejected when a code with the same description already exists.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. <code>true</code> makes the code selectable on account/collateral screens.</td>\n</tr>\n<tr>\n<td><em>type</em></td>\n<td>Required int. <code>CollateralTypes</code> enum: <code>1=Auto</code>, <code>2=Truck</code>, <code>3=Vessel</code>, <code>4=Misc</code>.</td>\n</tr>\n<tr>\n<td><em>note</em></td>\n<td>Optional string. Free-form note stored on the code.</td>\n</tr>\n<tr>\n<td><em>showTitle</em></td>\n<td>Required boolean. Controls whether title fields render for collateral using this code.</td>\n</tr>\n<tr>\n<td><em>titleStatus</em></td>\n<td>Optional Guid. <code>CollateralTitleStatusCode.Id</code> linking the default title status.</td>\n</tr>\n<tr>\n<td><em>accountTypeOverride</em></td>\n<td>Optional int. <code>CreditBureauAccountTypes</code> enum override for credit reporting (e.g. <code>1=Unsecured</code>, <code>2=Secured</code>, <code>3=Partially_Secured</code>, <code>6=Installment_Sales_Contract</code>, <code>13=Lease</code>, <code>100=Auto</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>titleStatusCodeOrId</code></td>\n<td><code>titleStatus</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"titleStatusCodeOrId\": \"1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Collateral","AddCollateralCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"350db34c-2931-4b7f-b4d6-46f915a704ce","name":"AddCollateralCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"description\": \"Auto - Used\",\n  \"active\": true,\n  \"type\": 1,\n  \"note\": \"Used automobile collateral\",\n  \"showTitle\": true,\n  \"titleStatus\": null,\n  \"accountTypeOverride\": 100,\n  \"titleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/AddCollateralCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"17f84200-fcac-4c4c-b5cd-115a71653751","name":"AddCollateralCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"description\": \"Auto - Used\",\n  \"active\": true,\n  \"type\": 1,\n  \"note\": \"Used automobile collateral\",\n  \"showTitle\": true,\n  \"titleStatus\": null,\n  \"accountTypeOverride\": 100,\n  \"titleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/AddCollateralCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A collateral code with this description already exists.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d100a1a2-db42-4bcc-b5e6-4951efa52e62"},{"name":"CollateralCodeChangesSave","id":"94b32f50-89e7-42d9-a789-50eb23e10c0b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"description\": \"Auto - Used\",\n  \"active\": true,\n  \"type\": 1,\n  \"note\": \"Used automobile collateral - updated\",\n  \"showTitle\": true,\n  \"titleStatus\": null,\n  \"accountTypeOverride\": 100,\n  \"ts\": \"AAAAAAAAB9E=\",\n  \"titleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/SaveCollateralCodeChanges/{{collateral_code_or_id}}","description":"<h3 id=\"save-collateral-code-changes\">Save Collateral Code Changes</h3>\n<p>Updates an existing Collateral code (<code>Common.CollateralCode</code>) resolved from either its description or <code>Id</code> Guid. Wraps <code>CollateralCodeWSServices.SaveCollateralCodeChangesWS</code> which looks up the row via <code>SharedWSServices.GetCommonCollateralCodeId</code>, re-fetches it to confirm the target exists, then delegates to <code>CollateralCodeServices.SaveCollateralCodeChanges</code>. Caller must pass the latest <code>ts</code> (rowversion) returned by the most recent GET; a stale <code>ts</code> causes an LLBLGen concurrency exception. Returns the updated row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/SaveCollateralCodeChanges/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Collateral code description or <code>Id</code> Guid of the row to update.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New (or unchanged) description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. <code>true</code> keeps the code selectable on screens.</td>\n</tr>\n<tr>\n<td><em>type</em></td>\n<td>Required int. <code>CollateralTypes</code> enum: <code>1=Auto</code>, <code>2=Truck</code>, <code>3=Vessel</code>, <code>4=Misc</code>.</td>\n</tr>\n<tr>\n<td><em>note</em></td>\n<td>Optional string. Free-form note stored on the code.</td>\n</tr>\n<tr>\n<td><em>showTitle</em></td>\n<td>Required boolean. Controls whether title fields render for collateral using this code.</td>\n</tr>\n<tr>\n<td><em>titleStatus</em></td>\n<td>Optional Guid. <code>CollateralTitleStatusCode.Id</code> linking the default title status.</td>\n</tr>\n<tr>\n<td><em>accountTypeOverride</em></td>\n<td>Optional int. <code>CreditBureauAccountTypes</code> enum override (see <code>AddCollateralCode</code> for values).</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Required base64 string. Concurrency rowversion from the most recent <code>ReturnCollateralCode</code> / <code>ReturnCollateralCodes</code> response.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>titleStatusCodeOrId</code></td>\n<td><code>titleStatus</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"titleStatusCodeOrId\": \"1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Collateral","SaveCollateralCodeChanges","{{collateral_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b86d6ecf-5365-41dc-ac4b-28ca950925ff","name":"SaveCollateralCodeChanges - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"description\": \"Auto - Used\",\n  \"active\": true,\n  \"type\": 1,\n  \"note\": \"Used automobile collateral - updated\",\n  \"showTitle\": true,\n  \"titleStatus\": null,\n  \"accountTypeOverride\": 100,\n  \"ts\": \"AAAAAAAAB9E=\",\n  \"titleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/SaveCollateralCodeChanges/{{collateral_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"c745dfc1-4210-440a-8918-843b94d536c3","name":"SaveCollateralCodeChanges - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"description\": \"Nonexistent Code\",\n  \"active\": true,\n  \"type\": 1,\n  \"note\": \"Used automobile collateral - updated\",\n  \"showTitle\": true,\n  \"titleStatus\": null,\n  \"accountTypeOverride\": 100,\n  \"ts\": \"AAAAAAAAB9E=\",\n  \"titleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/SaveCollateralCodeChanges/{{collateral_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Collateral code not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"94b32f50-89e7-42d9-a789-50eb23e10c0b"},{"name":"CollateralColorCodeAdd","id":"5a7e1d1f-423c-4a3f-bbe9-8029ee23093a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Pearl White\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/AddCollateralColorCode","description":"<h3 id=\"add-collateral-color-code\">Add Collateral Color Code</h3>\n<p>Creates a new collateral color code (<code>Common.CollateralColorCode</code>) for the caller's client. Wraps <code>CollateralColorCodeWSServices.AddSaveCollateralColorCodeWS</code>, which rejects the request when another color code already exists with the same <code>description</code> for the client. Returns the newly generated row's Guid in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/AddCollateralColorCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Unique (per client) color description (e.g. <code>Red</code>, <code>Pearl White</code>). Rejected when another code with the same description already exists.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required boolean. <code>true</code> makes the color selectable on collateral screens.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","AddCollateralColorCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d562b4a3-a461-46c1-b265-70be117e21da","name":"AddCollateralColorCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Pearl White\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/AddCollateralColorCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"8a7f4643-4555-4d81-a69b-fdcbb2b7c192","name":"AddCollateralColorCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Pearl White\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/AddCollateralColorCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A collateral color code with this description already exists.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"5a7e1d1f-423c-4a3f-bbe9-8029ee23093a"},{"name":"CollateralColorCodeUpdate","id":"bfb464d2-aa59-4c8b-a557-cac9019b0464","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Pearl White\",\n    \"isAvailable\": true,\n    \"ts\": \"AAAAAAAAB9E=\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/UpdateCollateralColorCode/{{collateral_color_description_or_id}}","description":"<h3 id=\"update-collateral-color-code\">Update Collateral Color Code</h3>\n<p>Updates the description and availability of an existing collateral color code resolved from the <code>{descriptionOrId}</code> route segment. Wraps <code>CollateralColorCodeWSServices.UpdateCollateralColorCodeWS</code>, which applies LLBLGen concurrency via <code>ConcurrencyPredicateType.Save</code> using the <code>ts</code> rowversion echoed from the prior <code>ReturnCollateralColorCode(s)</code> response.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/UpdateCollateralColorCode/{descriptionOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required. Either the current description or the color code <code>Id</code> Guid. Lookup tries description first, then <code>Guid.TryParse</code>. <code>400 Bad Request</code> when empty or unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New (or unchanged) description. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required boolean. <code>true</code> to keep the color selectable on collateral screens.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Required byte[]. Rowversion returned by a prior <code>ReturnCollateralColorCode(s)</code> call. The save fails with a concurrency exception when the stored row has been updated since.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","UpdateCollateralColorCode","{{collateral_color_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c3dcb65d-7fe7-49ae-951d-02d7163d03c0","name":"UpdateCollateralColorCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Pearl White\",\n    \"isAvailable\": true,\n    \"ts\": \"AAAAAAAAB9E=\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/UpdateCollateralColorCode/Pearl%20White"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"27381574-2b91-4a2b-9ecf-25b713e95832","name":"UpdateCollateralColorCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Nonexistent Color\",\n    \"isAvailable\": true,\n    \"ts\": \"AAAAAAAAB9E=\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/UpdateCollateralColorCode/Nonexistent%20Color"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Collateral color code not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"bfb464d2-aa59-4c8b-a557-cac9019b0464"},{"name":"CollateralTitleStatusCodeAdd","id":"37116e9e-cdb1-4d3e-93df-84ada3ce9172","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Title Pending\",\n    \"available\": true,\n    \"notes\": \"Awaiting title from prior lienholder\",\n    \"titleStatus\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode","description":"<h3 id=\"add-collateral-title-status-code\">Add Collateral Title Status Code</h3>\n<p>Creates a new <code>Servicing.CollateralTitleStatusCodes</code> row for the caller's client. Wraps <code>CollateralTitleStatusCodeWSServices.AddSaveCollateralTitleStatusCodeWS</code> (with <code>id=null</code>, <code>ts=null</code>), which validates the body and rejects duplicate descriptions per client via <code>CollateralTitleStatusCodesServices.ReturnCollateralTitleStatusCode(databaseName, clientId, code)</code>. Returns the newly generated row's Guid as a string in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. Stored on the parameter DTO; the controller also accepts the header forms listed below.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Unique (per client) title status description (e.g. <code>Title Pending</code>). Blank descriptions are rejected by the service.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required boolean. Maps to <code>IsActive</code>. <code>true</code> makes the code selectable on collateral/title screens.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form <code>TitleStatusNotes</code> stored on the row.</td>\n</tr>\n<tr>\n<td><em>titleStatus</em></td>\n<td>Required int. <code>Omega.Common.Types.Enums.TitleStatus</code> discriminator: <code>1=Title_Pending</code>, <code>2=Title_Received</code>, <code>3=Title_Released</code>, <code>4=Electronic_Title_Received</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","CollateralTitleStatusCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ecbe261a-2f30-4ce9-8b75-8bc63e33e1f5","name":"AddCollateralTitleStatusCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Title Pending\",\n    \"available\": true,\n    \"notes\": \"Awaiting title from prior lienholder\",\n    \"titleStatus\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"fcdd81c9-1106-4dfa-a05d-5b8378232b33","name":"AddCollateralTitleStatusCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"\",\n    \"available\": true,\n    \"notes\": \"Awaiting title from prior lienholder\",\n    \"titleStatus\": 1\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"37116e9e-cdb1-4d3e-93df-84ada3ce9172"},{"name":"CollateralTitleStatusCodeGet","id":"549367c9-910b-4e8c-806f-12cfda7ea6fe","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/{{collateral_title_status_code_or_id}}","description":"<h3 id=\"get-collateral-title-status-code\">Get Collateral Title Status Code</h3>\n<p>Returns a single <code>Servicing.CollateralTitleStatusCodes</code> row resolved from the <code>{codeOrId}</code> path segment. Wraps <code>CollateralTitleStatusCodeWSServices.GetCollateralTitleStatusCodeWS</code>, which delegates lookup to <code>SharedWSServices.GetCollateralTitleStatusCodeId(codeOrId, ...)</code> — description-first with a <code>Guid.TryParse</code> fallback. Returns <code>400 Bad Request</code> when the segment is empty or the code cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Either the title status code description (<code>Title Pending</code>, <code>Title Received</code>, ...) or the code <code>Id</code> Guid. Resolution is description-first, then <code>Guid.TryParse</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"titlestatus-enum-on-response\">TitleStatus Enum (on response)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Value</strong></th>\n<th><strong>Name</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>1</code></td>\n<td>Title Pending</td>\n</tr>\n<tr>\n<td><code>2</code></td>\n<td>Title Received</td>\n</tr>\n<tr>\n<td><code>3</code></td>\n<td>Title Released</td>\n</tr>\n<tr>\n<td><code>4</code></td>\n<td>Electronic Title Received</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","CollateralTitleStatusCode","{{collateral_title_status_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3fee2f22-2e7f-41e4-a216-6211da73f825","name":"GetCollateralTitleStatusCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/Title%20Pending"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Title Pending\",\n        \"IsActive\": true,\n        \"TitleStatus\": 1,\n        \"TitleStatusNotes\": \"Awaiting title from prior lienholder\",\n        \"CreatedByUserId\": \"00000000-0000-0000-0000-000000000000\",\n        \"CreationServerDate\": \"2026-04-18T00:00:00Z\",\n        \"Ts\": \"AAAAAAAAB+0=\"\n    }\n}"},{"id":"8bcce0f8-e531-43a0-983d-011117ac3a1d","name":"GetCollateralTitleStatusCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/Nonexistent%20Status"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Collateral title status code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"549367c9-910b-4e8c-806f-12cfda7ea6fe"},{"name":"CollateralTitleStatusCodesGetAll","id":"ed60d760-e21b-4b10-908f-7601f08e15bc","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode","description":"<h3 id=\"get-all-collateral-title-status-codes\">Get All Collateral Title Status Codes</h3>\n<p>Returns every collateral title status code (<code>Servicing.CollateralTitleStatusCodes</code>) configured for the caller's client. Wraps <code>CollateralTitleStatusCodeWSServices.GetAllCollateralTitleStatusCodesWS</code>, which filters by <code>OmegaClientId</code>. Response entities include the enum-backed <code>TitleStatus</code> discriminator used by collateral-code screens.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode</code></p>\n<h4 id=\"titlestatus-enum\">TitleStatus Enum</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Value</strong></th>\n<th><strong>Name</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>1</code></td>\n<td>Title Pending</td>\n</tr>\n<tr>\n<td><code>2</code></td>\n<td>Title Received</td>\n</tr>\n<tr>\n<td><code>3</code></td>\n<td>Title Released</td>\n</tr>\n<tr>\n<td><code>4</code></td>\n<td>Electronic Title Received</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","CollateralTitleStatusCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b6a2e23d-83d6-499f-a03d-6c45761a8f88","name":"GetAllCollateralTitleStatusCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Title Pending\",\n            \"IsActive\": true,\n            \"TitleStatus\": 1,\n            \"TitleStatusNotes\": \"Awaiting title from prior lienholder\",\n            \"CreatedByUserId\": \"00000000-0000-0000-0000-000000000000\",\n            \"CreationServerDate\": \"2026-04-18T00:00:00Z\",\n            \"Ts\": \"AAAAAAAAB+0=\"\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Title Received\",\n            \"IsActive\": true,\n            \"TitleStatus\": 2,\n            \"TitleStatusNotes\": \"\",\n            \"CreatedByUserId\": \"00000000-0000-0000-0000-000000000000\",\n            \"CreationServerDate\": \"2026-04-18T00:00:00Z\",\n            \"Ts\": \"AAAAAAAAB+4=\"\n        }\n    ]\n}"},{"id":"ddaa4af6-62e5-433e-a970-66c0bb66b56a","name":"GetAllCollateralTitleStatusCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed. Invalid or expired token.\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"ed60d760-e21b-4b10-908f-7601f08e15bc"},{"name":"CollateralTitleStatusCodeUpdate","id":"3d7a49e8-91b1-4062-ab64-65ddc5e92df0","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Title Received\",\n    \"available\": true,\n    \"notes\": \"Paper title received and on file\",\n    \"titleStatus\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/{{collateral_title_status_code_or_id}}","description":"<h3 id=\"update-collateral-title-status-code\">Update Collateral Title Status Code</h3>\n<p>Updates the description, availability, notes, and <code>TitleStatus</code> enum of an existing <code>Servicing.CollateralTitleStatusCodes</code> row resolved from the <code>{codeOrId}</code> path segment. Wraps <code>CollateralTitleStatusCodeWSServices.AddSaveCollateralTitleStatusCodeWS</code> after:</p>\n<ol>\n<li><p>resolving <code>codeOrId</code> via\n<code>SharedWSServices.GetCollateralTitleStatusCodeId</code> (description-first with\n<code>Guid.TryParse</code> fallback);</p>\n</li>\n<li><p>fetching the existing row via\n<code>CollateralTitleStatusCodesServices.ReturnCollateralTitleStatusCode</code> to\ncapture the current <code>ts</code> rowversion for\n<code>ConcurrencyPredicateType.Save</code>.</p>\n</li>\n</ol>\n<p>The caller therefore does <strong>not</strong> send <code>id</code> or <code>ts</code> in the body — they are derived server-side from the URL segment. A missing or unresolved <code>codeOrId</code> returns <code>400 Bad Request</code> with <code>Collateral title status code not found</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required. Current description or the <code>Id</code> Guid of the title status code to update. Description-first resolution with <code>Guid.TryParse</code> fallback.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token carried on the parameter DTO.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New (or unchanged) description. Must remain unique per client.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required boolean. Maps to <code>IsActive</code>.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. <code>TitleStatusNotes</code> replacement.</td>\n</tr>\n<tr>\n<td><em>titleStatus</em></td>\n<td>Required int. <code>Omega.Common.Types.Enums.TitleStatus</code> value: <code>1=Title_Pending</code>, <code>2=Title_Received</code>, <code>3=Title_Released</code>, <code>4=Electronic_Title_Received</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","CollateralTitleStatusCode","{{collateral_title_status_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b9bb25f3-80dd-40c2-8aab-c620ef8fd6cb","name":"UpdateCollateralTitleStatusCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Title Received\",\n    \"available\": true,\n    \"notes\": \"Paper title received and on file\",\n    \"titleStatus\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/Title%20Pending"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": \"00000000-0000-0000-0000-000000000000\"\n}"},{"id":"84785afe-e7c3-468c-b12d-27b2ba2317cd","name":"UpdateCollateralTitleStatusCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Title Received\",\n    \"available\": true,\n    \"notes\": \"Paper title received and on file\",\n    \"titleStatus\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Collateral/CollateralTitleStatusCode/Nonexistent%20Status"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Collateral title status code not found\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"3d7a49e8-91b1-4062-ab64-65ddc5e92df0"},{"name":"ReturnCollateralCode","id":"108c975c-1d19-4399-81f4-17bb8f30fe83","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCode/{{collateral_code_or_id}}?token={{token}}","description":"<h3 id=\"return-collateral-code\">Return Collateral Code</h3>\n<p>Returns a single Collateral code record (<code>Common.CollateralCode</code>) resolved from either the code's description (via <code>SharedWSServices.GetCommonCollateralCodeId</code>) or its <code>Id</code> Guid. Wraps <code>CollateralCodeWSServices.ReturnCollateralCodeWS</code>. Responds with <code>Error</code> / \"Collateral code not found.\" when the lookup fails.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/ReturnCollateralCode/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Collateral code description (e.g. <code>\"Auto - Used\"</code>) or <code>Id</code> Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (or supply via the <code>Authorization</code> / session header).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","ReturnCollateralCode","{{collateral_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fca42769-b8a6-4e22-8426-2475a68e8e3d","name":"ReturnCollateralCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCode/{{collateral_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Collateral","ReturnCollateralCode","{{collateral_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Auto - Used\",\n        \"Active\": true,\n        \"CollateralType\": 1,\n        \"Note\": \"Used automobile collateral\",\n        \"ShowTitle\": true,\n        \"TitleStatus\": null,\n        \"AccountTypeOverride\": 100,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"108642f6-fb82-4c7f-92bc-4ad4b6672de8","name":"ReturnCollateralCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCode/Nonexistent%20Code?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Collateral","ReturnCollateralCode","Nonexistent%20Code"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Collateral code not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"108c975c-1d19-4399-81f4-17bb8f30fe83"},{"name":"ReturnCollateralCodeByCollateralId","id":"bde32400-eee1-4625-9984-8cad33fd9ac6","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodeByCollateralId/{{collateral_id}}?token={{token}}","description":"<h3 id=\"return-collateral-code-by-collateral-id\">Return Collateral Code By Collateral Id</h3>\n<p>Returns the Collateral code record (<code>Common.CollateralCode</code>) that is linked to a specific Collateral (<code>Common.Collateral.Id</code>). Wraps <code>CollateralCodeWSServices.ReturnCollateralCodeByCollateralIdWS</code> which requires <code>collateralId</code> in Guid format - string codes are rejected with \"Invalid collateral ID format.\" Responds with <code>Error</code> / \"Collateral code not found for the specified collateral.\" when the collateral has no code linkage.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodeByCollateralId/{collateralId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>collateralId</em></td>\n<td>Required Guid. <code>Common.Collateral.Id</code> of the collateral record to look up. Must be a valid Guid; codes or numbers are not accepted here.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (or supply via the <code>Authorization</code> / session header).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","ReturnCollateralCodeByCollateralId","{{collateral_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a91acc6f-7b8a-4353-9564-1e87a7199a46","name":"ReturnCollateralCodeByCollateralId - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodeByCollateralId/{{collateral_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Collateral","ReturnCollateralCodeByCollateralId","{{collateral_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Auto - Used\",\n        \"Active\": true,\n        \"CollateralType\": 1,\n        \"Note\": \"Used automobile collateral\",\n        \"ShowTitle\": true,\n        \"TitleStatus\": null,\n        \"AccountTypeOverride\": 100,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"771f85f3-55c8-4d94-8f5d-0d87abe6883c","name":"ReturnCollateralCodeByCollateralId - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodeByCollateralId/not-a-guid?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Collateral","ReturnCollateralCodeByCollateralId","not-a-guid"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Invalid collateral ID format.\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"bde32400-eee1-4625-9984-8cad33fd9ac6"},{"name":"ReturnCollateralCodes","id":"4cdcc63f-c951-4c95-869c-6abca93afc46","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodes?token={{token}}","description":"<h3 id=\"return-collateral-codes\">Return Collateral Codes</h3>\n<p>Returns every Collateral code (<code>Common.CollateralCode</code>) visible to the caller's client. Wraps <code>CollateralCodeWSServices.ReturnCollateralCodesWS</code>, which calls <code>CollateralCodeServices.ReturnCollateralCodes(databaseName, null)</code> to load the full collection (active + inactive). No query filters are supported.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodes</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (or supply via the <code>Authorization</code> / session header).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","ReturnCollateralCodes"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"bdf78d18-f2d3-4e8e-b0f5-91a01dc816f7","name":"ReturnCollateralCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodes?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Collateral","ReturnCollateralCodes"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Auto - Used\",\n            \"Active\": true,\n            \"CollateralType\": 1,\n            \"Note\": \"Used automobile collateral\",\n            \"ShowTitle\": true,\n            \"TitleStatus\": null,\n            \"AccountTypeOverride\": 100,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        },\n        {\n            \"Id\": \"11111111-1111-1111-1111-111111111111\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Misc\",\n            \"Active\": true,\n            \"CollateralType\": 4,\n            \"Note\": null,\n            \"ShowTitle\": false,\n            \"TitleStatus\": null,\n            \"AccountTypeOverride\": null,\n            \"Ts\": \"AAAAAAAAB9I=\"\n        }\n    ]\n}"},{"id":"4ca17da4-a478-4054-b894-42a798a0da51","name":"ReturnCollateralCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralCodes?token=invalid-or-expired-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Collateral","ReturnCollateralCodes"],"query":[{"key":"token","value":"invalid-or-expired-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Authentication failed. Invalid or expired token.\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"4cdcc63f-c951-4c95-869c-6abca93afc46"},{"name":"ReturnCollateralColorCode","id":"023247fa-1fec-4967-8326-fd871670eb52","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode/{{collateral_color_description_or_id}}","description":"<h3 id=\"return-collateral-color-code\">Return Collateral Color Code</h3>\n<p>Returns a single collateral color code resolved by description <strong>or</strong> Guid <code>Id</code>. Wraps <code>CollateralColorCodeWSServices.ReturnCollateralColorCodeWS</code>, which first attempts a description lookup (<code>ReturnCollateralColorCodeByDescription</code>) and falls back to <code>Guid.TryParse</code> when the value is not a known description.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode/{descriptionOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required. Either the color code description (<code>Pearl White</code>, <code>Red</code>, ...) or the color code Guid <code>Id</code>. The lookup tries description first, then <code>Guid.TryParse</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"related\">Related</h4>\n<ul>\n<li><p>Omit the <code>{descriptionOrId}</code> segment to return every color code (see\n<code>ReturnCollateralColorCodes</code>).</p>\n</li>\n<li><p>For a strict description-only lookup that never falls back to Guid\nparsing, call <code>ReturnCollateralColorCodeByDescription</code>.</p>\n</li>\n</ul>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","ReturnCollateralColorCode","{{collateral_color_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0eed2ab5-03dc-4b74-92de-b48d0bb56af4","name":"ReturnCollateralColorCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode/Pearl%20White"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Pearl White\",\n        \"IsAvailable\": true,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"8732b840-39e2-4225-aeae-eda68a4a988f","name":"ReturnCollateralColorCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode/Nonexistent%20Color"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Collateral color code not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": \"\"\n}"}],"_postman_id":"023247fa-1fec-4967-8326-fd871670eb52"},{"name":"ReturnCollateralColorCodeByDescription","id":"2ab80730-37cd-401f-a8de-ec37cfa72446","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCodeByDescription/{{collateral_color_description}}","description":"<h3 id=\"return-collateral-color-code-by-description\">Return Collateral Color Code By Description</h3>\n<p>Strict description-only lookup for a single collateral color code. Wraps <code>CollateralColorCodeWSServices.ReturnCollateralColorCodeByDescriptionWS</code>, which calls <code>CollateralColorCodeServices.ReturnCollateralColorCodeByDescription</code> filtered by the caller's <code>OmegaClientId</code>. Unlike <code>ReturnCollateralColorCode/{descriptionOrId}</code>, this route does not fall back to Guid parsing — the URL segment is always treated as a description.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCodeByDescription/{description}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Exact color code description (case-sensitivity matches the database collation). Returns a <code>400 Bad Request</code> with <code>INVALID_PARAMETER_ERROR_MESSAGE</code> when empty.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","ReturnCollateralColorCodeByDescription","{{collateral_color_description}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"57e3d475-80b1-41e8-a9b0-d671c8d7fdcf","name":"ReturnCollateralColorCodeByDescription - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCodeByDescription/Pearl%20White"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000000\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n        \"Description\": \"Pearl White\",\n        \"IsAvailable\": true,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    }\n}"},{"id":"6463f135-0d0e-40ca-8ac0-be3b962ba7be","name":"ReturnCollateralColorCodeByDescription - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCodeByDescription/Nonexistent%20Color"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Collateral color code not found.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"2ab80730-37cd-401f-a8de-ec37cfa72446"},{"name":"ReturnCollateralColorCodes","id":"44d1183d-9449-4fae-ac2d-1d41c2abbf86","request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode","description":"<h3 id=\"return-all-collateral-color-codes\">Return All Collateral Color Codes</h3>\n<p>Returns every collateral color code configured for the caller's client. Wraps <code>CollateralColorCodeWSServices.ReturnAllCollateralColorCodesWS</code>, which fetches <code>Common.CollateralColorCode</code> rows for the current <code>OmegaClientId</code>. <code>data</code> contains the list of color code entities.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode</code></p>\n<h4 id=\"behavior\">Behavior</h4>\n<ul>\n<li><p>Called when no path segment is supplied (the optional <code>descriptionOrId</code>\nroute variant resolves a single record instead — see\n<code>ReturnCollateralColorCode</code>).</p>\n</li>\n<li><p>No query-string parameters are read.</p>\n</li>\n</ul>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Collateral","ReturnCollateralColorCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9de7ae91-2199-4713-8585-bfebcbc33341","name":"ReturnCollateralColorCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Pearl White\",\n            \"IsAvailable\": true,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        },\n        {\n            \"Id\": \"00000000-0000-0000-0000-000000000000\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000000\",\n            \"Description\": \"Red\",\n            \"IsAvailable\": true,\n            \"Ts\": \"AAAAAAAAB9I=\"\n        }\n    ]\n}"},{"id":"b2ad5cdb-33c9-4b44-ac3c-9118f68073ef","name":"ReturnCollateralColorCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"invalid-or-expired-token"}],"url":"https://{{base_url}}/api/Client/Collateral/ReturnCollateralColorCode"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Your authentication token is invalid or has expired. Call the Login method to retrieve a new token.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"44d1183d-9449-4fae-ac2d-1d41c2abbf86"}],"id":"2c1bedf4-f509-4f2b-b2e6-26a78c958308","_postman_id":"2c1bedf4-f509-4f2b-b2e6-26a78c958308","description":""},{"name":"DocSafe","item":[{"name":"CalculatedMergeFieldDelete","id":"8aede9b9-1eaa-4e62-a5f3-c841407ea629","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/{{calculated_merge_field_id}}?token={{token}}","description":"<h3 id=\"delete-calculated-merge-field\">Delete Calculated Merge Field</h3>\n<p>Deletes a calculated merge field configuration row. Internally calls <code>CalculatedMergeFieldConfigurationServices.DeleteCalculatedMergeField</code> inside a UnitOfWork2 transaction. The current row's <code>Ts</code> is loaded automatically and used for the concurrency check (there is no request body for DELETE calls).</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). Id of the calculated merge field to delete. Returns <code>BadRequest</code> (<code>INVALID_PARAMETER_ERROR_MESSAGE</code>) when the value is not a valid Guid, and \"Calculated merge field not found\" when no matching row exists.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers. DELETE callers cannot send a body, so the token must travel via query string or headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ id }</code> echoing the deleted field's Guid on success.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","CalculatedMergeField","{{calculated_merge_field_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"db387464-eede-4409-b69b-104ef2c69e85","name":"DeleteCalculatedMergeField - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","CalculatedMergeField","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Calculated merge field not found\"\n    ]\n}"},{"id":"ceddd18a-f890-4fdd-bffb-bc96bfaf679d","name":"DeleteCalculatedMergeField - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/7e1b0c41-2a34-49d7-8be1-5f2c3a9a4d91?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","CalculatedMergeField","7e1b0c41-2a34-49d7-8be1-5f2c3a9a4d91"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"7e1b0c41-2a34-49d7-8be1-5f2c3a9a4d91\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"8aede9b9-1eaa-4e62-a5f3-c841407ea629"},{"name":"CalculatedMergeFieldGet","id":"3bd874a6-ee32-483a-af0a-98e795a464aa","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/{{calculated_merge_field_id}}?token={{token}}","description":"<h3 id=\"get-calculated-merge-field-by-id\">Get Calculated Merge Field by Id</h3>\n<p>Returns a single calculated merge field configuration record (used to inject computed values into DocSafe merge forms) by its Guid <code>Id</code>. Internally calls <code>CalculatedMergeFieldConfigurationServices.ReturnCalculatedMergeFieldWithCache</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). The calculated merge field <code>Id</code>. Returns <code>BadRequest</code> (<code>INVALID_PARAMETER_ERROR_MESSAGE</code>) when the value is not a valid Guid and \"Calculated merge field not found\" when no matching row exists.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ id, omegaClientId, fieldDescription, mergeSet, mergeSetName, fieldNumber, fieldCalculation, ts }</code>, where <code>mergeSet</code> is an <code>Omega.DocSafe.Types.Enums.MergeSets</code> integer and <code>mergeSetName</code> is its string form (e.g. <code>Servicing_General_Letter</code>, <code>AP_Checks</code>, <code>Text_Message</code>).</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","CalculatedMergeField","{{calculated_merge_field_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"327df6ae-9bf2-47df-9822-b1f209831d65","name":"GetCalculatedMergeField - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","CalculatedMergeField","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Calculated merge field not found\"\n    ]\n}"},{"id":"7a3e43e9-b2af-465d-b292-2b60e25964f8","name":"GetCalculatedMergeField - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField/7e1b0c41-2a34-49d7-8be1-5f2c3a9a4d91?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","CalculatedMergeField","7e1b0c41-2a34-49d7-8be1-5f2c3a9a4d91"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"7e1b0c41-2a34-49d7-8be1-5f2c3a9a4d91\",\n        \"omegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n        \"fieldDescription\": \"Total Payoff Plus Late Fees\",\n        \"mergeSet\": 6,\n        \"mergeSetName\": \"Servicing_Payoff_Quote\",\n        \"fieldNumber\": 1,\n        \"fieldCalculation\": \"[PayoffAmount] + [LateFees]\",\n        \"ts\": \"AAAAAAAABuc=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"3bd874a6-ee32-483a-af0a-98e795a464aa"},{"name":"CalculatedMergeFieldSave","id":"6915bb19-5551-4688-82b5-5e43e5c043f1","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"id\": null,\n    \"ts\": null,\n    \"fieldDescription\": \"Total Payoff Plus Late Fees\",\n    \"mergeSet\": 6,\n    \"fieldNumber\": 1,\n    \"fieldCalculation\": \"[PayoffAmount] + [LateFees]\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField","description":"<h3 id=\"save-calculated-merge-field\">Save Calculated Merge Field</h3>\n<p>Adds a new calculated merge field or saves changes to an existing one. Internally calls <code>CalculatedMergeFieldConfigurationServices.AddSaveCalculatedMergeField</code> inside a UnitOfWork2 transaction. When <code>id</code> is omitted or <code>Guid.Empty</code>, a new Guid is generated and returned. When <code>id</code> is supplied but <code>ts</code> is not, the current row's <code>Ts</code> is looked up and used for the concurrency check.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>id</em></td>\n<td>Optional Guid. Existing field Id when updating. Omit or send <code>Guid.Empty</code> to create a new row.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional byte[] (base64). Row timestamp required for concurrency control on updates. When provided without <code>id</code>, returns \"ts requires id\". When omitted on update, the current <code>Ts</code> is re-read and used.</td>\n</tr>\n<tr>\n<td><em>fieldDescription</em></td>\n<td>Required string, max 55 characters. Human-readable label for the calculated field.</td>\n</tr>\n<tr>\n<td><em>mergeSet</em></td>\n<td>Required int. <code>Omega.DocSafe.Types.Enums.MergeSets</code> enum value: <code>1</code>=AP_Checks, <code>2</code>=Originations_Application_Letters, <code>4</code>=Servicing_General_Letter, <code>5</code>=Servicing_Billing_Statement_Or_Late_Notice, <code>6</code>=Servicing_Payoff_Quote, <code>7</code>=Servicing_Direct_Loan_Documents, <code>8</code>=Servicing_Payment_Receipt, <code>9</code>=Servicing_Repossession_Document, <code>10</code>=Common_Tax_Form, <code>11</code>=Insurance_Notice, <code>12</code>=Payment_Coupons, <code>13</code>=Text_Message.</td>\n</tr>\n<tr>\n<td><em>fieldNumber</em></td>\n<td>Required int, between 1 and 20 inclusive. Slot number of the calculated field within its merge set (determines <code>[CalculatedFieldN]</code> token used in templates).</td>\n</tr>\n<tr>\n<td><em>fieldCalculation</em></td>\n<td>Required string. Calculation expression evaluated at merge time (may reference other merge-field tokens in bracket notation).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ id }</code> containing the Guid of the new or updated field.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","CalculatedMergeField"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cc16b3f8-6b9d-409f-8576-9d27c2cc7f83","name":"SaveCalculatedMergeField - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"id\": null,\n    \"ts\": null,\n    \"fieldDescription\": \"\",\n    \"mergeSet\": 6,\n    \"fieldNumber\": 1,\n    \"fieldCalculation\": \"[PayoffAmount] + [LateFees]\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"fieldDescription is required\"\n    ]\n}"},{"id":"377dc9f2-58bb-4456-93d8-80a60d169a68","name":"SaveCalculatedMergeField - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"id\": null,\n    \"ts\": null,\n    \"fieldDescription\": \"Total Payoff Plus Late Fees\",\n    \"mergeSet\": 6,\n    \"fieldNumber\": 1,\n    \"fieldCalculation\": \"[PayoffAmount] + [LateFees]\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/CalculatedMergeField"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"7e1b0c41-2a34-49d7-8be1-5f2c3a9a4d91\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"6915bb19-5551-4688-82b5-5e43e5c043f1"},{"name":"CopyDocument","id":"79af595a-59bf-4a93-81d1-7447cd206729","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Copy","description":"<h3 id=\"copy-document\">Copy Document</h3>\n<p>Creates a new DocSafe document that is a copy of an existing document, placed into the target folder. Internally calls <code>DocumentServices.CopyDocument</code>, which duplicates the underlying storage object and inserts a new <code>Document</code> row.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Copy</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>documentId</em></td>\n<td>Required Guid. Id of the source DocSafe document to copy.</td>\n</tr>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. Id of the target DocSafe folder that will receive the copy.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ sourceDocumentId, newDocumentId, folderId, location }</code>, where <code>newDocumentId</code> is the Id of the new document row and <code>location</code> is the new storage key of the copied object.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Copy"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7adfde36-2fd1-49cb-b33a-24be4a06aa5e","name":"CopyDocument - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"00000000-0000-0000-0000-000000000000\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Copy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"documentId and folderId are required\"\n    ]\n}"},{"id":"c9293eb5-a21d-487b-876a-6b7a454be370","name":"CopyDocument - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Copy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"sourceDocumentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n        \"newDocumentId\": \"e8907ad2-4b4a-4f6a-9d5f-2b1a7f5d9c22\",\n        \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"location\": \"e8907ad2-4b4a-4f6a-9d5f-2b1a7f5d9c22signed_contract.pdf\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"79af595a-59bf-4a93-81d1-7447cd206729"},{"name":"DisableDocument","id":"0c36a9d5-02db-469c-a992-ef5431bccc33","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Disable","description":"<h3 id=\"disable-document\">Disable Document</h3>\n<p>Soft-disables a DocSafe document by setting its <code>Active</code> flag to <code>false</code>. Internally calls <code>DocumentServices.DisableDocument</code>. The document row and storage object are preserved so it can later be re-enabled. Disabled documents are excluded from default <code>Query</code> results unless <code>includeInactive=true</code> is passed.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Disable</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>documentId</em></td>\n<td>Required Guid. Id of the DocSafe document to disable.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ documentId, active }</code>, with <code>active</code> equal to <code>false</code> after a successful call.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Disable"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d526f419-9578-4eba-b443-b1d2e22f316a","name":"DisableDocument - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Disable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Document b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21 not found\"\n    ]\n}"},{"id":"88d70a11-aa31-473b-b0c7-09b514f99fd7","name":"DisableDocument - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Disable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n        \"active\": false\n    },\n    \"errors\": []\n}"}],"_postman_id":"0c36a9d5-02db-469c-a992-ef5431bccc33"},{"name":"Document","id":"a9356fc2-3e2b-4289-a963-6d34fed3d661","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Signed Contract (v2)\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/{{document_id}}?token={{token}}","description":"<h3 id=\"update-document-description\">Update Document Description</h3>\n<p>Renames / re-describes a DocSafe document. Internally calls <code>DocumentServices.EditDocumentInDB</code>, which also updates the underlying storage location so the object's key in S3/Azure/file storage reflects the new description.</p>\n<p><strong>HTTP Method:</strong> PATCH</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. The DocSafe document <code>Id</code>. Copied into <code>param.documentId</code> server-side (any <code>documentId</code> in the body is overwritten by the route value).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New description / file name base. Used to rebuild the storage object key.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Authentication: supplied as <code>?token={{token}}</code> query-string parameter, as a <code>SessionId</code> header, or as signed API headers. (The auth filter only reads <code>token</code> out of the body for POST/PUT, so PATCH callers must supply the token via query string or header.)</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ documentId, description, location }</code>, where <code>location</code> is the new storage key after the rename.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","{{document_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"264ed26f-966e-4d57-9d75-3fe87f52faa9","name":"UpdateDocument - Fail","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document/b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document","b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"description is required\"\n    ]\n}"},{"id":"b96d72b4-eb2f-4a3e-9c07-2f6e3c41cf4f","name":"UpdateDocument - Successful","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Signed Contract (v2)\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document/b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document","b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n        \"description\": \"Signed Contract (v2)\",\n        \"location\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21Signed_Contract_v2.pdf\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"a9356fc2-3e2b-4289-a963-6d34fed3d661"},{"name":"Document","id":"c37360db-8dc0-4cac-8c0a-05f39ddf3ba1","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Document/{{document_id}}?token={{token}}","description":"<h3 id=\"get-document-by-id\">Get Document by Id</h3>\n<p>Returns a single DocSafe document record.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. The DocSafe document <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the full <code>Document</code> entity returned by <code>DocumentServices.ReturnDocument</code>, including <code>Id</code>, <code>FolderId</code>, <code>Description</code>, <code>FileName</code>, <code>FileType</code>, <code>FileSize</code>, <code>Active</code>, <code>CreationDate</code>, <code>CreatedByUserId</code>, <code>ProcessName</code>, <code>Location</code>, and <code>Ts</code>.</p>\n<p>Returns <code>Error</code> with \"Invalid document ID format\" when the <code>{id}</code> route value is not a valid Guid and \"Document not found\" when no matching record exists.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","{{document_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"1fd857f5-77ee-4229-bd83-42e4fce75079","name":"GetDocument - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document/b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document","b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n        \"FolderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"Description\": \"Signed Contract\",\n        \"FileName\": \"signed_contract.pdf\",\n        \"FileType\": \".pdf\",\n        \"FileSize\": 12845,\n        \"Active\": true,\n        \"CreationDate\": \"2026-03-12T09:21:41.000Z\",\n        \"CreatedByUserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n        \"ProcessName\": \"upload\",\n        \"Location\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21signed_contract.pdf\",\n        \"Ts\": \"AAAAAAAABtg=\"\n    },\n    \"errors\": []\n}"},{"id":"6cc5ec60-a1b2-4e8a-9300-941af9190624","name":"GetDocument - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document/not-a-guid?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document","not-a-guid"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid document ID format\"\n    ]\n}"}],"_postman_id":"c37360db-8dc0-4cac-8c0a-05f39ddf3ba1"},{"name":"DocumentsDelete","id":"7fb666ba-4c0e-4b52-ac4a-5823704646ff","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentIds\": [\n        \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Delete","description":"<h3 id=\"delete-documents\">Delete Documents</h3>\n<p>Hard-deletes one or more DocSafe documents. Internally calls <code>DocumentServices.DeleteDocuments</code>, which removes both the <code>Document</code> rows and the underlying storage objects. Use <code>Disable</code> instead if you want to keep the audit trail.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Delete</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>documentIds</em></td>\n<td>Required array of Guid. Ids of the DocSafe documents to delete. All Ids must exist; the call is transactional.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ deletedIds, deletedCount }</code>, where <code>deletedIds</code> echoes the Ids that were removed and <code>deletedCount</code> is the number of rows deleted.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Delete"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4f3f4ae2-4c3b-453c-9536-72cbde4769a2","name":"DeleteDocuments - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentIds\": [\n        \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"deletedIds\": [\n            \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n        ],\n        \"deletedCount\": 1\n    },\n    \"errors\": []\n}"},{"id":"67cc4403-0b0c-487f-91e5-e862a823163a","name":"DeleteDocuments - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentIds\": [\n        \"00000000-0000-0000-0000-000000000000\"\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Each documentId must be a non-empty Guid\"\n    ]\n}"}],"_postman_id":"7fb666ba-4c0e-4b52-ac4a-5823704646ff"},{"name":"DocumentsGetAll","id":"0793becc-10a6-4bf0-ad1a-643c666a3cd3","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Document?token={{token}}","description":"<h3 id=\"get-all-documents\">Get All Documents</h3>\n<p>Returns every DocSafe document record visible to the caller. Useful for small installations or admin tooling. For any page with filtering or paging, prefer <code>GET /api/Client/DocSafe/Document/Query</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document</code></p>\n<p>Authentication: token may be supplied as a <code>?token={{token}}</code> query-string parameter, as a <code>SessionId</code> header from a prior Login call, or via signed API headers (<code>publicKey</code>, <code>timeStamp</code>, <code>signature</code>).</p>\n<h4 id=\"parameters\">Parameters</h4>\n<p>This endpoint takes no path, query, or body parameters other than authentication.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required. Session id, token, or API key. May be supplied as <code>?token={{token}}</code>, as a <code>SessionId</code> header, or via signed API headers (<code>publicKey</code>, <code>timeStamp</code>, <code>signature</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the full list of document records (id, folderId, description, fileName, createdByUserId, creationDate, fileType, fileSize, active, etc.) as returned by <code>DocumentServices.ReturnAllDocuments</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"915581d0-0432-474a-aafd-5b8d13c13f2a","name":"GetAllDocuments - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n            \"FolderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n            \"Description\": \"Signed Contract\",\n            \"FileName\": \"signed_contract.pdf\",\n            \"FileType\": \".pdf\",\n            \"FileSize\": 12845,\n            \"Active\": true,\n            \"CreationDate\": \"2026-03-12T09:21:41.000Z\",\n            \"CreatedByUserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n            \"Location\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21signed_contract.pdf\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"f0b2fe3c-1419-4882-a328-b06f102d244a","name":"GetAllDocuments - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving documents: Invalid or expired session token\"\n    ]\n}"}],"_postman_id":"0793becc-10a6-4bf0-ad1a-643c666a3cd3"},{"name":"DocumentsToFolderUpload","id":"d5ef2804-f15a-4b9c-aae6-bb21cac529ae","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"files\": [\n        {\n            \"fileName\": \"signed_contract\",\n            \"fileExtension\": \".pdf\",\n            \"base64Content\": \"JVBERi0xLjQKJeLjz9MKCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKdHJhaWxlcjw8L1Jvb3QgMSAwIFI+Pg==\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Upload/{{folder_id}}","description":"<h3 id=\"upload-documents-to-folder\">Upload Documents To Folder</h3>\n<p>Route-scoped variant of the DocSafe upload endpoint. Uploads one or more files into the DocSafe folder identified by the <code>{folderId}</code> route value. Internally shares <code>DocumentServices.UploadDocumentToStorage</code> + <code>AddDocumentToDb</code> with the generic <code>Upload</code> endpoint.</p>\n<p>The <code>folderId</code> in the request body (if present) is <strong>overwritten</strong> by the route value before processing, so the route wins.</p>\n<p>File content is transmitted inline as Base64 text, not as multipart form-data. Each entry in <code>files</code> is a separate document.</p>\n<p>Requires the <strong>Professional</strong> edition or higher; lower editions will receive an <code>Error</code> response indicating insufficient edition.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Upload/{folderId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. Id of the DocSafe folder that will receive the uploaded files. Copied into <code>param.folderId</code> server-side.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>files</em></td>\n<td>Required array. One entry per file to upload.</td>\n</tr>\n<tr>\n<td><em>files[].fileName</em></td>\n<td>Required string. The original file name (no path). Used to build the document <code>Description</code>.</td>\n</tr>\n<tr>\n<td><em>files[].fileExtension</em></td>\n<td>Required string. The file extension including the leading dot, e.g. <code>.pdf</code>.</td>\n</tr>\n<tr>\n<td><em>files[].base64Content</em></td>\n<td>Required string. Base64-encoded file contents.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ folderId, documentIds, uploadedCount }</code>, where <code>documentIds</code> is the list of newly-created DocSafe document Ids, in the same order as the <code>files</code> array.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Upload","{{folder_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"241551c3-902c-4d27-b15f-2166310ec274","name":"UploadDocumentsToFolder - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"files\": [\n        {\n            \"fileName\": \"signed_contract\",\n            \"fileExtension\": \".pdf\",\n            \"base64Content\": \"JVBERi0xLjQKJeLjz9MKCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKdHJhaWxlcjw8L1Jvb3QgMSAwIFI+Pg==\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Upload/ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"documentIds\": [\n            \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n        ],\n        \"uploadedCount\": 1\n    },\n    \"errors\": []\n}"},{"id":"648fb64b-040c-4334-ac80-dd6dbaaa54ab","name":"UploadDocumentsToFolder - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"files\": [\n        {\n            \"fileName\": \"signed_contract\",\n            \"fileExtension\": \".pdf\",\n            \"base64Content\": \"JVBERi0xLjQKJeLjz9MKCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKdHJhaWxlcjw8L1Jvb3QgMSAwIFI+Pg==\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Upload/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"folderId is required\"\n    ]\n}"}],"_postman_id":"d5ef2804-f15a-4b9c-aae6-bb21cac529ae"},{"name":"DocumentsUpload","id":"ad55bc95-fa44-481f-b3f4-b889277bf912","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n    \"files\": [\n        {\n            \"fileName\": \"signed_contract\",\n            \"fileExtension\": \".pdf\",\n            \"base64Content\": \"JVBERi0xLjQKJeLjz9MKCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKdHJhaWxlcjw8L1Jvb3QgMSAwIFI+Pg==\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Upload","description":"<h3 id=\"upload-documents\">Upload Documents</h3>\n<p>Uploads one or more files to DocSafe and stores them in the specified folder. Internally calls <code>DocumentServices.UploadDocumentToStorage</code> to write each file to the configured storage provider (S3, Azure Blob, or file system) and then <code>DocumentServices.AddDocumentToDb</code> to create the matching <code>Document</code> rows.</p>\n<p>File content is transmitted inline as Base64 text, not as multipart form-data. Each entry in <code>files</code> is a separate document.</p>\n<p>Requires the <strong>Professional</strong> edition or higher; lower editions will receive an <code>Error</code> response indicating insufficient edition.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Upload</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. Id of the DocSafe folder that will receive the uploaded files.</td>\n</tr>\n<tr>\n<td><em>files</em></td>\n<td>Required array. One entry per file to upload.</td>\n</tr>\n<tr>\n<td><em>files[].fileName</em></td>\n<td>Required string. The original file name (no path). Used to build the document <code>Description</code>.</td>\n</tr>\n<tr>\n<td><em>files[].fileExtension</em></td>\n<td>Required string. The file extension including the leading dot, e.g. <code>.pdf</code>.</td>\n</tr>\n<tr>\n<td><em>files[].base64Content</em></td>\n<td>Required string. Base64-encoded file contents.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ folderId, documentIds, uploadedCount }</code>, where <code>documentIds</code> is the list of newly-created DocSafe document Ids, in the same order as the <code>files</code> array.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Upload"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ee727381-1fe9-42a6-b363-46c8071b01fd","name":"UploadDocuments - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n    \"files\": [\n        {\n            \"fileName\": \"signed_contract\",\n            \"fileExtension\": \".pdf\",\n            \"base64Content\": \"JVBERi0xLjQKJeLjz9MKCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKdHJhaWxlcjw8L1Jvb3QgMSAwIFI+Pg==\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"documentIds\": [\n            \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n        ],\n        \"uploadedCount\": 1\n    },\n    \"errors\": []\n}"},{"id":"c048fa30-aa2c-42d2-8951-514a2a1b1aef","name":"UploadDocuments - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"folderId\": \"00000000-0000-0000-0000-000000000000\",\n    \"files\": [\n        {\n            \"fileName\": \"signed_contract\",\n            \"fileExtension\": \".pdf\",\n            \"base64Content\": \"JVBERi0xLjQKJeLjz9MKCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2c+PgplbmRvYmoKdHJhaWxlcjw8L1Jvb3QgMSAwIFI+Pg==\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"folderId is required\"\n    ]\n}"}],"_postman_id":"ad55bc95-fa44-481f-b3f4-b889277bf912"},{"name":"EnableDocument","id":"dcd042f1-9823-4491-bcc0-1d318dbb51f7","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Enable","description":"<h3 id=\"enable-document\">Enable Document</h3>\n<p>Re-enables a previously disabled DocSafe document by setting its <code>Active</code> flag back to <code>true</code>. Internally calls <code>DocumentServices.EnableDocument</code>. The document becomes visible again in default <code>Query</code> results.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Enable</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>documentId</em></td>\n<td>Required Guid. Id of the DocSafe document to enable.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ documentId, active }</code>, with <code>active</code> equal to <code>true</code> after a successful call.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Enable"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8a32408f-b451-4df4-a328-b78d18f9fd9b","name":"EnableDocument - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Enable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n        \"active\": true\n    },\n    \"errors\": []\n}"},{"id":"5b828523-8b23-4ba8-b19b-29ef8a9c4c54","name":"EnableDocument - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"00000000-0000-0000-0000-000000000000\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Enable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"documentId is required\"\n    ]\n}"}],"_postman_id":"dcd042f1-9823-4491-bcc0-1d318dbb51f7"},{"name":"FolderDelete","id":"485f44ef-0103-4453-908d-e514aa7e1d0e","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Folder/{{folder_id}}?token={{token}}","description":"<h3 id=\"delete-folder\">Delete Folder</h3>\n<p>Deletes a DocSafe folder (and its contents per the business rules in <code>FolderServices.DeleteFolderinDb</code>). System folders where <code>PreventDelete = true</code> cannot be deleted.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Folder/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). Id of the folder to delete. Returns <code>BadRequest</code> (<code>INVALID_PARAMETER_ERROR_MESSAGE</code>) when the value is not a valid Guid, and \"Folder {id} not found\" when no matching folder exists.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers. DELETE callers cannot send a body, so the token must travel via query string or headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ folderId }</code> on success.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Folder","{{folder_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"0d7015f0-8414-4d07-b897-7c96ba8641f1","name":"DeleteFolder - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Folder/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Folder","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Folder 00000000-0000-0000-0000-000000000000 not found\"\n    ]\n}"},{"id":"4aff5424-0b6a-4bc3-8980-f36940a7c780","name":"DeleteFolder - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Folder/d9a2c551-ea73-4a0b-9f15-7d5a9b7b1b21?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Folder","d9a2c551-ea73-4a0b-9f15-7d5a9b7b1b21"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"folderId\": \"d9a2c551-ea73-4a0b-9f15-7d5a9b7b1b21\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"485f44ef-0103-4453-908d-e514aa7e1d0e"},{"name":"FolderGet","id":"cd29a6da-d032-47fd-91cd-bd78bb93cfd0","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Folder/{{folder_id}}?token={{token}}","description":"<h3 id=\"get-folder-by-id\">Get Folder by Id</h3>\n<p>Returns a single DocSafe folder record by its Guid <code>Id</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Folder/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. The DocSafe folder <code>Id</code>. A <code>BadRequest</code> with \"Invalid folder ID format\" is returned when the value is not a valid Guid, and \"Folder not found\" when no matching row exists.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the full <code>DocSafe.Folder</code> entity returned by <code>FolderServices.ReturnFolder</code>, including <code>Id</code>, <code>OmegaClientId</code>, <code>FolderName</code>, <code>ParentId</code>, <code>CreationDate</code>, <code>Active</code>, <code>FolderType</code>, <code>CreatedByUserId</code>, <code>PermissionType</code> (1 = Use Folder Roles, 2 = Full Control), <code>PreventDelete</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Folder","{{folder_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"d80a5df9-46d7-49e5-b8df-aef466c41661","name":"GetFolder - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Folder/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Folder","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Folder not found\"\n    ]\n}"},{"id":"8306c02d-ba11-4615-95d0-6de7be58e8c1","name":"GetFolder - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Folder/ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Folder","ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"OmegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n        \"FolderName\": \"Contracts\",\n        \"ParentId\": \"11111111-1111-1111-1111-111111111111\",\n        \"CreationDate\": \"2026-03-12T09:21:41.000Z\",\n        \"Active\": true,\n        \"FolderType\": 0,\n        \"CreatedByUserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n        \"PermissionType\": 2,\n        \"PreventDelete\": false,\n        \"Ts\": \"AAAAAAAABtg=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"cd29a6da-d032-47fd-91cd-bd78bb93cfd0"},{"name":"FolderNew","id":"603743e6-63c6-4e0b-b892-a45ffa49963d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"parentId\": \"{{folder_id}}\",\n    \"folderName\": \"Signed Contracts\",\n    \"permissionType\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder","description":"<h3 id=\"create-new-folder\">Create New Folder</h3>\n<p>Creates a new DocSafe folder. When a <code>parentId</code> is supplied, the parent folder's <code>PermissionType</code> is inherited unless <code>permissionType</code> is explicitly provided; when no parent is supplied the default is <code>2</code> (Full Control). Internally calls <code>FolderServices.NewFolderinDB</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Folder</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>parentId</em></td>\n<td>Optional Guid. Id of the parent folder. When omitted, the new folder is created at the client root.</td>\n</tr>\n<tr>\n<td><em>folderName</em></td>\n<td>Required string. Name for the new folder. Returns <code>BadRequest</code> with \"folderName is required\" when missing.</td>\n</tr>\n<tr>\n<td><em>permissionType</em></td>\n<td>Optional int. Overrides the inherited <code>PermissionType</code>. Maps to <code>Omega.DocSafe.Types.Enums.PermissionTypes</code>: <code>1</code> = Use Folder Roles, <code>2</code> = Full Control.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ folderId, parentId, folderName, permissionType }</code>, where <code>folderId</code> is the newly generated Guid assigned to the new folder.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Folder"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cf9e2a8a-e3a9-4713-a414-e8c45b27d537","name":"NewFolder - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"parentId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n    \"folderName\": \"\",\n    \"permissionType\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"folderName is required\"\n    ]\n}"},{"id":"96d3af7e-571a-4233-a636-7abe32249df9","name":"NewFolder - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"parentId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n    \"folderName\": \"Signed Contracts\",\n    \"permissionType\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"folderId\": \"d9a2c551-ea73-4a0b-9f15-7d5a9b7b1b21\",\n        \"parentId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"folderName\": \"Signed Contracts\",\n        \"permissionType\": 2\n    },\n    \"errors\": []\n}"}],"_postman_id":"603743e6-63c6-4e0b-b892-a45ffa49963d"},{"name":"FolderPermissionsSave","id":"bd5d1ece-7510-4aa6-abfa-fc649d57a00b","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"folderName\": \"Signed Contracts\",\n  \"permissionType\": 1,\n  \"roleAssignments\": [\n    {\n      \"folderRoleId\": null,\n      \"roleId\": \"5a3c2a10-9b52-4e12-8a9f-6d8e1f2b4b01\",\n      \"canAdd\": true,\n      \"canDelete\": false,\n      \"canChange\": true,\n      \"canView\": true,\n      \"canAdminister\": true,\n      \"remove\": false,\n      \"roleNameOrId\": null\n    },\n    {\n      \"folderRoleId\": \"7d2f1c55-8a11-4d22-93e0-21e39fabc010\",\n      \"roleId\": null,\n      \"canAdd\": false,\n      \"canDelete\": false,\n      \"canChange\": false,\n      \"canView\": true,\n      \"canAdminister\": false,\n      \"remove\": false,\n      \"roleNameOrId\": null\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/{{folder_id}}/Permissions","description":"<h3 id=\"save-folder-permissions\">Save Folder Permissions</h3>\n<p>Updates the permission mode for a DocSafe folder and, when the mode is <code>Use_Folder_Roles</code>, inserts, updates, or removes the role assignments that grant access. Folder name may also be updated in the same call. Internally normalizes role permissions via <code>NormalizeFolderRolePermissions</code>, commits role changes through <code>FolderServices.AddFolderRole</code>, <code>FolderServices.SaveFolderRole</code>, and <code>FolderServices.DeleteFolderRole</code>, and then persists the folder itself via <code>FolderServices.SetFolderPermTypeinDB</code> and <code>FolderServices.SaveFolder</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Folder/{id}/Permissions</code></p>\n<h4 id=\"route--query--body-parameters\">Route / Query / Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). Id of the folder being updated. Overwrites <code>folderId</code> in the body.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May be supplied in the body, as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>folderName</em></td>\n<td>Optional string. New folder name. When blank or missing, the existing <code>FolderName</code> is kept and HTML-decoded on save.</td>\n</tr>\n<tr>\n<td><em>permissionType</em></td>\n<td>Required int. Maps to <code>Omega.DocSafe.Types.Enums.PermissionTypes</code>: <code>1</code> = Use Folder Roles, <code>2</code> = Full Control. Returns <code>BadRequest</code> when the value is not a defined enum member.</td>\n</tr>\n<tr>\n<td><em>roleAssignments</em></td>\n<td>Required array when <code>permissionType = 1</code>. Each element supports: <code>folderRoleId</code> (Guid of an existing <code>DocSafe.FolderRolePermissions</code> row, required for updates or removals), <code>roleId</code> (Guid of a General role for the current client, required for new assignments), <code>canAdd</code>, <code>canDelete</code>, <code>canChange</code>, <code>canView</code>, <code>canAdminister</code> (bool; <code>canAdminister=true</code> forces all other permissions to <code>true</code>; granting any of add/delete/change implicitly sets <code>canView=true</code>), and <code>remove</code> (bool; when <code>true</code> the existing assignment is removed and <code>folderRoleId</code> is required). The call validates that the requesting user is a member of at least one role that is kept, and that at least one kept role still has <code>canAdminister</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ folderId, folderName, permissionType }</code> where <code>folderName</code> is the final (HTML-decoded) name persisted and <code>permissionType</code> is the int value of the enum actually stored.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>roleAssignments[].roleNameOrId</code></td>\n<td><code>roleAssignments[].roleId</code></td>\n<td>String. general-role name or general-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"roleAssignments\": [\n    {\n      \"roleNameOrId\": \"Collections\"\n    }\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Folder","{{folder_id}}","Permissions"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9c3e35b5-519b-4ec9-95c2-adb64f3b7acf","name":"SaveFolderPermissions - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"folderName\": \"Signed Contracts\",\n  \"permissionType\": 1,\n  \"roleAssignments\": [\n    {\n      \"folderRoleId\": null,\n      \"roleId\": \"5a3c2a10-9b52-4e12-8a9f-6d8e1f2b4b01\",\n      \"canAdd\": true,\n      \"canDelete\": false,\n      \"canChange\": true,\n      \"canView\": true,\n      \"canAdminister\": true,\n      \"remove\": false,\n      \"roleNameOrId\": null\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/00000000-0000-0000-0000-000000000000/Permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Folder 00000000-0000-0000-0000-000000000000 not found\"\n    ]\n}"},{"id":"88e376f4-2ea1-4c7f-9f8d-5084decc44eb","name":"SaveFolderPermissions - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"folderName\": \"Signed Contracts\",\n  \"permissionType\": 1,\n  \"roleAssignments\": [\n    {\n      \"folderRoleId\": null,\n      \"roleId\": \"5a3c2a10-9b52-4e12-8a9f-6d8e1f2b4b01\",\n      \"canAdd\": true,\n      \"canDelete\": false,\n      \"canChange\": true,\n      \"canView\": true,\n      \"canAdminister\": true,\n      \"remove\": false,\n      \"roleNameOrId\": null\n    },\n    {\n      \"folderRoleId\": \"7d2f1c55-8a11-4d22-93e0-21e39fabc010\",\n      \"roleId\": null,\n      \"canAdd\": false,\n      \"canDelete\": false,\n      \"canChange\": false,\n      \"canView\": true,\n      \"canAdminister\": false,\n      \"remove\": false,\n      \"roleNameOrId\": null\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11/Permissions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"folderName\": \"Signed Contracts\",\n        \"permissionType\": 1\n    },\n    \"errors\": []\n}"}],"_postman_id":"bd5d1ece-7510-4aa6-abfa-fc649d57a00b"},{"name":"FormGet","id":"ae12bf43-d21f-4fbd-97c7-c632891d0f9d","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Form/{{form_id}}?token={{token}}","description":"<h3 id=\"get-merge-form-by-id\">Get Merge Form by Id</h3>\n<p>Returns a single merge form record (the metadata for one merge-set entry) by its Guid <code>Id</code>. Internally calls <code>FormServices.ReturnMergeFormWithId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Form/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). The merge form <code>Id</code>. Returns <code>BadRequest</code> with \"Invalid form ID format\" when the value is not a valid Guid and \"Form not found\" when no matching row exists.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>DocSafe.MergeForms</code> entity returned by <code>FormServices.ReturnMergeFormWithId</code>, including <code>Id</code>, <code>OmegaClientId</code>, <code>MergeSet</code>, <code>FileName</code>, <code>Description</code>, <code>LastModified</code>, <code>DocumentType</code>, <code>PrintOption</code>, <code>TransmissionMethod</code>, <code>RecepientType</code>, <code>DefaultForm</code>, <code>DefaultFormLang</code>, <code>Form2</code>, <code>Form2Lang</code>, <code>Form3</code>, <code>Form3Lang</code>, <code>PdfAttachment</code>, <code>Viewoption</code>, <code>IsDocuSign</code>, <code>IsOmegaSign</code>, <code>IdVerificationRequired</code>, <code>ThirdPartyDoc</code>, <code>EDocCompany</code>, <code>Notes</code>, <code>Label1</code>-<code>Label10</code>, <code>Ts</code>, and related fields.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Form","{{form_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"cbe64166-a28b-480a-9c5d-f412f6f2a671","name":"GetForm - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Form not found\"\n    ]\n}"},{"id":"56edc4d0-7bcb-44b9-aba6-fdb7a1742b53","name":"GetForm - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form/c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form","c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001\",\n        \"OmegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n        \"MergeSet\": 4,\n        \"FileName\": \"WelcomeLetter.pdf\",\n        \"Description\": \"Welcome Letter\",\n        \"LastModified\": \"2026-03-12T09:21:41.000Z\",\n        \"DocumentType\": 1,\n        \"PrintOption\": 1,\n        \"TransmissionMethod\": null,\n        \"RecepientType\": 2,\n        \"DefaultForm\": \"08b5f21c-f201-4b5c-8b9f-2f72cdb5a01a\",\n        \"DefaultFormLang\": 1,\n        \"Form2\": null,\n        \"Form2Lang\": null,\n        \"Form3\": null,\n        \"Form3Lang\": null,\n        \"PdfAttachment\": 2,\n        \"Viewoption\": 1,\n        \"IsDocuSign\": false,\n        \"IsOmegaSign\": false,\n        \"IdVerificationRequired\": false,\n        \"CopyToPortal\": true,\n        \"CreateForPaperlessOnly\": false,\n        \"EmailSubject\": \"Welcome to Omega\",\n        \"EmailBody\": \"Please review the attached welcome letter.\",\n        \"Notes\": null,\n        \"Label1\": null,\n        \"Label2\": null,\n        \"Label3\": null,\n        \"Label4\": null,\n        \"Label5\": null,\n        \"Label6\": null,\n        \"Label7\": null,\n        \"Label8\": null,\n        \"Label9\": null,\n        \"Label10\": null,\n        \"OmegaMailerPrintDuplex\": false,\n        \"OmegaMailerCertified\": false,\n        \"OmegaMailerReturnEnvelope\": false,\n        \"UserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n        \"Ts\": \"AAAAAAAABvY=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"ae12bf43-d21f-4fbd-97c7-c632891d0f9d"},{"name":"FormsGetAll","id":"4d115131-5710-43f5-b6ce-7d81b4f96625","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Form?token={{token}}","description":"<h3 id=\"get-all-merge-forms\">Get All Merge Forms</h3>\n<p>Returns every merge form configured for the authenticated client. Internally calls <code>FormServices.ReturnAllMergeForms</code>. For large collections prefer the paged <code>GET api/Client/DocSafe/Form/MergeForms</code> endpoint instead.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Form</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the raw list of <code>DocSafe.MergeForms</code> entity rows exactly as returned by <code>FormServices.ReturnAllMergeForms</code> (including fields such as <code>Id</code>, <code>OmegaClientId</code>, <code>MergeSet</code>, <code>FileName</code>, <code>Description</code>, <code>LastModified</code>, <code>DocumentType</code>, <code>PrintOption</code>, <code>TransmissionMethod</code>, <code>RecepientType</code>, <code>DefaultForm</code>, <code>Form2</code>, <code>Form3</code>, language fields, <code>IsDocuSign</code>, <code>Ts</code>, etc.).</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Form"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ee0cae7e-48ba-4851-8f57-ecd3e6f360f9","name":"GetAllForms - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving forms: Authentication failed.\"\n    ]\n}"},{"id":"6c318110-bb50-4314-a4ec-f1bc03e0cf1f","name":"GetAllForms - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001\",\n            \"OmegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n            \"MergeSet\": 4,\n            \"FileName\": \"WelcomeLetter.pdf\",\n            \"Description\": \"Welcome Letter\",\n            \"LastModified\": \"2026-03-12T09:21:41.000Z\",\n            \"DocumentType\": 1,\n            \"PrintOption\": 1,\n            \"TransmissionMethod\": null,\n            \"RecepientType\": 2,\n            \"PdfAttachment\": 2,\n            \"Viewoption\": 1,\n            \"IsDocuSign\": false,\n            \"UserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n            \"Ts\": \"AAAAAAAABvY=\"\n        },\n        {\n            \"Id\": \"e51e4ac3-25bb-4a4d-8a29-f3a7e9f34002\",\n            \"OmegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n            \"MergeSet\": 6,\n            \"FileName\": \"PayoffQuote.pdf\",\n            \"Description\": \"Payoff Quote\",\n            \"LastModified\": \"2026-03-15T11:02:08.000Z\",\n            \"DocumentType\": 1,\n            \"PrintOption\": 1,\n            \"TransmissionMethod\": null,\n            \"RecepientType\": 2,\n            \"PdfAttachment\": 2,\n            \"Viewoption\": 1,\n            \"IsDocuSign\": false,\n            \"UserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n            \"Ts\": \"AAAAAAAABvk=\"\n        }\n    ],\n    \"errors\": []\n}"}],"_postman_id":"4d115131-5710-43f5-b6ce-7d81b4f96625"},{"name":"JobStreamAdd","id":"b334eb34-c102-4ba6-826c-3bdefad45cc1","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 42,\n    \"description\": \"Weekly Billing Statements\",\n    \"autoRunType\": 3,\n    \"dayendFrequency\": 2,\n    \"dayendWeeklyDay\": 2,\n    \"dayendMonthlyDay\": null,\n    \"details\": [\n        {\n            \"sequence\": 1,\n            \"reportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n            \"reportId\": \"00000000-0000-0000-0000-000000000000\",\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream","description":"<h3 id=\"add-job-stream\">Add Job Stream</h3>\n<p>Creates a new DocSafe job stream with its scheduling metadata and ordered detail steps (report settings). Internally calls <code>JobStreamServices.AddSaveJobStreamChanges</code>. The controller forces <code>id</code> and <code>ts</code> to null on the body so you cannot accidentally target an existing row here — use <code>PUT /api/Client/DocSafe/JobStream/{jobStreamNumberOrId}</code> for updates.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/JobStream</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>number</em></td>\n<td>Required int, &gt; 0. Client-scoped job stream number shown in the Scheduler UI.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 55 characters. Human-readable label for the job stream.</td>\n</tr>\n<tr>\n<td><em>autoRunType</em></td>\n<td>Required int (<code>JobStreamAutoRunTypes</code>): <code>1</code>=Manual, <code>2</code>=Run_Before_Dayend, <code>3</code>=Run_After_Dayend.</td>\n</tr>\n<tr>\n<td><em>dayendFrequency</em></td>\n<td>Required when <code>autoRunType</code> is not Manual (<code>JobStreamAutoRunFrequency</code>): <code>1</code>=Daily, <code>2</code>=Weekly, <code>3</code>=Monthly. Ignored when Manual.</td>\n</tr>\n<tr>\n<td><em>dayendMonthlyDay</em></td>\n<td>Required int 1–32 when <code>dayendFrequency</code> is Monthly. <code>32</code> represents \"last day of the month\".</td>\n</tr>\n<tr>\n<td><em>dayendWeeklyDay</em></td>\n<td>Required bit-flag when <code>dayendFrequency</code> is Weekly (<code>Megasys.Framework.Types.Enums.DaysOfWeek</code>): <code>Sunday=1</code>, <code>Monday=2</code>, <code>Tuesday=4</code>, <code>Wednesday=8</code>, <code>Thursday=16</code>, <code>Friday=32</code>, <code>Saturday=64</code>. Sum the desired days (e.g. Monday + Friday = <code>34</code>).</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>Required <code>JobStreamDetailParameter[]</code>. Ordered list of report-setting steps executed as part of the job stream. Must not contain null items or duplicate <code>reportSettingId</code>.</td>\n</tr>\n<tr>\n<td><em>details[].id</em></td>\n<td>Optional Guid. Omit when adding — the server assigns a new Guid to each detail. Only meaningful on PUT.</td>\n</tr>\n<tr>\n<td><em>details[].ts</em></td>\n<td>Optional base64. Only valid when updating an existing detail on PUT. Not supported on add.</td>\n</tr>\n<tr>\n<td><em>details[].sequence</em></td>\n<td>Required int. Step order within the job stream (1-based in the UI).</td>\n</tr>\n<tr>\n<td><em>details[].reportSettingId</em></td>\n<td>Required Guid. The <code>Global.ReportSetting</code> that supplies the program/parameters for this step.</td>\n</tr>\n<tr>\n<td><em>details[].reportId</em></td>\n<td>Optional Guid. When supplied must match the report setting's <code>ReportId</code>; otherwise the request is rejected. Leave empty to have the server resolve it from the report setting.</td>\n</tr>\n<tr>\n<td><em>details[].display</em></td>\n<td>Optional bool. Defaults to <code>true</code>. Controls whether the step is shown to operators when the job stream runs.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ id }</code> — the Guid assigned to the new job stream.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","JobStream"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5ca5194d-7b56-40b6-a780-a9e491b11030","name":"AddJobStream - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 42,\n    \"description\": \"Weekly Billing Statements\",\n    \"autoRunType\": 3,\n    \"dayendFrequency\": 2,\n    \"dayendWeeklyDay\": 2,\n    \"dayendMonthlyDay\": null,\n    \"details\": [\n        {\n            \"sequence\": 1,\n            \"reportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n            \"reportId\": \"00000000-0000-0000-0000-000000000000\",\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": []\n}"},{"id":"d8678250-e032-47bf-8b05-29b0d8c6676f","name":"AddJobStream - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 0,\n    \"description\": \"Weekly Billing Statements\",\n    \"autoRunType\": 3,\n    \"dayendFrequency\": 2,\n    \"dayendWeeklyDay\": 2,\n    \"dayendMonthlyDay\": null,\n    \"details\": [\n        {\n            \"sequence\": 1,\n            \"reportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n            \"reportId\": \"00000000-0000-0000-0000-000000000000\",\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"number must be greater than 0\"\n    ]\n}"}],"_postman_id":"b334eb34-c102-4ba6-826c-3bdefad45cc1"},{"name":"JobStreamByNumberGet","id":"ec621119-7974-4ca2-b5f7-df7f6a283cf7","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/ByNumber/{{job_stream_number}}?token={{token}}","description":"<h3 id=\"get-job-stream-by-number\">Get Job Stream by Number</h3>\n<p>Looks up a DocSafe job stream by its client-assigned <code>Number</code> (the small integer shown in the Scheduler UI) and returns the full entity with <code>DocSafeJobStreamDetail</code> populated. Internally calls <code>JobStreamServices.ReturnJobStreamId</code> to translate the number to a Guid and then <code>JobStreamServices.ReturnJobStream(id, fetchDetail=true, databaseName)</code> to hydrate the row.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/JobStream/ByNumber/{jobStreamNumber}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>jobStreamNumber</em></td>\n<td>Required int (route). The job stream's client-scoped <code>Number</code>. Returns <code>BadRequest</code> with \"Job stream not found\" when no job stream in the current client matches.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the same <code>DocSafe.JobStream</code> entity shape as <code>GET /api/Client/DocSafe/JobStream/{id}</code> with <code>fetchDetail=true</code>, including <code>Id</code>, <code>Number</code>, <code>Description</code>, <code>OptionalDayEndType</code>, <code>OptionalDayEndFrequency</code>, <code>OptionalDayEndMonthlyDay</code>, <code>OptionalDayEndWeeklyDay</code>, and the <code>DocSafeJobStreamDetail[]</code> collection.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","JobStream","ByNumber","{{job_stream_number}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f0f52921-00d6-4e9b-8d5b-b13d9ecb341f","name":"GetJobStreamByNumber - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/JobStream/ByNumber/12?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","JobStream","ByNumber","12"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OmegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n        \"Number\": 12,\n        \"Description\": \"Monthly Billing Statements\",\n        \"OptionalDayEndType\": 3,\n        \"OptionalDayEndFrequency\": 3,\n        \"OptionalDayEndMonthlyDay\": 1,\n        \"OptionalDayEndWeeklyDay\": null,\n        \"DocSafeJobStreamDetail\": [\n            {\n                \"Id\": \"c0aa1111-2222-3333-4444-555566667777\",\n                \"Sequence\": 1,\n                \"Program\": \"Billing Statement\",\n                \"Parameter\": \"All Active Accounts\",\n                \"ReportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n                \"ReportId\": \"ff22ff22-2222-3333-4444-555566667777\",\n                \"Display\": true,\n                \"Ts\": \"AAAAAAAAB4E=\"\n            }\n        ],\n        \"Ts\": \"AAAAAAAAB4A=\"\n    },\n    \"errors\": []\n}"},{"id":"d29e293a-d79f-4c66-89bd-531a6379bdef","name":"GetJobStreamByNumber - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/JobStream/ByNumber/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","JobStream","ByNumber","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Job stream not found\"\n    ]\n}"}],"_postman_id":"ec621119-7974-4ca2-b5f7-df7f6a283cf7"},{"name":"JobStreamGet","id":"d9b9a40f-d550-46a6-8e2c-5f3ba2ff4684","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/{{job_stream_id}}?fetchDetail=true&token={{token}}","description":"<h3 id=\"get-job-stream-by-id\">Get Job Stream by Id</h3>\n<p>This operation accepts job-stream number or job-stream GUID in <code>id</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/JobStream/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. job-stream number or job-stream GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n<tr>\n<td><em>fetchDetail</em></td>\n<td>Optional bool (query string). Defaults to <code>false</code>. When <code>true</code>, the response <code>data</code> includes the <code>DocSafeJobStreamDetail</code> collection (one entry per configured report-setting step).</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>DocSafe.JobStream</code> entity (<code>MyDocSafeJobStreamEntity</code>) returned by <code>JobStreamServices.ReturnJobStream</code>, including <code>Id</code>, <code>OmegaClientId</code>, <code>Number</code>, <code>Description</code>, <code>OptionalDayEndType</code> (see <code>JobStreamAutoRunTypes</code>), <code>OptionalDayEndFrequency</code> (see <code>JobStreamAutoRunFrequency</code>), <code>OptionalDayEndMonthlyDay</code>, <code>OptionalDayEndWeeklyDay</code> (bit-flag of <code>DaysOfWeek</code>), audit fields, and (when <code>fetchDetail=true</code>) <code>DocSafeJobStreamDetail[]</code> with <code>Id</code>, <code>Sequence</code>, <code>Program</code>, <code>Parameter</code>, <code>ReportSettingId</code>, <code>ReportId</code>, <code>Display</code>, and <code>Ts</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>job-stream number or job-stream GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/DocSafe/JobStream/1\n/api/Client/DocSafe/JobStream/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","JobStream","{{job_stream_id}}"],"host":["{{base_url}}"],"query":[{"key":"fetchDetail","value":"true"},{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c3c4c3c0-e786-4e5a-968d-50c3d2938351","name":"GetJobStream - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/JobStream/a1b2c3d4-1111-4222-9333-abcdef012345?fetchDetail=true&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","JobStream","a1b2c3d4-1111-4222-9333-abcdef012345"],"query":[{"key":"fetchDetail","value":"true"},{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OmegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n        \"Number\": 12,\n        \"Description\": \"Monthly Billing Statements\",\n        \"OptionalDayEndType\": 3,\n        \"OptionalDayEndFrequency\": 3,\n        \"OptionalDayEndMonthlyDay\": 1,\n        \"OptionalDayEndWeeklyDay\": null,\n        \"UserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n        \"BranchId\": \"b3a6a9d7-8f12-4b33-bf48-7ec3b1a6d9a2\",\n        \"BusinessDate\": \"2026-03-31T00:00:00.000Z\",\n        \"DocSafeJobStreamDetail\": [\n            {\n                \"Id\": \"c0aa1111-2222-3333-4444-555566667777\",\n                \"Sequence\": 1,\n                \"Program\": \"Billing Statement\",\n                \"Parameter\": \"All Active Accounts\",\n                \"ReportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n                \"ReportId\": \"ff22ff22-2222-3333-4444-555566667777\",\n                \"Display\": true,\n                \"Ts\": \"AAAAAAAAB4E=\"\n            }\n        ],\n        \"Ts\": \"AAAAAAAAB4A=\"\n    },\n    \"errors\": []\n}"},{"id":"d26751c6-4766-4dbe-a4cf-cd12a9a82ca4","name":"GetJobStream - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/JobStream/11111111-1111-4111-8111-111111111111?fetchDetail=true&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","JobStream","11111111-1111-4111-8111-111111111111"],"query":[{"key":"fetchDetail","value":"true"},{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"d9b9a40f-d550-46a6-8e2c-5f3ba2ff4684"},{"name":"JobStreamUpdate","id":"60fdfd49-c26f-409e-837e-bc861e073f7e","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 12,\n    \"description\": \"Monthly Billing Statements\",\n    \"autoRunType\": 3,\n    \"dayendFrequency\": 3,\n    \"dayendMonthlyDay\": 1,\n    \"dayendWeeklyDay\": null,\n    \"details\": [\n        {\n            \"id\": \"c0aa1111-2222-3333-4444-555566667777\",\n            \"sequence\": 1,\n            \"reportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n            \"reportId\": \"00000000-0000-0000-0000-000000000000\",\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/{{job_stream_number_or_id}}","description":"<h3 id=\"update-job-stream\">Update Job Stream</h3>\n<p>Updates an existing DocSafe job stream. The route parameter accepts either the Guid <code>Id</code> or the client-scoped <code>Number</code>; the controller resolves it via <code>SharedWSServices.GetDocSafeJobStreamId</code> and overwrites <code>param.id</code> with the resolved Guid before calling <code>JobStreamServices.AddSaveJobStreamChanges</code>. When <code>ts</code> is omitted the server re-reads the current row's <code>Ts</code> so callers do not need to manage concurrency tokens directly.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/JobStream/{jobStreamNumberOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>jobStreamNumberOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>Number</code>. Returns <code>BadRequest</code> with \"Job stream not found\" when it cannot be resolved. The controller overwrites any <code>id</code> in the body with the resolved Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>id</em></td>\n<td>Ignored — overwritten by the route value.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional base64. When omitted the server re-reads the current row's <code>Ts</code> for the concurrency check. Sending <code>ts</code> without <code>id</code> returns \"ts requires id\"; on this route <code>id</code> is supplied by the route so you can safely omit <code>ts</code>.</td>\n</tr>\n<tr>\n<td><em>number</em></td>\n<td>Required int, &gt; 0. Client-scoped job stream number.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 55 characters.</td>\n</tr>\n<tr>\n<td><em>autoRunType</em></td>\n<td>Required int (<code>JobStreamAutoRunTypes</code>): <code>1</code>=Manual, <code>2</code>=Run_Before_Dayend, <code>3</code>=Run_After_Dayend.</td>\n</tr>\n<tr>\n<td><em>dayendFrequency</em></td>\n<td>Required when <code>autoRunType</code> is not Manual (<code>JobStreamAutoRunFrequency</code>): <code>1</code>=Daily, <code>2</code>=Weekly, <code>3</code>=Monthly.</td>\n</tr>\n<tr>\n<td><em>dayendMonthlyDay</em></td>\n<td>Required int 1–32 when <code>dayendFrequency</code> is Monthly.</td>\n</tr>\n<tr>\n<td><em>dayendWeeklyDay</em></td>\n<td>Required bit-flag when <code>dayendFrequency</code> is Weekly (<code>DaysOfWeek</code>): <code>Sunday=1</code>, <code>Monday=2</code>, <code>Tuesday=4</code>, <code>Wednesday=8</code>, <code>Thursday=16</code>, <code>Friday=32</code>, <code>Saturday=64</code>.</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>Required <code>JobStreamDetailParameter[]</code>. Full replacement list of report-setting steps — any detail not present is removed.</td>\n</tr>\n<tr>\n<td><em>details[].id</em></td>\n<td>Optional Guid. Supply to update an existing detail in place; omit to add a new one. When supplied it must belong to the target job stream (<code>details.id 'X' does not belong to the target job stream</code> otherwise).</td>\n</tr>\n<tr>\n<td><em>details[].ts</em></td>\n<td>Optional base64. Only valid when <code>details[].id</code> is supplied. Omit to have the server re-read the current <code>Ts</code>.</td>\n</tr>\n<tr>\n<td><em>details[].sequence</em></td>\n<td>Required int. Step order.</td>\n</tr>\n<tr>\n<td><em>details[].reportSettingId</em></td>\n<td>Required Guid. Must not duplicate another entry in the same request.</td>\n</tr>\n<tr>\n<td><em>details[].reportId</em></td>\n<td>Optional Guid. Must match the report setting's <code>ReportId</code> when supplied.</td>\n</tr>\n<tr>\n<td><em>details[].display</em></td>\n<td>Optional bool. Defaults to <code>true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ id }</code> — the Guid of the updated job stream.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","JobStream","{{job_stream_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"49afb577-2bd8-4e2f-920e-bd56be96d2e0","name":"UpdateJobStream - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 12,\n    \"description\": \"Monthly Billing Statements\",\n    \"autoRunType\": 3,\n    \"dayendFrequency\": 3,\n    \"dayendMonthlyDay\": 1,\n    \"dayendWeeklyDay\": null,\n    \"details\": [\n        {\n            \"id\": \"c0aa1111-2222-3333-4444-555566667777\",\n            \"sequence\": 1,\n            \"reportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n            \"reportId\": \"00000000-0000-0000-0000-000000000000\",\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/12"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": []\n}"},{"id":"44cab1e9-a6f3-4d18-bbe2-6e385f5d6d55","name":"UpdateJobStream - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 12,\n    \"description\": \"Monthly Billing Statements\",\n    \"autoRunType\": 3,\n    \"dayendFrequency\": 3,\n    \"dayendMonthlyDay\": 1,\n    \"dayendWeeklyDay\": null,\n    \"details\": [\n        {\n            \"id\": \"c0aa1111-2222-3333-4444-555566667777\",\n            \"sequence\": 1,\n            \"reportSettingId\": \"ee11ee11-2222-3333-4444-555566667777\",\n            \"reportId\": \"00000000-0000-0000-0000-000000000000\",\n            \"display\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Job stream not found\"\n    ]\n}"}],"_postman_id":"60fdfd49-c26f-409e-837e-bc861e073f7e"},{"name":"MergeFormsGet","id":"fe3b10a5-f4f8-41a9-a63d-25960c852e29","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Form/MergeForms?token={{token}}&mergeSet=4&pattern=Welcome&pageNumber=1&pageSize=25&sortField=fileName&sortDescending=false","description":"<h3 id=\"get-merge-forms-paged-filtered\">Get Merge Forms (Paged, Filtered)</h3>\n<p>Returns a paged, filtered, sortable list of merge forms for the authenticated client. Backed by <code>FormServices.ReturnMergeForm</code> and <code>FormServices.ReturnMergeFormCount</code>; returns both the current page of rows and the overall <code>totalCount</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Form/MergeForms</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>mergeSet</em></td>\n<td>Optional int. Filter by <code>Omega.DocSafe.Types.Enums.MergeSets</code>: <code>1</code>=AP_Checks, <code>2</code>=Originations_Application_Letters, <code>4</code>=Servicing_General_Letter, <code>5</code>=Servicing_Billing_Statement_Or_Late_Notice, <code>6</code>=Servicing_Payoff_Quote, <code>7</code>=Servicing_Direct_Loan_Documents, <code>8</code>=Servicing_Payment_Receipt, <code>9</code>=Servicing_Repossession_Document, <code>10</code>=Common_Tax_Form, <code>11</code>=Insurance_Notice, <code>12</code>=Payment_Coupons, <code>13</code>=Text_Message. Invalid values return \"mergeSet is not a valid MergeSets value\".</td>\n</tr>\n<tr>\n<td><em>pattern</em></td>\n<td>Optional string. Substring pattern used to filter by file name and/or description.</td>\n</tr>\n<tr>\n<td><em>pageNumber</em></td>\n<td>Optional int, defaults to <code>1</code>. Values <code>&lt;= 0</code> are coerced to <code>1</code>.</td>\n</tr>\n<tr>\n<td><em>pageSize</em></td>\n<td>Optional int, defaults to <code>50</code>. Values <code>&lt;= 0</code> are coerced to <code>50</code>.</td>\n</tr>\n<tr>\n<td><em>sortField</em></td>\n<td>Optional string, case-insensitive. One of <code>fileName</code>, <code>description</code>, <code>mergeSet</code>, <code>lastModified</code>. Unknown or empty values default to <code>FileName</code>.</td>\n</tr>\n<tr>\n<td><em>sortDescending</em></td>\n<td>Optional bool, defaults to <code>false</code>. When <code>true</code> the chosen sort field is applied in descending order.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ pageNumber, pageSize, totalCount, rows[] }</code>. Each <code>rows</code> entry is <code>{ id, omegaClientId, mergeSet, mergeSetName, fileName, description, lastModified, transmissionMethod, recepientType, printOption, documentType, userId, userLogin, isDocuSign, ts }</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Form","MergeForms"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"mergeSet","value":"4"},{"key":"pattern","value":"Welcome"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"25"},{"key":"sortField","value":"fileName"},{"key":"sortDescending","value":"false"}],"variable":[]}},"response":[{"id":"c3fdb6aa-16b1-4551-8fa1-234826b4d7b2","name":"GetMergeForms - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form/MergeForms?token={{token}}&mergeSet=4&pattern=Welcome&pageNumber=1&pageSize=25&sortField=fileName&sortDescending=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form","MergeForms"],"query":[{"key":"token","value":"{{token}}"},{"key":"mergeSet","value":"4"},{"key":"pattern","value":"Welcome"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"25"},{"key":"sortField","value":"fileName"},{"key":"sortDescending","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"pageNumber\": 1,\n        \"pageSize\": 25,\n        \"totalCount\": 1,\n        \"rows\": [\n            {\n                \"id\": \"c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001\",\n                \"omegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n                \"mergeSet\": 4,\n                \"mergeSetName\": \"Servicing_General_Letter\",\n                \"fileName\": \"WelcomeLetter.pdf\",\n                \"description\": \"Welcome Letter\",\n                \"lastModified\": \"2026-03-12T09:21:41.000Z\",\n                \"transmissionMethod\": null,\n                \"recepientType\": 2,\n                \"printOption\": 1,\n                \"documentType\": 1,\n                \"userId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n                \"userLogin\": \"developer\",\n                \"isDocuSign\": false,\n                \"ts\": \"AAAAAAAABvY=\"\n            }\n        ]\n    },\n    \"errors\": []\n}"},{"id":"65d5acc1-49f3-4d83-96f8-28bd56b87d80","name":"GetMergeForms - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form/MergeForms?token={{token}}&mergeSet=99&pattern=Welcome&pageNumber=1&pageSize=25&sortField=fileName&sortDescending=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form","MergeForms"],"query":[{"key":"token","value":"{{token}}"},{"key":"mergeSet","value":"99"},{"key":"pattern","value":"Welcome"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"25"},{"key":"sortField","value":"fileName"},{"key":"sortDescending","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"mergeSet is not a valid MergeSets value\"\n    ]\n}"}],"_postman_id":"fe3b10a5-f4f8-41a9-a63d-25960c852e29"},{"name":"MergeSetDelete","id":"2595ae39-d547-452f-8239-aecaa5b3a4da","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Form/MergeSet/{{form_id}}?token={{token}}&deleteEnglish=false&deleteSpanish=false&deleteFrench=false","description":"<h3 id=\"delete-merge-set-or-remove-language-specific-forms\">Delete Merge Set or Remove Language-Specific Forms</h3>\n<p>Deletes an entire merge set record, or removes one or more language-specific form documents from an existing merge set. Internally calls <code>FormWSServices.DeleteMergeSetWS</code>, which decides between <code>FormServices.DeleteMergeSet</code> (full delete) and <code>FormServices.DeleteMergeForm</code> (language-specific delete) based on the query flags.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Form/MergeSet/{id}</code></p>\n<h4 id=\"behaviour\">Behaviour</h4>\n<ul>\n<li><p>If <code>deleteEnglish</code>, <code>deleteSpanish</code>, and <code>deleteFrench</code> are all <code>false</code>\n(default), the entire merge set record is deleted via\n<code>FormServices.DeleteMergeSet</code>. <code>data.deletedMergeSet</code> is <code>true</code>.</p>\n</li>\n<li><p>If any of <code>deleteEnglish</code>, <code>deleteSpanish</code>, or <code>deleteFrench</code> is <code>true</code>, only\nthe specified language form document bindings are removed from the merge\nset via <code>FormServices.DeleteMergeForm</code>. The merge set row itself is kept.\n<code>data.deletedMergeSet</code> is <code>false</code>.</p>\n</li>\n<li><p>Concurrency timestamps are resolved server-side: the current row's <code>Ts</code> is\nused. <code>ts</code> is not accepted via query string.</p>\n</li>\n<li><p>If the form is referenced elsewhere (foreign key in use), the call returns\n\"This form is currently in use. The form cannot be deleted until all\nreferences to it in other screens are removed.\"</p>\n</li>\n</ul>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). The merge form <code>Id</code> to delete. Returns <code>BadRequest</code> with an invalid-parameter message when the value is not a valid Guid, and \"Form not found\" when no matching row exists.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>deleteEnglish</em></td>\n<td>Optional bool, defaults to <code>false</code>. When <code>true</code>, removes the English (default) form document from the merge set.</td>\n</tr>\n<tr>\n<td><em>deleteSpanish</em></td>\n<td>Optional bool, defaults to <code>false</code>. When <code>true</code>, removes the Spanish form document from the merge set.</td>\n</tr>\n<tr>\n<td><em>deleteFrench</em></td>\n<td>Optional bool, defaults to <code>false</code>. When <code>true</code>, removes the French form document from the merge set.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ id, deletedMergeSet }</code>. <code>id</code> echoes the deleted merge form Guid. <code>deletedMergeSet</code> is <code>true</code> when the entire merge set was deleted, or <code>false</code> when only language-specific form documents were removed.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Form","MergeSet","{{form_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"deleteEnglish","value":"false"},{"key":"deleteSpanish","value":"false"},{"key":"deleteFrench","value":"false"}],"variable":[]}},"response":[{"id":"3816ed2a-9ae1-47bb-b447-bfc2c04648fe","name":"DeleteMergeSet - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form/MergeSet/c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001?token={{token}}&deleteEnglish=false&deleteSpanish=false&deleteFrench=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form","MergeSet","c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001"],"query":[{"key":"token","value":"{{token}}"},{"key":"deleteEnglish","value":"false"},{"key":"deleteSpanish","value":"false"},{"key":"deleteFrench","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001\",\n        \"deletedMergeSet\": true\n    },\n    \"errors\": []\n}"},{"id":"38c251db-b557-401a-851e-b3926d6935c1","name":"DeleteMergeSet - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Form/MergeSet/00000000-0000-0000-0000-000000000000?token={{token}}&deleteEnglish=false&deleteSpanish=false&deleteFrench=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Form","MergeSet","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"},{"key":"deleteEnglish","value":"false"},{"key":"deleteSpanish","value":"false"},{"key":"deleteFrench","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Form not found\"\n    ]\n}"}],"_postman_id":"2595ae39-d547-452f-8239-aecaa5b3a4da"},{"name":"MergeSetSave","id":"6111aecd-5c98-438a-bdeb-64804cfbf9ca","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"formId\": \"c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001\",\n    \"ts\": null,\n    \"mergeSet\": 4,\n    \"fileName\": \"WelcomeLetter.pdf\",\n    \"description\": \"Welcome Letter\",\n    \"documentType\": 1,\n    \"printOptions\": 1,\n    \"pdfAttachment\": 2,\n    \"viewoption\": 1,\n    \"recepient\": 2,\n    \"defaultFormLang\": 1,\n    \"form2Lang\": null,\n    \"form3Lang\": null,\n    \"eDocCompany\": null,\n    \"thirdPartyDoc\": null,\n    \"thirdPartyFolderId\": null,\n    \"thirdPartyFolderUri\": null,\n    \"englishTextMessageDoc\": null,\n    \"spanishTextMessageDoc\": null,\n    \"frenchTextMessageDoc\": null,\n    \"emailSubject\": \"Welcome to Omega\",\n    \"emailBody\": \"Please review the attached welcome letter.\",\n    \"copyToPortal\": true,\n    \"isOmegaSign\": false,\n    \"createForPaperlessOnly\": false,\n    \"idVerificationRequired\": false,\n    \"label1\": null,\n    \"label2\": null,\n    \"label3\": null,\n    \"label4\": null,\n    \"label5\": null,\n    \"label6\": null,\n    \"label7\": null,\n    \"label8\": null,\n    \"label9\": null,\n    \"label10\": null,\n    \"notes\": null,\n    \"omegaMailerPrintDuplex\": false,\n    \"omegaMailerCertified\": false,\n    \"omegaMailerReturnEnvelope\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Form/Save","description":"<h3 id=\"save-merge-set-add-or-update-merge-form-metadata\">Save Merge Set (Add or Update Merge Form Metadata)</h3>\n<p>Creates a new merge form or saves changes to an existing one. Internally calls <code>FormServices.AddSaveMergeSet</code>. <strong>File uploads are not supported by this API</strong> — empty upload collections are passed to the business method, so the underlying <code>DefaultForm</code> / <code>Form2</code> / <code>Form3</code> document bindings remain unchanged. When creating a new form whose <code>printOptions</code> is not <code>Third_Party</code> (3) and whose <code>mergeSet</code> is not <code>Text_Message</code> (13), a default form must already be uploaded for the target row, otherwise the call returns \"A default form is required. File upload is not supported by this API.\" Use the Omega UI (<code>FormManager.aspx</code>) to upload the initial document, then this endpoint can be used to update the metadata.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Form/Save</code></p>\n<h4 id=\"behaviour-highlights\">Behaviour Highlights</h4>\n<ul>\n<li><p>Internal enforcement of option coupling (applied server-side before saving):</p>\n<ul>\n<li><code>printOptions = Third_Party</code> forces <code>recepient = Customer</code>,\n<code>pdfAttachment = None</code>, <code>viewoption = None</code>, and clears <code>isOmegaSign</code> /\n<code>idVerificationRequired</code>. Clearing <code>thirdPartyDoc</code> / <code>eDocCompany</code> /\n<code>thirdPartyFolderId</code> / <code>thirdPartyFolderUri</code> is only done automatically\nwhen <code>printOptions != Third_Party</code>.</li>\n<li><code>printOptions = OmegaMailer</code> forces <code>pdfAttachment = Account</code>, disables\n<code>isOmegaSign</code> / <code>idVerificationRequired</code>. If <code>viewoption = None</code> it is\nupgraded to <code>Account_Only</code>.</li>\n<li><code>mergeSet</code> in {<code>Text_Message</code>, <code>AP_Checks</code>, <code>Payment_Coupons</code>,\n<code>Common_Tax_Form</code>} forces <code>pdfAttachment = None</code>.</li>\n<li><code>isOmegaSign = true</code> forces <code>pdfAttachment = Account</code>.</li>\n<li><code>pdfAttachment != Account</code> forces <code>viewoption = None</code>.</li>\n<li><code>printOptions = OmegaMailer</code>, <code>isOmegaSign</code>, or <code>mergeSet = Insurance_Notice</code> force <code>recepient = Customer</code>.</li>\n</ul>\n</li>\n<li><p><code>Third_Party</code> requires <code>thirdPartyDoc</code> and <code>eDocCompany</code>. When\n<code>eDocCompany = Other_Company</code> (100) an in-house environment additionally\nrequires <code>thirdPartyFolderUri</code>, and a hosted environment requires\n<code>thirdPartyFolderId</code>.</p>\n</li>\n</ul>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>formId</em></td>\n<td>Optional Guid. Existing merge form Id when updating. Omit to create a new row (a new Guid is generated and returned).</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional byte[] (base64). Row timestamp for concurrency control. When provided without <code>formId</code>, returns \"ts requires formId\". When omitted on update, the existing row's <code>Ts</code> is used.</td>\n</tr>\n<tr>\n<td><em>mergeSet</em></td>\n<td>Required int. <code>MergeSets</code> enum: <code>1</code>=AP_Checks, <code>2</code>=Originations_Application_Letters, <code>4</code>=Servicing_General_Letter, <code>5</code>=Servicing_Billing_Statement_Or_Late_Notice, <code>6</code>=Servicing_Payoff_Quote, <code>7</code>=Servicing_Direct_Loan_Documents, <code>8</code>=Servicing_Payment_Receipt, <code>9</code>=Servicing_Repossession_Document, <code>10</code>=Common_Tax_Form, <code>11</code>=Insurance_Notice, <code>12</code>=Payment_Coupons, <code>13</code>=Text_Message.</td>\n</tr>\n<tr>\n<td><em>fileName</em></td>\n<td>Required string. Display file name. Commas are not allowed.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Free-text description.</td>\n</tr>\n<tr>\n<td><em>documentType</em></td>\n<td>Required int. <code>DocumentTypes</code> enum: <code>1</code>=Regular, <code>2</code>=Repo_Customer_Notification_Document, <code>3</code>=Add_Insurance_Letter, <code>4</code>=Add_In_Contract_Insurance_Letter, <code>5</code>=Cancel_Insurance_Letter.</td>\n</tr>\n<tr>\n<td><em>printOptions</em></td>\n<td>Required int. <code>PrintOptions</code> enum: <code>1</code>=PDF, <code>2</code>=OmegaMailer, <code>3</code>=Third_Party, <code>4</code>=Solutions_By_text, <code>5</code>=TextThread.</td>\n</tr>\n<tr>\n<td><em>pdfAttachment</em></td>\n<td>Required int. <code>PDFAttachmentOptions</code> enum: <code>1</code>=None, <code>2</code>=Account.</td>\n</tr>\n<tr>\n<td><em>viewoption</em></td>\n<td>Required int. <code>AccountDocumentViewOptions</code> enum: <code>0</code>=None, <code>1</code>=Account_Only, <code>2</code>=Account_And_Dealer_Portal, <code>3</code>=Account_And_Customer_Portal, <code>500</code>=All.</td>\n</tr>\n<tr>\n<td><em>recepient</em></td>\n<td>Optional int. <code>RecipientTypes</code> enum: <code>1</code>=Dealer, <code>2</code>=Customer, <code>3</code>=Repo_Agent. May be overridden by internal coupling rules.</td>\n</tr>\n<tr>\n<td><em>defaultFormLang</em>, <em>form2Lang</em>, <em>form3Lang</em></td>\n<td>Optional int. <code>UserLanguageTypes</code> enum (e.g. <code>1</code>=English, <code>2</code>=Spanish, <code>3</code>=French).</td>\n</tr>\n<tr>\n<td><em>eDocCompany</em></td>\n<td>Optional int. <code>ThirdPartyDocumentCompany</code> enum: <code>1</code>=Newcourse, <code>100</code>=Other_Company. Required when <code>printOptions = Third_Party</code>.</td>\n</tr>\n<tr>\n<td><em>thirdPartyDoc</em></td>\n<td>Optional string. Third-party document identifier. Required when <code>printOptions = Third_Party</code>.</td>\n</tr>\n<tr>\n<td><em>thirdPartyFolderId</em></td>\n<td>Optional Guid. Required when <code>printOptions = Third_Party</code> and <code>eDocCompany = Other_Company</code> on hosted environments.</td>\n</tr>\n<tr>\n<td><em>thirdPartyFolderUri</em></td>\n<td>Optional string. Required when <code>printOptions = Third_Party</code> and <code>eDocCompany = Other_Company</code> on in-house environments.</td>\n</tr>\n<tr>\n<td><em>englishTextMessageDoc</em>, <em>spanishTextMessageDoc</em>, <em>frenchTextMessageDoc</em></td>\n<td>Optional string. Text-message body templates per language (used when <code>mergeSet = Text_Message</code>).</td>\n</tr>\n<tr>\n<td><em>emailSubject</em>, <em>emailBody</em></td>\n<td>Optional string. Template subject and body for email delivery.</td>\n</tr>\n<tr>\n<td><em>copyToPortal</em></td>\n<td>Required bool. When true, copy generated documents to the customer/dealer portal.</td>\n</tr>\n<tr>\n<td><em>isOmegaSign</em></td>\n<td>Required bool. Enable OmegaSign e-signature flow. May be forced off by internal coupling rules.</td>\n</tr>\n<tr>\n<td><em>createForPaperlessOnly</em></td>\n<td>Required bool. Restrict generation to paperless-enrolled accounts.</td>\n</tr>\n<tr>\n<td><em>idVerificationRequired</em></td>\n<td>Required bool. Require identity verification for signing. May be forced off by internal coupling rules.</td>\n</tr>\n<tr>\n<td><em>label1</em> through <em>label10</em></td>\n<td>Optional string. Up to 10 custom labels.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-text notes.</td>\n</tr>\n<tr>\n<td><em>omegaMailerPrintDuplex</em>, <em>omegaMailerCertified</em>, <em>omegaMailerReturnEnvelope</em></td>\n<td>Required bool. OmegaMailer print options.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ formId }</code> containing the Guid of the new or updated form.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Form","Save"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f797061a-7883-4a1f-859c-72d74fe57972","name":"SaveMergeSet - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"formId\": null,\n    \"ts\": null,\n    \"mergeSet\": 4,\n    \"fileName\": \"\",\n    \"description\": \"Welcome Letter\",\n    \"documentType\": 1,\n    \"printOptions\": 1,\n    \"pdfAttachment\": 2,\n    \"viewoption\": 1,\n    \"recepient\": 2,\n    \"defaultFormLang\": 1,\n    \"form2Lang\": null,\n    \"form3Lang\": null,\n    \"eDocCompany\": null,\n    \"thirdPartyDoc\": null,\n    \"thirdPartyFolderId\": null,\n    \"thirdPartyFolderUri\": null,\n    \"englishTextMessageDoc\": null,\n    \"spanishTextMessageDoc\": null,\n    \"frenchTextMessageDoc\": null,\n    \"emailSubject\": \"Welcome to Omega\",\n    \"emailBody\": \"Please review the attached welcome letter.\",\n    \"copyToPortal\": true,\n    \"isOmegaSign\": false,\n    \"createForPaperlessOnly\": false,\n    \"idVerificationRequired\": false,\n    \"label1\": null,\n    \"label2\": null,\n    \"label3\": null,\n    \"label4\": null,\n    \"label5\": null,\n    \"label6\": null,\n    \"label7\": null,\n    \"label8\": null,\n    \"label9\": null,\n    \"label10\": null,\n    \"notes\": null,\n    \"omegaMailerPrintDuplex\": false,\n    \"omegaMailerCertified\": false,\n    \"omegaMailerReturnEnvelope\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Form/Save"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"fileName is required\"\n    ]\n}"},{"id":"219c4d15-fd0f-43de-b015-1149ccefed25","name":"SaveMergeSet - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"formId\": \"c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001\",\n    \"ts\": null,\n    \"mergeSet\": 4,\n    \"fileName\": \"WelcomeLetter.pdf\",\n    \"description\": \"Welcome Letter\",\n    \"documentType\": 1,\n    \"printOptions\": 1,\n    \"pdfAttachment\": 2,\n    \"viewoption\": 1,\n    \"recepient\": 2,\n    \"defaultFormLang\": 1,\n    \"form2Lang\": null,\n    \"form3Lang\": null,\n    \"eDocCompany\": null,\n    \"thirdPartyDoc\": null,\n    \"thirdPartyFolderId\": null,\n    \"thirdPartyFolderUri\": null,\n    \"englishTextMessageDoc\": null,\n    \"spanishTextMessageDoc\": null,\n    \"frenchTextMessageDoc\": null,\n    \"emailSubject\": \"Welcome to Omega\",\n    \"emailBody\": \"Please review the attached welcome letter.\",\n    \"copyToPortal\": true,\n    \"isOmegaSign\": false,\n    \"createForPaperlessOnly\": false,\n    \"idVerificationRequired\": false,\n    \"label1\": null,\n    \"label2\": null,\n    \"label3\": null,\n    \"label4\": null,\n    \"label5\": null,\n    \"label6\": null,\n    \"label7\": null,\n    \"label8\": null,\n    \"label9\": null,\n    \"label10\": null,\n    \"notes\": null,\n    \"omegaMailerPrintDuplex\": false,\n    \"omegaMailerCertified\": false,\n    \"omegaMailerReturnEnvelope\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Form/Save"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"formId\": \"c3c7a2b1-9105-4c09-8d2e-a0c66c1f3001\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"6111aecd-5c98-438a-bdeb-64804cfbf9ca"},{"name":"MoveDocument","id":"7e4da8eb-7aae-4310-9836-b581c3632371","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Move","description":"<h3 id=\"move-document\">Move Document</h3>\n<p>Moves a DocSafe document from its current folder into a different folder. Internally calls <code>DocumentServices.MoveDocument</code>, which re-parents the <code>Document</code> row by updating <code>FolderId</code>. The underlying storage object is retained (its key does not change).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Move</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>documentId</em></td>\n<td>Required Guid. Id of the DocSafe document to move.</td>\n</tr>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. Id of the target DocSafe folder.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ documentId, folderId }</code> echoing the document and its new folder.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Move"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"de82f5ee-00ae-4d88-afaa-016a89408200","name":"MoveDocument - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"00000000-0000-0000-0000-000000000000\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Move"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"documentId and folderId are required\"\n    ]\n}"},{"id":"f8a43452-276a-44b2-883d-0329423ad759","name":"MoveDocument - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n    \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Document/Move"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"documentId\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n        \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"7e4da8eb-7aae-4310-9836-b581c3632371"},{"name":"MoveFolder","id":"a913567c-3b11-449c-afcf-db1b6116dff7","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"folderId\": \"{{docsafe_child_folder_id}}\",\n    \"newParentId\": \"{{folder_id}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/Move","description":"<h3 id=\"move-folder\">Move Folder</h3>\n<p>Moves a DocSafe folder under a different parent folder. Internally calls <code>FolderServices.MoveFolderinDB</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Folder/Move</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, as signed API headers, or as a <code>?token=</code> query-string parameter.</td>\n</tr>\n<tr>\n<td><em>folderId</em></td>\n<td>Required Guid. Id of the folder being moved. Returns <code>BadRequest</code> with \"Folder {folderId} not found\" when the row does not exist.</td>\n</tr>\n<tr>\n<td><em>newParentId</em></td>\n<td>Required Guid. Id of the destination parent folder. Returns <code>BadRequest</code> with \"Parent folder {newParentId} not found\" when the row does not exist, and \"folderId and newParentId are required\" when either value is missing or <code>Guid.Empty</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ folderId, newParentId }</code> on success.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Folder","Move"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0c6298b4-3f7a-433b-9287-6992aeb48da6","name":"MoveFolder - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"folderId\": \"00000000-0000-0000-0000-000000000000\",\n    \"newParentId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/Move"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"folderId and newParentId are required\"\n    ]\n}"},{"id":"32b6a89e-70c0-46bf-93ad-7119c7d83021","name":"MoveFolder - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"folderId\": \"d9a2c551-ea73-4a0b-9f15-7d5a9b7b1b21\",\n    \"newParentId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/Move"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"folderId\": \"d9a2c551-ea73-4a0b-9f15-7d5a9b7b1b21\",\n        \"newParentId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"a913567c-3b11-449c-afcf-db1b6116dff7"},{"name":"QueryDocuments","id":"fbbcf962-daea-4bb5-b7a3-7552eb74381f","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Document/Query?token={{token}}&pageNumber=1&pageSize=50&includeInactive=false&sortField=creationDate&sortDescending=true","description":"<h3 id=\"query-documents-paged\">Query Documents (paged)</h3>\n<p>Paged search across DocSafe documents. All filters are optional; omit them to fall back to the default paging (<code>pageNumber=1</code>, <code>pageSize=50</code>, <code>sortDescending=true</code>). Mirrors the grid filters in <code>DocumentManager.aspx</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Document/Query</code></p>\n<h4 id=\"query-string-parameters\">Query-String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (may also be sent as <code>SessionId</code> header or signed API headers).</td>\n</tr>\n<tr>\n<td><em>folderId</em></td>\n<td>Optional Guid. Restrict results to a specific DocSafe folder.</td>\n</tr>\n<tr>\n<td><em>branchId</em></td>\n<td>Optional Guid. Restrict results to a specific branch.</td>\n</tr>\n<tr>\n<td><em>currentBranchOnly</em></td>\n<td>Optional boolean. When <code>true</code>, limits results to the logged-in user's current branch. Defaults to <code>false</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Case-insensitive <code>contains</code> match against the document description.</td>\n</tr>\n<tr>\n<td><em>fileType</em></td>\n<td>Optional string. File extension filter (e.g. <code>.pdf</code>).</td>\n</tr>\n<tr>\n<td><em>createdFrom</em></td>\n<td>Optional date. Lower bound (inclusive) on <code>CreationDate</code>.</td>\n</tr>\n<tr>\n<td><em>createdThrough</em></td>\n<td>Optional date. Upper bound (inclusive) on <code>CreationDate</code>.</td>\n</tr>\n<tr>\n<td><em>createdByUserId</em></td>\n<td>Optional Guid. Setup user who created the document.</td>\n</tr>\n<tr>\n<td><em>includeInactive</em></td>\n<td>Optional boolean. When <code>true</code>, includes disabled documents. Defaults to <code>false</code>.</td>\n</tr>\n<tr>\n<td><em>pageNumber</em></td>\n<td>Optional int. 1-based page index. Defaults to <code>1</code>.</td>\n</tr>\n<tr>\n<td><em>pageSize</em></td>\n<td>Optional int. Page size. Defaults to <code>50</code>.</td>\n</tr>\n<tr>\n<td><em>sortField</em></td>\n<td>Optional string. Sort column. Supported values: <code>description</code>, <code>fileName</code>, <code>fileType</code>, <code>fileSize</code>, <code>creationDate</code>, <code>createdByUserLogin</code>, <code>active</code>. Any other value falls back to <code>creationDate</code>.</td>\n</tr>\n<tr>\n<td><em>sortDescending</em></td>\n<td>Optional boolean. When <code>true</code>, sorts descending. Defaults to <code>true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ pageNumber, pageSize, totalCount, rows[] }</code>. Each row carries <code>id</code>, <code>folderId</code>, <code>description</code>, <code>fileName</code>, <code>createdByUserId</code>, <code>createdByUserLogin</code>, <code>creationDate</code>, <code>fileType</code>, <code>fileSize</code>, <code>active</code>, <code>processName</code>, <code>location</code>, and <code>ts</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Query field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>branchNumberOrId</code></td>\n<td><code>branchId</code></td>\n<td>A branch number or branch GUID.</td>\n</tr>\n<tr>\n<td><code>createdByUserLoginOrId</code></td>\n<td><code>createdByUserId</code></td>\n<td>A user login or user GUID.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Omit filters to leave them unrestricted. Explicitly blank new filters fail. For example, <code>branchNumberOrId=90&amp;createdByUserLoginOrId=collector.login</code>. If both scalar forms are supplied, they must identify the same record.</p>\n<p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Document","Query"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"50"},{"key":"includeInactive","value":"false"},{"key":"sortField","value":"creationDate"},{"key":"sortDescending","value":"true"}],"variable":[]}},"response":[{"id":"e97ecec8-802a-415a-93c4-0fb648a78b38","name":"QueryDocuments - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document/Query?token=invalid-token&pageNumber=1&pageSize=50&includeInactive=false&sortField=creationDate&sortDescending=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document","Query"],"query":[{"key":"token","value":"invalid-token"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"50"},{"key":"includeInactive","value":"false"},{"key":"sortField","value":"creationDate"},{"key":"sortDescending","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error querying documents: Invalid or expired session token\"\n    ]\n}"},{"id":"a2f0079c-69d5-4347-a2f4-176eabeaff3c","name":"QueryDocuments - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Document/Query?token={{token}}&pageNumber=1&pageSize=50&includeInactive=false&sortField=creationDate&sortDescending=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Document","Query"],"query":[{"key":"token","value":"{{token}}"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"50"},{"key":"includeInactive","value":"false"},{"key":"sortField","value":"creationDate"},{"key":"sortDescending","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"pageNumber\": 1,\n        \"pageSize\": 50,\n        \"totalCount\": 1,\n        \"rows\": [\n            {\n                \"id\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21\",\n                \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n                \"description\": \"Signed Contract\",\n                \"fileName\": \"signed_contract.pdf\",\n                \"createdByUserId\": \"1b3db84f-6d11-4a5a-8b33-3c5a1a12ff8e\",\n                \"createdByUserLogin\": \"developer\",\n                \"creationDate\": \"2026-03-12T09:21:41.000Z\",\n                \"fileType\": \".pdf\",\n                \"fileSize\": 12845,\n                \"active\": true,\n                \"processName\": \"upload\",\n                \"location\": \"b4f12c81-3d09-4b8b-9a35-0f8c5b2a5f21signed_contract.pdf\",\n                \"ts\": \"AAAAAAAABtg=\"\n            }\n        ]\n    },\n    \"errors\": []\n}"}],"_postman_id":"fbbcf962-daea-4bb5-b7a3-7552eb74381f"},{"name":"RenameFolder","id":"3b8ee77f-57e1-415d-85f3-6c359de2fbaa","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"newName\": \"Archived Contracts\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/{{folder_id}}","description":"<h3 id=\"rename-folder\">Rename Folder</h3>\n<p>Renames an existing DocSafe folder. Internally calls <code>FolderServices.RenameFolder</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Folder/{id}</code></p>\n<h4 id=\"route--query--body-parameters\">Route / Query / Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). Id of the folder to rename. The controller overwrites <code>folderId</code> in the body with this route value. Returns <code>BadRequest</code> (<code>INVALID_PARAMETER_ERROR_MESSAGE</code>) if <code>{id}</code> is not a valid Guid.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. PUT bodies are inspected for <code>token</code>; a <code>SessionId</code> header, signed API headers, or a <code>?token=</code> query string also work.</td>\n</tr>\n<tr>\n<td><em>newName</em></td>\n<td>Required string. New name for the folder. Returns <code>BadRequest</code> with \"folderId and newName are required\" when missing, and \"Folder {id} not found\" when the folder does not exist.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ folderId, newName }</code> on success.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Folder","{{folder_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"846fe3c4-a33b-4d67-81dd-dd5ec485e819","name":"RenameFolder - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"newName\": \"Archived Contracts\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Folder 00000000-0000-0000-0000-000000000000 not found\"\n    ]\n}"},{"id":"b897dad1-1296-4091-887d-4e13ceb8a24c","name":"RenameFolder - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"newName\": \"Archived Contracts\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/Folder/ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"folderId\": \"ab1c3f10-7a16-47a3-97c5-8e2e1c9d0e11\",\n        \"newName\": \"Archived Contracts\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"3b8ee77f-57e1-415d-85f3-6c359de2fbaa"},{"name":"RunningJobStreamsGet","id":"bf9ccbcc-1696-4d09-a09d-c83f4d896460","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/Running?token={{token}}","description":"<h3 id=\"get-running-job-streams\">Get Running Job Streams</h3>\n<p>Returns the job streams currently executing for the caller's client, ordered by server-side start time (oldest first). Internally calls <code>JobStreamServices.ReturnCompanyRunningJobs(clientId, false)</code> and projects each entry into a <code>RunningJobStreamSummary</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/JobStream/Running</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>RunningJobStreamSummary</code> objects, each with:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid. Running job stream <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>number</em></td>\n<td>int. Client-scoped job stream <code>Number</code>.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>string. Job stream description.</td>\n</tr>\n<tr>\n<td><em>user</em></td>\n<td>string. Login name of the user that started the run.</td>\n</tr>\n<tr>\n<td><em>startTimeServer</em></td>\n<td>DateTime. UTC timestamp the worker thread began executing on the server.</td>\n</tr>\n<tr>\n<td><em>reportSettingIds</em></td>\n<td>Guid[]. Report setting ids included in the running job (empty array when none are tracked yet).</td>\n</tr>\n</tbody>\n</table>\n</div><p>When no job streams are running the list is returned as an empty array.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","JobStream","Running"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"95527cd5-1cb0-4882-8f4e-fcc6195deb37","name":"GetRunningJobStreams - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/JobStream/Running?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","JobStream","Running"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving running job streams: Invalid or expired session token\"\n    ]\n}"},{"id":"ca92b300-2e6c-409c-91ce-f59364d27545","name":"GetRunningJobStreams - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/JobStream/Running?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","JobStream","Running"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"number\": 12,\n            \"description\": \"Monthly Billing Statements\",\n            \"user\": \"developer\",\n            \"startTimeServer\": \"2026-04-18T03:45:12.000Z\",\n            \"reportSettingIds\": [\n                \"ee11ee11-2222-3333-4444-555566667777\"\n            ]\n        }\n    ],\n    \"errors\": []\n}"}],"_postman_id":"bf9ccbcc-1696-4d09-a09d-c83f4d896460"},{"name":"StartJobStream","id":"3837f421-23b3-4ebb-abcc-02f2458006dd","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"jobStreamNumberOrId\": \"12\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/Run","description":"<h3 id=\"run-job-stream\">Run Job Stream</h3>\n<p>Starts the given job stream on a background worker thread and returns immediately with an <code>Accepted</code> acknowledgement. Internally calls <code>SharedWSServices.GetDocSafeJobStreamId</code> to resolve the number-or-id into a concrete Guid, <code>JobStreamServices.ReturnJobStream</code> to confirm the row exists, <code>JobStreamServices.ReturnCompanyRunningJobs</code> to reject duplicate runs (\"Job stream 'N' is currently in progress…\"), and then spins up a <code>Thread</code> that invokes <code>JobStreamServices.StartJobThread</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/JobStream/Run</code></p>\n<p><strong>Behavior notes:</strong></p>\n<ul>\n<li><p>Execution is fire-and-forget — the HTTP response returns once the worker\nthread has been scheduled, before the job stream itself completes. Poll\n<code>GET /api/Client/DocSafe/JobStream/Running</code> to observe progress.</p>\n</li>\n<li><p>Only one run per job stream is allowed at a time per client. A duplicate\nstart attempt returns <code>BadRequest</code> with the in-progress error message.</p>\n</li>\n<li><p>Requires a live <code>HttpContext.Current.Server</code> (to map <code>~</code> for the worker);\ncalls made from background jobs that lack an ASP.NET context will return\n<code>BadRequest</code> with \"Unable to resolve application path for job stream\nexecution\".</p>\n</li>\n</ul>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>jobStreamNumberOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>Number</code> of the job stream. <code>SharedWSServices.GetDocSafeJobStreamId</code> resolves the value; <code>BadRequest</code> with \"Job stream not found\" is returned when it cannot.</td>\n</tr>\n<tr>\n<td><em>jobStreamId</em></td>\n<td>Ignored on input — the controller overwrites this with the resolved Guid before calling the WS service.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ jobStreamId, number, description, status, message }</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>jobStreamId</em></td>\n<td>Guid. Resolved job stream id that was started.</td>\n</tr>\n<tr>\n<td><em>number</em></td>\n<td>int. Client-scoped job stream number.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>string. Job stream description.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td>string. Always <code>\"Accepted\"</code> on success (job stream started on a worker thread).</td>\n</tr>\n<tr>\n<td><em>message</em></td>\n<td>string. <code>\"Your job stream request has started.\"</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","DocSafe","JobStream","Run"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0c04c326-5b28-4449-aa10-5c6eda8e4ff1","name":"StartJobStream - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"jobStreamNumberOrId\": \"999999\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/Run"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Job stream not found\"\n    ]\n}"},{"id":"3deee340-7579-4aa1-8d60-c30e054eed95","name":"StartJobStream - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"jobStreamNumberOrId\": \"12\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/DocSafe/JobStream/Run"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"jobStreamId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"number\": 12,\n        \"description\": \"Monthly Billing Statements\",\n        \"status\": \"Accepted\",\n        \"message\": \"Your job stream request has started.\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"3837f421-23b3-4ebb-abcc-02f2458006dd"},{"name":"SystemFolderGet","id":"9a3d6362-5864-4719-a7ad-ff6602ff6821","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/DocSafe/Folder/System/{{system_folder_type}}?token={{token}}","description":"<h3 id=\"get-system-folder-by-type\">Get System Folder by Type</h3>\n<p>Returns the DocSafe folder that matches the built-in system folder type for the current client. Internally calls <code>FolderServices.ReturnSystemFolder</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/DocSafe/Folder/System/{systemFolderType}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>systemFolderType</em></td>\n<td>Required int. Maps to <code>Omega.DocSafe.Types.Enums.SystemFolderType</code>: <code>1</code> = System, <code>2</code> = OmegaMailer, <code>3</code> = OFAC, <code>4</code> = Loan App Error (<code>Error_Loan_App</code>), <code>5</code> = ZZ-Orphan Documents (<code>ZZ_Orphan_Documents</code>). Returns <code>BadRequest</code> with \"System folder not found\" when the client has no row for that type.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>DocSafe.Folder</code> entity for the requested system folder, including <code>Id</code>, <code>OmegaClientId</code>, <code>FolderName</code>, <code>ParentId</code>, <code>PermissionType</code>, <code>PreventDelete</code> (typically <code>true</code> for system folders), <code>FolderType</code>, <code>Active</code>, <code>CreatedByUserId</code>, <code>CreationDate</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","DocSafe","Folder","System","{{system_folder_type}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4fa27b0a-b2d8-4f6f-9fef-fb8d3fa30c5b","name":"GetSystemFolder - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Folder/System/99?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Folder","System","99"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"System folder not found\"\n    ]\n}"},{"id":"34973c80-c1fd-4771-8b49-c089eca5a7e4","name":"GetSystemFolder - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/DocSafe/Folder/System/2?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","DocSafe","Folder","System","2"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1a3e210-8f45-4b22-8db0-42ef1a9c2201\",\n        \"OmegaClientId\": \"0d60b2f5-1e3a-4e1b-91de-5d78a9a8f051\",\n        \"FolderName\": \"OmegaMailer\",\n        \"ParentId\": \"55555555-5555-5555-5555-555555555555\",\n        \"CreationDate\": \"2024-05-01T00:00:00.000Z\",\n        \"Active\": true,\n        \"FolderType\": 0,\n        \"CreatedByUserId\": null,\n        \"PermissionType\": 2,\n        \"PreventDelete\": true,\n        \"Ts\": \"AAAAAAAABhI=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"9a3d6362-5864-4719-a7ad-ff6602ff6821"}],"id":"c03062eb-f3b4-4de6-be66-5263e4b7bd98","_postman_id":"c03062eb-f3b4-4de6-be66-5263e4b7bd98","description":""},{"name":"General Ledger","item":[{"name":"ChartAdd","id":"a56860c9-d4b9-4336-a5cd-0967a822167e","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"acctNumberId\": \"{{gl_chart_new_account_id}}\",\n  \"branchAcctId\": \"{{gl_chart_new_branch_id}}\",\n  \"classAcctId\": null,\n  \"portfolioAcctId\": null,\n  \"description\": \"Operating cash - Main branch\",\n  \"notes\": \"\",\n  \"isConfirmed\": true,\n  \"branchAcctNumberOrId\": null,\n  \"classAcctNumberOrId\": null,\n  \"portfolioAcctNumberOrId\": null,\n  \"acctNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart","description":"<h3 id=\"add-gl-chart\">Add GL Chart</h3>\n<p>Creates a new General Ledger chart row — the intersection of a GL account with optional branch, class, and portfolio dimensions. The controller forces <code>id = null</code> and <code>ts = null</code> on the body, so this route always inserts; use <code>PUT /api/Client/GeneralLedger/Chart/{id}</code> to update an existing chart. Internally calls <code>ChartWSServices.AddSaveChartWS</code> which delegates to <code>GeneralLedgerChartServices.AddGLChart</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Chart</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>acctNumberId</em></td>\n<td>Required Guid. <code>Id</code> of the <code>GeneralLedger.Account</code> this chart belongs to.</td>\n</tr>\n<tr>\n<td><em>branchAcctId</em></td>\n<td>Optional Guid. <code>Id</code> of the <code>Setup.Branch</code> dimension. Null = no branch scoping.</td>\n</tr>\n<tr>\n<td><em>classAcctId</em></td>\n<td>Optional Guid. <code>Id</code> of the <code>Common.Class</code> dimension. Null = no class scoping.</td>\n</tr>\n<tr>\n<td><em>portfolioAcctId</em></td>\n<td>Optional Guid. <code>Id</code> of the <code>Servicing.Portfolio</code> dimension. Null = no portfolio scoping.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Null is stored as empty string.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Null is stored as empty string.</td>\n</tr>\n<tr>\n<td><em>isConfirmed</em></td>\n<td>Required bool. Whether the chart combination has been confirmed by the operator.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid assigned to the new chart row.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>branchAcctNumberOrId</code></td>\n<td><code>branchAcctId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>classAcctNumberOrId</code></td>\n<td><code>classAcctId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>portfolioAcctNumberOrId</code></td>\n<td><code>portfolioAcctId</code></td>\n<td>String. portfolio number or portfolio GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>acctNumberOrId</code></td>\n<td><code>acctNumberId</code></td>\n<td>String. general-ledger account number or GL account GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"branchAcctNumberOrId\": \"90\",\n  \"classAcctNumberOrId\": \"1\",\n  \"portfolioAcctNumberOrId\": \"1\",\n  \"acctNumberOrId\": \"1000\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Chart"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7d524703-fd5a-4bb0-81e4-026a28962af5","name":"AddChart - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"acctNumberId\": \"00000000-0000-0000-0000-000000000000\",\n  \"branchAcctId\": null,\n  \"classAcctId\": null,\n  \"portfolioAcctId\": null,\n  \"description\": \"Operating cash - Main branch\",\n  \"notes\": \"\",\n  \"isConfirmed\": true,\n  \"branchAcctNumberOrId\": null,\n  \"classAcctNumberOrId\": null,\n  \"portfolioAcctNumberOrId\": null,\n  \"acctNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error processing chart: The INSERT statement conflicted with the FOREIGN KEY constraint. The conflict occurred in column 'AcctNumberId'.\"\n    ],\n    \"warnings\": []\n}"},{"id":"a6b2cf32-73cb-45b5-9b13-4eb876eca0ea","name":"AddChart - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"acctNumberId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"branchAcctId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"classAcctId\": null,\n  \"portfolioAcctId\": null,\n  \"description\": \"Operating cash - Main branch\",\n  \"notes\": \"\",\n  \"isConfirmed\": true,\n  \"branchAcctNumberOrId\": null,\n  \"classAcctNumberOrId\": null,\n  \"portfolioAcctNumberOrId\": null,\n  \"acctNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"a56860c9-d4b9-4336-a5cd-0967a822167e"},{"name":"ChartByChartNumberGet","id":"6ba9b743-543a-422b-b6be-73a31a2935d1","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart/ByChartNumber/{{chart_account_number}}?token={{token}}","description":"<h3 id=\"get-gl-chart-by-chart-account-number\">Get GL Chart by Chart Account Number</h3>\n<p>Returns a single <code>GeneralLedger.Chart</code> row by its composite chart account number string. The service layer calls <code>GeneralLedgerChartServices.ReturnChartId(databaseName, clientId, chartAccountNumber)</code> to resolve the id, then reads the entity via <code>ReturnGLChart</code>. Unlike <code>/Chart/{id}</code> this route does not accept a Guid — it is specifically for the human-readable chart account number display format (for example <code>10500-01-00-00</code>).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Chart/ByChartNumber/{chartAccountNumber}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>chartAccountNumber</em></td>\n<td>Required string (route). The composite chart account number string (account-branch-class-portfolio). Returns <code>BadRequest</code> \"Chart not found\" when no row matches for this client.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>GeneralLedger.Chart</code> entity (no prefetch).</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Chart","ByChartNumber","{{chart_account_number}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fe5fecfe-bd27-49ff-b1d5-db03950b8888","name":"GetChartByChartNumber - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/ByChartNumber/99999-99-99-99?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","ByChartNumber","99999-99-99-99"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Chart not found\"\n    ]\n}"},{"id":"34c0d7ca-7256-442c-8b1a-6d94fa2a23b0","name":"GetChartByChartNumber - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/ByChartNumber/{{chart_account_number}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","ByChartNumber","{{chart_account_number}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000001\",\n        \"BranchAcctId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"ClassAcctId\": null,\n        \"PortfolioAcctId\": null,\n        \"AcctNumberId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Description\": \"Operating cash - Main branch\",\n        \"Notes\": \"\",\n        \"IsConfirmed\": true,\n        \"CreationDate\": \"2026-04-01T08:15:00\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"6ba9b743-543a-422b-b6be-73a31a2935d1"},{"name":"ChartDelete","id":"7ac0863c-e0d2-4775-923d-0f98f6c456ab","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart/{{chart_id}}?token={{token}}","description":"<h3 id=\"delete-gl-chart\">Delete GL Chart</h3>\n<p>Deletes a General Ledger chart row. The controller resolves <code>{id}</code> through <code>SharedWSServices.GetGeneralLedgerChartId</code>, so the route parameter accepts either the Guid <code>Id</code> or the chart account number string. Internally calls <code>ChartWSServices.DeleteChartWS</code> → <code>GeneralLedgerChartServices.DeleteGLChart</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Chart/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the chart account number string. Returns <code>BadRequest</code> (<code>INVALID_PARAMETER_ERROR_MESSAGE</code>) when blank, and \"Chart not found\" when the value cannot be resolved.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers. DELETE callers cannot send a body, so the token must travel via query string or headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id, Deleted = true }</code> on success.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Chart","{{chart_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"667fdc0b-26c6-4ed4-a9ea-7b45063ed802","name":"DeleteChart - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Chart not found\"\n    ]\n}"},{"id":"1b895698-23b5-4dc0-8854-1549ddd790a5","name":"DeleteChart - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/{{chart_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","{{chart_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Deleted\": true\n    },\n    \"errors\": []\n}"}],"_postman_id":"7ac0863c-e0d2-4775-923d-0f98f6c456ab"},{"name":"ChartGet","id":"ae3f4c78-c7cf-4531-8332-8af531b95c18","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart/{{chart_id}}?token={{token}}&fetchAccount=false&fetchBranch=false&fetchClass=false&fetchPortfolio=false","description":"<h3 id=\"get-gl-chart-by-id\">Get GL Chart by Id</h3>\n<p>Returns a single General Ledger chart row. The route parameter <code>{id}</code> accepts either the Guid <code>Id</code> or the chart account number string, resolved by <code>SharedWSServices.GetGeneralLedgerChartId</code>. Optional query flags control related-entity prefetch paths loaded by <code>ChartWSServices.GetChartWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Chart/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string (route). Guid <code>Id</code> or chart account number string. Returns \"Chart not found\" when it cannot be resolved.</td>\n</tr>\n<tr>\n<td><em>fetchAccount</em></td>\n<td>Optional bool (query). Defaults to <code>false</code>. When <code>true</code> the response prefetches the linked <code>GeneralLedger.Account</code>.</td>\n</tr>\n<tr>\n<td><em>fetchBranch</em></td>\n<td>Optional bool (query). Defaults to <code>false</code>. When <code>true</code> the response prefetches the linked <code>Setup.Branch</code>.</td>\n</tr>\n<tr>\n<td><em>fetchClass</em></td>\n<td>Optional bool (query). Defaults to <code>false</code>. When <code>true</code> the response prefetches the linked <code>Common.Class</code>.</td>\n</tr>\n<tr>\n<td><em>fetchPortfolio</em></td>\n<td>Optional bool (query). Defaults to <code>false</code>. When <code>true</code> the response prefetches the linked <code>Servicing.Portfolio</code>.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>GeneralLedger.Chart</code> entity (with the requested prefetched relations populated), including <code>Id</code>, <code>OmegaClientId</code>, <code>BranchAcctId</code>, <code>ClassAcctId</code>, <code>PortfolioAcctId</code>, <code>AcctNumberId</code>, <code>Description</code>, <code>Notes</code>, <code>IsConfirmed</code>, <code>CreationDate</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Chart","{{chart_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchAccount","value":"false"},{"key":"fetchBranch","value":"false"},{"key":"fetchClass","value":"false"},{"key":"fetchPortfolio","value":"false"}],"variable":[]}},"response":[{"id":"713eed57-3ee0-40b8-b44a-f10d652fdb97","name":"GetChart - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/00000000-0000-0000-0000-000000000000?token={{token}}&fetchAccount=false&fetchBranch=false&fetchClass=false&fetchPortfolio=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchAccount","value":"false"},{"key":"fetchBranch","value":"false"},{"key":"fetchClass","value":"false"},{"key":"fetchPortfolio","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Chart not found\"\n    ]\n}"},{"id":"80a964b5-8e55-4f7d-a1ba-8b584a7a66e7","name":"GetChart - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/{{chart_id}}?token={{token}}&fetchAccount=true&fetchBranch=false&fetchClass=false&fetchPortfolio=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","{{chart_id}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchAccount","value":"true"},{"key":"fetchBranch","value":"false"},{"key":"fetchClass","value":"false"},{"key":"fetchPortfolio","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000001\",\n        \"BranchAcctId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"ClassAcctId\": null,\n        \"PortfolioAcctId\": null,\n        \"AcctNumberId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Description\": \"Operating cash - Main branch\",\n        \"Notes\": \"\",\n        \"IsConfirmed\": true,\n        \"CreationDate\": \"2026-04-01T08:15:00\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"ae3f4c78-c7cf-4531-8332-8af531b95c18"},{"name":"ChartsByAccountGet","id":"72bb75be-a435-4193-8fcd-4ac0bbc117fb","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart/ByAccount/{{gl_account_number_or_id}}?token={{token}}","description":"<h3 id=\"get-gl-charts-by-account\">Get GL Charts by Account</h3>\n<p>Returns all <code>GeneralLedger.Chart</code> rows that roll up to the given GL account. The route parameter <code>{accountId}</code> accepts either the Guid <code>Id</code> or the client-scoped GL account <code>Number</code>, resolved by <code>SharedWSServices.GetGeneralLedgerAccountId</code>. Internally calls <code>ChartWSServices.GetChartsByAccountWS</code> → <code>GeneralLedgerChartServices.ReturnGLChartsWithAccountId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Chart/ByAccount/{accountId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> of a <code>GeneralLedger.Account</code> or the client-scoped account <code>Number</code>. Returns <code>BadRequest</code> \"GL account not found\" when it cannot be resolved.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>GeneralLedger.Chart</code> entities (no prefetch) ordered by the service-layer default.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Chart","ByAccount","{{gl_account_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"985aa8b6-a441-4b87-9257-67ef8f6040f4","name":"GetChartsByAccount - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/ByAccount/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","ByAccount","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"GL account not found\"\n    ]\n}"},{"id":"3ee725e6-2c3f-4693-83ce-008427db4c69","name":"GetChartsByAccount - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/Chart/ByAccount/{{gl_account_number_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","Chart","ByAccount","{{gl_account_number_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"OmegaClientId\": \"00000000-0000-0000-0000-000000000001\",\n            \"BranchAcctId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"ClassAcctId\": null,\n            \"PortfolioAcctId\": null,\n            \"AcctNumberId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"Description\": \"Operating cash - Main branch\",\n            \"Notes\": \"\",\n            \"IsConfirmed\": true,\n            \"CreationDate\": \"2026-04-01T08:15:00\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ],\n    \"errors\": []\n}"}],"_postman_id":"72bb75be-a435-4193-8fcd-4ac0bbc117fb"},{"name":"ChartUpdate","id":"7b9a6595-867c-4364-b57c-30f35ba72ef1","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"acctNumberId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"branchAcctId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"classAcctId\": null,\n  \"portfolioAcctId\": null,\n  \"description\": \"Operating cash - Main branch (updated)\",\n  \"notes\": \"Re-confirmed by controller\",\n  \"isConfirmed\": true,\n  \"branchAcctNumberOrId\": null,\n  \"classAcctNumberOrId\": null,\n  \"portfolioAcctNumberOrId\": null,\n  \"acctNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart/{{chart_id}}","description":"<h3 id=\"update-gl-chart\">Update GL Chart</h3>\n<p>Updates an existing General Ledger chart row. The route parameter <code>{id}</code> accepts either the Guid <code>Id</code> or the chart account number string; the controller resolves it via <code>SharedWSServices.GetGeneralLedgerChartId</code>, re-reads the row to capture the current <code>Ts</code>, and then calls <code>ChartWSServices.AddSaveChartWS</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Chart/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the chart account number string (<code>GeneralLedgerChartServices.ReturnChartId</code> is used for the number-based lookup). Returns <code>BadRequest</code> \"Chart not found\" when it cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>acctNumberId</em></td>\n<td>Required Guid. <code>Id</code> of the <code>GeneralLedger.Account</code> this chart belongs to.</td>\n</tr>\n<tr>\n<td><em>branchAcctId</em></td>\n<td>Optional Guid. <code>Id</code> of the <code>Setup.Branch</code> dimension.</td>\n</tr>\n<tr>\n<td><em>classAcctId</em></td>\n<td>Optional Guid. <code>Id</code> of the <code>Common.Class</code> dimension.</td>\n</tr>\n<tr>\n<td><em>portfolioAcctId</em></td>\n<td>Optional Guid. <code>Id</code> of the <code>Servicing.Portfolio</code> dimension.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. Null is stored as empty string.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Null is stored as empty string.</td>\n</tr>\n<tr>\n<td><em>isConfirmed</em></td>\n<td>Required bool. Whether the chart combination has been confirmed by the operator.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated chart row.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>branchAcctNumberOrId</code></td>\n<td><code>branchAcctId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>classAcctNumberOrId</code></td>\n<td><code>classAcctId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>portfolioAcctNumberOrId</code></td>\n<td><code>portfolioAcctId</code></td>\n<td>String. portfolio number or portfolio GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>acctNumberOrId</code></td>\n<td><code>acctNumberId</code></td>\n<td>String. general-ledger account number or GL account GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"branchAcctNumberOrId\": \"90\",\n  \"classAcctNumberOrId\": \"1\",\n  \"portfolioAcctNumberOrId\": \"1\",\n  \"acctNumberOrId\": \"1000\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Chart","{{chart_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"89d9673a-4a85-45a4-a379-2fc52f415e37","name":"UpdateChart - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"acctNumberId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"branchAcctId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"classAcctId\": null,\n  \"portfolioAcctId\": null,\n  \"description\": \"Operating cash - Main branch (updated)\",\n  \"notes\": \"Re-confirmed by controller\",\n  \"isConfirmed\": true,\n  \"branchAcctNumberOrId\": null,\n  \"classAcctNumberOrId\": null,\n  \"portfolioAcctNumberOrId\": null,\n  \"acctNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Chart not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"c8de4597-b012-4083-940f-ddbaf489120a","name":"UpdateChart - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"acctNumberId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"branchAcctId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"classAcctId\": null,\n  \"portfolioAcctId\": null,\n  \"description\": \"Operating cash - Main branch (updated)\",\n  \"notes\": \"Re-confirmed by controller\",\n  \"isConfirmed\": true,\n  \"branchAcctNumberOrId\": null,\n  \"classAcctNumberOrId\": null,\n  \"portfolioAcctNumberOrId\": null,\n  \"acctNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Chart/{{chart_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"7b9a6595-867c-4364-b57c-30f35ba72ef1"},{"name":"DailyTransactionSummaryGet","id":"e6c3f2b4-44ce-48c5-abe7-05d31919b404","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/DailyTransactionSummary/{{daily_transaction_summary_id}}?token={{token}}","description":"<h3 id=\"get-gl-daily-transaction-summary-by-id\">Get GL Daily Transaction Summary by Id</h3>\n<p>Returns a single <code>GeneralLedger.DailyTransactionSummary</code> row by its Guid <code>Id</code>. Used to inspect one day/chart/journal-type balance snapshot captured by GL posting. Calls <code>DailyTransactionSummaryWSServices.GetDailyTransactionSummaryWS</code> which invokes <code>GeneralLedgerDailyTransactionSummaryServices.ReturnGLDailyTransactionSummary(databaseName, id)</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/DailyTransactionSummary/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string (route). Guid <code>Id</code> of the daily transaction summary row. Must parse as a Guid — non-Guid values return <code>Invalid daily transaction summary ID format</code>. Missing rows return <code>Daily transaction summary not found</code>.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>GeneralLedger.DailyTransactionSummary</code> entity, including <code>Id</code>, <code>OmegaClientId</code>, <code>ChartId</code>, <code>SummaryDate</code>, <code>Balance</code>, <code>JournalType</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","DailyTransactionSummary","{{daily_transaction_summary_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7c2b50c6-d6c2-44b3-bc53-5cc98ec0afe7","name":"GetDailyTransactionSummary - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/DailyTransactionSummary/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","DailyTransactionSummary","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Daily transaction summary not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"b2749eb8-c1b8-4037-8fa5-d29952ed6a98","name":"GetDailyTransactionSummary - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/DailyTransactionSummary/{{daily_transaction_summary_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","DailyTransactionSummary","{{daily_transaction_summary_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"d1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000001\",\n        \"ChartId\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"SummaryDate\": \"2026-03-31T00:00:00\",\n        \"Balance\": 12500.75,\n        \"JournalType\": 1,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"e6c3f2b4-44ce-48c5-abe7-05d31919b404"},{"name":"ExternalMasterConfiguration","id":"3626871d-2c7b-4316-b5d9-926f696388cc","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"usePortfolioSubAccount\": false,\n    \"yearendPeriod\": 12,\n    \"retainedEarningsAccountNumberOrId\": \"3900\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration","description":"<h3 id=\"add-gl-external-master-configuration\">Add GL External Master Configuration</h3>\n<p>Creates the single General Ledger master configuration row for the current client. Fails with <code>GL master configuration already exists. Use PUT to update it.</code> if a row already exists — the PUT route is used for subsequent edits. The controller resolves <code>retainedEarningsAccountNumberOrId</code> via <code>SharedWSServices.GetGeneralLedgerAccountId</code> (accepts either the GL account Guid <code>Id</code> or numeric account number) and forces <code>allowFutureDatedTransactions = false</code> on insert. Internally calls <code>ExternalMasterConfigurationWSServices.SaveExternalMasterConfigurationWS</code> which delegates to <code>GeneralLedgerExternalMasterConfigurationServices.AddExternalMasterConfiguration</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>usePortfolioSubAccount</em></td>\n<td>Required bool. When <code>true</code> GL postings split by portfolio sub-account.</td>\n</tr>\n<tr>\n<td><em>yearendPeriod</em></td>\n<td>Required int (1-12). Month number that ends the fiscal year. <code>12</code> = calendar year, <code>6</code> = fiscal year ending in June, etc. Validated server-side — out-of-range values return <code>Yearend period must be between 1 and 12</code>.</td>\n</tr>\n<tr>\n<td><em>retainedEarningsAccountNumberOrId</em></td>\n<td>Required string. Guid <code>Id</code> or numeric account number of the GL account that receives retained earnings. Invalid or unresolvable values return <code>Invalid retained earnings account</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid assigned to the new configuration row.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e15905ca-612e-42ad-85cf-bfdf1ce04386","name":"AddExternalMasterConfiguration - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"usePortfolioSubAccount\": false,\n    \"yearendPeriod\": 12,\n    \"retainedEarningsAccountNumberOrId\": \"999999\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid retained earnings account\"\n    ],\n    \"warnings\": []\n}"},{"id":"97a2964c-77ae-4c53-8b94-c0e5ac7afbd3","name":"AddExternalMasterConfiguration - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"usePortfolioSubAccount\": false,\n    \"yearendPeriod\": 12,\n    \"retainedEarningsAccountNumberOrId\": \"3900\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"3626871d-2c7b-4316-b5d9-926f696388cc"},{"name":"ExternalMasterConfiguration","id":"563886bc-7682-4e3d-b1ac-979ff33eee81","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"usePortfolioSubAccount\": true,\n    \"yearendPeriod\": 12,\n    \"retainedEarningsAccountNumberOrId\": \"3900\",\n    \"allowFutureDatedTransactions\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration","description":"<h3 id=\"update-gl-external-master-configuration\">Update GL External Master Configuration</h3>\n<p>Updates the existing General Ledger master configuration for the current client. Fails with <code>GL master configuration not found</code> if POST has not been called first to create the row. The controller resolves <code>retainedEarningsAccountNumberOrId</code> via <code>SharedWSServices.GetGeneralLedgerAccountId</code> (Guid <code>Id</code> or numeric account number). <code>id</code> and <code>ts</code> are looked up from the existing row — the caller does not pass them on the body. Internally calls <code>ExternalMasterConfigurationWSServices.SaveExternalMasterConfigurationWS</code> which delegates to <code>GeneralLedgerExternalMasterConfigurationServices.SaveChangesToExternalMasterConfiguration</code>. That business method blocks changes to <code>yearendPeriod</code> and <code>retainedEarningsAccountId</code> once GL activity exists for the current fiscal year (checked via <code>HasGLDailyTransactionSummary</code>).</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>usePortfolioSubAccount</em></td>\n<td>Required bool. When <code>true</code> GL postings split by portfolio sub-account.</td>\n</tr>\n<tr>\n<td><em>yearendPeriod</em></td>\n<td>Required int (1-12). Month that ends the fiscal year. Out-of-range values return <code>Yearend period must be between 1 and 12</code>. May be locked by the BLL once GL activity exists for the current fiscal year.</td>\n</tr>\n<tr>\n<td><em>retainedEarningsAccountNumberOrId</em></td>\n<td>Required string. Guid <code>Id</code> or numeric account number of the retained earnings GL account. Unresolvable values return <code>Invalid retained earnings account</code>. May be locked by the BLL once GL activity exists for the current fiscal year.</td>\n</tr>\n<tr>\n<td><em>allowFutureDatedTransactions</em></td>\n<td>Required bool. When <code>true</code> manual GL transactions may be posted with a posting date later than the current business date. The POST route always sets this to <code>false</code> — use PUT to flip it on.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated configuration row.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c94b73f6-dea8-4ca2-a333-085acac1e082","name":"UpdateExternalMasterConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"usePortfolioSubAccount\": true,\n    \"yearendPeriod\": 12,\n    \"retainedEarningsAccountNumberOrId\": \"999999\",\n    \"allowFutureDatedTransactions\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid retained earnings account\"\n    ],\n    \"warnings\": []\n}"},{"id":"04234e0f-4dc6-4c8d-9ab2-60302c47bfdc","name":"UpdateExternalMasterConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"usePortfolioSubAccount\": true,\n    \"yearendPeriod\": 12,\n    \"retainedEarningsAccountNumberOrId\": \"3900\",\n    \"allowFutureDatedTransactions\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"563886bc-7682-4e3d-b1ac-979ff33eee81"},{"name":"ExternalMasterConfiguration","id":"91c4412f-3762-403d-bb0d-21811e4a7e56","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration?token={{token}}","description":"<h3 id=\"get-gl-external-master-configuration\">Get GL External Master Configuration</h3>\n<p>Returns the General Ledger master configuration row for the current client. One row per client. Calls <code>ExternalMasterConfigurationWSServices.GetExternalMasterConfigurationWS</code> which invokes <code>GeneralLedgerExternalMasterConfigurationServices.ReturnExternalMasterConfiguration(databaseName, clientId)</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>GeneralLedger.ExternalMasterConfiguration</code> entity, including <code>Id</code>, <code>OmegaClientId</code>, <code>UsePortfolioSubAccount</code>, <code>YearendPeriod</code>, <code>RetainedEarningsAccountId</code>, <code>AllowFutureDatedTransactions</code>, and <code>Ts</code>. Returns <code>GL Master configuration not found</code> when the client has not yet been configured — call the POST route to initialize it.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","ExternalMasterConfiguration"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"889be93f-a133-4179-b7d1-127783fd2d24","name":"GetExternalMasterConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","ExternalMasterConfiguration"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"GL Master configuration not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"64258e39-f412-4db9-b648-eec1db6e8c44","name":"GetExternalMasterConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/ExternalMasterConfiguration?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","ExternalMasterConfiguration"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000001\",\n        \"UsePortfolioSubAccount\": false,\n        \"YearendPeriod\": 12,\n        \"RetainedEarningsAccountId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"AllowFutureDatedTransactions\": false,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": []\n}"}],"_postman_id":"91c4412f-3762-403d-bb0d-21811e4a7e56"},{"name":"GLAccountAdd","id":"ef87bf39-2c94-427d-a69a-2fe3716003ea","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"active\": true,\n    \"accountNumber\": 10500,\n    \"description\": \"Cash - Operating\",\n    \"reportGroupNumberOrId\": \"1\",\n    \"notes\": \"Primary operating cash account\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Account","description":"<h3 id=\"add-gl-account\">Add GL Account</h3>\n<p>Creates a new General Ledger account. Internally the controller resolves <code>reportGroupNumberOrId</code> to a Guid via <code>SharedWSServices.GetGeneralLedgerReportGroupId</code>, maps to an <code>AddSaveGLAccountParameter</code> with <code>id = null</code> and <code>ts = null</code>, and calls <code>GeneralLedgerAccountWSServices.AddSaveGLAccountWS</code>. Use <code>PUT /api/Client/GeneralLedger/Account/{numberOrId}</code> to update an existing account — this route always inserts.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Account</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Active flag stored on the GL account.</td>\n</tr>\n<tr>\n<td><em>accountNumber</em></td>\n<td>Required int, 1–999999. Client-scoped GL account number. Values outside this range return \"Account number must be between 1 and 999999\".</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 50 characters. Empty or whitespace returns \"Description is required\"; longer than 50 returns \"Description cannot exceed 50 characters\".</td>\n</tr>\n<tr>\n<td><em>reportGroupNumberOrId</em></td>\n<td>Required. Either the Guid <code>Id</code> of a <code>GeneralLedger.ReportGroup</code> or the client-scoped report group <code>Number</code>. Resolved by <code>SharedWSServices.GetGeneralLedgerReportGroupId</code>; when it cannot be resolved the controller returns <code>BadRequest</code> with \"Report group not found\".</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form notes. Null is stored as empty string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid assigned to the new GL account.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Account"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9b4a7b20-ace4-4359-a63f-e02f329cd919","name":"AddGLAccount - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"active\": true,\n    \"accountNumber\": 10500,\n    \"description\": \"Cash - Operating\",\n    \"reportGroupNumberOrId\": \"999999\",\n    \"notes\": \"Primary operating cash account\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Report group not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"70278e43-64d4-488f-b4e8-104ab6295caa","name":"AddGLAccount - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"active\": true,\n    \"accountNumber\": 10500,\n    \"description\": \"Cash - Operating\",\n    \"reportGroupNumberOrId\": \"1\",\n    \"notes\": \"Primary operating cash account\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"ef87bf39-2c94-427d-a69a-2fe3716003ea"},{"name":"GLAccountUpdate","id":"29bc1bd6-b015-4f4e-a1de-ce608103cca0","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"active\": true,\n    \"accountNumber\": 10500,\n    \"description\": \"Cash - Operating Account\",\n    \"reportGroupNumberOrId\": \"1\",\n    \"notes\": \"Updated description\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Account/{{gl_account_number_or_id}}","description":"<h3 id=\"update-gl-account\">Update GL Account</h3>\n<p>Updates an existing General Ledger account. The route parameter <code>{numberOrId}</code> accepts either the Guid <code>Id</code> or the client-scoped account <code>Number</code>; the controller resolves it via <code>SharedWSServices.GetGeneralLedgerAccountId</code>, re-reads the row to capture the current <code>Ts</code>, and then calls <code>GeneralLedgerAccountWSServices.AddSaveGLAccountWS</code> with that concurrency token. The request body's <code>accountNumber</code> replaces the stored value — but changing it is blocked when any <code>GeneralLedger.Chart</code> rows already reference the account (\"Account number cannot be changed after chart activity exists for this account\").</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/Account/{numberOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped GL account <code>Number</code>. <code>BadRequest</code> with \"GL account not found\" when the value cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Active flag stored on the GL account.</td>\n</tr>\n<tr>\n<td><em>accountNumber</em></td>\n<td>Required int, 1–999999. Must remain unchanged when chart activity exists for this account.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 50 characters.</td>\n</tr>\n<tr>\n<td><em>reportGroupNumberOrId</em></td>\n<td>Required. Either the Guid <code>Id</code> of a <code>GeneralLedger.ReportGroup</code> or the client-scoped report group <code>Number</code>. <code>BadRequest</code> \"Report group not found\" when it cannot be resolved.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Null is stored as empty string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated GL account.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","Account","{{gl_account_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"871d7e62-cfbd-4746-a85c-6d2d6168e5c2","name":"UpdateGLAccount - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"active\": true,\n    \"accountNumber\": 10500,\n    \"description\": \"Cash - Operating Account\",\n    \"reportGroupNumberOrId\": \"1\",\n    \"notes\": \"Updated description\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Account/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"GL account not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"27f44461-d5e2-4698-9807-b9fec1a7bbff","name":"UpdateGLAccount - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"active\": true,\n    \"accountNumber\": 10500,\n    \"description\": \"Cash - Operating Account\",\n    \"reportGroupNumberOrId\": \"1\",\n    \"notes\": \"Updated description\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/Account/{{gl_account_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"29bc1bd6-b015-4f4e-a1de-ce608103cca0"},{"name":"GlBatchImport","id":"ca64920b-752d-40ff-a121-ac115053ef6f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-04-18\",\n    \"notes\": \"Monthly payroll import\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5100-100\",\n            \"amount\": 12000.00,\n            \"description\": \"Salaries expense\"\n        },\n        {\n            \"glAccountNumberOrId\": \"1100\",\n            \"branchNumberOrId\": \"100\",\n            \"classNumberOrId\": null,\n            \"portfolioNumberOrId\": null,\n            \"amount\": -12000.00,\n            \"description\": \"Operating cash offset\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ImportBatch","description":"<h3 id=\"import-gl-batch\">Import GL Batch</h3>\n<p>Posts a balanced GL import batch as a single <code>Import_Entry</code> journal-type transaction. Unlike the Manual Transaction endpoint, import batch lines accept either a chart identifier (preferred) or a raw GL account plus optional branch/class/portfolio dimensions; when <code>chartAccountNumberOrId</code> is omitted, the WS service resolves or creates the matching chart row on the fly from <code>glAccountNumberOrId</code> and the dimension identifiers. Internally calls <code>GeneralLedgerImportWSServices.ImportGlBatchWS</code>, which enforces the <code>ImportBatchScreenId</code> permission set (<code>B0B712E8-0408-46AE-9227-C17D51395BEC</code>) and the standard GL posting-date rules.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/ImportBatch</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>postingDate</em></td>\n<td>Required date. Must be ≤ the current business date, and must satisfy GL posting-date permissions.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Stored on the transaction header.</td>\n</tr>\n<tr>\n<td><em>lineItems</em></td>\n<td>Required array. Min 1 line.</td>\n</tr>\n<tr>\n<td><em>lineItems[].glAccountNumberOrId</em></td>\n<td>Optional. GL account number or Guid; resolved via <code>SharedWSServices.GetGeneralLedgerAccountId</code>. Must reference an <code>Active</code> GL account. Use when there is no existing chart row.</td>\n</tr>\n<tr>\n<td><em>lineItems[].chartAccountNumberOrId</em></td>\n<td>Optional. GL chart number or Guid; resolved via <code>SharedWSServices.GetGeneralLedgerChartId</code>. Each line must supply exactly one of <code>glAccountNumberOrId</code> OR <code>chartAccountNumberOrId</code>.</td>\n</tr>\n<tr>\n<td><em>lineItems[].branchNumberOrId</em></td>\n<td>Optional. Branch number or Guid; resolved via <code>SharedWSServices.GetSetupBranchId</code>. Used only when no chart is supplied.</td>\n</tr>\n<tr>\n<td><em>lineItems[].classNumberOrId</em></td>\n<td>Optional. Class number or Guid; resolved via <code>SharedWSServices.GetCommonClassId</code>.</td>\n</tr>\n<tr>\n<td><em>lineItems[].portfolioNumberOrId</em></td>\n<td>Optional. Portfolio number or Guid; resolved via <code>SharedWSServices.GetServicingPortfolioId</code>.</td>\n</tr>\n<tr>\n<td><em>lineItems[].amount</em></td>\n<td>Required decimal. Positive = debit, negative = credit. The sum across all lines must equal 0 (\"Import must balance out to 0.\").</td>\n</tr>\n<tr>\n<td><em>lineItems[].description</em></td>\n<td>Optional string. Per-line memo.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ TransactionId, ReferenceId, ReferenceNumber }</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","ImportBatch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"df67c1d9-d365-49f3-a36f-4705a421adbe","name":"ImportGlBatch - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-04-18\",\n    \"notes\": \"Monthly payroll import\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5100-100\",\n            \"amount\": 12000.00,\n            \"description\": \"Salaries expense\"\n        },\n        {\n            \"glAccountNumberOrId\": \"1100\",\n            \"branchNumberOrId\": \"100\",\n            \"classNumberOrId\": null,\n            \"portfolioNumberOrId\": null,\n            \"amount\": -12000.00,\n            \"description\": \"Operating cash offset\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ImportBatch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"TransactionId\": \"t4444444-1111-4222-9333-abcdef012345\",\n        \"ReferenceId\": \"r4444444-1111-4222-9333-abcdef012345\",\n        \"ReferenceNumber\": 5001\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"7619864c-0bc7-4106-b828-0d8627bc964a","name":"ImportGlBatch - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-04-18\",\n    \"notes\": \"Monthly payroll import\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5100-100\",\n            \"amount\": 12000.00,\n            \"description\": \"Salaries expense\"\n        },\n        {\n            \"glAccountNumberOrId\": \"1100\",\n            \"branchNumberOrId\": \"100\",\n            \"classNumberOrId\": null,\n            \"portfolioNumberOrId\": null,\n            \"amount\": -9000.00,\n            \"description\": \"Operating cash offset\"\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ImportBatch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Import must balance out to 0.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"ca64920b-752d-40ff-a121-ac115053ef6f"},{"name":"ManualTransactionAdd","id":"cb98bd56-344d-40eb-b356-9605a4dbcfc6","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-04-18\",\n    \"notes\": \"April rent payment\",\n    \"allowFutureDated\": false,\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2500.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"1100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 2500.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ManualTransaction","description":"<h3 id=\"add-manual-gl-transaction\">Add Manual GL Transaction</h3>\n<p>Posts a balanced manual GL transaction with an arbitrary list of chart lines. Internally calls <code>GeneralLedgerTransactionWSServices.AddManualTransactionWS</code>, which enforces the <code>ManualTransactionEntryScreenId</code> permission set (<code>636D7722-9C7A-4CAC-8EAA-F40D88B32E52</code>) and the standard GL posting-date rules.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/ManualTransaction</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>postingDate</em></td>\n<td>Required date. Must satisfy the posting-date permissions (<code>PostOutsideCurrentFiscalYear</code>, <code>PostOutsideCurrentPeriod</code>, <code>PostWithinCurrentPeriod</code>) for the current business date.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Stored on the transaction header. Null is treated as empty.</td>\n</tr>\n<tr>\n<td><em>allowFutureDated</em></td>\n<td>Required bool. Must be <code>true</code> together with <code>GeneralLedger.ExternalMasterConfiguration.AllowFutureDatedTransactions</code> for the API to accept a future <code>postingDate</code>.</td>\n</tr>\n<tr>\n<td><em>lineItems</em></td>\n<td>Required array. Each line must supply a chart identifier and exactly one non-zero side (debit XOR credit).</td>\n</tr>\n<tr>\n<td><em>lineItems[].chartAccountNumberOrId</em></td>\n<td>Required. GL chart number or Guid; resolved via <code>SharedWSServices.GetGeneralLedgerChartId</code>.</td>\n</tr>\n<tr>\n<td><em>lineItems[].debitAmount</em></td>\n<td>Required decimal ≥ 0.</td>\n</tr>\n<tr>\n<td><em>lineItems[].creditAmount</em></td>\n<td>Required decimal ≥ 0.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Aggregate rule: total debit amount must equal total credit amount.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ TransactionId, ReferenceId }</code> — the new GL transaction Guid and its reference row Guid.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","ManualTransaction"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e5167fe4-3084-46c5-bbda-f11bf6a605c6","name":"AddManualTransaction - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-04-18\",\n    \"notes\": \"April rent payment\",\n    \"allowFutureDated\": false,\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2500.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"1100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 2500.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ManualTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"TransactionId\": \"t2222222-1111-4222-9333-abcdef012345\",\n        \"ReferenceId\": \"r2222222-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"1052c7cc-5682-4ee2-841b-01fec988ca10","name":"AddManualTransaction - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-04-18\",\n    \"notes\": \"April rent payment\",\n    \"allowFutureDated\": false,\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2500.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"1100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 1500.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ManualTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Debit and credit totals must be balanced\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"cb98bd56-344d-40eb-b356-9605a4dbcfc6"},{"name":"RecurringAsManualPost","id":"f1c6f392-408a-4901-ab51-389e4310bf17","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/{{recurring_transaction_number_or_id}}/PostNow","description":"<h3 id=\"post-recurring-transaction-as-manual-transaction\">Post Recurring Transaction as Manual Transaction</h3>\n<p>Immediately posts a recurring transaction template as a manual GL transaction, using the current business date and the recurring transaction's stored lines. Intended for on-demand frequencies and manual runs; scheduled frequencies are posted by the recurring-transaction day-end job. Internally calls <code>RecurringTransactionWSServices.PostRecurringAsManualWS</code> which requires <code>GeneralLedger.ExternalMasterConfiguration</code> to exist, enforces client ownership, re-applies the posting-date permission check against the configured current business date, and uses the <code>ManualTransactionEntryScreenId</code> permission set (<code>636D7722-9C7A-4CAC-8EAA-F40D88B32E52</code>).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/{numberOrId}/PostNow</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required. Recurring transaction number or Guid, resolved via <code>SharedWSServices.GetGeneralLedgerRecurringTransactionId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ TransactionId, ReferenceId }</code> — the new GL transaction Guid and its reference row Guid.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","RecurringTransaction","{{recurring_transaction_number_or_id}}","PostNow"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6af02aff-ac58-4244-9ed9-5790b2b92fb6","name":"PostRecurringAsManual - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/1001/PostNow"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"TransactionId\": \"t1111111-1111-4222-9333-abcdef012345\",\n        \"ReferenceId\": \"r1111111-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"49576314-f952-4aca-bc11-adcbc286a920","name":"PostRecurringAsManual - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/999999/PostNow"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Recurring transaction not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"f1c6f392-408a-4901-ab51-389e4310bf17"},{"name":"RecurringTransactionAdd","id":"38b15c99-af2d-41cc-96ce-f3f212136205","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 1001,\n    \"description\": \"Monthly rent accrual\",\n    \"frequency\": 2,\n    \"branchNumberOrId\": \"{{branch_number_or_id}}\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"{{gl_chart_account_number_or_id}}\",\n            \"debitAmount\": 2500.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"{{gl_chart_account_number_or_id_2}}\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 2500.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction","description":"<h3 id=\"add-recurring-transaction\">Add Recurring Transaction</h3>\n<p>Creates a new GL recurring transaction template with at least two balanced debit/credit lines. The controller always calls <code>AddSaveRecurringTransactionWS</code> with <code>existingId = null</code>, so this route always inserts; use <code>PUT /api/Client/GeneralLedger/RecurringTransaction/{numberOrId}</code> to update.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>number</em></td>\n<td>Required int &gt; 0. Client-scoped recurring transaction number; must be unique.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 55 characters.</td>\n</tr>\n<tr>\n<td><em>frequency</em></td>\n<td>Required int enum (<code>Omega.GeneralLedger.Types.Enums.GeneralLedgerRecurringTransactionFrequency</code>): <code>1=On_Demand</code>, <code>2=First_Day_of_the_Month</code>, <code>3=Last_Day_of_the_Month</code>, <code>4=Daily</code>.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Required unless <code>frequency=1 (On_Demand)</code>. Branch number (e.g. <code>\"100\"</code>) or Guid resolved via <code>SharedWSServices.GetSetupBranchId</code>.</td>\n</tr>\n<tr>\n<td><em>lineItems</em></td>\n<td>Required array. Min 2, max 100 lines.</td>\n</tr>\n<tr>\n<td><em>lineItems[].chartAccountNumberOrId</em></td>\n<td>Required. GL chart number or Guid; resolved via <code>SharedWSServices.GetGeneralLedgerChartId</code>.</td>\n</tr>\n<tr>\n<td><em>lineItems[].debitAmount</em></td>\n<td>Required decimal ≥ 0.</td>\n</tr>\n<tr>\n<td><em>lineItems[].creditAmount</em></td>\n<td>Required decimal ≥ 0. Each line must be debit XOR credit (exactly one non-zero).</td>\n</tr>\n</tbody>\n</table>\n</div><p>Aggregate rule: total debit amount must equal total credit amount.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the new recurring transaction Guid.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","RecurringTransaction"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"55c9a486-7122-43d1-88d0-2404ffe3cd7f","name":"AddRecurringTransaction - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 1001,\n    \"description\": \"Monthly rent accrual\",\n    \"frequency\": 2,\n    \"branchNumberOrId\": \"100\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2500.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"2100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 2500.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"9d6665ca-00ee-4bb4-b95c-be123227a7fb","name":"AddRecurringTransaction - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 1001,\n    \"description\": \"Monthly rent accrual\",\n    \"frequency\": 2,\n    \"branchNumberOrId\": \"100\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2500.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"2100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 1000.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Debit and credit totals must be balanced\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"38b15c99-af2d-41cc-96ce-f3f212136205"},{"name":"RecurringTransactionByNumberGet","id":"915c5b32-ae0e-4e3f-845f-43d136b30a81","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"SessionId","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/ByNumber/{{recurring_transaction_number}}","description":"<h3 id=\"get-recurring-transaction-by-number\">Get Recurring Transaction by Number</h3>\n<p>Returns a single <code>GeneralLedger.RecurringTransaction</code> by its integer client-scoped <code>Number</code>. Always fetches line items and resolves chart metadata for each line. Internally calls <code>RecurringTransactionWSServices.GetRecurringTransactionByNumberWS</code> which first resolves the Id via <code>GeneralLedgerRecurringTransactionServices.ReturnRecurringTransactionId</code> and then loads the entity with <code>fetchDetail=true, fetchDetailChart=true</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/ByNumber/{transactionNumber}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>transactionNumber</em></td>\n<td>Required int. Client-scoped recurring transaction number. Returns <code>Recurring transaction not found</code> if no match exists for the current client.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>MyGeneralLedgerRecurringTransactionEntity</code> with its detail lines and chart metadata populated.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","RecurringTransaction","ByNumber","{{recurring_transaction_number}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"51dc6952-69dc-401a-a1ec-6cd9202f677a","name":"GetRecurringTransactionByNumber - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"SessionId","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/ByNumber/1001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Number\": 1001,\n        \"Description\": \"Monthly rent accrual\",\n        \"Frequency\": 2,\n        \"BranchId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Notes\": \"Auto-posts on the first of each month\",\n        \"GeneralLedgerRecurringTransactionDetails\": [\n            {\n                \"Id\": \"d1111111-1111-4222-9333-abcdef012345\",\n                \"GeneralLedgerChartId\": \"ch111111-1111-4222-9333-abcdef012345\",\n                \"DebitAmount\": 2500.00,\n                \"CreditAmount\": 0.00\n            },\n            {\n                \"Id\": \"d2222222-1111-4222-9333-abcdef012345\",\n                \"GeneralLedgerChartId\": \"ch222222-1111-4222-9333-abcdef012345\",\n                \"DebitAmount\": 0.00,\n                \"CreditAmount\": 2500.00\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"0dca7d11-74a9-4494-bca5-e34fe4f9e0dd","name":"GetRecurringTransactionByNumber - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"SessionId","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/ByNumber/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Recurring transaction not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"915c5b32-ae0e-4e3f-845f-43d136b30a81"},{"name":"RecurringTransactionGet","id":"da9e69a1-c0be-42ec-b818-4db63da2230a","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/{{recurringTransactionId}}?fetchDetail=true&fetchDetailChart=true","description":"<h3 id=\"get-recurring-transaction-by-id\">Get Recurring Transaction by Id</h3>\n<p>This operation accepts recurring GL transaction number or recurring GL transaction GUID in <code>id</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/{id}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. recurring GL transaction number or recurring GL transaction GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fetchDetail</em></td>\n<td>Optional bool, default <code>false</code>. When <code>true</code>, includes the recurring transaction line items.</td>\n</tr>\n<tr>\n<td><em>fetchDetailChart</em></td>\n<td>Optional bool, default <code>false</code>. When <code>true</code>, also resolves the chart, account, branch, class, and portfolio metadata for each line. Ignored when <code>fetchDetail=false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>MyGeneralLedgerRecurringTransactionEntity</code> — <code>Id</code>, <code>Number</code>, <code>Description</code>, <code>Frequency</code>, <code>BranchId</code>, <code>Notes</code>, audit columns, and the optional <code>GeneralLedgerRecurringTransactionDetails</code> collection when <code>fetchDetail=true</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>recurring GL transaction number or recurring GL transaction GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/GeneralLedger/RecurringTransaction/1\n/api/Client/GeneralLedger/RecurringTransaction/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","RecurringTransaction","{{recurringTransactionId}}"],"host":["{{base_url}}"],"query":[{"key":"fetchDetail","value":"true"},{"key":"fetchDetailChart","value":"true"}],"variable":[]}},"response":[{"id":"596128b1-0693-4d22-bbcb-67f4bad292d9","name":"GetRecurringTransaction - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"SessionId","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/{{recurringTransactionId}}?fetchDetail=true&fetchDetailChart=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","RecurringTransaction","{{recurringTransactionId}}"],"query":[{"key":"fetchDetail","value":"true"},{"key":"fetchDetailChart","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Number\": 1001,\n        \"Description\": \"Monthly rent accrual\",\n        \"Frequency\": 2,\n        \"BranchId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Notes\": \"Auto-posts on the first of each month\",\n        \"GeneralLedgerRecurringTransactionDetails\": [\n            {\n                \"Id\": \"d1111111-1111-4222-9333-abcdef012345\",\n                \"GeneralLedgerChartId\": \"ch111111-1111-4222-9333-abcdef012345\",\n                \"DebitAmount\": 2500.00,\n                \"CreditAmount\": 0.00\n            },\n            {\n                \"Id\": \"d2222222-1111-4222-9333-abcdef012345\",\n                \"GeneralLedgerChartId\": \"ch222222-1111-4222-9333-abcdef012345\",\n                \"DebitAmount\": 0.00,\n                \"CreditAmount\": 2500.00\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"ae72b8fa-9f76-4bf8-ac8f-3cf1b55ca122","name":"GetRecurringTransaction - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"SessionId","value":"{{token}}"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/11111111-1111-4111-8111-111111111111?fetchDetail=true&fetchDetailChart=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","RecurringTransaction","11111111-1111-4111-8111-111111111111"],"query":[{"key":"fetchDetail","value":"true"},{"key":"fetchDetailChart","value":"true"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"da9e69a1-c0be-42ec-b818-4db63da2230a"},{"name":"RecurringTransactionUpdate","id":"7c8125bb-6149-4aca-939f-fec94ad94f9f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 1001,\n    \"description\": \"Monthly rent accrual - updated\",\n    \"frequency\": 2,\n    \"branchNumberOrId\": \"100\",\n    \"lineItems\": [\n        {\n            \"id\": \"d1111111-1111-4222-9333-abcdef012345\",\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2750.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"id\": \"d2222222-1111-4222-9333-abcdef012345\",\n            \"chartAccountNumberOrId\": \"2100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 2750.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/{{recurring_transaction_number_or_id}}","description":"<h3 id=\"update-recurring-transaction\">Update Recurring Transaction</h3>\n<p>Updates an existing GL recurring transaction template. The URL segment <code>{numberOrId}</code> accepts either the integer recurring transaction number (e.g. <code>1001</code>) or the Guid, resolved via <code>SharedWSServices.GetGeneralLedgerRecurringTransactionId</code>. The controller passes the resolved Guid into <code>RecurringTransactionWSServices.AddSaveRecurringTransactionWS</code>, which re-runs every validation rule before replacing header fields and rewriting the full detail set.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required. Recurring transaction number or Guid. Returns <code>Recurring transaction not found</code> when unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Identical shape to <code>POST /api/Client/GeneralLedger/RecurringTransaction</code> (see <code>AddRecurringTransaction</code>). <code>number</code>, <code>description</code>, <code>frequency</code>, <code>branchNumberOrId</code>, and <code>lineItems</code> are all required and must pass the same validation rules. Existing detail rows whose <code>id</code> matches a line item in the payload are updated; all others are replaced.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the same recurring transaction Guid.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","RecurringTransaction","{{recurring_transaction_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a44ba489-0ae4-4b23-a0c7-70f9046567b8","name":"UpdateRecurringTransaction - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 1001,\n    \"description\": \"Monthly rent accrual - updated\",\n    \"frequency\": 2,\n    \"branchNumberOrId\": \"100\",\n    \"lineItems\": [\n        {\n            \"id\": \"d1111111-1111-4222-9333-abcdef012345\",\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2750.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"id\": \"d2222222-1111-4222-9333-abcdef012345\",\n            \"chartAccountNumberOrId\": \"2100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 2750.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/1001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e62efc43-69c1-433a-9659-1d49a2404c7c","name":"UpdateRecurringTransaction - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"number\": 999999,\n    \"description\": \"Monthly rent accrual - updated\",\n    \"frequency\": 2,\n    \"branchNumberOrId\": \"100\",\n    \"lineItems\": [\n        {\n            \"id\": \"d1111111-1111-4222-9333-abcdef012345\",\n            \"chartAccountNumberOrId\": \"5000-100\",\n            \"debitAmount\": 2750.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"id\": \"d2222222-1111-4222-9333-abcdef012345\",\n            \"chartAccountNumberOrId\": \"2100-100\",\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 2750.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RecurringTransaction/999999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Recurring transaction not found\"\n    ]\n}"}],"_postman_id":"7c8125bb-6149-4aca-939f-fec94ad94f9f"},{"name":"ReportGroupAdd","id":"010433ad-5eb3-4c95-8de5-8b310492aeb4","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Operating Expenses\",\n    \"report\": 2,\n    \"section\": 2,\n    \"notes\": \"Day-to-day operating expense accounts\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ReportGroup","description":"<h3 id=\"add-gl-report-group\">Add GL Report Group</h3>\n<p>Creates a new GL report group — a grouping bucket used by the GL financial statements to cluster chart accounts under a Balance Sheet or Income Statement section. The controller forces <code>id = null</code> and <code>ts = null</code> on the body, so this route always inserts; use <code>PUT /api/Client/GeneralLedger/ReportGroup/{reportGroupNumberOrId}</code> to update. Internally calls <code>ReportGroupWSServices.AddSaveReportGroupWS</code> which delegates to <code>GeneralLedgerReportGroupServices.AddReportGroup</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/ReportGroup</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 55 characters.</td>\n</tr>\n<tr>\n<td><em>report</em></td>\n<td>Required int enum (<code>Omega.GeneralLedger.Types.Enums.GeneralLedgerAccountTypes</code>): <code>1 = Balance_Sheet</code>, <code>2 = Income_Statement</code>.</td>\n</tr>\n<tr>\n<td><em>section</em></td>\n<td>Required int enum. Valid values depend on <code>report</code>: when <code>report = 1 (Balance_Sheet)</code> use <code>GeneralLedgerBalanceSheetSection</code>: <code>1 = Assets</code>, <code>4 = Liabilities</code>, <code>5 = Equity</code>; when <code>report = 2 (Income_Statement)</code> use <code>GeneralLedgerIncomeStatementSection</code>: <code>1 = Income</code>, <code>2 = Expenses</code>, <code>3 = Other</code>.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Null is stored as empty string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid assigned to the new report group.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","ReportGroup"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9303a899-9ab7-4ca8-896a-352bc168bdc2","name":"AddReportGroup - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Operating Expenses\",\n    \"report\": 2,\n    \"section\": 2,\n    \"notes\": \"Day-to-day operating expense accounts\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ReportGroup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"rg111111-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"7343961e-c7cd-41b5-8cc1-643deecb61e1","name":"AddReportGroup - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Operating Expenses\",\n    \"report\": 2,\n    \"section\": 9,\n    \"notes\": \"Day-to-day operating expense accounts\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ReportGroup"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Section must be 1 (Income), 2 (Expenses), or 3 (Other) for an Income_Statement report\"\n    ]\n}"}],"_postman_id":"010433ad-5eb3-4c95-8de5-8b310492aeb4"},{"name":"ReportGroupUpdate","id":"70fa4f70-2ce5-4432-90b7-d296356805eb","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Operating Expenses (updated)\",\n    \"report\": 2,\n    \"section\": 2,\n    \"notes\": \"Renamed for 2026 reporting\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ReportGroup/{{report_group_number_or_id}}","description":"<h3 id=\"update-gl-report-group\">Update GL Report Group</h3>\n<p>Updates an existing GL report group. The URL segment <code>{reportGroupNumberOrId}</code> accepts either the report group number or its Guid; the controller resolves it via <code>SharedWSServices.GetGeneralLedgerReportGroupId</code>, loads the existing entity with <code>GeneralLedgerReportGroupServices.ReturnReportGroupWithId</code> to capture the <code>Ts</code> optimistic-concurrency token, then calls <code>ReportGroupWSServices.AddSaveReportGroupWS</code>. Megasys-maintained report groups (<code>MegasysMaintained = true</code>) cannot be modified and return an error.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/ReportGroup/{reportGroupNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>reportGroupNumberOrId</em></td>\n<td>Required. Report group number or Guid. Returns <code>Report group not found</code> when unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Identical shape to <code>POST /api/Client/GeneralLedger/ReportGroup</code> (see <code>AddReportGroup</code>). <code>description</code>, <code>report</code>, <code>section</code>, and <code>notes</code> are required and must pass the same validation rules. The controller supplies the existing <code>id</code> and <code>ts</code> internally; the client does not send them.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the same report group Guid.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","ReportGroup","{{report_group_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"009aed16-ac89-4eb1-9235-f1134089459d","name":"UpdateReportGroup - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Operating Expenses (updated)\",\n    \"report\": 2,\n    \"section\": 2,\n    \"notes\": \"Renamed for 2026 reporting\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ReportGroup/rg111111-1111-4222-9333-abcdef012345"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"rg111111-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"3bd45602-da15-4376-a19c-873a2ae48eb8","name":"UpdateReportGroup - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Operating Expenses (updated)\",\n    \"report\": 2,\n    \"section\": 2,\n    \"notes\": \"Renamed for 2026 reporting\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/ReportGroup/999999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Report group not found\"\n    ]\n}"}],"_postman_id":"70fa4f70-2ce5-4432-90b7-d296356805eb"},{"name":"RetainedEarningsAdjustmentAdd","id":"9e1b9ed9-d71d-43ec-83f5-22a1d8f43e44","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-01-01\",\n    \"amount\": 15000.00,\n    \"retainedEarningsGlAccountNumberOrId\": \"3900\",\n    \"dummyGlAccountNumberOrId\": \"9999\",\n    \"notes\": \"Roll prior-year net income to retained earnings\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RetainedEarningsAdjustment","description":"<h3 id=\"add-retained-earnings-adjustment\">Add Retained Earnings Adjustment</h3>\n<p>Posts a two-line GL adjustment between the configured Retained Earnings account and a dummy offset account. Used to roll prior-period income into retained earnings outside of the normal year-end close. Internally calls <code>GeneralLedgerTransactionWSServices.AddRetainedEarningsAdjustmentWS</code>.</p>\n<p>When <code>postingDate</code> is null, the WS service defaults it to the fiscal year's <code>StartingDateOfYear</code> from <code>GeneralLedger.ExternalMasterConfiguration</code>. When <code>retainedEarningsGlAccountNumberOrId</code> or <code>dummyGlAccountNumberOrId</code> is omitted, the WS service falls back to the <code>RetainedEarningsAccountId</code> and dummy account configured on <code>ExternalMasterConfiguration</code>. The two accounts must not be equal.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/RetainedEarningsAdjustment</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>postingDate</em></td>\n<td>Optional date. Defaults to the configured <code>StartingDateOfYear</code> when null. Must satisfy GL posting-date permissions.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required decimal, non-zero. Positive amounts credit retained earnings (debit the dummy account); negative amounts do the reverse.</td>\n</tr>\n<tr>\n<td><em>retainedEarningsGlAccountNumberOrId</em></td>\n<td>Optional. GL account number or Guid; resolved via <code>SharedWSServices.GetGeneralLedgerAccountId</code>. Falls back to <code>ExternalMasterConfiguration.RetainedEarningsAccountId</code>.</td>\n</tr>\n<tr>\n<td><em>dummyGlAccountNumberOrId</em></td>\n<td>Optional. GL account number or Guid; resolved via <code>SharedWSServices.GetGeneralLedgerAccountId</code>. Falls back to the dummy account configured on <code>ExternalMasterConfiguration</code>.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Stored on the transaction header.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ TransactionId, ReferenceId }</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","RetainedEarningsAdjustment"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"398786a7-1511-4139-98dd-bddf56ee3ab1","name":"AddRetainedEarningsAdjustment - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-01-01\",\n    \"amount\": 15000.00,\n    \"retainedEarningsGlAccountNumberOrId\": \"3900\",\n    \"dummyGlAccountNumberOrId\": \"9999\",\n    \"notes\": \"Roll prior-year net income to retained earnings\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RetainedEarningsAdjustment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"TransactionId\": \"t3333333-1111-4222-9333-abcdef012345\",\n        \"ReferenceId\": \"r3333333-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"584d448f-3ce8-488a-b876-3757d5a4b09a","name":"AddRetainedEarningsAdjustment - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-01-01\",\n    \"amount\": 0.00,\n    \"retainedEarningsGlAccountNumberOrId\": \"3900\",\n    \"dummyGlAccountNumberOrId\": \"9999\",\n    \"notes\": \"Roll prior-year net income to retained earnings\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/RetainedEarningsAdjustment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Amount must be non-zero\"\n    ]\n}"}],"_postman_id":"9e1b9ed9-d71d-43ec-83f5-22a1d8f43e44"},{"name":"WorkingTrialBalanceAdjustmentPost","id":"af4889d8-7d29-4bef-87f7-533ef9b41e8e","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-03-31\",\n    \"notes\": \"March WTB adjustment\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"1000-001-00-00\",\n            \"glAccountNumberOrId\": null,\n            \"debitAmount\": 250.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"4000-001-00-00\",\n            \"glAccountNumberOrId\": null,\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 250.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance/Update","description":"<h3 id=\"post-working-trial-balance-adjustment\">Post Working Trial Balance Adjustment</h3>\n<p>Posts a balanced manual adjusting GL transaction to tune working trial balance figures. Each line item must resolve to either a chart (via <code>chartAccountNumberOrId</code>) or a GL account (via <code>glAccountNumberOrId</code>) — not both. Totals must balance (<code>sum(debitAmount) == sum(creditAmount)</code>) and at least two line items are required. The posting date is validated against the client's fiscal year / period via the <code>WTB Post Outside Current Fiscal Year</code>, <code>WTB Post Outside Current Period</code>, and <code>WTB Post Within Current Period</code> permissions, then persisted through <code>GeneralLedgerTransactionServices.AddManualGlTransaction</code> with journal type <code>Manual_Entry</code>. Calls <code>GeneralLedgerTransactionWSServices.PostWorkingTrialBalanceAdjustmentWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance/Update</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or <code>?token=</code> query string.</td>\n</tr>\n<tr>\n<td><em>postingDate</em></td>\n<td>Required DateTime. The date to post the adjustment on. Must be non-default. Permission-gated against the client's current period and current fiscal year.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form note stored on the generated GL transaction. Null is stored as empty string.</td>\n</tr>\n<tr>\n<td><em>lineItems</em></td>\n<td>Required array of <code>WorkingTrialBalanceAdjustmentLineItem</code> (minimum 2 entries). Debits and credits across all line items must balance.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"line-item-fields\">Line Item Fields</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>chartAccountNumberOrId</em></td>\n<td>Guid <code>Id</code> or composite chart account number resolved by <code>SharedWSServices.GetGeneralLedgerChartId</code>. Provide either this <em>or</em> <code>glAccountNumberOrId</code>, not both. Unresolvable values return <code>Line item {n}: chart account '...' not found</code>.</td>\n</tr>\n<tr>\n<td><em>glAccountNumberOrId</em></td>\n<td>Guid <code>Id</code> or numeric GL account number resolved by <code>SharedWSServices.GetGeneralLedgerAccountId</code>. Provide either this <em>or</em> <code>chartAccountNumberOrId</code>, not both. Unresolvable values return <code>Line item {n}: GL account '...' not found</code>.</td>\n</tr>\n<tr>\n<td><em>debitAmount</em></td>\n<td>Required decimal (&gt;= 0). Debit side of the line. A line cannot have both a debit and a credit greater than zero, and cannot be all-zero.</td>\n</tr>\n<tr>\n<td><em>creditAmount</em></td>\n<td>Required decimal (&gt;= 0). Credit side of the line. Same constraints as <code>debitAmount</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ TransactionId, ReferenceId }</code> — the Guid identifiers assigned to the new manual GL transaction and its reference record. Returns <code>Debit and credit totals must be balanced</code> if the line items are unbalanced, <code>GL master configuration missing</code> when the client has no GL master configuration row, or a permission error if the posting date falls outside the window allowed for the calling user.</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","WorkingTrialBalance","Update"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dab3c49c-3733-49cd-a171-9b556c402598","name":"PostWorkingTrialBalanceAdjustment - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-03-31\",\n    \"notes\": \"March WTB adjustment\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"1000-001-00-00\",\n            \"glAccountNumberOrId\": null,\n            \"debitAmount\": 250.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"4000-001-00-00\",\n            \"glAccountNumberOrId\": null,\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 250.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance/Update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"TransactionId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"ReferenceId\": \"b2b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"acac315a-4c77-42e1-92ad-4debbabe8df0","name":"PostWorkingTrialBalanceAdjustment - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"postingDate\": \"2026-03-31\",\n    \"notes\": \"March WTB adjustment\",\n    \"lineItems\": [\n        {\n            \"chartAccountNumberOrId\": \"1000-001-00-00\",\n            \"glAccountNumberOrId\": null,\n            \"debitAmount\": 250.00,\n            \"creditAmount\": 0.00\n        },\n        {\n            \"chartAccountNumberOrId\": \"4000-001-00-00\",\n            \"glAccountNumberOrId\": null,\n            \"debitAmount\": 0.00,\n            \"creditAmount\": 100.00\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance/Update"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Debit and credit totals must be balanced\"\n    ]\n}"}],"_postman_id":"af4889d8-7d29-4bef-87f7-533ef9b41e8e"},{"name":"WorkingTrialBalanceGet","id":"b04cdb72-27d6-4fb8-a066-6d8ee5a1cb61","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance?postingDate=2026-03-31&chartNumberOrId=&token={{token}}","description":"<h3 id=\"get-working-trial-balance\">Get Working Trial Balance</h3>\n<p>Returns the working trial balance for the fiscal period that contains <code>postingDate</code>, grouped by GL account and chart. The fiscal period is derived from the client's <code>YearendPeriod</code> via <code>Megasys.Framework.BLL.Date.ReportingPeriodFromDate</code> and the response includes the period start/end, fiscal-year start/end, period number, and fiscal year alongside every account row. Each account row aggregates one or more chart rows with <code>startingBalance</code>, <code>periodDebit</code>, <code>periodCredit</code>, and <code>endingBalance</code>. Calls <code>DailyTransactionSummaryWSServices.GetWorkingTrialBalanceWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>postingDate</em></td>\n<td>Optional DateTime (query). Any date inside the target fiscal period. When omitted, the client's <code>CurrentBusinessDate</code> is used. Only the date portion matters — time of day is ignored.</td>\n</tr>\n<tr>\n<td><em>chartNumberOrId</em></td>\n<td>Optional string (query). Filter the response to a single chart. Accepts the chart Guid <code>Id</code> or the composite chart account number string resolved by <code>SharedWSServices.GetGeneralLedgerChartId</code>. Unresolvable values return <code>GL chart not found</code>. Omit to return all charts.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>WorkingTrialBalanceResult</code> object: <code>postingDate</code>, <code>startPeriodDate</code>, <code>endPeriodDate</code>, <code>startYearDate</code>, <code>endYearDate</code>, <code>period</code>, <code>fiscalYear</code>, and <code>accounts</code> — a list of <code>WorkingTrialBalanceAccountRow</code> entries. Each account row has <code>accountId</code>, <code>accountNumber</code>, <code>description</code>, roll-up balances, and a <code>charts</code> array of <code>WorkingTrialBalanceChartRow</code> entries with <code>chartId</code>, <code>chartAccountNumber</code>, <code>description</code>, and per-chart balances. Returns <code>GL master configuration missing</code> when the client has no GL master configuration row yet (call POST <code>api/Client/GeneralLedger/ExternalMasterConfiguration</code> first).</p>\n","urlObject":{"protocol":"https","path":["api","Client","GeneralLedger","WorkingTrialBalance"],"host":["{{base_url}}"],"query":[{"key":"postingDate","value":"2026-03-31"},{"key":"chartNumberOrId","value":""},{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6e76dc7f-d9ed-45b9-ab8b-3025916311ca","name":"GetWorkingTrialBalance - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance?postingDate=2026-03-31&chartNumberOrId=&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","WorkingTrialBalance"],"query":[{"key":"postingDate","value":"2026-03-31"},{"key":"chartNumberOrId","value":""},{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"postingDate\": \"2026-03-31T00:00:00\",\n        \"startPeriodDate\": \"2026-03-01T00:00:00\",\n        \"endPeriodDate\": \"2026-03-31T00:00:00\",\n        \"startYearDate\": \"2026-01-01T00:00:00\",\n        \"endYearDate\": \"2026-12-31T00:00:00\",\n        \"period\": 3,\n        \"fiscalYear\": 2026,\n        \"accounts\": [\n            {\n                \"accountId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n                \"accountNumber\": 1000,\n                \"description\": \"Operating Cash\",\n                \"startingBalance\": 100000.00,\n                \"periodDebit\": 25000.00,\n                \"periodCredit\": -5000.00,\n                \"endingBalance\": 120000.00,\n                \"charts\": [\n                    {\n                        \"chartId\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n                        \"chartAccountNumber\": \"1000-001-00-00\",\n                        \"description\": \"Operating Cash - Main Branch\",\n                        \"startingBalance\": 100000.00,\n                        \"periodDebit\": 25000.00,\n                        \"periodCredit\": -5000.00,\n                        \"endingBalance\": 120000.00\n                    }\n                ]\n            }\n        ]\n    },\n    \"errors\": []\n}"},{"id":"0c80e502-eff7-4e68-a8c0-1a4de83aeb56","name":"GetWorkingTrialBalance - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/GeneralLedger/WorkingTrialBalance?postingDate=2026-03-31&chartNumberOrId=9999-999-99-99&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","GeneralLedger","WorkingTrialBalance"],"query":[{"key":"postingDate","value":"2026-03-31"},{"key":"chartNumberOrId","value":"9999-999-99-99"},{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"GL chart not found\"\n    ]\n}"}],"_postman_id":"b04cdb72-27d6-4fb8-a066-6d8ee5a1cb61"}],"id":"0de20495-f8c8-497d-941d-64c4b7b100ef","_postman_id":"0de20495-f8c8-497d-941d-64c4b7b100ef","description":""},{"name":"Global","item":[{"name":"ChildPermissionsGet","id":"c4e31bb6-b6f5-4386-882e-7e57878e3377","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/Permission/{{permission_id}}/children?token={{token}}","description":"<h3 id=\"get-child-permissions\">Get Child Permissions</h3>\n<p>Returns the immediate child <code>Global.Permission</code> rows whose <code>ParentId</code> equals the supplied Guid <code>{id}</code>. Backed by <code>PermissionWSServices.ReturnChildPermissionsWS</code> -&gt; <code>PermissionServices.ReturnChildPermission</code> (filter on <code>ParentId = id</code>).</p>\n<p>Returns BadRequest with <code>INVALID_PARAMETER_ERROR_MESSAGE</code> if <code>{id}</code> is blank or not parseable as a Guid. Returns an empty <code>data</code> array if the parent has no children.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/Permission/{id}/children</code></p>\n<blockquote>\n<p>Use together with <code>/Permission/root</code> and <code>/Permission/{id}</code> to walk the permission tree top-down: fetch the root, then call this route with the root <code>Id</code> to get its children, and recurse as needed.</p>\n</blockquote>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). The parent <code>Global.Permission.Id</code> whose immediate children should be returned.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Global.Permission</code> entities (immediate children only - this endpoint does not recurse). Each row exposes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Permission identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp.</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>String. Display name shown in the permissions tree.</td>\n</tr>\n<tr>\n<td><em>ModuleId</em></td>\n<td>Guid?. Module the permission belongs to.</td>\n</tr>\n<tr>\n<td><em>ParentId</em></td>\n<td>Guid?. Parent permission <code>Id</code> (matches the request <code>id</code>).</td>\n</tr>\n<tr>\n<td><em>Sequence</em></td>\n<td>Int. Sort order within the parent.</td>\n</tr>\n<tr>\n<td><em>MinimumEdition</em></td>\n<td>Int. Lowest product edition that exposes this node.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Global","Permission","{{permission_id}}","children"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"cf6c4061-0f8e-4e13-af98-511684b0767e","name":"GetChildPermissions - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Permission/{{permission_id}}/children?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Permission","{{permission_id}}","children"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n            \"Ts\": \"AAAAAAAAB9I=\",\n            \"Name\": \"Account Inquiry\",\n            \"ModuleId\": \"f4636c3b-17c5-4587-9dae-33c092f6dea3\",\n            \"ParentId\": \"00000000-0000-0000-0000-000000000001\",\n            \"Sequence\": 10,\n            \"MinimumEdition\": 1\n        },\n        {\n            \"Id\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n            \"Ts\": \"AAAAAAAAB9M=\",\n            \"Name\": \"Customer Maintenance\",\n            \"ModuleId\": \"f4636c3b-17c5-4587-9dae-33c092f6dea3\",\n            \"ParentId\": \"00000000-0000-0000-0000-000000000001\",\n            \"Sequence\": 20,\n            \"MinimumEdition\": 1\n        }\n    ],\n    \"errors\": []\n}"},{"id":"8d01acd2-ac1a-45cb-bd48-675d8351d974","name":"GetChildPermissions - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Permission/not-a-guid/children?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Permission","not-a-guid","children"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"\"Invalid parameter data\""}],"_postman_id":"c4e31bb6-b6f5-4386-882e-7e57878e3377"},{"name":"CountriesGetAll","id":"dcba8f59-0f22-4602-b904-15bbe8a10faa","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/Country?token={{token}}&includeCountryWithoutSequence=false","description":"<h3 id=\"get-all-countries\">Get All Countries</h3>\n<p>Returns the <code>Global.Country</code> lookup list, sorted by <code>Sequence</code> ascending. Backed by <code>CountryWSServices.ReturnAllCountriesWS</code> -&gt; <code>CountryServices.ReturnCountries</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/Country</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>includeCountryWithoutSequence</em></td>\n<td>Optional bool. Defaults to <code>false</code>. When <code>false</code>, rows whose <code>Sequence</code> is null are filtered out so only the curated/ordered set is returned. When <code>true</code>, every country row is returned regardless of <code>Sequence</code>.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Global.Country</code> entities. Each row exposes <code>Id</code>, <code>Ts</code>, <code>CountryName</code>, and <code>Sequence</code> (nullable int).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Global","Country"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"includeCountryWithoutSequence","value":"false"}],"variable":[]}},"response":[{"id":"09f04f17-f3ff-425a-a61b-effeb14493ad","name":"GetAllCountries - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Country?token={{token}}&includeCountryWithoutSequence=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Country"],"query":[{"key":"token","value":"{{token}}"},{"key":"includeCountryWithoutSequence","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9E=\",\n            \"CountryName\": \"United States\",\n            \"Sequence\": 1\n        },\n        {\n            \"Id\": \"22222222-2222-4222-9222-222222222222\",\n            \"Ts\": \"AAAAAAAAB9I=\",\n            \"CountryName\": \"Canada\",\n            \"Sequence\": 2\n        },\n        {\n            \"Id\": \"33333333-3333-4333-9333-333333333333\",\n            \"Ts\": \"AAAAAAAAB9M=\",\n            \"CountryName\": \"Mexico\",\n            \"Sequence\": 3\n        }\n    ],\n    \"errors\": []\n}"},{"id":"c0604052-5b9a-45fe-91dd-2ac17c568af3","name":"GetAllCountries - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Country?token=invalid-or-expired-token&includeCountryWithoutSequence=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Country"],"query":[{"key":"token","value":"invalid-or-expired-token"},{"key":"includeCountryWithoutSequence","value":"false"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authentication failed: No valid authentication method found (SessionId, API Key, or Token)\"\n}"}],"_postman_id":"dcba8f59-0f22-4602-b904-15bbe8a10faa"},{"name":"DBVersionGet","id":"a3005b3c-3fa4-4c56-804a-0638c9fc3ee0","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/DBVersion?token={{token}}","description":"<h3 id=\"get-database-version\">Get Database Version</h3>\n<p>Read-only endpoint that returns a curated subset of <code>Global.DBVersion</code> for the authenticated client database. Backed by <code>DBVersionWSServices.ReturnDBVersionWS</code> -&gt; <code>DBVersionServices.GetDBVersion</code>. Useful for verifying which schema/build the target database is running against before issuing other API calls.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/DBVersion</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a flat object with three safe-to-expose fields from the <code>Global.DBVersion</code> row (<code>Ts</code>, <code>RefreshSandboxDatabase</code>, and the row <code>Id</code> are intentionally not returned):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Version</em></td>\n<td>Int. Current schema version of the database.</td>\n</tr>\n<tr>\n<td><em>OneTimeUpdateVersion</em></td>\n<td>Int. Latest one-time data-fix script that has been applied.</td>\n</tr>\n<tr>\n<td><em>MainDatabase</em></td>\n<td>Bool. True for the primary tenant database.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Global","DBVersion"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f5ebad3e-9f35-46a9-bc59-e46bd9e6817d","name":"GetDBVersion - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/DBVersion?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","DBVersion"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Version\": 1599,\n        \"OneTimeUpdateVersion\": 27,\n        \"MainDatabase\": true\n    },\n    \"errors\": []\n}"},{"id":"6f0c8130-09ec-44df-96c9-8746d3d6116e","name":"GetDBVersion - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/DBVersion?token=invalid-or-expired-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","DBVersion"],"query":[{"key":"token","value":"invalid-or-expired-token"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authentication failed: No valid authentication method found (SessionId, API Key, or Token)\"\n}"}],"_postman_id":"a3005b3c-3fa4-4c56-804a-0638c9fc3ee0"},{"name":"ModulesGetAll","id":"efe254e8-3029-41a6-8ed5-b51d6b7e9674","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/Module?token={{token}}","description":"<h3 id=\"get-all-modules\">Get All Modules</h3>\n<p>Returns the list of <code>Global.Module</code> rows scoped to the Client application (<code>Application = 1</code>), ordered by <code>Sequence</code>. Backed by <code>ModuleWSServices.ReturnAllModulesWS</code> -&gt; <code>ModuleServices.GetModules(loginInfo.DatabaseName, ApplicationTypeEnum.Client)</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/Module</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Global.Module</code> entities. Each row exposes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Module identifier (e.g., Servicing, Originations, Common).</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp.</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>String. Display name of the module.</td>\n</tr>\n<tr>\n<td><em>IconUrl</em></td>\n<td>String. Relative URL of the module icon.</td>\n</tr>\n<tr>\n<td><em>DashboardUrl</em></td>\n<td>String. Relative URL of the module dashboard page.</td>\n</tr>\n<tr>\n<td><em>Sequence</em></td>\n<td>Int. Sort order in the application menu.</td>\n</tr>\n<tr>\n<td><em>RequiresLicense</em></td>\n<td>Bool. True when the module is gated by a license.</td>\n</tr>\n<tr>\n<td><em>Application</em></td>\n<td>Int. 1 = Client, 2 = Dealer Portal. Always 1 here.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Global","Module"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f9983d4b-aed6-4c3c-bd49-89260c6fad6a","name":"GetAllModules - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Module?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Module"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"f4636c3b-17c5-4587-9dae-33c092f6dea3\",\n            \"Ts\": \"AAAAAAAAB9E=\",\n            \"Name\": \"Servicing\",\n            \"IconUrl\": \"/Framework/Assets/Images/Modules/Servicing.png\",\n            \"DashboardUrl\": \"/Client/Servicing/Dashboard.aspx\",\n            \"Sequence\": 1,\n            \"RequiresLicense\": true,\n            \"Application\": 1\n        },\n        {\n            \"Id\": \"05aae2f0-582a-4721-8dca-4633319be8bb\",\n            \"Ts\": \"AAAAAAAAB9I=\",\n            \"Name\": \"Originations\",\n            \"IconUrl\": \"/Framework/Assets/Images/Modules/Originations.png\",\n            \"DashboardUrl\": \"/Client/Originations/Dashboard.aspx\",\n            \"Sequence\": 2,\n            \"RequiresLicense\": true,\n            \"Application\": 1\n        }\n    ],\n    \"errors\": []\n}"},{"id":"6fe4e6a5-421f-4917-9cf0-4e52ac9bc097","name":"GetAllModules - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Module?token=invalid-or-expired-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Module"],"query":[{"key":"token","value":"invalid-or-expired-token"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authentication failed: No valid authentication method found (SessionId, API Key, or Token)\"\n}"}],"_postman_id":"efe254e8-3029-41a6-8ed5-b51d6b7e9674"},{"name":"PermissionGet","id":"79c327dd-1f7b-457d-97a2-8fa85db97abb","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/Permission/{{permission_id}}?token={{token}}","description":"<h3 id=\"get-permission-by-id\">Get Permission by Id</h3>\n<p>Returns a single <code>Global.Permission</code> row by Guid <code>Id</code>. Backed by <code>PermissionWSServices.ReturnPermissionWS</code> -&gt; <code>PermissionServices.ReturnPermission</code> (direct <code>FetchEntity</code>).</p>\n<p>Returns BadRequest with <code>INVALID_PARAMETER_ERROR_MESSAGE</code> if <code>{id}</code> is blank or not parseable as a Guid. Returns <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Permission not found\"]}</code> if no row matches.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/Permission/{id}</code></p>\n<blockquote>\n<p>Companion routes in this controller: <code>/Permission/root</code> (top-level node) and <code>/Permission/{id}/children</code> (immediate descendants of a permission). Use this <code>/Permission/{id}</code> route to retrieve any non-root node in isolation.</p>\n</blockquote>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). The <code>Global.Permission.Id</code> to fetch.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>Global.Permission</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Permission identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp.</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>String. Display name shown in the permissions tree.</td>\n</tr>\n<tr>\n<td><em>ModuleId</em></td>\n<td>Guid?. Module the permission belongs to.</td>\n</tr>\n<tr>\n<td><em>ParentId</em></td>\n<td>Guid?. Parent permission <code>Id</code> (null for the root).</td>\n</tr>\n<tr>\n<td><em>Sequence</em></td>\n<td>Int. Sort order within the parent.</td>\n</tr>\n<tr>\n<td><em>MinimumEdition</em></td>\n<td>Int. Lowest product edition that exposes this node.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Global","Permission","{{permission_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5452001b-925a-41da-b04a-5f85796cfdde","name":"GetPermission - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Permission/{{permission_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Permission","{{permission_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n        \"Ts\": \"AAAAAAAAB9I=\",\n        \"Name\": \"Account Inquiry\",\n        \"ModuleId\": \"f4636c3b-17c5-4587-9dae-33c092f6dea3\",\n        \"ParentId\": \"00000000-0000-0000-0000-000000000001\",\n        \"Sequence\": 10,\n        \"MinimumEdition\": 1\n    },\n    \"errors\": []\n}"},{"id":"41466d99-25ed-422e-9a42-3616acd2966d","name":"GetPermission - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Permission/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Permission","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Permission not found\"\n    ]\n}"}],"_postman_id":"79c327dd-1f7b-457d-97a2-8fa85db97abb"},{"name":"RootPermissionGet","id":"e39ae9c4-4121-46f2-8da4-8186627cd5c8","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/Permission/root?token={{token}}","description":"<h3 id=\"get-root-permission\">Get Root Permission</h3>\n<p>Returns the single top-level (root) <code>Global.Permission</code> row - the row whose <code>ParentId</code> is null. This is the entry point for walking the permission tree; once you have the root <code>Id</code>, use the <code>Permission/{id}/children</code> endpoint to drill down.</p>\n<p>Backed by <code>PermissionWSServices.ReturnRootPermissionWS</code> -&gt; <code>PermissionServices.ReturnRootPermission</code> (filters <code>GlobalPermission.ParentId IS NULL</code> and expects exactly one row).</p>\n<p>Returns <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Root permission not found\"]}</code> if the database has no row with a null <code>ParentId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/Permission/root</code></p>\n<blockquote>\n<p>Note: this is a <strong>distinct route</strong> from the <code>/Permission/{id}</code> lookup - the literal segment <code>root</code> is matched ahead of the <code>{id}</code> template by Web API's route ordering, so callers should not URL-encode <code>root</code> or attempt to send it as a Guid.</p>\n</blockquote>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>Global.Permission</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Root permission identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp.</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>String. Display name (typically \"Root\" or similar).</td>\n</tr>\n<tr>\n<td><em>ModuleId</em></td>\n<td>Guid?. Module the permission belongs to (nullable).</td>\n</tr>\n<tr>\n<td><em>ParentId</em></td>\n<td>Guid?. Always <code>null</code> for the root row.</td>\n</tr>\n<tr>\n<td><em>Sequence</em></td>\n<td>Int. Sort order.</td>\n</tr>\n<tr>\n<td><em>MinimumEdition</em></td>\n<td>Int. Lowest product edition that exposes this node.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Global","Permission","root"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6f05af46-769e-444f-a02c-7584724115dc","name":"GetRootPermission - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Permission/root?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Permission","root"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"00000000-0000-0000-0000-000000000001\",\n        \"Ts\": \"AAAAAAAAB9E=\",\n        \"Name\": \"Root\",\n        \"ModuleId\": null,\n        \"ParentId\": null,\n        \"Sequence\": 0,\n        \"MinimumEdition\": 1\n    },\n    \"errors\": []\n}"},{"id":"16845abb-ccb5-4f5f-9e3b-ed17e667d612","name":"GetRootPermission - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Permission/root?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Permission","root"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Root permission not found\"\n    ]\n}"}],"_postman_id":"e39ae9c4-4121-46f2-8da4-8186627cd5c8"},{"name":"ScreenGet","id":"39f74208-d8fc-4c39-b5c6-61b301de432f","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/Screen/{{screen_id}}?token={{token}}","description":"<h3 id=\"get-screen-by-id\">Get Screen by Id</h3>\n<p>Returns a single <code>Global.Screen</code> row by Guid <code>Id</code>. Backed by <code>ScreenWSServices.ReturnScreenWS</code> -&gt; <code>ScreenServices.GetScreenEntity</code> (direct <code>FetchEntity</code>).</p>\n<p>Returns BadRequest with <code>INVALID_PARAMETER_ERROR_MESSAGE</code> if <code>{id}</code> is blank or not parseable as a Guid. Returns <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Screen not found\"]}</code> if no row matches.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/Screen/{id}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid (route). The <code>Global.Screen.Id</code> to fetch.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>Global.Screen</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Screen identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp.</td>\n</tr>\n<tr>\n<td><em>Url</em></td>\n<td>String. Relative URL of the screen.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String. Human-readable screen name.</td>\n</tr>\n<tr>\n<td><em>ModuleId</em></td>\n<td>Guid. Module the screen belongs to.</td>\n</tr>\n<tr>\n<td><em>RecordUserFavorite</em></td>\n<td>Bool. When true, the screen can be added to the user's favorites list.</td>\n</tr>\n<tr>\n<td><em>HelpUrl</em></td>\n<td>String. Optional URL of the help topic for the screen.</td>\n</tr>\n<tr>\n<td><em>MegasysOnly</em></td>\n<td>Bool. When true, the screen is restricted to internal Megasys users.</td>\n</tr>\n<tr>\n<td><em>PermissionId</em></td>\n<td>Guid. Permission required to access the screen.</td>\n</tr>\n<tr>\n<td><em>CommonTask</em></td>\n<td>Bool. When true, the screen appears under Common Tasks.</td>\n</tr>\n<tr>\n<td><em>ShowProgramTitle</em></td>\n<td>Bool. When true, the page renders its program title banner.</td>\n</tr>\n<tr>\n<td><em>MinimumEdition</em></td>\n<td>Int. Lowest product edition that exposes the screen.</td>\n</tr>\n<tr>\n<td><em>Application</em></td>\n<td>Int. 1 = Client, 2 = Dealer Portal.</td>\n</tr>\n<tr>\n<td><em>StopDayendOnError</em></td>\n<td>Bool. When true, day-end processing halts if the screen reports an error.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Global","Screen","{{screen_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4c29300f-b143-4d07-83c6-1a180b32b0ef","name":"GetScreen - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Screen/{{screen_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Screen","{{screen_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9I=\",\n        \"Url\": \"/Client/Servicing/AccountInquiry.aspx\",\n        \"Description\": \"Account Inquiry\",\n        \"ModuleId\": \"f4636c3b-17c5-4587-9dae-33c092f6dea3\",\n        \"RecordUserFavorite\": true,\n        \"HelpUrl\": null,\n        \"MegasysOnly\": false,\n        \"PermissionId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n        \"CommonTask\": true,\n        \"ShowProgramTitle\": true,\n        \"MinimumEdition\": 1,\n        \"Application\": 1,\n        \"StopDayendOnError\": false\n    },\n    \"errors\": []\n}"},{"id":"cbec9c6e-9814-4737-958d-9c4bcbec6359","name":"GetScreen - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Screen/99999999-9999-9999-9999-999999999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Screen","99999999-9999-9999-9999-999999999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Screen not found\"\n    ]\n}"}],"_postman_id":"39f74208-d8fc-4c39-b5c6-61b301de432f"},{"name":"ScreensGetAll","id":"a27ec283-1867-4745-a4c0-da26ac745bb6","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Global/Screen?token={{token}}","description":"<h3 id=\"get-all-screens\">Get All Screens</h3>\n<p>Returns the list of <code>Global.Screen</code> rows. Backed by <code>ScreenWSServices.ReturnAllScreensWS</code> -&gt; <code>ScreenServices.GetScreenCollectionWithFilter</code>.</p>\n<p>When the optional <code>commonTasksOnly</code> query parameter is <code>true</code>, only screens flagged as common tasks (<code>Global.Screen.CommonTask = 1</code>) are returned. When omitted or <code>false</code>, every screen is returned.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Global/Screen</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>commonTasksOnly</em></td>\n<td>Optional bool. When <code>true</code>, restricts the result to screens marked as common tasks. Defaults to no filtering when omitted.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Global.Screen</code> entities. Each row exposes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Screen identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp.</td>\n</tr>\n<tr>\n<td><em>Url</em></td>\n<td>String. Relative URL of the screen (e.g., <code>/Client/Servicing/AccountInquiry.aspx</code>).</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String. Human-readable screen name.</td>\n</tr>\n<tr>\n<td><em>ModuleId</em></td>\n<td>Guid. Module the screen belongs to.</td>\n</tr>\n<tr>\n<td><em>RecordUserFavorite</em></td>\n<td>Bool. When true, the screen can be added to the user's favorites list.</td>\n</tr>\n<tr>\n<td><em>HelpUrl</em></td>\n<td>String. Optional URL of the help topic for the screen.</td>\n</tr>\n<tr>\n<td><em>MegasysOnly</em></td>\n<td>Bool. When true, the screen is restricted to internal Megasys users.</td>\n</tr>\n<tr>\n<td><em>PermissionId</em></td>\n<td>Guid. Permission required to access the screen.</td>\n</tr>\n<tr>\n<td><em>CommonTask</em></td>\n<td>Bool. When true, the screen appears under Common Tasks.</td>\n</tr>\n<tr>\n<td><em>ShowProgramTitle</em></td>\n<td>Bool. When true, the page renders its program title banner.</td>\n</tr>\n<tr>\n<td><em>MinimumEdition</em></td>\n<td>Int. Lowest product edition that exposes the screen.</td>\n</tr>\n<tr>\n<td><em>Application</em></td>\n<td>Int. 1 = Client, 2 = Dealer Portal.</td>\n</tr>\n<tr>\n<td><em>StopDayendOnError</em></td>\n<td>Bool. When true, day-end processing halts if the screen reports an error.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Global","Screen"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7a8f26c5-5270-4a15-a47e-ac824eeba8df","name":"GetAllScreens - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Screen?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Screen"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9I=\",\n            \"Url\": \"/Client/Servicing/AccountInquiry.aspx\",\n            \"Description\": \"Account Inquiry\",\n            \"ModuleId\": \"f4636c3b-17c5-4587-9dae-33c092f6dea3\",\n            \"RecordUserFavorite\": true,\n            \"HelpUrl\": null,\n            \"MegasysOnly\": false,\n            \"PermissionId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n            \"CommonTask\": true,\n            \"ShowProgramTitle\": true,\n            \"MinimumEdition\": 1,\n            \"Application\": 1,\n            \"StopDayendOnError\": false\n        },\n        {\n            \"Id\": \"22222222-2222-2222-2222-222222222222\",\n            \"Ts\": \"AAAAAAAAB9M=\",\n            \"Url\": \"/Client/Common/CustomerMaintenance.aspx\",\n            \"Description\": \"Customer Maintenance\",\n            \"ModuleId\": \"f4636c3b-17c5-4587-9dae-33c092f6dea3\",\n            \"RecordUserFavorite\": true,\n            \"HelpUrl\": null,\n            \"MegasysOnly\": false,\n            \"PermissionId\": \"b2c3d4e5-f6a7-8901-bcde-f23456789012\",\n            \"CommonTask\": false,\n            \"ShowProgramTitle\": true,\n            \"MinimumEdition\": 1,\n            \"Application\": 1,\n            \"StopDayendOnError\": false\n        }\n    ],\n    \"errors\": []\n}"},{"id":"a56e0c13-b501-486a-9a81-fc6a2897572d","name":"GetAllScreens - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Global/Screen?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Global","Screen"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving screens: Object reference not set to an instance of an object.\"\n    ]\n}"}],"_postman_id":"a27ec283-1867-4745-a4c0-da26ac745bb6"}],"id":"1aa3753d-4329-49b7-b28a-eee9337a356a","_postman_id":"1aa3753d-4329-49b7-b28a-eee9337a356a","description":""},{"name":"Insurance","item":[{"name":"CancelReasonCodeAdd","id":"35b83bc8-fc02-467d-9813-eccd31b52969","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Request\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode","description":"<h3 id=\"add-cancel-reason-code\">Add Cancel Reason Code</h3>\n<p>Inserts a new <code>Insurance.CancelReasonCode</code> row scoped to the authenticated client. Backed by <code>CancelReasonCodeController.AddCancelReasonCode</code> -&gt; <code>CancelReasonCodeWSServices.AddSaveCancelReasonCodeWS</code> (with <code>id=null</code> and <code>ts=null</code> to force the add branch) -&gt; <code>Omega.Insurance.BLL.CancelReasonCodeServices.AddSaveCancelReasonCode</code>.</p>\n<p>The service rejects the call with <code>\"Cancel reason code with this description already exists\"</code> when a row with the same <code>Description</code> already exists for <code>OmegaClientId = loginInfo.ClientId</code> (case-sensitive exact match via <code>ReturnCancelReasonCodeByDescription</code>).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/CancelReasonCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Unique description within the client. Also serves as the <code>descriptionOrId</code> lookup key on the GET/PUT routes when using a Client session.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the reason code should appear in selection lists.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;new Guid&gt;\" }</code>.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","CancelReasonCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bea9e5e2-0331-4e45-a00e-285e2411e8b2","name":"AddCancelReasonCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Request\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"50a2981b-22f9-4606-8f9c-2691f6d5649d","name":"AddCancelReasonCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Request\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Cancel reason code with this description already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"35b83bc8-fc02-467d-9813-eccd31b52969"},{"name":"CancelReasonCodeGet","id":"ffcf74a9-7b0e-47fd-b870-3f7f75b69ea7","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode/{{cancel_reason_code_description_or_id}}?token={{token}}","description":"<h3 id=\"get-cancel-reason-code-by-description-or-id\">Get Cancel Reason Code by Description or Id</h3>\n<p>Returns a single <code>Insurance.CancelReasonCode</code> row resolved from <code>{descriptionOrId}</code>. Backed by <code>CancelReasonCodeController.GetCancelReasonCode</code> -&gt; <code>CancelReasonCodeWSServices.GetCancelReasonCodeWS</code> -&gt; <code>SharedWSServices.GetInsuranceCancelReasonCodeId</code> then <code>CancelReasonCodeServices.ReturnCancelReasonCode</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/CancelReasonCode/{descriptionOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the exact <code>Description</code> of the cancel reason code. <code>SharedWSServices.GetInsuranceCancelReasonCodeId</code> first tries <code>Guid.TryParse</code>; if that fails and the caller is on a <code>SessionTypes.Client</code> session, it falls back to <code>CancelReasonCodeServices.ReturnCancelReasonCodeId</code> which does a case-sensitive match on <code>Description</code> scoped to <code>OmegaClientId = loginInfo.ClientId</code>. Dealer sessions URL-decrypt the value as an encrypted Guid.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an <code>Insurance.CancelReasonCode</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Cancel reason code identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp used for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>OmegaClientId</em></td>\n<td>Guid. Client that owns the row.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String. Unique description within the client.</td>\n</tr>\n<tr>\n<td><em>Available</em></td>\n<td>Bool. Whether the reason code is available for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Cancel reason code not found\"]}</code> when neither the Guid nor the description resolves a row for the current client.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Insurance","CancelReasonCode","{{cancel_reason_code_description_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fd639008-ae0c-4f0f-bbb7-9c43b20ecb2c","name":"GetCancelReasonCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode/Customer%20Request?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","CancelReasonCode","Customer%20Request"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA0=\",\n        \"OmegaClientId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n        \"Description\": \"Customer Request\",\n        \"Available\": true\n    },\n    \"errors\": []\n}"},{"id":"30773551-00e7-4557-b77c-8004f03cbcf1","name":"GetCancelReasonCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode/Nonexistent%20Reason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","CancelReasonCode","Nonexistent%20Reason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Cancel reason code not found\"\n    ]\n}"}],"_postman_id":"ffcf74a9-7b0e-47fd-b870-3f7f75b69ea7"},{"name":"CancelReasonCodesGetAll","id":"98c031c7-ad2e-40e4-800b-132fb6514cec","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode?token={{token}}","description":"<h3 id=\"get-all-cancel-reason-codes\">Get All Cancel Reason Codes</h3>\n<p>Returns every <code>Insurance.CancelReasonCode</code> row scoped to the authenticated client (<code>OmegaClientId</code>). Backed by <code>CancelReasonCodeWSServices.GetAllCancelReasonCodesWS</code> -&gt; <code>Omega.Insurance.BLL.CancelReasonCodeServices.ReturnAllCancelReasonCodes</code> (filter <code>OmegaClientId = loginInfo.ClientId</code>).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/CancelReasonCode</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers (<code>publicKey</code>/<code>timeStamp</code>/<code>signature</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Insurance.CancelReasonCode</code> entities. Each row exposes:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Cancel reason code identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp used for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>OmegaClientId</em></td>\n<td>Guid. Client that owns the row.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String. Unique description within the client (used as the lookup key for <code>descriptionOrId</code> PUT/GET routes under a Client session).</td>\n</tr>\n<tr>\n<td><em>Available</em></td>\n<td>Bool. Whether the reason code is available for selection.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","CancelReasonCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c1112f7a-1c03-4330-81ab-6510c5fa14ab","name":"GetAllCancelReasonCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","CancelReasonCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA0=\",\n            \"OmegaClientId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n            \"Description\": \"Customer Request\",\n            \"Available\": true\n        },\n        {\n            \"Id\": \"22222222-2222-4222-9222-222222222222\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n            \"Description\": \"Payoff\",\n            \"Available\": true\n        },\n        {\n            \"Id\": \"33333333-3333-4333-9333-333333333333\",\n            \"Ts\": \"AAAAAAAACA8=\",\n            \"OmegaClientId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n            \"Description\": \"Repossession\",\n            \"Available\": false\n        }\n    ],\n    \"errors\": []\n}"},{"id":"82cc8ff0-4366-40b3-9c76-192127e6de57","name":"GetAllCancelReasonCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","CancelReasonCode"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired session token\"\n    ]\n}"}],"_postman_id":"98c031c7-ad2e-40e4-800b-132fb6514cec"},{"name":"CancelReasonCodeUpdate","id":"e977353e-37c0-419c-9ab2-3fd990e61490","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Request\",\n    \"available\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode/{{cancel_reason_code_description_or_id}}","description":"<h3 id=\"update-cancel-reason-code\">Update Cancel Reason Code</h3>\n<p>Updates an existing <code>Insurance.CancelReasonCode</code> row. Backed by <code>CancelReasonCodeController.UpdateCancelReasonCode</code> which resolves the id via <code>SharedWSServices.GetInsuranceCancelReasonCodeId</code>, loads the existing row with <code>CancelReasonCodeServices.ReturnCancelReasonCode</code> to capture the current <code>Ts</code>, then calls <code>CancelReasonCodeWSServices.AddSaveCancelReasonCodeWS</code> with both <code>id</code> and <code>ts</code> populated to force the update branch of <code>Omega.Insurance.BLL.CancelReasonCodeServices.AddSaveCancelReasonCode</code>.</p>\n<p>The service rejects the call with <code>\"Cancel reason code with this description already exists\"</code> if another row (different <code>Id</code>) in the same client already uses the new description.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/CancelReasonCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string (route). Guid <code>Id</code> or exact <code>Description</code> of the existing cancel reason code. Resolved by <code>SharedWSServices.GetInsuranceCancelReasonCodeId</code> the same way as the GET route.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. New description. Must be unique within the client.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the reason code is available for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;Guid&gt;\" }</code> for the updated row.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>. Includes <code>\"Cancel reason code not found\"</code> if the route id/description does not resolve for the current client.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","CancelReasonCode","{{cancel_reason_code_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4725e02a-ac57-4286-845e-b70c23ca4c46","name":"UpdateCancelReasonCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Request\",\n    \"available\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode/Customer%20Request"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"d5e4490e-a352-4c48-bf0e-56c05fe0f2c2","name":"UpdateCancelReasonCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Nonexistent Reason\",\n    \"available\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/CancelReasonCode/Nonexistent%20Reason"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Cancel reason code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"e977353e-37c0-419c-9ab2-3fd990e61490"},{"name":"CompanyAdd","id":"1bf72576-4fb3-400b-b4f1-3d2a2921d028","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Insurance\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Company","description":"<h3 id=\"add-insurance-company\">Add Insurance Company</h3>\n<p>Inserts a new <code>Insurance.Company</code> row. Backed by <code>InsuranceCompanyController.AddCompany</code> which forces <code>id=null</code> and <code>ts=null</code> on the internal <code>AddSaveCompanyParameter</code> before calling <code>InsuranceCompanyWSServices.AddSaveCompanyWS</code> -&gt; <code>Omega.Insurance.BLL.CompanyServices.AddSaveCompany</code>.</p>\n<p>When <code>ts == null</code> the WS service takes the add branch: it rejects the call with <code>\"Insurance company with this name already exists\"</code> when <code>CompanyServices.ReturnInsuranceCompanyId(databaseName, name)</code> returns a matching id (trimmed exact-name match against the shared <code>Insurance.Company</code> table — there is no <code>OmegaClientId</code> scoping). <code>CreationDateTime</code> is set to <code>DateTime.Now</code> server-side and a fresh <code>Guid.NewGuid()</code> is assigned.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Company</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string. Insurance company name. Must be globally unique (case/whitespace sensitive per trimmed SQL comparison) because <code>Insurance.Company</code> has no client scoping. Also serves as the <code>companyNameOrId</code> lookup key on the GET/PUT routes when using a Client session.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;new Guid&gt;\" }</code>.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>. Known values: <code>\"Name is required\"</code>, <code>\"Insurance company with this name already exists\"</code>.</td>\n</tr>\n<tr>\n<td><em>warnings</em></td>\n<td>Array; currently unused but present in the response shape.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","Company"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"89cc9b24-8629-4878-9f7a-9a8d4f807844","name":"AddCompany - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Insurance\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Company"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"22222222-2222-4222-9222-222222222222\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"05f4226c-0a4f-48e6-9483-476589f0cc14","name":"AddCompany - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Insurance\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Company"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Insurance company with this name already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"1bf72576-4fb3-400b-b4f1-3d2a2921d028"},{"name":"CompanyGet","id":"a69189bc-b97e-4040-a135-8947754fa94e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Insurance/Company/{{insurance_company_name_or_id}}?token={{token}}","description":"<h3 id=\"get-insurance-company-by-name-or-id\">Get Insurance Company by Name or Id</h3>\n<p>Returns a single <code>Insurance.Company</code> row resolved from <code>{companyNameOrId}</code>. Backed by <code>InsuranceCompanyController.GetCompany</code> -&gt; <code>InsuranceCompanyWSServices.ReturnCompanyWS</code> -&gt; <code>SharedWSServices.GetInsuranceCompanyId</code> then <code>Omega.Insurance.BLL.CompanyServices.ReturnCompany</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Company/{companyNameOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>companyNameOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the exact <code>Name</code> of the insurance company. <code>SharedWSServices.GetInsuranceCompanyId</code> first tries <code>Guid.TryParse</code>; if that fails and the caller is on a <code>SessionTypes.Client</code> session, it falls back to <code>CompanyServices.ReturnInsuranceCompanyId</code> which matches on <code>Name</code> (trimmed). <code>Insurance.Company</code> is a shared reference table with no <code>OmegaClientId</code> column — names are global across clients. Dealer sessions URL-decrypt the value as an encrypted Guid.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an <code>Insurance.Company</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Insurance company identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp used for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>String. Unique insurance company name.</td>\n</tr>\n<tr>\n<td><em>CreationDateTime</em></td>\n<td>DateTime. When the row was first created; preserved across updates.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Insurance company not found\"]}</code> when neither the Guid nor the name resolves a row.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Insurance","Company","{{insurance_company_name_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"92d1b548-07d9-4462-a74f-a52a79126b6d","name":"GetCompany - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Company/Acme%20Insurance?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Company","Acme%20Insurance"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"22222222-2222-4222-9222-222222222222\",\n        \"Ts\": \"AAAAAAAACA4=\",\n        \"Name\": \"Acme Insurance\",\n        \"CreationDateTime\": \"2024-01-15T09:30:00\"\n    },\n    \"errors\": []\n}"},{"id":"9efef2e5-8d56-485d-bd60-7e87ae5bc741","name":"GetCompany - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Company/Nonexistent%20Company?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Company","Nonexistent%20Company"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Insurance company not found\"\n    ]\n}"}],"_postman_id":"a69189bc-b97e-4040-a135-8947754fa94e"},{"name":"CompanyUpdate","id":"84f83afe-4aa7-469f-b49f-9f64788f2803","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Insurance\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Company/{{insurance_company_name_or_id}}","description":"<h3 id=\"update-insurance-company\">Update Insurance Company</h3>\n<p>Updates an existing <code>Insurance.Company</code> row. Backed by <code>InsuranceCompanyController.UpdateCompany</code> which resolves the id via <code>SharedWSServices.GetInsuranceCompanyId</code>, loads the existing entity with <code>Omega.Insurance.BLL.CompanyServices.ReturnCompany</code> to capture the current <code>Ts</code>, then calls <code>InsuranceCompanyWSServices.AddSaveCompanyWS</code> with both <code>id</code> and <code>ts</code> populated to force the update branch of <code>Omega.Insurance.BLL.CompanyServices.AddSaveCompany</code>.</p>\n<p>Note: unlike Guarantor, the client is <strong>not</strong> required to send <code>ts</code> in the request body — the controller reads it off the currently persisted row. There is also no duplicate-name guard on update: the WS service only enforces uniqueness on the add branch, so changing one company's name to another company's existing name is not rejected by this endpoint. <code>CreationDateTime</code> is preserved from the existing row.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Company/{companyNameOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>companyNameOrId</em></td>\n<td>Required string (route). Guid <code>Id</code> or exact <code>Name</code> of the existing insurance company. Resolved by <code>SharedWSServices.GetInsuranceCompanyId</code> the same way as the GET route (Guid first, then trimmed name lookup for Client sessions, URL-decrypt for Dealer sessions).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string. New insurance company name.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;Guid&gt;\" }</code> for the updated row.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>. Known values: <code>\"Insurance company not found\"</code> (route id/name did not resolve), <code>\"Name is required\"</code>.</td>\n</tr>\n<tr>\n<td><em>warnings</em></td>\n<td>Array; currently unused but present in the response shape.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","Company","{{insurance_company_name_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f03dda4f-1597-432e-807b-99b9cd959f3e","name":"UpdateCompany - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Insurance Group\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Company/Acme%20Insurance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"22222222-2222-4222-9222-222222222222\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"6b5ca839-cc69-44ee-b50b-eecb408cca71","name":"UpdateCompany - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Insurance Group\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Company/Nonexistent%20Company"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Insurance company not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"84f83afe-4aa7-469f-b49f-9f64788f2803"},{"name":"GuarantorAdd","id":"63453aff-7e92-4216-9609-b982d7597f79","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Guarantor\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Guarantor","description":"<h3 id=\"add-insurance-guarantor\">Add Insurance Guarantor</h3>\n<p>Inserts a new <code>Insurance.Guarantor</code> row. Backed by <code>InsuranceGuarantorController.AddGuarantor</code> which forces <code>id=null</code> and <code>ts=null</code> on the internal <code>AddSaveGuarantorParameter</code> before calling <code>InsuranceGuarantorWSServices.AddSaveGuarantorWS</code> -&gt; <code>Omega.Insurance.BLL.GuarantorServices.AddSaveGuarantor</code>.</p>\n<p>The WS service trims the supplied <code>name</code> and rejects the call with <code>\"Insurance guarantor with this name already exists\"</code> when <code>GuarantorServices.ReturnInsuranceGuarantorId(databaseName, trimmedName)</code> returns a matching id. <code>Insurance.Guarantor</code> has no <code>OmegaClientId</code> column, so the uniqueness check is global across clients. <code>CreationDateTime</code> is set to <code>DateTime.Now</code> server-side and a fresh <code>Guid.NewGuid()</code> is assigned.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Guarantor</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string. Insurance guarantor name. Trimmed before save and uniqueness check. Also serves as the <code>guarantorNameOrId</code> lookup key on the GET/PUT routes when using a Client session.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;new Guid&gt;\" }</code>.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>. Known values: <code>\"Name is required\"</code>, <code>\"Insurance guarantor with this name already exists\"</code>.</td>\n</tr>\n<tr>\n<td><em>warnings</em></td>\n<td>Array; currently unused but present in the response shape.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","Guarantor"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c0b2012a-856e-4685-84c9-1c63594b2eee","name":"AddGuarantor - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Guarantor\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Guarantor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"33333333-3333-4333-9333-333333333333\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e0afeb9c-7e6c-442d-8531-47e73e462110","name":"AddGuarantor - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"name\": \"Acme Guarantor\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Guarantor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Insurance guarantor with this name already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"63453aff-7e92-4216-9609-b982d7597f79"},{"name":"GuarantorGet","id":"3d4aa978-a355-4f46-b6c2-6663b270de82","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Insurance/Guarantor/{{insurance_guarantor_name_or_id}}?token={{token}}","description":"<h3 id=\"get-insurance-guarantor-by-name-or-id\">Get Insurance Guarantor by Name or Id</h3>\n<p>Returns a single <code>Insurance.Guarantor</code> row resolved from <code>{guarantorNameOrId}</code>. Backed by <code>InsuranceGuarantorController.GetGuarantor</code> -&gt; <code>InsuranceGuarantorWSServices.ReturnGuarantorWS</code> -&gt; <code>SharedWSServices.GetInsuranceGuarantorId</code> then <code>Omega.Insurance.BLL.GuarantorServices.ReturnGuarantor</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Guarantor/{guarantorNameOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>guarantorNameOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the exact <code>Name</code> of the insurance guarantor. <code>SharedWSServices.GetInsuranceGuarantorId</code> first tries <code>Guid.TryParse</code>; if that fails and the caller is on a <code>SessionTypes.Client</code> session, it falls back to <code>GuarantorServices.ReturnInsuranceGuarantorId</code> which matches on <code>Name</code> (trimmed). <code>Insurance.Guarantor</code> is a shared reference table with no <code>OmegaClientId</code> column — names are global across clients. Dealer sessions URL-decrypt the value as an encrypted Guid.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an <code>Insurance.Guarantor</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Insurance guarantor identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp. <strong>Required in the PUT body</strong> for optimistic concurrency (the PUT route validates <code>param.ts</code> before calling the WS service).</td>\n</tr>\n<tr>\n<td><em>Name</em></td>\n<td>String. Unique insurance guarantor name.</td>\n</tr>\n<tr>\n<td><em>CreationDateTime</em></td>\n<td>DateTime. When the row was first created; preserved across updates.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Insurance guarantor not found\"]}</code> when neither the Guid nor the name resolves a row.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Insurance","Guarantor","{{insurance_guarantor_name_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c0eddefd-c8ba-42a2-91bf-29a4d7bb8c29","name":"GetGuarantor - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Guarantor/Acme%20Guarantor?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Guarantor","Acme%20Guarantor"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"33333333-3333-4333-9333-333333333333\",\n        \"Ts\": \"AAAAAAAACBA=\",\n        \"Name\": \"Acme Guarantor\",\n        \"CreationDateTime\": \"2024-02-20T14:45:00\"\n    },\n    \"errors\": []\n}"},{"id":"111fdf2d-615e-48a9-9fd4-78416b8b2683","name":"GetGuarantor - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Guarantor/Nonexistent%20Guarantor?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Guarantor","Nonexistent%20Guarantor"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Insurance guarantor not found\"\n    ]\n}"}],"_postman_id":"3d4aa978-a355-4f46-b6c2-6663b270de82"},{"name":"GuarantorUpdate","id":"6fca2a2e-cf85-4fcd-8b1c-5e961fca81fc","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"ts\": \"AAAAAAAACBA=\",\n    \"name\": \"Acme Guarantor\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Guarantor/{{insurance_guarantor_name_or_id}}","description":"<h3 id=\"update-insurance-guarantor\">Update Insurance Guarantor</h3>\n<p>Updates an existing <code>Insurance.Guarantor</code> row. Backed by <code>InsuranceGuarantorController.UpdateGuarantor</code> which:</p>\n<ol>\n<li>Rejects the call when <code>param.ts</code> is null/empty (<code>\"ts is required for update\"</code>).</li>\n<li>Resolves the id via <code>SharedWSServices.GetInsuranceGuarantorId</code>.</li>\n<li>Calls <code>InsuranceGuarantorWSServices.AddSaveGuarantorWS</code> with the resolved <code>id</code> and the caller-supplied <code>ts</code>, which forces the update branch of <code>Omega.Insurance.BLL.GuarantorServices.AddSaveGuarantor</code>.</li>\n</ol>\n<p>Unlike the Company endpoint, the caller <strong>must</strong> send the current row's <code>ts</code> in the request body. The WS service also enforces a duplicate-name guard on update: it rejects with <code>\"Insurance guarantor with this name already exists\"</code> when another row (different <code>Id</code>) already uses the new trimmed name. <code>CreationDateTime</code> is preserved from the existing row.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Guarantor/{guarantorNameOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>guarantorNameOrId</em></td>\n<td>Required string (route). Guid <code>Id</code> or exact <code>Name</code> of the existing insurance guarantor. Resolved by <code>SharedWSServices.GetInsuranceGuarantorId</code> the same way as the GET route (Guid first, then trimmed name lookup for Client sessions, URL-decrypt for Dealer sessions).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Required byte[] (base64-encoded in JSON). Current <code>Ts</code> of the row being updated, used for optimistic concurrency. Obtain it from the GET response.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string. New insurance guarantor name. Trimmed before save and uniqueness check. Must not collide with a different row's name.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;Guid&gt;\" }</code> for the updated row.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>. Known values: <code>\"ts is required for update\"</code>, <code>\"Insurance guarantor not found\"</code>, <code>\"Name is required\"</code>, <code>\"Timestamp is required for update\"</code>, <code>\"Insurance guarantor with this name already exists\"</code>.</td>\n</tr>\n<tr>\n<td><em>warnings</em></td>\n<td>Array; currently unused but present in the response shape.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","Guarantor","{{insurance_guarantor_name_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"357be371-1343-4bea-8fea-20ce9444a8c5","name":"UpdateGuarantor - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"ts\": \"AAAAAAAACBA=\",\n    \"name\": \"Acme Guarantor Group\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Guarantor/Acme%20Guarantor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"33333333-3333-4333-9333-333333333333\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"5a8908ad-d534-4f8d-bd36-efc89c17ad39","name":"UpdateGuarantor - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"ts\": \"\",\n    \"name\": \"Acme Guarantor Group\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Guarantor/Acme%20Guarantor"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"ts is required for update\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"6fca2a2e-cf85-4fcd-8b1c-5e961fca81fc"},{"name":"ProductCreate","id":"63f5bcfb-44f6-43ae-8451-2c813bc439c1","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"productCode\": \"GAP01\",\n    \"description\": \"GAP Insurance\",\n    \"insuranceType\": 3,\n    \"available\": true,\n    \"ownershipType\": 2,\n    \"vendorOrId\": null,\n    \"defaultPremiumAmount\": 495.00,\n    \"defaultPolicyFeeAmount\": 0.00,\n    \"defaultPolicyFeeCalcPercent\": null,\n    \"mergeFieldMessage1\": null,\n    \"mergeFieldMessage2\": null,\n    \"mergeFieldMessage3\": null,\n    \"allowDuplicateTypes\": false,\n    \"includePolicyFeeMAPR\": false,\n    \"includePremiumMAPR\": false,\n    \"includePolicyFeeStateAllInAPR\": false,\n    \"includePremiumStateAllInAPR\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Product?token={{token}}","description":"<h3 id=\"create-insurance-product\">Create Insurance Product</h3>\n<p>Inserts a new <code>Insurance.Product</code> row scoped to the authenticated client. Backed by <code>ProductController.CreateProduct</code> -&gt; <code>ProductWSServices.CreateProductWS</code> -&gt; <code>Omega.Insurance.BLL.ProductServices.AddSaveProduct</code>.</p>\n<p>Validation errors returned in <code>errors</code> include:</p>\n<ul>\n<li><code>\"Product code is required\"</code> when <code>productCode</code> is blank</li>\n<li><code>\"Description is required\"</code> when <code>description</code> is blank</li>\n<li><code>\"Product code already exists\"</code> when <code>ProductServices.CheckDuplicateCode</code> finds another product in the client with the same <code>ProductCode</code></li>\n</ul>\n<p>When <code>ownershipType = 2</code> (Lender), the service also creates a child <code>Insurance.ProductLender</code> row using <code>InsurancePremiumCalculationMethodType = Add_On_Amount</code> by default. Non-lender ownership types do not get a ProductLender child.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Product</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>productCode</em></td>\n<td>Required string. Unique short code within the client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Product description.</td>\n</tr>\n<tr>\n<td><em>insuranceType</em></td>\n<td>Required int. <code>Omega.Insurance.Types.Enums.InsuranceTypes</code> value — see table below.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the product appears in selection lists.</td>\n</tr>\n<tr>\n<td><em>ownershipType</em></td>\n<td>Required int. <code>Omega.Insurance.Types.Enums.OwnershipType</code> value — see table below.</td>\n</tr>\n<tr>\n<td><em>vendorOrId</em></td>\n<td>Optional string. Accepted for backward compatibility; <code>CreateProductWS</code> currently passes <code>null</code> for vendorId regardless of input.</td>\n</tr>\n<tr>\n<td><em>defaultPremiumAmount</em></td>\n<td>Optional decimal. Default premium amount.</td>\n</tr>\n<tr>\n<td><em>defaultPolicyFeeAmount</em></td>\n<td>Optional decimal. Default policy fee amount.</td>\n</tr>\n<tr>\n<td><em>defaultPolicyFeeCalcPercent</em></td>\n<td>Optional decimal. Policy fee calculation percent.</td>\n</tr>\n<tr>\n<td><em>mergeFieldMessage1</em></td>\n<td>Optional string. Merge-field message 1.</td>\n</tr>\n<tr>\n<td><em>mergeFieldMessage2</em></td>\n<td>Optional string. Merge-field message 2.</td>\n</tr>\n<tr>\n<td><em>mergeFieldMessage3</em></td>\n<td>Optional string. Merge-field message 3.</td>\n</tr>\n<tr>\n<td><em>allowDuplicateTypes</em></td>\n<td>Required bool. Allow multiple products sharing the same <code>InsuranceType</code>.</td>\n</tr>\n<tr>\n<td><em>includePolicyFeeMAPR</em></td>\n<td>Required bool. Include policy fee in MAPR.</td>\n</tr>\n<tr>\n<td><em>includePremiumMAPR</em></td>\n<td>Required bool. Include premium in MAPR.</td>\n</tr>\n<tr>\n<td><em>includePolicyFeeStateAllInAPR</em></td>\n<td>Required bool. Include policy fee in state \"all-in\" APR.</td>\n</tr>\n<tr>\n<td><em>includePremiumStateAllInAPR</em></td>\n<td>Required bool. Include premium in state \"all-in\" APR.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"insurancetype-values-insurancetypes\"><code>insuranceType</code> Values (<code>InsuranceTypes</code>)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Value</strong></th>\n<th><strong>Name</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1</td>\n<td>Credit_Life</td>\n</tr>\n<tr>\n<td>2</td>\n<td>Credit_Disability</td>\n</tr>\n<tr>\n<td>3</td>\n<td>GAP</td>\n</tr>\n<tr>\n<td>4</td>\n<td>Mechanical_Breakdown</td>\n</tr>\n<tr>\n<td>5</td>\n<td>Warranty</td>\n</tr>\n<tr>\n<td>6</td>\n<td>Theft</td>\n</tr>\n<tr>\n<td>7</td>\n<td>Maintenance</td>\n</tr>\n<tr>\n<td>8</td>\n<td>VSI</td>\n</tr>\n<tr>\n<td>9</td>\n<td>Property</td>\n</tr>\n<tr>\n<td>10</td>\n<td>Specialized_Equipment</td>\n</tr>\n<tr>\n<td>11</td>\n<td>Credit_IUI</td>\n</tr>\n<tr>\n<td>12</td>\n<td>CPI</td>\n</tr>\n<tr>\n<td>13</td>\n<td>Auto</td>\n</tr>\n<tr>\n<td>14</td>\n<td>Credit_Card</td>\n</tr>\n<tr>\n<td>15</td>\n<td>Life</td>\n</tr>\n<tr>\n<td>16</td>\n<td>Other</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"ownershiptype-values-ownershiptype\"><code>ownershipType</code> Values (<code>OwnershipType</code>)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Value</strong></th>\n<th><strong>Name</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>1</td>\n<td>Customer_Tracking</td>\n</tr>\n<tr>\n<td>2</td>\n<td>Lender</td>\n</tr>\n<tr>\n<td>3</td>\n<td>Dealer</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;new Guid&gt;\" }</code>.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","Product"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c2e4445a-ff17-46d2-b284-6b581b822830","name":"CreateProduct - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"productCode\": \"GAP01\",\n    \"description\": \"GAP Insurance\",\n    \"insuranceType\": 3,\n    \"available\": true,\n    \"ownershipType\": 2,\n    \"vendorOrId\": null,\n    \"defaultPremiumAmount\": 495.00,\n    \"defaultPolicyFeeAmount\": 0.00,\n    \"defaultPolicyFeeCalcPercent\": null,\n    \"mergeFieldMessage1\": null,\n    \"mergeFieldMessage2\": null,\n    \"mergeFieldMessage3\": null,\n    \"allowDuplicateTypes\": false,\n    \"includePolicyFeeMAPR\": false,\n    \"includePremiumMAPR\": false,\n    \"includePolicyFeeStateAllInAPR\": false,\n    \"includePremiumStateAllInAPR\": false\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"0f535443-be1e-4be4-88c1-88c44326123c","name":"CreateProduct - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"productCode\": \"\",\n    \"description\": \"GAP Insurance\",\n    \"insuranceType\": 3,\n    \"available\": true,\n    \"ownershipType\": 2,\n    \"vendorOrId\": null,\n    \"defaultPremiumAmount\": 495.00,\n    \"defaultPolicyFeeAmount\": 0.00,\n    \"defaultPolicyFeeCalcPercent\": null,\n    \"mergeFieldMessage1\": null,\n    \"mergeFieldMessage2\": null,\n    \"mergeFieldMessage3\": null,\n    \"allowDuplicateTypes\": false,\n    \"includePolicyFeeMAPR\": false,\n    \"includePremiumMAPR\": false,\n    \"includePolicyFeeStateAllInAPR\": false,\n    \"includePremiumStateAllInAPR\": false\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Product code is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"63f5bcfb-44f6-43ae-8451-2c813bc439c1"},{"name":"ProductGet","id":"f9202c65-7d90-4fe0-a3ec-194340b0a13b","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Insurance/Product/{{insurance_product_code_or_id}}?token={{token}}","description":"<h3 id=\"get-insurance-product-by-code-or-id\">Get Insurance Product by Code or Id</h3>\n<p>Returns a single <code>Insurance.Product</code> row resolved from <code>{codeOrId}</code>. Backed by <code>ProductController.GetProduct</code> -&gt; <code>ProductWSServices.GetProductWS</code> -&gt; <code>SharedWSServices.GetInsuranceProductId</code> then <code>ProductServices.ReturnProduct</code>.</p>\n<p><code>SharedWSServices.GetInsuranceProductId</code> first tries <code>Guid.TryParse</code>; if that fails and the caller is on a <code>SessionTypes.Client</code> session, it falls back to <code>ProductServices.ReturnProductIdByCode</code> which does a case-sensitive match on <code>ProductCode</code> scoped to <code>OmegaClientId = loginInfo.ClientId</code>. Dealer sessions URL-decrypt the value as an encrypted Guid.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Product/{codeOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the exact <code>ProductCode</code> of the product.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an <code>Insurance.Product</code> entity. See <em>Get All Products</em> for the field list.</p>\n<p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Product not found\"]}</code> when neither the Guid nor the product code resolves a row for the current client.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Insurance","Product","{{insurance_product_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"728d208d-cde2-4b04-b3f5-17d3a9bf6091","name":"GetProduct - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product/GAP01?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product","GAP01"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA0=\",\n        \"OmegaClientId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n        \"ProductCode\": \"GAP01\",\n        \"Description\": \"GAP Insurance\",\n        \"InsuranceType\": 3,\n        \"OwnershipType\": 2,\n        \"Available\": true,\n        \"DefaultPremiumAmount\": 495.00,\n        \"DefaultPolicyFeeAmount\": 0.00,\n        \"DefaultPolicyFeeCalcPercent\": null,\n        \"MergeFieldMessage1\": null,\n        \"MergeFieldMessage2\": null,\n        \"MergeFieldMessage3\": null,\n        \"AllowDuplicateTypes\": false,\n        \"IncludePolicyFeeMAPR\": false,\n        \"IncludePremiumMAPR\": false,\n        \"IncludePolicyFeeStateAllInAPR\": false,\n        \"IncludePremiumStateAllInAPR\": false\n    },\n    \"errors\": []\n}"},{"id":"08b43e95-e52d-4c66-a42a-a9032696b2fd","name":"GetProduct - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product/ZZZ99?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product","ZZZ99"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Product not found\"\n    ]\n}"}],"_postman_id":"f9202c65-7d90-4fe0-a3ec-194340b0a13b"},{"name":"ProductsGetAll","id":"e3dd75fc-2a6d-4a51-9bf8-e9583e1f15c7","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Insurance/Product?token={{token}}","description":"<h3 id=\"get-all-insurance-products\">Get All Insurance Products</h3>\n<p>Returns every <code>Insurance.Product</code> row scoped to the authenticated client. Backed by <code>ProductController.GetAllProducts</code> -&gt; <code>ProductWSServices.GetAllProductsWS</code> -&gt; <code>ProductServices.ReturnAllProducts</code> (filtered by <code>OmegaClientId = loginInfo.ClientId</code>).</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Product</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers (<code>publicKey</code>, <code>timeStamp</code>, <code>signature</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Insurance.Product</code> entities:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. Product identifier.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp used for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>OmegaClientId</em></td>\n<td>Guid. Client that owns the row.</td>\n</tr>\n<tr>\n<td><em>ProductCode</em></td>\n<td>String. Short code (unique within the client).</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String. Product description.</td>\n</tr>\n<tr>\n<td><em>InsuranceType</em></td>\n<td><code>Omega.Insurance.Types.Enums.InsuranceTypes</code> enum value. See <em>Create Product</em> for the enum table.</td>\n</tr>\n<tr>\n<td><em>OwnershipType</em></td>\n<td><code>Omega.Insurance.Types.Enums.OwnershipType</code> enum value (<code>1 = Customer_Tracking</code>, <code>2 = Lender</code>, <code>3 = Dealer</code>).</td>\n</tr>\n<tr>\n<td><em>Available</em></td>\n<td>Bool. Whether the product is available for selection.</td>\n</tr>\n<tr>\n<td><em>DefaultPremiumAmount</em></td>\n<td>Decimal? default premium.</td>\n</tr>\n<tr>\n<td><em>DefaultPolicyFeeAmount</em></td>\n<td>Decimal? default policy fee.</td>\n</tr>\n<tr>\n<td><em>DefaultPolicyFeeCalcPercent</em></td>\n<td>Decimal? calculation percent for policy fee.</td>\n</tr>\n<tr>\n<td><em>MergeFieldMessage1</em> / <em>MergeFieldMessage2</em> / <em>MergeFieldMessage3</em></td>\n<td>Merge-field text blocks used by configured documents.</td>\n</tr>\n<tr>\n<td><em>AllowDuplicateTypes</em></td>\n<td>Bool. Whether the same <code>InsuranceType</code> can be used by multiple products.</td>\n</tr>\n<tr>\n<td><em>IncludePolicyFeeMAPR</em> / <em>IncludePremiumMAPR</em> / <em>IncludePolicyFeeStateAllInAPR</em> / <em>IncludePremiumStateAllInAPR</em></td>\n<td>Bool flags controlling APR/MAPR inclusion.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","Product"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"88941fd7-31af-480e-b016-c97ce51c6edc","name":"GetAllProducts - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA0=\",\n            \"OmegaClientId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n            \"ProductCode\": \"GAP01\",\n            \"Description\": \"GAP Insurance\",\n            \"InsuranceType\": 3,\n            \"OwnershipType\": 2,\n            \"Available\": true,\n            \"DefaultPremiumAmount\": 495.00,\n            \"DefaultPolicyFeeAmount\": 0.00,\n            \"DefaultPolicyFeeCalcPercent\": null,\n            \"MergeFieldMessage1\": null,\n            \"MergeFieldMessage2\": null,\n            \"MergeFieldMessage3\": null,\n            \"AllowDuplicateTypes\": false,\n            \"IncludePolicyFeeMAPR\": false,\n            \"IncludePremiumMAPR\": false,\n            \"IncludePolicyFeeStateAllInAPR\": false,\n            \"IncludePremiumStateAllInAPR\": false\n        },\n        {\n            \"Id\": \"22222222-2222-4222-9222-222222222222\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n            \"ProductCode\": \"CL01\",\n            \"Description\": \"Credit Life\",\n            \"InsuranceType\": 1,\n            \"OwnershipType\": 1,\n            \"Available\": true,\n            \"DefaultPremiumAmount\": null,\n            \"DefaultPolicyFeeAmount\": null,\n            \"DefaultPolicyFeeCalcPercent\": null,\n            \"MergeFieldMessage1\": null,\n            \"MergeFieldMessage2\": null,\n            \"MergeFieldMessage3\": null,\n            \"AllowDuplicateTypes\": false,\n            \"IncludePolicyFeeMAPR\": false,\n            \"IncludePremiumMAPR\": false,\n            \"IncludePolicyFeeStateAllInAPR\": false,\n            \"IncludePremiumStateAllInAPR\": false\n        }\n    ],\n    \"errors\": []\n}"},{"id":"94da684f-1cc3-4f92-a604-5c769614d35b","name":"GetAllProducts - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired session token\"\n    ]\n}"}],"_postman_id":"e3dd75fc-2a6d-4a51-9bf8-e9583e1f15c7"},{"name":"ProductUpdate","id":"8ce19d23-69cc-4098-88ad-bf6a80dc8361","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"productCode\": \"GAP01\",\n    \"description\": \"GAP Insurance\",\n    \"insuranceType\": 3,\n    \"available\": true,\n    \"ownershipType\": 2,\n    \"vendorOrId\": null,\n    \"defaultPremiumAmount\": 495.00,\n    \"defaultPolicyFeeAmount\": 0.00,\n    \"defaultPolicyFeeCalcPercent\": null,\n    \"mergeFieldMessage1\": null,\n    \"mergeFieldMessage2\": null,\n    \"mergeFieldMessage3\": null,\n    \"allowDuplicateTypes\": false,\n    \"includePolicyFeeMAPR\": false,\n    \"includePremiumMAPR\": false,\n    \"includePolicyFeeStateAllInAPR\": false,\n    \"includePremiumStateAllInAPR\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Insurance/Product/{{insurance_product_code_or_id}}?token={{token}}","description":"<h3 id=\"update-insurance-product\">Update Insurance Product</h3>\n<p>Updates an existing <code>Insurance.Product</code> row. Backed by <code>ProductController.UpdateProduct</code> -&gt; <code>ProductWSServices.UpdateProductWS</code> -&gt; <code>Omega.Insurance.BLL.ProductServices.AddSaveProduct</code>.</p>\n<p>The service resolves the id via <code>SharedWSServices.GetInsuranceProductId</code> (Guid or <code>ProductCode</code>), loads the existing product and — when present — its child <code>Insurance.ProductLender</code>, then performs the update. All ProductLender fields (commission percents, GL account ids, refund methods, premium calculation method, policy term limits, etc.) are preserved from the existing entity; this endpoint does not accept those fields in the request body. Use the page-level services to edit Lender detail.</p>\n<p>Validation errors returned in <code>errors</code> include:</p>\n<ul>\n<li><code>\"Product not found\"</code> when <code>codeOrId</code> does not resolve for the current client</li>\n<li><code>\"Product code is required\"</code> when <code>productCode</code> is blank</li>\n<li><code>\"Description is required\"</code> when <code>description</code> is blank</li>\n<li><code>\"Product code already exists\"</code> when another product in the client already uses the new <code>productCode</code></li>\n</ul>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Insurance/Product/{codeOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string (route). Guid <code>Id</code> or exact <code>ProductCode</code> of the existing product.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <em>Create Product</em> (except <code>token</code> is in the query string). See <em>Create Product</em> for the <code>insuranceType</code> and <code>ownershipType</code> enum tables.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>productCode</em></td>\n<td>Required string. Unique product code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Product description.</td>\n</tr>\n<tr>\n<td><em>insuranceType</em></td>\n<td>Required int. <code>InsuranceTypes</code> enum value.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the product is available for selection.</td>\n</tr>\n<tr>\n<td><em>ownershipType</em></td>\n<td>Required int. <code>OwnershipType</code> enum value.</td>\n</tr>\n<tr>\n<td><em>vendorOrId</em></td>\n<td>Optional string. Preserved from existing record if <code>UpdateProductWS</code> does not override.</td>\n</tr>\n<tr>\n<td><em>defaultPremiumAmount</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>defaultPolicyFeeAmount</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>defaultPolicyFeeCalcPercent</em></td>\n<td>Optional decimal.</td>\n</tr>\n<tr>\n<td><em>mergeFieldMessage1</em> / <em>mergeFieldMessage2</em> / <em>mergeFieldMessage3</em></td>\n<td>Optional merge-field strings.</td>\n</tr>\n<tr>\n<td><em>allowDuplicateTypes</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>includePolicyFeeMAPR</em> / <em>includePremiumMAPR</em> / <em>includePolicyFeeStateAllInAPR</em> / <em>includePremiumStateAllInAPR</em></td>\n<td>Required bool flags.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns a <code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>Ok</code> (0) on success, <code>Error</code> (-1) on validation or save failure.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>On success: <code>{ \"Id\": \"&lt;Guid&gt;\" }</code> for the updated row.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of error messages when <code>statusCode == Error</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Insurance","Product","{{insurance_product_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c3453325-1d36-45ca-a327-ff038edc2005","name":"UpdateProduct - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"productCode\": \"GAP01\",\n    \"description\": \"GAP Insurance - Updated\",\n    \"insuranceType\": 3,\n    \"available\": true,\n    \"ownershipType\": 2,\n    \"vendorOrId\": null,\n    \"defaultPremiumAmount\": 550.00,\n    \"defaultPolicyFeeAmount\": 0.00,\n    \"defaultPolicyFeeCalcPercent\": null,\n    \"mergeFieldMessage1\": null,\n    \"mergeFieldMessage2\": null,\n    \"mergeFieldMessage3\": null,\n    \"allowDuplicateTypes\": false,\n    \"includePolicyFeeMAPR\": false,\n    \"includePremiumMAPR\": false,\n    \"includePolicyFeeStateAllInAPR\": false,\n    \"includePremiumStateAllInAPR\": false\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product/GAP01?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product","GAP01"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"b47a4074-6a02-4bf2-857d-d62e6d14c7c7","name":"UpdateProduct - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"productCode\": \"GAP01\",\n    \"description\": \"GAP Insurance - Updated\",\n    \"insuranceType\": 3,\n    \"available\": true,\n    \"ownershipType\": 2,\n    \"vendorOrId\": null,\n    \"defaultPremiumAmount\": 550.00,\n    \"defaultPolicyFeeAmount\": 0.00,\n    \"defaultPolicyFeeCalcPercent\": null,\n    \"mergeFieldMessage1\": null,\n    \"mergeFieldMessage2\": null,\n    \"mergeFieldMessage3\": null,\n    \"allowDuplicateTypes\": false,\n    \"includePolicyFeeMAPR\": false,\n    \"includePremiumMAPR\": false,\n    \"includePolicyFeeStateAllInAPR\": false,\n    \"includePremiumStateAllInAPR\": false\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Insurance/Product/Nonexistent%20Product?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Insurance","Product","Nonexistent%20Product"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Product not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"8ce19d23-69cc-4098-88ad-bf6a80dc8361"}],"id":"366c5e9b-1ef6-4b2b-8978-e00f5e476b3e","_postman_id":"366c5e9b-1ef6-4b2b-8978-e00f5e476b3e","description":""},{"name":"Originations","item":[{"name":"AgentCreate","id":"9eb20672-ebd2-4912-a28a-5e9de797043e","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"AGT001\",\n  \"name\": \"Alice Agent\",\n  \"active\": true,\n  \"displayReports\": true,\n  \"agentPrograms\": [\n    {\n      \"programNumberOrId\": \"{{originations_program_number_or_id}}\",\n      \"display\": true\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Agent?token={{token}}","description":"<h3 id=\"create-originations-agent\">Create Originations Agent</h3>\n<p>Creates a new <code>Originations.Agent</code> row and any supplied <code>Originations.AgentProgram</code> associations in a single <code>UnitOfWork2</code>. Backed by <code>AgentController.CreateAgent</code> -&gt; <code>AgentWSServices.AddSaveAgentWS(..., isUpdate: false)</code> -&gt; <code>Omega.Originations.BLL.AgentServices.AddSaveAgent</code> + <code>AgentServices.AddSaveDeleteAgentProgram</code>.</p>\n<p>On create the server generates a new <code>Id</code> (Guid) and stamps <code>CreationDateTime</code> using <code>Date.ClientDateTimeNow(loginInfo.ClientTimeZone)</code>. The agent <code>Code</code> must be unique per <code>OmegaClientId</code> — duplicates are rejected via <code>AgentServices.DuplicateAgentCodeExist</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Agent</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>AddSaveAgentParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>agentCodeOrId</em></td>\n<td>String. Ignored on create.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Unique agent code (per client).</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string. Agent display name.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>displayReports</em></td>\n<td>Bool. Controls whether the agent is visible in originations reports.</td>\n</tr>\n<tr>\n<td><em>creationDateTime</em></td>\n<td>DateTime. Ignored on create — server stamps <code>Date.ClientDateTimeNow(loginInfo.ClientTimeZone)</code>.</td>\n</tr>\n<tr>\n<td><em>agentPrograms</em></td>\n<td>Array of <code>AgentProgramEntry</code>. On create, each entry must supply <code>programNumberOrId</code> (Guid or program number) and <code>display</code>. <code>id</code> and <code>ts</code> must be empty on create (any supplied id is treated as an update entry and will fail \"Existing agent program entries must include both id and ts for program ...\"). Duplicate <code>programNumberOrId</code> values are rejected with <code>\"Program '...' is duplicated in the request\"</code>.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].id</em></td>\n<td>String. Must be empty on create.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].ts</em></td>\n<td>String. Must be empty on create.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].programNumberOrId</em></td>\n<td>Required string. Program number or Guid. Resolved via <code>SharedWSServices.GetOriginationsProgramId</code>.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].display</em></td>\n<td>Bool. Whether the program is shown to the agent in the UI.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new agent <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>\"Agent code is required\"</code>, <code>\"Agent name is required\"</code>, <code>\"Duplicate agent code found\"</code>, <code>\"Agent program entry is missing program reference\"</code>, <code>\"Program '...' not found\"</code>, or <code>\"Program '...' is duplicated in the request\"</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Agent"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6cdfb292-b36c-47d7-8508-03adbad7b331","name":"CreateAgent - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"AGT001\",\n  \"name\": \"Alice Agent\",\n  \"active\": true,\n  \"displayReports\": true,\n  \"agentPrograms\": [\n    {\n      \"programNumberOrId\": \"1001\",\n      \"display\": true\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Agent?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Agent"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"00556b1a-3539-46ac-a0ca-ab8d199288e9","name":"CreateAgent - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"\",\n  \"name\": \"Alice Agent\",\n  \"active\": true,\n  \"displayReports\": true,\n  \"agentPrograms\": [\n    {\n      \"programNumberOrId\": \"1001\",\n      \"display\": true\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Agent?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Agent"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Agent code is required\"\n    ]\n}"}],"_postman_id":"9eb20672-ebd2-4912-a28a-5e9de797043e"},{"name":"AgentGet","id":"2e40cde6-8bb5-41a3-bff5-a6675fe3cc9e","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Agent/{{agent_code_or_id}}?token={{token}}","description":"<h3 id=\"get-originations-agent-by-code-or-id\">Get Originations Agent by Code or Id</h3>\n<p>Returns a single <code>Originations.Agent</code> row plus its active and inactive <code>Originations.AgentProgram</code> associations, resolved from <code>{agentCodeOrId}</code>. Backed by <code>AgentController.GetAgent</code> -&gt; <code>AgentWSServices.ReturnAgentWS</code> -&gt; <code>SharedWSServices.GetOriginationsAgentId</code> then <code>Omega.Originations.BLL.AgentServices.ReturnAgent</code> + <code>AgentServices.ReturnAgentProgramsWithAgent(includeInactive: true)</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Agent/{agentCodeOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>agentCodeOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> of the agent or the agent <code>Code</code> scoped to the caller's <code>OmegaClientId</code>. <code>SharedWSServices.GetOriginationsAgentId</code> first tries <code>Guid.TryParse</code>; if that fails it resolves the code via <code>AgentServices.ReturnOriginationsAgentId</code>.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token (query string). May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object with two members:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>agent</em></td>\n<td>The <code>Originations.Agent</code> entity (<code>Id</code>, <code>Ts</code>, <code>Code</code>, <code>Name</code>, <code>Active</code>, <code>DisplayReports</code>, <code>CreationDateTime</code>, etc.).</td>\n</tr>\n<tr>\n<td><em>agentPrograms</em></td>\n<td>Array of <code>Originations.AgentProgram</code> entities for this agent, including inactive rows. Each row exposes <code>Id</code>, <code>Ts</code>, <code>AgentId</code>, <code>ProgramId</code>, and <code>Display</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Agent not found\"]}</code> when neither the Guid nor the code resolves a row, or <code>[\"Agent code or id is required\"]</code> when the route value is empty.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Agent","{{agent_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"90f24941-c1d6-49be-8eb4-e83027b76cf4","name":"GetAgent - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Agent/AGT001?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Agent","AGT001"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"agent\": {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Code\": \"AGT001\",\n            \"Name\": \"Alice Agent\",\n            \"Active\": true,\n            \"DisplayReports\": true,\n            \"CreationDateTime\": \"2024-01-15T09:30:00\"\n        },\n        \"agentPrograms\": [\n            {\n                \"Id\": \"33333333-3333-4333-9333-333333333333\",\n                \"Ts\": \"AAAAAAAACA8=\",\n                \"AgentId\": \"11111111-1111-4111-9111-111111111111\",\n                \"ProgramId\": \"44444444-4444-4444-9444-444444444444\",\n                \"Display\": true\n            },\n            {\n                \"Id\": \"55555555-5555-4555-9555-555555555555\",\n                \"Ts\": \"AAAAAAAACBA=\",\n                \"AgentId\": \"11111111-1111-4111-9111-111111111111\",\n                \"ProgramId\": \"66666666-6666-4666-9666-666666666666\",\n                \"Display\": false\n            }\n        ]\n    },\n    \"errors\": []\n}"},{"id":"74e694ca-34de-4f8a-8777-68eba2503b58","name":"GetAgent - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Agent/NONEXISTENT?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Agent","NONEXISTENT"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Agent not found\"\n    ]\n}"}],"_postman_id":"2e40cde6-8bb5-41a3-bff5-a6675fe3cc9e"},{"name":"AgentPortalConfiguration","id":"655aff19-13bb-4506-b3a8-3003819f231a","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"allowAgentAccess\": true,\n  \"logoImageUrl\": \"https://example.com/agent-logo.png\",\n  \"allowAppEntry\": true,\n  \"newApplicationGroupNumberOrId\": \"{{originations_group_number_or_id}}\",\n  \"existingApplicantUpdateOption\": 1,\n  \"allowViewingDocuments\": true,\n  \"allowUploadingDocuments\": true,\n  \"notesActionCodeOrId\": \"{{action_code_or_id}}\",\n  \"noteReceivedTaskTemplateNumberOrId\": \"{{note_task_template_or_id}}\",\n  \"noteReceivedAssignedToUserLoginOrId\": \"{{assigned_user_login_or_id}}\",\n  \"noteReceivedAssignedToRoleNameOrId\": null,\n  \"applicationReceivedTaskTemplateNumberOrId\": \"{{application_task_template_or_id}}\",\n  \"applicationReceivedAssignedToUserLoginOrId\": null,\n  \"applicationReceivedAssignedToRoleNameOrId\": \"{{assigned_role_name_or_id}}\",\n  \"documentReceivedTaskTemplateNumberOrId\": \"{{document_task_template_or_id}}\",\n  \"documentReceivedAssignedToUserLoginOrId\": \"{{assigned_user_login_or_id}}\",\n  \"documentReceivedAssignedToRoleNameOrId\": null,\n  \"showLegalDisclaimer\": true,\n  \"legalDisclaimer\": \"<p>By submitting an application you confirm...</p>\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration?token={{token}}","description":"<h3 id=\"update-agent-portal-configuration\">Update Agent Portal Configuration</h3>\n<p>Upserts the agent portal configuration row for the caller's <code>OmegaClientId</code>. Backed by <code>AgentPortalConfigurationController.UpdateAgentPortalConfiguration</code> -&gt; <code>AgentPortalConfigurationWSServices.AddSaveAgentPortalConfigurationWS</code> -&gt; <code>Omega.Originations.BLL.PortalConfigurationServices.AddSavePortalConfiguration</code> with <code>PortalTypes.Agent</code>.</p>\n<p>Reference fields are supplied as user-friendly strings (group number, action code, task-template number, user login, role name) or as a Guid. The controller resolves each via <code>SharedWSServices.GetOriginations*Id</code>, <code>GetCommonActionCodeId</code>, <code>GetCommonTaskTemplateId</code>, <code>GetSetupUserId</code>, and <code>GetSetupRoleId</code>. A supplied value that cannot be resolved returns BadRequest with a targeted <code>\"... not found\"</code> error.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateAgentPortalConfigurationParameter</code>. All reference fields accept either a Guid <code>Id</code> or the natural key noted below.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>allowAgentAccess</em></td>\n<td>Bool. Master switch that allows agents into the portal.</td>\n</tr>\n<tr>\n<td><em>logoImageUrl</em></td>\n<td>String. Optional URL of the logo shown on the agent portal.</td>\n</tr>\n<tr>\n<td><em>allowAppEntry</em></td>\n<td>Bool. Whether agents can submit application entries.</td>\n</tr>\n<tr>\n<td><em>newApplicationGroupNumberOrId</em></td>\n<td>String. Originations group number or Guid applied to agent-entered applications. Resolved via <code>SharedWSServices.GetOriginationsGroupId</code>. Returns <code>\"New application group not found\"</code> when the value cannot be resolved.</td>\n</tr>\n<tr>\n<td><em>existingApplicantUpdateOption</em></td>\n<td>Int. <code>ExistingApplicantUpdateOptions</code> enum value.</td>\n</tr>\n<tr>\n<td><em>allowViewingDocuments</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>allowUploadingDocuments</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>notesActionCodeOrId</em></td>\n<td>String. Action-code <code>Code</code> or Guid stamped on notes created by the agent portal. Resolved via <code>SharedWSServices.GetCommonActionCodeId</code>. Returns <code>\"Notes action code not found\"</code> when the value cannot be resolved.</td>\n</tr>\n<tr>\n<td><em>noteReceivedTaskTemplateNumberOrId</em></td>\n<td>String. Task-template number or Guid. Resolved via <code>SharedWSServices.GetCommonTaskTemplateId</code>. The template must target the <code>Credit_Application</code> or <code>View_Account</code> screen.</td>\n</tr>\n<tr>\n<td><em>noteReceivedAssignedToUserLoginOrId</em></td>\n<td>String. User login or Guid the note-received task is assigned to. Required when the role field is empty.</td>\n</tr>\n<tr>\n<td><em>noteReceivedAssignedToRoleNameOrId</em></td>\n<td>String. Role name or Guid the note-received task is assigned to. Required when the user field is empty.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedTaskTemplateNumberOrId</em></td>\n<td>String. Task-template number or Guid. Template must target the <code>Credit_Application</code> screen.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedAssignedToUserLoginOrId</em></td>\n<td>String. User login or Guid. Required when the role field is empty.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedAssignedToRoleNameOrId</em></td>\n<td>String. Role name or Guid. Required when the user field is empty.</td>\n</tr>\n<tr>\n<td><em>documentReceivedTaskTemplateNumberOrId</em></td>\n<td>String. Task-template number or Guid. Template must target the <code>Credit_Application</code> screen.</td>\n</tr>\n<tr>\n<td><em>documentReceivedAssignedToUserLoginOrId</em></td>\n<td>String. User login or Guid. Required when the role field is empty.</td>\n</tr>\n<tr>\n<td><em>documentReceivedAssignedToRoleNameOrId</em></td>\n<td>String. Role name or Guid. Required when the user field is empty.</td>\n</tr>\n<tr>\n<td><em>showLegalDisclaimer</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>legalDisclaimer</em></td>\n<td>String. HTML/text. Required (non-empty) when <code>showLegalDisclaimer</code> is true.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Guid <code>Id</code> of the saved <code>Originations.PortalConfiguration</code> row (string).</p>\n<p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"...\"]}</code> for any of: <code>\"The 'New Application Group' could not be found.\"</code>, <code>\"The 'Notes Action Code' could not be found.\"</code>, <code>\"Legal Disclaimer must be completed.\"</code>, or task-template screen validation failures such as <code>\"The 'Note Received Task Template' must be configured to use a screen of 'Credit Application' or 'View Account'\"</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","AgentPortalConfiguration"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e856d552-c4b6-436c-9c22-db82977d648a","name":"UpdateAgentPortalConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"allowAgentAccess\": true,\n  \"logoImageUrl\": \"https://example.com/agent-logo.png\",\n  \"allowAppEntry\": true,\n  \"newApplicationGroupNumberOrId\": \"1001\",\n  \"existingApplicantUpdateOption\": 1,\n  \"allowViewingDocuments\": true,\n  \"allowUploadingDocuments\": true,\n  \"notesActionCodeOrId\": \"NOTE\",\n  \"noteReceivedTaskTemplateNumberOrId\": \"100\",\n  \"noteReceivedAssignedToUserLoginOrId\": \"developer\",\n  \"noteReceivedAssignedToRoleNameOrId\": null,\n  \"applicationReceivedTaskTemplateNumberOrId\": \"101\",\n  \"applicationReceivedAssignedToUserLoginOrId\": null,\n  \"applicationReceivedAssignedToRoleNameOrId\": \"Credit Analyst\",\n  \"documentReceivedTaskTemplateNumberOrId\": \"102\",\n  \"documentReceivedAssignedToUserLoginOrId\": \"developer\",\n  \"documentReceivedAssignedToRoleNameOrId\": null,\n  \"showLegalDisclaimer\": true,\n  \"legalDisclaimer\": \"<p>By submitting an application you confirm...</p>\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","AgentPortalConfiguration"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"d913ce80-d21e-4212-84ac-e218798b0c3b","name":"UpdateAgentPortalConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"allowAgentAccess\": true,\n  \"logoImageUrl\": \"https://example.com/agent-logo.png\",\n  \"allowAppEntry\": true,\n  \"newApplicationGroupNumberOrId\": \"9999\",\n  \"existingApplicantUpdateOption\": 1,\n  \"allowViewingDocuments\": true,\n  \"allowUploadingDocuments\": true,\n  \"notesActionCodeOrId\": \"NOTE\",\n  \"noteReceivedTaskTemplateNumberOrId\": \"100\",\n  \"noteReceivedAssignedToUserLoginOrId\": \"developer\",\n  \"noteReceivedAssignedToRoleNameOrId\": null,\n  \"applicationReceivedTaskTemplateNumberOrId\": \"101\",\n  \"applicationReceivedAssignedToUserLoginOrId\": null,\n  \"applicationReceivedAssignedToRoleNameOrId\": \"Credit Analyst\",\n  \"documentReceivedTaskTemplateNumberOrId\": \"102\",\n  \"documentReceivedAssignedToUserLoginOrId\": \"developer\",\n  \"documentReceivedAssignedToRoleNameOrId\": null,\n  \"showLegalDisclaimer\": true,\n  \"legalDisclaimer\": \"<p>By submitting an application you confirm...</p>\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","AgentPortalConfiguration"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"The 'New Application Group' could not be found.\"\n    ]\n}"}],"_postman_id":"655aff19-13bb-4506-b3a8-3003819f231a"},{"name":"AgentPortalConfiguration","id":"59087bd1-b8ce-4924-82fb-06b567dff898","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration?token={{token}}","description":"<h3 id=\"get-agent-portal-configuration\">Get Agent Portal Configuration</h3>\n<p>Returns the current agent portal configuration row for the caller's <code>OmegaClientId</code>. Backed by <code>AgentPortalConfigurationController.GetAgentPortalConfiguration</code> -&gt; <code>AgentPortalConfigurationWSServices.GetAgentPortalConfigurationWS</code> -&gt; <code>Omega.Originations.BLL.PortalConfigurationServices.ReturnPortalConfiguration</code> with <code>PortalTypes.Agent</code>. This is a separate row from the dealer and customer portal configuration endpoints.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the agent portal configuration projection:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid. <code>Originations.PortalConfiguration.Id</code>.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Base64 string. Row timestamp used for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>portalType</em></td>\n<td>Int. <code>PortalTypes.Agent</code> (<code>3</code>).</td>\n</tr>\n<tr>\n<td><em>omegaClientId</em></td>\n<td>Guid. Client the configuration belongs to.</td>\n</tr>\n<tr>\n<td><em>allowAgentAccess</em></td>\n<td>Bool. Master switch that allows agents into the portal (stored as <code>AllowDealerAccess</code> on the shared configuration row).</td>\n</tr>\n<tr>\n<td><em>logoImageUrl</em></td>\n<td>String. Optional URL of the logo shown on the agent portal.</td>\n</tr>\n<tr>\n<td><em>allowAppEntry</em></td>\n<td>Bool. Whether agents can submit application entries.</td>\n</tr>\n<tr>\n<td><em>newApplicationGroupId</em></td>\n<td>Guid. Default originations group applied to agent-entered applications.</td>\n</tr>\n<tr>\n<td><em>existingApplicantUpdateOption</em></td>\n<td>Int. <code>ExistingApplicantUpdateOptions</code> enum controlling how existing applicants are updated on entry.</td>\n</tr>\n<tr>\n<td><em>allowViewingDocuments</em></td>\n<td>Bool. Whether agents can view documents.</td>\n</tr>\n<tr>\n<td><em>allowUploadingDocuments</em></td>\n<td>Bool. Whether agents can upload documents.</td>\n</tr>\n<tr>\n<td><em>notesActionCodeId</em></td>\n<td>Guid. <code>Common.ActionCode.Id</code> stamped on notes created by the agent portal.</td>\n</tr>\n<tr>\n<td><em>noteReceivedTaskTemplateId</em></td>\n<td>Guid. Task template auto-created when an agent note is received. Must target the <code>Credit_Application</code> or <code>View_Account</code> screen.</td>\n</tr>\n<tr>\n<td><em>noteReceivedAssignedToUserId</em></td>\n<td>Guid. User the note-received task is assigned to. Required when the role is not set.</td>\n</tr>\n<tr>\n<td><em>noteReceivedAssignedToRoleId</em></td>\n<td>Guid. Role the note-received task is assigned to. Required when the user is not set.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedTaskTemplateId</em></td>\n<td>Guid. Task template auto-created when an agent submits an application. Must target the <code>Credit_Application</code> screen.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedAssignedToUserId</em></td>\n<td>Guid. User the application-received task is assigned to. Required when the role is not set.</td>\n</tr>\n<tr>\n<td><em>applicationReceivedAssignedToRoleId</em></td>\n<td>Guid. Role the application-received task is assigned to. Required when the user is not set.</td>\n</tr>\n<tr>\n<td><em>documentReceivedTaskTemplateId</em></td>\n<td>Guid. Task template auto-created when an agent uploads a document. Must target the <code>Credit_Application</code> screen.</td>\n</tr>\n<tr>\n<td><em>documentReceivedAssignedToUserId</em></td>\n<td>Guid. User the document-received task is assigned to. Required when the role is not set.</td>\n</tr>\n<tr>\n<td><em>documentReceivedAssignedToRoleId</em></td>\n<td>Guid. Role the document-received task is assigned to. Required when the user is not set.</td>\n</tr>\n<tr>\n<td><em>showLegalDisclaimer</em></td>\n<td>Bool. Whether the legal disclaimer is shown on the agent portal.</td>\n</tr>\n<tr>\n<td><em>legalDisclaimer</em></td>\n<td>String. Legal disclaimer HTML/text. Required when <code>showLegalDisclaimer</code> is true.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"...\"]}</code> when the configuration cannot be loaded.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","AgentPortalConfiguration"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"28d0819c-1a99-4aeb-9c77-620ba8d65fbd","name":"GetAgentPortalConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","AgentPortalConfiguration"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"11111111-1111-4111-9111-111111111111\",\n        \"ts\": \"AAAAAAAACA4=\",\n        \"portalType\": 3,\n        \"omegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n        \"allowAgentAccess\": true,\n        \"logoImageUrl\": \"https://example.com/agent-logo.png\",\n        \"allowAppEntry\": true,\n        \"newApplicationGroupId\": \"33333333-3333-4333-9333-333333333333\",\n        \"existingApplicantUpdateOption\": 1,\n        \"allowViewingDocuments\": true,\n        \"allowUploadingDocuments\": true,\n        \"notesActionCodeId\": \"44444444-4444-4444-9444-444444444444\",\n        \"noteReceivedTaskTemplateId\": \"55555555-5555-4555-9555-555555555555\",\n        \"noteReceivedAssignedToUserId\": \"66666666-6666-4666-9666-666666666666\",\n        \"noteReceivedAssignedToRoleId\": null,\n        \"applicationReceivedTaskTemplateId\": \"77777777-7777-4777-9777-777777777777\",\n        \"applicationReceivedAssignedToUserId\": null,\n        \"applicationReceivedAssignedToRoleId\": \"88888888-8888-4888-9888-888888888888\",\n        \"documentReceivedTaskTemplateId\": \"99999999-9999-4999-9999-999999999999\",\n        \"documentReceivedAssignedToUserId\": \"66666666-6666-4666-9666-666666666666\",\n        \"documentReceivedAssignedToRoleId\": null,\n        \"showLegalDisclaimer\": true,\n        \"legalDisclaimer\": \"<p>By submitting an application you confirm...</p>\"\n    },\n    \"errors\": []\n}"},{"id":"72c29d63-83bf-4d3f-ad21-aff06e00a243","name":"GetAgentPortalConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/AgentPortalConfiguration?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","AgentPortalConfiguration"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving agent portal configuration\"\n    ]\n}"}],"_postman_id":"59087bd1-b8ce-4924-82fb-06b567dff898"},{"name":"AgentUpdate","id":"dfd049bc-1831-49d1-9972-6eb46030fc54","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"AGT001\",\n  \"name\": \"Alice Agent (updated)\",\n  \"active\": true,\n  \"displayReports\": true,\n  \"agentPrograms\": [\n    {\n      \"id\": \"{{agent_program_id}}\",\n      \"ts\": \"{{agent_program_ts}}\",\n      \"programNumberOrId\": \"{{originations_program_number_or_id}}\",\n      \"display\": true\n    },\n    {\n      \"programNumberOrId\": \"{{additional_program_number_or_id}}\",\n      \"display\": false\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Agent/{{agent_code_or_id}}?token={{token}}","description":"<h3 id=\"update-originations-agent\">Update Originations Agent</h3>\n<p>Updates an existing <code>Originations.Agent</code> row and reconciles its <code>Originations.AgentProgram</code> entries in a single <code>UnitOfWork2</code>. Backed by <code>AgentController.UpdateAgent</code> -&gt; <code>AgentWSServices.AddSaveAgentWS(..., isUpdate: true)</code> -&gt; <code>Omega.Originations.BLL.AgentServices.AddSaveAgent</code> + <code>AgentServices.AddSaveDeleteAgentProgram</code>.</p>\n<p>The route <code>{agentCodeOrId}</code> is resolved via <code>SharedWSServices.GetOriginationsAgentId</code> (Guid first, then <code>AgentServices.ReturnOriginationsAgentId</code> by code). The existing <code>Id</code>, <code>Ts</code>, and <code>CreationDateTime</code> are preserved by the server; clients should not attempt to rewrite them.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Agent/{agentCodeOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>agentCodeOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> of the agent or the agent <code>Code</code> scoped to the caller's <code>OmegaClientId</code>.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>AddSaveAgentParameter</code>. The controller copies <code>{agentCodeOrId}</code> into <code>param.agentCodeOrId</code> before calling the WS service, so the body value is not required.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Agent code. Duplicate codes within the client are rejected unless the duplicate is this same row.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>displayReports</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>creationDateTime</em></td>\n<td>DateTime. Ignored — original value is preserved.</td>\n</tr>\n<tr>\n<td><em>agentPrograms</em></td>\n<td>Array of <code>AgentProgramEntry</code>. Existing entries must supply both <code>id</code> (Guid) and <code>ts</code> (base64 timestamp); new entries must supply neither. Duplicate <code>programNumberOrId</code> values across the array are rejected. Any existing program not represented in the array is deleted.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].id</em></td>\n<td>String. Existing row Guid, or empty for a new row.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].ts</em></td>\n<td>String. Base64 timestamp of the existing row, or empty for a new row. Converted via <code>Convert.FromBase64String</code>; invalid values return <code>\"Invalid agent program ts\"</code>.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].programNumberOrId</em></td>\n<td>Required string. Program number or Guid.</td>\n</tr>\n<tr>\n<td><em>agentPrograms[].display</em></td>\n<td>Bool.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the agent <code>Id</code> as a string.</p>\n<p>Returns BadRequest with errors such as <code>\"Agent not found\"</code>, <code>\"Agent code is required\"</code>, <code>\"Agent name is required\"</code>, <code>\"Duplicate agent code found\"</code>, <code>\"Existing agent program entries must include both id and ts for program '...'\"</code>, <code>\"Invalid agent program id\"</code>, <code>\"Invalid agent program ts\"</code>, or <code>\"Program '...' is duplicated in the request\"</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Agent","{{agent_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fcd3740b-8ca2-4631-a4d0-df6508b0666b","name":"UpdateAgent - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"AGT001\",\n  \"name\": \"Alice Agent (updated)\",\n  \"active\": true,\n  \"displayReports\": true,\n  \"agentPrograms\": [\n    {\n      \"id\": \"33333333-3333-4333-9333-333333333333\",\n      \"ts\": \"AAAAAAAACA8=\",\n      \"programNumberOrId\": \"1001\",\n      \"display\": true\n    },\n    {\n      \"programNumberOrId\": \"1002\",\n      \"display\": false\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Agent/AGT001?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Agent","AGT001"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"ef098d46-06e5-4fe4-97c7-7c41cf854389","name":"UpdateAgent - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"code\": \"AGT001\",\n  \"name\": \"Alice Agent (updated)\",\n  \"active\": true,\n  \"displayReports\": true,\n  \"agentPrograms\": [\n    {\n      \"id\": \"33333333-3333-4333-9333-333333333333\",\n      \"ts\": \"AAAAAAAACA8=\",\n      \"programNumberOrId\": \"1001\",\n      \"display\": true\n    },\n    {\n      \"programNumberOrId\": \"1002\",\n      \"display\": false\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Agent/NONEXISTENT?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Agent","NONEXISTENT"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Agent not found\"\n    ]\n}"}],"_postman_id":"dfd049bc-1831-49d1-9972-6eb46030fc54"},{"name":"ApplicationCustomSummaryGet","id":"af1ddec4-9b48-4ddc-ad16-53541768a9d8","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Application/{{originations_application_number_or_id}}/CustomSummary?token={{token}}","description":"<h3 id=\"get-originations-application-custom-summary\">Get Originations Application Custom Summary</h3>\n<p>Returns the class-driven summary that the Omega UI shows on the Application Summary screen. Backed by <code>ApplicationCustomSummaryController.GetCustomSummary</code> -&gt; <code>ApplicationCustomSummaryWSServices.GetWS</code>.</p>\n<p>The controller resolves <code>accountNumberOrId</code> via <code>Guid.TryParse</code> (the application <code>Id</code>) then <code>long.TryParse</code> + <code>ApplicationServices.ReturnApplicationId(databaseName, clientId, applicationNumber)</code>. When resolution fails it returns <code>BadRequest</code> with <code>\"Application not found\"</code>.</p>\n<p><code>GetWS</code> then:</p>\n<ul>\n<li><p>builds a <code>Megasys.Framework.Types.SensitiveOperationParameters</code> from\n<code>OmegaConfiguration.CurrentConfigurationKey</code> + <code>UserIsMegasysStaff</code>,</p>\n</li>\n<li><p>loads the full application via\n<code>LoanApplicationData.GetLoanApplicationEntity(databaseName, applicationId, null, GetEntityTypes.OriginationAccountEntry, clientDateTimeNow, userId, sensitiveOperationParameters)</code>. A null or\nthrowing result returns <code>\"Application not found. The application must be saved before the summary can be viewed.\"</code>,</p>\n</li>\n<li><p>enforces <code>loginInfo.ClientId == loanApplicationData.commonAccount.OmegaClientId</code> and returns\n<code>\"Security error\"</code> on mismatch,</p>\n</li>\n<li><p>calls\n<code>ClassSummaryFieldServices.GetFieldsForClass(loanApplicationData.commonAccount.ClassId, databaseName)</code> to pull the configured <code>OriginationsClassSummaryField</code>\nrows. An empty set returns <code>\"No fields have been selected to display. Configure the layout of this screen in 'Class Maintenance' under the 'Originations' tab\"</code>,</p>\n</li>\n<li><p>iterates each field, casts <code>field.Field</code> to\n<code>Omega.Originations.Types.OriginationsSummaryField</code>, and appends rows via\nthe private <code>BuildFieldRows</code> helper. Row labels come from the enum name\nwith underscores replaced by spaces and a trailing colon appended;\nblank-label rows are used as spacers. Supported cases include\n<code>Account_Number</code>, <code>Addresses</code>, <code>Application_Status</code>, <code>Class</code>,\n<code>Collateral</code>, <code>Group</code>, <code>Current_Mode</code>, <code>Customer_Ages</code>,\n<code>Customer_Employers</code>, <code>Customer_Names</code>, <code>Customer_References</code>,\n<code>Customer_Phones</code>, <code>Dealer</code>, <code>Program</code>, <code>Regular_Payment_Amount</code>,\n<code>Term</code>, <code>Verified_Collateral</code>, <code>Verified_Customer</code>,\n<code>Verified_Loan_Information</code>, <code>Notes</code>, <code>Disbursement_Amount</code>,\n<code>Down_Payment</code>, <code>Trade_In</code>, <code>Debt_To_Income_Ratio</code>,\n<code>Credit_Score_Experian</code> / <code>_Equifax</code> / <code>_TransUnion</code>,\n<code>Down_Payment_Percentage</code>, <code>Amount_Financed</code>, <code>Customer_Expenses</code>,\n<code>Customer_Other_Income</code>, <code>Recourse_Term</code>, <code>APR</code>, <code>MilitaryAPR</code>,\n<code>Insurance_Lender_Policies</code> (Gold edition also emits a \"Dealer Markup\"\nsub-row via <code>Omega.Framework.BLL.Edition.CheckEdition(EditionTypes.Gold, clientEdition)</code>), <code>Insurance_Dealer_Policies</code>, <code>VIN</code> (masked to the\nlast 6 characters prefixed with <code>****</code>), <code>Vehicle_Color</code>, and\n<code>Contractual_State_All_In_APR</code>,</p>\n</li>\n<li><p>builds the header as `\"Summary for Application \" + AccountNumber + \" - \"</p>\n<ul>\n<li>clientDateTimeNow.ToShortDateString() + \" \" +\nclientDateTimeNow.ToShortTimeString()`.</li>\n</ul>\n</li>\n</ul>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Application/{accountNumberOrId}/CustomSummary</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Either the <code>OriginationsApplication.Id</code> (Guid) or the numeric <code>CommonAccount.AccountNumber</code>. Blank returns <code>StandardAPIErrors.INVALID_PARAMETER_ERROR_MESSAGE</code>; unresolvable values return <code>\"Application not found\"</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> matches <code>ApplicationCustomSummaryResultDto</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumber</em></td>\n<td>Long. <code>CommonAccount.AccountNumber</code> for the resolved application.</td>\n</tr>\n<tr>\n<td><em>header</em></td>\n<td>String. <code>\"Summary for Application {AccountNumber} - {ShortDate} {ShortTime}\"</code> as formatted by the caller's time zone.</td>\n</tr>\n<tr>\n<td><em>rows</em></td>\n<td>Array of <code>{ label, value }</code> entries. The order and content mirror the configured <code>OriginationsClassSummaryField</code> list. Blank-label rows are used as spacers.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Errors return as <code>BadRequest</code> with the messages listed above or <code>\"Error retrieving application custom summary: {message}\"</code>.</p>\n<h4 id=\"bulk-variant\">Bulk variant</h4>\n<p>Process one to 250 accounts in one call: <code>POST api/Client/Originations/Application/Bulk/GetCustomSummary</code>. Each <code>accountNumberOrId</code> is a <code>Common.Account</code> number or Id resolved to its linked Originations application. See <strong>Bulk Get Originations Application Custom Summary</strong> in this collection.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application","{{originations_application_number_or_id}}","CustomSummary"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5c02dbc7-a022-4478-b8fd-c78f16aab94e","name":"GetApplicationCustomSummary - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/300012100/CustomSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","300012100","CustomSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"accountNumber\": 300012100,\n        \"header\": \"Summary for Application 300012100 - 4/18/2026 10:15 AM\",\n        \"rows\": [\n            { \"label\": \"Account Number:\", \"value\": \"300012100\" },\n            { \"label\": \"Application Status:\", \"value\": \"Approved Pending Funding\" },\n            { \"label\": \"Class:\", \"value\": \"Consumer Loan\" },\n            { \"label\": \"Group:\", \"value\": \"Default\" },\n            { \"label\": \"Dealer:\", \"value\": \"ABC Motors\" },\n            { \"label\": \"Program:\", \"value\": \"Standard 60\" },\n            { \"label\": \"Customer Names:\", \"value\": \"Doe, Jane A\" },\n            { \"label\": \"Amount Financed:\", \"value\": \"$10,000.00\" },\n            { \"label\": \"Down Payment:\", \"value\": \"$1,000.00\" },\n            { \"label\": \"Regular Payment Amount:\", \"value\": \"$199.25\" },\n            { \"label\": \"Term:\", \"value\": \"60\" },\n            { \"label\": \"APR:\", \"value\": \"6.9999%\" },\n            { \"label\": \"VIN:\", \"value\": \"****AB1234\" },\n            { \"label\": \"Vehicle Color:\", \"value\": \"Blue\" }\n        ]\n    },\n    \"errors\": []\n}"},{"id":"f4f3fcdb-ca8f-4584-8ee2-9ebf71b99bf3","name":"GetApplicationCustomSummary - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/999999999/CustomSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","999999999","CustomSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Application not found\"\n    ]\n}"}],"_postman_id":"af1ddec4-9b48-4ddc-ad16-53541768a9d8"},{"name":"ApplicationCustomSummaryGetBulk","id":"a721d263-94a2-49ee-ae39-ae7a86d3f36d","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Originations/Application/Bulk/GetCustomSummary?token={{token}}","description":"<h3 id=\"bulk-get-originations-application-custom-summary\">Bulk Get Originations Application Custom Summary</h3>\n<p>Returns class-driven application summaries for several accounts. The body must be an array containing one to 250 items. Each <code>accountNumberOrId</code> accepts a <code>Common.Account</code> number or Id. Every summary can contain a configured list of customer, collateral, insurance, and loan fields. Token or API-key authentication is required.</p>\n<p>This route reuses the API Access permission for <code>GET api/Client/Originations/Application/{accountNumberOrId}/CustomSummary</code>. Check the response <code>statusCode</code> and per-account rows; a processed batch can return HTTP 200 with <code>Successful_With_Error</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application","Bulk","GetCustomSummary"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"14997bb9-bc0b-46a3-8659-0d04d1d36ef8","name":"ApplicationCustomSummaryGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/Bulk/GetCustomSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","Bulk","GetCustomSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 2,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"accountNumber\": 30001212,\n          \"header\": \"Summary for Application 30001212 - 4/18/2026 10:15 AM\",\n          \"rows\": [\n            {\n              \"label\": \"Account Number:\",\n              \"value\": \"30001212\"\n            },\n            {\n              \"label\": \"Application Status:\",\n              \"value\": \"Approved Pending Funding\"\n            },\n            {\n              \"label\": \"Amount Financed:\",\n              \"value\": \"$10,000.00\"\n            }\n          ]\n        }\n      },\n      {\n        \"accountNumber\": 30001213,\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"accountNumber\": 30001213,\n          \"header\": \"Summary for Application 30001213 - 4/18/2026 10:15 AM\",\n          \"rows\": [\n            {\n              \"label\": \"Account Number:\",\n              \"value\": \"30001213\"\n            }\n          ]\n        }\n      }\n    ]\n  }\n}"},{"id":"4133639e-3443-40ee-96f2-92615fa520ad","name":"ApplicationCustomSummaryGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/Bulk/GetCustomSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","Bulk","GetCustomSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": {\n          \"accountNumber\": 30001212,\n          \"header\": \"Summary for Application 30001212 - 4/18/2026 10:15 AM\",\n          \"rows\": [\n            {\n              \"label\": \"Account Number:\",\n              \"value\": \"30001212\"\n            },\n            {\n              \"label\": \"Application Status:\",\n              \"value\": \"Approved Pending Funding\"\n            },\n            {\n              \"label\": \"Amount Financed:\",\n              \"value\": \"$10,000.00\"\n            }\n          ]\n        }\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"9db321dd-161f-4370-9794-47d745342688","name":"ApplicationCustomSummaryGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/Bulk/GetCustomSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","Bulk","GetCustomSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"8e1e9871-094e-4150-a9a5-871cc92207cc","name":"ApplicationCustomSummaryGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/Bulk/GetCustomSummary?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","Bulk","GetCustomSummary"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"a721d263-94a2-49ee-ae39-ae7a86d3f36d"},{"name":"ApplicationSave","id":"f08f481f-bbc1-4e30-90cb-c8f3535e58b8","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"loanApplication\": {\n    \"Id\": \"{{originations_application_id}}\",\n    \"GroupId\": \"{{originations_group_id}}\",\n    \"ProgramId\": \"{{originations_program_id}}\",\n    \"ApplicationStatus\": \"Entry_In_Progress\",\n    \"CurrentMode\": \"Entry\",\n    \"ApplicationDate\": \"2026-04-18T00:00:00\",\n    \"commonAccount\": {\n      \"Id\": \"{{originations_common_account_id}}\",\n      \"BranchId\": \"{{setup_branch_id}}\",\n      \"ClassId\": \"{{common_class_id}}\",\n      \"InternalStatus\": \"Loan_Application\",\n      \"AdminStatusId\": \"{{common_admin_status_id}}\",\n      \"AccountSourceCodeId\": \"{{common_account_source_code_id}}\",\n      \"commonAccountCustomers\": [],\n      \"commonAccountDirect\": {\n        \"Id\": \"{{originations_common_account_direct_id}}\"\n      }\n    }\n  }\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Application?token={{token}}","description":"<h3 id=\"save-originations-application\">Save Originations Application</h3>\n<p>Persists the full <code>LoanApplicationData</code> envelope produced by <code>CreateApplicationSession</code> (or rehydrated from an existing application). Backed by <code>ApplicationController.SaveApplication</code> -&gt; <code>ApplicationWSServices.SaveApplicationWS</code> -&gt; <code>Omega.Originations.Shared.ApplicationServices.AddSaveApplicationEntry</code> inside a single <code>UnitOfWork2</code> that is committed via <code>Omega.Framework.BLL.Database.Transaction.CommitTransaction</code>.</p>\n<p>Before saving, the server rebinds the readonly <code>commonAccount.DatabaseName</code> to <code>loginInfo.DatabaseName</code> via reflection and stamps <code>OmegaClientId</code>, <code>ClientNumber</code>, <code>ClientTimeZone</code>, <code>LastChangedByUserId</code>, <code>LastChangedByUser</code>, <code>CurrentBusinessDate</code>, <code>LastChangeBranchDate</code>, and <code>LastChangedBy</code>. Client edition is resolved via <code>SetupInternal.ClientServices.ReturnInternalClientWithId</code> and passed through to the save so edition-guarded fields behave consistently with the screens.</p>\n<p><code>AddSaveApplicationEntry</code> validates the payload, writes <code>Common.Account</code>, <code>Originations.Application</code>, and every owned child collection (customers, addresses, phones, collateral, employers, references, income/expense, decline / counter-offer reason lists, custom screen fields, etc.) and triggers document / notification pipelines.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Application</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>SaveApplicationParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>loanApplication</em></td>\n<td>Required <code>LoanApplicationData</code>. The full envelope the caller received from <code>POST /api/Client/Originations/Application/Session</code> (for new applications) or rehydrated from an existing application, with customer, collateral, financial, and class-driven summary fields filled in. Must include a <code>commonAccount</code>; a missing <code>commonAccount</code> returns <code>\"Loan application common account is required\"</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the application <code>Id</code> (Guid) that was saved.</p>\n<p>Returns <code>BadRequest</code> with <code>\"Loan application is required\"</code> when <code>loanApplication</code> is missing, <code>\"Loan application common account is required\"</code> when <code>commonAccount</code> is missing, or whatever validation / persistence error bubbles out of <code>AddSaveApplicationEntry</code> (for example missing required customers, invalid reason references, or sensitive-field policy violations).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ee8bb1a2-4547-4bc4-99c2-2a9c98169847","name":"SaveApplication - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"loanApplication\": {\n    \"Id\": \"22222222-2222-4222-9222-222222222222\",\n    \"GroupId\": \"33333333-3333-4333-9333-333333333333\",\n    \"ProgramId\": \"44444444-4444-4444-9444-444444444444\",\n    \"ApplicationStatus\": \"Entry_In_Progress\",\n    \"CurrentMode\": \"Entry\",\n    \"ApplicationDate\": \"2026-04-18T00:00:00\",\n    \"commonAccount\": {\n      \"Id\": \"55555555-5555-4555-9555-555555555555\",\n      \"BranchId\": \"77777777-7777-4777-9777-777777777777\",\n      \"ClassId\": \"88888888-8888-4888-9888-888888888888\",\n      \"InternalStatus\": \"Loan_Application\",\n      \"AdminStatusId\": \"99999999-9999-4999-9999-999999999999\",\n      \"AccountSourceCodeId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n      \"commonAccountCustomers\": [],\n      \"commonAccountDirect\": {\n        \"Id\": \"bbbbbbbb-bbbb-4bbb-9bbb-bbbbbbbbbbbb\"\n      }\n    }\n  }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"22222222-2222-4222-9222-222222222222\",\n    \"errors\": []\n}"},{"id":"bd2e652a-2320-437a-88b7-6712db6475bc","name":"SaveApplication - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"loanApplication\": {\n    \"Id\": \"22222222-2222-4222-9222-222222222222\",\n    \"GroupId\": \"33333333-3333-4333-9333-333333333333\",\n    \"ProgramId\": \"44444444-4444-4444-9444-444444444444\",\n    \"ApplicationStatus\": \"Entry_In_Progress\",\n    \"CurrentMode\": \"Entry\",\n    \"ApplicationDate\": \"2026-04-18T00:00:00\"\n  }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Loan application common account is required\"\n    ]\n}"}],"_postman_id":"f08f481f-bbc1-4e30-90cb-c8f3535e58b8"},{"name":"ApplicationSessionCreate","id":"422cc0ad-1493-4344-9d29-cb8f6bd6ffc7","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"programNumberOrId\": \"{{originations_program_number_or_id}}\",\n  \"groupNumberOrId\": \"{{originations_group_number_or_id}}\",\n  \"classNumberOrId\": \"{{common_class_number_or_id}}\",\n  \"branchNumberOrId\": \"{{setup_branch_number_or_id}}\",\n  \"dealerId\": null,\n  \"applicationDate\": null,\n  \"dealerCodeOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Application/Session?token={{token}}","description":"<h3 id=\"create-application-session\">Create Application Session</h3>\n<p>Returns an initialized <code>LoanApplicationData</code> the Originations entry screen can round-trip through <code>SaveApplication</code>. Backed by <code>ApplicationController.CreateApplicationSession</code> -&gt; <code>ApplicationWSServices.CreateSessionWS</code>. Nothing is persisted until the caller posts the returned payload back to <code>POST /api/Client/Originations/Application</code>.</p>\n<p>The server resolves the supplied identifiers via <code>SharedWSServices.GetOriginationsProgramId</code>, <code>GetOriginationsGroupId</code>, <code>GetCommonClassId</code>, and <code>GetSetupBranchId</code>. Any identifier that fails to resolve returns <code>BadRequest</code> with the matching <code>\"Program could not be resolved\"</code>, <code>\"Group could not be resolved\"</code>, <code>\"Class could not be resolved\"</code>, or <code>\"Branch could not be resolved\"</code> error. Missing common configuration returns <code>\"Common Configuration has not been set up.\"</code>.</p>\n<p>On success the server:</p>\n<ul>\n<li><p>generates a new <code>Id</code> for the application and for its <code>commonAccount</code>,</p>\n</li>\n<li><p>stamps <code>CreationBranchDate</code>, <code>CurrentBusinessDate</code>, <code>ApplicationDate</code>\n(overridable via <code>applicationDate</code>), and <code>CreationServerDate</code>,</p>\n</li>\n<li><p>sets <code>ApplicationStatus = Entry_In_Progress</code>,\n<code>CurrentMode = Entry</code>, and <code>InternalStatus = Loan_Application</code>,</p>\n</li>\n<li><p>defaults <code>AdminStatusId</code> from\n<code>ExternalMasterConfiguration.DefaultNewAccountAdminStatus</code>, then overrides\nwith <code>Group.EntryInProgressAdministrativeStatus</code> when the group has one,</p>\n</li>\n<li><p>defaults <code>AccountSourceCodeId</code> from\n<code>ExternalMasterConfiguration.DefaultSourceCodeId</code>,</p>\n</li>\n<li><p>when <code>dealerId</code> is supplied, resolves the dealer via\n<code>DealerServices.ReturnDealer</code>, initializes <code>commonAccount.commonAccountIndirect</code>\nwith <code>DealerId</code>/<code>DealerCode</code>, and copies the dealer's <code>PrimarySalesRepId</code>\nand <code>PrimaryTerritorialRepId</code> onto the account; otherwise it initializes\n<code>commonAccount.commonAccountDirect</code>.</p>\n</li>\n</ul>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Application/Session</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CreateApplicationSessionParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>programNumberOrId</em></td>\n<td>Required string. Originations program number or Guid. Resolved via <code>SharedWSServices.GetOriginationsProgramId</code>.</td>\n</tr>\n<tr>\n<td><em>groupNumberOrId</em></td>\n<td>Required string. Originations group number or Guid. Resolved via <code>SharedWSServices.GetOriginationsGroupId</code>.</td>\n</tr>\n<tr>\n<td><em>classNumberOrId</em></td>\n<td>Required string. Common class number or Guid. Resolved via <code>SharedWSServices.GetCommonClassId</code>.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Optional string. Setup branch number or Guid. When blank the server uses <code>loginInfo.CurrentBranchId</code>.</td>\n</tr>\n<tr>\n<td><em>dealerId</em></td>\n<td>Optional Guid. When supplied the session initializes <code>commonAccountIndirect</code> and copies the dealer's sales reps; when omitted it initializes <code>commonAccountDirect</code>.</td>\n</tr>\n<tr>\n<td><em>applicationDate</em></td>\n<td>Optional DateTime. Defaults to <code>Date.ClientDateTimeNow(loginInfo.TimeZoneId)</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the fully initialized <code>LoanApplicationData</code> envelope. The caller should populate customer, collateral, financial, and any other screen fields and post the full object back to <code>POST /api/Client/Originations/Application</code>.</p>\n<p>Returns <code>BadRequest</code> with one of the resolution errors above or <code>\"Parameters are required\"</code> when the body is empty.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>dealerCodeOrId</code></td>\n<td><code>dealerId</code></td>\n<td>String. dealer/vendor code or dealer GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"dealerCodeOrId\": \"DEALER1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application","Session"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7128a70f-8d7a-4abb-80be-593115eb5e9d","name":"CreateApplicationSession - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"programNumberOrId\": \"1001\",\n  \"groupNumberOrId\": \"500\",\n  \"classNumberOrId\": \"AUTO\",\n  \"branchNumberOrId\": \"1\",\n  \"dealerId\": null,\n  \"applicationDate\": null,\n  \"dealerCodeOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/Session?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","Session"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"22222222-2222-4222-9222-222222222222\",\n        \"GroupId\": \"33333333-3333-4333-9333-333333333333\",\n        \"ProgramId\": \"44444444-4444-4444-9444-444444444444\",\n        \"ApplicationStatus\": \"Entry_In_Progress\",\n        \"CurrentMode\": \"Entry\",\n        \"ApplicationDate\": \"2026-04-18T00:00:00\",\n        \"CurrentModeBranchDate\": \"2026-04-18T09:30:00\",\n        \"CurrentStatusBranchDate\": \"2026-04-18T09:30:00\",\n        \"CurrentOfferDate\": \"2026-04-18T09:30:00\",\n        \"ModeSetBy\": \"developer\",\n        \"StatusSetBy\": \"developer\",\n        \"LastChangeBranchDate\": \"2026-04-18T09:30:00\",\n        \"LastChangedBy\": \"developer\",\n        \"commonAccount\": {\n            \"Id\": \"55555555-5555-4555-9555-555555555555\",\n            \"OmegaClientId\": \"66666666-6666-4666-9666-666666666666\",\n            \"ClientNumber\": 547,\n            \"BranchId\": \"77777777-7777-4777-9777-777777777777\",\n            \"ClassId\": \"88888888-8888-4888-9888-888888888888\",\n            \"InternalStatus\": \"Loan_Application\",\n            \"AdminStatusId\": \"99999999-9999-4999-9999-999999999999\",\n            \"AccountSourceCodeId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n            \"CreationBranchDate\": \"2026-04-18T09:30:00\",\n            \"CurrentBusinessDate\": \"2026-04-18T09:30:00\",\n            \"CreatedBy\": \"developer\",\n            \"commonAccountDirect\": {\n                \"Id\": \"bbbbbbbb-bbbb-4bbb-9bbb-bbbbbbbbbbbb\"\n            },\n            \"commonAccountCustomers\": []\n        }\n    },\n    \"errors\": []\n}"},{"id":"9ff65cc2-f396-48b6-9777-507da34becbf","name":"CreateApplicationSession - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"programNumberOrId\": \"9999\",\n  \"groupNumberOrId\": \"500\",\n  \"classNumberOrId\": \"AUTO\",\n  \"branchNumberOrId\": \"1\",\n  \"dealerId\": null,\n  \"applicationDate\": null,\n  \"dealerCodeOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/Session?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","Session"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Program could not be resolved\"\n    ]\n}"}],"_postman_id":"422cc0ad-1493-4344-9d29-cb8f6bd6ffc7"},{"name":"CounterOfferApplication","id":"4696264c-5b33-4068-9528-d5d659494d87","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"counterOfferReasonIds\": [],\n  \"counterOfferReasonNumbersOrIds\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Application/{{originations_application_id}}/CounterOffer?token={{token}}","description":"<h3 id=\"counter-offer-originations-application\">Counter-Offer Originations Application</h3>\n<p>This operation accepts application's account number or application GUID in <code>id</code>. The GUID must identify the selected record type. The number identifies the application through its account; the GUID identifies the application itself. Any body <code>applicationId</code> is replaced with the resolved application ID. Malformed JSON or invalid field types return an error before the action runs.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Application/{id}/CounterOffer</code></p>\n<h4 id=\"url-parameters\">URL Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. application's account number or application GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CounterOfferApplicationParameter</code>. A null or empty body is allowed — the controller constructs an empty <code>CounterOfferApplicationParameter</code> and sets <code>applicationId</code> from the route.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>applicationId</em></td>\n<td>Ignored. The server always overwrites this with the route <code>{id}</code>.</td>\n</tr>\n<tr>\n<td><em>counterOfferReasonIds</em></td>\n<td>Optional list of Guids. Each entry must resolve via <code>CounterOfferReasonServices.ReturnCounterOfferReason</code> and must not be duplicated in the request. Null / empty clears counter-offer reasons.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the application <code>Id</code> (Guid).</p>\n<p>Returns <code>BadRequest</code> with <code>StandardAPIErrors.INVALID_PARAMETER_ERROR_MESSAGE</code> when the route <code>id</code> is empty, <code>\"Application id is required\"</code> when the parameter fails validation, <code>\"Application could not be resolved\"</code> when <code>LoanApplicationData.GetLoanApplicationEntity</code> returns null, <code>\"Counter Offer reason could not be resolved\"</code> when an entry is <code>Guid.Empty</code> or unknown, or <code>\"Counter Offer reason has already been added.\"</code> when the list contains duplicates.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>application's account number or application GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>counterOfferReasonNumbersOrIds</code></td>\n<td><code>counterOfferReasonIds</code></td>\n<td>Array of strings. Each entry: counter-offer-reason number or counter-offer-reason GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"counterOfferReasonNumbersOrIds\": [\n    \"1\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Originations/Application/30011709/CounterOffer\n/api/Client/Originations/Application/11111111-1111-4111-8111-111111111111/CounterOffer\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application","{{originations_application_id}}","CounterOffer"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"1e677765-f5b0-476c-b8a6-8c79edcc179a","name":"CounterOfferApplication - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"counterOfferReasonIds\": [\n    \"ffffffff-ffff-4fff-9fff-ffffffffffff\"\n  ],\n  \"counterOfferReasonNumbersOrIds\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/22222222-2222-4222-9222-222222222222/CounterOffer?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","22222222-2222-4222-9222-222222222222","CounterOffer"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"22222222-2222-4222-9222-222222222222\",\n    \"errors\": []\n}"},{"id":"96656892-f625-4699-a2b0-b6b167fb0628","name":"CounterOfferApplication - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"counterOfferReasonIds\": [\n    \"00000000-0000-0000-0000-000000000000\"\n  ],\n  \"counterOfferReasonNumbersOrIds\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/22222222-2222-4222-9222-222222222222/CounterOffer?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","22222222-2222-4222-9222-222222222222","CounterOffer"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Counter Offer reason could not be resolved\"\n    ]\n}"}],"_postman_id":"4696264c-5b33-4068-9528-d5d659494d87"},{"name":"CounterOfferReasonCreate","id":"685dc992-e010-4cf9-8ef7-05756329ed8f","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Higher down payment required\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/CounterOfferReason?token={{token}}","description":"<h3 id=\"create-counter-offer-reason\">Create Counter Offer Reason</h3>\n<p>Creates a new <code>Originations.CounterOfferReason</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>CounterOfferReasonController.CreateCounterOfferReason</code> -&gt; <code>CounterOfferReasonWSServices.CreateCounterOfferReasonWS</code> -&gt; <code>Omega.Originations.BLL.CounterOfferReasonServices.AddCounterOfferReason</code> committed through a single <code>UnitOfWork2</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/CounterOfferReason</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CreateCounterOfferReasonParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable reason text.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool. Whether the reason is available on new counter-offer entry.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Description is required\"]}</code> when <code>description</code> is empty.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","CounterOfferReason"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"9bb68d14-c9dc-4fc0-bd4f-c65eed0bdb9e","name":"CreateCounterOfferReason - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Higher down payment required\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"2f7f9566-7f2b-41ff-b51e-1159522cd171","name":"CreateCounterOfferReason - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ]\n}"}],"_postman_id":"685dc992-e010-4cf9-8ef7-05756329ed8f"},{"name":"CounterOfferReasonGet","id":"d787906f-76b8-41b7-97b0-3874fdb8f2da","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/CounterOfferReason/{{counter_offer_reason_number_or_id}}?token={{token}}","description":"<h3 id=\"get-counter-offer-reason-by-number-or-id\">Get Counter Offer Reason by Number or Id</h3>\n<p>Returns a single <code>Originations.CounterOfferReason</code> row resolved from <code>{numberOrId}</code>. Backed by <code>CounterOfferReasonController.GetCounterOfferReason</code> -&gt; <code>CounterOfferReasonWSServices.GetCounterOfferReasonWS</code> -&gt; <code>SharedWSServices.GetOriginationsCounterOfferReasonId</code> then <code>Omega.Originations.BLL.CounterOfferReasonServices.ReturnCounterOfferReason</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/CounterOfferReason/{numberOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the system counter-offer-reason number scoped to the caller's <code>OmegaClientId</code>. <code>SharedWSServices.GetOriginationsCounterOfferReasonId</code> first tries <code>Guid.TryParse</code>; if that fails, a <code>Client</code> session falls back to the numeric lookup.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an <code>Originations.CounterOfferReason</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>OmegaClientId</em></td>\n<td>Guid.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>Active</em></td>\n<td>Bool.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns BadRequest with <code>{\"statusCode\": -1, \"result\": \"Error\", \"errors\": [\"Counter offer reason not found\"]}</code> when the value cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","CounterOfferReason","{{counter_offer_reason_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"1111bfe8-b4c0-4eb4-b95b-53781f8ab8ff","name":"GetCounterOfferReason - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA4=\",\n        \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n        \"Description\": \"Higher down payment required\",\n        \"Active\": true\n    },\n    \"errors\": []\n}"},{"id":"475b4ab3-db70-444c-b9fc-d6bc0238b0b1","name":"GetCounterOfferReason - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason/9999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason","9999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Counter offer reason not found\"\n    ]\n}"}],"_postman_id":"d787906f-76b8-41b7-97b0-3874fdb8f2da"},{"name":"CounterOfferReasonsGetAll","id":"47664863-a000-471e-90a7-598c8f14255f","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/CounterOfferReason?token={{token}}","description":"<h3 id=\"get-all-counter-offer-reasons\">Get All Counter Offer Reasons</h3>\n<p>Returns every <code>Originations.CounterOfferReason</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>CounterOfferReasonController.GetAllCounterOfferReasons</code> -&gt; <code>CounterOfferReasonWSServices.GetAllCounterOfferReasonsWS</code>. The response is an LLBLGen <code>EntityCollection&lt;MyOriginationsCounterOfferReasonEntity&gt;</code> filtered by <code>OriginationsCounterOfferReasonFields.OmegaClientId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/CounterOfferReason</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Originations.CounterOfferReason</code> entities:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>OmegaClientId</em></td>\n<td>Guid. Always equals the caller's client.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String. Human-readable reason text.</td>\n</tr>\n<tr>\n<td><em>Active</em></td>\n<td>Bool. Whether the reason is available on new counter-offer entry.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Originations","CounterOfferReason"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"23163cb5-51c1-4701-9a35-78d880a93661","name":"GetAllCounterOfferReasons - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"Higher down payment required\",\n            \"Active\": true\n        },\n        {\n            \"Id\": \"33333333-3333-4333-9333-333333333333\",\n            \"Ts\": \"AAAAAAAACA8=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"Shorter term required\",\n            \"Active\": true\n        }\n    ],\n    \"errors\": []\n}"},{"id":"f6e63a55-8b2e-4688-8f77-e4272c08b974","name":"GetAllCounterOfferReasons - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason?token=","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason"],"query":[{"key":"token","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"47664863-a000-471e-90a7-598c8f14255f"},{"name":"CounterOfferReasonUpdate","id":"b25e25d4-d5c9-47fb-ab8c-6c92c577c2d1","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Higher down payment required (updated)\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/CounterOfferReason/{{counter_offer_reason_number_or_id}}?token={{token}}","description":"<h3 id=\"update-counter-offer-reason\">Update Counter Offer Reason</h3>\n<p>Updates an existing <code>Originations.CounterOfferReason</code> row resolved from <code>{numberOrId}</code>. Backed by <code>CounterOfferReasonController.UpdateCounterOfferReason</code> -&gt; <code>CounterOfferReasonWSServices.UpdateCounterOfferReasonWS</code> -&gt; <code>Omega.Originations.BLL.CounterOfferReasonServices.SaveCounterOfferReasonChanges</code> committed through a single <code>UnitOfWork2</code>. The server loads the existing row to pick up the current <code>Ts</code> used for optimistic concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/CounterOfferReason/{numberOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the counter-offer-reason number.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateCounterOfferReasonParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the resolved Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries <code>[\"Counter offer reason not found\"]</code> when the value cannot be resolved, or <code>[\"Description is required\"]</code> when <code>description</code> is empty.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","CounterOfferReason","{{counter_offer_reason_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7cef4c13-7772-4d1c-8c7f-4442574b61f9","name":"UpdateCounterOfferReason - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Higher down payment required (updated)\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"23af906c-754f-474b-922f-b4f3be3b479a","name":"UpdateCounterOfferReason - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Higher down payment required (updated)\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/CounterOfferReason/9999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CounterOfferReason","9999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Counter offer reason not found\"\n    ]\n}"}],"_postman_id":"b25e25d4-d5c9-47fb-ab8c-6c92c577c2d1"},{"name":"CreditReportSessionCreate","id":"cd7d7ee7-80b8-44ab-8b94-b7b991df375a","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"customerNumberOrId\": \"{{common_customer_id}}\",\n  \"sessionId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/CreditReports/Session?token={{token}}","description":"<h3 id=\"create-credit-report-session\">Create Credit Report Session</h3>\n<p>Bootstraps a server-side <code>LoanApplicationSession</code> keyed by a session Guid so that subsequent credit-report endpoints can operate against an in-memory <code>LoanApplicationData</code> without first persisting an Originations application. Backed by <code>ApplicationCreditReportController.CreateSession</code> -&gt; <code>ApplicationCreditReportWSServices.CreateSessionWS</code>.</p>\n<p>The controller rejects the call with <code>BadRequest</code> when:</p>\n<ul>\n<li><p>the body is null (<code>StandardAPIErrors.INVALID_PARAMETER_ERROR_MESSAGE</code>),</p>\n</li>\n<li><p><code>customerNumberOrId</code> is blank (<code>\"customerNumberOrId is required\"</code>),</p>\n</li>\n<li><p><code>customerNumberOrId</code> is neither a <code>Guid.TryParse</code>-able value nor an\n<code>int.TryParse</code>-able value\n(<code>\"customerNumberOrId must be a valid customer number or GUID\"</code>),</p>\n</li>\n<li><p><code>SharedWSServices.GetCommonCustomerId(customerNumberOrId, databaseName, clientId, sessionType)</code> cannot resolve the customer (<code>\"Customer not found\"</code>).</p>\n</li>\n</ul>\n<p>When validation passes, <code>CreateSessionWS</code>:</p>\n<ul>\n<li><p>requires <code>HttpContext.Current.Session</code> to be available (otherwise returns\n<code>\"HTTP session is not available for this request.\"</code>),</p>\n</li>\n<li><p>generates a new <code>sessionId</code> when the body omits it or passes\n<code>Guid.Empty</code>, otherwise reuses the supplied Guid,</p>\n</li>\n<li><p>builds an <code>Omega.Account.Objects.Originations.LoanApplicationData</code> with\na fresh <code>OriginationsAccountType(databaseName)</code> populated from\n<code>LoginInfo</code> (<code>OmegaClientId</code>, <code>LastChangedByUser</code>, <code>LastChangedByUserId</code>,\n<code>ClientTimeZone</code>, <code>BranchId</code>, <code>CurrentBusinessDate</code>),</p>\n</li>\n<li><p>adds a single <code>OriginationsAccountCustomer</code> whose <code>commonCustomer</code> comes\nfrom <code>CommonCustomerType.ReturnCommonCustomerDataObject(databaseName, customerId)</code>,</p>\n</li>\n<li><p>stores the loan application via\n<code>LoanApplicationSession.Store(HttpContext.Current.Session, loanApp, sessionId)</code>.</p>\n</li>\n</ul>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/CreditReports/Session</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CreateCreditReportSessionParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>customerNumberOrId</em></td>\n<td>Required string. Either the <code>Common.Customer.Id</code> as a Guid or the numeric <code>CustomerNumber</code>. Parsed via <code>Guid.TryParse</code> then <code>int.TryParse</code> before being passed to <code>SharedWSServices.GetCommonCustomerId</code>.</td>\n</tr>\n<tr>\n<td><em>sessionId</em></td>\n<td>Optional Guid. When supplied and non-empty, reused as the session key; otherwise a new Guid is generated.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the session envelope:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>sessionId</em></td>\n<td>Guid key under which the new <code>LoanApplicationData</code> was stored in the ASP.NET session. Pass this to follow-up credit-report endpoints that share the session.</td>\n</tr>\n<tr>\n<td><em>customerIndex</em></td>\n<td>Int. Always <code>0</code> — the customer is stored as the first entry in <code>commonAccount.commonAccountCustomers</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Errors return as <code>BadRequest</code> with <code>\"Error creating credit report session: {message}\"</code> in <code>errors</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","CreditReports","Session"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"8044feaa-1ef5-43fa-adeb-8c9acc3f5100","name":"CreateCreditReportSession - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"customerNumberOrId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n  \"sessionId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/CreditReports/Session?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CreditReports","Session"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"sessionId\": \"dddddddd-dddd-4ddd-9ddd-dddddddddddd\",\n        \"customerIndex\": 0\n    },\n    \"errors\": []\n}"},{"id":"32fb6e08-55bd-41e6-b919-f8ec299aa0e8","name":"CreateCreditReportSession - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"customerNumberOrId\": \"\",\n  \"sessionId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/CreditReports/Session?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","CreditReports","Session"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"customerNumberOrId is required\"\n    ]\n}"}],"_postman_id":"cd7d7ee7-80b8-44ab-8b94-b7b991df375a"},{"name":"DeclineApplication","id":"2d2ce4d9-91c6-4cbf-b755-db71eed3edb9","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"declineReasonIds\": [\n    \"{{originations_decline_reason_id}}\"\n  ],\n  \"declineReasonNumbersOrIds\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Application/{{originations_application_id}}/Decline?token={{token}}","description":"<h3 id=\"decline-originations-application\">Decline Originations Application</h3>\n<p>This operation accepts application's account number or application GUID in <code>id</code>. The GUID must identify the selected record type. The number identifies the application through its account; the GUID identifies the application itself. Any body <code>applicationId</code> is replaced with the resolved application ID. Malformed JSON or invalid field types return an error before the action runs.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Application/{id}/Decline</code></p>\n<h4 id=\"url-parameters\">URL Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. application's account number or application GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>DeclineApplicationParameter</code>. A null or empty body is allowed — the controller constructs an empty <code>DeclineApplicationParameter</code> and sets <code>applicationId</code> from the route.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>applicationId</em></td>\n<td>Ignored. The server always overwrites this with the route <code>{id}</code>.</td>\n</tr>\n<tr>\n<td><em>declineReasonIds</em></td>\n<td>Optional list of Guids. Each entry must resolve via <code>DeclineReasonServices.ReturnDeclineReason</code> and must not be duplicated in the request. Null / empty clears decline reasons.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the application <code>Id</code> (Guid).</p>\n<p>Returns <code>BadRequest</code> with <code>StandardAPIErrors.INVALID_PARAMETER_ERROR_MESSAGE</code> when the route <code>id</code> is empty, <code>\"Application id is required\"</code> when the parameter fails validation, <code>\"Application could not be resolved\"</code> when <code>LoanApplicationData.GetLoanApplicationEntity</code> returns null, <code>\"Decline reason could not be resolved\"</code> when an entry is <code>Guid.Empty</code> or unknown, or <code>\"Decline reason has already been added.\"</code> when the list contains duplicates.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>application's account number or application GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>declineReasonNumbersOrIds</code></td>\n<td><code>declineReasonIds</code></td>\n<td>Array of strings. Each entry: decline-reason number or decline-reason GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"declineReasonNumbersOrIds\": [\n    \"1\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Originations/Application/30011709/Decline\n/api/Client/Originations/Application/11111111-1111-4111-8111-111111111111/Decline\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application","{{originations_application_id}}","Decline"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ae2b1c74-2ef3-47ab-aebf-f410f66376cc","name":"DeclineApplication - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"declineReasonIds\": [\n    \"dddddddd-dddd-4ddd-9ddd-dddddddddddd\",\n    \"eeeeeeee-eeee-4eee-9eee-eeeeeeeeeeee\"\n  ],\n  \"declineReasonNumbersOrIds\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/22222222-2222-4222-9222-222222222222/Decline?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","22222222-2222-4222-9222-222222222222","Decline"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"22222222-2222-4222-9222-222222222222\",\n    \"errors\": []\n}"},{"id":"8cbe5673-25e6-4f08-a4db-15c0bea0a4e4","name":"DeclineApplication - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"declineReasonIds\": [\n    \"00000000-0000-0000-0000-000000000000\"\n  ],\n  \"declineReasonNumbersOrIds\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/22222222-2222-4222-9222-222222222222/Decline?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","22222222-2222-4222-9222-222222222222","Decline"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Decline reason could not be resolved\"\n    ]\n}"}],"_postman_id":"2d2ce4d9-91c6-4cbf-b755-db71eed3edb9"},{"name":"DeclineReasonCreate","id":"d94d2d1c-176f-4380-8340-9126de7b5be9","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Insufficient credit history\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/DeclineReason?token={{token}}","description":"<h3 id=\"create-decline-reason\">Create Decline Reason</h3>\n<p>Creates a new <code>Originations.DeclineReason</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>DeclineReasonController.CreateDeclineReason</code> -&gt; <code>DeclineReasonWSServices.CreateDeclineReasonWS</code> -&gt; <code>Omega.Originations.BLL.DeclineReasonServices.AddDeclineReason</code> committed through a single <code>UnitOfWork2</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/DeclineReason</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>AddDeclineReasonParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Human-readable decline reason.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool. Defaults to true when the row is created.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new decline-reason Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entry <code>[\"Description is required\"]</code> when <code>description</code> is missing or whitespace.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","DeclineReason"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e12add02-0b30-4d67-9ec3-c811b1b989f0","name":"CreateDeclineReason - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Insufficient credit history\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"5ffee17d-3e6a-41e6-932b-17fea55e80f9","name":"CreateDeclineReason - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ]\n}"}],"_postman_id":"d94d2d1c-176f-4380-8340-9126de7b5be9"},{"name":"DeclineReasonGet","id":"c626cd65-b6e9-4775-8595-1e0bccdceb56","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/DeclineReason/{{decline_reason_number_or_id}}?token={{token}}","description":"<h3 id=\"get-decline-reason-by-number-or-id\">Get Decline Reason by Number or Id</h3>\n<p>Returns a single <code>Originations.DeclineReason</code> row resolved from <code>{numberOrId}</code>. Backed by <code>DeclineReasonController.GetDeclineReason</code> -&gt; <code>DeclineReasonWSServices.GetDeclineReasonWS</code> -&gt; <code>SharedWSServices.GetOriginationsDeclineReasonId</code> then <code>Omega.Originations.BLL.DeclineReasonServices.ReturnDeclineReason</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/DeclineReason/{numberOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the system decline-reason number scoped to the caller's <code>OmegaClientId</code>. <code>SharedWSServices.GetOriginationsDeclineReasonId</code> first tries <code>Guid.TryParse</code>; if that fails, a <code>Client</code> session falls back to the numeric lookup.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an <code>Originations.DeclineReason</code> entity:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>OmegaClientId</em></td>\n<td>Guid.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>Active</em></td>\n<td>Bool.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Returns BadRequest with <code>errors</code> entry <code>[\"Decline reason not found\"]</code> when the value cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","DeclineReason","{{decline_reason_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"27eacf1b-59cb-4f73-8906-925a07fefdf3","name":"GetDeclineReason - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA4=\",\n        \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n        \"Description\": \"Insufficient credit history\",\n        \"Active\": true\n    },\n    \"errors\": []\n}"},{"id":"5075c0c3-8cba-4d84-965f-ecafd805e363","name":"GetDeclineReason - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason/9999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason","9999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Decline reason not found\"\n    ]\n}"}],"_postman_id":"c626cd65-b6e9-4775-8595-1e0bccdceb56"},{"name":"DeclineReasonsGetAll","id":"0c31ff27-5587-43bb-9ed8-b642b1e370da","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/DeclineReason?token={{token}}","description":"<h3 id=\"get-all-decline-reasons\">Get All Decline Reasons</h3>\n<p>Returns every <code>Originations.DeclineReason</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>DeclineReasonController.GetAllDeclineReasons</code> -&gt; <code>DeclineReasonWSServices.GetAllDeclineReasonsWS</code>. The response is an LLBLGen <code>EntityCollection&lt;MyOriginationsDeclineReasonEntity&gt;</code> filtered by <code>OriginationsDeclineReasonFields.OmegaClientId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/DeclineReason</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Originations.DeclineReason</code> entities:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid.</td>\n</tr>\n<tr>\n<td><em>Ts</em></td>\n<td>Byte[] timestamp for optimistic concurrency on PUT.</td>\n</tr>\n<tr>\n<td><em>OmegaClientId</em></td>\n<td>Guid. Always equals the caller's client.</td>\n</tr>\n<tr>\n<td><em>Description</em></td>\n<td>String. Human-readable reason text.</td>\n</tr>\n<tr>\n<td><em>Active</em></td>\n<td>Bool. Whether the reason is available on new decline entry.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Originations","DeclineReason"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"462e7386-a079-48de-b7f0-968f4eee71a3","name":"GetAllDeclineReasons - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"Insufficient credit history\",\n            \"Active\": true\n        },\n        {\n            \"Id\": \"33333333-3333-4333-9333-333333333333\",\n            \"Ts\": \"AAAAAAAACA8=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"Income below minimum\",\n            \"Active\": true\n        }\n    ],\n    \"errors\": []\n}"},{"id":"9f5c7243-132b-4c1a-a23d-b4008e93b7c4","name":"GetAllDeclineReasons - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving decline reasons: Invalid session token\"\n    ]\n}"}],"_postman_id":"0c31ff27-5587-43bb-9ed8-b642b1e370da"},{"name":"DeclineReasonUpdate","id":"cfa3c027-dc7c-4d0c-87e4-04272bb3d59a","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Insufficient credit history (updated)\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/DeclineReason/{{decline_reason_number_or_id}}?token={{token}}","description":"<h3 id=\"update-decline-reason\">Update Decline Reason</h3>\n<p>Updates an existing <code>Originations.DeclineReason</code> row resolved from <code>{numberOrId}</code>. Backed by <code>DeclineReasonController.UpdateDeclineReason</code> -&gt; <code>DeclineReasonWSServices.UpdateDeclineReasonWS</code> -&gt; <code>Omega.Originations.BLL.DeclineReasonServices.SaveDeclineReasonChanges</code> committed through a single <code>UnitOfWork2</code>. The server loads the existing row to pick up the current <code>Ts</code> used for optimistic concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/DeclineReason/{numberOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the decline-reason number.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateDeclineReasonParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the resolved Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries <code>[\"Decline reason not found\"]</code> when the value cannot be resolved, or <code>[\"Description is required\"]</code> when <code>description</code> is empty.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","DeclineReason","{{decline_reason_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"dc830781-af71-41de-aaac-ff3350fb4cef","name":"UpdateDeclineReason - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Insufficient credit history (updated)\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"5ba7252f-c45d-41c7-9cef-1d8269cf4b34","name":"UpdateDeclineReason - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Insufficient credit history (updated)\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/DeclineReason/9999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","DeclineReason","9999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Decline reason not found\"\n    ]\n}"}],"_postman_id":"cfa3c027-dc7c-4d0c-87e4-04272bb3d59a"},{"name":"ExportQueueDelete","id":"37a3dceb-2208-458d-9e19-4202a84a8e95","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ts\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/ExportQueue/{{originations_application_number_or_id}}?token={{token}}","description":"<h3 id=\"remove-originations-application-from-export-queue\">Remove Originations Application from Export Queue</h3>\n<p>Removes a single application from the export queue without actually exporting it. Backed by <code>ApplicationExportController.DeleteExportQueue</code> -&gt; <code>ApplicationExportWSServices.DeleteWS</code>.</p>\n<p>The server resolves <code>applicationNumberOrId</code> in this order:</p>\n<ul>\n<li><code>Guid.TryParse</code> — accepted when non-empty,</li>\n<li><code>long.TryParse</code> — resolved via\n<code>ApplicationServices.ReturnApplicationId(databaseName, clientId, applicationNumber)</code> to obtain the <code>OriginationsApplication.Id</code>.</li>\n</ul>\n<p>If neither succeeds, or the application is not currently in the client's export queue, the controller returns <code>BadRequest</code> with <code>\"Application not found\"</code>.</p>\n<p>When the request body does not provide a <code>ts</code>, the server reads <code>Ts</code> from the existing export queue row and uses that value. It then calls <code>ApplicationExport.QueueApplicationExport(applicationId, false, ts, databaseName)</code> to set <code>OriginationsApplication.QueueForExport = false</code>, producing the side effect of removing the application from the queue.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/ExportQueue/{applicationNumberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>applicationNumberOrId</em></td>\n<td>Required string. Either the <code>OriginationsApplication.Id</code> as a Guid or the numeric <code>CommonAccount.AccountNumber</code>. Returns <code>BadRequest</code> with <code>StandardAPIErrors.INVALID_PARAMETER_ERROR_MESSAGE</code> when blank, and <code>\"Application number or ID is required\"</code> / <code>\"Application not found\"</code> on resolution failures.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>DeleteExportQueueParameter</code>. The body may be omitted entirely — the server will look up <code>Ts</code> from the current export queue row if missing.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>applicationId</em></td>\n<td>Ignored. Resolution is driven by the route.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Optional byte array. <code>OriginationsApplication.Ts</code> for optimistic concurrency. When omitted, the server uses the <code>Ts</code> it just read from the queue row, which effectively disables concurrency checking for this call.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the resolved application <code>Id</code> (Guid). <code>statusCode</code> is <code>OmegaStatusCode.Ok</code> on success. Errors surface as <code>BadRequest</code> with <code>\"Error removing application from export queue: {message}\"</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","ExportQueue","{{originations_application_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"651c1ccf-308f-4d5c-b14b-7c745587b06f","name":"DeleteExportQueue - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ts\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/ExportQueue/11111111-1111-4111-9111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","ExportQueue","11111111-1111-4111-9111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"0fe2afed-7d1c-4b98-b9b7-3e0d5aa4d66b","name":"DeleteExportQueue - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"ts\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/ExportQueue/99999999-9999-4999-9999-999999999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","ExportQueue","99999999-9999-4999-9999-999999999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error removing application from export queue: Application not found\"\n    ]\n}"}],"_postman_id":"37a3dceb-2208-458d-9e19-4202a84a8e95"},{"name":"ExportQueueExport","id":"61d6fb8a-7f12-4af9-b081-a80385de9d6e","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"expectedQueueCount\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/ExportQueue/Export?token={{token}}","description":"<h3 id=\"export-queued-originations-applications\">Export Queued Originations Applications</h3>\n<p>Exports every application currently flagged in the Originations export queue as a single Megasys-format CSV payload. Backed by <code>ApplicationExportController.ExportExportQueue</code> -&gt; <code>ApplicationExportWSServices.ExportWS</code>.</p>\n<p>Workflow inside <code>ExportWS</code>:</p>\n<ul>\n<li><p>re-reads the queue with the same <code>BuildExportQueueFields</code> column set used\nby the list endpoint,</p>\n</li>\n<li><p>if the body supplies <code>expectedQueueCount</code>, compares it to the current\n<code>exportQueue.Rows.Count</code> and aborts with\n<code>\"Applications have been added or removed to the queue since it was displayed to you. Please review the updated queue and try again.\"</code> on\nmismatch,</p>\n</li>\n<li><p>builds a <code>Megasys.Framework.Types.SensitiveOperationParameters</code> from\n<code>OmegaConfiguration.CurrentConfigurationKey</code> + the caller's\n<code>UserIsMegasysStaff</code> flag,</p>\n</li>\n<li><p>determines the client edition via\n<code>SetupInternal.BLL.ClientServices.ReturnInternalClientWithId</code> (defaults\nto <code>Small_Business</code> if the internal client lookup fails),</p>\n</li>\n<li><p>for each queue row, appends the CSV produced by\n<code>ApplicationExport.MegasysSingleAccountFormat(databaseName, sensitiveOperationParameters, clientId, accountId, ref exportFileName, clientDateTimeNow, clientEdition)</code> followed by <code>Environment.NewLine</code>,</p>\n</li>\n<li><p>calls <code>ApplicationExport.ExportQueuedApplication(exportQueue, userId, clientDateTimeNow, databaseName)</code> to record the export and clear the\nqueue,</p>\n</li>\n<li><p>Base64-encodes the ASCII payload (<code>System.Text.Encoding.ASCII.GetBytes</code>\n-&gt; <code>Convert.ToBase64String</code>) and returns it under <code>contentBase64</code>.</p>\n</li>\n</ul>\n<p>The filename is <code>\"QueuedExport\" + clientDateTimeNow.ToString( \"yyyyMMdd_hh_mm_ss_ttt\") + \".csv\"</code> (note: the format string uses 12-hour <code>hh</code> and milliseconds as <code>ttt</code>).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/ExportQueue/Export</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>ExportQueueParameter</code>. The body may be omitted — concurrency checking only runs when <code>expectedQueueCount</code> is supplied.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>expectedQueueCount</em></td>\n<td>Optional int. Number of queued applications the caller believes are present. When provided, the server requires an exact match against the current queue size or returns the mismatch error above.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> has the export payload:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fileName</em></td>\n<td><code>QueuedExport{yyyyMMdd_hh_mm_ss_ttt}.csv</code>.</td>\n</tr>\n<tr>\n<td><em>contentType</em></td>\n<td><code>text/csv</code>.</td>\n</tr>\n<tr>\n<td><em>contentBase64</em></td>\n<td>Base64-encoded ASCII CSV produced by <code>MegasysSingleAccountFormat</code>, one row per queued application.</td>\n</tr>\n<tr>\n<td><em>exportedCount</em></td>\n<td>Number of applications that were exported and removed from the queue.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Errors surface as <code>BadRequest</code> with <code>\"Error exporting queued applications: {message}\"</code> or the concurrency mismatch message above.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","ExportQueue","Export"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ceba0625-ada4-430e-8bc3-caa81a2d1d9d","name":"ExportExportQueue - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"expectedQueueCount\": 2\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/ExportQueue/Export?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","ExportQueue","Export"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"fileName\": \"QueuedExport20260418_02_15_33_123.csv\",\n        \"contentType\": \"text/csv\",\n        \"contentBase64\": \"MzAwMDEyMTAwLERvZSxKYW5lLEEsMTAwMDAuMDAsNjAsNi45OTk5DQozMDAwMTIxMDEsU21pdGgsSm9obiwsMTUwMDAuMDAsNzIsNy45OTk5DQo=\",\n        \"exportedCount\": 2\n    },\n    \"errors\": []\n}"},{"id":"48df9add-8e11-4dd9-bc8d-fcb7448adc98","name":"ExportExportQueue - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"expectedQueueCount\": 99\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/ExportQueue/Export?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","ExportQueue","Export"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Applications have been added or removed to the queue since it was displayed to you. Please review the updated queue and try again.\"\n    ]\n}"}],"_postman_id":"61d6fb8a-7f12-4af9-b081-a80385de9d6e"},{"name":"ExportQueueGet","id":"c55032a0-1fba-467a-9af3-ddaf7d522313","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/ExportQueue?pageSize=0&currentPage=0&token={{token}}","description":"<h3 id=\"get-originations-application-export-queue\">Get Originations Application Export Queue</h3>\n<p>Returns the paged list of Originations applications currently flagged for export. Backed by <code>ApplicationExportController.ListExportQueue</code> -&gt; <code>ApplicationExportWSServices.ListWS</code>. The list is fetched via <code>ApplicationExport.ReturnExportQueueList(databaseName, clientId, fields, sort, pageSize, currentPage)</code> and the unpaged total via <code>ApplicationExport.ReturnExportQueueCount(databaseName, clientId)</code>. The <code>fields</code> set is built by the private <code>BuildExportQueueFields</code> helper, which defines eight columns from <code>OriginationsApplication</code>, <code>CommonAccount</code>, <code>CommonAdminStatus</code>, and <code>CommonCustomer</code>:</p>\n<ul>\n<li><p><code>Id</code>, <code>Ts</code>, <code>AccountId</code>, <code>GroupId</code> from <code>OriginationsApplicationFields</code>,</p>\n</li>\n<li><p>a computed <code>ApplicationStatus</code> string produced by a SQL <code>CASE</code> expression\nover <code>OriginationsApplicationFields.ApplicationStatus</code> that maps every\n<code>Omega.Originations.Types.ApplicationStatuses</code> enum value to its name with\nunderscores replaced by spaces,</p>\n</li>\n<li><p><code>AccountNumber</code> from <code>CommonAccountFields</code>,</p>\n</li>\n<li><p>the admin status <code>Description</code> from <code>CommonAdminStatusFields</code>,</p>\n</li>\n<li><p>a computed <code>FullName</code> column produced by a SQL <code>CASE</code> expression that\nreturns <code>LastName, FirstName</code> when <code>CommonCustomerFields.MiddleName</code> is\nnull / empty and <code>LastName, FirstName MiddleName</code> otherwise.</p>\n</li>\n</ul>\n<p>Rows are sorted by <code>CommonAccountFields.AccountNumber</code> ascending.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/ExportQueue</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>pageSize</em></td>\n<td>Optional int. Page size. <code>0</code> (the default when the query parameter is omitted) loads every row. Forwarded directly to <code>ApplicationExport.ReturnExportQueueList</code>.</td>\n</tr>\n<tr>\n<td><em>currentPage</em></td>\n<td>Optional int. Zero-based page index. <code>0</code> is the first page. Forwarded directly to <code>ApplicationExport.ReturnExportQueueList</code>.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the paging envelope:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>totalCount</em></td>\n<td>Total number of queued applications for the client, independent of paging.</td>\n</tr>\n<tr>\n<td><em>returnedCount</em></td>\n<td>Number of rows returned on the current page.</td>\n</tr>\n<tr>\n<td><em>rows</em></td>\n<td>Array of queue entries.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Each row has:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid. <code>OriginationsApplication.Id</code>.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Byte array. <code>OriginationsApplication.Ts</code> (row version). Required when calling the delete endpoint.</td>\n</tr>\n<tr>\n<td><em>accountId</em></td>\n<td>Guid. <code>OriginationsApplication.AccountId</code>.</td>\n</tr>\n<tr>\n<td><em>groupId</em></td>\n<td>Guid. <code>OriginationsApplication.GroupId</code>.</td>\n</tr>\n<tr>\n<td><em>applicationStatus</em></td>\n<td>String. Friendly name of the <code>ApplicationStatuses</code> enum (underscores replaced with spaces).</td>\n</tr>\n<tr>\n<td><em>accountNumber</em></td>\n<td>Long. <code>CommonAccount.AccountNumber</code>.</td>\n</tr>\n<tr>\n<td><em>adminStatusDescription</em></td>\n<td>String. <code>CommonAdminStatus.Description</code>.</td>\n</tr>\n<tr>\n<td><em>fullName</em></td>\n<td>String. Customer full name produced by the SQL CASE expression described above.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Errors are returned as <code>BadRequest</code> with <code>\"Error retrieving export queue: {message}\"</code> in <code>errors</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","ExportQueue"],"host":["{{base_url}}"],"query":[{"key":"pageSize","value":"0"},{"key":"currentPage","value":"0"},{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a43a3a43-e73d-4b80-8fc7-c3d2c70bc505","name":"GetExportQueue - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/ExportQueue?pageSize=0&currentPage=0&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","ExportQueue"],"query":[{"key":"pageSize","value":"0"},{"key":"currentPage","value":"0"},{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"totalCount\": 2,\n        \"returnedCount\": 2,\n        \"rows\": [\n            {\n                \"id\": \"11111111-1111-4111-9111-111111111111\",\n                \"ts\": \"AAAAAAAAB9E=\",\n                \"accountId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n                \"groupId\": \"bbbbbbbb-bbbb-4bbb-9bbb-bbbbbbbbbbbb\",\n                \"applicationStatus\": \"Approved Pending Funding\",\n                \"accountNumber\": 300012100,\n                \"adminStatusDescription\": \"Ready to Export\",\n                \"fullName\": \"Doe, Jane A\"\n            },\n            {\n                \"id\": \"22222222-2222-4222-9222-222222222222\",\n                \"ts\": \"AAAAAAAAB9I=\",\n                \"accountId\": \"cccccccc-cccc-4ccc-9ccc-cccccccccccc\",\n                \"groupId\": \"bbbbbbbb-bbbb-4bbb-9bbb-bbbbbbbbbbbb\",\n                \"applicationStatus\": \"Approved Pending Funding\",\n                \"accountNumber\": 300012101,\n                \"adminStatusDescription\": \"Ready to Export\",\n                \"fullName\": \"Smith, John\"\n            }\n        ]\n    },\n    \"errors\": []\n}"},{"id":"ebbc62fc-611f-458b-ad89-cd64672ce7c9","name":"GetExportQueue - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/ExportQueue?pageSize=0&currentPage=0&token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","ExportQueue"],"query":[{"key":"pageSize","value":"0"},{"key":"currentPage","value":"0"},{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving export queue: Invalid session token\"\n    ]\n}"}],"_postman_id":"c55032a0-1fba-467a-9af3-ddaf7d522313"},{"name":"GroupCreate","id":"52d13416-e5e4-4c6d-9e68-aab309e80941","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Prime Auto\",\n  \"active\": true,\n  \"usePreSelectionMode\": false,\n  \"useVerificationMode\": true,\n  \"notes\": \"Default group for prime auto applications.\",\n  \"declinedAdministrativeStatusOrId\": \"DECL\",\n  \"counterOfferAdministrativeStatusOrId\": \"COFR\",\n  \"counterOfferAcceptedAdministrativeStatusOrId\": \"COFRA\",\n  \"withdrawnAdministrativeStatusOrId\": \"WDRN\",\n  \"fundedAdministrativeStatusOrId\": \"FUND\",\n  \"exportedAdministrativeStatusOrId\": \"EXPT\",\n  \"expiredAdministrativeStatusOrId\": \"EXPD\",\n  \"entryInProgressAdministrativeStatusOrId\": \"ENIP\",\n  \"pendingDecisionAdministrativeStatusOrId\": \"PNDN\",\n  \"approvedPendingVerificationAdministrativeStatusOrId\": \"APVV\",\n  \"approvedPendingFundingAdministrativeStatusOrId\": \"APVF\",\n  \"pullExperianReport\": true,\n  \"pullTransUnionReport\": true,\n  \"pullEquifaxReport\": false,\n  \"allowDealerPortal\": true,\n  \"allowThirdParty\": false,\n  \"allowManualImport\": true,\n  \"equifaxCreditInquiryPullOption\": 1,\n  \"experianCreditInquiryPullOption\": 1,\n  \"transunionCreditInquiryPullOption\": 1,\n  \"loanDealInfoDeclineReasonNumberOrId\": \"1\",\n  \"additionalLoanOptionsDeclineReasonNumberOrId\": null,\n  \"borrowerDeclineReasonNumberOrId\": \"2\",\n  \"coborrowerDeclineReasonNumberOrId\": null,\n  \"collateralDeclineReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Group?token={{token}}","description":"<h3 id=\"create-group\">Create Group</h3>\n<p>Creates a new <code>Originations.Group</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>GroupController.CreateGroup</code> -&gt; <code>GroupWSServices.CreateGroupWS</code> -&gt; <code>Omega.Originations.BLL.GroupServices.AddGroup</code> committed through a single <code>UnitOfWork2</code>. The service resolves each administrative-status and decline-reason reference via <code>SharedWSServices.GetCommonAdminStatusId</code> / <code>SharedWSServices.GetOriginationsDeclineReasonId</code> and returns a BadRequest if any lookup fails.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Group</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CreateGroupParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Group description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>usePreSelectionMode</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>useVerificationMode</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>String. Free-form internal notes.</td>\n</tr>\n<tr>\n<td><em>declinedAdministrativeStatusOrId</em></td>\n<td>String. Guid <code>Id</code> or administrative-status code for declined applications.</td>\n</tr>\n<tr>\n<td><em>counterOfferAdministrativeStatusOrId</em></td>\n<td>String. Status used when a counter offer is generated.</td>\n</tr>\n<tr>\n<td><em>counterOfferAcceptedAdministrativeStatusOrId</em></td>\n<td>String. Status when the counter offer is accepted.</td>\n</tr>\n<tr>\n<td><em>withdrawnAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>fundedAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>exportedAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>expiredAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>entryInProgressAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>pendingDecisionAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>approvedPendingVerificationAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>approvedPendingFundingAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>pullExperianReport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>pullTransUnionReport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>pullEquifaxReport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>allowDealerPortal</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>allowThirdParty</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>allowManualImport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>equifaxCreditInquiryPullOption</em></td>\n<td>Nullable int. Maps to the credit-inquiry pull-option enum.</td>\n</tr>\n<tr>\n<td><em>experianCreditInquiryPullOption</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>transunionCreditInquiryPullOption</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>loanDealInfoDeclineReasonNumberOrId</em></td>\n<td>String. Guid <code>Id</code> or decline-reason number scoped to the caller's <code>OmegaClientId</code>.</td>\n</tr>\n<tr>\n<td><em>additionalLoanOptionsDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>borrowerDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>coborrowerDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>collateralDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new group Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Description is required\"]</code> when <code>description</code> is empty, or <code>[\"{fieldName} '{value}' not found\"]</code> when an administrative-status or decline-reason reference cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Group"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ee02092a-b72a-440e-99f4-39208f6285b3","name":"CreateGroup - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Prime Auto\",\n  \"active\": true,\n  \"usePreSelectionMode\": false,\n  \"useVerificationMode\": true,\n  \"notes\": \"Default group for prime auto applications.\",\n  \"declinedAdministrativeStatusOrId\": \"DECL\",\n  \"counterOfferAdministrativeStatusOrId\": \"COFR\",\n  \"counterOfferAcceptedAdministrativeStatusOrId\": \"COFRA\",\n  \"withdrawnAdministrativeStatusOrId\": \"WDRN\",\n  \"fundedAdministrativeStatusOrId\": \"FUND\",\n  \"exportedAdministrativeStatusOrId\": \"EXPT\",\n  \"expiredAdministrativeStatusOrId\": \"EXPD\",\n  \"entryInProgressAdministrativeStatusOrId\": \"ENIP\",\n  \"pendingDecisionAdministrativeStatusOrId\": \"PNDN\",\n  \"approvedPendingVerificationAdministrativeStatusOrId\": \"APVV\",\n  \"approvedPendingFundingAdministrativeStatusOrId\": \"APVF\",\n  \"pullExperianReport\": true,\n  \"pullTransUnionReport\": true,\n  \"pullEquifaxReport\": false,\n  \"allowDealerPortal\": true,\n  \"allowThirdParty\": false,\n  \"allowManualImport\": true,\n  \"equifaxCreditInquiryPullOption\": 1,\n  \"experianCreditInquiryPullOption\": 1,\n  \"transunionCreditInquiryPullOption\": 1,\n  \"loanDealInfoDeclineReasonNumberOrId\": \"1\",\n  \"additionalLoanOptionsDeclineReasonNumberOrId\": null,\n  \"borrowerDeclineReasonNumberOrId\": \"2\",\n  \"coborrowerDeclineReasonNumberOrId\": null,\n  \"collateralDeclineReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"77c718f7-ac41-486c-a1a8-7aa08b3a17f3","name":"CreateGroup - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"active\": true,\n  \"usePreSelectionMode\": false,\n  \"useVerificationMode\": true,\n  \"notes\": \"Default group for prime auto applications.\",\n  \"declinedAdministrativeStatusOrId\": \"DECL\",\n  \"counterOfferAdministrativeStatusOrId\": \"COFR\",\n  \"counterOfferAcceptedAdministrativeStatusOrId\": \"COFRA\",\n  \"withdrawnAdministrativeStatusOrId\": \"WDRN\",\n  \"fundedAdministrativeStatusOrId\": \"FUND\",\n  \"exportedAdministrativeStatusOrId\": \"EXPT\",\n  \"expiredAdministrativeStatusOrId\": \"EXPD\",\n  \"entryInProgressAdministrativeStatusOrId\": \"ENIP\",\n  \"pendingDecisionAdministrativeStatusOrId\": \"PNDN\",\n  \"approvedPendingVerificationAdministrativeStatusOrId\": \"APVV\",\n  \"approvedPendingFundingAdministrativeStatusOrId\": \"APVF\",\n  \"pullExperianReport\": true,\n  \"pullTransUnionReport\": true,\n  \"pullEquifaxReport\": false,\n  \"allowDealerPortal\": true,\n  \"allowThirdParty\": false,\n  \"allowManualImport\": true,\n  \"equifaxCreditInquiryPullOption\": 1,\n  \"experianCreditInquiryPullOption\": 1,\n  \"transunionCreditInquiryPullOption\": 1,\n  \"loanDealInfoDeclineReasonNumberOrId\": \"1\",\n  \"additionalLoanOptionsDeclineReasonNumberOrId\": null,\n  \"borrowerDeclineReasonNumberOrId\": \"2\",\n  \"coborrowerDeclineReasonNumberOrId\": null,\n  \"collateralDeclineReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ]\n}"}],"_postman_id":"52d13416-e5e4-4c6d-9e68-aab309e80941"},{"name":"GroupGet","id":"decaf11c-e22d-4409-b9e5-e52faf3c7de8","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Group/{{group_number_or_id}}?token={{token}}","description":"<h3 id=\"get-group-by-number-or-id\">Get Group by Number or Id</h3>\n<p>Returns a single <code>Originations.Group</code> row resolved from <code>{numberOrId}</code>. Backed by <code>GroupController.GetGroup</code> -&gt; <code>GroupWSServices.GetGroupWS</code> -&gt; <code>SharedWSServices.GetOriginationsGroupId</code> then <code>Omega.Originations.BLL.GroupServices.ReturnGroup</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Group/{numberOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the system group number scoped to the caller's <code>OmegaClientId</code>. <code>SharedWSServices.GetOriginationsGroupId</code> first tries <code>Guid.TryParse</code>; if that fails, a <code>Client</code> session falls back to the numeric lookup.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an <code>Originations.Group</code> entity with the same shape documented on the <code>Get All Groups</code> endpoint.</p>\n<p>Returns BadRequest with <code>errors</code> entry <code>[\"Group not found\"]</code> when the value cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Group","{{group_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"cc699a67-7ac5-4b06-be29-496c2686ae65","name":"GetGroup - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA4=\",\n        \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n        \"Description\": \"Prime Auto\",\n        \"Active\": true,\n        \"UsePreSelectionMode\": false,\n        \"UseVerificationMode\": true,\n        \"Notes\": \"Default group for prime auto applications.\",\n        \"DeclinedAdministrativeStatusId\": \"33333333-3333-4333-9333-333333333333\",\n        \"CounterOfferAdministrativeStatusId\": \"44444444-4444-4444-9444-444444444444\",\n        \"CounterOfferAcceptedAdministrativeStatusId\": \"55555555-5555-4555-9555-555555555555\",\n        \"WithdrawnAdministrativeStatusId\": \"66666666-6666-4666-9666-666666666666\",\n        \"FundedAdministrativeStatusId\": \"77777777-7777-4777-9777-777777777777\",\n        \"ExportedAdministrativeStatusId\": \"88888888-8888-4888-9888-888888888888\",\n        \"ExpiredAdministrativeStatusId\": \"99999999-9999-4999-9999-999999999999\",\n        \"EntryInProgressAdministrativeStatusId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n        \"PendingDecisionAdministrativeStatusId\": \"bbbbbbbb-bbbb-4bbb-9bbb-bbbbbbbbbbbb\",\n        \"ApprovedPendingVerificationAdministrativeStatusId\": \"cccccccc-cccc-4ccc-9ccc-cccccccccccc\",\n        \"ApprovedPendingFundingAdministrativeStatusId\": \"dddddddd-dddd-4ddd-9ddd-dddddddddddd\",\n        \"PullExperianReport\": true,\n        \"PullTransUnionReport\": true,\n        \"PullEquifaxReport\": false,\n        \"AllowDealerPortal\": true,\n        \"AllowThirdParty\": false,\n        \"AllowManualImport\": true,\n        \"EquifaxCreditInquiryPullOption\": 1,\n        \"ExperianCreditInquiryPullOption\": 1,\n        \"TransunionCreditInquiryPullOption\": 1,\n        \"LoanDealInfoDeclineReasonId\": \"eeeeeeee-eeee-4eee-9eee-eeeeeeeeeeee\",\n        \"AdditionalLoanOptionsDeclineReasonId\": null,\n        \"BorrowerDeclineReasonId\": \"ffffffff-ffff-4fff-9fff-ffffffffffff\",\n        \"CoborrowerDeclineReasonId\": null,\n        \"CollateralDeclineReasonId\": null\n    },\n    \"errors\": []\n}"},{"id":"49b7c538-972c-457b-b486-86e3d9fc3b0b","name":"GetGroup - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group/99999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group","99999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Group not found\"\n    ]\n}"}],"_postman_id":"decaf11c-e22d-4409-b9e5-e52faf3c7de8"},{"name":"GroupsGetAll","id":"95c1aa63-9358-4ace-ac46-197acbe7f284","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Group?token={{token}}","description":"<h3 id=\"get-all-groups\">Get All Groups</h3>\n<p>Returns every <code>Originations.Group</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>GroupController.GetAllGroups</code> -&gt; <code>GroupWSServices.GetAllGroupsWS</code>. The response is an LLBLGen <code>EntityCollection&lt;MyOriginationsGroupEntity&gt;</code> filtered by <code>OriginationsGroupFields.OmegaClientId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Group</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Originations.Group</code> entities. Key fields include <code>Id</code>, <code>Ts</code>, <code>OmegaClientId</code>, <code>Description</code>, <code>Active</code>, <code>UsePreSelectionMode</code>, <code>UseVerificationMode</code>, <code>Notes</code>, <code>PullExperianReport</code>, <code>PullTransUnionReport</code>, <code>PullEquifaxReport</code>, <code>AllowDealerPortal</code>, <code>AllowThirdParty</code>, <code>AllowManualImport</code>, <code>EquifaxCreditInquiryPullOption</code>, <code>ExperianCreditInquiryPullOption</code>, <code>TransunionCreditInquiryPullOption</code>, and the eleven administrative status reference columns (<code>DeclinedAdministrativeStatusId</code>, <code>CounterOfferAdministrativeStatusId</code>, <code>CounterOfferAcceptedAdministrativeStatusId</code>, <code>WithdrawnAdministrativeStatusId</code>, <code>FundedAdministrativeStatusId</code>, <code>ExportedAdministrativeStatusId</code>, <code>ExpiredAdministrativeStatusId</code>, <code>EntryInProgressAdministrativeStatusId</code>, <code>PendingDecisionAdministrativeStatusId</code>, <code>ApprovedPendingVerificationAdministrativeStatusId</code>, <code>ApprovedPendingFundingAdministrativeStatusId</code>), plus the five decline reason reference columns (<code>LoanDealInfoDeclineReasonId</code>, <code>AdditionalLoanOptionsDeclineReasonId</code>, <code>BorrowerDeclineReasonId</code>, <code>CoborrowerDeclineReasonId</code>, <code>CollateralDeclineReasonId</code>).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Group"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"08f2e89f-261a-43f2-967a-7e23b2ca775e","name":"GetAllGroups - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"Prime Auto\",\n            \"Active\": true,\n            \"UsePreSelectionMode\": false,\n            \"UseVerificationMode\": true,\n            \"Notes\": \"Default group for prime auto applications.\",\n            \"DeclinedAdministrativeStatusId\": \"33333333-3333-4333-9333-333333333333\",\n            \"CounterOfferAdministrativeStatusId\": \"44444444-4444-4444-9444-444444444444\",\n            \"CounterOfferAcceptedAdministrativeStatusId\": \"55555555-5555-4555-9555-555555555555\",\n            \"WithdrawnAdministrativeStatusId\": \"66666666-6666-4666-9666-666666666666\",\n            \"FundedAdministrativeStatusId\": \"77777777-7777-4777-9777-777777777777\",\n            \"ExportedAdministrativeStatusId\": \"88888888-8888-4888-9888-888888888888\",\n            \"ExpiredAdministrativeStatusId\": \"99999999-9999-4999-9999-999999999999\",\n            \"EntryInProgressAdministrativeStatusId\": \"aaaaaaaa-aaaa-4aaa-9aaa-aaaaaaaaaaaa\",\n            \"PendingDecisionAdministrativeStatusId\": \"bbbbbbbb-bbbb-4bbb-9bbb-bbbbbbbbbbbb\",\n            \"ApprovedPendingVerificationAdministrativeStatusId\": \"cccccccc-cccc-4ccc-9ccc-cccccccccccc\",\n            \"ApprovedPendingFundingAdministrativeStatusId\": \"dddddddd-dddd-4ddd-9ddd-dddddddddddd\",\n            \"PullExperianReport\": true,\n            \"PullTransUnionReport\": true,\n            \"PullEquifaxReport\": false,\n            \"AllowDealerPortal\": true,\n            \"AllowThirdParty\": false,\n            \"AllowManualImport\": true,\n            \"EquifaxCreditInquiryPullOption\": 1,\n            \"ExperianCreditInquiryPullOption\": 1,\n            \"TransunionCreditInquiryPullOption\": 1,\n            \"LoanDealInfoDeclineReasonId\": \"eeeeeeee-eeee-4eee-9eee-eeeeeeeeeeee\",\n            \"AdditionalLoanOptionsDeclineReasonId\": null,\n            \"BorrowerDeclineReasonId\": \"ffffffff-ffff-4fff-9fff-ffffffffffff\",\n            \"CoborrowerDeclineReasonId\": null,\n            \"CollateralDeclineReasonId\": null\n        }\n    ],\n    \"errors\": []\n}"},{"id":"e3c84d2e-3e13-4d3a-8f87-ce90a44f0e00","name":"GetAllGroups - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid token\"\n    ]\n}"}],"_postman_id":"95c1aa63-9358-4ace-ac46-197acbe7f284"},{"name":"GroupUpdate","id":"b47d5a84-a7e4-43e5-bfd7-0e239b01b278","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Prime Auto (updated)\",\n  \"active\": true,\n  \"usePreSelectionMode\": false,\n  \"useVerificationMode\": true,\n  \"notes\": \"Default group for prime auto applications (updated).\",\n  \"declinedAdministrativeStatusOrId\": \"DECL\",\n  \"counterOfferAdministrativeStatusOrId\": \"COFR\",\n  \"counterOfferAcceptedAdministrativeStatusOrId\": \"COFRA\",\n  \"withdrawnAdministrativeStatusOrId\": \"WDRN\",\n  \"fundedAdministrativeStatusOrId\": \"FUND\",\n  \"exportedAdministrativeStatusOrId\": \"EXPT\",\n  \"expiredAdministrativeStatusOrId\": \"EXPD\",\n  \"entryInProgressAdministrativeStatusOrId\": \"ENIP\",\n  \"pendingDecisionAdministrativeStatusOrId\": \"PNDN\",\n  \"approvedPendingVerificationAdministrativeStatusOrId\": \"APVV\",\n  \"approvedPendingFundingAdministrativeStatusOrId\": \"APVF\",\n  \"pullExperianReport\": true,\n  \"pullTransUnionReport\": true,\n  \"pullEquifaxReport\": false,\n  \"allowDealerPortal\": true,\n  \"allowThirdParty\": false,\n  \"allowManualImport\": true,\n  \"equifaxCreditInquiryPullOption\": 1,\n  \"experianCreditInquiryPullOption\": 1,\n  \"transunionCreditInquiryPullOption\": 1,\n  \"loanDealInfoDeclineReasonNumberOrId\": \"1\",\n  \"additionalLoanOptionsDeclineReasonNumberOrId\": null,\n  \"borrowerDeclineReasonNumberOrId\": \"2\",\n  \"coborrowerDeclineReasonNumberOrId\": null,\n  \"collateralDeclineReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Group/{{group_number_or_id}}?token={{token}}","description":"<h3 id=\"update-group\">Update Group</h3>\n<p>Updates an existing <code>Originations.Group</code> row resolved from <code>{numberOrId}</code>. Backed by <code>GroupController.UpdateGroup</code> -&gt; <code>GroupWSServices.UpdateGroupWS</code> -&gt; <code>Omega.Originations.BLL.GroupServices.SaveGroupChanges</code> committed through a single <code>UnitOfWork2</code>. The server loads the existing row to pick up the current <code>Ts</code> used for optimistic concurrency, and validates every administrative-status and decline-reason reference before saving.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Group/{numberOrId}</code></p>\n<h4 id=\"route--query-parameters\">Route / Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string (route). Either the Guid <code>Id</code> or the group number.</td>\n</tr>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateGroupParameter</code>. Mirrors the <code>CreateGroupParameter</code> shape (same fields and validation rules).</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>usePreSelectionMode</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>useVerificationMode</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>declinedAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>counterOfferAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>counterOfferAcceptedAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>withdrawnAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>fundedAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>exportedAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>expiredAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>entryInProgressAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>pendingDecisionAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>approvedPendingVerificationAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>approvedPendingFundingAdministrativeStatusOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>pullExperianReport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>pullTransUnionReport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>pullEquifaxReport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>allowDealerPortal</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>allowThirdParty</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>allowManualImport</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>equifaxCreditInquiryPullOption</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>experianCreditInquiryPullOption</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>transunionCreditInquiryPullOption</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>loanDealInfoDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>additionalLoanOptionsDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>borrowerDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>coborrowerDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>collateralDeclineReasonNumberOrId</em></td>\n<td>String.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the resolved group Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Group not found\"]</code> when the value cannot be resolved, <code>[\"Description is required\"]</code> when <code>description</code> is empty, or <code>[\"{fieldName} '{value}' not found\"]</code> when an administrative-status or decline-reason reference cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Group","{{group_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5706e7e1-9413-491e-bd5c-2266e1bdf55c","name":"UpdateGroup - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Prime Auto (updated)\",\n  \"active\": true,\n  \"usePreSelectionMode\": false,\n  \"useVerificationMode\": true,\n  \"notes\": \"Default group for prime auto applications (updated).\",\n  \"declinedAdministrativeStatusOrId\": \"DECL\",\n  \"counterOfferAdministrativeStatusOrId\": \"COFR\",\n  \"counterOfferAcceptedAdministrativeStatusOrId\": \"COFRA\",\n  \"withdrawnAdministrativeStatusOrId\": \"WDRN\",\n  \"fundedAdministrativeStatusOrId\": \"FUND\",\n  \"exportedAdministrativeStatusOrId\": \"EXPT\",\n  \"expiredAdministrativeStatusOrId\": \"EXPD\",\n  \"entryInProgressAdministrativeStatusOrId\": \"ENIP\",\n  \"pendingDecisionAdministrativeStatusOrId\": \"PNDN\",\n  \"approvedPendingVerificationAdministrativeStatusOrId\": \"APVV\",\n  \"approvedPendingFundingAdministrativeStatusOrId\": \"APVF\",\n  \"pullExperianReport\": true,\n  \"pullTransUnionReport\": true,\n  \"pullEquifaxReport\": false,\n  \"allowDealerPortal\": true,\n  \"allowThirdParty\": false,\n  \"allowManualImport\": true,\n  \"equifaxCreditInquiryPullOption\": 1,\n  \"experianCreditInquiryPullOption\": 1,\n  \"transunionCreditInquiryPullOption\": 1,\n  \"loanDealInfoDeclineReasonNumberOrId\": \"1\",\n  \"additionalLoanOptionsDeclineReasonNumberOrId\": null,\n  \"borrowerDeclineReasonNumberOrId\": \"2\",\n  \"coborrowerDeclineReasonNumberOrId\": null,\n  \"collateralDeclineReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"13431974-f5b4-4ee7-a055-9c7df7c3f1b1","name":"UpdateGroup - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Prime Auto (updated)\",\n  \"active\": true,\n  \"usePreSelectionMode\": false,\n  \"useVerificationMode\": true,\n  \"notes\": \"Default group for prime auto applications (updated).\",\n  \"declinedAdministrativeStatusOrId\": \"DECL\",\n  \"counterOfferAdministrativeStatusOrId\": \"COFR\",\n  \"counterOfferAcceptedAdministrativeStatusOrId\": \"COFRA\",\n  \"withdrawnAdministrativeStatusOrId\": \"WDRN\",\n  \"fundedAdministrativeStatusOrId\": \"FUND\",\n  \"exportedAdministrativeStatusOrId\": \"EXPT\",\n  \"expiredAdministrativeStatusOrId\": \"EXPD\",\n  \"entryInProgressAdministrativeStatusOrId\": \"ENIP\",\n  \"pendingDecisionAdministrativeStatusOrId\": \"PNDN\",\n  \"approvedPendingVerificationAdministrativeStatusOrId\": \"APVV\",\n  \"approvedPendingFundingAdministrativeStatusOrId\": \"APVF\",\n  \"pullExperianReport\": true,\n  \"pullTransUnionReport\": true,\n  \"pullEquifaxReport\": false,\n  \"allowDealerPortal\": true,\n  \"allowThirdParty\": false,\n  \"allowManualImport\": true,\n  \"equifaxCreditInquiryPullOption\": 1,\n  \"experianCreditInquiryPullOption\": 1,\n  \"transunionCreditInquiryPullOption\": 1,\n  \"loanDealInfoDeclineReasonNumberOrId\": \"1\",\n  \"additionalLoanOptionsDeclineReasonNumberOrId\": null,\n  \"borrowerDeclineReasonNumberOrId\": \"2\",\n  \"coborrowerDeclineReasonNumberOrId\": null,\n  \"collateralDeclineReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Group/9999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Group","9999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Group not found\"\n    ]\n}"}],"_postman_id":"b47d5a84-a7e4-43e5-bfd7-0e239b01b278"},{"name":"Preselection","id":"51f3b0b4-bf85-43da-8f8e-4acd2e823d67","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"criteria\": [\n    {\n      \"criteriaId\": 1,\n      \"include\": true,\n      \"preApproval\": \"700\",\n      \"decline\": \"600\"\n    },\n    {\n      \"criteriaId\": 12,\n      \"include\": true,\n      \"preApproval\": \"0\",\n      \"decline\": \"3\"\n    },\n    {\n      \"criteriaId\": 21,\n      \"include\": false,\n      \"preApproval\": \"\",\n      \"decline\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Program/{{originations_program_number_or_id}}/Preselection?token={{token}}","description":"<h3 id=\"save-preselection\">Save Preselection</h3>\n<p>Saves the preselection criteria configuration for a program. Backed by <code>ProgramController.SavePreselection</code> -&gt; <code>PreselectionWSServices.SavePreselectionWS</code> -&gt; <code>Omega.Originations.BLL.PreselectionServices.AddSavePreselection</code> committed through a single <code>UnitOfWork2</code>. The route segment <code>numberOrId</code> is resolved through <code>SharedWSServices.GetOriginationsProgramId</code>. The internal client edition is loaded via <code>SetupInternal.BLL.ClientServices.ReturnInternalClientWithId</code> and passed to the BLL.</p>\n<p>The service first loads the program via <code>ProgramServices.ReturnProgram</code> and the existing preselection <code>DataTable</code> via <code>PreselectionServices.ReturnPreselectionSetupTable</code>, then merges the supplied <code>criteria</code> entries by matching <code>criteriaId</code> against the table's <code>Id</code> primary key. After merging, validation runs:</p>\n<ul>\n<li>When the program has <code>UsePreSelection = true</code>, at least one of <code>UseAutoDecline</code> or <code>UseAutoPreApproval</code> must be enabled on the program (otherwise: <code>[\"Auto decline or approve must be selected to use pre-selection\"]</code>).</li>\n<li>At least one criteria row must be marked <code>include: true</code> (otherwise: <code>[\"A criteria must be included in the selection\"]</code>).</li>\n<li>Each included row's <code>preApproval</code> (when auto-approve is on) and <code>decline</code> (when auto-decline is on) must be non-empty (otherwise: <code>[\"Included criteria cannot be empty\"]</code>).</li>\n<li>When both auto-approve and auto-decline are on, the <code>preApproval</code>/<code>decline</code> pair must form a valid range based on the criteria's data type and direction (otherwise: <code>[\"Criteria id 'N' has an invalid approval and decline range\"]</code>).</li>\n</ul>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program/{numberOrId}/Preselection</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Program Guid <code>Id</code> or numeric program <code>Number</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdatePreselectionParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>criteria</em></td>\n<td>Required array. Each entry is a <code>PreselectionCriteriaUpdate</code> with <code>criteriaId</code> (int matching a <code>PreselectionServices.Criterias</code> enum value), <code>include</code> (bool), <code>preApproval</code> (string), and <code>decline</code> (string).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the program Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"At least one criteria entry is required\"]</code>, <code>[\"Program not found\"]</code>, <code>[\"Criteria id 'N' not found\"]</code>, <code>[\"Auto decline or approve must be selected to use pre-selection\"]</code>, <code>[\"A criteria must be included in the selection\"]</code>, <code>[\"Included criteria cannot be empty\"]</code>, or <code>[\"Criteria id 'N' has an invalid approval and decline range\"]</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program","{{originations_program_number_or_id}}","Preselection"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ffa16d9b-641d-49eb-8c12-2a1c04d61d22","name":"SavePreselection - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"criteria\": [\n    {\n      \"criteriaId\": 1,\n      \"include\": true,\n      \"preApproval\": \"700\",\n      \"decline\": \"600\"\n    },\n    {\n      \"criteriaId\": 12,\n      \"include\": true,\n      \"preApproval\": \"0\",\n      \"decline\": \"3\"\n    },\n    {\n      \"criteriaId\": 21,\n      \"include\": false,\n      \"preApproval\": \"\",\n      \"decline\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/1/Preselection?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","1","Preselection"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"6d7b2ee9-0c8e-4828-9ee5-41314e7cf4a2","name":"SavePreselection - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"criteria\": [\n    {\n      \"criteriaId\": 1,\n      \"include\": false,\n      \"preApproval\": \"\",\n      \"decline\": \"\"\n    },\n    {\n      \"criteriaId\": 12,\n      \"include\": false,\n      \"preApproval\": \"\",\n      \"decline\": \"\"\n    },\n    {\n      \"criteriaId\": 21,\n      \"include\": false,\n      \"preApproval\": \"\",\n      \"decline\": \"\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/1/Preselection?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","1","Preselection"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A criteria must be included in the selection\"\n    ]\n}"}],"_postman_id":"51f3b0b4-bf85-43da-8f8e-4acd2e823d67"},{"name":"Preselection","id":"0b9983cb-5b73-49ff-9fe4-4504ec0cdccd","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Program/{{originations_program_number_or_id}}/Preselection?token={{token}}","description":"<h3 id=\"get-preselection\">Get Preselection</h3>\n<p>Returns the preselection setup table for a program. Backed by <code>ProgramController.GetPreselection</code> -&gt; <code>PreselectionWSServices.GetPreselectionWS</code> -&gt; <code>Omega.Originations.BLL.PreselectionServices.ReturnPreselectionSetupTable</code>. The route segment <code>numberOrId</code> is resolved through <code>SharedWSServices.GetOriginationsProgramId</code>.</p>\n<p>The returned <code>data</code> is the serialized <code>DataTable</code> produced by <code>ReturnPreselectionSetupTable</code>. Each row represents one entry of the <code>PreselectionServices.Criterias</code> enum (e.g. <code>Minimum_Custom_Score_1</code>, <code>Maximum_Number_Of_Late_Payments</code>, <code>Primary_Maximum_Number_Of_Charge_Offs</code>) with the saved values for this program. Important columns include <code>Id</code> (criteria enum value), <code>Description</code>, <code>ValueType</code> (matches <code>PreselectionServices.CriteriaDataType</code>), <code>Include</code>, <code>PreApproval</code>, and <code>Decline</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program/{numberOrId}/Preselection</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Program Guid <code>Id</code> or numeric program <code>Number</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the preselection criteria <code>DataTable</code> for the program.</p>\n<p>Returns BadRequest with <code>errors</code>: <code>[\"Program not found\"]</code> if the program identifier cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program","{{originations_program_number_or_id}}","Preselection"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6fa7f848-9de7-487c-8278-6929322dd56e","name":"GetPreselection - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/1/Preselection?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","1","Preselection"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": 1,\n            \"Description\": \"Minimum Custom Score 1\",\n            \"ValueType\": \"Integer\",\n            \"Include\": true,\n            \"PreApproval\": \"700\",\n            \"Decline\": \"600\"\n        },\n        {\n            \"Id\": 12,\n            \"Description\": \"Maximum Number Of Late Payments\",\n            \"ValueType\": \"Integer\",\n            \"Include\": true,\n            \"PreApproval\": \"0\",\n            \"Decline\": \"3\"\n        },\n        {\n            \"Id\": 21,\n            \"Description\": \"Primary Maximum Number Of Charge Offs\",\n            \"ValueType\": \"Integer\",\n            \"Include\": false,\n            \"PreApproval\": \"\",\n            \"Decline\": \"\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"5d8507f7-a6e1-4735-9a7e-250ebbf04b7c","name":"GetPreselection - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/9999/Preselection?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","9999","Preselection"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Program not found\"\n    ]\n}"}],"_postman_id":"0b9983cb-5b73-49ff-9fe4-4504ec0cdccd"},{"name":"ProgramCreate","id":"ab2f2d7d-07ab-4a7d-97ea-755e0ab0267b","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Standard Auto\",\n  \"collateralCodeOrId\": \"AUTO\",\n  \"defaultSameAsCashDays\": 90,\n  \"active\": true,\n  \"usePreSelection\": true,\n  \"useAutoDecline\": true,\n  \"useAutoApprove\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Program?token={{token}}","description":"<h3 id=\"create-program\">Create Program</h3>\n<p>Creates a new <code>Originations.Program</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>ProgramController.CreateProgram</code> -&gt; <code>ProgramWSServices.CreateProgramWS</code> -&gt; <code>Omega.Originations.BLL.ProgramServices.AddProgram</code> committed through a single <code>UnitOfWork2</code>. The service resolves the optional <code>collateralCodeOrId</code> via <code>SharedWSServices.GetCommonCollateralCodeId</code> and validates against <code>CollateralCodeServices.ReturnCollateralCode</code>. The internal client edition is loaded via <code>SetupInternal.BLL.ClientServices.ReturnInternalClientWithId</code> and passed to <code>AddProgram</code> so the BLL can apply edition-based limits.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CreateProgramParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Program description.</td>\n</tr>\n<tr>\n<td><em>collateralCodeOrId</em></td>\n<td>String. Guid <code>Id</code> or collateral code scoped to the caller's <code>OmegaClientId</code>. Optional.</td>\n</tr>\n<tr>\n<td><em>defaultSameAsCashDays</em></td>\n<td>Nullable int. Default Same-As-Cash days.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>usePreSelection</em></td>\n<td>Bool. Enables pre-selection mode for the program.</td>\n</tr>\n<tr>\n<td><em>useAutoDecline</em></td>\n<td>Bool. Enables auto-decline.</td>\n</tr>\n<tr>\n<td><em>useAutoApprove</em></td>\n<td>Bool. Enables auto-approval.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new program Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Description is required\"]</code> when <code>description</code> is empty, or <code>[\"Collateral code not found\"]</code> when the optional <code>collateralCodeOrId</code> cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"2b0cf3d1-bc12-4aaf-a3c5-f1667444afe9","name":"CreateProgram - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Standard Auto\",\n  \"collateralCodeOrId\": \"AUTO\",\n  \"defaultSameAsCashDays\": 90,\n  \"active\": true,\n  \"usePreSelection\": true,\n  \"useAutoDecline\": true,\n  \"useAutoApprove\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"0faa4e84-c778-46fd-8082-b7cc33096112","name":"CreateProgram - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"collateralCodeOrId\": \"AUTO\",\n  \"defaultSameAsCashDays\": 90,\n  \"active\": true,\n  \"usePreSelection\": true,\n  \"useAutoDecline\": true,\n  \"useAutoApprove\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ]\n}"}],"_postman_id":"ab2f2d7d-07ab-4a7d-97ea-755e0ab0267b"},{"name":"ProgramGet","id":"17dece9d-71e2-4166-9b68-458815b90d0c","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Program/{{originations_program_number_or_id}}?token={{token}}","description":"<h3 id=\"get-program\">Get Program</h3>\n<p>Returns a single <code>Originations.Program</code> row by Guid <code>Id</code> or program number scoped to the caller's <code>OmegaClientId</code>. Backed by <code>ProgramController.GetProgram</code> -&gt; <code>ProgramWSServices.GetProgramWS</code>. The route segment <code>numberOrId</code> is resolved through <code>SharedWSServices.GetOriginationsProgramId</code>, then the entity is loaded by <code>ProgramServices.ReturnProgram</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Program Guid <code>Id</code> or numeric program <code>Number</code>. Resolved by <code>SharedWSServices.GetOriginationsProgramId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a single <code>Originations.Program</code> entity with fields <code>Id</code>, <code>Ts</code>, <code>OmegaClientId</code>, <code>Number</code>, <code>Description</code>, <code>CollateralCodeId</code>, <code>DefaultSameAsCashDays</code>, <code>Active</code>, <code>UsePreSelection</code>, <code>UseAutoDecline</code>, <code>UseAutoPreApproval</code>, <code>LastChangedById</code>, and <code>LastChanged</code>.</p>\n<p>Returns BadRequest with <code>errors</code>: <code>[\"Program not found\"]</code> if the identifier cannot be resolved or the entity does not exist for this client.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program","{{originations_program_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e77e9935-0f90-4800-844a-36b4d435c8eb","name":"GetProgram - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA4=\",\n        \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n        \"Number\": 1,\n        \"Description\": \"Standard Auto\",\n        \"CollateralCodeId\": \"33333333-3333-4333-9333-333333333333\",\n        \"DefaultSameAsCashDays\": 90,\n        \"Active\": true,\n        \"UsePreSelection\": true,\n        \"UseAutoDecline\": true,\n        \"UseAutoPreApproval\": true,\n        \"LastChangedById\": \"44444444-4444-4444-9444-444444444444\",\n        \"LastChanged\": \"2026-04-01T12:00:00\"\n    },\n    \"errors\": []\n}"},{"id":"fabfa292-cada-465b-9cec-c1f4de224918","name":"GetProgram - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/9999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","9999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": -1,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Program not found\"\n    ]\n}"}],"_postman_id":"17dece9d-71e2-4166-9b68-458815b90d0c"},{"name":"ProgramIndirect","id":"f5ce9800-f9bc-4ca0-91f9-9fafc6ea1133","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"discountHoldbackBasisDescriptionOrId\": \"Amount Financed\",\n  \"discountPercent\": 2.50,\n  \"discountAmount\": null,\n  \"reserveHoldbackBasisDescriptionOrId\": \"Amount Financed\",\n  \"reservePercent\": 1.00,\n  \"reserveAmount\": null,\n  \"withholdHoldbackBasisDescriptionOrId\": null,\n  \"withholdPercent\": null,\n  \"withholdAmount\": null,\n  \"recourseTerm\": 90,\n  \"allowOverride\": false,\n  \"useOverAdvance\": true,\n  \"maxAdvanceBasis\": 1,\n  \"maxAdvancePercent\": 110.00,\n  \"maxAdvanceAdjustment\": 0.00,\n  \"overAdvanceBucket\": 1,\n  \"overAdvanceInsurancePolicyMarkup\": 1,\n  \"dealerTrackAprOption\": 1,\n  \"dealerTrackApr\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Program/{{originations_program_number_or_id}}/Indirect?token={{token}}","description":"<h3 id=\"save-program-indirect\">Save Program Indirect</h3>\n<p>Upserts the <code>Originations.ProgramIndirect</code> row tied to a program. Backed by <code>ProgramController.SaveProgramIndirect</code> -&gt; <code>ProgramIndirectWSServices.SaveProgramIndirectWS</code>. The route segment <code>numberOrId</code> is resolved via <code>SharedWSServices.GetOriginationsProgramId</code>, then <code>ProgramIndirectServices.ReturnProgramIndirect</code> is consulted - when no row exists the service calls <code>ProgramIndirectServices.AddProgramIndirect</code> with a new Guid, otherwise <code>ProgramIndirectServices.SaveProgramIndirect</code> reuses the existing <code>Id</code> and <code>Ts</code> for optimistic concurrency. All work commits through a single <code>UnitOfWork2</code>.</p>\n<p>Each <code>*HoldbackBasisDescriptionOrId</code> is resolved through <code>SharedWSServices.GetCommonHoldbackBasisId</code> and validated via <code>Common.BLL.HoldbackBasisServices.ReturnHoldbackBasis</code>. When <code>allowOverride</code> is <code>false</code> the matching <code>*Percent</code> and basis must both be supplied. When <code>useOverAdvance</code> is <code>true</code>, <code>maxAdvancePercent</code> must be positive and <code>maxAdvanceAdjustment</code> (if supplied) must be non-negative. <code>dealerTrackAprOption</code> must match the <code>DealerTrackAPROption</code> enum (1 = <code>Use_Program_APR_As_Default</code>, 2 = <code>Use_Program_APR_To_Override_Dealer_Track_APR</code>); <code>0</code> is treated as the default option.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program/{numberOrId}/Indirect</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Program Guid <code>Id</code> or numeric program <code>Number</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateProgramIndirectParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>discountHoldbackBasisDescriptionOrId</em></td>\n<td>String. Guid <code>Id</code> or description of a <code>Common.HoldbackBasis</code>.</td>\n</tr>\n<tr>\n<td><em>discountPercent</em></td>\n<td>Nullable decimal.</td>\n</tr>\n<tr>\n<td><em>discountAmount</em></td>\n<td>Nullable decimal.</td>\n</tr>\n<tr>\n<td><em>reserveHoldbackBasisDescriptionOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>reservePercent</em></td>\n<td>Nullable decimal.</td>\n</tr>\n<tr>\n<td><em>reserveAmount</em></td>\n<td>Nullable decimal.</td>\n</tr>\n<tr>\n<td><em>withholdHoldbackBasisDescriptionOrId</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>withholdPercent</em></td>\n<td>Nullable decimal.</td>\n</tr>\n<tr>\n<td><em>withholdAmount</em></td>\n<td>Nullable decimal.</td>\n</tr>\n<tr>\n<td><em>recourseTerm</em></td>\n<td>Int. Recourse term in days.</td>\n</tr>\n<tr>\n<td><em>allowOverride</em></td>\n<td>Bool. When <code>false</code>, each holdback basis and percent pair is required.</td>\n</tr>\n<tr>\n<td><em>useOverAdvance</em></td>\n<td>Bool. When <code>true</code>, <code>maxAdvancePercent</code> must be positive.</td>\n</tr>\n<tr>\n<td><em>maxAdvanceBasis</em></td>\n<td>Nullable int. Max advance basis enum value.</td>\n</tr>\n<tr>\n<td><em>maxAdvancePercent</em></td>\n<td>Nullable decimal. Required positive when <code>useOverAdvance</code> is true.</td>\n</tr>\n<tr>\n<td><em>maxAdvanceAdjustment</em></td>\n<td>Nullable decimal. Must be non-negative when supplied.</td>\n</tr>\n<tr>\n<td><em>overAdvanceBucket</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>overAdvanceInsurancePolicyMarkup</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>dealerTrackAprOption</em></td>\n<td>Int. 1 = <code>Use_Program_APR_As_Default</code>, 2 = <code>Use_Program_APR_To_Override_Dealer_Track_APR</code>. <code>0</code> is treated as the default option.</td>\n</tr>\n<tr>\n<td><em>dealerTrackApr</em></td>\n<td>Nullable decimal.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the program-indirect Guid <code>Id</code> as a string (newly generated on insert, or the existing <code>Id</code> on update).</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Program not found\"]</code>, <code>[\"Discount holdback basis not found\"]</code>, <code>[\"Discount holdback basis is required with percent when override is not allowed\"]</code>, <code>[\"Max Advance Percent must be positive\"]</code>, or <code>[\"Dealer Track APR option is invalid\"]</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program","{{originations_program_number_or_id}}","Indirect"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"3bdb968b-ce9a-423d-a3ba-8d369e4d85d2","name":"SaveProgramIndirect - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"discountHoldbackBasisDescriptionOrId\": \"Amount Financed\",\n  \"discountPercent\": 2.50,\n  \"discountAmount\": null,\n  \"reserveHoldbackBasisDescriptionOrId\": \"Amount Financed\",\n  \"reservePercent\": 1.00,\n  \"reserveAmount\": null,\n  \"withholdHoldbackBasisDescriptionOrId\": null,\n  \"withholdPercent\": null,\n  \"withholdAmount\": null,\n  \"recourseTerm\": 90,\n  \"allowOverride\": false,\n  \"useOverAdvance\": true,\n  \"maxAdvanceBasis\": 1,\n  \"maxAdvancePercent\": 110.00,\n  \"maxAdvanceAdjustment\": 0.00,\n  \"overAdvanceBucket\": 1,\n  \"overAdvanceInsurancePolicyMarkup\": 1,\n  \"dealerTrackAprOption\": 1,\n  \"dealerTrackApr\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/1/Indirect?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","1","Indirect"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"55555555-5555-4555-9555-555555555555\",\n    \"errors\": []\n}"},{"id":"7e1baac5-cd03-452b-953b-e75e726bd54a","name":"SaveProgramIndirect - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"discountHoldbackBasisDescriptionOrId\": \"Amount Financed\",\n  \"discountPercent\": 2.50,\n  \"discountAmount\": null,\n  \"reserveHoldbackBasisDescriptionOrId\": \"Amount Financed\",\n  \"reservePercent\": 1.00,\n  \"reserveAmount\": null,\n  \"withholdHoldbackBasisDescriptionOrId\": null,\n  \"withholdPercent\": null,\n  \"withholdAmount\": null,\n  \"recourseTerm\": 90,\n  \"allowOverride\": false,\n  \"useOverAdvance\": true,\n  \"maxAdvanceBasis\": 1,\n  \"maxAdvancePercent\": 110.00,\n  \"maxAdvanceAdjustment\": 0.00,\n  \"overAdvanceBucket\": 1,\n  \"overAdvanceInsurancePolicyMarkup\": 1,\n  \"dealerTrackAprOption\": 1,\n  \"dealerTrackApr\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/999999/Indirect?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","999999","Indirect"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Program not found\"\n    ]\n}"}],"_postman_id":"f5ce9800-f9bc-4ca0-91f9-9fafc6ea1133"},{"name":"ProgramIndirect","id":"b3fa61a3-c742-4e65-917a-e8008f959ee3","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Program/{{originations_program_number_or_id}}/Indirect?token={{token}}","description":"<h3 id=\"get-program-indirect\">Get Program Indirect</h3>\n<p>Returns the <code>Originations.ProgramIndirect</code> row tied to a specific program. Backed by <code>ProgramController.GetProgramIndirect</code> -&gt; <code>ProgramIndirectWSServices.GetProgramIndirectWS</code> -&gt; <code>Omega.Originations.BLL.ProgramIndirectServices.ReturnProgramIndirect</code>. The route segment <code>numberOrId</code> is resolved through <code>SharedWSServices.GetOriginationsProgramId</code> so callers can pass either the program Guid <code>Id</code> or the numeric program <code>Number</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program/{numberOrId}/Indirect</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Program Guid <code>Id</code> or numeric program <code>Number</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a single <code>Originations.ProgramIndirect</code> entity (or <code>null</code> when no indirect record has been saved yet for the program). Key fields include <code>Id</code>, <code>Ts</code>, <code>ProgramId</code>, <code>DiscountHoldbackBasisId</code>, <code>DiscountPercent</code>, <code>DiscountAmount</code>, <code>ReserveHoldbackBasisId</code>, <code>ReservePercent</code>, <code>ReserveAmount</code>, <code>WithholdHoldbackBasisId</code>, <code>WithholdPercent</code>, <code>WithholdAmount</code>, <code>RecourseTerm</code>, <code>AllowOverride</code>, <code>UseOverAdvance</code>, <code>MaxAdvanceBasis</code>, <code>MaxAdvancePercent</code>, <code>MaxAdvanceAdjustment</code>, <code>OverAdvanceBucket</code>, <code>OverAdvanceInsurancePolicyMarkup</code>, <code>DealerTrackAPROption</code>, and <code>DealerTrackAPR</code>.</p>\n<p>Returns BadRequest with <code>errors</code>: <code>[\"Program not found\"]</code> if the program identifier cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program","{{originations_program_number_or_id}}","Indirect"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"eaa9d51c-02b8-432b-b820-faa69c942fe9","name":"GetProgramIndirect - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/1/Indirect?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","1","Indirect"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"55555555-5555-4555-9555-555555555555\",\n        \"Ts\": \"AAAAAAAACA8=\",\n        \"ProgramId\": \"11111111-1111-4111-9111-111111111111\",\n        \"DiscountHoldbackBasisId\": \"66666666-6666-4666-9666-666666666666\",\n        \"DiscountPercent\": 2.50,\n        \"DiscountAmount\": null,\n        \"ReserveHoldbackBasisId\": \"77777777-7777-4777-9777-777777777777\",\n        \"ReservePercent\": 1.00,\n        \"ReserveAmount\": null,\n        \"WithholdHoldbackBasisId\": null,\n        \"WithholdPercent\": null,\n        \"WithholdAmount\": null,\n        \"RecourseTerm\": 90,\n        \"AllowOverride\": false,\n        \"UseOverAdvance\": true,\n        \"MaxAdvanceBasis\": 1,\n        \"MaxAdvancePercent\": 110.00,\n        \"MaxAdvanceAdjustment\": 0.00,\n        \"OverAdvanceBucket\": 1,\n        \"OverAdvanceInsurancePolicyMarkup\": 1,\n        \"DealerTrackAPROption\": 1,\n        \"DealerTrackAPR\": null\n    },\n    \"errors\": []\n}"},{"id":"cae65c2c-25f6-444b-ad4a-43fd0b69be15","name":"GetProgramIndirect - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/999999/Indirect?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","999999","Indirect"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Program not found\"\n    ]\n}"}],"_postman_id":"b3fa61a3-c742-4e65-917a-e8008f959ee3"},{"name":"ProgramsGetAll","id":"994251d8-82c1-4ba6-ad40-7ef3c09cb6f4","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Program?token={{token}}","description":"<h3 id=\"get-all-programs\">Get All Programs</h3>\n<p>Returns every <code>Originations.Program</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>ProgramController.GetAllPrograms</code> -&gt; <code>ProgramWSServices.GetAllProgramsWS</code>. The response is an LLBLGen <code>EntityCollection&lt;MyOriginationsProgramEntity&gt;</code> filtered by <code>OriginationsProgramFields.OmegaClientId</code> via a single <code>OmegaDataAccessAdapter.FetchEntityCollection</code> call.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Originations.Program</code> entities. Key fields include <code>Id</code>, <code>Ts</code>, <code>OmegaClientId</code>, <code>Number</code>, <code>Description</code>, <code>CollateralCodeId</code>, <code>DefaultSameAsCashDays</code>, <code>Active</code>, <code>UsePreSelection</code>, <code>UseAutoDecline</code>, <code>UseAutoPreApproval</code>, <code>LastChangedById</code>, and <code>LastChanged</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7c19332f-2b75-4867-9d1f-9ee548023db5","name":"GetAllPrograms - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Number\": 1,\n            \"Description\": \"Standard Auto\",\n            \"CollateralCodeId\": \"33333333-3333-4333-9333-333333333333\",\n            \"DefaultSameAsCashDays\": 90,\n            \"Active\": true,\n            \"UsePreSelection\": true,\n            \"UseAutoDecline\": true,\n            \"UseAutoPreApproval\": true,\n            \"LastChangedById\": \"44444444-4444-4444-9444-444444444444\",\n            \"LastChanged\": \"2026-04-01T12:00:00\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"7303f3bd-1ca8-491c-a629-c03a9a87088b","name":"GetAllPrograms - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid token\"\n    ]\n}"}],"_postman_id":"994251d8-82c1-4ba6-ad40-7ef3c09cb6f4"},{"name":"ProgramUpdate","id":"52e99850-49e9-488b-a2ff-b363c9050fb0","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Standard Auto\",\n  \"collateralCodeOrId\": \"AUTO\",\n  \"defaultSameAsCashDays\": 120,\n  \"active\": true,\n  \"usePreSelection\": true,\n  \"useAutoDecline\": true,\n  \"useAutoApprove\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Program/{{originations_program_number_or_id}}?token={{token}}","description":"<h3 id=\"update-program\">Update Program</h3>\n<p>Updates an existing <code>Originations.Program</code> row identified by Guid <code>Id</code> or program number scoped to the caller's <code>OmegaClientId</code>. Backed by <code>ProgramController.UpdateProgram</code> -&gt; <code>ProgramWSServices.UpdateProgramWS</code> -&gt; <code>Omega.Originations.BLL.ProgramServices.SaveProgram</code> committed through a single <code>UnitOfWork2</code>. The route segment <code>numberOrId</code> is resolved by <code>SharedWSServices.GetOriginationsProgramId</code>. The optional <code>collateralCodeOrId</code> is resolved by <code>SharedWSServices.GetCommonCollateralCodeId</code> and validated against <code>CollateralCodeServices.ReturnCollateralCode</code>. The existing entity's <code>Ts</code> is reused for optimistic concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Program/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Program Guid <code>Id</code> or numeric program <code>Number</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateProgramParameter</code> (same shape as <code>CreateProgramParameter</code>).</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Program description.</td>\n</tr>\n<tr>\n<td><em>collateralCodeOrId</em></td>\n<td>String. Guid <code>Id</code> or collateral code.</td>\n</tr>\n<tr>\n<td><em>defaultSameAsCashDays</em></td>\n<td>Nullable int.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>usePreSelection</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>useAutoDecline</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>useAutoApprove</em></td>\n<td>Bool.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the program Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Program not found\"]</code>, <code>[\"Description is required\"]</code>, or <code>[\"Collateral code not found\"]</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Program","{{originations_program_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"1e56b1d1-3d45-4505-a8fc-be65c24cb637","name":"UpdateProgram - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Standard Auto\",\n  \"collateralCodeOrId\": \"AUTO\",\n  \"defaultSameAsCashDays\": 120,\n  \"active\": true,\n  \"usePreSelection\": true,\n  \"useAutoDecline\": true,\n  \"useAutoApprove\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"0b12b78f-b061-4510-8035-3077d92a4212","name":"UpdateProgram - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Standard Auto\",\n  \"collateralCodeOrId\": \"AUTO\",\n  \"defaultSameAsCashDays\": 120,\n  \"active\": true,\n  \"usePreSelection\": true,\n  \"useAutoDecline\": true,\n  \"useAutoApprove\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Program/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Program","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Program not found\"\n    ]\n}"}],"_postman_id":"52e99850-49e9-488b-a2ff-b363c9050fb0"},{"name":"StipulationCreate","id":"48cc85dc-60be-4ed0-8cd7-a68eeb4d3b4b","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Proof of Income\",\n  \"active\": true,\n  \"assigneeType\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Stipulation?token={{token}}","description":"<h3 id=\"create-stipulation\">Create Stipulation</h3>\n<p>Creates a new <code>Originations.Stipulation</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>StipulationController.CreateStipulation</code> -&gt; <code>StipulationWSServices.CreateStipulationWS</code> -&gt; <code>Omega.Originations.BLL.StipulationServices.AddStipulation</code> committed through a single <code>UnitOfWork2</code>. The integer <code>assigneeType</code> is cast directly to <code>Omega.Originations.Types.AssigneeTypes</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Stipulation</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CreateStipulationParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Stipulation description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>assigneeType</em></td>\n<td>Int. Maps to <code>Omega.Originations.Types.AssigneeTypes</code> (1 = <code>Internal</code>, 2 = <code>Borrower</code>, 3 = <code>Dealer</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new stipulation Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code>: <code>[\"Description is required\"]</code> when <code>description</code> is empty.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Stipulation"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"99dd7dec-d0c7-4fb5-a4e1-8eb373977414","name":"CreateStipulation - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Proof of Income\",\n  \"active\": true,\n  \"assigneeType\": 2\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"e8752a50-4954-4b06-8c77-6fef10350dfd","name":"CreateStipulation - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"active\": true,\n  \"assigneeType\": 2\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ]\n}"}],"_postman_id":"48cc85dc-60be-4ed0-8cd7-a68eeb4d3b4b"},{"name":"StipulationGet","id":"18d9d295-3232-4c6d-9bdb-326e2d32c545","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Stipulation/{{originations_stipulation_number_or_id}}?token={{token}}","description":"<h3 id=\"get-stipulation\">Get Stipulation</h3>\n<p>Returns a single <code>Originations.Stipulation</code> row by Guid <code>Id</code> or stipulation number scoped to the caller's <code>OmegaClientId</code>. Backed by <code>StipulationController.GetStipulation</code> -&gt; <code>StipulationWSServices.GetStipulationWS</code>. The route segment <code>numberOrId</code> is resolved through <code>SharedWSServices.GetOriginationsStipulationId</code>, then the entity is loaded by <code>StipulationServices.ReturnStipulation</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Stipulation/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Stipulation Guid <code>Id</code> or numeric stipulation <code>Number</code>. Resolved by <code>SharedWSServices.GetOriginationsStipulationId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a single <code>Originations.Stipulation</code> entity with fields <code>Id</code>, <code>Ts</code>, <code>OmegaClientId</code>, <code>Number</code>, <code>Description</code>, <code>Active</code>, <code>AssigneeType</code>, <code>LastChangedById</code>, and <code>LastChanged</code>.</p>\n<p>Returns BadRequest with <code>errors</code>: <code>[\"Stipulation not found\"]</code> if the identifier cannot be resolved or the entity does not exist for this client.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Stipulation","{{originations_stipulation_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f13ffd41-006b-445f-8c2d-35ee50fee4ca","name":"GetStipulation - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA4=\",\n        \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n        \"Number\": 1,\n        \"Description\": \"Proof of Income\",\n        \"Active\": true,\n        \"AssigneeType\": 2,\n        \"LastChangedById\": \"33333333-3333-4333-9333-333333333333\",\n        \"LastChanged\": \"2026-04-01T12:00:00\"\n    },\n    \"errors\": []\n}"},{"id":"7dd30750-abd7-43dc-bacb-e1df21cb1a7f","name":"GetStipulation - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Stipulation not found\"\n    ]\n}"}],"_postman_id":"18d9d295-3232-4c6d-9bdb-326e2d32c545"},{"name":"StipulationsGetAll","id":"6caa890e-4a9c-41a8-8d8a-02b64561b5c2","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/Stipulation?token={{token}}","description":"<h3 id=\"get-all-stipulations\">Get All Stipulations</h3>\n<p>Returns every <code>Originations.Stipulation</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>StipulationController.GetAllStipulations</code> -&gt; <code>StipulationWSServices.GetAllStipulationsWS</code>. The response is an LLBLGen <code>EntityCollection&lt;MyOriginationsStipulationEntity&gt;</code> filtered by <code>OriginationsStipulationFields.OmegaClientId</code> via a single <code>OmegaDataAccessAdapter.FetchEntityCollection</code> call.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Stipulation</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Originations.Stipulation</code> entities. Key fields include <code>Id</code>, <code>Ts</code>, <code>OmegaClientId</code>, <code>Number</code>, <code>Description</code>, <code>Active</code>, <code>AssigneeType</code>, <code>LastChangedById</code>, and <code>LastChanged</code>. <code>AssigneeType</code> matches <code>Omega.Originations.Types.AssigneeTypes</code> (1 = <code>Internal</code>, 2 = <code>Borrower</code>, 3 = <code>Dealer</code>).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Stipulation"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"438000a0-e957-49c8-aded-5b1428ccad4f","name":"GetAllStipulations - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Number\": 1,\n            \"Description\": \"Proof of Income\",\n            \"Active\": true,\n            \"AssigneeType\": 2,\n            \"LastChangedById\": \"33333333-3333-4333-9333-333333333333\",\n            \"LastChanged\": \"2026-04-01T12:00:00\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"ddf25fe8-97c1-48df-b062-c31a30ff4e5c","name":"GetAllStipulations - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ]\n}"}],"_postman_id":"6caa890e-4a9c-41a8-8d8a-02b64561b5c2"},{"name":"StipulationUpdate","id":"7e85918b-6183-4913-b474-19e33fa108af","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Proof of Income\",\n  \"active\": true,\n  \"assigneeType\": 2\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Stipulation/{{originations_stipulation_number_or_id}}?token={{token}}","description":"<h3 id=\"update-stipulation\">Update Stipulation</h3>\n<p>Updates an existing <code>Originations.Stipulation</code> row identified by Guid <code>Id</code> or stipulation number scoped to the caller's <code>OmegaClientId</code>. Backed by <code>StipulationController.UpdateStipulation</code> -&gt; <code>StipulationWSServices.UpdateStipulationWS</code> -&gt; <code>Omega.Originations.BLL.StipulationServices.SaveStipulationChanges</code> committed through a single <code>UnitOfWork2</code>. The route segment <code>numberOrId</code> is resolved via <code>SharedWSServices.GetOriginationsStipulationId</code>. The existing entity's <code>Ts</code> is reused for optimistic concurrency. The integer <code>assigneeType</code> is cast directly to <code>Omega.Originations.Types.AssigneeTypes</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Stipulation/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Stipulation Guid <code>Id</code> or numeric stipulation <code>Number</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateStipulationParameter</code> (same shape as <code>CreateStipulationParameter</code>).</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Stipulation description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>assigneeType</em></td>\n<td>Int. Maps to <code>Omega.Originations.Types.AssigneeTypes</code> (1 = <code>Internal</code>, 2 = <code>Borrower</code>, 3 = <code>Dealer</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the stipulation Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Stipulation not found\"]</code> or <code>[\"Description is required\"]</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Stipulation","{{originations_stipulation_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5b1fedf0-bc10-4c01-86f5-6965f38e0f57","name":"UpdateStipulation - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Proof of Income\",\n  \"active\": true,\n  \"assigneeType\": 2\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"bd48e303-75a0-4228-8e2a-7e11692e6b5f","name":"UpdateStipulation - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"active\": true,\n  \"assigneeType\": 2\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Stipulation/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Stipulation","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ]\n}"}],"_postman_id":"7e85918b-6183-4913-b474-19e33fa108af"},{"name":"SubmitApplication","id":"bff6bf9b-26e2-434c-828f-aaabfc39bbc6","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Originations/Application/{{originations_application_id}}/Submit?token={{token}}","description":"<h3 id=\"submit-originations-application\">Submit Originations Application</h3>\n<p>This operation accepts application's account number or application GUID in <code>id</code>. The GUID must identify the selected record type. The number identifies the application through its account; the GUID identifies the application itself. No request body is required or read; the resolved application ID is taken from the route.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Application/{id}/Submit</code></p>\n<h4 id=\"url-parameters\">URL Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. application's account number or application GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>No body is required. Any submitted body is ignored — the controller builds <code>new SubmitApplicationParameter { applicationId = id }</code> from the route value.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is the application <code>Id</code> (Guid).</p>\n<p>Unknown application selectors return <code>400 Bad Request</code> with an <code>id</code> lookup error. The selected application must also satisfy the normal submission rules.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>application's account number or application GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Originations/Application/30011709/Submit\n/api/Client/Originations/Application/11111111-1111-4111-8111-111111111111/Submit\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application","{{originations_application_id}}","Submit"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"02f293ce-6e7f-4bf1-89b9-e10c853d894c","name":"SubmitApplication - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/22222222-2222-4222-9222-222222222222/Submit?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","22222222-2222-4222-9222-222222222222","Submit"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"22222222-2222-4222-9222-222222222222\",\n    \"errors\": []\n}"},{"id":"9f209856-ef3c-4e0f-bc91-be6984b43828","name":"SubmitApplication - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/00000000-0000-0000-0000-000000000000/Submit?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","00000000-0000-0000-0000-000000000000","Submit"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid parameter data\"\n    ]\n}"}],"_postman_id":"bff6bf9b-26e2-434c-828f-aaabfc39bbc6"},{"name":"WithdrawApplication","id":"742d684a-d386-4aa9-ac65-9f8eab49332d","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"withdrawnReasonId\": \"{{originations_withdrawn_reason_id}}\",\n  \"withdrawnReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/Application/{{originations_application_id}}/Withdraw?token={{token}}","description":"<h3 id=\"withdraw-originations-application\">Withdraw Originations Application</h3>\n<p>This operation accepts application's account number or application GUID in <code>id</code>. The GUID must identify the selected record type. The number identifies the application through its account; the GUID identifies the application itself. Any body <code>applicationId</code> is replaced with the resolved application ID. Malformed JSON or invalid field types return an error before the action runs.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/Application/{id}/Withdraw</code></p>\n<h4 id=\"url-parameters\">URL Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. application's account number or application GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be sent as a <code>SessionId</code> header or as signed API headers.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>WithdrawApplicationParameter</code>. A null or empty body is allowed — the controller constructs an empty <code>WithdrawApplicationParameter</code> and sets <code>applicationId</code> from the route.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>applicationId</em></td>\n<td>Ignored. The server always overwrites this with the route <code>{id}</code>.</td>\n</tr>\n<tr>\n<td><em>withdrawnReasonId</em></td>\n<td>Optional Guid. When supplied must resolve via <code>WithdrawnReasonServices.ReturnWithdrawnReason</code>; when omitted the application's <code>WithdrawnReasonId</code> is cleared.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the application <code>Id</code> (Guid).</p>\n<p>Returns <code>BadRequest</code> with <code>StandardAPIErrors.INVALID_PARAMETER_ERROR_MESSAGE</code> when the route <code>id</code> is empty, <code>\"Application id is required\"</code> when the parameter fails validation, <code>\"Application could not be resolved\"</code> when <code>LoanApplicationData.GetLoanApplicationEntity</code> returns null, or <code>\"Withdrawn reason could not be resolved\"</code> when <code>withdrawnReasonId</code> is <code>Guid.Empty</code> or does not match a configured reason.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>application's account number or application GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>withdrawnReasonNumberOrId</code></td>\n<td><code>withdrawnReasonId</code></td>\n<td>String. withdrawn-reason number or withdrawn-reason GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"withdrawnReasonNumberOrId\": \"1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Originations/Application/30011709/Withdraw\n/api/Client/Originations/Application/11111111-1111-4111-8111-111111111111/Withdraw\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","Application","{{originations_application_id}}","Withdraw"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"9892293f-c77d-4678-8b6e-f634540e725b","name":"WithdrawApplication - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"withdrawnReasonId\": \"cccccccc-cccc-4ccc-9ccc-cccccccccccc\",\n  \"withdrawnReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/22222222-2222-4222-9222-222222222222/Withdraw?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","22222222-2222-4222-9222-222222222222","Withdraw"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"22222222-2222-4222-9222-222222222222\",\n    \"errors\": []\n}"},{"id":"f55e3fba-db68-4b23-ba88-e8f8394b148e","name":"WithdrawApplication - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"withdrawnReasonId\": \"00000000-0000-0000-0000-000000000000\",\n  \"withdrawnReasonNumberOrId\": null\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/Application/22222222-2222-4222-9222-222222222222/Withdraw?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","Application","22222222-2222-4222-9222-222222222222","Withdraw"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Withdrawn reason could not be resolved\"\n    ]\n}"}],"_postman_id":"742d684a-d386-4aa9-ac65-9f8eab49332d"},{"name":"WithdrawnReasonCreate","id":"f01fb8bf-b1a9-4b3f-9d3f-32c56a27f344","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Customer Cancelled\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/WithdrawnReason?token={{token}}","description":"<h3 id=\"create-withdrawn-reason\">Create Withdrawn Reason</h3>\n<p>Inserts a new <code>Originations.WithdrawnReason</code> row scoped to the caller's <code>OmegaClientId</code>. Backed by <code>WithdrawnReasonController.CreateWithdrawnReason</code> -&gt; <code>WithdrawnReasonWSServices.CreateWithdrawnReasonWS</code> -&gt; <code>Omega.Originations.BLL.WithdrawnReasonServices.AddWithdrawnReason</code> committed through a single <code>UnitOfWork2</code>. The next available <code>Number</code> is assigned automatically by the BLL.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/WithdrawnReason</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>CreateWithdrawnReasonParameter</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Withdrawn reason description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool. Defaults true when omitted.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new withdrawn reason Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Description is required\"]</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","WithdrawnReason"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"be0add2a-f1e5-4021-8fda-37b04efc26ee","name":"CreateWithdrawnReason - Successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Customer Cancelled\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"2ab4faf3-40ac-4a2e-99e9-ed2a4dd3f454","name":"CreateWithdrawnReason - Fail","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ]\n}"}],"_postman_id":"f01fb8bf-b1a9-4b3f-9d3f-32c56a27f344"},{"name":"WithdrawnReasonGet","id":"9824ef8e-0761-448e-be8f-080e1b6cf2a3","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/WithdrawnReason/{{originations_withdrawn_reason_number_or_id}}?token={{token}}","description":"<h3 id=\"get-withdrawn-reason\">Get Withdrawn Reason</h3>\n<p>Returns a single <code>Originations.WithdrawnReason</code> row by Guid <code>Id</code> or withdrawn reason number scoped to the caller's <code>OmegaClientId</code>. Backed by <code>WithdrawnReasonController.GetWithdrawnReason</code> -&gt; <code>WithdrawnReasonWSServices.GetWithdrawnReasonWS</code>. The route segment <code>numberOrId</code> is resolved through <code>SharedWSServices.GetOriginationsWithdrawnReasonId</code>, then the entity is loaded by <code>WithdrawnReasonServices.ReturnWithdrawnReason</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/WithdrawnReason/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Withdrawn reason Guid <code>Id</code> or numeric <code>Number</code>. Resolved by <code>SharedWSServices.GetOriginationsWithdrawnReasonId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a single <code>Originations.WithdrawnReason</code> entity with fields <code>Id</code>, <code>Ts</code>, <code>OmegaClientId</code>, <code>Number</code>, <code>Description</code>, <code>Active</code>, <code>LastChangedById</code>, and <code>LastChanged</code>.</p>\n<p>Returns BadRequest with <code>errors</code>: <code>[\"Withdrawn Reason not found\"]</code> if the identifier cannot be resolved or the entity does not exist for this client.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","WithdrawnReason","{{originations_withdrawn_reason_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"80609830-6552-45eb-9739-e4abc8e8913f","name":"GetWithdrawnReason - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"11111111-1111-4111-9111-111111111111\",\n        \"Ts\": \"AAAAAAAACA4=\",\n        \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n        \"Number\": 1,\n        \"Description\": \"Customer Cancelled\",\n        \"Active\": true,\n        \"LastChangedById\": \"33333333-3333-4333-9333-333333333333\",\n        \"LastChanged\": \"2026-04-01T12:00:00\"\n    },\n    \"errors\": []\n}"},{"id":"6942710b-4a17-4aba-b094-7182087887f3","name":"GetWithdrawnReason - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Withdrawn Reason not found\"\n    ]\n}"}],"_postman_id":"9824ef8e-0761-448e-be8f-080e1b6cf2a3"},{"name":"WithdrawnReasonsGetAll","id":"80119f35-850c-4530-aa73-dc4fc5fb9e7f","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Originations/WithdrawnReason?token={{token}}","description":"<h3 id=\"get-all-withdrawn-reasons\">Get All Withdrawn Reasons</h3>\n<p>Returns every <code>Originations.WithdrawnReason</code> row for the caller's <code>OmegaClientId</code>. Backed by <code>WithdrawnReasonController.GetAllWithdrawnReasons</code> -&gt; <code>WithdrawnReasonWSServices.GetAllWithdrawnReasonsWS</code>. The response is an LLBLGen <code>EntityCollection&lt;MyOriginationsWithdrawnReasonEntity&gt;</code> filtered by <code>OriginationsWithdrawnReasonFields.OmegaClientId</code> via a single <code>OmegaDataAccessAdapter.FetchEntityCollection</code> call.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/WithdrawnReason</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>Originations.WithdrawnReason</code> entities. Key fields include <code>Id</code>, <code>Ts</code>, <code>OmegaClientId</code>, <code>Number</code>, <code>Description</code>, <code>Active</code>, <code>LastChangedById</code>, and <code>LastChanged</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","WithdrawnReason"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"2ed278b1-c9eb-490c-a7c7-18fe014abe69","name":"GetAllWithdrawnReasons - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"Ts\": \"AAAAAAAACA4=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Number\": 1,\n            \"Description\": \"Customer Cancelled\",\n            \"Active\": true,\n            \"LastChangedById\": \"33333333-3333-4333-9333-333333333333\",\n            \"LastChanged\": \"2026-04-01T12:00:00\"\n        },\n        {\n            \"Id\": \"44444444-4444-4444-9444-444444444444\",\n            \"Ts\": \"AAAAAAAACA8=\",\n            \"OmegaClientId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Number\": 2,\n            \"Description\": \"Approved Elsewhere\",\n            \"Active\": true,\n            \"LastChangedById\": \"33333333-3333-4333-9333-333333333333\",\n            \"LastChanged\": \"2026-04-01T12:00:00\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"813fc48a-df7c-492d-900e-ddaafc422b0b","name":"GetAllWithdrawnReasons - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ]\n}"}],"_postman_id":"80119f35-850c-4530-aa73-dc4fc5fb9e7f"},{"name":"WithdrawnReasonUpdate","id":"5ab07a7b-87af-4831-97dc-979073de2f3b","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Customer Cancelled\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://{{base_url}}/api/Client/Originations/WithdrawnReason/{{originations_withdrawn_reason_number_or_id}}?token={{token}}","description":"<h3 id=\"update-withdrawn-reason\">Update Withdrawn Reason</h3>\n<p>Updates an existing <code>Originations.WithdrawnReason</code> row identified by Guid <code>Id</code> or withdrawn reason number scoped to the caller's <code>OmegaClientId</code>. Backed by <code>WithdrawnReasonController.UpdateWithdrawnReason</code> -&gt; <code>WithdrawnReasonWSServices.UpdateWithdrawnReasonWS</code> -&gt; <code>Omega.Originations.BLL.WithdrawnReasonServices.SaveWithdrawnReasonChanges</code> committed through a single <code>UnitOfWork2</code>. The route segment <code>numberOrId</code> is resolved via <code>SharedWSServices.GetOriginationsWithdrawnReasonId</code>. The existing entity's <code>Ts</code> is reused for optimistic concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Originations/WithdrawnReason/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. Withdrawn reason Guid <code>Id</code> or numeric <code>Number</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<p>Matches <code>UpdateWithdrawnReasonParameter</code> (same shape as <code>CreateWithdrawnReasonParameter</code>).</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Withdrawn reason description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the withdrawn reason Guid <code>Id</code> as a string.</p>\n<p>Returns BadRequest with <code>errors</code> entries such as <code>[\"Withdrawn Reason not found\"]</code> or <code>[\"Description is required\"]</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Originations","WithdrawnReason","{{originations_withdrawn_reason_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4de46afb-a460-41e9-a584-5a16b678e20e","name":"UpdateWithdrawnReason - Successful","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Customer Cancelled\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason/1?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason","1"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-1111-4111-9111-111111111111\",\n    \"errors\": []\n}"},{"id":"d26d0ffe-1c7c-40cc-8661-8aa258f6b51a","name":"UpdateWithdrawnReason - Fail","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"description\": \"Customer Cancelled\",\n  \"active\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{base_url}}/api/Client/Originations/WithdrawnReason/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Originations","WithdrawnReason","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Withdrawn reason not found\"\n    ]\n}"}],"_postman_id":"5ab07a7b-87af-4831-97dc-979073de2f3b"}],"id":"30ad3626-0a9c-49e9-8d55-e249478f1063","_postman_id":"30ad3626-0a9c-49e9-8d55-e249478f1063","description":""},{"name":"Servicing","item":[{"name":"ActiveOnlyAssignmentCodesGet","id":"452697af-3ceb-43a4-b48b-6d3c79782e5e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetActiveOnly?token={{token}}","description":"<h3 id=\"get-active-only-servicing-assignment-codes\">Get Active-Only Servicing Assignment Codes</h3>\n<p>Helper route that returns only the assignment codes where <code>IsAvailable</code> is true for the current client. Delegates to <code>AssignmentCodeWSServices.GetClientAssignmentCodesActiveOnly</code>, which filters the output of <code>AssignmentCodeServices.ReturnAllClientAssignmentCodes</code> to active rows.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetActiveOnly</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingAssignmentCodeEntity</code> records with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>IsAvailable=true</code>, <code>XMLParameters</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AssignmentCode","GetActiveOnly"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"16b7f8fe-7a5d-450d-9678-87400146c8f1","name":"GetActiveOnlyAssignmentCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetActiveOnly?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","GetActiveOnly"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"Code\": 10,\n            \"Description\": \"Primary Assignment\",\n            \"IsAvailable\": true,\n            \"XMLParameters\": \"\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"7ccade80-4de6-4c01-a714-54154efc375f","name":"GetActiveOnlyAssignmentCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetActiveOnly?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","GetActiveOnly"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ]\n}"}],"_postman_id":"452697af-3ceb-43a4-b48b-6d3c79782e5e"},{"name":"AssignmentCodeAdd","id":"f89e0673-a9f6-43a0-a239-5803fc884884","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": 10,\n    \"description\": \"Primary Assignment\",\n    \"isAvailable\": true,\n    \"xmlparameters\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode","description":"<h3 id=\"add-servicing-assignment-code\">Add Servicing Assignment Code</h3>\n<p>Creates a new assignment code for the current client. Delegates to <code>AssignmentCodeWSServices.AddSaveAssignmentCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another assignment code with the same integer <code>code</code> already exists for the client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AssignmentCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required integer. Client-scoped unique assignment code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Assignment code description.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the code is available for selection.</td>\n</tr>\n<tr>\n<td><em>xmlparameters</em></td>\n<td>Optional string. XML parameter blob stored on the row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new assignment code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AssignmentCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"269110e7-fdd3-497f-af7b-5b77f62bfa03","name":"AddAssignmentCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": 10,\n    \"description\": \"Primary Assignment\",\n    \"isAvailable\": true,\n    \"xmlparameters\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"3cbb8e45-2ab6-47c4-997f-cd1c7ecc515b","name":"AddAssignmentCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": 10,\n    \"description\": \"Duplicate Assignment\",\n    \"isAvailable\": true,\n    \"xmlparameters\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"An assignment code with code 10 already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"f89e0673-a9f6-43a0-a239-5803fc884884"},{"name":"AssignmentCodeByCodeGet","id":"de26801d-4924-43f3-806d-8f22985b120a","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCode/{{assignment_code}}?token={{token}}","description":"<h3 id=\"get-servicing-assignment-code-by-code\">Get Servicing Assignment Code By Code</h3>\n<p>Helper route that returns a single assignment code matched by its integer <code>Code</code> value. Delegates to <code>AssignmentCodeWSServices.GetAssignmentCodeByCode</code>, which calls <code>AssignmentCodeServices.ReturnAssignmentCodeId</code> and then <code>ReturnAssignmentCode</code>. Unlike <code>GET /AssignmentCode/{codeOrId}</code>, this route accepts only the integer code (not a Guid) and is useful when the caller is certain the path segment is numeric.</p>\n<p>Returns <code>\"Assignment code not found\"</code> when the code does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCode/{code}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>code</em></td>\n<td>Required integer. <code>Servicing.AssignmentCode.Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingAssignmentCodeEntity</code> with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>IsAvailable</code>, <code>XMLParameters</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AssignmentCode","GetByCode","{{assignment_code}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"33e77b9f-ef4f-4943-bba8-a6ab7e00f54a","name":"GetAssignmentCodeByCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCode/{{assignment_code}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","GetByCode","{{assignment_code}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Code\": 10,\n        \"Description\": \"Primary Assignment\",\n        \"IsAvailable\": true,\n        \"XMLParameters\": \"\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"c52a39d8-f379-45f9-9d60-9eff5dda8459","name":"GetAssignmentCodeByCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCode/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","GetByCode","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Assignment code not found\"\n    ]\n}"}],"_postman_id":"de26801d-4924-43f3-806d-8f22985b120a"},{"name":"AssignmentCodeGet","id":"61194b8b-f83c-4007-8d80-d965ed53be8d","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/{{assignment_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-assignment-code\">Get Servicing Assignment Code</h3>\n<p>Returns a single assignment code resolved by Guid or integer code. Delegates to <code>AssignmentCodeWSServices.ReturnAssignmentCodeWS</code>, which first attempts <code>Guid.TryParse</code>; if that fails it parses the segment as an integer and calls <code>AssignmentCodeServices.ReturnAssignmentCodeId</code> to resolve the client-scoped numeric code, then fetches the record via <code>AssignmentCodeServices.ReturnAssignmentCode</code>.</p>\n<p>Returns <code>\"Assignment code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AssignmentCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.AssignmentCode.Id</code> Guid or numeric <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingAssignmentCodeEntity</code> with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>IsAvailable</code>, <code>XMLParameters</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AssignmentCode","{{assignment_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"475342e9-efe2-4e82-ba59-9b20af4c1798","name":"GetAssignmentCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/{{assignment_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","{{assignment_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Code\": 10,\n        \"Description\": \"Primary Assignment\",\n        \"IsAvailable\": true,\n        \"XMLParameters\": \"\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"c3b3b547-70cb-4b1f-88c9-c0527fec8a60","name":"GetAssignmentCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Assignment code not found\"\n    ]\n}"}],"_postman_id":"61194b8b-f83c-4007-8d80-d965ed53be8d"},{"name":"AssignmentCodesByCollectorGet","id":"d643833a-8bae-4171-8b45-1f77d86d7bfb","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCollector/{{collector_id}}?token={{token}}","description":"<h3 id=\"get-servicing-assignment-codes-by-collector\">Get Servicing Assignment Codes By Collector</h3>\n<p>This operation accepts associated user login or collector GUID in <code>collectorId</code>. The GUID must identify the selected record type. A user GUID identifies a different record; use the associated user login or the collector/teller GUID.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCollector/{collectorId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>collectorId</em></td>\n<td>Required string. associated user login or collector GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingAssignmentCodeEntity</code> records with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>IsAvailable</code>, <code>XMLParameters</code>, and <code>Ts</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>collectorId</code></td>\n<td>associated user login or collector GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/AssignmentCode/GetByCollector/collector.login\n/api/Client/Servicing/AssignmentCode/GetByCollector/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AssignmentCode","GetByCollector","{{collector_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e2e32d14-50f7-4fe6-84d1-292b0055906c","name":"GetAssignmentCodesByCollector - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCollector/{{collector_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","GetByCollector","{{collector_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"Code\": 10,\n            \"Description\": \"Primary Assignment\",\n            \"IsAvailable\": true,\n            \"XMLParameters\": \"\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"47723026-ce4b-47b9-8111-74767b827668","name":"GetAssignmentCodesByCollector - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/GetByCollector/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode","GetByCollector","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"collectorId: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"d643833a-8bae-4171-8b45-1f77d86d7bfb"},{"name":"AssignmentCodesGetAll","id":"061c7481-9b18-4dac-aaac-e1ea76baecd2","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode?token={{token}}","description":"<h3 id=\"get-all-servicing-assignment-codes\">Get All Servicing Assignment Codes</h3>\n<p>Returns every assignment code for the current client. Delegates to <code>AssignmentCodeWSServices.ReturnClientAssignmentCodesWS</code>, which reads all rows from <code>Servicing.AssignmentCode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AssignmentCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingAssignmentCodeEntity</code> records with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>IsAvailable</code>, <code>XMLParameters</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AssignmentCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"406d8eb8-dc10-4c0e-a529-6229587eecd8","name":"GetAllAssignmentCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"Code\": 10,\n            \"Description\": \"Primary Assignment\",\n            \"IsAvailable\": true,\n            \"XMLParameters\": \"\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        },\n        {\n            \"Id\": \"b2c3d4e5-2222-4333-9444-bcdef0123456\",\n            \"Code\": 20,\n            \"Description\": \"Collections Assignment\",\n            \"IsAvailable\": true,\n            \"XMLParameters\": \"\",\n            \"Ts\": \"AAAAAAAAB9Q=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"9127f182-a795-468c-9975-4187fc06cb5f","name":"GetAllAssignmentCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AssignmentCode?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AssignmentCode"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving assignment codes: Invalid token\"\n    ]\n}"}],"_postman_id":"061c7481-9b18-4dac-aaac-e1ea76baecd2"},{"name":"AssignmentCodeUpdate","id":"9ed16425-dcec-4455-bb51-465cde169d06","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": 10,\n    \"description\": \"Primary Assignment (Updated)\",\n    \"isAvailable\": true,\n    \"xmlparameters\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/{{assignment_code_or_id}}","description":"<h3 id=\"update-servicing-assignment-code\">Update Servicing Assignment Code</h3>\n<p>Updates an existing assignment code, resolved by Guid or integer code. The controller first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it parses the segment as an integer and calls <code>AssignmentCodeServices.ReturnAssignmentCodeId</code> to resolve the client-scoped numeric code. Returns <code>\"Assignment code not found\"</code> when neither the Guid nor the numeric code match a record for the current client.</p>\n<p>Delegates to <code>AssignmentCodeWSServices.AddSaveAssignmentCodeWS</code> with the resolved <code>id</code> and the row's current <code>Ts</code> preserved for concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AssignmentCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.AssignmentCode.Id</code> Guid or numeric <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required integer. Client-scoped unique assignment code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Assignment code description.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the code is available for selection.</td>\n</tr>\n<tr>\n<td><em>xmlparameters</em></td>\n<td>Optional string. XML parameter blob stored on the row.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated assignment code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AssignmentCode","{{assignment_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0438c139-db9b-4c46-acb0-8bf06063bf9a","name":"UpdateAssignmentCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": 10,\n    \"description\": \"Primary Assignment (Updated)\",\n    \"isAvailable\": true,\n    \"xmlparameters\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/{{assignment_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8d6edf21-26a4-4522-98a6-7a241301eb02","name":"UpdateAssignmentCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": 999999,\n    \"description\": \"Primary Assignment (Updated)\",\n    \"isAvailable\": true,\n    \"xmlparameters\": \"\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AssignmentCode/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Assignment code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"9ed16425-dcec-4455-bb51-465cde169d06"},{"name":"AutomaticPaymentFileDefAdd","id":"1d2e8ac4-6d2e-4da3-bedc-a6a501d821d5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"CUSTOM\",\n  \"description\": \"Custom Fixed-Position ACH File\",\n  \"fileFormat\": 1,\n  \"paymentTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultFundsCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"branchBankAccountId\": \"c1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"postToChargeOffAccounts\": false,\n  \"postToClosedOrCredBalAccounts\": false,\n  \"chargeFee\": true,\n  \"feeOtherBalanceTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012349\",\n  \"feeAmount\": 2.5,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"paymentAmountIncludeDecimal\": false,\n    \"paymentAmountStart\": 13,\n    \"paymentAmountEnd\": 22,\n    \"paymentEffectiveDateFormat\": 1,\n    \"paymentEffectiveDateStart\": 23,\n    \"paymentEffectiveDateEnd\": 30,\n    \"checkNumberStart\": null,\n    \"checkNumberEnd\": null,\n    \"fundsTypeStart\": null,\n    \"fundsTypeEnd\": null,\n    \"lastNameValidationStart\": null,\n    \"lastNameValidationEnd\": null,\n    \"commentStart\": null,\n    \"commentEnd\": null,\n    \"accountLookupType\": 1\n  },\n  \"paymentTransCodeOrId\": null,\n  \"defaultFundsCodeDescriptionOrId\": null,\n  \"feeOtherBalanceTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition","description":"<h3 id=\"add-servicing-automatic-payment-file-definition\">Add Servicing Automatic Payment File Definition</h3>\n<p>Creates a new Automatic Payment file definition used to generate ACH payment files. Delegates to <code>AutomaticPaymentFileDefWSServices.AddSaveWS</code> with <code>id=null</code> and <code>ts=null</code>. <code>fileFormat=Custom</code> requires the <code>custom</code> object with start/end positions. Position ranges must satisfy <code>start &lt;= end</code>; when a date format length is provided the position range length must match. When <code>chargeFee=true</code>, <code>feeOtherBalanceTransCodeId</code> is required and <code>feeAmount &gt;= 0.01</code> (except when <code>fileFormat=Wells_Fargo</code>, which supports fee amount = 0).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required bool. Active flag.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string, max 10 characters. Client-scoped unique code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 50 characters.</td>\n</tr>\n<tr>\n<td><em>fileFormat</em></td>\n<td>Required int enum <code>ServicingAutomaticPaymentFileFormat</code> (e.g. <code>Custom=1</code>, <code>Wells_Fargo=2</code>, etc.).</td>\n</tr>\n<tr>\n<td><em>paymentTransCodeId</em></td>\n<td>Required Guid. <code>GeneralLedger.TransactionCode</code> Id for the payment. Must not be empty.</td>\n</tr>\n<tr>\n<td><em>defaultFundsCodeId</em></td>\n<td>Required Guid. <code>GeneralLedger.FundsCode</code> Id. Must not be empty.</td>\n</tr>\n<tr>\n<td><em>branchBankAccountId</em></td>\n<td>Optional Guid. Source branch bank account.</td>\n</tr>\n<tr>\n<td><em>postToChargeOffAccounts</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>postToClosedOrCredBalAccounts</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>chargeFee</em></td>\n<td>Required bool. When true a fee transaction is added.</td>\n</tr>\n<tr>\n<td><em>feeOtherBalanceTransCodeId</em></td>\n<td>Required Guid when <code>chargeFee=true</code>.</td>\n</tr>\n<tr>\n<td><em>feeAmount</em></td>\n<td>Required decimal when <code>chargeFee=true</code>. Must be &gt;= 0.01 unless <code>fileFormat=Wells_Fargo</code>.</td>\n</tr>\n<tr>\n<td><em>custom</em></td>\n<td>Required object when <code>fileFormat=Custom</code>. Custom fixed-position file-format layout (see below).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"custom-object-parameters-custom\">Custom Object Parameters (<code>custom</code>)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberStart</em> / <em>accountNumberEnd</em></td>\n<td>Required int. Start and end positions (1-based). Start &lt;= end.</td>\n</tr>\n<tr>\n<td><em>paymentAmountIncludeDecimal</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>paymentAmountStart</em> / <em>paymentAmountEnd</em></td>\n<td>Required int. Start &lt;= end.</td>\n</tr>\n<tr>\n<td><em>paymentEffectiveDateFormat</em></td>\n<td>Required int enum <code>ServicingAutomaticPaymentFileDateFormat</code>.</td>\n</tr>\n<tr>\n<td><em>paymentEffectiveDateStart</em> / <em>paymentEffectiveDateEnd</em></td>\n<td>Required int. Range length must match the selected date format.</td>\n</tr>\n<tr>\n<td><em>checkNumberStart</em> / <em>checkNumberEnd</em></td>\n<td>Optional int. Both or neither.</td>\n</tr>\n<tr>\n<td><em>fundsTypeStart</em> / <em>fundsTypeEnd</em></td>\n<td>Optional int. Both or neither.</td>\n</tr>\n<tr>\n<td><em>lastNameValidationStart</em> / <em>lastNameValidationEnd</em></td>\n<td>Optional int. Both or neither.</td>\n</tr>\n<tr>\n<td><em>commentStart</em> / <em>commentEnd</em></td>\n<td>Optional int. Both or neither.</td>\n</tr>\n<tr>\n<td><em>accountLookupType</em></td>\n<td>Required int enum <code>ServicingAutomaticPaymentFileAccountLookupType</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id, CustomId }</code> — the Guid of the new file definition and of its custom-format child row (when applicable).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>paymentTransCodeOrId</code></td>\n<td><code>paymentTransCodeId</code></td>\n<td>String. regular or extension payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultFundsCodeDescriptionOrId</code></td>\n<td><code>defaultFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>feeOtherBalanceTransCodeOrId</code></td>\n<td><code>feeOtherBalanceTransCodeId</code></td>\n<td>String. miscellaneous other-balance journal transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"paymentTransCodeOrId\": \"PYC\",\n  \"defaultFundsCodeDescriptionOrId\": \"Check\",\n  \"feeOtherBalanceTransCodeOrId\": \"FEE\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AutomaticPaymentFileDefinition"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"67e785b6-8ae4-4974-8330-fff820f9cdd6","name":"AddAutomaticPaymentFileDef - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"CUSTOM\",\n  \"description\": \"Custom Fixed-Position ACH File\",\n  \"fileFormat\": 1,\n  \"paymentTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultFundsCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"branchBankAccountId\": \"c1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"postToChargeOffAccounts\": false,\n  \"postToClosedOrCredBalAccounts\": false,\n  \"chargeFee\": true,\n  \"feeOtherBalanceTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012349\",\n  \"feeAmount\": 2.5,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"paymentAmountIncludeDecimal\": false,\n    \"paymentAmountStart\": 13,\n    \"paymentAmountEnd\": 22,\n    \"paymentEffectiveDateFormat\": 1,\n    \"paymentEffectiveDateStart\": 23,\n    \"paymentEffectiveDateEnd\": 30,\n    \"checkNumberStart\": null,\n    \"checkNumberEnd\": null,\n    \"fundsTypeStart\": null,\n    \"fundsTypeEnd\": null,\n    \"lastNameValidationStart\": null,\n    \"lastNameValidationEnd\": null,\n    \"commentStart\": null,\n    \"commentEnd\": null,\n    \"accountLookupType\": 1\n  },\n  \"paymentTransCodeOrId\": null,\n  \"defaultFundsCodeDescriptionOrId\": null,\n  \"feeOtherBalanceTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"CustomId\": \"d1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"37e02a36-a69c-4471-af89-63951b1a88c7","name":"AddAutomaticPaymentFileDef - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"\",\n  \"description\": \"Custom Fixed-Position ACH File\",\n  \"fileFormat\": 1,\n  \"paymentTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultFundsCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"branchBankAccountId\": \"c1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"postToChargeOffAccounts\": false,\n  \"postToClosedOrCredBalAccounts\": false,\n  \"chargeFee\": true,\n  \"feeOtherBalanceTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012349\",\n  \"feeAmount\": 2.5,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"paymentAmountIncludeDecimal\": false,\n    \"paymentAmountStart\": 13,\n    \"paymentAmountEnd\": 22,\n    \"paymentEffectiveDateFormat\": 1,\n    \"paymentEffectiveDateStart\": 23,\n    \"paymentEffectiveDateEnd\": 30,\n    \"checkNumberStart\": null,\n    \"checkNumberEnd\": null,\n    \"fundsTypeStart\": null,\n    \"fundsTypeEnd\": null,\n    \"lastNameValidationStart\": null,\n    \"lastNameValidationEnd\": null,\n    \"commentStart\": null,\n    \"commentEnd\": null,\n    \"accountLookupType\": 1\n  },\n  \"paymentTransCodeOrId\": null,\n  \"defaultFundsCodeDescriptionOrId\": null,\n  \"feeOtherBalanceTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Code is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"1d2e8ac4-6d2e-4da3-bedc-a6a501d821d5"},{"name":"AutomaticPaymentFileDefGet","id":"80a08435-d2bc-4391-a41b-c11856af73ef","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/{{automatic_payment_file_def_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-automatic-payment-file-definition\">Get Servicing Automatic Payment File Definition</h3>\n<p>Returns a single Automatic Payment file definition by either its Guid <code>Id</code> or client-scoped <code>Code</code>. Delegates to <code>AutomaticPaymentFileDefWSServices.ReturnWS</code>, which resolves the Id via <code>SharedWSServices.GetServicingAutomaticPaymentFileDefId</code> and then calls <code>AutomaticPaymentFileServices.ReturnServicingAutomaticPaymentFileDef</code>. The returned entity includes the child <code>AutomaticPaymentFileDefCustom</code> row used for custom fixed-position file formats.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>Code</code>. <code>BadRequest</code> with \"Automatic payment file definition not found\" when the value cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>MyServicingAutomaticPaymentFileDefEntity</code> projection with the core scalar fields (<code>Id</code>, <code>IsActive</code>, <code>Code</code>, <code>Description</code>, <code>FileFormat</code>, <code>PaymentTransCodeId</code>, <code>DefaultFundsCodeId</code>, <code>BranchBankAccountId</code>, <code>PostToChargeOffAccounts</code>, <code>PostToClosedOrCredBalAccounts</code>, <code>ChargeFee</code>, <code>FeeOtherBalanceTransCodeId</code>, <code>FeeAmount</code>, <code>Ts</code>) plus the <code>AutomaticPaymentFileDefCustom</code> collection that holds the custom format position metadata when <code>FileFormat</code> is <code>Custom</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AutomaticPaymentFileDefinition","{{automatic_payment_file_def_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4e121e64-2526-4591-8b01-b3c3989bcbb9","name":"GetAutomaticPaymentFileDef - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/{{automatic_payment_file_def_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AutomaticPaymentFileDefinition","{{automatic_payment_file_def_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"IsActive\": true,\n        \"Code\": \"CUSTOM\",\n        \"Description\": \"Custom Fixed-Position ACH File\",\n        \"FileFormat\": 1,\n        \"PaymentTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n        \"DefaultFundsCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n        \"BranchBankAccountId\": \"c1c2d3e4-1111-4222-9333-abcdef012348\",\n        \"PostToChargeOffAccounts\": false,\n        \"PostToClosedOrCredBalAccounts\": false,\n        \"ChargeFee\": true,\n        \"FeeOtherBalanceTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012349\",\n        \"FeeAmount\": 2.50,\n        \"Ts\": \"AAAAAAAAB9E=\",\n        \"AutomaticPaymentFileDefCustom\": [\n            {\n                \"Id\": \"d1c2d3e4-1111-4222-9333-abcdef012345\",\n                \"AutomaticPaymentFileDefId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n                \"AccountNumberStart\": 1,\n                \"AccountNumberEnd\": 12,\n                \"PaymentAmountIncludeDecimal\": false,\n                \"PaymentAmountStart\": 13,\n                \"PaymentAmountEnd\": 22,\n                \"PaymentEffectiveDateFormat\": 1,\n                \"PaymentEffectiveDateStart\": 23,\n                \"PaymentEffectiveDateEnd\": 30,\n                \"CheckNumberStart\": null,\n                \"CheckNumberEnd\": null,\n                \"FundsTypeStart\": null,\n                \"FundsTypeEnd\": null,\n                \"LastNameValidationStart\": null,\n                \"LastNameValidationEnd\": null,\n                \"CommentStart\": null,\n                \"CommentEnd\": null,\n                \"AccountLookupType\": 1,\n                \"Ts\": \"AAAAAAAAB9I=\"\n            }\n        ]\n    },\n    \"errors\": []\n}"},{"id":"3990ac82-1112-442c-90f1-4d057b20a552","name":"GetAutomaticPaymentFileDef - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/NONEXISTENT?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","AutomaticPaymentFileDefinition","NONEXISTENT"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Automatic payment file definition not found\"\n    ]\n}"}],"_postman_id":"80a08435-d2bc-4391-a41b-c11856af73ef"},{"name":"AutomaticPaymentFileDefUpdate","id":"7bb64247-fe3e-433d-b6e3-a755f432be99","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"CUSTOM\",\n  \"description\": \"Custom Fixed-Position ACH File - Updated\",\n  \"fileFormat\": 1,\n  \"paymentTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultFundsCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"branchBankAccountId\": \"c1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"postToChargeOffAccounts\": false,\n  \"postToClosedOrCredBalAccounts\": false,\n  \"chargeFee\": true,\n  \"feeOtherBalanceTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012349\",\n  \"feeAmount\": 3,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"paymentAmountIncludeDecimal\": false,\n    \"paymentAmountStart\": 13,\n    \"paymentAmountEnd\": 22,\n    \"paymentEffectiveDateFormat\": 1,\n    \"paymentEffectiveDateStart\": 23,\n    \"paymentEffectiveDateEnd\": 30,\n    \"checkNumberStart\": null,\n    \"checkNumberEnd\": null,\n    \"fundsTypeStart\": null,\n    \"fundsTypeEnd\": null,\n    \"lastNameValidationStart\": null,\n    \"lastNameValidationEnd\": null,\n    \"commentStart\": null,\n    \"commentEnd\": null,\n    \"accountLookupType\": 1\n  },\n  \"paymentTransCodeOrId\": null,\n  \"defaultFundsCodeDescriptionOrId\": null,\n  \"feeOtherBalanceTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/{{automatic_payment_file_def_code_or_id}}","description":"<h3 id=\"update-servicing-automatic-payment-file-definition\">Update Servicing Automatic Payment File Definition</h3>\n<p>Updates an existing Automatic Payment file definition. The controller resolves the route <code>{codeOrId}</code> via <code>SharedWSServices.GetServicingAutomaticPaymentFileDefId</code>, re-reads the row through <code>AutomaticPaymentFileServices.ReturnServicingAutomaticPaymentFileDef</code> to capture the current <code>Ts</code> (and the child <code>AutomaticPaymentFileDefCustom</code> <code>Id</code> and <code>Ts</code> when present), and then calls <code>AutomaticPaymentFileDefWSServices.AddSaveWS</code>. All validation rules from the Add endpoint apply; additionally, the <code>Code</code> value can change only within the 10-character limit.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>Code</code>. <code>BadRequest</code> \"Automatic payment file definition not found\" when it cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape and rules as <code>Add Servicing Automatic Payment File Definition</code>. Client-provided <code>ts</code>/<code>customId</code>/<code>customTs</code> values are ignored — the controller always injects the values it read from the existing row.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id, CustomId }</code> — the Guid of the updated file definition and of the custom-format child row (when applicable).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>paymentTransCodeOrId</code></td>\n<td><code>paymentTransCodeId</code></td>\n<td>String. regular or extension payment transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultFundsCodeDescriptionOrId</code></td>\n<td><code>defaultFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>feeOtherBalanceTransCodeOrId</code></td>\n<td><code>feeOtherBalanceTransCodeId</code></td>\n<td>String. miscellaneous other-balance journal transaction code or matching transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"paymentTransCodeOrId\": \"PYC\",\n  \"defaultFundsCodeDescriptionOrId\": \"Check\",\n  \"feeOtherBalanceTransCodeOrId\": \"FEE\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","AutomaticPaymentFileDefinition","{{automatic_payment_file_def_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5dea6c36-addc-4300-8824-80c383ac5a82","name":"UpdateAutomaticPaymentFileDef - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"CUSTOM\",\n  \"description\": \"Custom Fixed-Position ACH File - Updated\",\n  \"fileFormat\": 1,\n  \"paymentTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultFundsCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"branchBankAccountId\": \"c1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"postToChargeOffAccounts\": false,\n  \"postToClosedOrCredBalAccounts\": false,\n  \"chargeFee\": true,\n  \"feeOtherBalanceTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012349\",\n  \"feeAmount\": 3,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"paymentAmountIncludeDecimal\": false,\n    \"paymentAmountStart\": 13,\n    \"paymentAmountEnd\": 22,\n    \"paymentEffectiveDateFormat\": 1,\n    \"paymentEffectiveDateStart\": 23,\n    \"paymentEffectiveDateEnd\": 30,\n    \"checkNumberStart\": null,\n    \"checkNumberEnd\": null,\n    \"fundsTypeStart\": null,\n    \"fundsTypeEnd\": null,\n    \"lastNameValidationStart\": null,\n    \"lastNameValidationEnd\": null,\n    \"commentStart\": null,\n    \"commentEnd\": null,\n    \"accountLookupType\": 1\n  },\n  \"paymentTransCodeOrId\": null,\n  \"defaultFundsCodeDescriptionOrId\": null,\n  \"feeOtherBalanceTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/{{automatic_payment_file_def_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"CustomId\": \"d1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"6af9b190-7a83-43b1-a56f-68e2ee2ec67a","name":"UpdateAutomaticPaymentFileDef - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"CUSTOM\",\n  \"description\": \"Custom Fixed-Position ACH File - Updated\",\n  \"fileFormat\": 1,\n  \"paymentTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultFundsCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"branchBankAccountId\": \"c1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"postToChargeOffAccounts\": false,\n  \"postToClosedOrCredBalAccounts\": false,\n  \"chargeFee\": true,\n  \"feeOtherBalanceTransCodeId\": \"c1c2d3e4-1111-4222-9333-abcdef012349\",\n  \"feeAmount\": 3,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"paymentAmountIncludeDecimal\": false,\n    \"paymentAmountStart\": 13,\n    \"paymentAmountEnd\": 22,\n    \"paymentEffectiveDateFormat\": 1,\n    \"paymentEffectiveDateStart\": 23,\n    \"paymentEffectiveDateEnd\": 30,\n    \"checkNumberStart\": null,\n    \"checkNumberEnd\": null,\n    \"fundsTypeStart\": null,\n    \"fundsTypeEnd\": null,\n    \"lastNameValidationStart\": null,\n    \"lastNameValidationEnd\": null,\n    \"commentStart\": null,\n    \"commentEnd\": null,\n    \"accountLookupType\": 1\n  },\n  \"paymentTransCodeOrId\": null,\n  \"defaultFundsCodeDescriptionOrId\": null,\n  \"feeOtherBalanceTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/AutomaticPaymentFileDefinition/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Automatic payment file definition not found\"\n    ]\n}"}],"_postman_id":"7bb64247-fe3e-433d-b6e3-a755f432be99"},{"name":"CheckTransactionCodeInUse","id":"fa8f8e11-ec06-444a-b039-19ba93338fae","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}/CheckInUse?token={{token}}","description":"<h3 id=\"check-servicing-transaction-code-in-use\">Check Servicing Transaction Code In Use</h3>\n<p>Helper route that reports whether a transaction code is referenced by any existing records, so callers can decide whether a delete or rename is safe. Delegates to <code>TransactionCodeWSServices.CheckTransactionCodeInUseWS</code>, which resolves the <code>codeOrId</code> path segment (Guid or code) and calls <code>TransactionCodeServices.CheckTransactionCodeInUse</code>.</p>\n<p>Returns <code>\"Transaction code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCode/{codeOrId}/CheckInUse</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.TransactionCode.Id</code> Guid or <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ InUse }</code> — a boolean indicating whether the code is currently referenced by other records.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCode","{{transaction_code_or_id}}","CheckInUse"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5fdbfbb7-89bf-4f48-bbce-b6aef25bdfc4","name":"CheckTransactionCodeInUse - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}/CheckInUse?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode","{{transaction_code_or_id}}","CheckInUse"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"InUse\": true\n    },\n    \"errors\": []\n}"},{"id":"a28162b5-1f0f-4ee5-8774-2cd12ad507c1","name":"CheckTransactionCodeInUse - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode/NONEXISTENT/CheckInUse?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode","NONEXISTENT","CheckInUse"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code not found\"\n    ]\n}"}],"_postman_id":"fa8f8e11-ec06-444a-b039-19ba93338fae"},{"name":"CloseOutDefaultAdd","id":"b07abe5e-06b8-4a34-8dae-c4dca4a2a3b8","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"CO\",\n    \"description\": \"Standard Charge-Off\",\n    \"active\": true,\n    \"closeOutType\": 1,\n    \"unpaidLateChargeMethod\": 1,\n    \"unpaidOtherBalanceFeeMethod\": 1,\n    \"accruedInterestMethod\": 1,\n    \"unpaidSubAccountMethod\": 1,\n    \"unpaidRemainingSubAccountInsuranceMethod\": 1,\n    \"financeChargeEarningsMethod\": 1,\n    \"unearnedPointsAcqIncomeMethod\": 1,\n    \"unearnedPointsAcqBalanceMethod\": 1,\n    \"discountBalanceMethod\": 1,\n    \"discountEarningsMethod\": 1,\n    \"dealerReserveAdjustmentMethod\": 4,\n    \"unwindOption\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"subAccountTransCodeOrId\": null,\n    \"writeOffTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault","description":"<h3 id=\"add-servicing-close-out-default\">Add Servicing Close-Out Default</h3>\n<p>Creates a new close-out default template for the current client. Delegates to <code>CloseOutDefaultWSServices.AddSaveCloseOutDefaultWS</code> with no existing entity, so the row is inserted.</p>\n<p><code>closeOutType</code> is a required integer: <code>1</code> = Charge Off, <code>2</code> = Unwind, <code>3</code> = Write Off, <code>4</code> = Repurchase.</p>\n<p>Method fields are optional integers backed by enums:</p>\n<ul>\n<li><code>unpaidLateChargeMethod</code>, <code>unpaidOtherBalanceFeeMethod</code>,\n<code>accruedInterestMethod</code>, <code>unpaidSubAccountMethod</code>,\n<code>unpaidRemainingSubAccountInsuranceMethod</code> —\n<code>1</code> Waive, <code>2</code> Charge Account, <code>3</code> Leave</li>\n<li><code>financeChargeEarningsMethod</code>, <code>discountEarningsMethod</code> —\n<code>1</code> Earn Through Charge Off Date, <code>2</code> Earn Through Last Earnings Accrual Date\n(discount adds <code>3</code> Earn No Discount)</li>\n<li><code>unearnedPointsAcqIncomeMethod</code> — <code>1</code> No Earnings, <code>2</code> Earn Through\nCharge Off Date, <code>3</code> Earn Through Last Earnings Accrual Date</li>\n<li><code>unearnedPointsAcqBalanceMethod</code> — <code>1</code> Adjust Loss, <code>2</code> Adjust Balance - <code>discountBalanceMethod</code> — <code>1</code> Adjust Charge Off Balance, <code>2</code> Adjust Loss - <code>dealerReserveAdjustmentMethod</code> — <code>1</code> Maximum Available,\n<code>2</code> Original Reserve Amount, <code>3</code> All to Reserve, <code>4</code> None,\n<code>5</code> Straight Line Method</li>\n<li><code>unwindOption</code> — <code>1</code> Clearing, <code>2</code> Void/Reverse Payment, <code>3</code> Reserve\n(only applies when <code>closeOutType = 2</code>)</li>\n</ul>\n<p><code>newAdminStatusCodeOrId</code>, <code>subAccountTransCodeOrId</code>, and <code>writeOffTransactionCodeOrId</code> accept either a Guid or the client-scoped code string.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/CloseOutDefault</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Client-scoped close-out default code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Template description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the template is available for selection.</td>\n</tr>\n<tr>\n<td><em>closeOutType</em></td>\n<td>Required integer. <code>1</code> Charge Off, <code>2</code> Unwind, <code>3</code> Write Off, <code>4</code> Repurchase.</td>\n</tr>\n<tr>\n<td><em>unpaidLateChargeMethod</em></td>\n<td>Optional integer. Unpaid late charge handling.</td>\n</tr>\n<tr>\n<td><em>unpaidOtherBalanceFeeMethod</em></td>\n<td>Optional integer. Unpaid other-balance fee handling.</td>\n</tr>\n<tr>\n<td><em>accruedInterestMethod</em></td>\n<td>Optional integer. Accrued-interest handling.</td>\n</tr>\n<tr>\n<td><em>unpaidSubAccountMethod</em></td>\n<td>Optional integer. Unpaid subaccount handling.</td>\n</tr>\n<tr>\n<td><em>unpaidRemainingSubAccountInsuranceMethod</em></td>\n<td>Optional integer. Unpaid subaccount insurance handling.</td>\n</tr>\n<tr>\n<td><em>financeChargeEarningsMethod</em></td>\n<td>Optional integer. Finance-charge earnings method.</td>\n</tr>\n<tr>\n<td><em>unearnedPointsAcqIncomeMethod</em></td>\n<td>Optional integer. Unearned points/acquisition income method.</td>\n</tr>\n<tr>\n<td><em>unearnedPointsAcqBalanceMethod</em></td>\n<td>Optional integer. Unearned points/acquisition balance method.</td>\n</tr>\n<tr>\n<td><em>discountBalanceMethod</em></td>\n<td>Optional integer. Discount balance method.</td>\n</tr>\n<tr>\n<td><em>discountEarningsMethod</em></td>\n<td>Optional integer. Discount earnings method.</td>\n</tr>\n<tr>\n<td><em>dealerReserveAdjustmentMethod</em></td>\n<td>Optional integer. Dealer reserve adjustment method.</td>\n</tr>\n<tr>\n<td><em>unwindOption</em></td>\n<td>Optional integer. Unwind option (required when <code>closeOutType = 2</code>).</td>\n</tr>\n<tr>\n<td><em>newAdminStatusCodeOrId</em></td>\n<td>Optional string. Admin status Guid or code applied on close-out.</td>\n</tr>\n<tr>\n<td><em>subAccountTransCodeOrId</em></td>\n<td>Optional string. Transaction code Guid or code used when charging subaccounts back.</td>\n</tr>\n<tr>\n<td><em>writeOffTransactionCodeOrId</em></td>\n<td>Optional string. Transaction code Guid or code used for write-off close-outs. Used only when <code>closeOutType = 3</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Guid of the new close-out default (returned as a string).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","CloseOutDefault"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0e388737-e8c9-4eda-b838-07ceeeea5676","name":"AddCloseOutDefault - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"CO\",\n    \"description\": \"Standard Charge-Off\",\n    \"active\": true,\n    \"closeOutType\": 1,\n    \"unpaidLateChargeMethod\": 1,\n    \"unpaidOtherBalanceFeeMethod\": 1,\n    \"accruedInterestMethod\": 1,\n    \"unpaidSubAccountMethod\": 1,\n    \"unpaidRemainingSubAccountInsuranceMethod\": 1,\n    \"financeChargeEarningsMethod\": 1,\n    \"unearnedPointsAcqIncomeMethod\": 1,\n    \"unearnedPointsAcqBalanceMethod\": 1,\n    \"discountBalanceMethod\": 1,\n    \"discountEarningsMethod\": 1,\n    \"dealerReserveAdjustmentMethod\": 4,\n    \"unwindOption\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"subAccountTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"7b6b5138-71a1-4288-a02e-45bcb50812cd","name":"AddCloseOutDefault - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"\",\n    \"description\": \"Standard Charge-Off\",\n    \"active\": true,\n    \"closeOutType\": 1,\n    \"unpaidLateChargeMethod\": 1,\n    \"unpaidOtherBalanceFeeMethod\": 1,\n    \"accruedInterestMethod\": 1,\n    \"unpaidSubAccountMethod\": 1,\n    \"unpaidRemainingSubAccountInsuranceMethod\": 1,\n    \"financeChargeEarningsMethod\": 1,\n    \"unearnedPointsAcqIncomeMethod\": 1,\n    \"unearnedPointsAcqBalanceMethod\": 1,\n    \"discountBalanceMethod\": 1,\n    \"discountEarningsMethod\": 1,\n    \"dealerReserveAdjustmentMethod\": 4,\n    \"unwindOption\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"subAccountTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Code is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"b07abe5e-06b8-4a34-8dae-c4dca4a2a3b8"},{"name":"CloseOutDefaultGet","id":"2bf6d227-8cc6-41e5-8303-dc73872133ad","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{{close_out_default_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-close-out-default\">Get Servicing Close-Out Default</h3>\n<p>Returns a single close-out default resolved by Guid or code string. Delegates to <code>CloseOutDefaultWSServices.ReturnCloseOutDefaultWS</code>, which calls <code>SharedWSServices.GetServicingCloseOutDefaultsId</code> to resolve the identifier (first attempts <code>Guid.TryParse</code>; if that fails, treats the segment as the <code>Code</code> string and looks it up for the current client), then fetches the record via <code>CloseOutDefaultServices.ReturnCloseOutDefault</code>.</p>\n<p>Returns <code>\"Close out default not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.CloseOutDefaults.Id</code> Guid or <code>Code</code> string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingCloseOutDefaultsEntity</code> with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>Active</code>, <code>CloseOutType</code>, all method fields, <code>UnwindOption</code>, <code>NewAdminStatusId</code>, <code>SubAccountTransCodeId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","CloseOutDefault","{{close_out_default_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a64210cf-5996-499a-8597-071ec0714d70","name":"GetCloseOutDefault - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{{close_out_default_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","CloseOutDefault","{{close_out_default_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Code\": \"CO\",\n        \"Description\": \"Standard Charge-Off\",\n        \"Active\": true,\n        \"CloseOutType\": 1,\n        \"UnpaidLateChargeMethod\": 1,\n        \"UnpaidOtherBalanceFeeMethod\": 1,\n        \"AccruedInterestMethod\": 1,\n        \"UnpaidSubAccountMethod\": 1,\n        \"UnpaidRemainingSubAccountInsuranceMethod\": 1,\n        \"FinanceChargeEarningsMethod\": 1,\n        \"UnearnedPointsAcqIncomeMethod\": 1,\n        \"UnearnedPointsAcqBalanceMethod\": 1,\n        \"DiscountBalanceMethod\": 1,\n        \"DiscountEarningsMethod\": 1,\n        \"DealerReserveAdjustmentMethod\": 4,\n        \"UnwindOption\": null,\n        \"NewAdminStatusId\": null,\n        \"SubAccountTransCodeId\": null,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"2e084652-b494-498c-9c17-9232e407a514","name":"GetCloseOutDefault - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{{close_out_default_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","CloseOutDefault","{{close_out_default_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Close out default not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"2bf6d227-8cc6-41e5-8303-dc73872133ad"},{"name":"CloseOutDefaultsGetAll","id":"29176195-dda3-431f-baca-6247898b8349","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault?token={{token}}","description":"<h3 id=\"get-all-servicing-close-out-defaults\">Get All Servicing Close-Out Defaults</h3>\n<p>Returns every close-out default template for the current client. Delegates to <code>CloseOutDefaultWSServices.ReturnAllCloseOutDefaultsWS</code>, which reads all rows from <code>Servicing.CloseOutDefaults</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/CloseOutDefault</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingCloseOutDefaultsEntity</code> records with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>Active</code>, <code>CloseOutType</code>, and the method fields (<code>UnpaidLateChargeMethod</code>, <code>UnpaidOtherBalanceFeeMethod</code>, <code>AccruedInterestMethod</code>, <code>UnpaidSubAccountMethod</code>, <code>UnpaidRemainingSubAccountInsuranceMethod</code>, <code>FinanceChargeEarningsMethod</code>, <code>UnearnedPointsAcqIncomeMethod</code>, <code>UnearnedPointsAcqBalanceMethod</code>, <code>DiscountBalanceMethod</code>, <code>DiscountEarningsMethod</code>, <code>DealerReserveAdjustmentMethod</code>, <code>UnwindOption</code>, <code>NewAdminStatusId</code>, <code>SubAccountTransCodeId</code>, <code>Ts</code>).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","CloseOutDefault"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"50d70f91-68f2-46a0-acf1-a40c51850564","name":"GetAllCloseOutDefaults - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","CloseOutDefault"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"Code\": \"CO\",\n            \"Description\": \"Standard Charge-Off\",\n            \"Active\": true,\n            \"CloseOutType\": 1,\n            \"UnpaidLateChargeMethod\": 1,\n            \"UnpaidOtherBalanceFeeMethod\": 1,\n            \"AccruedInterestMethod\": 1,\n            \"UnpaidSubAccountMethod\": 1,\n            \"UnpaidRemainingSubAccountInsuranceMethod\": 1,\n            \"FinanceChargeEarningsMethod\": 1,\n            \"UnearnedPointsAcqIncomeMethod\": 1,\n            \"UnearnedPointsAcqBalanceMethod\": 1,\n            \"DiscountBalanceMethod\": 1,\n            \"DiscountEarningsMethod\": 1,\n            \"DealerReserveAdjustmentMethod\": 4,\n            \"UnwindOption\": null,\n            \"NewAdminStatusId\": null,\n            \"SubAccountTransCodeId\": null,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"f175c8a2-2fe3-4df8-8673-38ed79212278","name":"GetAllCloseOutDefaults - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","CloseOutDefault"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving close out defaults: Login information could not be resolved\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"29176195-dda3-431f-baca-6247898b8349"},{"name":"CloseOutDefaultUpdate","id":"40d302f6-c141-46fc-b3ae-506d1f14bcd4","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"CO\",\n    \"description\": \"Standard Charge-Off (Updated)\",\n    \"active\": true,\n    \"closeOutType\": 1,\n    \"unpaidLateChargeMethod\": 1,\n    \"unpaidOtherBalanceFeeMethod\": 1,\n    \"accruedInterestMethod\": 1,\n    \"unpaidSubAccountMethod\": 2,\n    \"unpaidRemainingSubAccountInsuranceMethod\": 1,\n    \"financeChargeEarningsMethod\": 1,\n    \"unearnedPointsAcqIncomeMethod\": 1,\n    \"unearnedPointsAcqBalanceMethod\": 1,\n    \"discountBalanceMethod\": 1,\n    \"discountEarningsMethod\": 1,\n    \"dealerReserveAdjustmentMethod\": 4,\n    \"unwindOption\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"subAccountTransCodeOrId\": null,\n    \"writeOffTransactionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{{close_out_default_or_id}}","description":"<h3 id=\"update-servicing-close-out-default\">Update Servicing Close-Out Default</h3>\n<p>Updates an existing close-out default resolved by Guid or code. The controller calls <code>SharedWSServices.GetServicingCloseOutDefaultsId</code> (Guid or <code>Code</code> string) and fetches the row via <code>CloseOutDefaultServices.ReturnCloseOutDefault</code> to preserve the row's current <code>Ts</code>. Returns <code>\"Close out default not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p>Delegates to <code>CloseOutDefaultWSServices.AddSaveCloseOutDefaultWS</code> with the resolved existing entity and the caller-provided field values.</p>\n<p>See the Add endpoint for the full enum value legend for each method field.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.CloseOutDefaults.Id</code> Guid or <code>Code</code> string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Client-scoped close-out default code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Template description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the template is available for selection.</td>\n</tr>\n<tr>\n<td><em>closeOutType</em></td>\n<td>Required integer. <code>1</code> Charge Off, <code>2</code> Unwind, <code>3</code> Write Off, <code>4</code> Repurchase.</td>\n</tr>\n<tr>\n<td><em>unpaidLateChargeMethod</em></td>\n<td>Optional integer. Unpaid late charge handling.</td>\n</tr>\n<tr>\n<td><em>unpaidOtherBalanceFeeMethod</em></td>\n<td>Optional integer. Unpaid other-balance fee handling.</td>\n</tr>\n<tr>\n<td><em>accruedInterestMethod</em></td>\n<td>Optional integer. Accrued-interest handling.</td>\n</tr>\n<tr>\n<td><em>unpaidSubAccountMethod</em></td>\n<td>Optional integer. Unpaid subaccount handling.</td>\n</tr>\n<tr>\n<td><em>unpaidRemainingSubAccountInsuranceMethod</em></td>\n<td>Optional integer. Unpaid subaccount insurance handling.</td>\n</tr>\n<tr>\n<td><em>financeChargeEarningsMethod</em></td>\n<td>Optional integer. Finance-charge earnings method.</td>\n</tr>\n<tr>\n<td><em>unearnedPointsAcqIncomeMethod</em></td>\n<td>Optional integer. Unearned points/acquisition income method.</td>\n</tr>\n<tr>\n<td><em>unearnedPointsAcqBalanceMethod</em></td>\n<td>Optional integer. Unearned points/acquisition balance method.</td>\n</tr>\n<tr>\n<td><em>discountBalanceMethod</em></td>\n<td>Optional integer. Discount balance method.</td>\n</tr>\n<tr>\n<td><em>discountEarningsMethod</em></td>\n<td>Optional integer. Discount earnings method.</td>\n</tr>\n<tr>\n<td><em>dealerReserveAdjustmentMethod</em></td>\n<td>Optional integer. Dealer reserve adjustment method.</td>\n</tr>\n<tr>\n<td><em>unwindOption</em></td>\n<td>Optional integer. Unwind option (required when <code>closeOutType = 2</code>).</td>\n</tr>\n<tr>\n<td><em>newAdminStatusCodeOrId</em></td>\n<td>Optional string. Admin status Guid or code applied on close-out.</td>\n</tr>\n<tr>\n<td><em>subAccountTransCodeOrId</em></td>\n<td>Optional string. Transaction code Guid or code used when charging subaccounts back.</td>\n</tr>\n<tr>\n<td><em>writeOffTransactionCodeOrId</em></td>\n<td>Optional string. Transaction code Guid or code used for write-off close-outs. Used only when <code>closeOutType = 3</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Guid of the updated close-out default (returned as a string).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","CloseOutDefault","{{close_out_default_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"650fb574-60e6-41e9-9389-f93229848db4","name":"UpdateCloseOutDefault - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"CO\",\n    \"description\": \"Standard Charge-Off (Updated)\",\n    \"active\": true,\n    \"closeOutType\": 1,\n    \"unpaidLateChargeMethod\": 1,\n    \"unpaidOtherBalanceFeeMethod\": 1,\n    \"accruedInterestMethod\": 1,\n    \"unpaidSubAccountMethod\": 2,\n    \"unpaidRemainingSubAccountInsuranceMethod\": 1,\n    \"financeChargeEarningsMethod\": 1,\n    \"unearnedPointsAcqIncomeMethod\": 1,\n    \"unearnedPointsAcqBalanceMethod\": 1,\n    \"discountBalanceMethod\": 1,\n    \"discountEarningsMethod\": 1,\n    \"dealerReserveAdjustmentMethod\": 4,\n    \"unwindOption\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"subAccountTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{{close_out_default_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"66296a99-aa90-43b9-807b-64d8c27a3bbe","name":"UpdateCloseOutDefault - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"DOES-NOT-EXIST\",\n    \"description\": \"Standard Charge-Off (Updated)\",\n    \"active\": true,\n    \"closeOutType\": 1,\n    \"unpaidLateChargeMethod\": 1,\n    \"unpaidOtherBalanceFeeMethod\": 1,\n    \"accruedInterestMethod\": 1,\n    \"unpaidSubAccountMethod\": 2,\n    \"unpaidRemainingSubAccountInsuranceMethod\": 1,\n    \"financeChargeEarningsMethod\": 1,\n    \"unearnedPointsAcqIncomeMethod\": 1,\n    \"unearnedPointsAcqBalanceMethod\": 1,\n    \"discountBalanceMethod\": 1,\n    \"discountEarningsMethod\": 1,\n    \"dealerReserveAdjustmentMethod\": 4,\n    \"unwindOption\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"subAccountTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CloseOutDefault/{{close_out_default_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Close out default not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"40d302f6-c141-46fc-b3ae-506d1f14bcd4"},{"name":"CollectionsConfigurationGet","id":"29431b61-49fc-4ac0-a0a5-a0ebed8b7e28","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Configuration/Collections?token={{token}}","description":"<h3 id=\"get-servicing-collections-configuration\">Get Servicing Collections Configuration</h3>\n<p>Returns the Collections module subset of the Servicing master configuration. Delegates to <code>ExternalMasterConfigurationWSServices.ReturnCollectionsConfigurationWS</code> which calls <code>GeneralLedgerExternalMasterConfigurationServices.ReturnCollectionsExternalMasterConfiguration</code>. Used by the Collections setup UI to pre-populate the queue/assignment settings without loading the full Servicing configuration payload.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Configuration/Collections</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Collections configuration projection: <code>AgingType</code>, <code>AssignMinimumDaysPastDue</code>, <code>AssignMaximumDaysPastDue</code>, <code>AssignCurrentAccounts</code>, <code>AssignChargeOffAccounts</code>, <code>UnassignedAccountCollectorId</code>, <code>BalancePriorityInQueue</code>, <code>AgePriorityInQueue</code>, <code>ScorePriorityInQueue</code>, <code>QueueCurrentAccounts</code>, <code>QueueChargeOffAccounts</code>, <code>UseCollectionsModule</code>, <code>CollectorGoalAmountOption</code>, <code>AssignNewAccounts</code>, <code>BalanceType</code>, <code>QueueMinimumDaysPastDue</code>, <code>QueueMaximumDaysPastDue</code>, <code>DefaultMaxMinutesPerCall</code>, <code>DefaultMaxSecondsPerCall</code>. These fields are updated via the Servicing <code>PUT /Configuration</code> endpoint using the <code>collectionsConfiguration</code> aggregate.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Configuration","Collections"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"cddd7eeb-292c-43e4-a196-df29499c303e","name":"GetCollectionsConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration/Collections?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration","Collections"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"AgingType\": 1,\n        \"AssignMinimumDaysPastDue\": 1,\n        \"AssignMaximumDaysPastDue\": 180,\n        \"AssignCurrentAccounts\": false,\n        \"AssignChargeOffAccounts\": false,\n        \"UnassignedAccountCollectorId\": null,\n        \"BalancePriorityInQueue\": 1,\n        \"AgePriorityInQueue\": 2,\n        \"ScorePriorityInQueue\": 3,\n        \"QueueCurrentAccounts\": false,\n        \"QueueChargeOffAccounts\": false,\n        \"UseCollectionsModule\": true,\n        \"CollectorGoalAmountOption\": 1,\n        \"AssignNewAccounts\": true,\n        \"BalanceType\": 1,\n        \"QueueMinimumDaysPastDue\": 1,\n        \"QueueMaximumDaysPastDue\": 180,\n        \"DefaultMaxMinutesPerCall\": 5,\n        \"DefaultMaxSecondsPerCall\": 0\n    },\n    \"errors\": []\n}"},{"id":"5bb37cdd-2623-473c-a365-5febcbcd9e0a","name":"GetCollectionsConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration/Collections?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration","Collections"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Servicing module configuration not found\"\n    ]\n}"}],"_postman_id":"29431b61-49fc-4ac0-a0a5-a0ebed8b7e28"},{"name":"CollectorAdd","id":"a8ff83a8-a57d-43b2-8742-d50c528d6525","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"userIdOrLogin\": \"collector1\",\n  \"isAvailable\": true,\n  \"customizeSettings\": false,\n  \"agingType\": 1,\n  \"queueMinDaysPastDue\": 0,\n  \"queueMaxDaysPastDue\": 30,\n  \"assistCollectorId\": null,\n  \"balancePriorityInQueue\": 1,\n  \"agePriorityInQueue\": 2,\n  \"scorePriorityInQueue\": 3,\n  \"queueCurrentAccounts\": false,\n  \"queueChargeOffAccounts\": false,\n  \"includeScheduledFUPs\": true,\n  \"queueMethod\": 1,\n  \"queryId\": null,\n  \"loadFactor\": 1,\n  \"assistCollectorLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Collector","description":"<h3 id=\"add-servicing-collector\">Add Servicing Collector</h3>\n<p>Creates a new collector for the current client. Delegates to <code>CollectorWSServices.AddSaveCollectorWS</code> with no existing entity. The <code>userIdOrLogin</code> field accepts either a <code>Setup.User.Id</code> Guid or a <code>UserLogin</code> string — <code>SharedWSServices.GetSetupUserId</code> resolves both forms. Rejects the request when another collector already exists for the resolved user.</p>\n<p>Enum-backed integer fields:</p>\n<ul>\n<li><code>agingType</code> — <code>1</code> Contractual, <code>2</code> Recency, <code>3</code> Calendar - <code>queueMethod</code> — <code>1</code> Queue, <code>2</code> Assist Collector, <code>3</code> Query</li>\n</ul>\n<p>When <code>queueMethod = 2</code> (Assist Collector), <code>assistCollectorId</code> must be supplied. When <code>queueMethod = 3</code> (Query), <code>queryId</code> must reference an existing <code>Global.Query</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Collector</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>userIdOrLogin</em></td>\n<td>Required string. <code>Setup.User.Id</code> Guid or <code>UserLogin</code> string.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the collector is available for assignment.</td>\n</tr>\n<tr>\n<td><em>customizeSettings</em></td>\n<td>Required bool. Whether the collector overrides client default queue/aging settings.</td>\n</tr>\n<tr>\n<td><em>agingType</em></td>\n<td>Required integer. <code>1</code> Contractual, <code>2</code> Recency, <code>3</code> Calendar.</td>\n</tr>\n<tr>\n<td><em>queueMinDaysPastDue</em></td>\n<td>Optional integer. Minimum days past due for accounts to appear in the queue.</td>\n</tr>\n<tr>\n<td><em>queueMaxDaysPastDue</em></td>\n<td>Optional integer. Maximum days past due for accounts to appear in the queue.</td>\n</tr>\n<tr>\n<td><em>assistCollectorId</em></td>\n<td>Optional Guid. Required when <code>queueMethod = 2</code>.</td>\n</tr>\n<tr>\n<td><em>balancePriorityInQueue</em></td>\n<td>Optional integer. Balance priority rank.</td>\n</tr>\n<tr>\n<td><em>agePriorityInQueue</em></td>\n<td>Optional integer. Age priority rank.</td>\n</tr>\n<tr>\n<td><em>scorePriorityInQueue</em></td>\n<td>Optional integer. Score priority rank.</td>\n</tr>\n<tr>\n<td><em>queueCurrentAccounts</em></td>\n<td>Required bool. Include current (not past-due) accounts in the queue.</td>\n</tr>\n<tr>\n<td><em>queueChargeOffAccounts</em></td>\n<td>Required bool. Include charge-off accounts in the queue.</td>\n</tr>\n<tr>\n<td><em>includeScheduledFUPs</em></td>\n<td>Required bool. Include scheduled follow-ups in the queue.</td>\n</tr>\n<tr>\n<td><em>queueMethod</em></td>\n<td>Required integer. <code>1</code> Queue, <code>2</code> Assist Collector, <code>3</code> Query.</td>\n</tr>\n<tr>\n<td><em>queryId</em></td>\n<td>Optional Guid. Required when <code>queueMethod = 3</code>.</td>\n</tr>\n<tr>\n<td><em>loadFactor</em></td>\n<td>Required decimal. Distribution factor for round-robin queue loads (typically <code>1.00</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Guid of the new collector (returned as a string).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>assistCollectorLoginOrId</code></td>\n<td><code>assistCollectorId</code></td>\n<td>String. associated user login or collector GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"assistCollectorLoginOrId\": \"collector.login\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Collector"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"73dca5e3-be18-47c0-bf37-56c3309f2d3b","name":"AddCollector - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"userIdOrLogin\": \"collector1\",\n  \"isAvailable\": true,\n  \"customizeSettings\": false,\n  \"agingType\": 1,\n  \"queueMinDaysPastDue\": 0,\n  \"queueMaxDaysPastDue\": 30,\n  \"assistCollectorId\": null,\n  \"balancePriorityInQueue\": 1,\n  \"agePriorityInQueue\": 2,\n  \"scorePriorityInQueue\": 3,\n  \"queueCurrentAccounts\": false,\n  \"queueChargeOffAccounts\": false,\n  \"includeScheduledFUPs\": true,\n  \"queueMethod\": 1,\n  \"queryId\": null,\n  \"loadFactor\": 1,\n  \"assistCollectorLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Collector"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"b2c3d4e5-2222-4333-9444-bcdef0123456\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e46fa3f5-6910-4f78-beed-990b1bb98211","name":"AddCollector - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"userIdOrLogin\": \"nonexistentuser\",\n  \"isAvailable\": true,\n  \"customizeSettings\": false,\n  \"agingType\": 1,\n  \"queueMinDaysPastDue\": 0,\n  \"queueMaxDaysPastDue\": 30,\n  \"assistCollectorId\": null,\n  \"balancePriorityInQueue\": 1,\n  \"agePriorityInQueue\": 2,\n  \"scorePriorityInQueue\": 3,\n  \"queueCurrentAccounts\": false,\n  \"queueChargeOffAccounts\": false,\n  \"includeScheduledFUPs\": true,\n  \"queueMethod\": 1,\n  \"queryId\": null,\n  \"loadFactor\": 1,\n  \"assistCollectorLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Collector"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"User not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"a8ff83a8-a57d-43b2-8742-d50c528d6525"},{"name":"CollectorGet","id":"15f558d0-27c0-4fbb-b970-adf76dab5117","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Collector/{{collector_id}}?token={{token}}&fetchUser=false","description":"<h3 id=\"get-servicing-collector\">Get Servicing Collector</h3>\n<p>This operation accepts associated user login or collector GUID in <code>id</code>. The GUID must identify the selected record type. A user GUID identifies a different record; use the associated user login or the collector/teller GUID.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Collector/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. associated user login or collector GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>fetchUser</em></td>\n<td>Optional bool. Defaults to <code>false</code>. When <code>true</code>, includes the linked <code>Setup.User</code> record as a nested property.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingCollectorEntity</code> with <code>Id</code>, <code>UserId</code>, <code>IsAvailable</code>, <code>CustomizeSettings</code>, <code>AgingType</code>, queue priority fields, <code>QueueMethod</code>, <code>QueryId</code>, <code>LoadFactor</code>, and <code>Ts</code>. When <code>fetchUser=true</code>, the <code>User</code> navigation is populated.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>associated user login or collector GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Collector/collector.login\n/api/Client/Servicing/Collector/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Collector","{{collector_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchUser","value":"false"}],"variable":[]}},"response":[{"id":"d3a483b6-fc76-426b-a08b-bdabb6964cb4","name":"GetCollector - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Collector/{{collector_id}}?token={{token}}&fetchUser=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Collector","{{collector_id}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchUser","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b2c3d4e5-2222-4333-9444-bcdef0123456\",\n        \"UserId\": \"c3d4e5f6-3333-4444-9555-cdef01234567\",\n        \"IsAvailable\": true,\n        \"CustomizeSettings\": false,\n        \"AgingType\": 1,\n        \"QueueMinDaysPastDue\": 0,\n        \"QueueMaxDaysPastDue\": 30,\n        \"AssistCollectorId\": null,\n        \"BalancePriorityInQueue\": 1,\n        \"AgePriorityInQueue\": 2,\n        \"ScorePriorityInQueue\": 3,\n        \"QueueCurrentAccounts\": false,\n        \"QueueChargeOffAccounts\": false,\n        \"IncludeScheduledFUPs\": true,\n        \"QueueMethod\": 1,\n        \"QueryId\": null,\n        \"LoadFactor\": 1.00,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"ba31ca91-2804-412f-87b7-12f58cdeb4a6","name":"GetCollector - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Collector/11111111-1111-4111-8111-111111111111?token={{token}}&fetchUser=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Collector","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchUser","value":"false"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"15f558d0-27c0-4fbb-b970-adf76dab5117"},{"name":"CollectorsGetAll","id":"fc2d443d-2b4a-4c8d-a11d-434d61600b66","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Collector?token={{token}}&activeOnly=true","description":"<h3 id=\"get-all-servicing-collectors\">Get All Servicing Collectors</h3>\n<p>Returns every collector for the current client. Delegates to <code>CollectorWSServices.ReturnAllCollectorsWS</code>, which reads rows from <code>Servicing.Collector</code> scoped to the authenticated client.</p>\n<p>When <code>activeOnly=true</code> (default), only collectors whose linked <code>Setup.User.IsActive</code> is <code>true</code> are returned.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Collector</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>activeOnly</em></td>\n<td>Optional bool. Defaults to <code>true</code> — restricts results to collectors whose user is active. Pass <code>false</code> to include inactive collectors.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingCollectorEntity</code> records with <code>Id</code>, <code>UserId</code>, <code>IsAvailable</code>, <code>CustomizeSettings</code>, <code>AgingType</code>, <code>QueueMinDaysPastDue</code>, <code>QueueMaxDaysPastDue</code>, <code>AssistCollectorId</code>, <code>BalancePriorityInQueue</code>, <code>AgePriorityInQueue</code>, <code>ScorePriorityInQueue</code>, <code>QueueCurrentAccounts</code>, <code>QueueChargeOffAccounts</code>, <code>IncludeScheduledFUPs</code>, <code>QueueMethod</code>, <code>QueryId</code>, <code>LoadFactor</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Collector"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"activeOnly","value":"true"}],"variable":[]}},"response":[{"id":"6a340b92-0cb8-4ca9-bcaf-cdfff85f3b3e","name":"GetAllCollectors - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Collector?token={{token}}&activeOnly=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Collector"],"query":[{"key":"token","value":"{{token}}"},{"key":"activeOnly","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"b2c3d4e5-2222-4333-9444-bcdef0123456\",\n            \"UserId\": \"c3d4e5f6-3333-4444-9555-cdef01234567\",\n            \"IsAvailable\": true,\n            \"CustomizeSettings\": false,\n            \"AgingType\": 1,\n            \"QueueMinDaysPastDue\": 0,\n            \"QueueMaxDaysPastDue\": 30,\n            \"AssistCollectorId\": null,\n            \"BalancePriorityInQueue\": 1,\n            \"AgePriorityInQueue\": 2,\n            \"ScorePriorityInQueue\": 3,\n            \"QueueCurrentAccounts\": false,\n            \"QueueChargeOffAccounts\": false,\n            \"IncludeScheduledFUPs\": true,\n            \"QueueMethod\": 1,\n            \"QueryId\": null,\n            \"LoadFactor\": 1.00,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e306cd46-8ec2-4006-b38b-f87f4676b5d1","name":"GetAllCollectors - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Collector?token=invalid-token&activeOnly=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Collector"],"query":[{"key":"token","value":"invalid-token"},{"key":"activeOnly","value":"true"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"fc2d443d-2b4a-4c8d-a11d-434d61600b66"},{"name":"CollectorUpdate","id":"7612158f-45dc-4e2b-a00a-c9be790561ce","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"userIdOrLogin\": \"collector1\",\n  \"isAvailable\": true,\n  \"customizeSettings\": true,\n  \"agingType\": 1,\n  \"queueMinDaysPastDue\": 0,\n  \"queueMaxDaysPastDue\": 60,\n  \"assistCollectorId\": null,\n  \"balancePriorityInQueue\": 2,\n  \"agePriorityInQueue\": 1,\n  \"scorePriorityInQueue\": 3,\n  \"queueCurrentAccounts\": false,\n  \"queueChargeOffAccounts\": false,\n  \"includeScheduledFUPs\": true,\n  \"queueMethod\": 1,\n  \"queryId\": null,\n  \"loadFactor\": 1.5,\n  \"assistCollectorLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Collector/{{collector_id}}","description":"<h3 id=\"update-servicing-collector\">Update Servicing Collector</h3>\n<p>This operation accepts associated user login or collector GUID in <code>id</code>. The GUID must identify the selected record type. A user GUID identifies a different record; use the associated user login or the collector/teller GUID.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Collector/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. associated user login or collector GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>userIdOrLogin</em></td>\n<td>Required string. <code>Setup.User.Id</code> Guid or <code>UserLogin</code> string.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the collector is available for assignment.</td>\n</tr>\n<tr>\n<td><em>customizeSettings</em></td>\n<td>Required bool. Whether the collector overrides client default queue/aging settings.</td>\n</tr>\n<tr>\n<td><em>agingType</em></td>\n<td>Required integer. <code>1</code> Contractual, <code>2</code> Recency, <code>3</code> Calendar.</td>\n</tr>\n<tr>\n<td><em>queueMinDaysPastDue</em></td>\n<td>Optional integer. Minimum days past due for accounts to appear in the queue.</td>\n</tr>\n<tr>\n<td><em>queueMaxDaysPastDue</em></td>\n<td>Optional integer. Maximum days past due for accounts to appear in the queue.</td>\n</tr>\n<tr>\n<td><em>assistCollectorId</em></td>\n<td>Optional Guid. Required when <code>queueMethod = 2</code>.</td>\n</tr>\n<tr>\n<td><em>balancePriorityInQueue</em></td>\n<td>Optional integer. Balance priority rank.</td>\n</tr>\n<tr>\n<td><em>agePriorityInQueue</em></td>\n<td>Optional integer. Age priority rank.</td>\n</tr>\n<tr>\n<td><em>scorePriorityInQueue</em></td>\n<td>Optional integer. Score priority rank.</td>\n</tr>\n<tr>\n<td><em>queueCurrentAccounts</em></td>\n<td>Required bool. Include current (not past-due) accounts in the queue.</td>\n</tr>\n<tr>\n<td><em>queueChargeOffAccounts</em></td>\n<td>Required bool. Include charge-off accounts in the queue.</td>\n</tr>\n<tr>\n<td><em>includeScheduledFUPs</em></td>\n<td>Required bool. Include scheduled follow-ups in the queue.</td>\n</tr>\n<tr>\n<td><em>queueMethod</em></td>\n<td>Required integer. <code>1</code> Queue, <code>2</code> Assist Collector, <code>3</code> Query.</td>\n</tr>\n<tr>\n<td><em>queryId</em></td>\n<td>Optional Guid. Required when <code>queueMethod = 3</code>.</td>\n</tr>\n<tr>\n<td><em>loadFactor</em></td>\n<td>Required decimal. Distribution factor for round-robin queue loads.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Guid of the updated collector (returned as a string).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>associated user login or collector GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>assistCollectorLoginOrId</code></td>\n<td><code>assistCollectorId</code></td>\n<td>String. associated user login or collector GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"assistCollectorLoginOrId\": \"collector.login\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Collector/collector.login\n/api/Client/Servicing/Collector/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Collector","{{collector_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9a6bc190-2199-496c-ba21-5420f5b657d6","name":"UpdateCollector - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"userIdOrLogin\": \"collector1\",\n  \"isAvailable\": true,\n  \"customizeSettings\": true,\n  \"agingType\": 1,\n  \"queueMinDaysPastDue\": 0,\n  \"queueMaxDaysPastDue\": 60,\n  \"assistCollectorId\": null,\n  \"balancePriorityInQueue\": 2,\n  \"agePriorityInQueue\": 1,\n  \"scorePriorityInQueue\": 3,\n  \"queueCurrentAccounts\": false,\n  \"queueChargeOffAccounts\": false,\n  \"includeScheduledFUPs\": true,\n  \"queueMethod\": 1,\n  \"queryId\": null,\n  \"loadFactor\": 1.5,\n  \"assistCollectorLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Collector/{{collector_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"b2c3d4e5-2222-4333-9444-bcdef0123456\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"002de870-70ab-4bd5-8ebb-629d66bd61ce","name":"UpdateCollector - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"userIdOrLogin\": \"collector1\",\n  \"isAvailable\": true,\n  \"customizeSettings\": true,\n  \"agingType\": 1,\n  \"queueMinDaysPastDue\": 0,\n  \"queueMaxDaysPastDue\": 60,\n  \"assistCollectorId\": null,\n  \"balancePriorityInQueue\": 2,\n  \"agePriorityInQueue\": 1,\n  \"scorePriorityInQueue\": 3,\n  \"queueCurrentAccounts\": false,\n  \"queueChargeOffAccounts\": false,\n  \"includeScheduledFUPs\": true,\n  \"queueMethod\": 1,\n  \"queryId\": null,\n  \"loadFactor\": 1.5,\n  \"assistCollectorLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Collector/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"7612158f-45dc-4e2b-a00a-c9be790561ce"},{"name":"DefaultFundsCodeByFundsTypeGet","id":"8892119e-2485-4885-852a-5fb1a5bffb64","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/FundsCode/GetDefaultByFundsType/{{funds_type}}?token={{token}}","description":"<h3 id=\"get-default-servicing-funds-code-by-funds-type\">Get Default Servicing Funds Code By Funds Type</h3>\n<p>Helper route that returns the default funds code for a given <code>FundsType</code>. Delegates to <code>FundsCodeWSServices.GetDefaultFundsCodeByFundsType</code>, which parses the <code>fundsType</code> path segment as <code>Omega.Servicing.Types.Enums.FundsType</code> and calls <code>FundsCodeServices.ReturnDefaultFundsCodeByFundsType</code>. Returns an error when the enum value is not valid.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/FundsCode/GetDefaultByFundsType/{fundsType}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fundsType</em></td>\n<td>Required enum. <code>Omega.Servicing.Types.Enums.FundsType</code> name (e.g. <code>Cash</code>, <code>Trust</code>).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingFundsCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Available</code>, <code>FundsType</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","FundsCode","GetDefaultByFundsType","{{funds_type}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"df518827-eba7-4882-a755-4655597928d6","name":"GetDefaultFundsCodeByFundsType - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode/GetDefaultByFundsType/{{funds_type}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode","GetDefaultByFundsType","{{funds_type}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-1111-4222-9333-abcdef012345\",\n        \"Description\": \"Checking Account\",\n        \"Available\": true,\n        \"FundsType\": \"Cash\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"3cc69483-097b-4f85-b1a3-37fd8b303629","name":"GetDefaultFundsCodeByFundsType - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode/GetDefaultByFundsType/NotAFundsType?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode","GetDefaultByFundsType","NotAFundsType"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid funds type format\"\n    ]\n}"}],"_postman_id":"8892119e-2485-4885-852a-5fb1a5bffb64"},{"name":"DefaultGeneralLedgerAccountsGet","id":"b7464a51-5433-4abc-9572-56b52db92f1a","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Configuration/DefaultGLAccounts?token={{token}}","description":"<h3 id=\"get-servicing-default-gl-accounts\">Get Servicing Default GL Accounts</h3>\n<p>Returns the GL account mapping used by Servicing postings. Delegates to <code>ExternalMasterConfigurationWSServices.ReturnDefaultGeneralLedgerAccountsWS</code> which calls <code>GeneralLedgerExternalMasterConfigurationServices.ReturnDefaultGeneralLedgerAccountsByExternalMasterConfigId</code>. Used by the Servicing configuration UI to populate the default GL account pickers. Updates flow through the Servicing <code>PUT /Configuration</code> endpoint's <code>defaultGeneralLedgerAccounts</code> aggregate.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Configuration/DefaultGLAccounts</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>MyServicingDefaultGeneralLedgerAccountsEntity</code> projection — 19 nullable GL account Id fields:</p>\n<ul>\n<li><code>ReceivablesAccountId</code>, <code>LossReserveAccountId</code>, <code>LossRecoveriesAccountId</code> - <code>InterestReceivablesAccountId</code>, <code>InterestEarningsAccountId</code> - <code>UnearnedFinanceChargeAccountId</code>, <code>EarnedFinanceChargeAccountId</code> - <code>UnearnedDiscountAccountId</code>, <code>EarnedDiscountAccountId</code> - <code>NewAccountClearingAccountId</code>, <code>GeneralClearingAccountId</code> - <code>IvaPaymentAccountId</code> - <code>DealerWithholdAccountId</code>, <code>DealerReserveAccountId</code>,\n<code>NegativeDealerReserveAccountId</code></li>\n<li><code>PointsAccountId</code>, <code>UnearnedPointsAccountId</code> - <code>AcquisitionAccountId</code>, <code>UnearnedAcquisitionAccountId</code>\nPlus the concurrency token <code>Ts</code>. When no row exists yet the endpoint returns a zeroed-out projection with <code>Id: null</code>.</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Configuration","DefaultGLAccounts"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5e904896-821b-4853-8269-3cbd7d60e88e","name":"GetDefaultGeneralLedgerAccounts - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration/DefaultGLAccounts?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration","DefaultGLAccounts"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"ReceivablesAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"LossReserveAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012346\",\n        \"LossRecoveriesAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012347\",\n        \"InterestReceivablesAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012348\",\n        \"InterestEarningsAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012349\",\n        \"UnearnedFinanceChargeAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef01234a\",\n        \"EarnedFinanceChargeAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef01234b\",\n        \"UnearnedDiscountAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef01234c\",\n        \"EarnedDiscountAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef01234d\",\n        \"NewAccountClearingAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef01234e\",\n        \"GeneralClearingAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef01234f\",\n        \"IvaPaymentAccountId\": null,\n        \"DealerWithholdAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012350\",\n        \"DealerReserveAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012351\",\n        \"NegativeDealerReserveAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012352\",\n        \"PointsAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012353\",\n        \"UnearnedPointsAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012354\",\n        \"AcquisitionAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012355\",\n        \"UnearnedAcquisitionAccountId\": \"d1b2c3d4-1111-4222-9333-abcdef012356\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": []\n}"},{"id":"b3394f21-7962-4590-ade9-c8abab2f1561","name":"GetDefaultGeneralLedgerAccounts - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration/DefaultGLAccounts?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration","DefaultGLAccounts"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ]\n}"}],"_postman_id":"b7464a51-5433-4abc-9572-56b52db92f1a"},{"name":"DefaultTransactionCodesGet","id":"866b9e96-4abd-46cc-b56b-b403a9042f51","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Configuration/DefaultTransactionCodes?token={{token}}","description":"<h3 id=\"get-servicing-default-transaction-codes\">Get Servicing Default Transaction Codes</h3>\n<p>Returns the Servicing default conversion transaction code mapping used when converting accounts from legacy systems. Delegates to <code>ExternalMasterConfigurationWSServices.ReturnDefaultTransactionCodesWS</code> which calls <code>GeneralLedgerExternalMasterConfigurationServices.ReturnDefaultTransactionCodesByClientId</code>. Used by the Servicing configuration UI to populate the Conversion Transaction Codes tab. Updates flow through the Servicing <code>PUT /Configuration</code> endpoint's <code>defaultTransactionCodes</code> aggregate.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Configuration/DefaultTransactionCodes</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the default transaction-code projection — 11 nullable transaction code Id fields used during conversion:</p>\n<ul>\n<li><code>OpeningConvCodeId</code> — opening balance transaction - <code>PaymentConvCodeId</code> — converted payment transaction - <code>InterestConvCodeId</code> — converted interest transaction - <code>LateFeeConvCodeId</code> — converted late fee transaction - <code>NsfFeeConvCodeId</code> — converted NSF fee transaction - <code>OtherBalConvCodeId</code> — other balance transaction - <code>ExtFeeConvCodeId</code> — extension fee transaction - <code>MiscAdjConvCodeId</code> — miscellaneous adjustment transaction - <code>FinanceChargeConvCodeId</code> — finance charge transaction - <code>ChargeOffConvCodeId</code> — charge-off transaction - <code>AllOtherConvCodeId</code> — catch-all for other converted transactions\nPlus the concurrency token <code>Ts</code>.</li>\n</ul>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Configuration","DefaultTransactionCodes"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ee5bb8b0-cdee-4cfc-98f1-eb1d665b0e34","name":"GetDefaultTransactionCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration/DefaultTransactionCodes?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration","DefaultTransactionCodes"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OpeningConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012360\",\n        \"PaymentConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012361\",\n        \"InterestConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012362\",\n        \"LateFeeConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012363\",\n        \"NsfFeeConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012364\",\n        \"OtherBalConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012365\",\n        \"ExtFeeConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012366\",\n        \"MiscAdjConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012367\",\n        \"FinanceChargeConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012368\",\n        \"ChargeOffConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012369\",\n        \"AllOtherConvCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01236a\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": []\n}"},{"id":"115b6b3a-5019-4bf6-b729-0e1ed54e804b","name":"GetDefaultTransactionCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration/DefaultTransactionCodes?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration","DefaultTransactionCodes"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ]\n}"}],"_postman_id":"866b9e96-4abd-46cc-b56b-b403a9042f51"},{"name":"ExternalMasterConfiguration","id":"2853fcf3-59ba-4693-9b41-a9c3b89ab2b5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"newAccountOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"agedConvOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012346\",\n  \"interestPaymentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012347\",\n  \"extensionFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012348\",\n  \"defaultActivatedAccountAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"nsfFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012349\",\n  \"lateChargeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234a\",\n  \"chargeOffTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234b\",\n  \"ivaFeeTransactionCodeId\": null,\n  \"defaultChargeOffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012346\",\n  \"defaultWriteOffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef01234b\",\n  \"defaultPayoffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012347\",\n  \"defaultBuyBackAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012348\",\n  \"defaultUnwindAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012349\",\n  \"discountAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012350\",\n  \"discountCreditOrDebitTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012351\",\n  \"financeChargeAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012352\",\n  \"financeChargeRebateTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012353\",\n  \"conversionLateFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012354\",\n  \"conversionOtherFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012355\",\n  \"unwindTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012356\",\n  \"reserveAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012357\",\n  \"withholdAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012358\",\n  \"pointsAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012359\",\n  \"acquisitionFeeAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01235a\",\n  \"agingPeriod1MinDays\": 0,\n  \"agingPeriod1MaxDays\": 9,\n  \"agingPeriod2MinDays\": 10,\n  \"agingPeriod2MaxDays\": 29,\n  \"agingPeriod3MinDays\": 30,\n  \"agingPeriod3MaxDays\": 59,\n  \"agingPeriod4MinDays\": 60,\n  \"agingPeriod4MaxDays\": 89,\n  \"agingPeriod5MinDays\": 90,\n  \"agingPeriod5MaxDays\": 119,\n  \"agingPeriod6MinDays\": 120,\n  \"agingPeriod6MaxDays\": 149,\n  \"agingPeriod7MinDays\": 150,\n  \"agingPeriod7MaxDays\": 179,\n  \"agingPeriod8MinDays\": 180,\n  \"accrualBasis\": 1,\n  \"maxTellerDrawerOpenDays\": 3,\n  \"dsrBalanceType\": 1,\n  \"dsrAgingType\": 1,\n  \"dsrIncludeAgingPeriod1\": false,\n  \"dsrIncludeAgingPeriod2\": true,\n  \"dsrIncludeAgingPeriod3\": true,\n  \"dsrIncludeAgingPeriod4\": true,\n  \"dsrIncludeAgingPeriod5\": true,\n  \"dsrIncludeAgingPeriod6\": true,\n  \"dsrIncludeAgingPeriod7\": true,\n  \"dsrIncludeAgingPeriod8\": true,\n  \"noteGridSize\": 1,\n  \"notesGridPageSize\": 25,\n  \"transactionGridPageSize\": 25,\n  \"defaultGeneralLedgerAccounts\": null,\n  \"defaultTransactionCodes\": null,\n  \"collectionsConfiguration\": null,\n  \"newAccountOpeningTransactionCodeOrId\": null,\n  \"agedConvOpeningTransactionCodeOrId\": null,\n  \"interestPaymentTransactionCodeOrId\": null,\n  \"extensionFeeTransactionCodeOrId\": null,\n  \"defaultActivatedAccountAdminStatusCodeOrId\": null,\n  \"nsfFeeTransactionCodeOrId\": null,\n  \"lateChargeTransactionCodeOrId\": null,\n  \"chargeOffTransactionCodeOrId\": null,\n  \"ivaFeeTransactionCodeOrId\": null,\n  \"defaultChargeOffAdminStatusCodeOrId\": null,\n  \"defaultWriteOffAdminStatusCodeOrId\": null,\n  \"defaultPayoffAdminStatusCodeOrId\": null,\n  \"defaultBuyBackAdminStatusCodeOrId\": null,\n  \"defaultUnwindAdminStatusCodeOrId\": null,\n  \"discountAdjustmentTransactionCodeOrId\": null,\n  \"discountCreditOrDebitTransactionCodeOrId\": null,\n  \"financeChargeAdjustmentTransactionCodeOrId\": null,\n  \"financeChargeRebateTransactionCodeOrId\": null,\n  \"conversionLateFeeTransactionCodeOrId\": null,\n  \"conversionOtherFeeTransactionCodeOrId\": null,\n  \"unwindTransactionCodeOrId\": null,\n  \"reserveAdjustmentTransactionCodeOrId\": null,\n  \"withholdAdjustmentTransactionCodeOrId\": null,\n  \"pointsAdjustmentTransactionCodeOrId\": null,\n  \"acquisitionFeeAdjustmentTransactionCodeOrId\": null,\n  \"conversionGenericFollowUpTaskTemplateNumberOrId\": null,\n  \"conversionSumOfOriginationsFeeCodeDescriptionOrId\": null,\n  \"conversionSumOfOriginationsFinanceFeeCodeDescriptionOrId\": null,\n  \"conversionTrackingProductCodeOrId\": null,\n  \"defaultNewDirectAccountCashDisbursementFundsCodeDescriptionOrId\": null,\n  \"defaultPayoffActionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Configuration","description":"<h3 id=\"save-servicing-external-master-configuration\">Save Servicing External Master Configuration</h3>\n<p>Upserts the single Servicing master configuration row for the current client. This is the PUT endpoint used for both the initial create <strong>and</strong> subsequent updates — the server detects whether a row already exists and performs an insert-or-update in a single transaction. Delegates to <code>ExternalMasterConfigurationWSServices.AddSaveServicingExternalMasterConfigurationWS</code> which enforces:</p>\n<ul>\n<li><code>accrualBasis</code>, <code>dsrBalanceType</code>, <code>dsrAgingType</code>, <code>noteGridSize</code>,\n<code>notesGridPageSize</code>, <code>transactionGridPageSize</code> must map to the respective\nenums (<code>AccrualBasisType</code>, <code>DSRBalanceType</code>, <code>DSRAgingType</code>, <code>GridSize</code>,\n<code>GridPageSize</code>) or the call fails with\n<code>Invalid ...</code>.</li>\n<li><code>maxTellerDrawerOpenDays</code> must be between 1 and 8 inclusive. - Each aging period <code>Min &lt;= Max</code> and periods chain consecutively\n(<code>Period2.Min = Period1.Max + 1</code>, etc.). Same rule applies to DSR aging\nperiods when the corresponding include flag is true.</li>\n<li>All of the provided transaction code and admin status Ids must resolve to\nan active row in the client database.</li>\n<li>When <code>defaultGeneralLedgerAccounts</code> is supplied, each referenced GL\naccount pair (Interest Receivables/Earnings,\nUnearned/Earned Discount, Unearned/Earned Finance Charge,\nUnearned/Earned Points, Unearned/Earned Acquisition,\nDealer Reserve/Withhold, Dealer Reserve/Negative Dealer Reserve) must\npoint at distinct GL accounts or the save fails with\n<code>... accounts must be distinct</code>.</li>\n</ul>\n<p>Nested aggregates let a single PUT also update child configuration:</p>\n<ul>\n<li><code>defaultGeneralLedgerAccounts</code> — 19 optional GL account Ids used by\nServicing postings. Processed via\n<code>DefaultGeneralLedgerAccountsServices.AddSave...</code>.</li>\n<li><code>defaultTransactionCodes</code> — 11 optional conversion transaction code Ids\n(<code>openingConvCodeId</code>, <code>paymentConvCodeId</code>, etc.).</li>\n<li><code>collectionsConfiguration</code> — Collections module defaults (aging type,\npriority weights, assignment rules, collector goal option, queue day\nranges, default call time limits).</li>\n</ul>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Configuration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>newAccountOpeningTransactionCodeId</em></td>\n<td>Required Guid. Transaction code used when a new account opens.</td>\n</tr>\n<tr>\n<td><em>agedConvOpeningTransactionCodeId</em></td>\n<td>Required Guid. Transaction code used when an aged converted account opens.</td>\n</tr>\n<tr>\n<td><em>interestPaymentTransactionCodeId</em></td>\n<td>Required Guid. Transaction code used for interest payments.</td>\n</tr>\n<tr>\n<td><em>extensionFeeTransactionCodeId</em></td>\n<td>Required Guid. Transaction code used for extension fees.</td>\n</tr>\n<tr>\n<td><em>defaultActivatedAccountAdminStatusId</em></td>\n<td>Required Guid. Admin status Id assigned when an account is activated.</td>\n</tr>\n<tr>\n<td><em>nsfFeeTransactionCodeId</em></td>\n<td>Required Guid. Transaction code used for NSF fees.</td>\n</tr>\n<tr>\n<td><em>lateChargeTransactionCodeId</em></td>\n<td>Required Guid. Transaction code used for late charges.</td>\n</tr>\n<tr>\n<td><em>chargeOffTransactionCodeId</em></td>\n<td>Required Guid. Transaction code used when an account is charged off.</td>\n</tr>\n<tr>\n<td><em>ivaFeeTransactionCodeId</em></td>\n<td>Optional Guid. Transaction code used for IVA fees.</td>\n</tr>\n<tr>\n<td><em>defaultChargeOffAdminStatusId</em></td>\n<td>Required Guid. Admin status Id assigned to charged-off accounts.</td>\n</tr>\n<tr>\n<td><em>defaultWriteOffAdminStatusId</em></td>\n<td>Required Guid. Admin status Id assigned to written-off accounts. If omitted or empty, the server uses <code>defaultChargeOffAdminStatusId</code>.</td>\n</tr>\n<tr>\n<td><em>defaultPayoffAdminStatusId</em></td>\n<td>Required Guid. Admin status Id assigned to paid-off accounts.</td>\n</tr>\n<tr>\n<td><em>defaultBuyBackAdminStatusId</em></td>\n<td>Required Guid. Admin status Id assigned to bought-back accounts.</td>\n</tr>\n<tr>\n<td><em>defaultUnwindAdminStatusId</em></td>\n<td>Required Guid. Admin status Id assigned to unwound accounts.</td>\n</tr>\n<tr>\n<td><em>discountAdjustmentTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>discountCreditOrDebitTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>financeChargeAdjustmentTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>financeChargeRebateTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>conversionLateFeeTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>conversionOtherFeeTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>unwindTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>reserveAdjustmentTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>withholdAdjustmentTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>pointsAdjustmentTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>acquisitionFeeAdjustmentTransactionCodeId</em></td>\n<td>Required Guid.</td>\n</tr>\n<tr>\n<td><em>agingPeriod1MinDays</em> … <em>agingPeriod8MinDays</em> / <em>agingPeriod1MaxDays</em> … <em>agingPeriod7MaxDays</em></td>\n<td>Optional ints. Define the consecutive aging bucket ranges in days. Period 8 has only a minimum (open-ended).</td>\n</tr>\n<tr>\n<td><em>accrualBasis</em></td>\n<td>Required int. Enum <code>AccrualBasisType</code> (e.g. <code>1</code> = 30/360, <code>2</code> = Actual/Actual).</td>\n</tr>\n<tr>\n<td><em>maxTellerDrawerOpenDays</em></td>\n<td>Required int 1-8. Max days a teller drawer may remain open.</td>\n</tr>\n<tr>\n<td><em>dsrBalanceType</em> / <em>dsrAgingType</em></td>\n<td>Required ints. Enums controlling Days Sales Receivable calculation.</td>\n</tr>\n<tr>\n<td><em>dsrIncludeAgingPeriod1</em> … <em>dsrIncludeAgingPeriod8</em></td>\n<td>Required bools. Whether the DSR calc includes each period.</td>\n</tr>\n<tr>\n<td><em>dsrAgingPeriod1MinDays</em> … <em>dsrAgingPeriod8MinDays</em> / <em>dsrAgingPeriod1MaxDays</em> … <em>dsrAgingPeriod7MaxDays</em></td>\n<td>Optional ints. Same pattern as the top-level aging periods but specific to DSR.</td>\n</tr>\n<tr>\n<td><em>paymentCouponsDocumentId</em></td>\n<td>Optional Guid. Document template used for payment coupons.</td>\n</tr>\n<tr>\n<td><em>noteGridSize</em></td>\n<td>Required int. Enum <code>GridSize</code>.</td>\n</tr>\n<tr>\n<td><em>notesGridPageSize</em> / <em>transactionGridPageSize</em></td>\n<td>Required ints. Enum <code>GridPageSize</code> (typical values 10, 25, 50).</td>\n</tr>\n<tr>\n<td><em>conversionGenericFollowUpTaskTemplateId</em></td>\n<td>Optional Guid. Task template used for conversion follow-ups.</td>\n</tr>\n<tr>\n<td><em>conversionSumOfOriginationsFeeCodeId</em> / <em>conversionSumOfOriginationsFinanceFeeCodeId</em> / <em>conversionTrackingProductCodeId</em></td>\n<td>Optional Guids. Conversion mapping defaults.</td>\n</tr>\n<tr>\n<td><em>defaultNewDirectAccountCashDisbursementFundsCodeId</em></td>\n<td>Optional Guid. Default funds code for new direct-account cash disbursements.</td>\n</tr>\n<tr>\n<td><em>defaultPayoffActionCodeId</em></td>\n<td>Optional Guid. Action code applied when an account pays off.</td>\n</tr>\n<tr>\n<td><em>maxDateChangeDays</em></td>\n<td>Optional int. Max days a due date may be moved.</td>\n</tr>\n<tr>\n<td><em>defaultGeneralLedgerAccounts</em></td>\n<td>Optional object. See <code>Get Configuration Default GL Accounts</code> for field-by-field descriptions of the 19 GL account Ids (Receivables, Loss Reserve, Loss Recoveries, Interest Receivables, Interest Earnings, Unearned/Earned Finance Charge, Unearned/Earned Discount, New Account Clearing, General Clearing, IVA Payment, Dealer Withhold, Dealer Reserve, Points, Acquisition, Unearned Points, Unearned Acquisition, Negative Dealer Reserve).</td>\n</tr>\n<tr>\n<td><em>defaultTransactionCodes</em></td>\n<td>Optional object. See <code>Get Configuration Default Transaction Codes</code> for the 11 conversion transaction code Ids (<code>openingConvCodeId</code>, <code>paymentConvCodeId</code>, <code>interestConvCodeId</code>, <code>lateFeeConvCodeId</code>, <code>nsfFeeConvCodeId</code>, <code>otherBalConvCodeId</code>, <code>extFeeConvCodeId</code>, <code>miscAdjConvCodeId</code>, <code>financeChargeConvCodeId</code>, <code>chargeOffConvCodeId</code>, <code>allOtherConvCodeId</code>).</td>\n</tr>\n<tr>\n<td><em>collectionsConfiguration</em></td>\n<td>Optional object. Collections module config: <code>agingType</code>, <code>assignMinimumDaysPastDue</code>, <code>assignMaximumDaysPastDue</code>, <code>assignCurrentAccounts</code>, <code>assignChargeOffAccounts</code>, <code>unassignedAccountCollectorId</code>, <code>balancePriorityInQueue</code>, <code>agePriorityInQueue</code>, <code>scorePriorityInQueue</code>, <code>queueCurrentAccounts</code>, <code>queueChargeOffAccounts</code>, <code>useCollectionsModule</code>, <code>collectorGoalAmountOption</code>, <code>assignNewAccounts</code>, <code>balanceType</code>, <code>queueMinimumDaysPastDue</code>, <code>queueMaximumDaysPastDue</code>, <code>defaultMaxMinutesPerCall</code>, <code>defaultMaxSecondsPerCall</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the Servicing external master configuration row (stable across create and update).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>newAccountOpeningTransactionCodeOrId</code></td>\n<td><code>newAccountOpeningTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>agedConvOpeningTransactionCodeOrId</code></td>\n<td><code>agedConvOpeningTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>interestPaymentTransactionCodeOrId</code></td>\n<td><code>interestPaymentTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>extensionFeeTransactionCodeOrId</code></td>\n<td><code>extensionFeeTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultActivatedAccountAdminStatusCodeOrId</code></td>\n<td><code>defaultActivatedAccountAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>nsfFeeTransactionCodeOrId</code></td>\n<td><code>nsfFeeTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>lateChargeTransactionCodeOrId</code></td>\n<td><code>lateChargeTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>chargeOffTransactionCodeOrId</code></td>\n<td><code>chargeOffTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>ivaFeeTransactionCodeOrId</code></td>\n<td><code>ivaFeeTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultChargeOffAdminStatusCodeOrId</code></td>\n<td><code>defaultChargeOffAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultWriteOffAdminStatusCodeOrId</code></td>\n<td><code>defaultWriteOffAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultPayoffAdminStatusCodeOrId</code></td>\n<td><code>defaultPayoffAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultBuyBackAdminStatusCodeOrId</code></td>\n<td><code>defaultBuyBackAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultUnwindAdminStatusCodeOrId</code></td>\n<td><code>defaultUnwindAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>discountAdjustmentTransactionCodeOrId</code></td>\n<td><code>discountAdjustmentTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>discountCreditOrDebitTransactionCodeOrId</code></td>\n<td><code>discountCreditOrDebitTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>financeChargeAdjustmentTransactionCodeOrId</code></td>\n<td><code>financeChargeAdjustmentTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>financeChargeRebateTransactionCodeOrId</code></td>\n<td><code>financeChargeRebateTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>conversionLateFeeTransactionCodeOrId</code></td>\n<td><code>conversionLateFeeTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>conversionOtherFeeTransactionCodeOrId</code></td>\n<td><code>conversionOtherFeeTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>unwindTransactionCodeOrId</code></td>\n<td><code>unwindTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>reserveAdjustmentTransactionCodeOrId</code></td>\n<td><code>reserveAdjustmentTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>withholdAdjustmentTransactionCodeOrId</code></td>\n<td><code>withholdAdjustmentTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>pointsAdjustmentTransactionCodeOrId</code></td>\n<td><code>pointsAdjustmentTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>acquisitionFeeAdjustmentTransactionCodeOrId</code></td>\n<td><code>acquisitionFeeAdjustmentTransactionCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>conversionGenericFollowUpTaskTemplateNumberOrId</code></td>\n<td><code>conversionGenericFollowUpTaskTemplateId</code></td>\n<td>String. task-template number or template GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>conversionSumOfOriginationsFeeCodeDescriptionOrId</code></td>\n<td><code>conversionSumOfOriginationsFeeCodeId</code></td>\n<td>String. origination-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>conversionSumOfOriginationsFinanceFeeCodeDescriptionOrId</code></td>\n<td><code>conversionSumOfOriginationsFinanceFeeCodeId</code></td>\n<td>String. origination finance-fee description or finance-fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>conversionTrackingProductCodeOrId</code></td>\n<td><code>conversionTrackingProductCodeId</code></td>\n<td>String. customer-tracking insurance product code or matching product GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultNewDirectAccountCashDisbursementFundsCodeDescriptionOrId</code></td>\n<td><code>defaultNewDirectAccountCashDisbursementFundsCodeId</code></td>\n<td>String. funds-code description or funds-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultPayoffActionCodeOrId</code></td>\n<td><code>defaultPayoffActionCodeId</code></td>\n<td>String. action code or action-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.receivablesAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.receivablesAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.lossReserveAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.lossReserveAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.lossRecoveriesAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.lossRecoveriesAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.interestReceivablesAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.interestReceivablesAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.interestEarningsAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.interestEarningsAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.unearnedFinanceChargeAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.unearnedFinanceChargeAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.earnedFinanceChargeAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.earnedFinanceChargeAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.unearnedDiscountAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.unearnedDiscountAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.earnedDiscountAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.earnedDiscountAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.newAccountClearingAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.newAccountClearingAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.generalClearingAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.generalClearingAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.ivaPaymentAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.ivaPaymentAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.dealerWithholdAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.dealerWithholdAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.dealerReserveAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.dealerReserveAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.pointsAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.pointsAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.acquisitionAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.acquisitionAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.unearnedPointsAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.unearnedPointsAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.unearnedAcquisitionAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.unearnedAcquisitionAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultGeneralLedgerAccounts.negativeDealerReserveAccountNumberOrId</code></td>\n<td><code>defaultGeneralLedgerAccounts.negativeDealerReserveAccountId</code></td>\n<td>String. chart-account number or GL chart-row GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.openingConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.openingConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.paymentConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.paymentConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.interestConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.interestConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.lateFeeConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.lateFeeConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.nsfFeeConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.nsfFeeConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.otherBalConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.otherBalConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.extFeeConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.extFeeConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.miscAdjConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.miscAdjConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.financeChargeConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.financeChargeConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.chargeOffConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.chargeOffConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTransactionCodes.allOtherConvCodeOrId</code></td>\n<td><code>defaultTransactionCodes.allOtherConvCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>collectionsConfiguration.unassignedAccountCollectorLoginOrId</code></td>\n<td><code>collectionsConfiguration.unassignedAccountCollectorId</code></td>\n<td>String. associated user login or collector GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"newAccountOpeningTransactionCodeOrId\": \"PYC\",\n  \"agedConvOpeningTransactionCodeOrId\": \"PYC\",\n  \"interestPaymentTransactionCodeOrId\": \"PYC\",\n  \"extensionFeeTransactionCodeOrId\": \"PYC\",\n  \"defaultActivatedAccountAdminStatusCodeOrId\": \"ACTIVE\",\n  \"nsfFeeTransactionCodeOrId\": \"PYC\",\n  \"lateChargeTransactionCodeOrId\": \"PYC\",\n  \"chargeOffTransactionCodeOrId\": \"PYC\",\n  \"ivaFeeTransactionCodeOrId\": \"PYC\",\n  \"defaultChargeOffAdminStatusCodeOrId\": \"ACTIVE\",\n  \"defaultWriteOffAdminStatusCodeOrId\": \"ACTIVE\",\n  \"defaultPayoffAdminStatusCodeOrId\": \"ACTIVE\",\n  \"defaultBuyBackAdminStatusCodeOrId\": \"ACTIVE\",\n  \"defaultUnwindAdminStatusCodeOrId\": \"ACTIVE\",\n  \"discountAdjustmentTransactionCodeOrId\": \"PYC\",\n  \"discountCreditOrDebitTransactionCodeOrId\": \"PYC\",\n  \"financeChargeAdjustmentTransactionCodeOrId\": \"PYC\",\n  \"financeChargeRebateTransactionCodeOrId\": \"PYC\",\n  \"conversionLateFeeTransactionCodeOrId\": \"PYC\",\n  \"conversionOtherFeeTransactionCodeOrId\": \"PYC\",\n  \"unwindTransactionCodeOrId\": \"PYC\",\n  \"reserveAdjustmentTransactionCodeOrId\": \"PYC\",\n  \"withholdAdjustmentTransactionCodeOrId\": \"PYC\",\n  \"pointsAdjustmentTransactionCodeOrId\": \"PYC\",\n  \"acquisitionFeeAdjustmentTransactionCodeOrId\": \"PYC\",\n  \"conversionGenericFollowUpTaskTemplateNumberOrId\": \"1\",\n  \"conversionSumOfOriginationsFeeCodeDescriptionOrId\": \"Origination Fee\",\n  \"conversionSumOfOriginationsFinanceFeeCodeDescriptionOrId\": \"Finance Fee\",\n  \"conversionTrackingProductCodeOrId\": \"CPPI\",\n  \"defaultNewDirectAccountCashDisbursementFundsCodeDescriptionOrId\": \"Check\",\n  \"defaultPayoffActionCodeOrId\": \"CALL\",\n  \"defaultGeneralLedgerAccounts\": {\n    \"receivablesAccountNumberOrId\": \"1000-90\",\n    \"lossReserveAccountNumberOrId\": \"1000-90\",\n    \"lossRecoveriesAccountNumberOrId\": \"1000-90\",\n    \"interestReceivablesAccountNumberOrId\": \"1000-90\",\n    \"interestEarningsAccountNumberOrId\": \"1000-90\",\n    \"unearnedFinanceChargeAccountNumberOrId\": \"1000-90\",\n    \"earnedFinanceChargeAccountNumberOrId\": \"1000-90\",\n    \"unearnedDiscountAccountNumberOrId\": \"1000-90\",\n    \"earnedDiscountAccountNumberOrId\": \"1000-90\",\n    \"newAccountClearingAccountNumberOrId\": \"1000-90\",\n    \"generalClearingAccountNumberOrId\": \"1000-90\",\n    \"ivaPaymentAccountNumberOrId\": \"1000-90\",\n    \"dealerWithholdAccountNumberOrId\": \"1000-90\",\n    \"dealerReserveAccountNumberOrId\": \"1000-90\",\n    \"pointsAccountNumberOrId\": \"1000-90\",\n    \"acquisitionAccountNumberOrId\": \"1000-90\",\n    \"unearnedPointsAccountNumberOrId\": \"1000-90\",\n    \"unearnedAcquisitionAccountNumberOrId\": \"1000-90\",\n    \"negativeDealerReserveAccountNumberOrId\": \"1000-90\"\n  },\n  \"defaultTransactionCodes\": {\n    \"openingConvCodeOrId\": \"PYC\",\n    \"paymentConvCodeOrId\": \"PYC\",\n    \"interestConvCodeOrId\": \"PYC\",\n    \"lateFeeConvCodeOrId\": \"PYC\",\n    \"nsfFeeConvCodeOrId\": \"PYC\",\n    \"otherBalConvCodeOrId\": \"PYC\",\n    \"extFeeConvCodeOrId\": \"PYC\",\n    \"miscAdjConvCodeOrId\": \"PYC\",\n    \"financeChargeConvCodeOrId\": \"PYC\",\n    \"chargeOffConvCodeOrId\": \"PYC\",\n    \"allOtherConvCodeOrId\": \"PYC\"\n  },\n  \"collectionsConfiguration\": {\n    \"unassignedAccountCollectorLoginOrId\": \"collector.login\"\n  }\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Configuration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"891ad1c7-c6ac-4e18-851e-0ca67c23300c","name":"UpdateExternalMasterConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"newAccountOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"agedConvOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012346\",\n  \"interestPaymentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012347\",\n  \"extensionFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012348\",\n  \"defaultActivatedAccountAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"nsfFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012349\",\n  \"lateChargeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234a\",\n  \"chargeOffTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234b\",\n  \"defaultChargeOffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012346\",\n  \"defaultPayoffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012347\",\n  \"defaultBuyBackAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012348\",\n  \"defaultUnwindAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012349\",\n  \"discountAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012350\",\n  \"discountCreditOrDebitTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012351\",\n  \"financeChargeAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012352\",\n  \"financeChargeRebateTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012353\",\n  \"conversionLateFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012354\",\n  \"conversionOtherFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012355\",\n  \"unwindTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012356\",\n  \"reserveAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012357\",\n  \"withholdAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012358\",\n  \"pointsAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012359\",\n  \"acquisitionFeeAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01235a\",\n  \"agingPeriod1MinDays\": 0,\n  \"agingPeriod1MaxDays\": 9,\n  \"agingPeriod2MinDays\": 10,\n  \"agingPeriod2MaxDays\": 29,\n  \"agingPeriod3MinDays\": 30,\n  \"agingPeriod3MaxDays\": 59,\n  \"agingPeriod4MinDays\": 60,\n  \"agingPeriod4MaxDays\": 89,\n  \"agingPeriod5MinDays\": 90,\n  \"agingPeriod5MaxDays\": 119,\n  \"agingPeriod6MinDays\": 120,\n  \"agingPeriod6MaxDays\": 149,\n  \"agingPeriod7MinDays\": 150,\n  \"agingPeriod7MaxDays\": 179,\n  \"agingPeriod8MinDays\": 180,\n  \"accrualBasis\": 1,\n  \"maxTellerDrawerOpenDays\": 3,\n  \"dsrBalanceType\": 1,\n  \"dsrAgingType\": 1,\n  \"dsrIncludeAgingPeriod1\": false,\n  \"dsrIncludeAgingPeriod2\": true,\n  \"dsrIncludeAgingPeriod3\": true,\n  \"dsrIncludeAgingPeriod4\": true,\n  \"dsrIncludeAgingPeriod5\": true,\n  \"dsrIncludeAgingPeriod6\": true,\n  \"dsrIncludeAgingPeriod7\": true,\n  \"dsrIncludeAgingPeriod8\": true,\n  \"noteGridSize\": 1,\n  \"notesGridPageSize\": 25,\n  \"transactionGridPageSize\": 25,\n  \"newAccountOpeningTransactionCodeOrId\": null,\n  \"agedConvOpeningTransactionCodeOrId\": null,\n  \"interestPaymentTransactionCodeOrId\": null,\n  \"extensionFeeTransactionCodeOrId\": null,\n  \"defaultActivatedAccountAdminStatusCodeOrId\": null,\n  \"nsfFeeTransactionCodeOrId\": null,\n  \"lateChargeTransactionCodeOrId\": null,\n  \"chargeOffTransactionCodeOrId\": null,\n  \"ivaFeeTransactionCodeOrId\": null,\n  \"defaultChargeOffAdminStatusCodeOrId\": null,\n  \"defaultWriteOffAdminStatusCodeOrId\": null,\n  \"defaultPayoffAdminStatusCodeOrId\": null,\n  \"defaultBuyBackAdminStatusCodeOrId\": null,\n  \"defaultUnwindAdminStatusCodeOrId\": null,\n  \"discountAdjustmentTransactionCodeOrId\": null,\n  \"discountCreditOrDebitTransactionCodeOrId\": null,\n  \"financeChargeAdjustmentTransactionCodeOrId\": null,\n  \"financeChargeRebateTransactionCodeOrId\": null,\n  \"conversionLateFeeTransactionCodeOrId\": null,\n  \"conversionOtherFeeTransactionCodeOrId\": null,\n  \"unwindTransactionCodeOrId\": null,\n  \"reserveAdjustmentTransactionCodeOrId\": null,\n  \"withholdAdjustmentTransactionCodeOrId\": null,\n  \"pointsAdjustmentTransactionCodeOrId\": null,\n  \"acquisitionFeeAdjustmentTransactionCodeOrId\": null,\n  \"conversionGenericFollowUpTaskTemplateNumberOrId\": null,\n  \"conversionSumOfOriginationsFeeCodeDescriptionOrId\": null,\n  \"conversionSumOfOriginationsFinanceFeeCodeDescriptionOrId\": null,\n  \"conversionTrackingProductCodeOrId\": null,\n  \"defaultNewDirectAccountCashDisbursementFundsCodeDescriptionOrId\": null,\n  \"defaultPayoffActionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"ecbc5083-0c08-4ae2-91c4-c2f7f600fd57","name":"UpdateExternalMasterConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"newAccountOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"agedConvOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012346\",\n  \"interestPaymentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012347\",\n  \"extensionFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012348\",\n  \"defaultActivatedAccountAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"nsfFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012349\",\n  \"lateChargeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234a\",\n  \"chargeOffTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234b\",\n  \"defaultChargeOffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012346\",\n  \"defaultPayoffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012347\",\n  \"defaultBuyBackAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012348\",\n  \"defaultUnwindAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012349\",\n  \"discountAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012350\",\n  \"discountCreditOrDebitTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012351\",\n  \"financeChargeAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012352\",\n  \"financeChargeRebateTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012353\",\n  \"conversionLateFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012354\",\n  \"conversionOtherFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012355\",\n  \"unwindTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012356\",\n  \"reserveAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012357\",\n  \"withholdAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012358\",\n  \"pointsAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012359\",\n  \"acquisitionFeeAdjustmentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01235a\",\n  \"agingPeriod1MinDays\": 0,\n  \"agingPeriod1MaxDays\": 9,\n  \"agingPeriod2MinDays\": 10,\n  \"agingPeriod2MaxDays\": 29,\n  \"agingPeriod3MinDays\": 30,\n  \"agingPeriod3MaxDays\": 59,\n  \"agingPeriod4MinDays\": 60,\n  \"agingPeriod4MaxDays\": 89,\n  \"agingPeriod5MinDays\": 90,\n  \"agingPeriod5MaxDays\": 119,\n  \"agingPeriod6MinDays\": 120,\n  \"agingPeriod6MaxDays\": 149,\n  \"agingPeriod7MinDays\": 150,\n  \"agingPeriod7MaxDays\": 179,\n  \"agingPeriod8MinDays\": 180,\n  \"accrualBasis\": 1,\n  \"maxTellerDrawerOpenDays\": 99,\n  \"dsrBalanceType\": 1,\n  \"dsrAgingType\": 1,\n  \"dsrIncludeAgingPeriod1\": false,\n  \"dsrIncludeAgingPeriod2\": true,\n  \"dsrIncludeAgingPeriod3\": true,\n  \"dsrIncludeAgingPeriod4\": true,\n  \"dsrIncludeAgingPeriod5\": true,\n  \"dsrIncludeAgingPeriod6\": true,\n  \"dsrIncludeAgingPeriod7\": true,\n  \"dsrIncludeAgingPeriod8\": true,\n  \"noteGridSize\": 1,\n  \"notesGridPageSize\": 25,\n  \"transactionGridPageSize\": 25,\n  \"newAccountOpeningTransactionCodeOrId\": null,\n  \"agedConvOpeningTransactionCodeOrId\": null,\n  \"interestPaymentTransactionCodeOrId\": null,\n  \"extensionFeeTransactionCodeOrId\": null,\n  \"defaultActivatedAccountAdminStatusCodeOrId\": null,\n  \"nsfFeeTransactionCodeOrId\": null,\n  \"lateChargeTransactionCodeOrId\": null,\n  \"chargeOffTransactionCodeOrId\": null,\n  \"ivaFeeTransactionCodeOrId\": null,\n  \"defaultChargeOffAdminStatusCodeOrId\": null,\n  \"defaultWriteOffAdminStatusCodeOrId\": null,\n  \"defaultPayoffAdminStatusCodeOrId\": null,\n  \"defaultBuyBackAdminStatusCodeOrId\": null,\n  \"defaultUnwindAdminStatusCodeOrId\": null,\n  \"discountAdjustmentTransactionCodeOrId\": null,\n  \"discountCreditOrDebitTransactionCodeOrId\": null,\n  \"financeChargeAdjustmentTransactionCodeOrId\": null,\n  \"financeChargeRebateTransactionCodeOrId\": null,\n  \"conversionLateFeeTransactionCodeOrId\": null,\n  \"conversionOtherFeeTransactionCodeOrId\": null,\n  \"unwindTransactionCodeOrId\": null,\n  \"reserveAdjustmentTransactionCodeOrId\": null,\n  \"withholdAdjustmentTransactionCodeOrId\": null,\n  \"pointsAdjustmentTransactionCodeOrId\": null,\n  \"acquisitionFeeAdjustmentTransactionCodeOrId\": null,\n  \"conversionGenericFollowUpTaskTemplateNumberOrId\": null,\n  \"conversionSumOfOriginationsFeeCodeDescriptionOrId\": null,\n  \"conversionSumOfOriginationsFinanceFeeCodeDescriptionOrId\": null,\n  \"conversionTrackingProductCodeOrId\": null,\n  \"defaultNewDirectAccountCashDisbursementFundsCodeDescriptionOrId\": null,\n  \"defaultPayoffActionCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Configuration"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Max teller drawer open days must be between 1 and 8\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"2853fcf3-59ba-4693-9b41-a9c3b89ab2b5"},{"name":"ExternalMasterConfiguration","id":"bb614914-77de-4646-8901-695e14b8a254","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Configuration?token={{token}}","description":"<h3 id=\"get-servicing-external-master-configuration\">Get Servicing External Master Configuration</h3>\n<p>Returns the single Servicing master configuration row for the current client. Delegates to <code>ExternalMasterConfigurationWSServices.ReturnExternalMasterConfigurationWS</code> which calls <code>GeneralLedgerExternalMasterConfigurationServices.ReturnExternalMasterConfiguration</code> (shared entity used by both GL and Servicing configuration). The same row is read by <code>GET api/Client/GeneralLedger/ExternalMasterConfiguration</code> — the Servicing-specific fields live on <code>Servicing.ExternalMasterConfiguration</code> while the GL-specific fields live on <code>GeneralLedger.ExternalMasterConfiguration</code>. If no row exists the controller returns HTTP 400 with <code>External master configuration not found</code> and PUT must be called to create it.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Configuration</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token. May also be supplied as a <code>SessionId</code> header, signed API headers, or body <code>{ \"token\": \"...\" }</code> for compatibility.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the full Servicing <code>MyServicingExternalMasterConfigurationEntity</code> — aging period min/max day ranges (periods 1-8), DSR aging configuration (<code>DsrBalanceType</code>, <code>DsrAgingType</code>, <code>DsrIncludeAgingPeriod1..8</code>), transaction code Ids (NewAccountOpening, AgedConvOpening, InterestPayment, ExtensionFee, NsfFee, LateCharge, ChargeOff, IvaFee, DiscountAdjustment, DiscountCreditOrDebit, FinanceChargeAdjustment, FinanceChargeRebate, ConversionLateFee, ConversionOtherFee, Unwind, ReserveAdjustment, WithholdAdjustment, PointsAdjustment, AcquisitionFeeAdjustment), admin status Ids (DefaultActivatedAccount, DefaultChargeOff, DefaultPayoff, DefaultBuyBack, DefaultUnwind), grid sizes (<code>NoteGridSize</code>, <code>NotesGridPageSize</code>, <code>TransactionGridPageSize</code>), conversion linkage (<code>ConversionGenericFollowUpTaskTemplateId</code>, <code>ConversionSumOfOriginationsFeeCodeId</code>, <code>ConversionSumOfOriginationsFinanceFeeCodeId</code>, <code>ConversionTrackingProductCodeId</code>), plus <code>AccrualBasis</code>, <code>MaxTellerDrawerOpenDays</code>, <code>PaymentCouponsDocumentId</code>, <code>DefaultNewDirectAccountCashDisbursementFundsCodeId</code>, <code>DefaultPayoffActionCodeId</code>, <code>MaxDateChangeDays</code>, and the concurrency token <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Configuration"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ba3e62e5-e95d-472b-80e4-201992779696","name":"GetExternalMasterConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"OmegaClientId\": \"00000000-0000-0000-0000-000000000001\",\n        \"NewAccountOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"AgedConvOpeningTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012346\",\n        \"InterestPaymentTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012347\",\n        \"ExtensionFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012348\",\n        \"DefaultActivatedAccountAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"NsfFeeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef012349\",\n        \"LateChargeTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234a\",\n        \"ChargeOffTransactionCodeId\": \"a1b2c3d4-1111-4222-9333-abcdef01234b\",\n        \"IvaFeeTransactionCodeId\": null,\n        \"DefaultChargeOffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012346\",\n        \"DefaultPayoffAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012347\",\n        \"DefaultBuyBackAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012348\",\n        \"DefaultUnwindAdminStatusId\": \"b1b2c3d4-1111-4222-9333-abcdef012349\",\n        \"AccrualBasis\": 1,\n        \"MaxTellerDrawerOpenDays\": 3,\n        \"AgingPeriod1MinDays\": 0,\n        \"AgingPeriod1MaxDays\": 9,\n        \"AgingPeriod2MinDays\": 10,\n        \"AgingPeriod2MaxDays\": 29,\n        \"AgingPeriod3MinDays\": 30,\n        \"AgingPeriod3MaxDays\": 59,\n        \"AgingPeriod4MinDays\": 60,\n        \"AgingPeriod4MaxDays\": 89,\n        \"AgingPeriod5MinDays\": 90,\n        \"AgingPeriod5MaxDays\": 119,\n        \"AgingPeriod6MinDays\": 120,\n        \"AgingPeriod6MaxDays\": 149,\n        \"AgingPeriod7MinDays\": 150,\n        \"AgingPeriod7MaxDays\": 179,\n        \"AgingPeriod8MinDays\": 180,\n        \"DsrBalanceType\": 1,\n        \"DsrAgingType\": 1,\n        \"DsrIncludeAgingPeriod1\": false,\n        \"DsrIncludeAgingPeriod2\": true,\n        \"DsrIncludeAgingPeriod3\": true,\n        \"DsrIncludeAgingPeriod4\": true,\n        \"DsrIncludeAgingPeriod5\": true,\n        \"DsrIncludeAgingPeriod6\": true,\n        \"DsrIncludeAgingPeriod7\": true,\n        \"DsrIncludeAgingPeriod8\": true,\n        \"NoteGridSize\": 1,\n        \"NotesGridPageSize\": 25,\n        \"TransactionGridPageSize\": 25,\n        \"PaymentCouponsDocumentId\": null,\n        \"ConversionGenericFollowUpTaskTemplateId\": null,\n        \"ConversionSumOfOriginationsFeeCodeId\": null,\n        \"ConversionSumOfOriginationsFinanceFeeCodeId\": null,\n        \"ConversionTrackingProductCodeId\": null,\n        \"DefaultNewDirectAccountCashDisbursementFundsCodeId\": null,\n        \"DefaultPayoffActionCodeId\": null,\n        \"MaxDateChangeDays\": null,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": []\n}"},{"id":"cca85a87-121d-4b17-acfd-7be15be61b26","name":"GetExternalMasterConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Configuration?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Configuration"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Servicing module configuration not found\"\n    ]\n}"}],"_postman_id":"bb614914-77de-4646-8901-695e14b8a254"},{"name":"FundsCodeAdd","id":"8f910615-3caa-4bde-b8e0-0e66c42d3d91","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Checking Account\",\n    \"available\": true,\n    \"fundsType\": \"Cash\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/FundsCode","description":"<h3 id=\"add-servicing-funds-code\">Add Servicing Funds Code</h3>\n<p>Creates a new funds code for the current client. Delegates to <code>FundsCodeWSServices.AddSaveFundsCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another funds code with the same <code>description</code> already exists for the client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/FundsCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique funds description.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the funds code is available for selection.</td>\n</tr>\n<tr>\n<td><em>fundsType</em></td>\n<td>Required enum. <code>Omega.Servicing.Types.Enums.FundsType</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new funds code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","FundsCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5a1b21d2-c28d-4b3d-8680-b5d8637d70d3","name":"AddFundsCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Checking Account\",\n    \"available\": true,\n    \"fundsType\": \"Cash\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/FundsCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e22b39f0-ac2f-4236-b1da-58b967cb5c87","name":"AddFundsCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Checking Account\",\n    \"available\": true,\n    \"fundsType\": \"Cash\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/FundsCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A funds code with this description already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"8f910615-3caa-4bde-b8e0-0e66c42d3d91"},{"name":"FundsCodeByDescriptionGet","id":"9c3922b0-8635-4300-a322-3c1e9e038d47","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/FundsCode/GetByDescription/{{funds_description}}?token={{token}}","description":"<h3 id=\"get-servicing-funds-code-by-description\">Get Servicing Funds Code By Description</h3>\n<p>Helper route that returns a single funds code matched by its description. Delegates to <code>FundsCodeWSServices.GetFundsCodeByDescription</code>, which calls <code>FundsCodeServices.ReturnFundsCodeByString</code> and then <code>ReturnFundsCode</code>. Unlike <code>GET /FundsCode/{descriptionOrId}</code>, this route accepts only the description (not a Guid) and is useful when the caller is certain the path segment is a description string.</p>\n<p>Returns <code>\"Funds code not found\"</code> when the description does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/FundsCode/GetByDescription/{description}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Required string. <code>Servicing.FundsCode.Description</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingFundsCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Available</code>, <code>FundsType</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","FundsCode","GetByDescription","{{funds_description}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e62bdb73-5dac-4507-8268-9d61141dcde0","name":"GetFundsCodeByDescription - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode/GetByDescription/{{funds_description}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode","GetByDescription","{{funds_description}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-1111-4222-9333-abcdef012345\",\n        \"Description\": \"Checking Account\",\n        \"Available\": true,\n        \"FundsType\": \"Cash\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"0ef326e3-1c05-4fce-bc23-c36c687b240e","name":"GetFundsCodeByDescription - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode/GetByDescription/{{funds_description}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode","GetByDescription","{{funds_description}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Funds code not found\"\n    ]\n}"}],"_postman_id":"9c3922b0-8635-4300-a322-3c1e9e038d47"},{"name":"FundsCodeGet","id":"fe5663aa-ad6d-4198-b9f2-d6f8a52d7163","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/FundsCode/{{funds_description_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-funds-code\">Get Servicing Funds Code</h3>\n<p>Returns a single funds code resolved by Guid or description. Delegates to <code>FundsCodeWSServices.ReturnFundsCodeWS</code>, which first attempts <code>Guid.TryParse</code>; if that fails it calls <code>FundsCodeServices.ReturnFundsCodeByString</code> to resolve the client-scoped description, then fetches the record via <code>FundsCodeServices.ReturnFundsCode</code>.</p>\n<p>Returns <code>\"Funds code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/FundsCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.FundsCode.Id</code> Guid or <code>Description</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingFundsCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Available</code>, <code>FundsType</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","FundsCode","{{funds_description_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"9f758d37-15b5-4642-b04b-46dede34b969","name":"GetFundsCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode/{{funds_description_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode","{{funds_description_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-1111-4222-9333-abcdef012345\",\n        \"Description\": \"Checking Account\",\n        \"Available\": true,\n        \"FundsType\": \"Cash\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"075f4472-5b8b-4aa9-91ef-6654aeb8d9e4","name":"GetFundsCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode/{{funds_description_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode","{{funds_description_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Funds code not found\"\n    ]\n}"}],"_postman_id":"fe5663aa-ad6d-4198-b9f2-d6f8a52d7163"},{"name":"FundsCodesGetAll","id":"9e9bd192-42a5-4ef5-a321-6f95d3487884","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/FundsCode?token={{token}}","description":"<h3 id=\"get-all-servicing-funds-codes\">Get All Servicing Funds Codes</h3>\n<p>Returns every funds code for the current client. Delegates to <code>FundsCodeWSServices.ReturnClientFundsCodesWS</code>, which reads all rows from <code>Servicing.FundsCode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/FundsCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingFundsCodeEntity</code> records with <code>Id</code>, <code>Description</code>, <code>Available</code>, <code>FundsType</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","FundsCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fe6480bc-6f2e-4a8f-b7a1-222c8a0a79ff","name":"GetAllFundsCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"c1d2e3f4-1111-4222-9333-abcdef012345\",\n            \"Description\": \"Checking Account\",\n            \"Available\": true,\n            \"FundsType\": \"Cash\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        },\n        {\n            \"Id\": \"d2e3f4a5-2222-4333-9444-bcdef0123456\",\n            \"Description\": \"Trust Account\",\n            \"Available\": true,\n            \"FundsType\": \"Trust\",\n            \"Ts\": \"AAAAAAAAB9Q=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"94da83f0-5745-4826-993e-1a2729d320af","name":"GetAllFundsCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/FundsCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","FundsCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving funds codes: authentication token is invalid or expired\"\n    ]\n}"}],"_postman_id":"9e9bd192-42a5-4ef5-a321-6f95d3487884"},{"name":"FundsCodeUpdate","id":"b873f966-ccb3-40f7-849a-67c7b4cdadb2","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Checking Account\",\n    \"available\": true,\n    \"fundsType\": \"Cash\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/FundsCode/{{funds_description_or_id}}","description":"<h3 id=\"update-servicing-funds-code\">Update Servicing Funds Code</h3>\n<p>Updates an existing funds code, resolved by Guid or description. The controller first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it calls <code>FundsCodeServices.ReturnFundsCodeByString</code> to resolve the client-scoped description. Returns <code>\"Funds code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>FundsCodeWSServices.AddSaveFundsCodeWS</code> with the resolved <code>id</code> and the row's current <code>Ts</code> preserved for concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/FundsCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.FundsCode.Id</code> Guid or <code>Description</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique funds description.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the funds code is available for selection.</td>\n</tr>\n<tr>\n<td><em>fundsType</em></td>\n<td>Required enum. <code>Omega.Servicing.Types.Enums.FundsType</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated funds code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","FundsCode","{{funds_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"297a1d7a-c657-49dd-99a1-219654d33c34","name":"UpdateFundsCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Checking Account\",\n    \"available\": true,\n    \"fundsType\": \"Cash\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/FundsCode/{{funds_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"7cdbb14c-b0dd-4aad-a64e-db05f1cdf172","name":"UpdateFundsCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Checking Account\",\n    \"available\": true,\n    \"fundsType\": \"Cash\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/FundsCode/{{funds_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Funds code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"b873f966-ccb3-40f7-849a-67c7b4cdadb2"},{"name":"ImportAccountConfigurationAdd","id":"c9a253e6-19ef-4672-a33e-de5d6190083c","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"importSpecification\": \"NEW_ACCT_STD\",\n  \"active\": true,\n  \"type\": 1,\n  \"format\": 1,\n  \"importMethod\": 1,\n  \"notificationEmail\": \"imports@example.com\",\n  \"defaultBranchId\": \"f1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultClassId\": \"f1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"defaultAdminStatusId\": \"f1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"defaultNoteActionCodeId\": null,\n  \"defaultAdvanceAdjustmentFeeId\": null,\n  \"defaultOriginationFeeId\": null,\n  \"defaultOriginationFinanceFeeId\": null,\n  \"defaultTitleStatusCodeId\": null,\n  \"defaultLanguageCode\": 1,\n  \"disbursementOption\": 1,\n  \"autoActivate\": false,\n  \"importInsuredType\": null,\n  \"defaultBranchNumberOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"defaultAdminStatusCodeOrId\": null,\n  \"defaultNoteActionCodeOrId\": null,\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": null,\n  \"defaultOriginationFeeDescriptionOrId\": null,\n  \"defaultOriginationFinanceFeeDescriptionOrId\": null,\n  \"defaultTitleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration","description":"<h3 id=\"add-servicing-import-account-configuration\">Add Servicing Import Account Configuration</h3>\n<p>Creates a new Import Account configuration. Delegates to <code>ImportAccountConfigurationWSServices.AddSaveWS</code> with <code>id=null</code> and <code>ts=null</code>. Validation rules:</p>\n<ul>\n<li><code>importSpecification</code> required, max 50 characters, must be unique per\nclient.</li>\n<li><code>notificationEmail</code> required and must pass <code>IsValidEmail</code>. - <code>type</code>, <code>format</code>, <code>importMethod</code>, <code>disbursementOption</code>, and\n<code>defaultLanguageCode</code> must be valid enum values.</li>\n<li><code>defaultBranchId</code> and <code>defaultAdminStatusId</code> must resolve to existing\nactive records.</li>\n<li>When <code>type=New_Account</code>, <code>defaultClassId</code> is required. - When <code>importMethod=Customer_Loan_Application</code>, <code>defaultNoteActionCodeId</code>\nis required.</li>\n<li>When <code>format</code> is a legacy insurance format, <code>importInsuredType</code> is\nrequired.</li>\n</ul>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>importSpecification</em></td>\n<td>Required string, max 50 characters. Unique per client.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>type</em></td>\n<td>Required int enum <code>ServicingImportAccountType</code> (e.g. <code>New_Account=1</code>, <code>Update_Account=2</code>, <code>New_Insurance=3</code>, etc.).</td>\n</tr>\n<tr>\n<td><em>format</em></td>\n<td>Required int enum <code>ServicingImportAccountFormat</code> (delimited, positional, or vendor-specific).</td>\n</tr>\n<tr>\n<td><em>importMethod</em></td>\n<td>Required int enum <code>ServicingImportAccountMethod</code>.</td>\n</tr>\n<tr>\n<td><em>notificationEmail</em></td>\n<td>Required string. Must be a valid email address.</td>\n</tr>\n<tr>\n<td><em>defaultBranchId</em></td>\n<td>Required Guid. <code>Setup.Branch</code> Id.</td>\n</tr>\n<tr>\n<td><em>defaultClassId</em></td>\n<td>Optional Guid; required when <code>type=New_Account</code>.</td>\n</tr>\n<tr>\n<td><em>defaultAdminStatusId</em></td>\n<td>Required Guid. <code>Servicing.AdminStatus</code> Id.</td>\n</tr>\n<tr>\n<td><em>defaultNoteActionCodeId</em></td>\n<td>Optional Guid; required when <code>importMethod=Customer_Loan_Application</code>.</td>\n</tr>\n<tr>\n<td><em>defaultAdvanceAdjustmentFeeId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>defaultOriginationFeeId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>defaultOriginationFinanceFeeId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>defaultTitleStatusCodeId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>defaultLanguageCode</em></td>\n<td>Required int enum <code>LanguageCode</code>.</td>\n</tr>\n<tr>\n<td><em>disbursementOption</em></td>\n<td>Required int enum <code>ServicingImportDisbursementOption</code>.</td>\n</tr>\n<tr>\n<td><em>autoActivate</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>importInsuredType</em></td>\n<td>Optional int; required for legacy insurance formats.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new import account configuration.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>defaultBranchNumberOrId</code></td>\n<td><code>defaultBranchId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultClassNumberOrId</code></td>\n<td><code>defaultClassId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultAdminStatusCodeOrId</code></td>\n<td><code>defaultAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultNoteActionCodeOrId</code></td>\n<td><code>defaultNoteActionCodeId</code></td>\n<td>String. action code or action-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultAdvanceAdjustmentFeeDescriptionOrId</code></td>\n<td><code>defaultAdvanceAdjustmentFeeId</code></td>\n<td>String. advance/adjustment-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOriginationFeeDescriptionOrId</code></td>\n<td><code>defaultOriginationFeeId</code></td>\n<td>String. origination-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOriginationFinanceFeeDescriptionOrId</code></td>\n<td><code>defaultOriginationFinanceFeeId</code></td>\n<td>String. origination finance-fee description or finance-fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTitleStatusCodeOrId</code></td>\n<td><code>defaultTitleStatusCodeId</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"defaultBranchNumberOrId\": \"90\",\n  \"defaultClassNumberOrId\": \"1\",\n  \"defaultAdminStatusCodeOrId\": \"ACTIVE\",\n  \"defaultNoteActionCodeOrId\": \"CALL\",\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": \"Advance Fee\",\n  \"defaultOriginationFeeDescriptionOrId\": \"Origination Fee\",\n  \"defaultOriginationFinanceFeeDescriptionOrId\": \"Finance Fee\",\n  \"defaultTitleStatusCodeOrId\": \"1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ImportAccountConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3ffdb1c1-ee31-4b07-b88c-0d23a87f9a7e","name":"AddImportAccountConfiguration - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"importSpecification\": \"NEW_ACCT_STD\",\n  \"active\": true,\n  \"type\": 1,\n  \"format\": 1,\n  \"importMethod\": 1,\n  \"notificationEmail\": \"imports@example.com\",\n  \"defaultBranchId\": \"f1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultClassId\": \"f1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"defaultAdminStatusId\": \"f1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"defaultNoteActionCodeId\": null,\n  \"defaultAdvanceAdjustmentFeeId\": null,\n  \"defaultOriginationFeeId\": null,\n  \"defaultOriginationFinanceFeeId\": null,\n  \"defaultTitleStatusCodeId\": null,\n  \"defaultLanguageCode\": 1,\n  \"disbursementOption\": 1,\n  \"autoActivate\": false,\n  \"importInsuredType\": null,\n  \"defaultBranchNumberOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"defaultAdminStatusCodeOrId\": null,\n  \"defaultNoteActionCodeOrId\": null,\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": null,\n  \"defaultOriginationFeeDescriptionOrId\": null,\n  \"defaultOriginationFinanceFeeDescriptionOrId\": null,\n  \"defaultTitleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"b2a73fc4-b822-497c-9684-b9f3a21282cb","name":"AddImportAccountConfiguration - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"importSpecification\": \"NEW_ACCT_STD\",\n  \"active\": true,\n  \"type\": 1,\n  \"format\": 1,\n  \"importMethod\": 1,\n  \"notificationEmail\": \"not-a-valid-email\",\n  \"defaultBranchId\": \"f1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultClassId\": \"f1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"defaultAdminStatusId\": \"f1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"defaultNoteActionCodeId\": null,\n  \"defaultAdvanceAdjustmentFeeId\": null,\n  \"defaultOriginationFeeId\": null,\n  \"defaultOriginationFinanceFeeId\": null,\n  \"defaultTitleStatusCodeId\": null,\n  \"defaultLanguageCode\": 1,\n  \"disbursementOption\": 1,\n  \"autoActivate\": false,\n  \"importInsuredType\": null,\n  \"defaultBranchNumberOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"defaultAdminStatusCodeOrId\": null,\n  \"defaultNoteActionCodeOrId\": null,\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": null,\n  \"defaultOriginationFeeDescriptionOrId\": null,\n  \"defaultOriginationFinanceFeeDescriptionOrId\": null,\n  \"defaultTitleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Notification email is not a valid email address\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"c9a253e6-19ef-4672-a33e-de5d6190083c"},{"name":"ImportAccountConfigurationGet","id":"b4f6fd5f-9140-4757-b18f-dc8559073d9f","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{{import_account_configuration_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-import-account-configuration\">Get Servicing Import Account Configuration</h3>\n<p>Returns a single Import Account configuration by either its Guid <code>Id</code> or client-scoped <code>ImportSpecification</code> (the user-facing code). Delegates to <code>ImportAccountConfigurationWSServices.ReturnWS</code> which resolves the Id via <code>SharedWSServices.GetServicingImportAccountConfigurationId</code> and calls <code>ImportAccountConfiguration.ReturnImportAccountConfiguration</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>ImportSpecification</code>. <code>BadRequest</code> with \"Import account configuration not found\" when the value cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>MyServicingImportAccountConfigurationEntity</code> projection including the scalar fields (<code>Id</code>, <code>ImportSpecification</code>, <code>Active</code>, <code>Type</code>, <code>Format</code>, <code>ImportMethod</code>, <code>NotificationEmail</code>, <code>DefaultBranchId</code>, <code>DefaultClassId</code>, <code>DefaultAdminStatusId</code>, <code>DefaultNoteActionCodeId</code>, <code>DefaultAdvanceAdjustmentFeeId</code>, <code>DefaultOriginationFeeId</code>, <code>DefaultOriginationFinanceFeeId</code>, <code>DefaultTitleStatusCodeId</code>, <code>DefaultLanguageCode</code>, <code>DisbursementOption</code>, <code>AutoActivate</code>, <code>ImportInsuredType</code>, <code>Ts</code>).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ImportAccountConfiguration","{{import_account_configuration_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"12caddc3-b858-4bac-88de-91b7dd646605","name":"GetImportAccountConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{{import_account_configuration_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","ImportAccountConfiguration","{{import_account_configuration_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"ImportSpecification\": \"NEW_ACCT_STD\",\n        \"Active\": true,\n        \"Type\": 1,\n        \"Format\": 1,\n        \"ImportMethod\": 1,\n        \"NotificationEmail\": \"imports@example.com\",\n        \"DefaultBranchId\": \"f1c2d3e4-1111-4222-9333-abcdef012346\",\n        \"DefaultClassId\": \"f1c2d3e4-1111-4222-9333-abcdef012347\",\n        \"DefaultAdminStatusId\": \"f1c2d3e4-1111-4222-9333-abcdef012348\",\n        \"DefaultNoteActionCodeId\": null,\n        \"DefaultAdvanceAdjustmentFeeId\": null,\n        \"DefaultOriginationFeeId\": null,\n        \"DefaultOriginationFinanceFeeId\": null,\n        \"DefaultTitleStatusCodeId\": null,\n        \"DefaultLanguageCode\": 1,\n        \"DisbursementOption\": 1,\n        \"AutoActivate\": false,\n        \"ImportInsuredType\": null,\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"a298dbe5-a710-4ee6-9858-78617e005438","name":"GetImportAccountConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{{import_account_configuration_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","ImportAccountConfiguration","{{import_account_configuration_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Import account configuration not found\"\n    ]\n}"}],"_postman_id":"b4f6fd5f-9140-4757-b18f-dc8559073d9f"},{"name":"ImportAccountConfigurationUpdate","id":"2c6aa7dc-1745-49ae-9771-358e6300b2ff","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"importSpecification\": \"NEW_ACCT_STD\",\n  \"active\": true,\n  \"type\": 1,\n  \"format\": 1,\n  \"importMethod\": 1,\n  \"notificationEmail\": \"imports-updated@example.com\",\n  \"defaultBranchId\": \"f1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultClassId\": \"f1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"defaultAdminStatusId\": \"f1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"defaultNoteActionCodeId\": null,\n  \"defaultAdvanceAdjustmentFeeId\": null,\n  \"defaultOriginationFeeId\": null,\n  \"defaultOriginationFinanceFeeId\": null,\n  \"defaultTitleStatusCodeId\": null,\n  \"defaultLanguageCode\": 1,\n  \"disbursementOption\": 1,\n  \"autoActivate\": true,\n  \"importInsuredType\": null,\n  \"defaultBranchNumberOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"defaultAdminStatusCodeOrId\": null,\n  \"defaultNoteActionCodeOrId\": null,\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": null,\n  \"defaultOriginationFeeDescriptionOrId\": null,\n  \"defaultOriginationFinanceFeeDescriptionOrId\": null,\n  \"defaultTitleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{{import_account_configuration_code_or_id}}","description":"<h3 id=\"update-servicing-import-account-configuration\">Update Servicing Import Account Configuration</h3>\n<p>Updates an existing Import Account configuration. The controller resolves the route <code>{codeOrId}</code> via <code>SharedWSServices.GetServicingImportAccountConfigurationId</code>, re-reads the row through <code>ImportAccountConfiguration.ReturnImportAccountConfiguration</code> to capture the current <code>Ts</code>, and then calls <code>ImportAccountConfigurationWSServices.AddSaveWS</code>. All validation rules from the Add endpoint apply.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>ImportSpecification</code>. <code>BadRequest</code> \"Import account configuration not found\" when the value cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape and rules as <code>Add Servicing Import Account Configuration</code>. Any client-provided <code>ts</code> value is ignored — the controller always injects the <code>Ts</code> it read from the existing row.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated import account configuration.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>defaultBranchNumberOrId</code></td>\n<td><code>defaultBranchId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultClassNumberOrId</code></td>\n<td><code>defaultClassId</code></td>\n<td>String. class number or class GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultAdminStatusCodeOrId</code></td>\n<td><code>defaultAdminStatusId</code></td>\n<td>String. administrative-status code or admin-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultNoteActionCodeOrId</code></td>\n<td><code>defaultNoteActionCodeId</code></td>\n<td>String. action code or action-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultAdvanceAdjustmentFeeDescriptionOrId</code></td>\n<td><code>defaultAdvanceAdjustmentFeeId</code></td>\n<td>String. advance/adjustment-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOriginationFeeDescriptionOrId</code></td>\n<td><code>defaultOriginationFeeId</code></td>\n<td>String. origination-fee description or fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultOriginationFinanceFeeDescriptionOrId</code></td>\n<td><code>defaultOriginationFinanceFeeId</code></td>\n<td>String. origination finance-fee description or finance-fee GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>defaultTitleStatusCodeOrId</code></td>\n<td><code>defaultTitleStatusCodeId</code></td>\n<td>String. title-status number or title-status GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"defaultBranchNumberOrId\": \"90\",\n  \"defaultClassNumberOrId\": \"1\",\n  \"defaultAdminStatusCodeOrId\": \"ACTIVE\",\n  \"defaultNoteActionCodeOrId\": \"CALL\",\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": \"Advance Fee\",\n  \"defaultOriginationFeeDescriptionOrId\": \"Origination Fee\",\n  \"defaultOriginationFinanceFeeDescriptionOrId\": \"Finance Fee\",\n  \"defaultTitleStatusCodeOrId\": \"1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ImportAccountConfiguration","{{import_account_configuration_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d582a472-aadb-430a-8ae7-2097bcf85a72","name":"UpdateImportAccountConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"importSpecification\": \"NEW_ACCT_STD\",\n  \"active\": true,\n  \"type\": 1,\n  \"format\": 1,\n  \"importMethod\": 1,\n  \"notificationEmail\": \"imports-updated@example.com\",\n  \"defaultBranchId\": \"f1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultClassId\": \"f1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"defaultAdminStatusId\": \"f1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"defaultNoteActionCodeId\": null,\n  \"defaultAdvanceAdjustmentFeeId\": null,\n  \"defaultOriginationFeeId\": null,\n  \"defaultOriginationFinanceFeeId\": null,\n  \"defaultTitleStatusCodeId\": null,\n  \"defaultLanguageCode\": 1,\n  \"disbursementOption\": 1,\n  \"autoActivate\": true,\n  \"importInsuredType\": null,\n  \"defaultBranchNumberOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"defaultAdminStatusCodeOrId\": null,\n  \"defaultNoteActionCodeOrId\": null,\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": null,\n  \"defaultOriginationFeeDescriptionOrId\": null,\n  \"defaultOriginationFinanceFeeDescriptionOrId\": null,\n  \"defaultTitleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{{import_account_configuration_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"4dbc912c-a428-4540-99d1-8a976b3fc274","name":"UpdateImportAccountConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"importSpecification\": \"NEW_ACCT_STD\",\n  \"active\": true,\n  \"type\": 1,\n  \"format\": 1,\n  \"importMethod\": 1,\n  \"notificationEmail\": \"imports-updated@example.com\",\n  \"defaultBranchId\": \"f1c2d3e4-1111-4222-9333-abcdef012346\",\n  \"defaultClassId\": \"f1c2d3e4-1111-4222-9333-abcdef012347\",\n  \"defaultAdminStatusId\": \"f1c2d3e4-1111-4222-9333-abcdef012348\",\n  \"defaultNoteActionCodeId\": null,\n  \"defaultAdvanceAdjustmentFeeId\": null,\n  \"defaultOriginationFeeId\": null,\n  \"defaultOriginationFinanceFeeId\": null,\n  \"defaultTitleStatusCodeId\": null,\n  \"defaultLanguageCode\": 1,\n  \"disbursementOption\": 1,\n  \"autoActivate\": true,\n  \"importInsuredType\": null,\n  \"defaultBranchNumberOrId\": null,\n  \"defaultClassNumberOrId\": null,\n  \"defaultAdminStatusCodeOrId\": null,\n  \"defaultNoteActionCodeOrId\": null,\n  \"defaultAdvanceAdjustmentFeeDescriptionOrId\": null,\n  \"defaultOriginationFeeDescriptionOrId\": null,\n  \"defaultOriginationFinanceFeeDescriptionOrId\": null,\n  \"defaultTitleStatusCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportAccountConfiguration/{{import_account_configuration_code_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Import account configuration not found\"\n    ]\n}"}],"_postman_id":"2c6aa7dc-1745-49ae-9771-358e6300b2ff"},{"name":"InsuranceImportFileDefAdd","id":"f045b804-dfba-41b9-8d57-364e0bf316ab","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"INSCUST\",\n  \"description\": \"Custom Insurance Import File\",\n  \"fileFormat\": 1,\n  \"hasHeader\": true,\n  \"hasFooter\": false,\n  \"insuranceProductId\": \"b2c2d3e4-1111-4222-9333-abcdef012346\",\n  \"includeAdditions\": true,\n  \"includeCancelled\": true,\n  \"includeExpired\": false,\n  \"financeTermOption\": 1,\n  \"premiumRefundMethod\": 1,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"policyNumberStart\": 13,\n    \"policyNumberEnd\": 32,\n    \"premiumAmountStart\": 33,\n    \"premiumAmountEnd\": 42,\n    \"policyFeeStart\": null,\n    \"policyFeeEnd\": null,\n    \"effectiveDateStart\": 43,\n    \"effectiveDateEnd\": 50,\n    \"effectiveDateFormat\": 1,\n    \"policyTermStart\": 51,\n    \"policyTermEnd\": 53,\n    \"financeTermStart\": null,\n    \"financeTermEnd\": null,\n    \"expirationDateStart\": null,\n    \"expirationDateEnd\": null,\n    \"expirationDateFormat\": null,\n    \"cancelDateStart\": null,\n    \"cancelDateEnd\": null,\n    \"cancelDateFormat\": null,\n    \"premiumRefundStart\": null,\n    \"premiumRefundEnd\": null,\n    \"policyFeeRefundStart\": null,\n    \"policyFeeRefundEnd\": null,\n    \"agentStart\": null,\n    \"agentEnd\": null,\n    \"insuredTypeStart\": null,\n    \"insuredTypeEnd\": null\n  },\n  \"insuranceProductCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition","description":"<h3 id=\"add-servicing-insurance-import-file-definition\">Add Servicing Insurance Import File Definition</h3>\n<p>Creates a new Insurance Import file definition used when importing insurance policies against servicing accounts. Delegates to <code>InsuranceImportFileDefWSServices.AddSaveWS</code> with <code>id=null</code> and <code>ts=null</code>. Validation rules:</p>\n<ul>\n<li><code>code</code> required, max 10 characters, unique per client. - <code>description</code> required, max 50 characters. - <code>insuranceProductId</code> must resolve to an existing insurance product;\nthe product's <code>Ownership</code> and <code>InsuranceType</code> drive which custom-range\nfields are required.</li>\n<li><code>fileFormat=API</code> cannot set <code>includeExpired=true</code> (API files do not\ninclude expired rows).</li>\n<li><code>fileFormat=Custom</code> requires the <code>custom</code> object; any other format\nmust omit custom.</li>\n<li>Range pairs (<code>*Start</code>/<code>*End</code>) must be supplied together and satisfy\n<code>start &lt;= end</code>. Date ranges must match the length of the selected date\nformat (MMDDYY=6, MMDDYYYY=8, etc.).</li>\n<li>Custom cannot include both <code>policyTermStart</code>/<code>End</code> and <code>expirationDateStart</code>/<code>End</code>.</li>\n</ul>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string, max 10 characters. Unique per client.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string, max 50 characters.</td>\n</tr>\n<tr>\n<td><em>fileFormat</em></td>\n<td>Required int enum <code>ServicingInsuranceImportFileFormat</code> (e.g. <code>Custom=1</code>, <code>API=2</code>, vendor-specific values).</td>\n</tr>\n<tr>\n<td><em>hasHeader</em> / <em>hasFooter</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>insuranceProductId</em></td>\n<td>Required Guid. <code>Insurance.Product</code> Id.</td>\n</tr>\n<tr>\n<td><em>includeAdditions</em> / <em>includeCancelled</em> / <em>includeExpired</em></td>\n<td>Required bool. <code>includeExpired</code> cannot be true when <code>fileFormat=API</code>.</td>\n</tr>\n<tr>\n<td><em>financeTermOption</em></td>\n<td>Optional int enum <code>ServicingInsuranceFinanceTermOption</code>.</td>\n</tr>\n<tr>\n<td><em>premiumRefundMethod</em></td>\n<td>Optional int enum <code>ServicingInsurancePremiumRefundMethod</code>.</td>\n</tr>\n<tr>\n<td><em>custom</em></td>\n<td>Required object when <code>fileFormat=Custom</code>; must be omitted for all other formats.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"custom-object-parameters-custom\">Custom Object Parameters (<code>custom</code>)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberStart</em> / <em>accountNumberEnd</em></td>\n<td>Required int. Start &lt;= end.</td>\n</tr>\n<tr>\n<td><em>policyNumberStart</em> / <em>policyNumberEnd</em></td>\n<td>Optional int pair.</td>\n</tr>\n<tr>\n<td><em>premiumAmountStart</em> / <em>premiumAmountEnd</em></td>\n<td>Optional int pair. Required for additions.</td>\n</tr>\n<tr>\n<td><em>policyFeeStart</em> / <em>policyFeeEnd</em></td>\n<td>Optional int pair.</td>\n</tr>\n<tr>\n<td><em>effectiveDateStart</em> / <em>effectiveDateEnd</em></td>\n<td>Required int. Range length must match <code>effectiveDateFormat</code>.</td>\n</tr>\n<tr>\n<td><em>effectiveDateFormat</em></td>\n<td>Required int enum <code>ServicingInsuranceImportFileDateFormat</code>.</td>\n</tr>\n<tr>\n<td><em>policyTermStart</em> / <em>policyTermEnd</em></td>\n<td>Optional int pair. Cannot coexist with <code>expirationDateStart</code>/<code>End</code>.</td>\n</tr>\n<tr>\n<td><em>financeTermStart</em> / <em>financeTermEnd</em></td>\n<td>Optional int pair.</td>\n</tr>\n<tr>\n<td><em>expirationDateStart</em> / <em>expirationDateEnd</em></td>\n<td>Optional int pair. Length must match <code>expirationDateFormat</code>.</td>\n</tr>\n<tr>\n<td><em>expirationDateFormat</em></td>\n<td>Optional int enum.</td>\n</tr>\n<tr>\n<td><em>cancelDateStart</em> / <em>cancelDateEnd</em></td>\n<td>Optional int pair. Length must match <code>cancelDateFormat</code>.</td>\n</tr>\n<tr>\n<td><em>cancelDateFormat</em></td>\n<td>Optional int enum.</td>\n</tr>\n<tr>\n<td><em>premiumRefundStart</em> / <em>premiumRefundEnd</em></td>\n<td>Optional int pair. Required when <code>includeCancelled=true</code>.</td>\n</tr>\n<tr>\n<td><em>policyFeeRefundStart</em> / <em>policyFeeRefundEnd</em></td>\n<td>Optional int pair.</td>\n</tr>\n<tr>\n<td><em>agentStart</em> / <em>agentEnd</em></td>\n<td>Optional int pair.</td>\n</tr>\n<tr>\n<td><em>insuredTypeStart</em> / <em>insuredTypeEnd</em></td>\n<td>Optional int pair. Required when the selected insurance product's ownership needs an insured-type mapping.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id, CustomId }</code> — the Guid of the new file definition and of its custom-format child row (when applicable).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>insuranceProductCodeOrId</code></td>\n<td><code>insuranceProductId</code></td>\n<td>String. customer-tracking or lender insurance product code or matching product GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"insuranceProductCodeOrId\": \"INS\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ImportInsuranceFileDefinition"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"637f9e38-1ac2-41e0-8906-d6db682d78ca","name":"AddInsuranceImportFileDef - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"INSCUST\",\n  \"description\": \"Custom Insurance Import File\",\n  \"fileFormat\": 2,\n  \"hasHeader\": true,\n  \"hasFooter\": false,\n  \"insuranceProductId\": \"b2c2d3e4-1111-4222-9333-abcdef012346\",\n  \"includeAdditions\": true,\n  \"includeCancelled\": true,\n  \"includeExpired\": true,\n  \"financeTermOption\": 1,\n  \"premiumRefundMethod\": 1,\n  \"custom\": null,\n  \"insuranceProductCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Include expired cannot be selected when the file format is API\"\n    ],\n    \"warnings\": []\n}"},{"id":"5cf318ee-3514-4ce8-9f12-e18c16268420","name":"AddInsuranceImportFileDef - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"INSCUST\",\n  \"description\": \"Custom Insurance Import File\",\n  \"fileFormat\": 1,\n  \"hasHeader\": true,\n  \"hasFooter\": false,\n  \"insuranceProductId\": \"b2c2d3e4-1111-4222-9333-abcdef012346\",\n  \"includeAdditions\": true,\n  \"includeCancelled\": true,\n  \"includeExpired\": false,\n  \"financeTermOption\": 1,\n  \"premiumRefundMethod\": 1,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"policyNumberStart\": 13,\n    \"policyNumberEnd\": 32,\n    \"premiumAmountStart\": 33,\n    \"premiumAmountEnd\": 42,\n    \"policyFeeStart\": null,\n    \"policyFeeEnd\": null,\n    \"effectiveDateStart\": 43,\n    \"effectiveDateEnd\": 50,\n    \"effectiveDateFormat\": 1,\n    \"policyTermStart\": 51,\n    \"policyTermEnd\": 53,\n    \"financeTermStart\": null,\n    \"financeTermEnd\": null,\n    \"expirationDateStart\": null,\n    \"expirationDateEnd\": null,\n    \"expirationDateFormat\": null,\n    \"cancelDateStart\": null,\n    \"cancelDateEnd\": null,\n    \"cancelDateFormat\": null,\n    \"premiumRefundStart\": null,\n    \"premiumRefundEnd\": null,\n    \"policyFeeRefundStart\": null,\n    \"policyFeeRefundEnd\": null,\n    \"agentStart\": null,\n    \"agentEnd\": null,\n    \"insuredTypeStart\": null,\n    \"insuredTypeEnd\": null\n  },\n  \"insuranceProductCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2c2d3e4-1111-4222-9333-abcdef012345\",\n        \"CustomId\": \"c2c2d3e4-1111-4222-9333-abcdef012347\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"f045b804-dfba-41b9-8d57-364e0bf316ab"},{"name":"InsuranceImportFileDefGet","id":"5c5f9d83-308f-469b-83ab-71b2e42ef030","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{{insurance_import_file_def_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-insurance-import-file-definition\">Get Servicing Insurance Import File Definition</h3>\n<p>Returns a single Insurance Import file definition by either its Guid <code>Id</code> or client-scoped <code>Code</code>. Delegates to <code>InsuranceImportFileDefWSServices.ReturnWS</code> which resolves the Id via <code>SharedWSServices.GetServicingInsuranceImportFileDefId</code> and then calls <code>ImportInsuranceConfiguration.ReturnInsuranceImportConfiguration(db, id, includeCustom:true)</code>. The response includes the child <code>ServicingInsuranceImportFileDefCustoms</code> row used for custom fixed-position file formats.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>Code</code>. <code>BadRequest</code> \"Insurance import file definition not found\" when the value cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the <code>MyServicingInsuranceImportFileDefEntity</code> projection with the core scalar fields (<code>Id</code>, <code>IsActive</code>, <code>Code</code>, <code>Description</code>, <code>FileFormat</code>, <code>HasHeader</code>, <code>HasFooter</code>, <code>InsuranceProductId</code>, <code>IncludeAdditions</code>, <code>IncludeCancelled</code>, <code>IncludeExpired</code>, <code>FinanceTermOption</code>, <code>PremiumRefundMethod</code>, <code>Ts</code>) plus the <code>ServicingInsuranceImportFileDefCustoms</code> collection that holds the custom format position metadata when <code>FileFormat=Custom</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ImportInsuranceFileDefinition","{{insurance_import_file_def_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a3b9847c-29e6-45cf-9b1f-f939eda08688","name":"GetInsuranceImportFileDef - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{{insurance_import_file_def_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","ImportInsuranceFileDefinition","{{insurance_import_file_def_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Insurance import file definition not found\"\n    ]\n}"},{"id":"6bc66138-c68a-4c97-aad6-ca0baf1fa4f3","name":"GetInsuranceImportFileDef - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{{insurance_import_file_def_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","ImportInsuranceFileDefinition","{{insurance_import_file_def_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2c2d3e4-1111-4222-9333-abcdef012345\",\n        \"IsActive\": true,\n        \"Code\": \"INSCUST\",\n        \"Description\": \"Custom Insurance Import File\",\n        \"FileFormat\": 1,\n        \"HasHeader\": true,\n        \"HasFooter\": false,\n        \"InsuranceProductId\": \"b2c2d3e4-1111-4222-9333-abcdef012346\",\n        \"IncludeAdditions\": true,\n        \"IncludeCancelled\": true,\n        \"IncludeExpired\": false,\n        \"FinanceTermOption\": 1,\n        \"PremiumRefundMethod\": 1,\n        \"Ts\": \"AAAAAAAAB9U=\",\n        \"ServicingInsuranceImportFileDefCustoms\": [\n            {\n                \"Id\": \"c2c2d3e4-1111-4222-9333-abcdef012347\",\n                \"ServicingInsuranceImportFileDefId\": \"a2c2d3e4-1111-4222-9333-abcdef012345\",\n                \"AccountNumberStart\": 1,\n                \"AccountNumberEnd\": 12,\n                \"PolicyNumberStart\": 13,\n                \"PolicyNumberEnd\": 32,\n                \"PremiumAmountStart\": 33,\n                \"PremiumAmountEnd\": 42,\n                \"PolicyFeeStart\": null,\n                \"PolicyFeeEnd\": null,\n                \"EffectiveDateStart\": 43,\n                \"EffectiveDateEnd\": 50,\n                \"EffectiveDateFormat\": 1,\n                \"PolicyTermStart\": 51,\n                \"PolicyTermEnd\": 53,\n                \"FinanceTermStart\": null,\n                \"FinanceTermEnd\": null,\n                \"ExpirationDateStart\": null,\n                \"ExpirationDateEnd\": null,\n                \"ExpirationDateFormat\": null,\n                \"CancelDateStart\": null,\n                \"CancelDateEnd\": null,\n                \"CancelDateFormat\": null,\n                \"PremiumRefundStart\": null,\n                \"PremiumRefundEnd\": null,\n                \"PolicyFeeRefundStart\": null,\n                \"PolicyFeeRefundEnd\": null,\n                \"AgentStart\": null,\n                \"AgentEnd\": null,\n                \"InsuredTypeStart\": null,\n                \"InsuredTypeEnd\": null,\n                \"Ts\": \"AAAAAAAAB9Y=\"\n            }\n        ]\n    },\n    \"errors\": []\n}"}],"_postman_id":"5c5f9d83-308f-469b-83ab-71b2e42ef030"},{"name":"InsuranceImportFileDefUpdate","id":"773af195-6ab3-458b-8fd5-e7cf78838f86","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"INSCUST\",\n  \"description\": \"Custom Insurance Import File - Updated\",\n  \"fileFormat\": 1,\n  \"hasHeader\": true,\n  \"hasFooter\": false,\n  \"insuranceProductId\": \"b2c2d3e4-1111-4222-9333-abcdef012346\",\n  \"includeAdditions\": true,\n  \"includeCancelled\": true,\n  \"includeExpired\": false,\n  \"financeTermOption\": 1,\n  \"premiumRefundMethod\": 1,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"policyNumberStart\": 13,\n    \"policyNumberEnd\": 32,\n    \"premiumAmountStart\": 33,\n    \"premiumAmountEnd\": 42,\n    \"policyFeeStart\": null,\n    \"policyFeeEnd\": null,\n    \"effectiveDateStart\": 43,\n    \"effectiveDateEnd\": 50,\n    \"effectiveDateFormat\": 1,\n    \"policyTermStart\": 51,\n    \"policyTermEnd\": 53,\n    \"financeTermStart\": null,\n    \"financeTermEnd\": null,\n    \"expirationDateStart\": null,\n    \"expirationDateEnd\": null,\n    \"expirationDateFormat\": null,\n    \"cancelDateStart\": null,\n    \"cancelDateEnd\": null,\n    \"cancelDateFormat\": null,\n    \"premiumRefundStart\": null,\n    \"premiumRefundEnd\": null,\n    \"policyFeeRefundStart\": null,\n    \"policyFeeRefundEnd\": null,\n    \"agentStart\": null,\n    \"agentEnd\": null,\n    \"insuredTypeStart\": null,\n    \"insuredTypeEnd\": null\n  },\n  \"insuranceProductCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{{insurance_import_file_def_code_or_id}}","description":"<h3 id=\"update-servicing-insurance-import-file-definition\">Update Servicing Insurance Import File Definition</h3>\n<p>Updates an existing Insurance Import file definition. The controller resolves the route <code>{codeOrId}</code> via <code>SharedWSServices.GetServicingInsuranceImportFileDefId</code>, re-reads the row through <code>ImportInsuranceConfiguration.ReturnInsuranceImportConfiguration(db, id, includeCustom:true)</code> to capture the current <code>Ts</code> (and the child <code>ServicingInsuranceImportFileDefCustoms[0]</code> <code>Id</code> and <code>Ts</code> when present), and then calls <code>InsuranceImportFileDefWSServices.AddSaveWS</code>. All validation rules from the Add endpoint apply.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the Guid <code>Id</code> or the client-scoped <code>Code</code>. <code>BadRequest</code> \"Insurance import file definition not found\" when the value cannot be resolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape and rules as <code>Add Servicing Insurance Import File Definition</code>. Client-provided <code>ts</code>/<code>customId</code>/<code>customTs</code> values are ignored — the controller always injects the values it read from the existing row.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id, CustomId }</code> — the Guid of the updated file definition and of its custom-format child row (when applicable).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>insuranceProductCodeOrId</code></td>\n<td><code>insuranceProductId</code></td>\n<td>String. customer-tracking or lender insurance product code or matching product GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"insuranceProductCodeOrId\": \"INS\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ImportInsuranceFileDefinition","{{insurance_import_file_def_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bf11f8a3-39f3-46ff-aeaf-1fd1432a9fb3","name":"UpdateInsuranceImportFileDef - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"INSCUST\",\n  \"description\": \"Custom Insurance Import File - Updated\",\n  \"fileFormat\": 1,\n  \"hasHeader\": true,\n  \"hasFooter\": false,\n  \"insuranceProductId\": \"b2c2d3e4-1111-4222-9333-abcdef012346\",\n  \"includeAdditions\": true,\n  \"includeCancelled\": true,\n  \"includeExpired\": false,\n  \"financeTermOption\": 1,\n  \"premiumRefundMethod\": 1,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"policyNumberStart\": 13,\n    \"policyNumberEnd\": 32,\n    \"premiumAmountStart\": 33,\n    \"premiumAmountEnd\": 42,\n    \"policyFeeStart\": null,\n    \"policyFeeEnd\": null,\n    \"effectiveDateStart\": 43,\n    \"effectiveDateEnd\": 50,\n    \"effectiveDateFormat\": 1,\n    \"policyTermStart\": 51,\n    \"policyTermEnd\": 53,\n    \"financeTermStart\": null,\n    \"financeTermEnd\": null,\n    \"expirationDateStart\": null,\n    \"expirationDateEnd\": null,\n    \"expirationDateFormat\": null,\n    \"cancelDateStart\": null,\n    \"cancelDateEnd\": null,\n    \"cancelDateFormat\": null,\n    \"premiumRefundStart\": null,\n    \"premiumRefundEnd\": null,\n    \"policyFeeRefundStart\": null,\n    \"policyFeeRefundEnd\": null,\n    \"agentStart\": null,\n    \"agentEnd\": null,\n    \"insuredTypeStart\": null,\n    \"insuredTypeEnd\": null\n  },\n  \"insuranceProductCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{{insurance_import_file_def_code_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Insurance import file definition not found\"\n    ]\n}"},{"id":"6e28c1fd-56f5-4309-90cf-856d83ae0eb6","name":"UpdateInsuranceImportFileDef - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"isActive\": true,\n  \"code\": \"INSCUST\",\n  \"description\": \"Custom Insurance Import File - Updated\",\n  \"fileFormat\": 1,\n  \"hasHeader\": true,\n  \"hasFooter\": false,\n  \"insuranceProductId\": \"b2c2d3e4-1111-4222-9333-abcdef012346\",\n  \"includeAdditions\": true,\n  \"includeCancelled\": true,\n  \"includeExpired\": false,\n  \"financeTermOption\": 1,\n  \"premiumRefundMethod\": 1,\n  \"custom\": {\n    \"accountNumberStart\": 1,\n    \"accountNumberEnd\": 12,\n    \"policyNumberStart\": 13,\n    \"policyNumberEnd\": 32,\n    \"premiumAmountStart\": 33,\n    \"premiumAmountEnd\": 42,\n    \"policyFeeStart\": null,\n    \"policyFeeEnd\": null,\n    \"effectiveDateStart\": 43,\n    \"effectiveDateEnd\": 50,\n    \"effectiveDateFormat\": 1,\n    \"policyTermStart\": 51,\n    \"policyTermEnd\": 53,\n    \"financeTermStart\": null,\n    \"financeTermEnd\": null,\n    \"expirationDateStart\": null,\n    \"expirationDateEnd\": null,\n    \"expirationDateFormat\": null,\n    \"cancelDateStart\": null,\n    \"cancelDateEnd\": null,\n    \"cancelDateFormat\": null,\n    \"premiumRefundStart\": null,\n    \"premiumRefundEnd\": null,\n    \"policyFeeRefundStart\": null,\n    \"policyFeeRefundEnd\": null,\n    \"agentStart\": null,\n    \"agentEnd\": null,\n    \"insuredTypeStart\": null,\n    \"insuredTypeEnd\": null\n  },\n  \"insuranceProductCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ImportInsuranceFileDefinition/{{insurance_import_file_def_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2c2d3e4-1111-4222-9333-abcdef012345\",\n        \"CustomId\": \"c2c2d3e4-1111-4222-9333-abcdef012347\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"773af195-6ab3-458b-8fd5-e7cf78838f86"},{"name":"NewWaterfallCodeAndDetailCreate","id":"182a4c47-5bc8-4fa5-b638-7b1016716dab","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall\",\n  \"overwriteExisting\": false,\n  \"details\": [\n    {\n      \"sequenceNumber\": 1,\n      \"item\": 5,\n      \"specificTransCodeId\": null,\n      \"methodOfPayment\": 1,\n      \"payCount\": 1,\n      \"specificTransCodeOrId\": null\n    },\n    {\n      \"sequenceNumber\": 2,\n      \"item\": 3,\n      \"specificTransCodeId\": null,\n      \"methodOfPayment\": 1,\n      \"payCount\": 1,\n      \"specificTransCodeOrId\": null\n    },\n    {\n      \"sequenceNumber\": 3,\n      \"item\": 1,\n      \"specificTransCodeId\": null,\n      \"methodOfPayment\": null,\n      \"payCount\": null,\n      \"specificTransCodeOrId\": null\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CreateNewWaterfallCodeAndDetail","description":"<h3 id=\"create-servicing-payment-waterfall-code-with-details\">Create Servicing Payment Waterfall Code with Details</h3>\n<p>Creates a payment waterfall code together with its sequenced detail rows in a single call. Delegates to <code>PaymentWaterfallCodeWSServices.CreateNewWaterfallCodeAndDetailWS</code>, which assembles a <code>PaymentWaterfallCodeObject.WaterfallCode</code> (with nested <code>WaterfallDetail</code> rows) and calls <code>PaymentWaterfallCodeServices.CreateNewWaterfallCodeAndDetail</code>. The business method commits its own transaction.</p>\n<p><code>waterfallCode</code> and <code>description</code> are both required. When <code>overwriteExisting=false</code> and a waterfall with the same <code>waterfallCode</code> already exists, the call fails with <code>\"Waterfall code '{code}' already exists. Use overwriteExisting=true to overwrite.\"</code>. When <code>overwriteExisting=true</code>, the existing waterfall is replaced.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/CreateNewWaterfallCodeAndDetail</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>waterfallCode</em></td>\n<td>Required string. Client-scoped unique waterfall code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Waterfall description.</td>\n</tr>\n<tr>\n<td><em>overwriteExisting</em></td>\n<td>Required bool. When <code>true</code>, replaces an existing waterfall of the same code.</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>Optional array of waterfall detail rows (see below).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"detail-object-parameters-details\">Detail Object Parameters (<code>details[]</code>)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>sequenceNumber</em></td>\n<td>Required int. 1-based order in which the line is applied.</td>\n</tr>\n<tr>\n<td><em>item</em></td>\n<td>Required int enum <code>PaymentApplicationItem</code> — e.g. <code>Principal=1</code>, <code>Interest=2</code>, <code>All_Other_Balance=3</code>, <code>Specific_Other_Balance=4</code>, <code>Past_Due_Interest_And_Principal=5</code>, <code>Whole_Payment_Ignore_Update_Percent=6</code>, <code>Whole_Payment_Include_Update_Percent=7</code>, <code>Past_And_Current_Amount_Due_Principal_And_Interest=8</code>, <code>All_Sub_Account_By_Period=9</code>, <code>Specific_Sub_Account_By_Period=10</code>, <code>All_Sub_Account_By_Percent_Of_Principal=11</code>, <code>Specific_Sub_Account_By_Percent_Of_Principal=12</code>.</td>\n</tr>\n<tr>\n<td><em>specificTransCodeId</em></td>\n<td>Optional Guid. Required when <code>item</code> references a specific other-balance/sub-account transaction code.</td>\n</tr>\n<tr>\n<td><em>methodOfPayment</em></td>\n<td>Optional int enum <code>PaymentApplicationItemMethodOfPayment</code> — <code>Periods_To_Pay=1</code> (default), <code>Pay_X_Periods_Ahead=2</code>.</td>\n</tr>\n<tr>\n<td><em>payCount</em></td>\n<td>Optional int. Count paired with <code>methodOfPayment</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the newly created (or overwritten) payment waterfall code.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>details[].specificTransCodeOrId</code></td>\n<td><code>details[].specificTransCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"details\": [\n    {\n      \"specificTransCodeOrId\": \"PYC\"\n    }\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","CreateNewWaterfallCodeAndDetail"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"45eb90bc-b13f-4def-9500-57666ca898bb","name":"CreateNewWaterfallCodeAndDetail - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall\",\n  \"overwriteExisting\": false,\n  \"details\": [\n    {\n      \"sequenceNumber\": 1,\n      \"item\": 5,\n      \"specificTransCodeId\": null,\n      \"methodOfPayment\": 1,\n      \"payCount\": 1,\n      \"specificTransCodeOrId\": null\n    },\n    {\n      \"sequenceNumber\": 2,\n      \"item\": 3,\n      \"specificTransCodeId\": null,\n      \"methodOfPayment\": 1,\n      \"payCount\": 1,\n      \"specificTransCodeOrId\": null\n    },\n    {\n      \"sequenceNumber\": 3,\n      \"item\": 1,\n      \"specificTransCodeId\": null,\n      \"methodOfPayment\": null,\n      \"payCount\": null,\n      \"specificTransCodeOrId\": null\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CreateNewWaterfallCodeAndDetail"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"5cc2d9d9-2309-46d5-884a-2c2832c254a1","name":"CreateNewWaterfallCodeAndDetail - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall\",\n  \"overwriteExisting\": false,\n  \"details\": [\n    {\n      \"sequenceNumber\": 1,\n      \"item\": 5,\n      \"specificTransCodeId\": null,\n      \"methodOfPayment\": 1,\n      \"payCount\": 1,\n      \"specificTransCodeOrId\": null\n    }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/CreateNewWaterfallCodeAndDetail"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Waterfall code 'STANDARD' already exists. Use overwriteExisting=true to overwrite.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"182a4c47-5bc8-4fa5-b638-7b1016716dab"},{"name":"OtherBalancesGet","id":"6f60f9a0-f2e2-4aa5-b724-e8aa80e6c444","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number}}/OtherBalances?token={{token}}&returnType=1&unpaidOnly=false","description":"<h3 id=\"get-servicing-account-other-balances\">Get Servicing Account Other Balances</h3>\n<p>Returns the full set of other-balance rows posted against a servicing account (fees, insurance, misc charges, etc.). Delegates to <code>OtherBalanceWSServices.ReturnOtherBalancesWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and calls <code>OtherBalanceServices.ReturnOtherBalance(db, accountId, fetchDetail=true, fetchCode=true, unpaidOnly, returnType)</code>. <code>data</code> is an <code>EntityCollection&lt;MyServicingAccountTransactionOtherBalanceEntity&gt;</code> with related <code>ServicingAccountTransactionOtherBalanceTransaction</code> and <code>ServicingAccountTransactionDetail</code>/<code>ServicingTransactionCode</code> rows prefetched.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Account/{accountNumberOrId}/OtherBalances</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Account number or <code>Common.Account</code> Id. Resolved by <code>SharedWSServices.GetCommonAccountId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>returnType</em></td>\n<td>Optional int enum <code>OtherBalanceServices.OtherBalanceReturnType</code> — <code>All=1</code> (default), <code>LateFee=2</code>, <code>Other=3</code>.</td>\n</tr>\n<tr>\n<td><em>unpaidOnly</em></td>\n<td>Optional bool. Defaults to <code>false</code>. When <code>true</code>, only other-balance rows with remaining amount due are returned (same shape, filtered server-side). For the dedicated unpaid projection use the <code>/OtherBalances/Unpaid</code> route, which returns a slimmer <code>OtherBalanceType</code> list instead of the full entity collection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"bulk-variant\">Bulk variant</h4>\n<p>Process one to 250 accounts in one call: <code>POST api/Client/Servicing/Account/Bulk/GetOtherBalances</code>. Each array item supplies its own <code>returnType</code> and <code>unpaidOnly</code>. See <strong>Bulk Get Servicing Account Other Balances</strong> in this collection.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","{{account_number}}","OtherBalances"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"returnType","value":"1"},{"key":"unpaidOnly","value":"false"}],"variable":[]}},"response":[{"id":"488a6a8f-86f9-4018-a1ad-f98dde94b8dd","name":"GetOtherBalances - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number}}/OtherBalances?token={{token}}&returnType=1&unpaidOnly=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","{{account_number}}","OtherBalances"],"query":[{"key":"token","value":"{{token}}"},{"key":"returnType","value":"1"},{"key":"unpaidOnly","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"AccountId\": \"a1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"OriginalAmount\": 150.00,\n            \"AmountPaid\": 50.00,\n            \"AmountDue\": 100.00,\n            \"TransactionDate\": \"2026-03-15T00:00:00\",\n            \"PostedDate\": \"2026-03-15T00:00:00\",\n            \"Comment\": \"Late fee assessment\",\n            \"ServicingAccountTransactionOtherBalanceTransaction\": [\n                {\n                    \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012345\",\n                    \"Amount\": 50.00,\n                    \"TransactionDate\": \"2026-03-20T00:00:00\"\n                }\n            ],\n            \"ServicingAccountTransactionDetail\": {\n                \"Id\": \"d1c2d3e4-1111-4222-9333-abcdef012345\",\n                \"ServicingTransactionCode\": {\n                    \"Id\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n                    \"Code\": \"LATEFEE\",\n                    \"Description\": \"Late Fee\"\n                }\n            }\n        }\n    ],\n    \"errors\": []\n}"},{"id":"be754a87-0a47-4895-82a3-ab723f1e3b72","name":"GetOtherBalances - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/0000000000/OtherBalances?token={{token}}&returnType=1&unpaidOnly=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","0000000000","OtherBalances"],"query":[{"key":"token","value":"{{token}}"},{"key":"returnType","value":"1"},{"key":"unpaidOnly","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error fetching other balances: Invalid account number\"\n    ]\n}"}],"_postman_id":"6f60f9a0-f2e2-4aa5-b724-e8aa80e6c444"},{"name":"OtherBalancesGetBulk","id":"62188982-ef33-4f98-938c-ada256b60c67","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"returnType\": 1, \"unpaidOnly\": false },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"returnType\": 2, \"unpaidOnly\": true }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetOtherBalances?token={{token}}","description":"<h3 id=\"bulk-get-servicing-account-other-balances\">Bulk Get Servicing Account Other Balances</h3>\n<p>Returns Other Balances for several accounts. The request body is an array of per-account objects containing one to 250 items, so each account can choose its own <code>returnType</code> and <code>unpaidOnly</code> values. <code>accountNumberOrId</code> accepts an account number or <code>Common.Account</code> Id. The request is capped at 250 accounts and requires token or API-key authentication.</p>\n<p>This route reuses the API Access permission for <code>GET api/Client/Servicing/Account/{accountNumberOrId}/OtherBalances</code>. Check the response <code>statusCode</code> and per-account rows; a processed batch can return HTTP 200 with <code>Successful_With_Error</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","Bulk","GetOtherBalances"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"2422525c-8ab4-45a7-a2b2-8dd8c23379b5","name":"OtherBalancesGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"returnType\": 1,\n    \"unpaidOnly\": false\n  },\n  {\n    \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n    \"returnType\": 2,\n    \"unpaidOnly\": true\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 2,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [\n          {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Ts\": \"AAAAAAAAB9E=\",\n            \"TransactionId\": \"c1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"AmountPaidToDate\": 50,\n            \"NsftransactionId\": null,\n            \"PaidInFull\": false,\n            \"DueDate\": \"2026-03-15T00:00:00\",\n            \"LastPaidDate\": \"2026-03-20T00:00:00\",\n            \"LateFeePaymentDueDate\": null\n          }\n        ]\n      },\n      {\n        \"accountNumber\": 30001213,\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": []\n      }\n    ]\n  }\n}"},{"id":"f5ba704e-fd7a-4a55-8809-efa450a749f6","name":"OtherBalancesGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"returnType\": 1,\n    \"unpaidOnly\": false\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"returnType\": 1,\n    \"unpaidOnly\": false\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [\n          {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Ts\": \"AAAAAAAAB9E=\",\n            \"TransactionId\": \"c1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"AmountPaidToDate\": 50,\n            \"NsftransactionId\": null,\n            \"PaidInFull\": false,\n            \"DueDate\": \"2026-03-15T00:00:00\",\n            \"LastPaidDate\": \"2026-03-20T00:00:00\",\n            \"LateFeePaymentDueDate\": null\n          }\n        ]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"e47a1dc1-4b65-42ec-9643-dc0662aa4fd2","name":"OtherBalancesGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"215c9d00-751e-43fc-b7cb-50704f60f372","name":"OtherBalancesGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false},{\"accountNumberOrId\":\"30001212\",\"returnType\":1,\"unpaidOnly\":false}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"62188982-ef33-4f98-938c-ada256b60c67"},{"name":"PaymentWaterfallCodeAdd","id":"6dbdd5fe-09af-4675-a4c0-f5426f86cd23","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall\",\n  \"jsonHistory\": \"[]\",\n  \"creationServerDate\": \"2026-04-18T00:00:00Z\",\n  \"createdByUserId\": null,\n  \"createdByUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode","description":"<h3 id=\"add-servicing-payment-waterfall-code\">Add Servicing Payment Waterfall Code</h3>\n<p>Creates a new payment waterfall code (header row only — no details). Delegates to <code>PaymentWaterfallCodeWSServices.AddSavePaymentWaterfallCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another waterfall with the same <code>waterfallCode</code> already exists for the client (<code>\"Payment waterfall code already exists\"</code>).</p>\n<p>The BLL call <code>PaymentWaterfallCodeServices.AddSavePaymentWaterfallCode</code> defaults <code>creationServerDate</code> to <code>DateTime.Now</code> and <code>createdByUserId</code> to <code>loginInfo.UserId</code> when they are not supplied.</p>\n<p>Use <code>/api/Client/Servicing/CreateNewWaterfallCodeAndDetail</code> when the waterfall should be created together with its detail rows in a single call.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>waterfallCode</em></td>\n<td>Required string. Client-scoped unique waterfall code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Waterfall description.</td>\n</tr>\n<tr>\n<td><em>jsonHistory</em></td>\n<td>Optional string. JSON change-history blob stored on the row.</td>\n</tr>\n<tr>\n<td><em>creationServerDate</em></td>\n<td>Optional ISO-8601 date. Defaults to server <code>DateTime.Now</code>.</td>\n</tr>\n<tr>\n<td><em>createdByUserId</em></td>\n<td>Optional Guid. Defaults to the authenticated user.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new waterfall code.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>createdByUserLoginOrId</code></td>\n<td><code>createdByUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"createdByUserLoginOrId\": \"collector.login\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ad0552f4-e811-46a0-846c-26808fa50e15","name":"AddPaymentWaterfallCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall\",\n  \"jsonHistory\": \"[]\",\n  \"creationServerDate\": \"2026-04-18T00:00:00Z\",\n  \"createdByUserId\": \"f1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"createdByUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"0fe32453-a482-4f7d-b6cf-9afbdd206092","name":"AddPaymentWaterfallCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall\",\n  \"jsonHistory\": \"[]\",\n  \"creationServerDate\": \"2026-04-18T00:00:00Z\",\n  \"createdByUserId\": null,\n  \"createdByUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Payment waterfall code already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"6dbdd5fe-09af-4675-a4c0-f5426f86cd23"},{"name":"PaymentWaterfallCodeGet","id":"038d0632-ce2d-461c-87f1-3bb418e48295","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/{{payment_waterfall_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-payment-waterfall-code\">Get Servicing Payment Waterfall Code</h3>\n<p>Returns a single payment waterfall code resolved by code or Guid. Delegates to <code>PaymentWaterfallCodeWSServices.ReturnPaymentWaterfallCodeWS</code>, which first attempts <code>Guid.TryParse</code>; if that fails it calls <code>PaymentWaterfallCodeServices.ReturnPaymentWaterfallId</code> to resolve the client-scoped code, then fetches the record via <code>PaymentWaterfallCodeServices.ReturnPaymentWaterfallCode</code>.</p>\n<p>Returns <code>\"Payment waterfall code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.PaymentWaterfallCode.Code</code> or Id.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingPaymentWaterfallCodeEntity</code> with <code>Id</code>, <code>Code</code>, <code>Description</code>, <code>JsonHistory</code>, <code>CreationServerDate</code>, <code>CreatedByUserId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallCode","{{payment_waterfall_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f91f4769-3b50-4524-a62b-24da1e1890a5","name":"GetPaymentWaterfallCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/{{payment_waterfall_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallCode","{{payment_waterfall_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"Code\": \"STANDARD\",\n        \"Description\": \"Standard Payment Waterfall\",\n        \"JsonHistory\": \"[]\",\n        \"CreationServerDate\": \"2026-04-18T00:00:00\",\n        \"CreatedByUserId\": \"f1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"d3be0610-492c-4e7c-8125-f4ad848ac04c","name":"GetPaymentWaterfallCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/DOESNOTEXIST?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallCode","DOESNOTEXIST"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Payment waterfall code not found\"\n    ]\n}"}],"_postman_id":"038d0632-ce2d-461c-87f1-3bb418e48295"},{"name":"PaymentWaterfallCodesGetAll","id":"8ba22a6e-1417-4686-9ea5-a78a2f7507e3","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode?token={{token}}","description":"<h3 id=\"get-all-servicing-payment-waterfall-codes\">Get All Servicing Payment Waterfall Codes</h3>\n<p>Returns every payment waterfall code configured for the client. Delegates to <code>PaymentWaterfallCodeWSServices.ReturnAllPaymentWaterfallCodesWS</code>, which calls <code>PaymentWaterfallCodeServices.ReturnAllPaymentWaterfallCodes</code> for the current <code>loginInfo.DatabaseName</code>.</p>\n<p>The same controller action (<code>PaymentWaterfallCodeController.GetPaymentWaterfallCode</code>) exposes two GET routes — this one (no route parameter) lists all waterfall codes, and <code>/PaymentWaterfallCode/{codeOrId}</code> returns a single record.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingPaymentWaterfallCodeEntity</code> rows with <code>Id</code>, <code>Code</code>, <code>Description</code>, and standard audit columns.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"8f24a183-6e6d-49ec-9a03-60dc15af399b","name":"GetAllPaymentWaterfallCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Code\": \"STANDARD\",\n            \"Description\": \"Standard Payment Waterfall\",\n            \"JsonHistory\": \"[]\",\n            \"CreationServerDate\": \"2026-04-18T00:00:00\",\n            \"CreatedByUserId\": \"f1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        },\n        {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"Code\": \"COLLECTIONS\",\n            \"Description\": \"Collections Payment Waterfall\",\n            \"JsonHistory\": \"[]\",\n            \"CreationServerDate\": \"2026-03-10T00:00:00\",\n            \"CreatedByUserId\": \"f1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"f49cdb05-35a5-4aee-904e-9cc3438b369d","name":"GetAllPaymentWaterfallCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallCode"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ]\n}"}],"_postman_id":"8ba22a6e-1417-4686-9ea5-a78a2f7507e3"},{"name":"PaymentWaterfallCodeUpdate","id":"f4f180c4-1d99-4dbc-a766-39f67f89b9cf","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall - Updated\",\n  \"jsonHistory\": \"[]\",\n  \"creationServerDate\": \"2026-04-18T00:00:00Z\",\n  \"createdByUserId\": \"f1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"createdByUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/{{payment_waterfall_code_or_id}}","description":"<h3 id=\"update-servicing-payment-waterfall-code\">Update Servicing Payment Waterfall Code</h3>\n<p>Updates an existing payment waterfall code header. The controller resolves the <code>{codeOrId}</code> via <code>Guid.TryParse</code> or <code>PaymentWaterfallCodeServices.ReturnPaymentWaterfallId</code>, fetches the current record to obtain the concurrency <code>Ts</code>, then delegates to <code>PaymentWaterfallCodeWSServices.AddSavePaymentWaterfallCodeWS</code> with the existing <code>id</code> and <code>ts</code> populated.</p>\n<p>Rejects with <code>\"Payment waterfall code not found\"</code> when the <code>{codeOrId}</code> does not resolve to an existing record.</p>\n<p>Detail-row changes are handled through the <code>PaymentWaterfallDetail</code> routes, not through this endpoint.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Existing <code>Servicing.PaymentWaterfallCode.Code</code> or Id.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>waterfallCode</em></td>\n<td>Required string. Updated waterfall code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Updated waterfall description.</td>\n</tr>\n<tr>\n<td><em>jsonHistory</em></td>\n<td>Optional string. JSON change-history blob.</td>\n</tr>\n<tr>\n<td><em>creationServerDate</em></td>\n<td>Optional ISO-8601 date.</td>\n</tr>\n<tr>\n<td><em>createdByUserId</em></td>\n<td>Optional Guid.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated waterfall code.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>createdByUserLoginOrId</code></td>\n<td><code>createdByUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"createdByUserLoginOrId\": \"collector.login\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallCode","{{payment_waterfall_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9264a413-143a-4458-aa73-219e3b7668b8","name":"UpdatePaymentWaterfallCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"STANDARD\",\n  \"description\": \"Standard Payment Waterfall - Updated\",\n  \"jsonHistory\": \"[]\",\n  \"creationServerDate\": \"2026-04-18T00:00:00Z\",\n  \"createdByUserId\": \"f1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"createdByUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/{{payment_waterfall_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"a1b67182-4816-4c4f-9c78-94b5a7a11e22","name":"UpdatePaymentWaterfallCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCode\": \"DOESNOTEXIST\",\n  \"description\": \"Standard Payment Waterfall - Updated\",\n  \"jsonHistory\": \"[]\",\n  \"creationServerDate\": \"2026-04-18T00:00:00Z\",\n  \"createdByUserId\": \"f1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"createdByUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallCode/DOESNOTEXIST"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Payment waterfall code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"f4f180c4-1d99-4dbc-a766-39f67f89b9cf"},{"name":"PaymentWaterfallDetailDelete","id":"c732392f-e4e5-46bc-8cc9-fa102cf44ebd","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/{{payment_waterfall_detail_id}}?token={{token}}","description":"<h3 id=\"delete-servicing-payment-waterfall-detail\">Delete Servicing Payment Waterfall Detail</h3>\n<p>Removes a single waterfall detail row by Guid. The controller validates that <code>{waterfallDetailId}</code> is a parseable Guid, then delegates to <code>PaymentWaterfallCodeWSServices.DeletePaymentWaterfallDetailWS</code>, which calls <code>PaymentWaterfallCodeServices.DeletePaymentWaterfallDetail</code> inside a <code>UnitOfWork2</code> and commits via <code>Transaction.CommitTransaction</code>.</p>\n<p>Rejects with <code>\"Invalid waterfall detail ID\"</code> when <code>{waterfallDetailId}</code> is not a Guid. Any downstream delete failure surfaces as <code>\"Error deleting payment waterfall detail: {message}\"</code>.</p>\n<p><strong>HTTP Method:</strong> DELETE</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/{waterfallDetailId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>waterfallDetailId</em></td>\n<td>Required Guid. <code>Servicing.PaymentWaterfallDetail.Id</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>null</code>. Success is indicated by <code>statusCode=0</code> / <code>result=\"Ok\"</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallDetail","{{payment_waterfall_detail_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5c6989db-b6d3-4a43-8c03-7adad5340cee","name":"DeletePaymentWaterfallDetail - Successful","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/{{payment_waterfall_detail_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallDetail","{{payment_waterfall_detail_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": null,\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"803ad573-a391-4507-995c-66ead18a34f0","name":"DeletePaymentWaterfallDetail - Fail","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/not-a-guid?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallDetail","not-a-guid"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid waterfall detail ID\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"c732392f-e4e5-46bc-8cc9-fa102cf44ebd"},{"name":"PortfolioAccountsGet","id":"04d3459a-d354-42ce-bb1a-7b35b2108415","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Portfolio/{{portfolio_number_or_id}}/Accounts?token={{token}}&fetchClass=false&fetchAdminStatus=false&fetchAccountInstallment=false","description":"<h3 id=\"get-servicing-portfolio-accounts\">Get Servicing Portfolio Accounts</h3>\n<p>Returns every <code>Common.Account</code> linked to the specified portfolio. Delegates to <code>PortfolioWSServices.ReturnPortfolioAccountsWS</code>, which resolves the portfolio via <code>SharedWSServices.GetServicingPortfolioId</code> (Guid or numeric <code>PortfolioNumber</code>) and fetches the associated accounts for the current client.</p>\n<p>The optional <code>fetchClass</code>, <code>fetchAdminStatus</code>, and <code>fetchAccountInstallment</code> flags prefetch the linked <code>Common.Class</code>, <code>Common.AdminStatus</code>, and <code>Common.AccountInstallment</code> records as nested navigation properties on each account.</p>\n<p>Returns <code>\"Portfolio not found\"</code> when the identifier does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Portfolio/{numberOrId}/Accounts</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. <code>Servicing.Portfolio.Id</code> Guid or numeric <code>PortfolioNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>fetchClass</em></td>\n<td>Optional bool. Defaults to <code>false</code>. Prefetches the account's <code>Class</code> navigation.</td>\n</tr>\n<tr>\n<td><em>fetchAdminStatus</em></td>\n<td>Optional bool. Defaults to <code>false</code>. Prefetches the account's <code>AdminStatus</code> navigation.</td>\n</tr>\n<tr>\n<td><em>fetchAccountInstallment</em></td>\n<td>Optional bool. Defaults to <code>false</code>. Prefetches the account's <code>AccountInstallment</code> navigation.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyCommonAccountEntity</code> records with <code>Id</code>, <code>AccountNumber</code>, <code>Name</code>, <code>PortfolioId</code>, and — when requested — populated <code>Class</code>, <code>AdminStatus</code>, and <code>AccountInstallment</code> navigation properties.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Portfolio","{{portfolio_number_or_id}}","Accounts"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchClass","value":"false"},{"key":"fetchAdminStatus","value":"false"},{"key":"fetchAccountInstallment","value":"false"}],"variable":[]}},"response":[{"id":"afcaa6cd-bd42-44ae-910c-f90fd8894e73","name":"GetPortfolioAccounts - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Portfolio/{{portfolio_number_or_id}}/Accounts?token={{token}}&fetchClass=false&fetchAdminStatus=false&fetchAccountInstallment=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Portfolio","{{portfolio_number_or_id}}","Accounts"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchClass","value":"false"},{"key":"fetchAdminStatus","value":"false"},{"key":"fetchAccountInstallment","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"e5f6a7b8-5555-4666-9777-ef0123456789\",\n            \"AccountNumber\": \"30001212\",\n            \"Name\": \"Doe, John\",\n            \"PortfolioId\": \"d4e5f6a7-4444-4555-9666-def012345678\"\n        },\n        {\n            \"Id\": \"f6a7b8c9-6666-4777-9888-f01234567890\",\n            \"AccountNumber\": \"30001213\",\n            \"Name\": \"Smith, Jane\",\n            \"PortfolioId\": \"d4e5f6a7-4444-4555-9666-def012345678\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"d7b11f8e-2e37-4a7e-a47d-ff2a4eeb9725","name":"GetPortfolioAccounts - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Portfolio/999999/Accounts?token={{token}}&fetchClass=false&fetchAdminStatus=false&fetchAccountInstallment=false","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Portfolio","999999","Accounts"],"query":[{"key":"token","value":"{{token}}"},{"key":"fetchClass","value":"false"},{"key":"fetchAdminStatus","value":"false"},{"key":"fetchAccountInstallment","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Portfolio not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"04d3459a-d354-42ce-bb1a-7b35b2108415"},{"name":"PortfolioAdd","id":"b1d9459b-e9cf-43d0-b71f-4a76b10e7105","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"portfolioNumber\": 10,\n    \"description\": \"Primary Portfolio\",\n    \"isActive\": true,\n    \"portfolioType\": 1,\n    \"originalCreditor\": \"\",\n    \"originalCreditorType\": null,\n    \"notes\": \"\",\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Portfolio","description":"<h3 id=\"add-servicing-portfolio\">Add Servicing Portfolio</h3>\n<p>Creates a new portfolio for the current client. Delegates to <code>PortfolioWSServices.AddSavePortfolioWS</code> with no existing entity. Rejects the request when another portfolio with the same <code>portfolioNumber</code> already exists for the client.</p>\n<p>Enum-backed integer fields:</p>\n<ul>\n<li><code>portfolioType</code> — <code>1</code> Regular, <code>2</code> Collection Account - <code>originalCreditorType</code> — <code>1</code> Retail, <code>2</code> Medical/Health Care,\n<code>3</code> Oil Company, <code>4</code> Government, <code>5</code> Personal Services, <code>6</code> Insurance,\n<code>7</code> Educational, <code>8</code> Banking, <code>9</code> Rental/Leasing, <code>10</code> Utilities,\n<code>11</code> Cable/Cellular, <code>12</code> Financial, <code>13</code> Credit Union, … (only\napplies when <code>portfolioType = 2</code>)</li>\n</ul>\n<p>Portfolio <code>originalCreditor</code> / <code>originalCreditorType</code> are Collection Account defaults. Per-account overrides are imported on <code>Account/CreditReporting/AccountCreditReporting/OriginalCreditor</code> and <code>OriginalCreditorType</code> (Single New Account Import / conversion XML) and are shown on ViewAccount only when the account's portfolio is Collection Account.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Portfolio</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>portfolioNumber</em></td>\n<td>Required integer. Client-scoped unique portfolio number.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Portfolio description.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required bool. Whether the portfolio is available for selection.</td>\n</tr>\n<tr>\n<td><em>portfolioType</em></td>\n<td>Required integer. <code>1</code> Regular, <code>2</code> Collection Account.</td>\n</tr>\n<tr>\n<td><em>originalCreditor</em></td>\n<td>Optional string. Original creditor name (Collection Account).</td>\n</tr>\n<tr>\n<td><em>originalCreditorType</em></td>\n<td>Optional integer. Original creditor category (Collection Account).</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form portfolio notes.</td>\n</tr>\n<tr>\n<td><em>useSecurity</em></td>\n<td>Required bool. Whether the portfolio participates in row-level security.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Guid of the new portfolio (returned as a string).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Portfolio"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"55dc04eb-47ec-4f07-8ab4-1f9718f266f8","name":"AddPortfolio - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"portfolioNumber\": 10,\n    \"description\": \"Primary Portfolio\",\n    \"isActive\": true,\n    \"portfolioType\": 1,\n    \"originalCreditor\": \"\",\n    \"originalCreditorType\": null,\n    \"notes\": \"\",\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Portfolio"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"d4e5f6a7-4444-4555-9666-def012345678\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"351ef5ee-6002-4e95-8dd4-e7cc2e88e002","name":"AddPortfolio - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"portfolioNumber\": 10,\n    \"description\": \"\",\n    \"isActive\": true,\n    \"portfolioType\": 1,\n    \"originalCreditor\": \"\",\n    \"originalCreditorType\": null,\n    \"notes\": \"\",\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Portfolio"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"b1d9459b-e9cf-43d0-b71f-4a76b10e7105"},{"name":"PortfolioGet","id":"4495d1b0-5889-46a0-9425-912af5bd863d","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Portfolio/{{portfolio_number_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-portfolio\">Get Servicing Portfolio</h3>\n<p>Returns a single portfolio resolved by Guid or integer portfolio number. Delegates to <code>PortfolioWSServices.ReturnPortfolioWS</code>, which calls <code>SharedWSServices.GetServicingPortfolioId</code> (first attempts <code>Guid.TryParse</code>; if that fails, parses the segment as an integer and resolves via <code>PortfolioServices.ReturnPortfolioId</code>), then fetches the record via <code>PortfolioServices.ReturnPortfolio</code>.</p>\n<p>Returns <code>\"Portfolio not found\"</code> when neither the Guid nor the number match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Portfolio/{numberOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. <code>Servicing.Portfolio.Id</code> Guid or numeric <code>PortfolioNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingPortfolioEntity</code> with <code>Id</code>, <code>PortfolioNumber</code>, <code>Description</code>, <code>IsActive</code>, <code>PortfolioType</code>, <code>OriginalCreditor</code>, <code>OriginalCreditorType</code>, <code>Notes</code>, <code>UseSecurity</code>, and <code>Ts</code>.</p>\n<p><code>OriginalCreditor</code> / <code>OriginalCreditorType</code> are portfolio defaults for the Metro 2 K1 segment when <code>PortfolioType = 2</code> (Collection Account). Accounts on a Collection Account portfolio can override them via import XML <code>Account/CreditReporting/AccountCreditReporting/OriginalCreditor</code> and <code>OriginalCreditorType</code> (see Single New Account Import). ViewAccount shows the account-level overrides only for Collection Account portfolios.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Portfolio","{{portfolio_number_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c7aec243-dc58-481a-b388-6b82f068414b","name":"GetPortfolio - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Portfolio/{{portfolio_number_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Portfolio","{{portfolio_number_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"d4e5f6a7-4444-4555-9666-def012345678\",\n        \"PortfolioNumber\": 10,\n        \"Description\": \"Primary Portfolio\",\n        \"IsActive\": true,\n        \"PortfolioType\": 1,\n        \"OriginalCreditor\": \"\",\n        \"OriginalCreditorType\": null,\n        \"Notes\": \"\",\n        \"UseSecurity\": false,\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"db97d9ea-e043-4f38-bf8f-4d8784b58c4c","name":"GetPortfolio - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Portfolio/999999?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Portfolio","999999"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Portfolio not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"4495d1b0-5889-46a0-9425-912af5bd863d"},{"name":"PortfolioUpdate","id":"f4e067fa-958a-408e-8172-c07b81ece77c","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"portfolioNumber\": 10,\n    \"description\": \"Primary Portfolio (Updated)\",\n    \"isActive\": true,\n    \"portfolioType\": 1,\n    \"originalCreditor\": \"\",\n    \"originalCreditorType\": null,\n    \"notes\": \"Renamed 2026-04-18.\",\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Portfolio/{{portfolio_number_or_id}}","description":"<h3 id=\"update-servicing-portfolio\">Update Servicing Portfolio</h3>\n<p>Updates an existing portfolio resolved by Guid or integer portfolio number. The controller calls <code>SharedWSServices.GetServicingPortfolioId</code> to resolve the identifier (Guid or numeric <code>PortfolioNumber</code>) and fetches the row via <code>PortfolioServices.ReturnPortfolio</code> to preserve the row's <code>Ts</code>. Returns <code>\"Portfolio not found\"</code> when neither the Guid nor the number match a record for the current client.</p>\n<p>Delegates to <code>PortfolioWSServices.AddSavePortfolioWS</code> with the resolved existing entity.</p>\n<p>See the Add endpoint for the enum value legend for <code>portfolioType</code> and <code>originalCreditorType</code>.</p>\n<p>Portfolio <code>originalCreditor</code> / <code>originalCreditorType</code> apply when <code>portfolioType = 2</code> (Collection Account). Account-level K1 overrides use the import XML nodes documented on Single New Account Import and appear on ViewAccount only for Collection Account portfolios.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Portfolio/{numberOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required string. <code>Servicing.Portfolio.Id</code> Guid or numeric <code>PortfolioNumber</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>portfolioNumber</em></td>\n<td>Required integer. Client-scoped unique portfolio number.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Portfolio description.</td>\n</tr>\n<tr>\n<td><em>isActive</em></td>\n<td>Required bool. Whether the portfolio is available for selection.</td>\n</tr>\n<tr>\n<td><em>portfolioType</em></td>\n<td>Required integer. <code>1</code> Regular, <code>2</code> Collection Account.</td>\n</tr>\n<tr>\n<td><em>originalCreditor</em></td>\n<td>Optional string. Original creditor name (Collection Account).</td>\n</tr>\n<tr>\n<td><em>originalCreditorType</em></td>\n<td>Optional integer. Original creditor category (Collection Account).</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form portfolio notes.</td>\n</tr>\n<tr>\n<td><em>useSecurity</em></td>\n<td>Required bool. Whether the portfolio participates in row-level security.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the Guid of the updated portfolio (returned as a string).</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Portfolio","{{portfolio_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d0e3278c-1dcc-45d8-b152-e94aaaa90047","name":"UpdatePortfolio - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"portfolioNumber\": 10,\n    \"description\": \"Primary Portfolio (Updated)\",\n    \"isActive\": true,\n    \"portfolioType\": 1,\n    \"originalCreditor\": \"\",\n    \"originalCreditorType\": null,\n    \"notes\": \"Renamed 2026-04-18.\",\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Portfolio/{{portfolio_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"d4e5f6a7-4444-4555-9666-def012345678\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"562860c3-a97f-47bd-ae0d-c25d1d543b32","name":"UpdatePortfolio - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"portfolioNumber\": 10,\n    \"description\": \"Primary Portfolio (Updated)\",\n    \"isActive\": true,\n    \"portfolioType\": 1,\n    \"originalCreditor\": \"\",\n    \"originalCreditorType\": null,\n    \"notes\": \"Renamed 2026-04-18.\",\n    \"useSecurity\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Portfolio/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Portfolio not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"f4e067fa-958a-408e-8172-c07b81ece77c"},{"name":"RepoBidStatusAdd","id":"99575c90-fd16-4bf6-bffe-2d8be7f740a0","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Submitted\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus","description":"<h3 id=\"add-servicing-repo-bid-status\">Add Servicing Repo Bid Status</h3>\n<p>Creates a new repossession bid status for the current client. The controller wraps the input in <code>AddSaveRepoBidStatusParameter</code> with <code>id=null</code> and <code>ts=null</code> and delegates to <code>RepoBidStatusWSServices.AddSaveWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoBidStatus</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique repo bid status description.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the bid status is available for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo bid status.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoBidStatus"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"05390a04-abca-4765-83c7-771a8929df2b","name":"AddRepoBidStatus - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Submitted\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-6666-4777-a888-f01234567890\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8f985662-a0a5-40c9-bdc2-69542b9af197","name":"AddRepoBidStatus - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Submitted\",\n    \"isAvailable\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo bid status with this description already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"99575c90-fd16-4bf6-bffe-2d8be7f740a0"},{"name":"RepoBidStatusGet","id":"c9afca4b-3b31-4d98-a791-5422e34c49fe","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{{repo_bid_status_description_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-bid-status\">Get Servicing Repo Bid Status</h3>\n<p>Returns a single repossession bid status resolved by Guid or description. Delegates to <code>RepoBidStatusWSServices.ReturnWS</code>, which resolves the <code>descriptionOrId</code> against <code>Servicing.RepoBidStatus</code> scoped to the authenticated client.</p>\n<p>Returns <code>\"Repo bid status not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoBidStatus.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoBidStatusEntity</code> with <code>Id</code>, <code>Description</code>, <code>IsAvailable</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoBidStatus","{{repo_bid_status_description_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"1c684c09-5678-4048-b894-404d6db0b257","name":"GetRepoBidStatus - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{{repo_bid_status_description_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoBidStatus","{{repo_bid_status_description_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-6666-4777-a888-f01234567890\",\n        \"Description\": \"Submitted\",\n        \"IsAvailable\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"1d80e6a0-588a-4091-9fb5-8a7a057573ae","name":"GetRepoBidStatus - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{{repo_bid_status_description_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoBidStatus","{{repo_bid_status_description_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo bid status not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"c9afca4b-3b31-4d98-a791-5422e34c49fe"},{"name":"RepoBidStatusUpdate","id":"604d4c5d-a9e3-4528-819c-9a5554caf274","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Submitted - Updated\",\n    \"isAvailable\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{{repo_bid_status_description_or_id}}","description":"<h3 id=\"update-servicing-repo-bid-status\">Update Servicing Repo Bid Status</h3>\n<p>Updates an existing repossession bid status, resolved by Guid or description. The controller calls <code>SharedWSServices.GetServicingRepoBidStatusId(descriptionOrId, databaseName, clientId, sessionType, server)</code> to resolve the id, then loads the existing row via <code>RepoBidStatusServices.ReturnBidStatus</code> to preserve <code>Ts</code> for concurrency. Returns <code>\"Repo bid status not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoBidStatusWSServices.AddSaveWS</code> with the resolved <code>id</code> and existing <code>Ts</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoBidStatus.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped repo bid status description.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the bid status is available for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo bid status.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoBidStatus","{{repo_bid_status_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bfe10a40-f937-4835-b9b5-5dc85c627e86","name":"UpdateRepoBidStatus - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Submitted - Updated\",\n    \"isAvailable\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{{repo_bid_status_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-6666-4777-a888-f01234567890\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"51a25cfa-f330-49d2-a8eb-fb39d45ab798","name":"UpdateRepoBidStatus - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Nonexistent Bid Status\",\n    \"isAvailable\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoBidStatus/{{repo_bid_status_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo bid status not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"604d4c5d-a9e3-4528-819c-9a5554caf274"},{"name":"RepoCancelReasonCodeAdd","id":"a867a5dd-1c1e-443e-853a-12cf3a06450d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Requested\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode","description":"<h3 id=\"add-servicing-repo-cancel-reason-code\">Add Servicing Repo Cancel Reason Code</h3>\n<p>Creates a new repossession cancel reason code for the current client. Delegates to <code>RepoCancelReasonCodeWSServices.AddSaveRepoCancelReasonCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another repo cancel reason code with the same <code>description</code> already exists for the client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique cancel reason description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo cancel reason code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCancelReasonCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c4699b77-9c0a-4dbc-9473-37ac4f99ed87","name":"AddRepoCancelReasonCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Requested\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"81c9dc2c-3a52-4122-ae0a-efdd02f0cc19","name":"AddRepoCancelReasonCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Requested\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A repo cancel reason code with this description already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"a867a5dd-1c1e-443e-853a-12cf3a06450d"},{"name":"RepoCancelReasonCodeGet","id":"c7092801-9135-486a-b544-80c1bc8c569d","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{{repo_cancel_reason_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-cancel-reason-code\">Get Servicing Repo Cancel Reason Code</h3>\n<p>Returns a single repossession cancel reason code resolved by Guid or description. Delegates to <code>RepoCancelReasonCodeWSServices.ReturnCancelReasonCodeWS</code>, which first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoCancelReasonCodeServices.ReturnCancelReasonCode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo cancel reason code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.RepoCancelReasonCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoCancelReasonCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCancelReasonCode","{{repo_cancel_reason_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a01783c1-f3a7-4c5e-8ce5-c0ac4799d3c5","name":"GetRepoCancelReasonCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{{repo_cancel_reason_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCancelReasonCode","{{repo_cancel_reason_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"Description\": \"Customer Requested\",\n        \"Active\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"a929392c-a5ec-44bf-95dc-c572c1d2a108","name":"GetRepoCancelReasonCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{{repo_cancel_reason_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCancelReasonCode","{{repo_cancel_reason_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo cancel reason code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"c7092801-9135-486a-b544-80c1bc8c569d"},{"name":"RepoCancelReasonCodesGetAll","id":"21153575-bfcb-425a-985d-5b6a456bfb25","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode?token={{token}}","description":"<h3 id=\"get-all-servicing-repo-cancel-reason-codes\">Get All Servicing Repo Cancel Reason Codes</h3>\n<p>Returns every repossession cancel reason code for the current client. Delegates to <code>RepoCancelReasonCodeWSServices.ReturnAllCancelReasonCodesWS</code>, which reads all rows from <code>Servicing.RepoCancelReasonCode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingRepoCancelReasonCodeEntity</code> records with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCancelReasonCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"239dfb95-0c1b-4924-93bc-9c3c1a883bde","name":"GetAllRepoCancelReasonCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCancelReasonCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"Description\": \"Customer Requested\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        },\n        {\n            \"Id\": \"b2c3d4e5-2222-4333-a444-bcdef0123456\",\n            \"Description\": \"Bankruptcy\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9I=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"a3b1ac18-f328-4042-9505-569fd79e1d0c","name":"GetAllRepoCancelReasonCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCancelReasonCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"21153575-bfcb-425a-985d-5b6a456bfb25"},{"name":"RepoCancelReasonCodeUpdate","id":"637498fa-35b0-4b24-85e5-37360da709f7","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Requested - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{{repo_cancel_reason_code_or_id}}","description":"<h3 id=\"update-servicing-repo-cancel-reason-code\">Update Servicing Repo Cancel Reason Code</h3>\n<p>Updates an existing repossession cancel reason code, resolved by Guid or description. The controller first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it calls <code>RepoCancelReasonCodeServices.ReturnCancelReasonCode(databaseName, clientId, descriptionOrId)</code> to resolve the client-scoped description. Returns <code>\"Repo cancel reason code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoCancelReasonCodeWSServices.AddSaveRepoCancelReasonCodeWS</code> with the resolved <code>id</code> and the existing row's <code>Ts</code> preserved for concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoCancelReasonCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped cancel reason description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo cancel reason code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCancelReasonCode","{{repo_cancel_reason_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0f4a7e44-9b98-465d-b6d4-8226ac7a9d18","name":"UpdateRepoCancelReasonCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Customer Requested - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{{repo_cancel_reason_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"4b5f2fbd-ce5a-49e6-bfb2-440a38d9d023","name":"UpdateRepoCancelReasonCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Nonexistent Reason - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCancelReasonCode/{{repo_cancel_reason_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo cancel reason code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"637498fa-35b0-4b24-85e5-37360da709f7"},{"name":"RepoCauseCodeAdd","id":"581388bb-6372-4472-8fde-f9ef412d88b6","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Vehicle Repossessed\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode","description":"<h3 id=\"add-servicing-repo-cause-code\">Add Servicing Repo Cause Code</h3>\n<p>Creates a new repossession cause code for the current client. Delegates to <code>RepoCauseCodeWSServices.AddSaveRepoCauseCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another repo cause code with the same <code>description</code> already exists for the client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCauseCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique cause code description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo cause code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCauseCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"21db9bcc-22e4-4ee8-a27b-f7f88bf60360","name":"AddRepoCauseCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Vehicle Repossessed\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c3d4e5f6-3333-4444-a555-cdef01234567\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"4217f556-81e4-4d5b-b905-16d4cf2fb02d","name":"AddRepoCauseCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Vehicle Repossessed\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A repo cause code with description 'Vehicle Repossessed' already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"581388bb-6372-4472-8fde-f9ef412d88b6"},{"name":"RepoCauseCodeGet","id":"6a7b66af-166c-443a-a8dd-1609ac5bd0f5","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode/{{repo_cause_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-cause-code\">Get Servicing Repo Cause Code</h3>\n<p>Returns a single repossession cause code resolved by Guid or description. Delegates to <code>RepoCauseCodeWSServices.ReturnCauseReasonCodeWS</code>, which first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoCauseCodeServices.ReturnCauseReasonCode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo cause code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCauseCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.RepoCauseCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoCauseCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCauseCode","{{repo_cause_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e570abdf-1021-457f-a7f2-45179fc07494","name":"GetRepoCauseCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode/{{repo_cause_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCauseCode","{{repo_cause_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c3d4e5f6-3333-4444-a555-cdef01234567\",\n        \"Description\": \"Vehicle Repossessed\",\n        \"Active\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"701e958a-3559-4f3b-8150-fdd9359cfe9d","name":"GetRepoCauseCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode/Nonexistent%20Cause%20Code?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCauseCode","Nonexistent%20Cause%20Code"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo cause code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"6a7b66af-166c-443a-a8dd-1609ac5bd0f5"},{"name":"RepoCauseCodesGetAll","id":"8612d17d-8257-4342-9cc5-f6c02012698e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode?token={{token}}","description":"<h3 id=\"get-all-servicing-repo-cause-codes\">Get All Servicing Repo Cause Codes</h3>\n<p>Returns every repossession cause code for the current client. Delegates to <code>RepoCauseCodeWSServices.ReturnAllCauseReasonCodesWS</code>, which reads all rows from <code>Servicing.RepoCauseCode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCauseCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingRepoCauseCodeEntity</code> records with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCauseCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"d1f0960c-da8d-4415-a744-0ab0120d31ed","name":"GetAllRepoCauseCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCauseCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"c3d4e5f6-3333-4444-a555-cdef01234567\",\n            \"Description\": \"Vehicle Repossessed\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        },\n        {\n            \"Id\": \"d4e5f6a7-4444-4555-a666-def012345678\",\n            \"Description\": \"Voluntary Surrender\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9Q=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"4f42a950-b452-48f7-8503-a23b71f2fee4","name":"GetAllRepoCauseCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoCauseCode"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"8612d17d-8257-4342-9cc5-f6c02012698e"},{"name":"RepoCauseCodeUpdate","id":"89d70581-315d-4582-aa77-fdb5ce4795a0","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Vehicle Repossessed - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode/{{repo_cause_code_or_id}}","description":"<h3 id=\"update-servicing-repo-cause-code\">Update Servicing Repo Cause Code</h3>\n<p>Updates an existing repossession cause code, resolved by Guid or description. The controller first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it calls <code>RepoCauseCodeServices.ReturnCauseReasonCode(databaseName, clientId, descriptionOrId)</code> to resolve the client-scoped description. Returns <code>\"Repo cause code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoCauseCodeWSServices.AddSaveRepoCauseCodeWS</code> with the resolved <code>id</code> and the existing row's <code>Ts</code> preserved for concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoCauseCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoCauseCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped cause code description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo cause code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoCauseCode","{{repo_cause_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"22eb5580-aef9-430f-8591-05984ce6d3a0","name":"UpdateRepoCauseCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Vehicle Repossessed - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode/{{repo_cause_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c3d4e5f6-3333-4444-a555-cdef01234567\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"4e90b154-ff4a-443b-8256-7d836ebb0c3c","name":"UpdateRepoCauseCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Vehicle Repossessed - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoCauseCode/Nonexistent%20Cause%20Code"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo cause code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"89d70581-315d-4582-aa77-fdb5ce4795a0"},{"name":"RepoConditionCodeAdd","id":"cfc75e59-4c0b-4b0a-9043-ffe9f8aab20e","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Good Condition\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode","description":"<h3 id=\"add-servicing-repo-condition-code\">Add Servicing Repo Condition Code</h3>\n<p>Creates a new repossession condition code for the current client. Delegates to <code>RepoConditionCodeWSServices.AddSaveRepoConditionCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another repo condition code with the same <code>description</code> already exists for the client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoConditionCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique condition code description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo condition code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoConditionCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d4dfdb47-186e-4453-9617-94c9c9a504e4","name":"AddRepoConditionCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Good Condition\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e5f6a7b8-5555-4666-a777-ef0123456789\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"1e10b445-d864-41f4-98b2-52120fa9272a","name":"AddRepoConditionCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Good Condition\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A repo condition code with description 'Good Condition' already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"cfc75e59-4c0b-4b0a-9043-ffe9f8aab20e"},{"name":"RepoConditionCodeGet","id":"54e59d77-bc0b-4a7c-b9e3-40bc3b5ef90d","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode/{{repo_condition_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-condition-code\">Get Servicing Repo Condition Code</h3>\n<p>Returns a single repossession condition code resolved by Guid or description. Delegates to <code>RepoConditionCodeWSServices.ReturnConditionCodeWS</code>, which first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoConditionCodeServices.ReturnConditionCode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo condition code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoConditionCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.RepoConditionCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoConditionCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoConditionCode","{{repo_condition_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"96f8f88d-a665-4618-9df9-5e1b8ea41ce8","name":"GetRepoConditionCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode/{{repo_condition_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoConditionCode","{{repo_condition_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e5f6a7b8-5555-4666-a777-ef0123456789\",\n        \"Description\": \"Good Condition\",\n        \"Active\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9Q=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"fd519978-d36d-4ae5-a0dc-022931cd43ba","name":"GetRepoConditionCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode/Nonexistent%20Condition%20Code?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoConditionCode","Nonexistent%20Condition%20Code"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo condition code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"54e59d77-bc0b-4a7c-b9e3-40bc3b5ef90d"},{"name":"RepoConditionCodesGetAll","id":"06911d5b-f99a-45a5-8e1a-1667d5b5357c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode?token={{token}}","description":"<h3 id=\"get-all-servicing-repo-condition-codes\">Get All Servicing Repo Condition Codes</h3>\n<p>Returns all repossession condition codes for the current client. Delegates to <code>RepoConditionCodeWSServices.ReturnAllConditionCodesWS(databaseName, clientId)</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoConditionCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>MyServicingRepoConditionCodeEntity</code> objects with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoConditionCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"59ef3312-6c98-446e-a3fd-41320dea9cb3","name":"GetAllRepoConditionCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoConditionCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"e5f6a7b8-5555-4666-a777-ef0123456789\",\n            \"Description\": \"Good Condition\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9Q=\"\n        },\n        {\n            \"Id\": \"f6a7b8c9-6666-4777-a888-f01234567890\",\n            \"Description\": \"Poor Condition\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"2937c5b6-9a30-4b2f-8215-66e843fea244","name":"GetAllRepoConditionCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoConditionCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"06911d5b-f99a-45a5-8e1a-1667d5b5357c"},{"name":"RepoConditionCodeUpdate","id":"a9ddd4d0-122f-4b01-b344-5a38ea8730e3","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Good Condition - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode/{{repo_condition_code_or_id}}","description":"<h3 id=\"update-servicing-repo-condition-code\">Update Servicing Repo Condition Code</h3>\n<p>Updates an existing repossession condition code, resolved by Guid or description. The controller first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it calls <code>RepoConditionCodeServices.ReturnConditionCode(databaseName, clientId, descriptionOrId)</code> to resolve the client-scoped description. Returns <code>\"Repo condition code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoConditionCodeWSServices.AddSaveRepoConditionCodeWS</code> with the resolved <code>id</code> and the existing row's <code>Ts</code> preserved for concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoConditionCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoConditionCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped condition code description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo condition code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoConditionCode","{{repo_condition_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8dff8d9d-34e4-4849-937a-330efad9fb7b","name":"UpdateRepoConditionCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Good Condition - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode/{{repo_condition_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e5f6a7b8-5555-4666-a777-ef0123456789\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"b7ee4f58-05c4-4820-9cb9-a810c7ed0eeb","name":"UpdateRepoConditionCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Nonexistent Condition - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoConditionCode/{{repo_condition_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo condition code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"a9ddd4d0-122f-4b01-b344-5a38ea8730e3"},{"name":"RepoHoldReasonCodeAdd","id":"d389a268-a57b-43a8-a6f0-82c9992382f5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Pending Investigation\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode","description":"<h3 id=\"add-servicing-repo-hold-reason-code\">Add Servicing Repo Hold Reason Code</h3>\n<p>Creates a new repossession hold reason code for the current client. Delegates to <code>RepoHoldReasonCodeWSServices.AddSaveRepoHoldReasonCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another repo hold reason code with the same <code>description</code> already exists for the client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique hold reason code description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo hold reason code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoHoldReasonCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"721fbfc7-abdb-41c9-a342-b769585cd678","name":"AddRepoHoldReasonCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Pending Investigation\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a7b8c9d0-7777-4888-a999-012345678901\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"a33b0d24-62bb-4cd9-b4bb-5ed17ecb684e","name":"AddRepoHoldReasonCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Pending Investigation\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo hold reason code with this description already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"d389a268-a57b-43a8-a6f0-82c9992382f5"},{"name":"RepoHoldReasonCodeGet","id":"396974b7-b2ae-4863-8e81-843640fcecbd","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{{repo_hold_reason_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-hold-reason-code\">Get Servicing Repo Hold Reason Code</h3>\n<p>Returns a single repossession hold reason code resolved by Guid or description. Delegates to <code>RepoHoldReasonCodeWSServices.ReturnHoldReasonCodeWS</code>, which first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoHoldReasonCodeServices.ReturnHoldReasonCode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo hold reason code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.RepoHoldReasonCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoHoldReasonCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoHoldReasonCode","{{repo_hold_reason_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7ac7a591-1ec9-490b-b84c-dd8ab22f50ce","name":"GetRepoHoldReasonCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{{repo_hold_reason_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoHoldReasonCode","{{repo_hold_reason_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a7b8c9d0-7777-4888-a999-012345678901\",\n        \"Description\": \"Pending Investigation\",\n        \"Active\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9Y=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"1de1b3f9-473b-41f4-b2f0-ca1e2d0442d1","name":"GetRepoHoldReasonCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{{repo_hold_reason_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoHoldReasonCode","{{repo_hold_reason_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo hold reason code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"396974b7-b2ae-4863-8e81-843640fcecbd"},{"name":"RepoHoldReasonCodesGetAll","id":"aacb834d-207c-41a1-ad80-6ea14b1e045e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode?token={{token}}","description":"<h3 id=\"get-all-servicing-repo-hold-reason-codes\">Get All Servicing Repo Hold Reason Codes</h3>\n<p>Returns all repossession hold reason codes for the current client. Delegates to <code>RepoHoldReasonCodeWSServices.ReturnAllHoldReasonCodesWS(databaseName, clientId)</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of <code>MyServicingRepoHoldReasonCodeEntity</code> objects with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoHoldReasonCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"308b1e92-2274-4146-9eb7-3c293cb3fcb1","name":"GetAllRepoHoldReasonCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoHoldReasonCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a7b8c9d0-7777-4888-a999-012345678901\",\n            \"Description\": \"Pending Investigation\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9Y=\"\n        },\n        {\n            \"Id\": \"b8c9d0e1-8888-4999-aaaa-123456789012\",\n            \"Description\": \"Awaiting Documentation\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9Z=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"465057ab-8394-4a1b-af8b-3803665d075d","name":"GetAllRepoHoldReasonCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoHoldReasonCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"aacb834d-207c-41a1-ad80-6ea14b1e045e"},{"name":"RepoHoldReasonCodeUpdate","id":"175e85d2-648c-46c2-9baa-2da059582420","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Pending Investigation - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{{repo_hold_reason_code_or_id}}","description":"<h3 id=\"update-servicing-repo-hold-reason-code\">Update Servicing Repo Hold Reason Code</h3>\n<p>Updates an existing repossession hold reason code, resolved by Guid or description. The controller first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it calls <code>RepoHoldReasonCodeServices.ReturnHoldReasonCode(databaseName, clientId, descriptionOrId)</code> to resolve the client-scoped description. Returns <code>\"Repo hold reason code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoHoldReasonCodeWSServices.AddSaveRepoHoldReasonCodeWS</code> with the resolved <code>id</code> and the existing row's <code>Ts</code> preserved for concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoHoldReasonCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped hold reason code description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo hold reason code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoHoldReasonCode","{{repo_hold_reason_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"64d3a46d-d304-4dc6-9798-43d63163dd79","name":"UpdateRepoHoldReasonCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Pending Investigation - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{{repo_hold_reason_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a7b8c9d0-7777-4888-a999-012345678901\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"a5ad015c-1aa0-4178-8847-b531448acc61","name":"UpdateRepoHoldReasonCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Nonexistent Reason - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoHoldReasonCode/{{repo_hold_reason_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo hold reason code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"175e85d2-648c-46c2-9baa-2da059582420"},{"name":"RepoModeAdd","id":"4246ce01-961e-43e8-a697-9e5ef517ea43","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Standard Repo\",\n    \"modeType\": 1,\n    \"repoStatusCodeOrId\": \"In Progress\",\n    \"adminStatusCodeOrId\": \"Active\",\n    \"showAgentControl\": true,\n    \"showLocationControl\": true,\n    \"showCollateralControl\": true,\n    \"showCustomFieldsControl\": false,\n    \"allowHold\": true,\n    \"allowCancel\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoMode","description":"<h3 id=\"add-servicing-repo-mode\">Add Servicing Repo Mode</h3>\n<p>Creates a new repossession mode for the current client. Delegates to <code>RepoModeWSServices.AddSaveRepoModeWS</code> with <code>existingRepoMode=null</code>. The <code>modeType</code> integer maps to <code>Omega.Servicing.Types.Enums.RepoModeTypes</code> (cast inside the WS service). The <code>repoStatusCodeOrId</code> and <code>adminStatusCodeOrId</code> accept either a description or a Guid and are resolved to internal ids.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoMode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique repo mode description.</td>\n</tr>\n<tr>\n<td><em>modeType</em></td>\n<td>Required int. Maps to <code>Omega.Servicing.Types.Enums.RepoModeTypes</code>.</td>\n</tr>\n<tr>\n<td><em>repoStatusCodeOrId</em></td>\n<td>Optional string. <code>Servicing.RepoStatusCode.Description</code> or <code>Id</code> Guid.</td>\n</tr>\n<tr>\n<td><em>adminStatusCodeOrId</em></td>\n<td>Optional string. <code>Servicing.AdminStatus.Description</code> or <code>Id</code> Guid.</td>\n</tr>\n<tr>\n<td><em>showAgentControl</em></td>\n<td>Required bool. Whether the agent control is displayed.</td>\n</tr>\n<tr>\n<td><em>showLocationControl</em></td>\n<td>Required bool. Whether the location control is displayed.</td>\n</tr>\n<tr>\n<td><em>showCollateralControl</em></td>\n<td>Required bool. Whether the collateral control is displayed.</td>\n</tr>\n<tr>\n<td><em>showCustomFieldsControl</em></td>\n<td>Required bool. Whether the custom fields control is displayed.</td>\n</tr>\n<tr>\n<td><em>allowHold</em></td>\n<td>Required bool. Whether the hold action is allowed.</td>\n</tr>\n<tr>\n<td><em>allowCancel</em></td>\n<td>Required bool. Whether the cancel action is allowed.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo mode.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoMode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"575873c3-d598-4fcb-8e5d-a742c3d6cd5e","name":"AddRepoMode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"\",\n    \"modeType\": 1,\n    \"repoStatusCodeOrId\": \"In Progress\",\n    \"adminStatusCodeOrId\": \"Active\",\n    \"showAgentControl\": true,\n    \"showLocationControl\": true,\n    \"showCollateralControl\": true,\n    \"showCustomFieldsControl\": false,\n    \"allowHold\": true,\n    \"allowCancel\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoMode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": []\n}"},{"id":"aa07afe9-23cd-4022-9c15-80f5b1ce7bdb","name":"AddRepoMode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Standard Repo\",\n    \"modeType\": 1,\n    \"repoStatusCodeOrId\": \"In Progress\",\n    \"adminStatusCodeOrId\": \"Active\",\n    \"showAgentControl\": true,\n    \"showLocationControl\": true,\n    \"showCollateralControl\": true,\n    \"showCustomFieldsControl\": false,\n    \"allowHold\": true,\n    \"allowCancel\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoMode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-3333-4444-a555-cdef01234567\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"4246ce01-961e-43e8-a697-9e5ef517ea43"},{"name":"RepoModeGet","id":"43c38122-8a6f-4292-b5bf-03f8656cc9de","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoMode/{{repo_mode_description_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-mode\">Get Servicing Repo Mode</h3>\n<p>Returns a single repossession mode resolved by Guid or description. Delegates to <code>RepoModeWSServices.ReturnRepoModeWS</code>, which first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoModeServices.ReturnRepoMode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo mode not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoMode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoMode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoModeEntity</code> with <code>Id</code>, <code>Description</code>, <code>ModeType</code>, <code>RepoStatusCodeId</code>, <code>AdminStatusId</code>, <code>ShowAgentControl</code>, <code>ShowLocationControl</code>, <code>ShowCollateralControl</code>, <code>ShowCustomFieldsControl</code>, <code>AllowHold</code>, <code>AllowCancel</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoMode","{{repo_mode_description_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"de323971-7e03-48e7-a6d4-4fab5f867ae1","name":"GetRepoMode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoMode/Nonexistent Repo Mode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoMode","Nonexistent Repo Mode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo mode not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"d9ac2669-b327-4539-9418-5a6390936c0c","name":"GetRepoMode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoMode/{{repo_mode_description_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoMode","{{repo_mode_description_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-3333-4444-a555-cdef01234567\",\n        \"Description\": \"Standard Repo\",\n        \"ModeType\": 1,\n        \"RepoStatusCodeId\": \"d1e2f3a4-4444-4555-a666-def012345678\",\n        \"AdminStatusId\": \"e1f2a3b4-5555-4666-a777-ef0123456789\",\n        \"ShowAgentControl\": true,\n        \"ShowLocationControl\": true,\n        \"ShowCollateralControl\": true,\n        \"ShowCustomFieldsControl\": false,\n        \"AllowHold\": true,\n        \"AllowCancel\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"43c38122-8a6f-4292-b5bf-03f8656cc9de"},{"name":"RepoModesGetAll","id":"4e44abed-b232-4410-9e58-ddeed45b1456","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoMode?token={{token}}","description":"<h3 id=\"get-all-servicing-repo-modes\">Get All Servicing Repo Modes</h3>\n<p>Returns every repossession mode for the current client. Delegates to <code>RepoModeWSServices.ReturnAllRepoModesWS</code>, which reads all rows from <code>Servicing.RepoMode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoMode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingRepoModeEntity</code> records with <code>Id</code>, <code>Description</code>, <code>ModeType</code>, <code>RepoStatusCodeId</code>, <code>AdminStatusId</code>, <code>ShowAgentControl</code>, <code>ShowLocationControl</code>, <code>ShowCollateralControl</code>, <code>ShowCustomFieldsControl</code>, <code>AllowHold</code>, <code>AllowCancel</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoMode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"5a98da96-e72a-491a-a996-d70e6280c5bb","name":"GetAllRepoModes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoMode?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoMode"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving repo modes: Authentication failed\"\n    ],\n    \"warnings\": []\n}"},{"id":"97375cb5-d114-4e9f-8acc-4151318efa3d","name":"GetAllRepoModes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoMode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoMode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"c1d2e3f4-3333-4444-a555-cdef01234567\",\n            \"Description\": \"Standard Repo\",\n            \"ModeType\": 1,\n            \"RepoStatusCodeId\": \"d1e2f3a4-4444-4555-a666-def012345678\",\n            \"AdminStatusId\": \"e1f2a3b4-5555-4666-a777-ef0123456789\",\n            \"ShowAgentControl\": true,\n            \"ShowLocationControl\": true,\n            \"ShowCollateralControl\": true,\n            \"ShowCustomFieldsControl\": false,\n            \"AllowHold\": true,\n            \"AllowCancel\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"4e44abed-b232-4410-9e58-ddeed45b1456"},{"name":"RepoModeUpdate","id":"2bd433cf-7803-49a7-840c-960439f43b51","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Standard Repo - Updated\",\n    \"modeType\": 1,\n    \"repoStatusCodeOrId\": \"In Progress\",\n    \"adminStatusCodeOrId\": \"Active\",\n    \"showAgentControl\": true,\n    \"showLocationControl\": true,\n    \"showCollateralControl\": true,\n    \"showCustomFieldsControl\": true,\n    \"allowHold\": false,\n    \"allowCancel\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoMode/{{repo_mode_description_or_id}}","description":"<h3 id=\"update-servicing-repo-mode\">Update Servicing Repo Mode</h3>\n<p>Updates an existing repossession mode, resolved by Guid or description. The controller first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it calls <code>RepoModeServices.ReturnRepoMode(databaseName, clientId, descriptionOrId)</code> to resolve the client-scoped description. Returns <code>\"Repo mode not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoModeWSServices.AddSaveRepoModeWS</code> with the existing row passed for <code>Ts</code> concurrency preservation.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoMode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoMode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped repo mode description.</td>\n</tr>\n<tr>\n<td><em>modeType</em></td>\n<td>Required int. Maps to <code>Omega.Servicing.Types.Enums.RepoModeTypes</code>.</td>\n</tr>\n<tr>\n<td><em>repoStatusCodeOrId</em></td>\n<td>Optional string. <code>Servicing.RepoStatusCode.Description</code> or <code>Id</code> Guid.</td>\n</tr>\n<tr>\n<td><em>adminStatusCodeOrId</em></td>\n<td>Optional string. <code>Servicing.AdminStatus.Description</code> or <code>Id</code> Guid.</td>\n</tr>\n<tr>\n<td><em>showAgentControl</em></td>\n<td>Required bool. Whether the agent control is displayed.</td>\n</tr>\n<tr>\n<td><em>showLocationControl</em></td>\n<td>Required bool. Whether the location control is displayed.</td>\n</tr>\n<tr>\n<td><em>showCollateralControl</em></td>\n<td>Required bool. Whether the collateral control is displayed.</td>\n</tr>\n<tr>\n<td><em>showCustomFieldsControl</em></td>\n<td>Required bool. Whether the custom fields control is displayed.</td>\n</tr>\n<tr>\n<td><em>allowHold</em></td>\n<td>Required bool. Whether the hold action is allowed.</td>\n</tr>\n<tr>\n<td><em>allowCancel</em></td>\n<td>Required bool. Whether the cancel action is allowed.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo mode.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoMode","{{repo_mode_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9d56f012-262f-48d9-afee-b7f6fb6ed098","name":"UpdateRepoMode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Standard Repo - Updated\",\n    \"modeType\": 1,\n    \"repoStatusCodeOrId\": \"In Progress\",\n    \"adminStatusCodeOrId\": \"Active\",\n    \"showAgentControl\": true,\n    \"showLocationControl\": true,\n    \"showCollateralControl\": true,\n    \"showCustomFieldsControl\": true,\n    \"allowHold\": false,\n    \"allowCancel\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoMode/Nonexistent Repo Mode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo mode not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"67e9e112-fb0a-45e0-afaa-a51416f57ece","name":"UpdateRepoMode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Standard Repo - Updated\",\n    \"modeType\": 1,\n    \"repoStatusCodeOrId\": \"In Progress\",\n    \"adminStatusCodeOrId\": \"Active\",\n    \"showAgentControl\": true,\n    \"showLocationControl\": true,\n    \"showCollateralControl\": true,\n    \"showCustomFieldsControl\": true,\n    \"allowHold\": false,\n    \"allowCancel\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoMode/{{repo_mode_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-3333-4444-a555-cdef01234567\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"2bd433cf-7803-49a7-840c-960439f43b51"},{"name":"RepoReasonCodeAdd","id":"7144a2c6-7f13-4938-aa73-55681fdb1172","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Default on Payment\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode","description":"<h3 id=\"add-servicing-repo-reason-code\">Add Servicing Repo Reason Code</h3>\n<p>Creates a new repossession reason code for the current client. The controller wraps the input in <code>AddSaveRepoReasonCodeParameter</code> with <code>id=null</code> and <code>ts=null</code> and delegates to <code>RepoReasonCodeWSServices.AddSaveRepoReasonCodeWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoReasonCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique repo reason description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo reason code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoReasonCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"05d7c6af-281c-461c-95c8-71f80b3d6027","name":"AddRepoReasonCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Default on Payment\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo reason code with this description already exists\"\n    ],\n    \"warnings\": []\n}"},{"id":"0a5e17c9-80b3-4eeb-99e5-fbb154b74660","name":"AddRepoReasonCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Default on Payment\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b3c4d5e6-8888-4999-aaaa-123456789abc\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"7144a2c6-7f13-4938-aa73-55681fdb1172"},{"name":"RepoReasonCodeGet","id":"cb0c8a8e-d07d-411a-b2cb-b5911cda4eee","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode/{{repo_reason_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-reason-code\">Get Servicing Repo Reason Code</h3>\n<p>Returns a single repossession reason code resolved by Guid or description. Delegates to <code>RepoReasonCodeWSServices.ReturnReasonCodeWS</code>, which first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoReasonCodeServices.ReturnReasonCode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo reason code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoReasonCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.RepoReasonCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoReasonCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoReasonCode","{{repo_reason_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ef4d268f-595f-4f9e-acf0-0f2d0a0d82f9","name":"GetRepoReasonCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode/Nonexistent Reason Code?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoReasonCode","Nonexistent Reason Code"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo reason code not found\"\n    ],\n    \"warnings\": []\n}"},{"id":"d6a8171e-47f2-4a3e-a144-1bd1c31c6ad8","name":"GetRepoReasonCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode/{{repo_reason_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoReasonCode","{{repo_reason_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b3c4d5e6-8888-4999-aaaa-123456789abc\",\n        \"Description\": \"Default on Payment\",\n        \"Active\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"cb0c8a8e-d07d-411a-b2cb-b5911cda4eee"},{"name":"RepoReasonCodesGetAll","id":"1098510b-f882-447d-be7a-e7a9bad4b8f2","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode?token={{token}}","description":"<h3 id=\"get-all-servicing-repo-reason-codes\">Get All Servicing Repo Reason Codes</h3>\n<p>Returns every repossession reason code for the current client. Delegates to <code>RepoReasonCodeWSServices.ReturnAllReasonCodesWS</code>, which reads all rows from <code>Servicing.RepoReasonCode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoReasonCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingRepoReasonCodeEntity</code> records with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoReasonCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"316d35bf-df24-4009-8dfe-f3d1c83c5155","name":"GetAllRepoReasonCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoReasonCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"b3c4d5e6-8888-4999-aaaa-123456789abc\",\n            \"Description\": \"Default on Payment\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9E=\"\n        },\n        {\n            \"Id\": \"c4d5e6f7-9999-4aaa-abbb-23456789abcd\",\n            \"Description\": \"Fraud\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9I=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"05765390-b956-4eb4-9210-1cb7ccb87cbf","name":"GetAllRepoReasonCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoReasonCode"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid or expired token\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"1098510b-f882-447d-be7a-e7a9bad4b8f2"},{"name":"RepoReasonCodeUpdate","id":"9f88bce0-f904-4ac1-be83-5a1f4b286e5c","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Default on Payment - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode/{{repo_reason_code_description_or_id}}","description":"<h3 id=\"update-servicing-repo-reason-code\">Update Servicing Repo Reason Code</h3>\n<p>Updates an existing repossession reason code, resolved by Guid or description. The controller first attempts <code>Guid.TryParse(descriptionOrId)</code>; if that fails it calls <code>RepoReasonCodeServices.ReturnReasonCode(databaseName, clientId, descriptionOrId)</code> to resolve the client-scoped description. Returns <code>\"Repo reason code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoReasonCodeWSServices.AddSaveRepoReasonCodeWS</code> with the resolved <code>id</code> and existing <code>Ts</code> preserved for concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoReasonCode/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoReasonCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped repo reason description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the code is active for selection.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo reason code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoReasonCode","{{repo_reason_code_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"36488b2c-e895-47da-8307-523556032364","name":"UpdateRepoReasonCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Default on Payment - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode/{{repo_reason_code_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b3c4d5e6-8888-4999-aaaa-123456789abc\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"73711b89-9fc4-4e01-8879-9265b1d8f2da","name":"UpdateRepoReasonCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Nonexistent Reason Code\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoReasonCode/{{repo_reason_code_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo reason code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"9f88bce0-f904-4ac1-be83-5a1f4b286e5c"},{"name":"RepoRedemptionOptionAdd","id":"4225696f-d7c6-4c68-b9e9-4d90af1ce1da","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Full Redemption\",\n    \"isAvailable\": true,\n    \"canRedeem\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption","description":"<h3 id=\"add-servicing-repo-redemption-option\">Add Servicing Repo Redemption Option</h3>\n<p>Creates a new repossession redemption option for the current client. The controller wraps the input in <code>AddSaveRepoRedemptionOptionParameter</code> with <code>id=null</code> and <code>ts=null</code> and delegates to <code>RepoRedemptionOptionWSServices.AddSaveWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped unique redemption option description.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the redemption option is available for selection.</td>\n</tr>\n<tr>\n<td><em>canRedeem</em></td>\n<td>Required bool. Whether the option allows redemption.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new repo redemption option.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoRedemptionOption"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9da64685-f024-48fa-8e09-988e21bf8149","name":"AddRepoRedemptionOption - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Full Redemption\",\n    \"isAvailable\": true,\n    \"canRedeem\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2b3c4d5-7777-4888-a999-012345678abc\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"25d76994-7abe-43c6-a870-dded77a2aa70","name":"AddRepoRedemptionOption - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"\",\n    \"isAvailable\": true,\n    \"canRedeem\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"4225696f-d7c6-4c68-b9e9-4d90af1ce1da"},{"name":"RepoRedemptionOptionGet","id":"e077ec14-4f8d-4c82-a486-1314c1288e15","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/{{repo_redemption_option_description_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-redemption-option\">Get Servicing Repo Redemption Option</h3>\n<p>Returns a single repossession redemption option resolved by Guid or description. Delegates to <code>RepoRedemptionOptionWSServices.ReturnWS</code>, which resolves the <code>descriptionOrId</code> against <code>Servicing.RepoRedemptionOption</code> scoped to the authenticated client.</p>\n<p>Returns <code>\"Repo redemption option not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoRedemptionOption.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoRedemptionOptionEntity</code> with <code>Id</code>, <code>Description</code>, <code>IsAvailable</code>, <code>CanRedeem</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoRedemptionOption","{{repo_redemption_option_description_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"475889d9-5b67-4348-a755-91098aaec6be","name":"GetRepoRedemptionOption - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/{{repo_redemption_option_description_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoRedemptionOption","{{repo_redemption_option_description_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2b3c4d5-7777-4888-a999-012345678abc\",\n        \"Description\": \"Full Redemption\",\n        \"IsAvailable\": true,\n        \"CanRedeem\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9E=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"bbc30241-f57a-4e66-9ac5-f3ec9a295d8f","name":"GetRepoRedemptionOption - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/Nonexistent%20Option?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoRedemptionOption","Nonexistent%20Option"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo redemption option not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"e077ec14-4f8d-4c82-a486-1314c1288e15"},{"name":"RepoRedemptionOptionUpdate","id":"7a2cc838-e343-4a37-80e3-13c9eb74f3f0","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Full Redemption - Updated\",\n    \"isAvailable\": false,\n    \"canRedeem\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/{{repo_redemption_option_description_or_id}}","description":"<h3 id=\"update-servicing-repo-redemption-option\">Update Servicing Repo Redemption Option</h3>\n<p>Updates an existing repossession redemption option, resolved by Guid or description. The controller calls <code>SharedWSServices.GetServicingRepoRedemptionOptionId(descriptionOrId, databaseName, clientId, sessionType, server)</code> to resolve the id, then loads the existing row via <code>RepoRedemptionOptionServices.ReturnRedemptionOption</code> to preserve <code>Ts</code> for concurrency. Returns <code>\"Repo redemption option not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p>Delegates to <code>RepoRedemptionOptionWSServices.AddSaveWS</code> with the resolved <code>id</code> and existing <code>Ts</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/{descriptionOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>descriptionOrId</em></td>\n<td>Required string. <code>Servicing.RepoRedemptionOption.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Client-scoped redemption option description.</td>\n</tr>\n<tr>\n<td><em>isAvailable</em></td>\n<td>Required bool. Whether the redemption option is available for selection.</td>\n</tr>\n<tr>\n<td><em>canRedeem</em></td>\n<td>Required bool. Whether the option allows redemption.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated repo redemption option.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoRedemptionOption","{{repo_redemption_option_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"b89054c5-e052-4aa7-bc31-ef0d9cf1af82","name":"UpdateRepoRedemptionOption - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Full Redemption - Updated\",\n    \"isAvailable\": false,\n    \"canRedeem\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/{{repo_redemption_option_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2b3c4d5-7777-4888-a999-012345678abc\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"b4820b6f-23f1-464c-8509-6968e2990436","name":"UpdateRepoRedemptionOption - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Nonexistent Option - Updated\",\n    \"isAvailable\": false,\n    \"canRedeem\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoRedemptionOption/Nonexistent%20Option"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo redemption option not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"7a2cc838-e343-4a37-80e3-13c9eb74f3f0"},{"name":"RepoStatusCodeAdd","id":"c90a0ad6-2967-48d2-a406-8ac6030b363b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Recovered\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode","description":"<h3 id=\"add-servicing-repo-status-code\">Add Servicing Repo Status Code</h3>\n<p>Creates a new repossession status code for the current client. Delegates to <code>RepoStatusCodeWSServices.AddRepoStatusCodeWS</code>, which inserts a new <code>Servicing.RepoStatusCode</code> row scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoStatusCode</code></p>\n<h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Repo status code description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Optional boolean. Indicates whether the code is active. Defaults to <code>true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the new <code>Id</code> of the created repo status code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoStatusCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"cd4d9718-8886-406d-8728-870152a568eb","name":"AddRepoStatusCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Recovered\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"d5e6f7a8-aaaa-4bbb-accc-3456789abcde\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"f276ce02-cd12-41cc-8304-236fb28dfde0","name":"AddRepoStatusCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"\",\n    \"active\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Description is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"c90a0ad6-2967-48d2-a406-8ac6030b363b"},{"name":"RepoStatusCodeGet","id":"f911907b-782f-4250-bf50-502357fc0a1e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode/{{repo_status_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-repo-status-code\">Get Servicing Repo Status Code</h3>\n<p>Returns a single repossession status code resolved by Guid or description. Delegates to <code>RepoStatusCodeWSServices.ReturnRepoStatusCodeWS</code>, which first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoStatusCodeServices.ReturnRepoStatusCode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo status code not found\"</code> when neither the Guid nor the description match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoStatusCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.RepoStatusCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingRepoStatusCodeEntity</code> with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoStatusCode","{{repo_status_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"cdfb301f-0b8e-4d89-b22e-f99b6e0f4295","name":"GetRepoStatusCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode/{{repo_status_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoStatusCode","{{repo_status_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"d5e6f7a8-aaaa-4bbb-accc-3456789abcde\",\n        \"Description\": \"Recovered\",\n        \"Active\": true,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"3eb715f6-a8d3-4254-9912-46347e05b605","name":"GetRepoStatusCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoStatusCode","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo status code not found\"\n    ]\n}"}],"_postman_id":"f911907b-782f-4250-bf50-502357fc0a1e"},{"name":"RepoStatusCodesGetAll","id":"bfae3dce-ce19-4356-b2c1-4312813661b5","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode?token={{token}}","description":"<h3 id=\"get-all-servicing-repo-status-codes\">Get All Servicing Repo Status Codes</h3>\n<p>Returns every repossession status code for the current client. Delegates to <code>RepoStatusCodeWSServices.ReturnAllRepoStatusCodesWS</code>, which reads all rows from <code>Servicing.RepoStatusCode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoStatusCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingRepoStatusCodeEntity</code> records with <code>Id</code>, <code>Description</code>, <code>Active</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoStatusCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"bbfc1067-0966-4cb9-9db5-1b8b51c44a97","name":"GetAllRepoStatusCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoStatusCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"d5e6f7a8-aaaa-4bbb-accc-3456789abcde\",\n            \"Description\": \"Recovered\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        },\n        {\n            \"Id\": \"e6f7a8b9-bbbb-4ccc-addd-456789abcdef\",\n            \"Description\": \"Sold at Auction\",\n            \"Active\": true,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9Q=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"ded7c26e-b743-45ef-b7a2-352d28c32f9f","name":"GetAllRepoStatusCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","RepoStatusCode"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ]\n}"}],"_postman_id":"bfae3dce-ce19-4356-b2c1-4312813661b5"},{"name":"RepoStatusCodeUpdate","id":"06343b7c-1a2e-462a-a4f2-f17601069106","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Recovered - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode/{{repo_status_code_description_or_id}}","description":"<h3 id=\"update-servicing-repo-status-code\">Update Servicing Repo Status Code</h3>\n<p>Updates an existing repossession status code for the current client. The controller first resolves the route value by calling <code>Guid.TryParse(codeOrId)</code>; if that fails it looks up the record by description scoped to the current client via <code>RepoStatusCodeServices.ReturnRepoStatusCode(databaseName, clientId, description)</code>.</p>\n<p>Returns <code>\"Repo status code not found\"</code> when neither the Guid nor the description match a record for the current client. The <code>Ts</code> byte[] timestamp is preserved from the existing record for optimistic concurrency.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepoStatusCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.RepoStatusCode.Id</code> Guid or <code>Description</code> text.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string. New description.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Optional boolean. Indicates whether the code is active.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the <code>Id</code> of the updated repo status code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepoStatusCode","{{repo_status_code_description_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a937322b-b757-4a32-befd-730b799f3566","name":"UpdateRepoStatusCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Recovered - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode/{{repo_status_code_description_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"d5e6f7a8-aaaa-4bbb-accc-3456789abcde\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"51f0bcea-d0d5-460c-b8ef-570950d9845f","name":"UpdateRepoStatusCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"description\": \"Recovered - Updated\",\n    \"active\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepoStatusCode/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Repo status code not found\"\n    ]\n}"}],"_postman_id":"06343b7c-1a2e-462a-a4f2-f17601069106"},{"name":"RepurchaseBatchesCancel","id":"a6aabdf7-fadd-42c4-aebb-52a0ed3a088f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"batchNumbersOrIds\": [\n    \"12\",\n    \"13\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/Cancel","description":"<h3 id=\"cancel-repurchase-batches\">Cancel Repurchase Batches</h3>\n<p>Cancels one or more open repurchase batches selected by batch number or exact batch GUID. A running\nbatch finishes the account it is currently processing, then stops and reports\nthe rest as <code>Skipped</code> (cancelled); a pending/orphaned batch is cancelled\noutright. Permission-gated like <strong>Start Repurchase Batch</strong>. Delegates to\n<code>RepurchaseWSServices.CancelRepurchaseBatchesWS</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Repurchase/Cancel</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>batchNumbers</em></td>\n<td>Legacy numeric array. Supply this or <code>batchNumbersOrIds</code>, never both.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object: <code>requested</code>, <code>cancelling</code>, <code>cancelled</code>,\n<code>alreadyComplete</code>, <code>notFound</code>, and <code>batches</code> — each with <code>batchNumber</code> and\n<code>result</code> (Cancelling / Cancelled / AlreadyComplete / NotFound).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>batchNumbersOrIds</code></td>\n<td><code>batchNumbers</code></td>\n<td>Array of strings. Each entry: repurchase or reversal batch number or batch GUID.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. The new <code>batchNumbersOrIds</code> list requires unique numbers and uses a GUID to select an exact batch. Legacy <code>batchNumbers</code> keeps its existing behavior of cancelling matching open batches even when a number is duplicated.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"batchNumbersOrIds\": [\n    \"12\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Repurchase","Cancel"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"251c4b9d-f8c6-45ab-bd10-2d91348cbc9f","name":"CancelRepurchaseBatches - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"batchNumbersOrIds\": [\n    \"12\",\n    \"13\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/Cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"requested\": 2,\n        \"cancelling\": 1,\n        \"cancelled\": 1,\n        \"alreadyComplete\": 0,\n        \"notFound\": 0,\n        \"batches\": [\n            { \"batchNumber\": 12, \"result\": \"Cancelling\" },\n            { \"batchNumber\": 13, \"result\": \"Cancelled\" }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"c61943c5-4c49-4e23-ac7b-c10eebccf3d3","name":"CancelRepurchaseBatches - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"batchNumbers\": [],\n  \"batchNumbersOrIds\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/Cancel"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Select at least one repurchase batch to cancel.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"a6aabdf7-fadd-42c4-aebb-52a0ed3a088f"},{"name":"RepurchaseBatchStart","id":"e5fa2b1d-7195-4470-a866-c88414e543cc","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"repurchaseCloseOutCode\": \"RP\",\n  \"newPortfolio\": \"2\",\n  \"newAdminStatus\": null,\n  \"newClass\": null,\n  \"newCollateralCode\": null,\n  \"effectiveDate\": null,\n  \"purchaseCode\": \"PUR-2026-001\",\n  \"notificationEmail\": \"ops@example.com\",\n  \"accountNumbersOrIds\": [\n    \"30009504\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase","description":"<h3 id=\"start-repurchase-batch\">Start Repurchase Batch</h3>\n<p>Starts a repurchase batch for the eligible accounts and returns the new batch\nid/number. The batch runs asynchronously on a background worker — poll\n<strong>Get Repurchase Batch Status</strong> for completion, or supply <code>notificationEmail</code>\nto be emailed the results CSV when it finishes. Delegates to\n<code>RepurchaseWSServices.StartRepurchaseBatchWS</code>.</p>\n<p>Ineligible accounts are excluded (see <strong>Preview Repurchase Eligibility</strong>);\nrepurchase is indirect-only, so direct accounts are skipped. Requires the\nExecute-Repurchase API permission. Batches left open by an application restart\nare repaired first (resumed, or closed when they cannot be); if any selected\naccount is then still enrolled in an open batch, the whole request is rejected\nand no batch is created.</p>\n<p><code>repurchaseCloseOutCode</code>, <code>newPortfolio</code>, <code>newAdminStatus</code>, <code>newClass</code>, and\n<code>newCollateralCode</code> each accept either a code/number/description string or a\nGUID. <code>newAdminStatus</code>, <code>newClass</code>, and <code>newCollateralCode</code> are optional\n(blank keeps the account's current value).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Repurchase</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>accountNumbers</em></td>\n<td>Legacy numeric array. Supply this or <code>accountNumbersOrIds</code>, never both.</td>\n</tr>\n<tr>\n<td><em>repurchaseCloseOutCode</em></td>\n<td>Required string. Type=4 (Repurchase) close-out default code or GUID.</td>\n</tr>\n<tr>\n<td><em>newPortfolio</em></td>\n<td>Required string. Target portfolio number or GUID.</td>\n</tr>\n<tr>\n<td><em>newAdminStatus</em></td>\n<td>Optional string. Admin status code or GUID applied on close-out. Blank keeps the current admin status.</td>\n</tr>\n<tr>\n<td><em>newClass</em></td>\n<td>Optional string. Class number or GUID to rebook into. Blank keeps the current class.</td>\n</tr>\n<tr>\n<td><em>newCollateralCode</em></td>\n<td>Optional string. Collateral code description or GUID applied to every collateral on the account. Blank leaves codes unchanged. An account is skipped unless every one of its collaterals is already of the same collateral type as this code; an account with no collateral is skipped too.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date for the repurchase. Defaults to the current business date. Cannot be in the future.</td>\n</tr>\n<tr>\n<td><em>useWebhook</em></td>\n<td>Ignored. Repurchase always uses the account-entry webhook.</td>\n</tr>\n<tr>\n<td><em>purchaseCode</em></td>\n<td>Optional string. Value sent as the account-entry webhook <code>purchaseCode</code> request header.</td>\n</tr>\n<tr>\n<td><em>notificationEmail</em></td>\n<td>Optional string. Address emailed the results CSV when the batch completes.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object: <code>batchId</code> (GUID), <code>batchNumber</code> (int), <code>started</code> (count\nof eligible accounts enrolled), and <code>excluded</code> (count of skipped/blocked/\nnot-found accounts).</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumbersOrIds</code></td>\n<td><code>accountNumbers</code></td>\n<td>Array of strings. Each entry: account number (positive 64-bit integer) or account GUID.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown account GUIDs, ambiguous keys, mismatched record types and invalid ownership are rejected. Account numbers retain the existing per-account eligibility/not-found results; conversion to the new list does not make every account eligible. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumbersOrIds\": [\n    \"30011709\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Repurchase"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c76cb860-64e9-4899-ac30-48f599ba9a0a","name":"StartRepurchaseBatch - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"repurchaseCloseOutCode\": \"RP\",\n  \"newPortfolio\": \"2\",\n  \"newAdminStatus\": null,\n  \"newClass\": null,\n  \"newCollateralCode\": null,\n  \"effectiveDate\": null,\n  \"purchaseCode\": \"PUR-2026-001\",\n  \"notificationEmail\": \"ops@example.com\",\n  \"accountNumbersOrIds\": [\n    \"30009504\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"batchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"batchNumber\": 12,\n        \"started\": 1,\n        \"excluded\": 0\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"51786af3-0389-4de4-87a3-2037c45fd560","name":"StartRepurchaseBatch - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumbers\": [\n    30009504\n  ],\n  \"repurchaseCloseOutCode\": \"RP\",\n  \"newPortfolio\": \"2\",\n  \"newAdminStatus\": null,\n  \"newClass\": null,\n  \"newCollateralCode\": null,\n  \"effectiveDate\": null,\n  \"purchaseCode\": \"PUR-2026-001\",\n  \"notificationEmail\": \"ops@example.com\",\n  \"accountNumbersOrIds\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"No eligible accounts to repurchase. Use the preview endpoint to see why.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"e5fa2b1d-7195-4470-a866-c88414e543cc"},{"name":"RepurchaseBatchStatusGet","id":"aa01098c-3dd9-439d-9699-63ba7c555563","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/{{repurchase_batch_id}}?token={{token}}","description":"<h3 id=\"get-repurchase-batch-status\">Get Repurchase Batch Status</h3>\n<p>Returns persisted status and counts for a repurchase or reversal batch. Use the batch number or batch GUID returned when the batch started. Duplicate batch numbers are rejected; use the exact batch GUID to select one. Completed, cancelled and failed batches can also be read.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Repurchase/{batchId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>batchId</em></td>\n<td>Required string. repurchase or reversal batch number or batch GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object: <code>batchId</code>, <code>batchNumber</code>, <code>status</code> (Pending / Running /\nCompleted / Cancelled / Failed), <code>total</code>, <code>succeeded</code>, <code>failed</code>,\n<code>startedAtUtc</code>, <code>completedAtUtc</code>, and <code>errorMessage</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>batchId</code></td>\n<td>repurchase or reversal batch number or batch GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Repurchase/12\n/api/Client/Servicing/Repurchase/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Repurchase","{{repurchase_batch_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"59ae3ffd-1f3b-483d-aef1-fa7336e6df1a","name":"GetRepurchaseBatchStatus - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Repurchase/{{repurchase_batch_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Repurchase","{{repurchase_batch_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"batchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"batchNumber\": 12,\n        \"status\": \"Completed\",\n        \"total\": 2,\n        \"succeeded\": 2,\n        \"failed\": 0,\n        \"startedAtUtc\": \"2026-07-08T14:31:05.000Z\",\n        \"completedAtUtc\": \"2026-07-08T14:33:47.000Z\",\n        \"errorMessage\": null\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"5f1c8fdb-635d-4dfd-9cf7-99435714d9fc","name":"GetRepurchaseBatchStatus - By Number (Illustrative)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Repurchase/12?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Repurchase","12"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"batchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"batchNumber\": 12,\n        \"status\": \"Completed\",\n        \"total\": 2,\n        \"succeeded\": 2,\n        \"failed\": 0,\n        \"startedAtUtc\": \"2026-07-08T14:31:05.000Z\",\n        \"completedAtUtc\": \"2026-07-08T14:33:47.000Z\",\n        \"errorMessage\": null\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"0cea436c-bd06-4fde-b9f5-2f5d811691ad","name":"GetRepurchaseBatchStatus - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Repurchase/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Repurchase","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"batchId: record not found.\"\n  ],\n  \"warnings\": []\n}"},{"id":"292f5dfb-c1d8-44d4-bdb6-b365e0c1e9a3","name":"GetRepurchaseBatchStatus - Duplicate Number (Illustrative)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Repurchase/12?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Repurchase","12"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"batchId: more than one record matches; supply its GUID.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"aa01098c-3dd9-439d-9699-63ba7c555563"},{"name":"RepurchaseOpenBatchesGet","id":"cceca6ba-3696-458d-978c-e0e68c2d7ebc","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/OpenBatches?token={{token}}","description":"<h3 id=\"get-open-repurchase-batches\">Get Open Repurchase Batches</h3>\n<p>Lists the current client's open (Pending or Running) repurchase batches so a\ncaller can choose which to cancel. Read-only; it only exposes the caller's own\nopen batches. Delegates to <code>RepurchaseWSServices.ListOpenRepurchaseBatchesWS</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Repurchase/OpenBatches</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object: <code>count</code> and <code>batches</code> — each with <code>batchNumber</code>,\n<code>status</code>, <code>startedAtUtc</code>, <code>total</code>, <code>processed</code>, <code>succeeded</code>, <code>failed</code>,\n<code>skipped</code>, and <code>cancelRequested</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Repurchase","OpenBatches"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"d954df6f-f280-4580-aaee-5ed8e4038c78","name":"GetOpenRepurchaseBatches - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Repurchase/OpenBatches?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Repurchase","OpenBatches"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"count\": 1,\n        \"batches\": [\n            {\n                \"batchNumber\": 12,\n                \"status\": \"Running\",\n                \"startedAtUtc\": \"2026-07-08T14:31:05.000Z\",\n                \"total\": 25,\n                \"processed\": 8,\n                \"succeeded\": 7,\n                \"failed\": 1,\n                \"skipped\": 0,\n                \"cancelRequested\": false\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"d3b044d0-b7d9-4de6-bc88-295782004254","name":"GetOpenRepurchaseBatches - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Repurchase/OpenBatches?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Repurchase","OpenBatches"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error listing open repurchase batches: Login information could not be resolved\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"cceca6ba-3696-458d-978c-e0e68c2d7ebc"},{"name":"RepurchasePreview","id":"71e1c8cc-59d1-4bff-91a7-f6368b474e75","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"newPortfolio\": \"2\",\n  \"repurchaseCloseOutCode\": \"RP\",\n  \"newAdminStatus\": null,\n  \"newClass\": null,\n  \"newCollateralCode\": null,\n  \"effectiveDate\": null,\n  \"purchaseCode\": \"PUR-2026-001\",\n  \"accountNumbersOrIds\": [\n    \"30009504\",\n    \"30009818\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/Preview","description":"<h3 id=\"preview-repurchase-eligibility\">Preview Repurchase Eligibility</h3>\n<p>Runs the same pre-transaction preflight as posting for each supplied account\nagainst a target portfolio — WITHOUT executing anything — so eligibility and\nthe posting prerequisites (close-out default, optional admin status, rebook\ncode, snapshot, rebook resolve) surface before you start a batch. Delegates to\n<code>RepurchaseWSServices.PreviewRepurchaseWS</code>.</p>\n<p>Repurchase is an indirect-only operation: direct accounts are reported as\n<code>Skipped</code>. Repurchase always uses the configured account-entry webhook to\nresolve rebook economics, so the webhook configuration/connection/response is\nvalidated here too.</p>\n<p><code>newPortfolio</code>, <code>repurchaseCloseOutCode</code>, <code>newAdminStatus</code>, <code>newClass</code>, and\n<code>newCollateralCode</code> each accept either a code/number/description string or a\nGUID. <code>newAdminStatus</code>, <code>newClass</code>, and <code>newCollateralCode</code> are optional\n(blank keeps the account's current value).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Repurchase/Preview</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>accountNumbers</em></td>\n<td>Legacy numeric array. Supply this or <code>accountNumbersOrIds</code>, never both.</td>\n</tr>\n<tr>\n<td><em>newPortfolio</em></td>\n<td>Required string. Target portfolio number or GUID.</td>\n</tr>\n<tr>\n<td><em>repurchaseCloseOutCode</em></td>\n<td>Required string. Type=4 (Repurchase) close-out default code or GUID.</td>\n</tr>\n<tr>\n<td><em>newAdminStatus</em></td>\n<td>Optional string. Admin status code or GUID applied on close-out. Blank keeps the current admin status.</td>\n</tr>\n<tr>\n<td><em>newClass</em></td>\n<td>Optional string. Class number or GUID to rebook into. Blank keeps the current class.</td>\n</tr>\n<tr>\n<td><em>newCollateralCode</em></td>\n<td>Optional string. Collateral code description or GUID applied to every collateral on the account. Blank leaves codes unchanged. An account is skipped unless every one of its collaterals is already of the same collateral type as this code; an account with no collateral is skipped too.</td>\n</tr>\n<tr>\n<td><em>effectiveDate</em></td>\n<td>Optional date. Effective date for the repurchase. Defaults to the current business date. Cannot be after the current business date.</td>\n</tr>\n<tr>\n<td><em>purchaseCode</em></td>\n<td>Optional string. Value sent as the account-entry webhook <code>purchaseCode</code> request header during webhook preview validation.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object: <code>total</code>, <code>eligible</code>, <code>skipped</code>, <code>blocked</code>,\n<code>webhookValidated</code>, and <code>accounts</code> (per-account <code>accountNumber</code>,\n<code>eligibility</code>, <code>message</code>, <code>webhookStatus</code>, <code>rebookSource</code>,\n<code>webhookDroppedItems</code>).</p>\n<p><code>webhookDroppedItems</code> lists anything the account-entry webhook returned that\ndoes not exist in Omega and was therefore not applied — unknown remark codes\nand unknown custom-screen field keys. Blank when the response applied in\nfull. A posted batch records the same value per account and shows it in the\nresults file's <code>WebhookDroppedItems</code> column; the account also gets one log\nnote with the readable detail.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumbersOrIds</code></td>\n<td><code>accountNumbers</code></td>\n<td>Array of strings. Each entry: account number (positive 64-bit integer) or account GUID.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown account GUIDs, ambiguous keys, mismatched record types and invalid ownership are rejected. Account numbers retain the existing per-account eligibility/not-found results; conversion to the new list does not make every account eligible. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumbersOrIds\": [\n    \"30011709\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Repurchase","Preview"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f3a96cf2-b3e6-4240-82c9-bb955c117b41","name":"PreviewRepurchase - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"newPortfolio\": \"2\",\n  \"repurchaseCloseOutCode\": \"RP\",\n  \"newAdminStatus\": null,\n  \"newClass\": null,\n  \"newCollateralCode\": null,\n  \"effectiveDate\": null,\n  \"purchaseCode\": \"PUR-2026-001\",\n  \"accountNumbersOrIds\": [\n    \"30009504\",\n    \"30009818\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/Preview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"total\": 2,\n        \"eligible\": 1,\n        \"skipped\": 1,\n        \"blocked\": 0,\n        \"webhookValidated\": true,\n        \"accounts\": [\n            {\n                \"accountNumber\": 30009504,\n                \"eligibility\": \"Eligible\",\n                \"message\": \"\",\n                \"webhookStatus\": \"Validated\",\n                \"rebookSource\": \"Webhook\",\n                \"webhookDroppedItems\": \"Remark codes: NOSUCHCODE | Custom screen fields: UnknownKey=some value\"\n            },\n            {\n                \"accountNumber\": 30009818,\n                \"eligibility\": \"Skipped\",\n                \"message\": \"Only indirect accounts can be repurchased; direct accounts are skipped.\",\n                \"webhookStatus\": \"Not evaluated\",\n                \"rebookSource\": \"\",\n                \"webhookDroppedItems\": \"\"\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"047647ed-9c29-4d9f-850f-cd1d4f890a66","name":"PreviewRepurchase - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumbers\": [\n    30009504\n  ],\n  \"newPortfolio\": \"999\",\n  \"repurchaseCloseOutCode\": \"RP\",\n  \"newAdminStatus\": null,\n  \"newClass\": null,\n  \"newCollateralCode\": null,\n  \"effectiveDate\": null,\n  \"purchaseCode\": \"PUR-2026-001\",\n  \"accountNumbersOrIds\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Repurchase/Preview"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"New portfolio '999' not found.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"71e1c8cc-59d1-4bff-91a7-f6368b474e75"},{"name":"RepurchaseReversalPreview","id":"6cf79709-19b8-4518-9a4b-da43b9fdf10d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumbersOrIds\": [\n    \"30009470\",\n    \"30009504\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepurchaseReversal/Preview","description":"<h3 id=\"preview-repurchase-reversal-eligibility\">Preview Repurchase Reversal Eligibility</h3>\n<p>Reports, per account, whether its most recent repurchase can be reversed and\nwhy — without changing anything. Delegates to\n<code>RepurchaseReversalWSServices.PreviewRepurchaseReversalWS</code>.</p>\n<p>Use this before <strong>Start Repurchase Reversal Batch</strong>: the start endpoint\nexcludes ineligible accounts silently, and this is the only way to see the\nreason. Requires the View-Repurchase-Reversal API permission, and the client\nmust have the Repurchase Accounts optional feature enabled — the reversal API\nis locked to the same licence flag as the repurchase screen, never one of its\nown.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepurchaseReversal/Preview</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>accountNumbers</em></td>\n<td>Legacy numeric array. Supply this or <code>accountNumbersOrIds</code>, never both.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array with one row per requested account number:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumber</em></td>\n<td>The account number as supplied.</td>\n</tr>\n<tr>\n<td><em>eligibility</em></td>\n<td><code>Eligible</code>, <code>Skipped</code>, or <code>Blocked</code>.</td>\n</tr>\n<tr>\n<td><em>reason</em></td>\n<td>Why, when not eligible. Empty for an eligible account.</td>\n</tr>\n<tr>\n<td><em>repurchaseDate</em></td>\n<td>Effective date of the repurchase that would be reversed. Null when there is none.</td>\n</tr>\n<tr>\n<td><em>closeOutType</em></td>\n<td><code>Repurchase</code> or <code>Repurchase_Charge_Off</code>. Null when there is no target.</td>\n</tr>\n<tr>\n<td><em>reportedToBureau</em></td>\n<td>True when a credit bureau cycle has already reported this repurchase. Reversal still proceeds, but the bureau side must be corrected by hand.</td>\n</tr>\n<tr>\n<td><em>bureauDetail</em></td>\n<td>What reached the bureau, when <code>reportedToBureau</code> is true.</td>\n</tr>\n</tbody>\n</table>\n</div><p>An account number that does not exist on this client is returned as\n<code>Blocked</code> rather than failing the whole request.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumbersOrIds</code></td>\n<td><code>accountNumbers</code></td>\n<td>Array of strings. Each entry: account number (positive 64-bit integer) or account GUID.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown account GUIDs, ambiguous keys, mismatched record types and invalid ownership are rejected. Account numbers retain the existing per-account eligibility/not-found results; conversion to the new list does not make every account eligible. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumbersOrIds\": [\n    \"30011709\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ]\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepurchaseReversal","Preview"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a64925fd-d9b0-4a5c-bc06-83807fadbc3d","name":"PreviewRepurchaseReversal - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumbersOrIds\": [\n    \"30009470\",\n    \"30009504\"\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepurchaseReversal/Preview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"accountNumber\": 30009470,\n            \"eligibility\": \"Eligible\",\n            \"reason\": \"\",\n            \"repurchaseDate\": \"2025-10-01T00:00:00\",\n            \"closeOutType\": \"Repurchase_Charge_Off\",\n            \"reportedToBureau\": false,\n            \"bureauDetail\": null\n        },\n        {\n            \"accountNumber\": 30009504,\n            \"eligibility\": \"Skipped\",\n            \"reason\": \"Account has no repurchase to reverse.\",\n            \"repurchaseDate\": null,\n            \"closeOutType\": null,\n            \"reportedToBureau\": false,\n            \"bureauDetail\": null\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"3797d36c-e75a-4e20-b1fa-529b0a2b4d37","name":"PreviewRepurchaseReversal - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumbers\": [\n    30009470\n  ],\n  \"accountNumbersOrIds\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepurchaseReversal/Preview"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"The Repurchase Accounts feature is not enabled for this client.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"6cf79709-19b8-4518-9a4b-da43b9fdf10d"},{"name":"RepurchaseReversalStart","id":"5d6b9378-fc0a-46c7-aa01-c773f514703b","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"adminStatusOverride\": null,\n  \"notificationEmail\": \"ops@example.com\",\n  \"accountNumbersOrIds\": [\n    \"30009470\"\n  ],\n  \"repurchaseBatchNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepurchaseReversal","description":"<h3 id=\"start-repurchase-reversal-batch\">Start Repurchase Reversal Batch</h3>\n<p>Reverses the most recent repurchase on each eligible account and returns the\nnew batch id/number. The batch runs asynchronously on a background worker —\npoll <strong>Get Repurchase Batch Status</strong> for completion, or supply\n<code>notificationEmail</code> to be emailed the results CSV when it finishes. Delegates\nto <code>RepurchaseReversalWSServices.StartRepurchaseReversalBatchWS</code>.</p>\n<p>A reversal is a full undo: transactions are reversed rather than deleted,\nvalues the repurchase overwrote are restored, and records the rebook created\nare deleted. Ineligible accounts are excluded — call <strong>Preview Repurchase\nReversal Eligibility</strong> first to see why. Requires BOTH the\nView-Repurchase-Reversal and Execute-Repurchase-Reversal API permissions, and\nthe client must have the Repurchase Accounts optional feature enabled.</p>\n<p>Batch status and cancellation are deliberately not duplicated for reversals:\nboth directions share <code>Servicing.RepurchaseBatch</code>, so the existing\n<strong>Get Repurchase Batch Status</strong> and <strong>Cancel Repurchase Batches</strong> endpoints\nalready serve reversal batches by id or number.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/RepurchaseReversal</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>accountNumbers</em></td>\n<td>Legacy numeric array. Supply this or <code>accountNumbersOrIds</code>, never both.</td>\n</tr>\n<tr>\n<td><em>repurchaseBatchNumber</em></td>\n<td>Optional int. Reverse only the repurchases this batch created, instead of each account's most recent repurchase.</td>\n</tr>\n<tr>\n<td><em>adminStatusOverride</em></td>\n<td>Optional string. Admin status code or GUID to apply. Blank restores the admin status each account had before its repurchase, which is the default because a reversal is a full undo.</td>\n</tr>\n<tr>\n<td><em>notificationEmail</em></td>\n<td><strong>Required</strong> string. Address emailed the results CSV when the batch completes. Required because the batch runs in the background and reports there — unlike the forward repurchase endpoint, where it is optional.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object: <code>batchId</code> (GUID), <code>batchNumber</code> (int), and\n<code>accountsQueued</code> (count of accounts enrolled in the batch).</p>\n<p>The results CSV names, per account, the repurchase that was reversed and\nwhether a bureau cycle had already reported it — the accounts in that state\nneed manual correction at the bureau.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>accountNumbersOrIds</code></td>\n<td><code>accountNumbers</code></td>\n<td>Array of strings. Each entry: account number (positive 64-bit integer) or account GUID.</td>\n</tr>\n<tr>\n<td><code>repurchaseBatchNumberOrId</code></td>\n<td><code>repurchaseBatchNumber</code></td>\n<td>String. Original repurchase batch number or GUID; a reversal batch cannot be used as the source.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown account GUIDs, ambiguous keys, mismatched record types and invalid ownership are rejected. Account numbers retain the existing per-account eligibility/not-found results; conversion to the new list does not make every account eligible. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. Omitting <code>repurchaseBatchNumberOrId</code> preserves automatic source selection. If both source-batch fields are supplied, they must identify the same original repurchase batch.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"accountNumbersOrIds\": [\n    \"30011709\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ],\n  \"repurchaseBatchNumberOrId\": \"12\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","RepurchaseReversal"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ad56e094-c4b7-4957-8181-5b1d32999e62","name":"StartRepurchaseReversal - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"adminStatusOverride\": null,\n  \"notificationEmail\": \"ops@example.com\",\n  \"accountNumbersOrIds\": [\n    \"30009470\"\n  ],\n  \"repurchaseBatchNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepurchaseReversal"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"batchId\": \"b7c8d9e0-2222-4333-9444-bcdef0123456\",\n        \"batchNumber\": 29,\n        \"accountsQueued\": 1\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"2960d2bd-3123-4d27-b2a7-0f97a91a309d","name":"StartRepurchaseReversal - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"accountNumbers\": [\n    30009504\n  ],\n  \"repurchaseBatchNumber\": null,\n  \"adminStatusOverride\": null,\n  \"notificationEmail\": \"ops@example.com\",\n  \"accountNumbersOrIds\": null,\n  \"repurchaseBatchNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/RepurchaseReversal"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"None of the supplied account numbers exist on this client.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"5d6b9378-fc0a-46c7-aa01-c773f514703b"},{"name":"ScoreCodeAdd","id":"98385e78-4be7-4b00-b996-0ae42ff16fe6","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"RISK1\",\n    \"description\": \"Standard Risk Scoring\",\n    \"includeBalance\": true,\n    \"balance\": [\n        { \"lowValue\": 0, \"highValue\": 5000, \"weight\": 10 },\n        { \"lowValue\": 5001, \"highValue\": 20000, \"weight\": 20 }\n    ],\n    \"includeAgingDays\": false,\n    \"agingDays\": [],\n    \"includeLastPaidDays\": false,\n    \"lastPaidDays\": [],\n    \"includeRemainingPayments\": false,\n    \"remainingPayments\": [],\n    \"includePaymentsMade\": false,\n    \"paymentsMade\": [],\n    \"includePastDueAmount\": false,\n    \"pastDueAmount\": [],\n    \"includeBalancePercentPaid\": false,\n    \"balancePercentPaid\": [],\n    \"includeLastActivityDays\": false,\n    \"lastActivityDays\": [],\n    \"includeLastNoteDays\": false,\n    \"lastNoteDays\": [],\n    \"includeRemainingRecoursePayments\": false,\n    \"remainingRecoursePayments\": [],\n    \"includeBrokenPromises\": false,\n    \"brokenPromises\": [],\n    \"includeAccountWithinFirstXPayPeriods\": false,\n    \"accountWithinFirstXPayPeriods\": [],\n    \"includeRedeemedRepoInLastXMonths\": false,\n    \"redeemedRepoInLastXMonths\": [],\n    \"includeReturnedCheckOnLastPayment\": false,\n    \"returnedCheckOnLastPaymentWeight\": 0,\n    \"includeNoTextOptIn\": false,\n    \"noTextOptInWeight\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ScoreCode","description":"<h3 id=\"add-servicing-score-code\">Add Servicing Score Code</h3>\n<p>Creates a new score code for the current client. Delegates to <code>ScoreCodeWSServices.AddSaveScoreCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another score code with the same <code>code</code> already exists for the client.</p>\n<p>The payload is a rich object: a set of boolean <code>includeX</code> flags toggle individual scoring criteria, and each enabled criterion carries a list of <code>ScoreCodeDetailParameter</code> ranges with <code>lowValue</code>, <code>highValue</code>, and <code>weight</code>. Two criteria (<code>returnedCheckOnLastPayment</code>, <code>noTextOptIn</code>) use a single <code>weight</code> instead of a range list.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ScoreCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Client-scoped unique score code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Score code description.</td>\n</tr>\n<tr>\n<td><em>includeBalance</em></td>\n<td>Required bool. Enable balance-range scoring.</td>\n</tr>\n<tr>\n<td><em>balance</em></td>\n<td>List of <code>{ lowValue, highValue, weight }</code> ranges.</td>\n</tr>\n<tr>\n<td><em>includeAgingDays</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>agingDays</em></td>\n<td>List of <code>{ lowValue, highValue, weight }</code> ranges.</td>\n</tr>\n<tr>\n<td><em>includeLastPaidDays / lastPaidDays</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeRemainingPayments / remainingPayments</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includePaymentsMade / paymentsMade</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includePastDueAmount / pastDueAmount</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeBalancePercentPaid / balancePercentPaid</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeLastActivityDays / lastActivityDays</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeLastNoteDays / lastNoteDays</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeRemainingRecoursePayments / remainingRecoursePayments</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeBrokenPromises / brokenPromises</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeAccountWithinFirstXPayPeriods / accountWithinFirstXPayPeriods</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeRedeemedRepoInLastXMonths / redeemedRepoInLastXMonths</em></td>\n<td>Flag + ranges.</td>\n</tr>\n<tr>\n<td><em>includeReturnedCheckOnLastPayment / returnedCheckOnLastPaymentWeight</em></td>\n<td>Flag + single weight.</td>\n</tr>\n<tr>\n<td><em>includeNoTextOptIn / noTextOptInWeight</em></td>\n<td>Flag + single weight.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new score code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ScoreCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"10ead5cc-79b2-43d6-9acb-d8796a4d5773","name":"AddScoreCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"RISK1\",\n    \"description\": \"Standard Risk Scoring\",\n    \"includeBalance\": true,\n    \"balance\": [\n        { \"lowValue\": 0, \"highValue\": 5000, \"weight\": 10 }\n    ],\n    \"includeAgingDays\": false,\n    \"agingDays\": [],\n    \"includeLastPaidDays\": false,\n    \"lastPaidDays\": [],\n    \"includeRemainingPayments\": false,\n    \"remainingPayments\": [],\n    \"includePaymentsMade\": false,\n    \"paymentsMade\": [],\n    \"includePastDueAmount\": false,\n    \"pastDueAmount\": [],\n    \"includeBalancePercentPaid\": false,\n    \"balancePercentPaid\": [],\n    \"includeLastActivityDays\": false,\n    \"lastActivityDays\": [],\n    \"includeLastNoteDays\": false,\n    \"lastNoteDays\": [],\n    \"includeRemainingRecoursePayments\": false,\n    \"remainingRecoursePayments\": [],\n    \"includeBrokenPromises\": false,\n    \"brokenPromises\": [],\n    \"includeAccountWithinFirstXPayPeriods\": false,\n    \"accountWithinFirstXPayPeriods\": [],\n    \"includeRedeemedRepoInLastXMonths\": false,\n    \"redeemedRepoInLastXMonths\": [],\n    \"includeReturnedCheckOnLastPayment\": false,\n    \"returnedCheckOnLastPaymentWeight\": 0,\n    \"includeNoTextOptIn\": false,\n    \"noTextOptInWeight\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ScoreCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1f2a3b4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"f86a3f3a-f55d-4d7f-8c14-26f2f82dce0d","name":"AddScoreCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"RISK1\",\n    \"description\": \"Standard Risk Scoring\",\n    \"includeBalance\": true,\n    \"balance\": [\n        { \"lowValue\": 0, \"highValue\": 5000, \"weight\": 10 }\n    ],\n    \"includeAgingDays\": false,\n    \"agingDays\": [],\n    \"includeLastPaidDays\": false,\n    \"lastPaidDays\": [],\n    \"includeRemainingPayments\": false,\n    \"remainingPayments\": [],\n    \"includePaymentsMade\": false,\n    \"paymentsMade\": [],\n    \"includePastDueAmount\": false,\n    \"pastDueAmount\": [],\n    \"includeBalancePercentPaid\": false,\n    \"balancePercentPaid\": [],\n    \"includeLastActivityDays\": false,\n    \"lastActivityDays\": [],\n    \"includeLastNoteDays\": false,\n    \"lastNoteDays\": [],\n    \"includeRemainingRecoursePayments\": false,\n    \"remainingRecoursePayments\": [],\n    \"includeBrokenPromises\": false,\n    \"brokenPromises\": [],\n    \"includeAccountWithinFirstXPayPeriods\": false,\n    \"accountWithinFirstXPayPeriods\": [],\n    \"includeRedeemedRepoInLastXMonths\": false,\n    \"redeemedRepoInLastXMonths\": [],\n    \"includeReturnedCheckOnLastPayment\": false,\n    \"returnedCheckOnLastPaymentWeight\": 0,\n    \"includeNoTextOptIn\": false,\n    \"noTextOptInWeight\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ScoreCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A score code with code 'RISK1' already exists\"\n    ]\n}"}],"_postman_id":"98385e78-4be7-4b00-b996-0ae42ff16fe6"},{"name":"ScoreCodeGet","id":"538dda95-7417-47d2-a6be-124aa01f98be","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/ScoreCode/{{score_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-score-code\">Get Servicing Score Code</h3>\n<p>Returns a single score code resolved by Guid or code. Delegates to <code>ScoreCodeWSServices.ReturnScoreCodeWS</code>, which first attempts <code>Guid.TryParse</code>; if that fails it calls <code>SharedWSServices.GetServicingScoreCodeId</code> to resolve the client-scoped code, then fetches the record via <code>ScoreCodeServices.ReturnScoreCode</code>.</p>\n<p>Returns <code>\"Score code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ScoreCode/{scoreCodeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>scoreCodeOrId</em></td>\n<td>Required string. <code>Servicing.ScoreCode.Id</code> Guid or <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingScoreCodeEntity</code> with <code>Id</code>, <code>Code</code>, <code>Description</code>, and the full set of scoring flags and criteria detail collections (balance, aging days, last paid days, remaining payments, payments made, past due amount, balance percent paid, last activity days, last note days, remaining recourse payments, broken promises, accounts within first X pay periods, redeemed repo in last X months, returned check on last payment, and no text opt-in), along with the row's <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ScoreCode","{{score_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"57b11d57-91a0-43c1-adfd-8d60d194fb72","name":"GetScoreCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/ScoreCode/{{score_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","ScoreCode","{{score_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1f2a3b4-1111-4222-9333-abcdef012345\",\n        \"Code\": \"RISK1\",\n        \"Description\": \"Standard Risk Scoring\",\n        \"IncludeBalance\": true,\n        \"Balance\": [\n            {\n                \"Id\": \"11111111-1111-4111-9111-111111111111\",\n                \"LowValue\": 0,\n                \"HighValue\": 5000,\n                \"Weight\": 10,\n                \"Ts\": \"AAAAAAAAB9A=\"\n            }\n        ],\n        \"IncludeAgingDays\": false,\n        \"AgingDays\": [],\n        \"IncludeLastPaidDays\": false,\n        \"LastPaidDays\": [],\n        \"IncludeRemainingPayments\": false,\n        \"RemainingPayments\": [],\n        \"IncludePaymentsMade\": false,\n        \"PaymentsMade\": [],\n        \"IncludePastDueAmount\": false,\n        \"PastDueAmount\": [],\n        \"IncludeBalancePercentPaid\": false,\n        \"BalancePercentPaid\": [],\n        \"IncludeLastActivityDays\": false,\n        \"LastActivityDays\": [],\n        \"IncludeLastNoteDays\": false,\n        \"LastNoteDays\": [],\n        \"IncludeRemainingRecoursePayments\": false,\n        \"RemainingRecoursePayments\": [],\n        \"IncludeBrokenPromises\": false,\n        \"BrokenPromises\": [],\n        \"IncludeAccountWithinFirstXPayPeriods\": false,\n        \"AccountWithinFirstXPayPeriods\": [],\n        \"IncludeRedeemedRepoInLastXMonths\": false,\n        \"RedeemedRepoInLastXMonths\": [],\n        \"IncludeReturnedCheckOnLastPayment\": false,\n        \"ReturnedCheckOnLastPaymentWeight\": 0,\n        \"IncludeNoTextOptIn\": false,\n        \"NoTextOptInWeight\": 0,\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"b047ca12-c956-4a1d-a24d-8d62375a5f10","name":"GetScoreCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/ScoreCode/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","ScoreCode","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Score code not found\"\n    ]\n}"}],"_postman_id":"538dda95-7417-47d2-a6be-124aa01f98be"},{"name":"ScoreCodeUpdate","id":"e8d6b38d-f2ab-4359-8f56-40d82739f468","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"RISK1\",\n    \"description\": \"Standard Risk Scoring (Updated)\",\n    \"includeBalance\": true,\n    \"balance\": [\n        { \"lowValue\": 0, \"highValue\": 10000, \"weight\": 15 }\n    ],\n    \"includeAgingDays\": false,\n    \"agingDays\": [],\n    \"includeLastPaidDays\": false,\n    \"lastPaidDays\": [],\n    \"includeRemainingPayments\": false,\n    \"remainingPayments\": [],\n    \"includePaymentsMade\": false,\n    \"paymentsMade\": [],\n    \"includePastDueAmount\": false,\n    \"pastDueAmount\": [],\n    \"includeBalancePercentPaid\": false,\n    \"balancePercentPaid\": [],\n    \"includeLastActivityDays\": false,\n    \"lastActivityDays\": [],\n    \"includeLastNoteDays\": false,\n    \"lastNoteDays\": [],\n    \"includeRemainingRecoursePayments\": false,\n    \"remainingRecoursePayments\": [],\n    \"includeBrokenPromises\": false,\n    \"brokenPromises\": [],\n    \"includeAccountWithinFirstXPayPeriods\": false,\n    \"accountWithinFirstXPayPeriods\": [],\n    \"includeRedeemedRepoInLastXMonths\": false,\n    \"redeemedRepoInLastXMonths\": [],\n    \"includeReturnedCheckOnLastPayment\": false,\n    \"returnedCheckOnLastPaymentWeight\": 0,\n    \"includeNoTextOptIn\": false,\n    \"noTextOptInWeight\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ScoreCode/{{score_code_or_id}}","description":"<h3 id=\"update-servicing-score-code\">Update Servicing Score Code</h3>\n<p>Updates an existing score code, resolved by Guid or code. The controller calls <code>SharedWSServices.GetServicingScoreCodeId</code> to resolve the Id from the <code>scoreCodeOrId</code> path segment (Guid or code), re-reads the existing record via <code>ScoreCodeServices.ReturnScoreCode</code> to capture its current <code>Ts</code>, and then calls <code>ScoreCodeWSServices.AddSaveScoreCodeWS</code> with the resolved <code>id</code> and preserved <code>ts</code>. Returns <code>\"Score code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p>The payload mirrors <code>POST /ScoreCode</code> — a set of <code>includeX</code> flags with matching criteria detail lists, plus two single-weight criteria (<code>returnedCheckOnLastPayment</code>, <code>noTextOptIn</code>).</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/ScoreCode/{scoreCodeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>scoreCodeOrId</em></td>\n<td>Required string. <code>Servicing.ScoreCode.Id</code> Guid or <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <code>POST /api/Client/Servicing/ScoreCode</code>. See that endpoint for the full field list.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated score code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","ScoreCode","{{score_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7c39e238-930b-4475-881a-566bec24e596","name":"UpdateScoreCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"RISK1\",\n    \"description\": \"Standard Risk Scoring (Updated)\",\n    \"includeBalance\": true,\n    \"balance\": [\n        { \"lowValue\": 0, \"highValue\": 10000, \"weight\": 15 }\n    ],\n    \"includeAgingDays\": false,\n    \"agingDays\": [],\n    \"includeLastPaidDays\": false,\n    \"lastPaidDays\": [],\n    \"includeRemainingPayments\": false,\n    \"remainingPayments\": [],\n    \"includePaymentsMade\": false,\n    \"paymentsMade\": [],\n    \"includePastDueAmount\": false,\n    \"pastDueAmount\": [],\n    \"includeBalancePercentPaid\": false,\n    \"balancePercentPaid\": [],\n    \"includeLastActivityDays\": false,\n    \"lastActivityDays\": [],\n    \"includeLastNoteDays\": false,\n    \"lastNoteDays\": [],\n    \"includeRemainingRecoursePayments\": false,\n    \"remainingRecoursePayments\": [],\n    \"includeBrokenPromises\": false,\n    \"brokenPromises\": [],\n    \"includeAccountWithinFirstXPayPeriods\": false,\n    \"accountWithinFirstXPayPeriods\": [],\n    \"includeRedeemedRepoInLastXMonths\": false,\n    \"redeemedRepoInLastXMonths\": [],\n    \"includeReturnedCheckOnLastPayment\": false,\n    \"returnedCheckOnLastPaymentWeight\": 0,\n    \"includeNoTextOptIn\": false,\n    \"noTextOptInWeight\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ScoreCode/{{score_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"e1f2a3b4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"0283f4c9-9760-4868-869b-6f2d50dd1381","name":"UpdateScoreCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"RISK1\",\n    \"description\": \"Standard Risk Scoring (Updated)\",\n    \"includeBalance\": true,\n    \"balance\": [\n        { \"lowValue\": 0, \"highValue\": 10000, \"weight\": 15 }\n    ],\n    \"includeAgingDays\": false,\n    \"agingDays\": [],\n    \"includeLastPaidDays\": false,\n    \"lastPaidDays\": [],\n    \"includeRemainingPayments\": false,\n    \"remainingPayments\": [],\n    \"includePaymentsMade\": false,\n    \"paymentsMade\": [],\n    \"includePastDueAmount\": false,\n    \"pastDueAmount\": [],\n    \"includeBalancePercentPaid\": false,\n    \"balancePercentPaid\": [],\n    \"includeLastActivityDays\": false,\n    \"lastActivityDays\": [],\n    \"includeLastNoteDays\": false,\n    \"lastNoteDays\": [],\n    \"includeRemainingRecoursePayments\": false,\n    \"remainingRecoursePayments\": [],\n    \"includeBrokenPromises\": false,\n    \"brokenPromises\": [],\n    \"includeAccountWithinFirstXPayPeriods\": false,\n    \"accountWithinFirstXPayPeriods\": [],\n    \"includeRedeemedRepoInLastXMonths\": false,\n    \"redeemedRepoInLastXMonths\": [],\n    \"includeReturnedCheckOnLastPayment\": false,\n    \"returnedCheckOnLastPaymentWeight\": 0,\n    \"includeNoTextOptIn\": false,\n    \"noTextOptInWeight\": 0\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/ScoreCode/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Score code not found\"\n    ]\n}"}],"_postman_id":"e8d6b38d-f2ab-4359-8f56-40d82739f468"},{"name":"StatementTemplateAdd","id":"28c48da6-78d1-47c6-b455-b3027f7c282f","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"active\": true,\n  \"classNumberOrId\": \"1\",\n  \"documentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n  \"statementDays\": 30,\n  \"statementType\": 1,\n  \"includeCoSigners\": true,\n  \"includeGuarantors\": true,\n  \"includeChargeOffAccounts\": false,\n  \"createFollowUpTask\": false,\n  \"followUpDays\": 0,\n  \"followUpTaskTemplateId\": null,\n  \"includeFutureBillingPeriods\": false,\n  \"followUpTaskTemplateNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate","description":"<h3 id=\"add-servicing-statement-template\">Add Servicing Statement Template</h3>\n<p>Creates a new statement template for the current client. Delegates to <code>StatementTemplateWSServices.AddSaveStatementTemplateWS</code> with <code>id=null</code> and <code>ts=null</code>. The controller resolves the <code>classNumberOrId</code> string to a <code>ClassId</code> Guid via helper lookup logic and persists the row through <code>StatementTemplateServices.AddSaveStatementTemplate</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/StatementTemplate</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the template is active.</td>\n</tr>\n<tr>\n<td><em>classNumberOrId</em></td>\n<td>Required string. <code>Common.Class.Number</code> or <code>Id</code>.</td>\n</tr>\n<tr>\n<td><em>documentId</em></td>\n<td>Required Guid. <code>Global.Document.Id</code> for the template document.</td>\n</tr>\n<tr>\n<td><em>statementDays</em></td>\n<td>Required integer. Number of days covered by each statement period.</td>\n</tr>\n<tr>\n<td><em>statementType</em></td>\n<td>Required integer. <code>Omega.Servicing.Types.Enums.StatementType</code> numeric value.</td>\n</tr>\n<tr>\n<td><em>includeCoSigners</em></td>\n<td>Required bool. Include co-signers on the statement.</td>\n</tr>\n<tr>\n<td><em>includeGuarantors</em></td>\n<td>Required bool. Include guarantors on the statement.</td>\n</tr>\n<tr>\n<td><em>includeChargeOffAccounts</em></td>\n<td>Required bool. Include charge-off accounts.</td>\n</tr>\n<tr>\n<td><em>createFollowUpTask</em></td>\n<td>Required bool. Create a follow-up task when generating the statement.</td>\n</tr>\n<tr>\n<td><em>followUpDays</em></td>\n<td>Optional integer. Days after statement to schedule the follow-up task.</td>\n</tr>\n<tr>\n<td><em>followUpTaskTemplateId</em></td>\n<td>Optional Guid. <code>Servicing.TaskTemplate.Id</code> for the follow-up.</td>\n</tr>\n<tr>\n<td><em>includeFutureBillingPeriods</em></td>\n<td>Required bool. Include future billing periods on the statement.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new statement template.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>followUpTaskTemplateNumberOrId</code></td>\n<td><code>followUpTaskTemplateId</code></td>\n<td>String. task-template number or template GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"followUpTaskTemplateNumberOrId\": \"1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","StatementTemplate"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7c0555ff-99ff-457c-8820-bd40321fbb3a","name":"AddStatementTemplate - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"active\": true,\n  \"classNumberOrId\": \"1\",\n  \"documentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n  \"statementDays\": 30,\n  \"statementType\": 1,\n  \"includeCoSigners\": true,\n  \"includeGuarantors\": true,\n  \"includeChargeOffAccounts\": false,\n  \"createFollowUpTask\": false,\n  \"followUpDays\": 0,\n  \"followUpTaskTemplateId\": null,\n  \"includeFutureBillingPeriods\": false,\n  \"followUpTaskTemplateNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2b3c4d5-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"9be130cf-3b56-4196-a906-f667bde3c8bf","name":"AddStatementTemplate - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"active\": true,\n  \"classNumberOrId\": \"9999\",\n  \"documentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n  \"statementDays\": 30,\n  \"statementType\": 1,\n  \"includeCoSigners\": true,\n  \"includeGuarantors\": true,\n  \"includeChargeOffAccounts\": false,\n  \"createFollowUpTask\": false,\n  \"followUpDays\": 0,\n  \"followUpTaskTemplateId\": null,\n  \"includeFutureBillingPeriods\": false,\n  \"followUpTaskTemplateNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error saving statement template: Class not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"28c48da6-78d1-47c6-b455-b3027f7c282f"},{"name":"StatementTemplateGet","id":"78640cba-17ce-4b5b-81ab-ce3aa027973c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate/{{statement_template_id}}?token={{token}}","description":"<h3 id=\"get-servicing-statement-template\">Get Servicing Statement Template</h3>\n<p>Returns a single statement template resolved by Guid. Delegates to <code>StatementTemplateWSServices.ReturnStatementTemplateWS</code>, which parses the <code>id</code> path segment as a Guid and calls <code>StatementTemplateServices.ReturnStatementTemplate</code>.</p>\n<p>Returns <code>\"Statement template not found\"</code> when the Guid does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/StatementTemplate/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. <code>Servicing.StatementTemplate.Id</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingStatementTemplateEntity</code> with <code>Id</code>, <code>Active</code>, <code>ClassNumberOrId</code>, <code>DocumentId</code>, <code>StatementDays</code>, <code>StatementType</code>, <code>IncludeCoSigners</code>, <code>IncludeGuarantors</code>, <code>IncludeChargeOffAccounts</code>, <code>CreateFollowUpTask</code>, <code>FollowUpDays</code>, <code>FollowUpTaskTemplateId</code>, <code>IncludeFutureBillingPeriods</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","StatementTemplate","{{statement_template_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7866e67c-540a-412a-8cf7-d90820646ae2","name":"GetStatementTemplate - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/StatementTemplate/{{statement_template_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","StatementTemplate","{{statement_template_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2b3c4d5-1111-4222-9333-abcdef012345\",\n        \"Active\": true,\n        \"ClassNumberOrId\": \"1\",\n        \"DocumentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n        \"StatementDays\": 30,\n        \"StatementType\": 1,\n        \"IncludeCoSigners\": true,\n        \"IncludeGuarantors\": true,\n        \"IncludeChargeOffAccounts\": false,\n        \"CreateFollowUpTask\": false,\n        \"FollowUpDays\": 0,\n        \"FollowUpTaskTemplateId\": null,\n        \"IncludeFutureBillingPeriods\": false,\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"c1bf76a7-2443-404f-9a68-155cde574780","name":"GetStatementTemplate - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/StatementTemplate/00000000-0000-0000-0000-000000000000?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","StatementTemplate","00000000-0000-0000-0000-000000000000"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Statement template not found\"\n    ]\n}"}],"_postman_id":"78640cba-17ce-4b5b-81ab-ce3aa027973c"},{"name":"StatementTemplatesGetAll","id":"901fb64e-ce3d-4ba8-b269-e47b5279dc60","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate?token={{token}}","description":"<h3 id=\"get-all-servicing-statement-templates\">Get All Servicing Statement Templates</h3>\n<p>Returns every statement template for the current client. Delegates to <code>StatementTemplateWSServices.ReturnAllStatementTemplatesWS</code>, which reads <code>Servicing.StatementTemplate</code> scoped to the authenticated client.</p>\n<p>The optional <code>statementType</code> query parameter filters the result set to a single template category; omit the parameter to return all types. The optional <code>activeOnly</code> query parameter filters to rows where <code>Active=true</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/StatementTemplate</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>statementType</em></td>\n<td>Optional integer. <code>Omega.Servicing.Types.Enums.StatementType</code> numeric value.</td>\n</tr>\n<tr>\n<td><em>activeOnly</em></td>\n<td>Optional bool. When <code>true</code>, returns only rows where <code>Active=true</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingStatementTemplateEntity</code> records.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","StatementTemplate"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"15cff6c6-a264-4817-bff6-aabbce420a1c","name":"GetAllStatementTemplates - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/StatementTemplate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","StatementTemplate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a2b3c4d5-1111-4222-9333-abcdef012345\",\n            \"Active\": true,\n            \"ClassNumberOrId\": \"1\",\n            \"DocumentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n            \"StatementDays\": 30,\n            \"StatementType\": 1,\n            \"IncludeCoSigners\": true,\n            \"IncludeGuarantors\": true,\n            \"IncludeChargeOffAccounts\": false,\n            \"CreateFollowUpTask\": false,\n            \"FollowUpDays\": 0,\n            \"FollowUpTaskTemplateId\": null,\n            \"IncludeFutureBillingPeriods\": false,\n            \"Ts\": \"AAAAAAAAB9M=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"e61ce857-dce7-429a-adfc-1d9ea2fb6264","name":"GetAllStatementTemplates - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/StatementTemplate?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","StatementTemplate"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"Message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"901fb64e-ce3d-4ba8-b269-e47b5279dc60"},{"name":"StatementTemplateUpdate","id":"87effbbe-f4e9-43ee-b7d9-7bbfa546115d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"active\": true,\n  \"classNumberOrId\": \"1\",\n  \"documentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n  \"statementDays\": 30,\n  \"statementType\": 1,\n  \"includeCoSigners\": true,\n  \"includeGuarantors\": true,\n  \"includeChargeOffAccounts\": false,\n  \"createFollowUpTask\": false,\n  \"followUpDays\": 0,\n  \"followUpTaskTemplateId\": null,\n  \"includeFutureBillingPeriods\": false,\n  \"followUpTaskTemplateNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate/{{statement_template_id}}","description":"<h3 id=\"update-servicing-statement-template\">Update Servicing Statement Template</h3>\n<p>Updates an existing statement template. The controller requires a strict Guid in the path (no code lookup fallback), re-reads the existing record via <code>StatementTemplateServices.ReturnStatementTemplate</code> to capture its current <code>Ts</code>, converts the <code>UpdateStatementTemplateParameter</code> into the shared add-save shape, and then calls <code>StatementTemplateWSServices.AddSaveStatementTemplateWS</code> with the resolved <code>id</code> and preserved <code>ts</code>. Returns <code>\"Statement template not found\"</code> when the Guid does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/StatementTemplate/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required Guid. <code>Servicing.StatementTemplate.Id</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <code>POST /api/Client/Servicing/StatementTemplate</code>. See that endpoint for the full field list.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated statement template.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>followUpTaskTemplateNumberOrId</code></td>\n<td><code>followUpTaskTemplateId</code></td>\n<td>String. task-template number or template GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"followUpTaskTemplateNumberOrId\": \"1\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","StatementTemplate","{{statement_template_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a4218288-7acc-431b-9ad2-5d8ab60d71e1","name":"UpdateStatementTemplate - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"active\": true,\n  \"classNumberOrId\": \"1\",\n  \"documentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n  \"statementDays\": 30,\n  \"statementType\": 1,\n  \"includeCoSigners\": true,\n  \"includeGuarantors\": true,\n  \"includeChargeOffAccounts\": false,\n  \"createFollowUpTask\": false,\n  \"followUpDays\": 0,\n  \"followUpTaskTemplateId\": null,\n  \"includeFutureBillingPeriods\": false,\n  \"followUpTaskTemplateNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate/{{statement_template_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a2b3c4d5-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"a12cd3e7-1c92-4a8d-a062-28096a3cc606","name":"UpdateStatementTemplate - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"active\": true,\n  \"classNumberOrId\": \"1\",\n  \"documentId\": \"f1e2d3c4-1111-4222-9333-abcdef012345\",\n  \"statementDays\": 30,\n  \"statementType\": 1,\n  \"includeCoSigners\": true,\n  \"includeGuarantors\": true,\n  \"includeChargeOffAccounts\": false,\n  \"createFollowUpTask\": false,\n  \"followUpDays\": 0,\n  \"followUpTaskTemplateId\": null,\n  \"includeFutureBillingPeriods\": false,\n  \"followUpTaskTemplateNumberOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/StatementTemplate/00000000-0000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Statement template not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"87effbbe-f4e9-43ee-b7d9-7bbfa546115d"},{"name":"SubAccountsGet","id":"ef3a1034-ba2a-49dd-a570-69603516d50e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number_or_id}}/SubAccounts?token={{token}}","description":"<h3 id=\"get-account-subaccounts\">Get Account SubAccounts</h3>\n<p>Returns every subaccount attached to the specified account. Delegates to <code>SubAccountWSServices.ReturnSubAccountsWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> (Guid or <code>AccountNumber</code> string) and reads rows from <code>Servicing.AccountSubAccount</code> for that account.</p>\n<p>Returns <code>\"Account not found\"</code> when the identifier does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Account/{accountNumberOrId}/SubAccounts</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. <code>Common.Account.Id</code> Guid or <code>AccountNumber</code> string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingAccountSubAccountEntity</code> records with <code>Id</code>, <code>AccountId</code>, <code>SubAccountId</code>, <code>Description</code>, <code>OriginalBalance</code>, <code>AmountPaid</code>, <code>AdjustmentAmount</code>, <code>RemainingBalance</code>, <code>EnterDate</code>, <code>IsPaid</code>, and <code>Ts</code>.</p>\n<h4 id=\"bulk-variant\">Bulk variant</h4>\n<p>Process one to 250 accounts in one call: <code>POST api/Client/Servicing/Account/Bulk/GetSubAccounts</code>. See <strong>Bulk Get Account Subaccounts</strong> in this collection.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","{{account_number_or_id}}","SubAccounts"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"13e941ab-2af5-4a0d-a45f-32a10a8f5773","name":"GetSubAccounts - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number_or_id}}/SubAccounts?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","{{account_number_or_id}}","SubAccounts"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"AccountId\": \"e5f6a7b8-5555-4666-9777-ef0123456789\",\n            \"SubAccountId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"GAP Insurance\",\n            \"OriginalBalance\": 500.00,\n            \"AmountPaid\": 100.00,\n            \"AdjustmentAmount\": 0.00,\n            \"RemainingBalance\": 400.00,\n            \"EnterDate\": \"2026-01-15T00:00:00\",\n            \"IsPaid\": false,\n            \"Ts\": \"AAAAAAAAB9E=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"3afe366c-379b-453c-a10a-a8161043706e","name":"GetSubAccounts - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/0000000000/SubAccounts?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","0000000000","SubAccounts"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"ef3a1034-ba2a-49dd-a570-69603516d50e"},{"name":"SubAccountsGetBulk","id":"63378170-5141-4706-a223-cf811a87f457","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetSubAccounts?token={{token}}","description":"<h3 id=\"bulk-get-account-subaccounts\">Bulk Get Account Subaccounts</h3>\n<p>Returns Subaccounts for several accounts. The body must be an array containing one to 250 items. Each <code>accountNumberOrId</code> accepts an account number or <code>Common.Account</code> Id. The request requires token or API-key authentication.</p>\n<p>This route reuses the API Access permission for <code>GET api/Client/Servicing/Account/{accountNumberOrId}/SubAccounts</code>. Check the response <code>statusCode</code> and per-account rows; a processed batch can return HTTP 200 with <code>Successful_With_Error</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","Bulk","GetSubAccounts"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"16d1f5db-fdd7-40cf-949d-d8912819f549","name":"SubAccountsGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetSubAccounts?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetSubAccounts"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 2,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [\n          {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"AccountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n            \"SubAccountId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"GAP Insurance\",\n            \"OriginalBalance\": 500,\n            \"AmountPaid\": 100,\n            \"AdjustmentAmount\": 0,\n            \"RemainingBalance\": 400,\n            \"EnterDate\": \"2026-01-15T00:00:00\",\n            \"IsPaid\": false,\n            \"Ts\": \"AAAAAAAAB9E=\"\n          }\n        ]\n      },\n      {\n        \"accountNumber\": 30001213,\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": []\n      }\n    ]\n  }\n}"},{"id":"11b63971-7f6c-4699-888c-84b661a687e5","name":"SubAccountsGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetSubAccounts?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetSubAccounts"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [\n          {\n            \"Id\": \"11111111-1111-4111-9111-111111111111\",\n            \"AccountId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n            \"SubAccountId\": \"22222222-2222-4222-9222-222222222222\",\n            \"Description\": \"GAP Insurance\",\n            \"OriginalBalance\": 500,\n            \"AmountPaid\": 100,\n            \"AdjustmentAmount\": 0,\n            \"RemainingBalance\": 400,\n            \"EnterDate\": \"2026-01-15T00:00:00\",\n            \"IsPaid\": false,\n            \"Ts\": \"AAAAAAAAB9E=\"\n          }\n        ]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"42cd7100-3360-483c-a915-da072de233d7","name":"SubAccountsGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetSubAccounts?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetSubAccounts"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"9833c192-d2b1-4b9f-b8d4-09f0da1a1a11","name":"SubAccountsGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetSubAccounts?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetSubAccounts"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"63378170-5141-4706-a223-cf811a87f457"},{"name":"TellerAdd","id":"b6502c70-9093-4796-8f62-50fca9624607","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"userIdOrLogin\": \"developer\",\n    \"active\": true,\n    \"cashGLAccountNumberOrId\": \"10100\",\n    \"overShortGLAccountNumberOrId\": \"70900\",\n    \"startingBalance\": 500.00,\n    \"allowInnerBranchPayments\": true,\n    \"defaultFundsCodeOrId\": \"Cash\",\n    \"defaultPaymentTransCodeOrId\": \"Regular Payment\",\n    \"defaultBrBankAccountId\": null,\n    \"autoPostApiTransactionToBank\": false,\n    \"apiBrBankAccountId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Teller","description":"<h3 id=\"add-servicing-teller\">Add Servicing Teller</h3>\n<p>Creates a new teller for the current client. Delegates to <code>TellerWSServices.AddSaveTellerWS</code>, which resolves the user by Id/login, the GL accounts by number/Id, the funds code and payment transaction code by description/Id, and inserts a new <code>Servicing.Teller</code> row scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Teller</code></p>\n<h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>userIdOrLogin</em></td>\n<td>Required string. <code>Setup.[User].Id</code> Guid or <code>UserLogin</code> text.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. Whether the teller is active.</td>\n</tr>\n<tr>\n<td><em>cashGLAccountNumberOrId</em></td>\n<td>Required string. <code>GeneralLedger.GLAccount.Id</code> Guid or <code>AccountNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>overShortGLAccountNumberOrId</em></td>\n<td>Required string. <code>GeneralLedger.GLAccount.Id</code> Guid or <code>AccountNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>startingBalance</em></td>\n<td>Required decimal. Teller starting cash balance.</td>\n</tr>\n<tr>\n<td><em>allowInnerBranchPayments</em></td>\n<td>Optional boolean.</td>\n</tr>\n<tr>\n<td><em>defaultFundsCodeOrId</em></td>\n<td>Optional string. <code>Servicing.FundsCode.Id</code> Guid or description.</td>\n</tr>\n<tr>\n<td><em>defaultPaymentTransCodeOrId</em></td>\n<td>Optional string. <code>Servicing.PaymentTransCode.Id</code> Guid or description.</td>\n</tr>\n<tr>\n<td><em>defaultBrBankAccountId</em></td>\n<td>Optional Guid. <code>Common.BrBankAccount.Id</code>.</td>\n</tr>\n<tr>\n<td><em>autoPostApiTransactionToBank</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>apiBrBankAccountId</em></td>\n<td>Optional Guid. <code>Common.BrBankAccount.Id</code> used for API transactions.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the new <code>Id</code> of the created teller.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Teller"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"994f5b15-86d4-41a8-8b98-1bf568711150","name":"AddTeller - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"userIdOrLogin\": \"developer\",\n    \"active\": true,\n    \"cashGLAccountNumberOrId\": \"10100\",\n    \"overShortGLAccountNumberOrId\": \"70900\",\n    \"startingBalance\": 500.00,\n    \"allowInnerBranchPayments\": true,\n    \"defaultFundsCodeOrId\": \"Cash\",\n    \"defaultPaymentTransCodeOrId\": \"Regular Payment\",\n    \"defaultBrBankAccountId\": null,\n    \"autoPostApiTransactionToBank\": false,\n    \"apiBrBankAccountId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Teller"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f7a8b9c0-cccc-4ddd-aeee-56789abcdef0\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"c1b619cf-f630-4b43-bb67-dc043272ff12","name":"AddTeller - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"userIdOrLogin\": \"nonexistentuser\",\n    \"active\": true,\n    \"cashGLAccountNumberOrId\": \"10100\",\n    \"overShortGLAccountNumberOrId\": \"70900\",\n    \"startingBalance\": 500.00,\n    \"allowInnerBranchPayments\": true,\n    \"defaultFundsCodeOrId\": \"Cash\",\n    \"defaultPaymentTransCodeOrId\": \"Regular Payment\",\n    \"defaultBrBankAccountId\": null,\n    \"autoPostApiTransactionToBank\": false,\n    \"apiBrBankAccountId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Teller"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"User not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"b6502c70-9093-4796-8f62-50fca9624607"},{"name":"TellerGet","id":"26f76f9f-9979-49c7-ac6b-47b5623fcdcb","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Teller/{{teller_id}}?token={{token}}","description":"<h3 id=\"get-servicing-teller\">Get Servicing Teller</h3>\n<p>This operation accepts associated user login or teller GUID in <code>id</code>. The GUID must identify the selected record type. A user GUID identifies a different record; use the associated user login or the collector/teller GUID.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Teller/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. associated user login or teller GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingTellerEntity</code> including <code>Id</code>, user reference, GL account references, starting balance, funds code, payment transaction code, bank account references, and <code>Ts</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>associated user login or teller GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Teller/teller.login\n/api/Client/Servicing/Teller/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Teller","{{teller_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"60258997-3c4f-44b5-a5ab-e6672bc23a23","name":"GetTeller - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Teller/{{teller_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Teller","{{teller_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f7a8b9c0-cccc-4ddd-aeee-56789abcdef0\",\n        \"UserId\": \"22222222-2222-2222-2222-222222222222\",\n        \"Active\": true,\n        \"CashGLAccountId\": \"33333333-3333-3333-3333-333333333333\",\n        \"OverShortGLAccountId\": \"44444444-4444-4444-4444-444444444444\",\n        \"StartingBalance\": 500.00,\n        \"AllowInnerBranchPayments\": true,\n        \"DefaultFundsCodeId\": \"55555555-5555-5555-5555-555555555555\",\n        \"DefaultPaymentTransCodeId\": \"66666666-6666-6666-6666-666666666666\",\n        \"DefaultBrBankAccountId\": \"77777777-7777-7777-7777-777777777777\",\n        \"AutoPostApiTransactionToBank\": false,\n        \"ApiBrBankAccountId\": null,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9U=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"5b5abde0-6d1d-4940-8202-6c02e3965542","name":"GetTeller - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Teller/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Teller","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"26f76f9f-9979-49c7-ac6b-47b5623fcdcb"},{"name":"TellersGetAll","id":"3b313abd-7499-4b4f-92f4-3f3ecb7c48af","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Teller?token={{token}}","description":"<h3 id=\"get-all-servicing-tellers\">Get All Servicing Tellers</h3>\n<p>Returns every teller for the current client. Delegates to <code>TellerWSServices.ReturnAllTellersWS</code>, which reads all rows from <code>Servicing.Teller</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Teller</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingTellerEntity</code> records including <code>Id</code>, user reference, GL account references, starting balance, funds code, payment transaction code, bank account references, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Teller"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"80b02bf1-9610-4f59-8321-865bd6466ff1","name":"GetAllTellers - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Teller?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Teller"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"f7a8b9c0-cccc-4ddd-aeee-56789abcdef0\",\n            \"UserId\": \"22222222-2222-2222-2222-222222222222\",\n            \"Active\": true,\n            \"CashGLAccountId\": \"33333333-3333-3333-3333-333333333333\",\n            \"OverShortGLAccountId\": \"44444444-4444-4444-4444-444444444444\",\n            \"StartingBalance\": 500.00,\n            \"AllowInnerBranchPayments\": true,\n            \"DefaultFundsCodeId\": \"55555555-5555-5555-5555-555555555555\",\n            \"DefaultPaymentTransCodeId\": \"66666666-6666-6666-6666-666666666666\",\n            \"DefaultBrBankAccountId\": \"77777777-7777-7777-7777-777777777777\",\n            \"AutoPostApiTransactionToBank\": false,\n            \"ApiBrBankAccountId\": null,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9U=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"f22b3285-bbc7-4df8-964a-cdfbf5acec9a","name":"GetAllTellers - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Teller?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Teller"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"3b313abd-7499-4b4f-92f4-3f3ecb7c48af"},{"name":"TellerUpdate","id":"c7c4b49a-0053-4149-9255-ac533884ec7a","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"userIdOrLogin\": \"developer\",\n    \"active\": false,\n    \"cashGLAccountNumberOrId\": \"10100\",\n    \"overShortGLAccountNumberOrId\": \"70900\",\n    \"startingBalance\": 1000.00,\n    \"allowInnerBranchPayments\": true,\n    \"defaultFundsCodeOrId\": \"Cash\",\n    \"defaultPaymentTransCodeOrId\": \"Regular Payment\",\n    \"defaultBrBankAccountId\": null,\n    \"autoPostApiTransactionToBank\": false,\n    \"apiBrBankAccountId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Teller/{{teller_id}}","description":"<h3 id=\"update-servicing-teller\">Update Servicing Teller</h3>\n<p>This operation accepts associated user login or teller GUID in <code>id</code>. The GUID must identify the selected record type. A user GUID identifies a different record; use the associated user login or the collector/teller GUID.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Teller/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. associated user login or teller GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>userIdOrLogin</em></td>\n<td>Required string. <code>Setup.[User].Id</code> Guid or <code>UserLogin</code> text.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required boolean. Whether the teller is active.</td>\n</tr>\n<tr>\n<td><em>cashGLAccountNumberOrId</em></td>\n<td>Required string. <code>GeneralLedger.GLAccount.Id</code> Guid or <code>AccountNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>overShortGLAccountNumberOrId</em></td>\n<td>Required string. <code>GeneralLedger.GLAccount.Id</code> Guid or <code>AccountNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>startingBalance</em></td>\n<td>Required decimal. Teller starting cash balance.</td>\n</tr>\n<tr>\n<td><em>allowInnerBranchPayments</em></td>\n<td>Optional boolean.</td>\n</tr>\n<tr>\n<td><em>defaultFundsCodeOrId</em></td>\n<td>Optional string. <code>Servicing.FundsCode.Id</code> Guid or description.</td>\n</tr>\n<tr>\n<td><em>defaultPaymentTransCodeOrId</em></td>\n<td>Optional string. <code>Servicing.PaymentTransCode.Id</code> Guid or description.</td>\n</tr>\n<tr>\n<td><em>defaultBrBankAccountId</em></td>\n<td>Optional Guid. <code>Common.BrBankAccount.Id</code>.</td>\n</tr>\n<tr>\n<td><em>autoPostApiTransactionToBank</em></td>\n<td>Required boolean.</td>\n</tr>\n<tr>\n<td><em>apiBrBankAccountId</em></td>\n<td>Optional Guid. <code>Common.BrBankAccount.Id</code> used for API transactions.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the <code>Id</code> of the updated teller.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>associated user login or teller GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Teller/teller.login\n/api/Client/Servicing/Teller/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Teller","{{teller_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d6591542-10ef-4d73-82da-38d1bc318d25","name":"UpdateTeller - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"userIdOrLogin\": \"developer\",\n    \"active\": false,\n    \"cashGLAccountNumberOrId\": \"10100\",\n    \"overShortGLAccountNumberOrId\": \"70900\",\n    \"startingBalance\": 1000.00,\n    \"allowInnerBranchPayments\": true,\n    \"defaultFundsCodeOrId\": \"Cash\",\n    \"defaultPaymentTransCodeOrId\": \"Regular Payment\",\n    \"defaultBrBankAccountId\": null,\n    \"autoPostApiTransactionToBank\": false,\n    \"apiBrBankAccountId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Teller/{{teller_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f7a8b9c0-cccc-4ddd-aeee-56789abcdef0\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"6bac495d-f57e-4606-b86f-b149553ed7c2","name":"UpdateTeller - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"userIdOrLogin\": \"developer\",\n    \"active\": false,\n    \"cashGLAccountNumberOrId\": \"10100\",\n    \"overShortGLAccountNumberOrId\": \"70900\",\n    \"startingBalance\": 1000.00,\n    \"allowInnerBranchPayments\": true,\n    \"defaultFundsCodeOrId\": \"Cash\",\n    \"defaultPaymentTransCodeOrId\": \"Regular Payment\",\n    \"defaultBrBankAccountId\": null,\n    \"autoPostApiTransactionToBank\": false,\n    \"apiBrBankAccountId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Teller/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"c7c4b49a-0053-4149-9255-ac533884ec7a"},{"name":"TransactionCodeAdd","id":"b0b45bd7-8ea0-4e3a-8e52-986f03b678fc","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCodeOrId\": \"{{payment_waterfall_code_or_id}}\",\n    \"jsonHistory\": \"[]\",\n    \"includeSubAccountInAmountDueAndPastDue\": false,\n    \"includeInNextAmountDue\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode","description":"<h3 id=\"add-servicing-transaction-code\">Add Servicing Transaction Code</h3>\n<p>Creates a new transaction code for the current client. Delegates to <code>TransactionCodeWSServices.AddSaveTransactionCodeWS</code> with <code>id=null</code> and <code>ts=null</code>. Rejects the request when another transaction code with the same <code>transactionCode</code> already exists for the client.</p>\n<p>Lookup fields such as <code>generalLedgerAccountCodeOrId</code>, <code>otherBalReceivablesGLAccountCodeOrId</code>, <code>addRemarkCodeOrId</code>, <code>delRemarkCodeOrId</code>, <code>newAdminStatusCodeOrId</code>, and <code>waterfallCodeOrId</code> accept either the code/description or the underlying Guid — the BLL resolves each lookup in turn.</p>\n<p>Use <code>POST /api/Client/Servicing/TransactionCodeAndCreateNewWaterfall</code> when the transaction code must be created together with a brand-new payment waterfall in a single call.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCode</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>transactionCode</em></td>\n<td>Required string. Client-scoped unique transaction code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Transaction code description.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the code is available for selection.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form notes.</td>\n</tr>\n<tr>\n<td><em>transactionType</em></td>\n<td>Required enum. <code>Omega.Servicing.Types.Enums.TransactionTypes</code>.</td>\n</tr>\n<tr>\n<td><em>generalLedgerAccountCodeOrId</em></td>\n<td>Required string. GL account code or Guid.</td>\n</tr>\n<tr>\n<td><em>otherBalReceivablesGLAccountCodeOrId</em></td>\n<td>Optional string. Other-balance receivables GL account code or Guid.</td>\n</tr>\n<tr>\n<td><em>otherBalTransAccrualBasis</em></td>\n<td>Optional enum. <code>Omega.Servicing.Types.Enums.AccrualBasis</code>.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Add-remark code or Guid.</td>\n</tr>\n<tr>\n<td><em>delRemarkCodeOrId</em></td>\n<td>Optional string. Delete-remark code or Guid.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusCodeOrId</em></td>\n<td>Optional string. New admin status code or Guid.</td>\n</tr>\n<tr>\n<td><em>isJournalPayment</em></td>\n<td>Required bool. Whether this is a journal payment.</td>\n</tr>\n<tr>\n<td><em>pmtOrderType</em></td>\n<td>Required integer. Payment order type.</td>\n</tr>\n<tr>\n<td><em>bumpNextDueDate</em></td>\n<td>Required bool. Bump the next-due-date when applied.</td>\n</tr>\n<tr>\n<td><em>applyTowardsNextDueDate</em></td>\n<td>Required bool. Apply toward the next-due-date.</td>\n</tr>\n<tr>\n<td><em>waterfallCodeOrId</em></td>\n<td>Optional string. Existing payment waterfall code or Guid.</td>\n</tr>\n<tr>\n<td><em>jsonHistory</em></td>\n<td>Optional string. JSON change-history blob stored on the row.</td>\n</tr>\n<tr>\n<td><em>includeSubAccountInAmountDueAndPastDue</em></td>\n<td>Required bool. Include sub-accounts in amount-due and past-due calculations.</td>\n</tr>\n<tr>\n<td><em>includeInNextAmountDue</em></td>\n<td>Optional bool, other-balance fee codes only (Other Balance Misc Journal Entry, Other Balance Late Charge, NSF Fee). True adds the code's fees due from today through the next amount due date (posted, or scheduled by recurring billing) to Next Amount Due. Omit or send null to keep the code's current setting; a new code starts off.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new transaction code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCode"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7ed919ad-72f9-412c-8fc6-78cb27da5f5e","name":"AddTransactionCode - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCodeOrId\": \"STANDARD\",\n    \"jsonHistory\": \"[]\",\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"07ad9df3-28d7-4d8c-82f8-92fb57ac04c1","name":"AddTransactionCode - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCodeOrId\": \"STANDARD\",\n    \"jsonHistory\": \"[]\",\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"b0b45bd7-8ea0-4e3a-8e52-986f03b678fc"},{"name":"TransactionCodeAndCreateNewWaterfallAdd","id":"60633fb8-fc8a-47e1-be8b-c62fb4f70d74","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCode\": {\n        \"Code\": \"STANDARD\",\n        \"Description\": \"Standard Payment Waterfall\",\n        \"CreatedByUserId\": null,\n        \"Details\": [\n            {\n                \"SequenceNumber\": 1,\n                \"Item\": \"InterestDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            },\n            {\n                \"SequenceNumber\": 2,\n                \"Item\": \"PrincipalDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            }\n        ]\n    },\n    \"jsonHistory\": \"[]\",\n    \"overwriteExistingWaterfall\": false,\n    \"includeSubAccountInAmountDueAndPastDue\": false,\n    \"includeInNextAmountDue\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall","description":"<h3 id=\"add-servicing-transaction-code-and-create-new-waterfall\">Add Servicing Transaction Code And Create New Waterfall</h3>\n<p>Composite route that creates a new transaction code <strong>and</strong> a brand-new payment waterfall in a single call. Delegates to <code>TransactionCodeWSServices.AddSaveTransactionCodeAndCreateNewWaterfallWS</code> with <code>id=null</code> and <code>ts=null</code>, which in turn calls <code>TransactionCodeServices.AddSaveTransactionCodeAndCreateNewWaterfall</code>.</p>\n<p>The embedded <code>waterfallCode</code> payload matches <code>Omega.Servicing.BLL.PaymentWaterfallCodeObject.WaterfallCode</code> and is created as-if <code>POST /api/Client/Servicing/PaymentWaterfallCode</code> had been called first. Use <code>overwriteExistingWaterfall = true</code> to allow the request to replace a waterfall whose <code>Code</code> collides with an existing waterfall for the client; otherwise the route fails with a duplicate waterfall error.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>transactionCode</em></td>\n<td>Required string. Client-scoped unique transaction code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Transaction code description.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the code is available for selection.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form notes.</td>\n</tr>\n<tr>\n<td><em>transactionType</em></td>\n<td>Required enum. <code>Omega.Servicing.Types.Enums.TransactionTypes</code>.</td>\n</tr>\n<tr>\n<td><em>generalLedgerAccountCodeOrId</em></td>\n<td>Required string. GL account code or Guid.</td>\n</tr>\n<tr>\n<td><em>otherBalReceivablesGLAccountCodeOrId</em></td>\n<td>Optional string. Other-balance receivables GL account code or Guid.</td>\n</tr>\n<tr>\n<td><em>otherBalTransAccrualBasis</em></td>\n<td>Optional enum. <code>Omega.Servicing.Types.Enums.AccrualBasis</code>.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Add-remark code or Guid.</td>\n</tr>\n<tr>\n<td><em>delRemarkCodeOrId</em></td>\n<td>Optional string. Delete-remark code or Guid.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusCodeOrId</em></td>\n<td>Optional string. New admin status code or Guid.</td>\n</tr>\n<tr>\n<td><em>isJournalPayment</em></td>\n<td>Required bool. Whether this is a journal payment.</td>\n</tr>\n<tr>\n<td><em>pmtOrderType</em></td>\n<td>Required integer. Payment order type.</td>\n</tr>\n<tr>\n<td><em>bumpNextDueDate</em></td>\n<td>Required bool. Bump the next-due-date when applied.</td>\n</tr>\n<tr>\n<td><em>applyTowardsNextDueDate</em></td>\n<td>Required bool. Apply toward the next-due-date.</td>\n</tr>\n<tr>\n<td><em>waterfallCode</em></td>\n<td>Required object. New waterfall payload — matches <code>Omega.Servicing.BLL.PaymentWaterfallCodeObject.WaterfallCode</code>.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.Code</em></td>\n<td>Required string. New waterfall code.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.Description</em></td>\n<td>Required string. New waterfall description.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.CreatedByUserId</em></td>\n<td>Optional Guid. User Id recorded on the new waterfall.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.Details</em></td>\n<td>Required array. Ordered waterfall steps — each item is a <code>WaterfallDetail</code> with <code>SequenceNumber</code>, <code>Item</code> (<code>PaymentApplicationItem</code>), <code>OtherBalanceTransactionId</code>, <code>MethodOfPayment</code> (<code>PaymentApplicationItemMethodOfPayment</code>), and <code>OtherBalancePayCount</code>.</td>\n</tr>\n<tr>\n<td><em>jsonHistory</em></td>\n<td>Optional string. JSON change-history blob stored on the row.</td>\n</tr>\n<tr>\n<td><em>overwriteExistingWaterfall</em></td>\n<td>Required bool. When <code>true</code>, allows the new waterfall to replace an existing waterfall whose <code>Code</code> collides for the client.</td>\n</tr>\n<tr>\n<td><em>includeSubAccountInAmountDueAndPastDue</em></td>\n<td>Required bool. Include sub-accounts in amount-due and past-due calculations.</td>\n</tr>\n<tr>\n<td><em>includeInNextAmountDue</em></td>\n<td>Optional bool, other-balance fee codes only (Other Balance Misc Journal Entry, Other Balance Late Charge, NSF Fee). True adds the code's fees due from today through the next amount due date (posted, or scheduled by recurring billing) to Next Amount Due. Omit or send null to keep the code's current setting; a new code starts off.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new transaction code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCodeAndCreateNewWaterfall"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a81c3622-250c-45d8-9bbd-93555c6170e5","name":"AddTransactionCodeAndCreateNewWaterfall - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCode\": {\n        \"Code\": \"STANDARD\",\n        \"Description\": \"Standard Payment Waterfall\",\n        \"CreatedByUserId\": null,\n        \"Details\": [\n            {\n                \"SequenceNumber\": 1,\n                \"Item\": \"InterestDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            },\n            {\n                \"SequenceNumber\": 2,\n                \"Item\": \"PrincipalDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            }\n        ]\n    },\n    \"jsonHistory\": \"[]\",\n    \"overwriteExistingWaterfall\": false,\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"06a78ac8-6dc2-4ebd-aab3-f2d828f71fe8","name":"AddTransactionCodeAndCreateNewWaterfall - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCode\": {\n        \"Code\": \"STANDARD\",\n        \"Description\": \"Standard Payment Waterfall\",\n        \"CreatedByUserId\": null,\n        \"Details\": [\n            {\n                \"SequenceNumber\": 1,\n                \"Item\": \"InterestDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            },\n            {\n                \"SequenceNumber\": 2,\n                \"Item\": \"PrincipalDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            }\n        ]\n    },\n    \"jsonHistory\": \"[]\",\n    \"overwriteExistingWaterfall\": false,\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"60633fb8-fc8a-47e1-be8b-c62fb4f70d74"},{"name":"TransactionCodeAndCreateNewWaterfallUpdate","id":"9c14a4cc-04da-44a3-aba7-e40998a725db","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCode\": {\n        \"Code\": \"STANDARD-V2\",\n        \"Description\": \"Updated Payment Waterfall\",\n        \"CreatedByUserId\": null,\n        \"Details\": [\n            {\n                \"SequenceNumber\": 1,\n                \"Item\": \"InterestDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            },\n            {\n                \"SequenceNumber\": 2,\n                \"Item\": \"PrincipalDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            }\n        ]\n    },\n    \"jsonHistory\": \"[]\",\n    \"overwriteExistingWaterfall\": true,\n    \"includeSubAccountInAmountDueAndPastDue\": false,\n    \"includeInNextAmountDue\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall/{{transaction_code_or_id}}","description":"<h3 id=\"update-servicing-transaction-code-and-create-new-waterfall\">Update Servicing Transaction Code And Create New Waterfall</h3>\n<p>Composite route that updates an existing transaction code <strong>and</strong> creates a new payment waterfall attached to it in a single call. Delegates to <code>TransactionCodeWSServices.AddSaveTransactionCodeAndCreateNewWaterfallWS</code> with the resolved <code>id</code> and the stored <code>Ts</code>, which in turn calls <code>TransactionCodeServices.AddSaveTransactionCodeAndCreateNewWaterfall</code>. The controller resolves <code>codeOrId</code> by trying <code>Guid.TryParse</code> first and then falling back to <code>TransactionCodeServices.ReturnTransactionCodeId</code>.</p>\n<p>The existing <code>Ts</code> is fetched from the database and reused so the save honors optimistic concurrency — no caller-supplied <code>Ts</code> is accepted on this route.</p>\n<p>Set <code>overwriteExistingWaterfall = true</code> when the new waterfall's <code>Code</code> collides with an existing waterfall for the client and that waterfall should be replaced.</p>\n<p>Returns <code>\"Transaction code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.TransactionCode.Id</code> Guid or <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>transactionCode</em></td>\n<td>Required string. Client-scoped unique transaction code.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Required string. Transaction code description.</td>\n</tr>\n<tr>\n<td><em>available</em></td>\n<td>Required bool. Whether the code is available for selection.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form notes.</td>\n</tr>\n<tr>\n<td><em>transactionType</em></td>\n<td>Required enum. <code>Omega.Servicing.Types.Enums.TransactionTypes</code>.</td>\n</tr>\n<tr>\n<td><em>generalLedgerAccountCodeOrId</em></td>\n<td>Required string. GL account code or Guid.</td>\n</tr>\n<tr>\n<td><em>otherBalReceivablesGLAccountCodeOrId</em></td>\n<td>Optional string. Other-balance receivables GL account code or Guid.</td>\n</tr>\n<tr>\n<td><em>otherBalTransAccrualBasis</em></td>\n<td>Optional enum. <code>Omega.Servicing.Types.Enums.AccrualBasis</code>.</td>\n</tr>\n<tr>\n<td><em>addRemarkCodeOrId</em></td>\n<td>Optional string. Add-remark code or Guid.</td>\n</tr>\n<tr>\n<td><em>delRemarkCodeOrId</em></td>\n<td>Optional string. Delete-remark code or Guid.</td>\n</tr>\n<tr>\n<td><em>newAdminStatusCodeOrId</em></td>\n<td>Optional string. New admin status code or Guid.</td>\n</tr>\n<tr>\n<td><em>isJournalPayment</em></td>\n<td>Required bool. Whether this is a journal payment.</td>\n</tr>\n<tr>\n<td><em>pmtOrderType</em></td>\n<td>Required integer. Payment order type.</td>\n</tr>\n<tr>\n<td><em>bumpNextDueDate</em></td>\n<td>Required bool. Bump the next-due-date when applied.</td>\n</tr>\n<tr>\n<td><em>applyTowardsNextDueDate</em></td>\n<td>Required bool. Apply toward the next-due-date.</td>\n</tr>\n<tr>\n<td><em>waterfallCode</em></td>\n<td>Required object. New waterfall payload — matches <code>Omega.Servicing.BLL.PaymentWaterfallCodeObject.WaterfallCode</code>.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.Code</em></td>\n<td>Required string. New waterfall code.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.Description</em></td>\n<td>Required string. New waterfall description.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.CreatedByUserId</em></td>\n<td>Optional Guid. User Id recorded on the new waterfall.</td>\n</tr>\n<tr>\n<td><em>waterfallCode.Details</em></td>\n<td>Required array. Ordered waterfall steps — each item is a <code>WaterfallDetail</code> with <code>SequenceNumber</code>, <code>Item</code> (<code>PaymentApplicationItem</code>), <code>OtherBalanceTransactionId</code>, <code>MethodOfPayment</code> (<code>PaymentApplicationItemMethodOfPayment</code>), and <code>OtherBalancePayCount</code>.</td>\n</tr>\n<tr>\n<td><em>jsonHistory</em></td>\n<td>Optional string. JSON change-history blob stored on the row.</td>\n</tr>\n<tr>\n<td><em>overwriteExistingWaterfall</em></td>\n<td>Required bool. When <code>true</code>, allows the new waterfall to replace an existing waterfall whose <code>Code</code> collides for the client.</td>\n</tr>\n<tr>\n<td><em>includeSubAccountInAmountDueAndPastDue</em></td>\n<td>Required bool. Include sub-accounts in amount-due and past-due calculations.</td>\n</tr>\n<tr>\n<td><em>includeInNextAmountDue</em></td>\n<td>Optional bool, other-balance fee codes only (Other Balance Misc Journal Entry, Other Balance Late Charge, NSF Fee). True adds the code's fees due from today through the next amount due date (posted, or scheduled by recurring billing) to Next Amount Due. Omit or send null to keep the code's current setting; a new code starts off.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated transaction code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCodeAndCreateNewWaterfall","{{transaction_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"abaf356f-301f-4d9f-9511-8864a73d9c85","name":"UpdateTransactionCodeAndCreateNewWaterfall - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCode\": {\n        \"Code\": \"STANDARD-V2\",\n        \"Description\": \"Updated Payment Waterfall\",\n        \"CreatedByUserId\": null,\n        \"Details\": [\n            {\n                \"SequenceNumber\": 1,\n                \"Item\": \"InterestDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            },\n            {\n                \"SequenceNumber\": 2,\n                \"Item\": \"PrincipalDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            }\n        ]\n    },\n    \"jsonHistory\": \"[]\",\n    \"overwriteExistingWaterfall\": true,\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall/{{transaction_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"45b0c6ff-2683-4e73-80a1-abbe0ba6728e","name":"UpdateTransactionCodeAndCreateNewWaterfall - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCode\": {\n        \"Code\": \"STANDARD-V2\",\n        \"Description\": \"Updated Payment Waterfall\",\n        \"CreatedByUserId\": null,\n        \"Details\": [\n            {\n                \"SequenceNumber\": 1,\n                \"Item\": \"InterestDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            },\n            {\n                \"SequenceNumber\": 2,\n                \"Item\": \"PrincipalDue\",\n                \"OtherBalanceTransactionId\": null,\n                \"MethodOfPayment\": \"Full\",\n                \"OtherBalancePayCount\": null\n            }\n        ]\n    },\n    \"jsonHistory\": \"[]\",\n    \"overwriteExistingWaterfall\": true,\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCodeAndCreateNewWaterfall/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"9c14a4cc-04da-44a3-aba7-e40998a725db"},{"name":"TransactionCodeByCodeGet","id":"2210c86b-c608-4b9c-9f6c-bedf323ed5c3","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode/ByCode/{{transaction_code}}?token={{token}}","description":"<h3 id=\"get-servicing-transaction-code-by-code\">Get Servicing Transaction Code By Code</h3>\n<p>Helper route that returns a single transaction code matched by its string <code>Code</code>. Delegates to <code>TransactionCodeWSServices.ReturnTransactionCodeByStringWS</code>, which calls <code>TransactionCodeServices.ReturnTransactionCodeId</code> and then <code>ReturnTransactionCode</code>. Unlike <code>GET /TransactionCode/{codeOrId}</code>, this route treats the path segment strictly as a code (not a Guid).</p>\n<p>Returns <code>\"Transaction code not found\"</code> when the code does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCode/ByCode/{code}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>code</em></td>\n<td>Required string. <code>Servicing.TransactionCode.Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingTransactionCodeEntity</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCode","ByCode","{{transaction_code}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"ba5b4612-9480-40a9-9603-b03ad2594d14","name":"GetTransactionCodeByCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode/ByCode/{{transaction_code}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode","ByCode","{{transaction_code}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-1111-4222-9333-abcdef012345\",\n        \"TransactionCode\": \"PMT\",\n        \"Description\": \"Regular Payment\",\n        \"Available\": true,\n        \"TransactionType\": \"Payment\",\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"7d59f03f-cd86-4318-afcb-8e9b2513bd4b","name":"GetTransactionCodeByCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode/ByCode/{{transaction_code}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode","ByCode","{{transaction_code}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code not found\"\n    ]\n}"}],"_postman_id":"2210c86b-c608-4b9c-9f6c-bedf323ed5c3"},{"name":"TransactionCodeGet","id":"ba682f42-4e90-4168-b81b-d2cf47ff1ae1","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-transaction-code\">Get Servicing Transaction Code</h3>\n<p>Returns a single transaction code resolved by Guid or code. Delegates to <code>TransactionCodeWSServices.ReturnTransactionCodeWS</code>, which first attempts <code>Guid.TryParse</code>; if that fails it calls <code>TransactionCodeServices.ReturnTransactionCodeId</code> to resolve the client-scoped code, then fetches the record via <code>TransactionCodeServices.ReturnTransactionCode</code>.</p>\n<p>Returns <code>\"Transaction code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.TransactionCode.Id</code> Guid or <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingTransactionCodeEntity</code> with the full set of transaction code fields.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCode","{{transaction_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"98d937ff-2f44-4611-967a-72fd45e9619a","name":"GetTransactionCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode","{{transaction_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-1111-4222-9333-abcdef012345\",\n        \"TransactionCode\": \"PMT\",\n        \"Description\": \"Regular Payment\",\n        \"Available\": true,\n        \"Notes\": \"\",\n        \"TransactionType\": \"Payment\",\n        \"GeneralLedgerAccountId\": \"11111111-1111-4111-9111-111111111111\",\n        \"OtherBalReceivablesGLAccountId\": null,\n        \"OtherBalTransAccrualBasis\": null,\n        \"AddRemarkCodeId\": null,\n        \"DelRemarkCodeId\": null,\n        \"NewAdminStatusCodeId\": null,\n        \"IsJournalPayment\": false,\n        \"PmtOrderType\": 1,\n        \"BumpNextDueDate\": true,\n        \"ApplyTowardsNextDueDate\": true,\n        \"WaterfallCodeId\": \"22222222-2222-4222-9222-222222222222\",\n        \"JsonHistory\": \"[]\",\n        \"IncludeSubAccountInAmountDueAndPastDue\": false,\n        \"IncludeInNextAmountDue\": false,\n        \"Ts\": \"AAAAAAAAB9M=\"\n    },\n    \"errors\": []\n}"},{"id":"253f425e-a33d-4e04-b5df-00cbd6dd2bf2","name":"GetTransactionCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode","{{transaction_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code not found\"\n    ]\n}"}],"_postman_id":"ba682f42-4e90-4168-b81b-d2cf47ff1ae1"},{"name":"TransactionCodesGetAll","id":"b245ae38-ea7a-4ed8-b3ca-fd2c1480f17e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode?token={{token}}","description":"<h3 id=\"get-all-servicing-transaction-codes\">Get All Servicing Transaction Codes</h3>\n<p>Returns every transaction code for the current client. Delegates to <code>TransactionCodeWSServices.ReturnClientTransactionCodesWS</code>, which reads all rows from <code>Servicing.TransactionCode</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCode</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingTransactionCodeEntity</code> records.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCode"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c8350438-0a70-42de-b9a9-083b058f7fc9","name":"GetAllTransactionCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"f1a2b3c4-1111-4222-9333-abcdef012345\",\n            \"TransactionCode\": \"PMT\",\n            \"Description\": \"Regular Payment\",\n            \"Available\": true,\n            \"TransactionType\": \"Payment\",\n            \"Ts\": \"AAAAAAAAB9M=\"\n        },\n        {\n            \"Id\": \"a2b3c4d5-2222-4333-9444-bcdef0123456\",\n            \"TransactionCode\": \"FEE\",\n            \"Description\": \"Late Fee\",\n            \"Available\": true,\n            \"TransactionType\": \"Fee\",\n            \"Ts\": \"AAAAAAAAB9Q=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"83ee3f11-3038-405c-b264-7573f7e6533c","name":"GetAllTransactionCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/TransactionCode?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","TransactionCode"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid token\"\n    ]\n}"}],"_postman_id":"b245ae38-ea7a-4ed8-b3ca-fd2c1480f17e"},{"name":"TransactionCodeUpdate","id":"f9dfbda6-9cc0-469d-b320-c5d9636d4364","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment (Updated)\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCodeOrId\": \"{{payment_waterfall_code_or_id}}\",\n    \"jsonHistory\": \"[]\",\n    \"includeSubAccountInAmountDueAndPastDue\": false,\n    \"includeInNextAmountDue\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}","description":"<h3 id=\"update-servicing-transaction-code\">Update Servicing Transaction Code</h3>\n<p>Updates an existing transaction code, resolved by Guid or code. The controller first attempts <code>Guid.TryParse(codeOrId)</code>; if that fails it calls <code>TransactionCodeServices.ReturnTransactionCodeId</code> to resolve the client-scoped code. Returns <code>\"Transaction code not found\"</code> when neither the Guid nor the code match a record for the current client.</p>\n<p>Delegates to <code>TransactionCodeWSServices.AddSaveTransactionCodeWS</code> with the resolved <code>id</code> and the row's current <code>Ts</code> preserved for concurrency.</p>\n<p>Use <code>PUT /api/Client/Servicing/TransactionCodeAndCreateNewWaterfall/{codeOrId}</code> when the transaction code must be updated together with a brand-new payment waterfall in a single call.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/TransactionCode/{codeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. <code>Servicing.TransactionCode.Id</code> Guid or <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <code>POST /api/Client/Servicing/TransactionCode</code>. See that endpoint for the full field list.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated transaction code.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","TransactionCode","{{transaction_code_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"313a8624-34cd-4d1c-9d7b-91d8bf879ba1","name":"UpdateTransactionCode - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment (Updated)\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCodeOrId\": \"STANDARD\",\n    \"jsonHistory\": \"[]\",\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"f1a2b3c4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"60f33f16-9ec3-424a-b472-d8815dfdf3ec","name":"UpdateTransactionCode - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"transactionCode\": \"PMT\",\n    \"description\": \"Regular Payment (Updated)\",\n    \"available\": true,\n    \"notes\": \"\",\n    \"transactionType\": \"Payment\",\n    \"generalLedgerAccountCodeOrId\": \"1000\",\n    \"otherBalReceivablesGLAccountCodeOrId\": null,\n    \"otherBalTransAccrualBasis\": null,\n    \"addRemarkCodeOrId\": null,\n    \"delRemarkCodeOrId\": null,\n    \"newAdminStatusCodeOrId\": null,\n    \"isJournalPayment\": false,\n    \"pmtOrderType\": 1,\n    \"bumpNextDueDate\": true,\n    \"applyTowardsNextDueDate\": true,\n    \"waterfallCodeOrId\": \"STANDARD\",\n    \"jsonHistory\": \"[]\",\n    \"includeSubAccountInAmountDueAndPastDue\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/TransactionCode/{{transaction_code_or_id}}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"f9dfbda6-9cc0-469d-b320-c5d9636d4364"},{"name":"UnpaidOtherBalancesGet","id":"7362fca9-79c3-4c33-b1c7-e4455cff9540","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number}}/OtherBalances/Unpaid?token={{token}}&returnType=1","description":"<h3 id=\"get-servicing-account-unpaid-other-balances\">Get Servicing Account Unpaid Other Balances</h3>\n<p>Returns the slim projection of other-balance rows that still have a remaining amount due on the servicing account. Delegates to <code>OtherBalanceWSServices.ReturnUnpaidOtherBalancesWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> and calls <code>OtherBalanceServices.ReturnUnpaidOtherBalance(db, accountId, returnType)</code>. <code>data</code> is a <code>List&lt;OtherBalanceType&gt;</code> with the key balance fields rather than the full entity collection returned by the <code>/OtherBalances</code> route.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Account/{accountNumberOrId}/OtherBalances/Unpaid</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. Account number or <code>Common.Account</code> Id. Resolved by <code>SharedWSServices.GetCommonAccountId</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>returnType</em></td>\n<td>Optional int enum <code>OtherBalanceServices.OtherBalanceReturnType</code> — <code>All=1</code> (default), <code>LateFee=2</code>, <code>Other=3</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>List&lt;OtherBalanceType&gt;</code> with <code>Id</code>, <code>TransactionCodeId</code>, <code>Code</code>, <code>Description</code>, <code>AmountDue</code>, and related balance metadata. For the full entity collection with prefetched transaction history use <code>/api/Client/Servicing/Account/{accountNumberOrId}/OtherBalances</code>.</p>\n<h4 id=\"bulk-variant\">Bulk variant</h4>\n<p>Process one to 250 accounts in one call: <code>POST api/Client/Servicing/Account/Bulk/GetUnpaidOtherBalances</code>. Each array item supplies its own <code>returnType</code>. See <strong>Bulk Get Unpaid Other Balances</strong> in this collection.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","{{account_number}}","OtherBalances","Unpaid"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"returnType","value":"1"}],"variable":[]}},"response":[{"id":"8b0d5036-6343-4d29-a10e-085bb6bb1511","name":"GetUnpaidOtherBalances - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number}}/OtherBalances/Unpaid?token={{token}}&returnType=1","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","{{account_number}}","OtherBalances","Unpaid"],"query":[{"key":"token","value":"{{token}}"},{"key":"returnType","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"TransactionCodeId\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Code\": \"LATEFEE\",\n            \"Description\": \"Late Fee\",\n            \"AmountDue\": 100.00,\n            \"OriginalAmount\": 150.00,\n            \"AmountPaid\": 50.00,\n            \"TransactionDate\": \"2026-03-15T00:00:00\"\n        },\n        {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"TransactionCodeId\": \"e1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"Code\": \"NSF\",\n            \"Description\": \"NSF Fee\",\n            \"AmountDue\": 35.00,\n            \"OriginalAmount\": 35.00,\n            \"AmountPaid\": 0.00,\n            \"TransactionDate\": \"2026-04-01T00:00:00\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"8366ba8c-cca8-4eb8-85fb-6a671f249df9","name":"GetUnpaidOtherBalances - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/000000000/OtherBalances/Unpaid?token={{token}}&returnType=1","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","000000000","OtherBalances","Unpaid"],"query":[{"key":"token","value":"{{token}}"},{"key":"returnType","value":"1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Account not found\"\n    ]\n}"}],"_postman_id":"7362fca9-79c3-4c33-b1c7-e4455cff9540"},{"name":"UnpaidOtherBalancesGetBulk","id":"e3ea0d0f-51f7-4e25-821e-58be7c5e5b53","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\", \"returnType\": 1 },\n  { \"accountNumberOrId\": \"{{account_id}}\", \"returnType\": 2 }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidOtherBalances?token={{token}}","description":"<h3 id=\"bulk-get-unpaid-other-balances\">Bulk Get Unpaid Other Balances</h3>\n<p>Returns the unpaid Other Balance projection for several accounts. The request body is an array of per-account objects containing one to 250 items, so each account can choose its own <code>returnType</code>. <code>accountNumberOrId</code> accepts an account number or <code>Common.Account</code> Id. The request is capped at 250 accounts and requires token or API-key authentication.</p>\n<p>This route reuses the API Access permission for <code>GET api/Client/Servicing/Account/{accountNumberOrId}/OtherBalances/Unpaid</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","Bulk","GetUnpaidOtherBalances"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e67be7c0-b581-4a96-acd2-2a31fac0fd6b","name":"UnpaidOtherBalancesGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"returnType\": 1\n  },\n  {\n    \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n    \"returnType\": 2\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 2,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [\n          {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"TransactionCodeId\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Code\": \"LATEFEE\",\n            \"Description\": \"Late Fee\",\n            \"AmountDue\": 100,\n            \"OriginalAmount\": 150,\n            \"AmountPaid\": 50,\n            \"TransactionDate\": \"2026-03-15T00:00:00\"\n          }\n        ]\n      },\n      {\n        \"accountNumber\": 30001213,\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": []\n      }\n    ]\n  }\n}"},{"id":"c935089e-4108-4f91-bd2a-61ed1d1b60d8","name":"UnpaidOtherBalancesGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\",\n    \"returnType\": 1\n  },\n  {\n    \"accountNumberOrId\": \"99999999\",\n    \"returnType\": 1\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": [\n          {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"TransactionCodeId\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Code\": \"LATEFEE\",\n            \"Description\": \"Late Fee\",\n            \"AmountDue\": 100,\n            \"OriginalAmount\": 150,\n            \"AmountPaid\": 50,\n            \"TransactionDate\": \"2026-03-15T00:00:00\"\n          }\n        ]\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"9956fd34-ac10-4f4b-b2de-8c5c0f72834e","name":"UnpaidOtherBalancesGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"6006013a-b7f9-4bda-99f9-cea25ecc742d","name":"UnpaidOtherBalancesGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1},{\"accountNumberOrId\":\"30001212\",\"returnType\":1}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidOtherBalances?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidOtherBalances"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e3ea0d0f-51f7-4e25-821e-58be7c5e5b53"},{"name":"UnpaidSubAccountTotalGet","id":"2e672d8c-bf0e-4a60-ba13-e8030700a564","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number_or_id}}/SubAccounts/UnpaidTotal?token={{token}}","description":"<h3 id=\"get-unpaid-subaccount-total\">Get Unpaid SubAccount Total</h3>\n<p>Returns the aggregate unpaid balance across all subaccounts for the specified account. Delegates to <code>SubAccountWSServices.ReturnUnpaidSubAccountTotalWS</code>, which resolves the account via <code>SharedWSServices.GetCommonAccountId</code> (Guid or <code>AccountNumber</code> string) and sums <code>OriginalBalance + AdjustmentAmount − AmountPaid</code> across every subaccount whose unpaid remainder is positive.</p>\n<p>Returns <code>\"Account not found\"</code> when the identifier does not match a record for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Account/{accountNumberOrId}/SubAccounts/UnpaidTotal</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>accountNumberOrId</em></td>\n<td>Required string. <code>Common.Account.Id</code> Guid or <code>AccountNumber</code> string.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a decimal representing the sum of unpaid subaccount balances.</p>\n<h4 id=\"bulk-variant\">Bulk variant</h4>\n<p>Process one to 250 accounts in one call: <code>POST api/Client/Servicing/Account/Bulk/GetUnpaidSubAccountTotal</code>. See <strong>Bulk Get Unpaid Subaccount Total</strong> in this collection.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","{{account_number_or_id}}","SubAccounts","UnpaidTotal"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fdadb7e2-272a-49b4-92aa-24980d763614","name":"GetUnpaidSubAccountTotal - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/{{account_number_or_id}}/SubAccounts/UnpaidTotal?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","{{account_number_or_id}}","SubAccounts","UnpaidTotal"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": 400.00,\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"c490f3be-65f8-41d5-87c5-dc5e41cc680a","name":"GetUnpaidSubAccountTotal - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/000000000/SubAccounts/UnpaidTotal?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","000000000","SubAccounts","UnpaidTotal"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Account not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"2e672d8c-bf0e-4a60-ba13-e8030700a564"},{"name":"UnpaidSubAccountTotalGetBulk","id":"71564462-4dc8-4ef1-bd13-5e3e254f1edc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  { \"accountNumberOrId\": \"{{account_number}}\" },\n  { \"accountNumberOrId\": \"{{account_id}}\" }\n]","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidSubAccountTotal?token={{token}}","description":"<h3 id=\"bulk-get-unpaid-subaccount-total\">Bulk Get Unpaid Subaccount Total</h3>\n<p>Returns the unpaid Subaccount total for several accounts. The body must be an array containing one to 250 items. Each <code>accountNumberOrId</code> accepts an account number or <code>Common.Account</code> Id. Token or API-key authentication is required.</p>\n<p>This route reuses the API Access permission for <code>GET api/Client/Servicing/Account/{accountNumberOrId}/SubAccounts/UnpaidTotal</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Account","Bulk","GetUnpaidSubAccountTotal"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"b9a45028-83b4-45b5-95a1-ef5ed4263e65","name":"UnpaidSubAccountTotalGetBulk - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidSubAccountTotal?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidSubAccountTotal"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Ok\",\n  \"result\": \"Ok\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 2,\n    \"succeededWithError\": 0,\n    \"failed\": 0,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": 400\n      },\n      {\n        \"accountNumber\": 30001213,\n        \"accountNumberOrId\": \"7d9496f3-58a7-4e6e-a52d-a0c0fe781213\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": 0\n      }\n    ]\n  }\n}"},{"id":"f9e3e574-b64a-4c0a-b2fe-800ce07feee5","name":"UnpaidSubAccountTotalGetBulk - Partial Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n  {\n    \"accountNumberOrId\": \"30001212\"\n  },\n  {\n    \"accountNumberOrId\": \"99999999\"\n  }\n]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidSubAccountTotal?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidSubAccountTotal"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Successful_With_Error\",\n  \"result\": \"Successful With Error\",\n  \"errors\": [],\n  \"warnings\": [],\n  \"data\": {\n    \"requestId\": \"3f7c1f0e-9a44-4d21-8f6b-1c2d3e4f5a6b\",\n    \"requested\": 2,\n    \"total\": 2,\n    \"succeeded\": 1,\n    \"succeededWithError\": 0,\n    \"failed\": 1,\n    \"skipped\": 0,\n    \"accounts\": [\n      {\n        \"accountNumber\": 30001212,\n        \"accountNumberOrId\": \"30001212\",\n        \"status\": \"Succeeded\",\n        \"message\": null,\n        \"singleStatusCode\": \"Ok\",\n        \"singleResult\": \"Ok\",\n        \"errors\": [],\n        \"warnings\": [],\n        \"data\": 400\n      },\n      {\n        \"accountNumber\": 99999999,\n        \"accountNumberOrId\": \"99999999\",\n        \"status\": \"Failed\",\n        \"message\": \"Account not found\",\n        \"singleStatusCode\": \"Error\",\n        \"singleResult\": \"Error\",\n        \"errors\": [\n          \"Account not found\"\n        ],\n        \"warnings\": [],\n        \"data\": null\n      }\n    ]\n  }\n}"},{"id":"729d2fdc-9cbf-4012-a97b-39cb6b6f7868","name":"UnpaidSubAccountTotalGetBulk - Failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidSubAccountTotal?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidSubAccountTotal"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": \"Error\",\n  \"result\": \"Error\",\n  \"errors\": [\n    \"At least one account request is required.\"\n  ],\n  \"warnings\": [],\n  \"data\": null\n}"},{"id":"425fae80-1e35-4659-b09c-8642c3844e9a","name":"UnpaidSubAccountTotalGetBulk - Over the cap","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"},{\"accountNumberOrId\":\"30001212\"}]","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Account/Bulk/GetUnpaidSubAccountTotal?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Account","Bulk","GetUnpaidSubAccountTotal"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"A maximum of 250 accounts may be processed in one request (received 251). Split the request into smaller batches.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"71564462-4dc8-4ef1-bd13-5e3e254f1edc"},{"name":"VaultAdd","id":"27634582-153a-4d23-bad0-f155031ce1b3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"1\",\n    \"vaultGLAccountNumberOrId\": \"10150\",\n    \"balance\": 5000.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Vault","description":"<h3 id=\"add-servicing-vault\">Add Servicing Vault</h3>\n<p>Creates a new vault for the current client. Delegates to <code>VaultWSServices.AddSaveVaultWS</code>, which resolves the branch by number/Id, the vault GL account by number/Id, and inserts a new <code>Servicing.Vault</code> row scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Vault</code></p>\n<h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Required string. <code>Common.Branch.Id</code> Guid or <code>BranchNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>vaultGLAccountNumberOrId</em></td>\n<td>Required string. <code>GeneralLedger.GLAccount.Id</code> Guid or <code>AccountNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>balance</em></td>\n<td>Required decimal. Starting vault balance.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the new <code>Id</code> of the created vault.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Vault"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e08a84db-eb94-4533-b21b-694ebb3e1e67","name":"AddVault - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"1\",\n    \"vaultGLAccountNumberOrId\": \"10150\",\n    \"balance\": 5000.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Vault"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a8b9c0d1-dddd-4eee-afff-6789abcdef01\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"05d97397-54c7-45b3-a069-2f4ff3155354","name":"AddVault - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"9999\",\n    \"vaultGLAccountNumberOrId\": \"10150\",\n    \"balance\": 5000.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Vault"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Branch not found\"\n    ]\n}"}],"_postman_id":"27634582-153a-4d23-bad0-f155031ce1b3"},{"name":"VaultGet","id":"225076e7-bf84-4153-840f-28f00a5ce220","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Vault/{{vault_id}}?token={{token}}","description":"<h3 id=\"get-servicing-vault\">Get Servicing Vault</h3>\n<p>This operation accepts branch number or vault GUID in <code>id</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Vault/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. branch number or vault GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a <code>MyServicingVaultEntity</code> with <code>Id</code>, branch reference, GL account reference, <code>Balance</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>branch number or vault GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Vault/90\n/api/Client/Servicing/Vault/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Vault","{{vault_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"6e6072e5-d85e-4976-9b6d-58222866af19","name":"GetVault - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Vault/{{vault_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Vault","{{vault_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a8b9c0d1-dddd-4eee-afff-6789abcdef01\",\n        \"BranchId\": \"88888888-8888-8888-8888-888888888888\",\n        \"VaultGLAccountId\": \"99999999-9999-9999-9999-999999999999\",\n        \"Balance\": 5000.00,\n        \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n        \"Ts\": \"AAAAAAAAB9Y=\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"b1fcf7ca-d05b-4b68-8856-3aed9036de4a","name":"GetVault - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Vault/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Vault","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"225076e7-bf84-4153-840f-28f00a5ce220"},{"name":"VaultsGetAll","id":"7b1226e6-1af4-44d2-b9ad-723ca855bbc8","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Vault?token={{token}}","description":"<h3 id=\"get-all-servicing-vaults\">Get All Servicing Vaults</h3>\n<p>Returns every vault for the current client. Delegates to <code>VaultWSServices.ReturnAllVaultsWS</code>, which reads all rows from <code>Servicing.Vault</code> scoped to the authenticated client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Vault</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingVaultEntity</code> records with <code>Id</code>, branch reference, GL account reference, <code>Balance</code>, <code>ClientId</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Vault"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7b63e0f7-4126-426c-9a36-24c1137c1ade","name":"GetAllVaults - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Vault?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Vault"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a8b9c0d1-dddd-4eee-afff-6789abcdef01\",\n            \"BranchId\": \"88888888-8888-8888-8888-888888888888\",\n            \"VaultGLAccountId\": \"99999999-9999-9999-9999-999999999999\",\n            \"Balance\": 5000.00,\n            \"ClientId\": \"11111111-1111-1111-1111-111111111111\",\n            \"Ts\": \"AAAAAAAAB9Y=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8b47d1b1-c092-449f-afd9-646569098edc","name":"GetAllVaults - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Vault?token=invalid-token","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Vault"],"query":[{"key":"token","value":"invalid-token"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ]\n}"}],"_postman_id":"7b1226e6-1af4-44d2-b9ad-723ca855bbc8"},{"name":"VaultTransactionsGet","id":"d19ae05e-7e6c-4212-8959-a48f48fba70c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/Vault/{{vault_id}}/Transactions?transactionType={{vault_transaction_type}}&token={{token}}","description":"<h3 id=\"get-servicing-vault-transactions\">Get Servicing Vault Transactions</h3>\n<p>This operation accepts branch number or vault GUID in <code>id</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Vault/{id}/Transactions</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. branch number or vault GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>transactionType</em></td>\n<td>Optional integer. Matches <code>Omega.Servicing.Types.Enums.VaultTransactionTypes</code>. Omit to return all transaction types.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of <code>MyServicingVaultTransactionEntity</code> records with <code>Id</code>, <code>VaultId</code>, <code>TransactionType</code>, <code>Amount</code>, <code>TransactionDate</code>, and <code>Ts</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>branch number or vault GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Vault/90/Transactions\n/api/Client/Servicing/Vault/11111111-1111-4111-8111-111111111111/Transactions\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Vault","{{vault_id}}","Transactions"],"host":["{{base_url}}"],"query":[{"key":"transactionType","value":"{{vault_transaction_type}}"},{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"b400680d-2360-42b4-86e7-812ca3b61fd8","name":"GetVaultTransactions - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Vault/{{vault_id}}/Transactions?transactionType={{vault_transaction_type}}&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Vault","{{vault_id}}","Transactions"],"query":[{"key":"transactionType","value":"{{vault_transaction_type}}"},{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"b9c0d1e2-eeee-4fff-a000-789abcdef012\",\n            \"VaultId\": \"a8b9c0d1-dddd-4eee-afff-6789abcdef01\",\n            \"TransactionType\": 1,\n            \"Amount\": 1000.00,\n            \"TransactionDate\": \"2026-04-01T00:00:00\",\n            \"Ts\": \"AAAAAAAAB9c=\"\n        },\n        {\n            \"Id\": \"c0d1e2f3-ffff-4000-a111-89abcdef0123\",\n            \"VaultId\": \"a8b9c0d1-dddd-4eee-afff-6789abcdef01\",\n            \"TransactionType\": 2,\n            \"Amount\": 500.00,\n            \"TransactionDate\": \"2026-04-05T00:00:00\",\n            \"Ts\": \"AAAAAAAAB9g=\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"fc29da9e-5d61-47f5-b36a-6e65e3226ed7","name":"GetVaultTransactions - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/Vault/11111111-1111-4111-8111-111111111111/Transactions?transactionType={{vault_transaction_type}}&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","Vault","11111111-1111-4111-8111-111111111111","Transactions"],"query":[{"key":"transactionType","value":"{{vault_transaction_type}}"},{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"d19ae05e-7e6c-4212-8959-a48f48fba70c"},{"name":"VaultUpdate","id":"e40b3dc2-c560-40bb-b713-c3e11981a981","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"1\",\n    \"vaultGLAccountNumberOrId\": \"10150\",\n    \"balance\": 7500.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Vault/{{vault_id}}","description":"<h3 id=\"update-servicing-vault\">Update Servicing Vault</h3>\n<p>This operation accepts branch number or vault GUID in <code>id</code>. The GUID must identify the selected record type.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/Vault/{id}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Required string. branch number or vault GUID. Unknown or ambiguous values are rejected.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"body-parameters\">Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Required string. <code>Common.Branch.Id</code> Guid or <code>BranchNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>vaultGLAccountNumberOrId</em></td>\n<td>Required string. <code>GeneralLedger.GLAccount.Id</code> Guid or <code>AccountNumber</code> text.</td>\n</tr>\n<tr>\n<td><em>balance</em></td>\n<td>Required decimal. Vault balance.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> contains the <code>Id</code> of the updated vault.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Route/query field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>branch number or vault GUID. Required; URL-encode the value.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>Example paths (illustrative keys and GUID; replace with an existing record and retain authentication):</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-text\">/api/Client/Servicing/Vault/90\n/api/Client/Servicing/Vault/11111111-1111-4111-8111-111111111111\n</code></pre>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","Vault","{{vault_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a6adf5a5-ee94-4a75-acad-3ecbd15cfed0","name":"UpdateVault - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"1\",\n    \"vaultGLAccountNumberOrId\": \"10150\",\n    \"balance\": 7500.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Vault/{{vault_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a8b9c0d1-dddd-4eee-afff-6789abcdef01\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8c922a41-853a-4d0d-b88b-f1c09cde9966","name":"UpdateVault - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": \"1\",\n    \"vaultGLAccountNumberOrId\": \"10150\",\n    \"balance\": 7500.00\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/Vault/11111111-1111-4111-8111-111111111111"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"id: record not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"e40b3dc2-c560-40bb-b713-c3e11981a981"},{"name":"WaterfallDetailAdd","id":"2bcee6e0-777d-4d52-b178-288f602dd02d","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCodeOrId\": \"{{payment_waterfall_code_or_id}}\",\n  \"sequenceNumber\": 1,\n  \"item\": 1,\n  \"specificTransCodeId\": null,\n  \"methodOfPayment\": 1,\n  \"payCount\": 1,\n  \"specificTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail","description":"<h3 id=\"add-servicing-payment-waterfall-detail\">Add Servicing Payment Waterfall Detail</h3>\n<p>Creates a new waterfall detail row attached to an existing waterfall code. The controller resolves <code>waterfallCodeOrId</code> via <code>Guid.TryParse</code> or <code>PaymentWaterfallCodeServices.ReturnPaymentWaterfallId</code>, then delegates to <code>PaymentWaterfallCodeWSServices.AddSaveWaterfallDetailWS</code> with <code>waterfallDetailId=null</code> and <code>ts=null</code>.</p>\n<p>Rejects with <code>\"Payment waterfall code not found\"</code> when <code>waterfallCodeOrId</code> does not resolve to an existing record.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>waterfallCodeOrId</em></td>\n<td>Required string. Existing <code>Servicing.PaymentWaterfallCode.Code</code> or Id to attach the detail to.</td>\n</tr>\n<tr>\n<td><em>sequenceNumber</em></td>\n<td>Required int. 1-based order the detail is applied.</td>\n</tr>\n<tr>\n<td><em>item</em></td>\n<td>Required int enum <code>PaymentApplicationItem</code> — e.g. <code>Principal=1</code>, <code>Interest=2</code>, <code>All_Other_Balance=3</code>, <code>Specific_Other_Balance=4</code>, <code>Past_Due_Interest_And_Principal=5</code>, <code>Whole_Payment_Ignore_Update_Percent=6</code>, <code>Whole_Payment_Include_Update_Percent=7</code>, <code>Past_And_Current_Amount_Due_Principal_And_Interest=8</code>, <code>All_Sub_Account_By_Period=9</code>, <code>Specific_Sub_Account_By_Period=10</code>, <code>All_Sub_Account_By_Percent_Of_Principal=11</code>, <code>Specific_Sub_Account_By_Percent_Of_Principal=12</code>.</td>\n</tr>\n<tr>\n<td><em>specificTransCodeId</em></td>\n<td>Optional Guid. Required when <code>item</code> targets a specific other-balance / sub-account transaction code.</td>\n</tr>\n<tr>\n<td><em>methodOfPayment</em></td>\n<td>Optional int enum <code>PaymentApplicationItemMethodOfPayment</code> — <code>Periods_To_Pay=1</code>, <code>Pay_X_Periods_Ahead=2</code>.</td>\n</tr>\n<tr>\n<td><em>payCount</em></td>\n<td>Optional int. Count paired with <code>methodOfPayment</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the new waterfall detail row.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>specificTransCodeOrId</code></td>\n<td><code>specificTransCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"specificTransCodeOrId\": \"PYC\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallDetail"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"09d206ea-d250-44ad-b69f-702ad62314d2","name":"AddWaterfallDetail - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCodeOrId\": \"STANDARD\",\n  \"sequenceNumber\": 1,\n  \"item\": 1,\n  \"specificTransCodeId\": null,\n  \"methodOfPayment\": 1,\n  \"payCount\": 1,\n  \"specificTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"1fc77740-94dc-49be-8925-99d877b86695","name":"AddWaterfallDetail - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCodeOrId\": \"DOES_NOT_EXIST\",\n  \"sequenceNumber\": 1,\n  \"item\": 1,\n  \"specificTransCodeId\": null,\n  \"methodOfPayment\": 1,\n  \"payCount\": 1,\n  \"specificTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Payment waterfall code not found\"\n    ]\n}"}],"_postman_id":"2bcee6e0-777d-4d52-b178-288f602dd02d"},{"name":"WaterfallDetailByTransactionCodeGet","id":"e897197e-32ed-4c9e-8db1-826fc52a3208","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByTransactionCode/{{servicing_transaction_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-payment-waterfall-details-by-transaction-code\">Get Servicing Payment Waterfall Details by Transaction Code</h3>\n<p>Returns every payment waterfall detail row that references a specific <code>Servicing.TransactionCode</code>. Delegates to <code>PaymentWaterfallCodeWSServices.ReturnWaterfallDetailByTransactionCodeIdWS</code>, which resolves the transaction code via <code>SharedWSServices.GetServicingTransactionCodeId</code> and then calls <code>PaymentWaterfallCodeServices.ReturnWaterfallDetailByTransactionCodeId</code>.</p>\n<p>Use this route to audit which waterfall lines currently consume a given other-balance / sub-account transaction code before editing or retiring it. Rejects with <code>\"Transaction code not found\"</code> when the <code>{transactionCodeOrId}</code> does not resolve for the current client.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByTransactionCode/{transactionCodeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>transactionCodeOrId</em></td>\n<td>Required string. <code>Servicing.TransactionCode.Code</code> or Id.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of waterfall detail rows with <code>Id</code>, <code>WaterfallCodeId</code>, <code>SequenceNumber</code>, <code>Item</code>, <code>SpecificTransCodeId</code>, <code>MethodOfPayment</code>, <code>PayCount</code>, and the parent waterfall code/description.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallDetail","ByTransactionCode","{{servicing_transaction_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c95cf02f-12be-48d8-b5f7-c54937d556b3","name":"GetWaterfallDetailByTransactionCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByTransactionCode/{{servicing_transaction_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallDetail","ByTransactionCode","{{servicing_transaction_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"WaterfallCodeId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"WaterfallCode\": \"STANDARD\",\n            \"WaterfallDescription\": \"Standard Payment Waterfall\",\n            \"SequenceNumber\": 2,\n            \"Item\": 4,\n            \"SpecificTransCodeId\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"MethodOfPayment\": 1,\n            \"PayCount\": 1\n        },\n        {\n            \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"WaterfallCodeId\": \"b1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"WaterfallCode\": \"COLLECTIONS\",\n            \"WaterfallDescription\": \"Collections Payment Waterfall\",\n            \"SequenceNumber\": 1,\n            \"Item\": 4,\n            \"SpecificTransCodeId\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"MethodOfPayment\": 1,\n            \"PayCount\": 1\n        }\n    ],\n    \"errors\": []\n}"},{"id":"fb30c8ab-7077-4bee-9a49-5ee2f4b9830b","name":"GetWaterfallDetailByTransactionCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByTransactionCode/NONEXISTENT?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallDetail","ByTransactionCode","NONEXISTENT"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Transaction code not found\"\n    ]\n}"}],"_postman_id":"e897197e-32ed-4c9e-8db1-826fc52a3208"},{"name":"WaterfallDetailByWaterfallCodeGet","id":"5cf120e6-1a8b-4249-a391-c929d681f6e3","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByWaterfallCode/{{payment_waterfall_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-payment-waterfall-details-by-waterfall-code\">Get Servicing Payment Waterfall Details by Waterfall Code</h3>\n<p>Returns the ordered detail rows that make up a payment waterfall. Delegates to <code>PaymentWaterfallCodeWSServices.ReturnWaterfallDetailByWaterfallIdWS</code>, which resolves the waterfall via <code>SharedWSServices.GetServicingPaymentWaterfallId</code> and then calls <code>PaymentWaterfallCodeServices.ReturnWaterfallDetailByWaterfallId</code>.</p>\n<p>Rejects with <code>\"Payment waterfall code not found\"</code> when <code>{waterfallCodeOrId}</code> does not resolve for the current client. For the flat list of distinct transaction codes referenced by those detail rows, use <code>/api/Client/Servicing/PaymentWaterfallTransactionCodes/{waterfallCodeOrId}</code> instead.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByWaterfallCode/{waterfallCodeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>waterfallCodeOrId</em></td>\n<td>Required string. <code>Servicing.PaymentWaterfallCode.Code</code> or Id.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of waterfall detail rows ordered by <code>SequenceNumber</code>, each with <code>Id</code>, <code>SequenceNumber</code>, <code>Item</code>, <code>SpecificTransCodeId</code>, <code>MethodOfPayment</code>, <code>PayCount</code>, and <code>Ts</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallDetail","ByWaterfallCode","{{payment_waterfall_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"79747d40-0b39-4540-9fb5-0af4a58a26c2","name":"GetWaterfallDetailByWaterfallCode - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByWaterfallCode/{{payment_waterfall_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallDetail","ByWaterfallCode","{{payment_waterfall_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"SequenceNumber\": 1,\n            \"Item\": 5,\n            \"SpecificTransCodeId\": null,\n            \"MethodOfPayment\": 1,\n            \"PayCount\": 1,\n            \"Ts\": \"AAAAAAAAB9M=\"\n        },\n        {\n            \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"SequenceNumber\": 2,\n            \"Item\": 3,\n            \"SpecificTransCodeId\": null,\n            \"MethodOfPayment\": 1,\n            \"PayCount\": 1,\n            \"Ts\": \"AAAAAAAAB9N=\"\n        },\n        {\n            \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012347\",\n            \"SequenceNumber\": 3,\n            \"Item\": 1,\n            \"SpecificTransCodeId\": null,\n            \"MethodOfPayment\": null,\n            \"PayCount\": null,\n            \"Ts\": \"AAAAAAAAB9O=\"\n        }\n    ],\n    \"errors\": []\n}"},{"id":"458f0e76-b791-4b08-9f33-1e59bae0df69","name":"GetWaterfallDetailByWaterfallCode - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/ByWaterfallCode/NONEXISTENT?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallDetail","ByWaterfallCode","NONEXISTENT"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Payment waterfall code not found\"\n    ]\n}"}],"_postman_id":"5cf120e6-1a8b-4249-a391-c929d681f6e3"},{"name":"WaterfallDetailUpdate","id":"3999a941-76ec-456e-9b49-4acf39ba3744","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCodeOrId\": \"{{payment_waterfall_code_or_id}}\",\n  \"sequenceNumber\": 2,\n  \"item\": 2,\n  \"specificTransCodeId\": null,\n  \"methodOfPayment\": 1,\n  \"payCount\": 1,\n  \"specificTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/{{payment_waterfall_detail_id}}","description":"<h3 id=\"update-servicing-payment-waterfall-detail\">Update Servicing Payment Waterfall Detail</h3>\n<p>Updates an existing waterfall detail row. The controller:</p>\n<ol>\n<li>Parses <code>{waterfallDetailId}</code> as a Guid (rejects <code>\"Invalid waterfall detail ID\"</code> otherwise).</li>\n<li>Resolves <code>waterfallCodeOrId</code> via <code>Guid.TryParse</code> or <code>PaymentWaterfallCodeServices.ReturnPaymentWaterfallId</code>.</li>\n<li>Fetches the existing details via <code>PaymentWaterfallCodeServices.ReturnWaterfallDetailByWaterfallId</code> and finds the detail by <code>Id</code> to capture the concurrency <code>Ts</code>.</li>\n<li>Delegates to <code>PaymentWaterfallCodeWSServices.AddSaveWaterfallDetailWS</code> with the existing <code>waterfallDetailId</code> and <code>ts</code>.</li>\n</ol>\n<p>Rejects with <code>\"Payment waterfall detail not found\"</code> when the detail row does not exist under the referenced waterfall.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/{waterfallDetailId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>waterfallDetailId</em></td>\n<td>Required Guid. <code>Servicing.PaymentWaterfallDetail.Id</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>waterfallCodeOrId</em></td>\n<td>Required string. Existing <code>Servicing.PaymentWaterfallCode.Code</code> or Id the detail belongs to.</td>\n</tr>\n<tr>\n<td><em>sequenceNumber</em></td>\n<td>Required int. 1-based order the detail is applied.</td>\n</tr>\n<tr>\n<td><em>item</em></td>\n<td>Required int enum <code>PaymentApplicationItem</code> (see <code>AddWaterfallDetail</code> for values).</td>\n</tr>\n<tr>\n<td><em>specificTransCodeId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>methodOfPayment</em></td>\n<td>Optional int enum <code>PaymentApplicationItemMethodOfPayment</code> — <code>Periods_To_Pay=1</code>, <code>Pay_X_Periods_Ahead=2</code>.</td>\n</tr>\n<tr>\n<td><em>payCount</em></td>\n<td>Optional int.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ Id }</code> — the Guid of the updated waterfall detail row.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>specificTransCodeOrId</code></td>\n<td><code>specificTransCodeId</code></td>\n<td>String. transaction code or transaction-code GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"specificTransCodeOrId\": \"PYC\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallDetail","{{payment_waterfall_detail_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"bf429b84-5b7c-4519-a7f2-1e17fb7d2d5e","name":"UpdateWaterfallDetail - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCodeOrId\": \"STANDARD\",\n  \"sequenceNumber\": 2,\n  \"item\": 2,\n  \"specificTransCodeId\": null,\n  \"methodOfPayment\": 1,\n  \"payCount\": 1,\n  \"specificTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/{{payment_waterfall_detail_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1c2d3e4-1111-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"3c8c4b81-9aa6-445a-b866-41af23c6454f","name":"UpdateWaterfallDetail - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"waterfallCodeOrId\": \"STANDARD\",\n  \"sequenceNumber\": 2,\n  \"item\": 2,\n  \"specificTransCodeId\": null,\n  \"methodOfPayment\": 1,\n  \"payCount\": 1,\n  \"specificTransCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallDetail/00000000-0000-0000-0000-000000000000"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Payment waterfall detail not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"3999a941-76ec-456e-9b49-4acf39ba3744"},{"name":"WaterfallTransactionCodesGet","id":"938b33f2-c647-43b6-a6d9-d83b11746f39","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallTransactionCodes/{{payment_waterfall_code_or_id}}?token={{token}}","description":"<h3 id=\"get-servicing-payment-waterfall-transaction-codes\">Get Servicing Payment Waterfall Transaction Codes</h3>\n<p>Returns the distinct set of transaction codes referenced by a payment waterfall's detail rows. Delegates to <code>PaymentWaterfallCodeWSServices.ReturnWaterfallTransactionCodesWS</code>, which resolves the waterfall via <code>SharedWSServices.GetServicingPaymentWaterfallId</code> and then calls <code>PaymentWaterfallCodeServices.ReturnWaterfallTransactionCodes</code>.</p>\n<p>Rejects with <code>\"Payment waterfall code not found\"</code> when <code>{waterfallCodeOrId}</code> does not resolve for the current client. Unlike <code>/PaymentWaterfallDetail/ByWaterfallCode/{waterfallCodeOrId}</code>, which returns every detail row, this route returns the flattened transaction-code list suitable for populating a waterfall summary UI.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/PaymentWaterfallTransactionCodes/{waterfallCodeOrId}</code></p>\n<h4 id=\"route-parameters\">Route Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>waterfallCodeOrId</em></td>\n<td>Required string. <code>Servicing.PaymentWaterfallCode.Code</code> or Id.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list of transaction-code summary rows with <code>Id</code>, <code>Code</code>, <code>Description</code>, and the linking metadata needed to associate them with the waterfall.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","PaymentWaterfallTransactionCodes","{{payment_waterfall_code_or_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"95895e53-e3a7-4dcf-9a8c-d7b4fb4749ef","name":"GetWaterfallTransactionCodes - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallTransactionCodes/{{payment_waterfall_code_or_id}}?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallTransactionCodes","{{payment_waterfall_code_or_id}}"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"e1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"Code\": \"LATE\",\n            \"Description\": \"Late Fee\",\n            \"WaterfallCodeId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"WaterfallDetailId\": \"c1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"SequenceNumber\": 1\n        },\n        {\n            \"Id\": \"e1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"Code\": \"NSF\",\n            \"Description\": \"Non-Sufficient Funds Fee\",\n            \"WaterfallCodeId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"WaterfallDetailId\": \"c1c2d3e4-1111-4222-9333-abcdef012346\",\n            \"SequenceNumber\": 2\n        }\n    ],\n    \"errors\": []\n}"},{"id":"2b26e08c-97ac-4388-b856-6d15f6cc0556","name":"GetWaterfallTransactionCodes - Fail","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/PaymentWaterfallTransactionCodes/NONEXISTENT?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","PaymentWaterfallTransactionCodes","NONEXISTENT"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Payment waterfall code not found\"\n    ]\n}"}],"_postman_id":"938b33f2-c647-43b6-a6d9-d83b11746f39"},{"name":"DealerTransactionsImport","id":"8db68c73-d917-46e4-8968-a0e3c395bb38","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"validateOnly\": false,\n  \"folderPath\": \"System/Daily Reports\",\n  \"notificationEmail\": \"\",\n  \"transactions\": [\n    { \"vendorCode\": \"AKING\", \"branchNumber\": 90, \"transactionType\": \"Reserve\", \"amount\": 4.00, \"comment\": \"API reserve\" },\n    { \"vendorCode\": \"AKING\", \"branchNumber\": 90, \"transactionType\": \"Withhold\", \"amount\": 3.00, \"comment\": \"API withhold\", \"accountNumber\": 30011709 }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/DealerTransactions/Import","description":"<h3 id=\"import-dealer-transactions\">Import Dealer Transactions</h3>\n<p>Imports dealer Reserve and Withhold transactions, the same as uploading a file on\nthe <strong>Import Dealer Transactions</strong> screen\n(<code>/Client/Servicing/ImportExport/Dealers/ImportDealerTransactions.aspx</code>). Every\ntransaction is posted the same way as an entry on the <strong>Dealer Transactions</strong>\nscreen: dated with the current business date, entered by the calling user, with\nTransaction Source Dealer Transaction, a reference number, general ledger entries\nwhen the client uses the general ledger, and (Withhold) a change to the\naccount's remaining withhold.</p>\n<p>The transactions are checked at once, with the same rules as the screen. When\nany transaction has errors nothing is queued, <code>statusCode</code> is <code>Error</code>, and\n<code>data.rows</code> lists each transaction's errors and warnings (also flattened into\n<code>errors</code>/<code>warnings</code> as <code>Row N: ...</code>). With <code>validateOnly</code> true the checks run\nand nothing is queued.</p>\n<p>Otherwise the transactions are <strong>queued and posted in the background</strong> through\nthe shared report queue, like an import started on the screen: one import per\nclient at a time, the rest in the order they were started (from the screen or\nthe API). The response has <code>data.status</code> <code>Queued</code>, <code>data.importsAhead</code> (imports\nalready running or waiting) and the full <code>data.folderPath</code>. When the import\nfinishes, a results file (each transaction Posted or Not posted, with its\nreference number and any errors) is saved to that Document Manager folder, the\ncalling user (not the system user) gets a <strong>Report Saved</strong> notification in\nOmega that links to it, and <code>notificationEmail</code>, when given, is e-mailed. That\naddress is also e-mailed when the results file cannot be saved (with the\nresults attached) or the import cannot start (nothing is posted). Progress:\n<strong>Import Dealer Transactions - Running</strong>\n(<code>GET .../DealerTransactions/Import/Running</code>).</p>\n<p>Requires the <strong>Import Dealer Transactions</strong> permission and permission to each\ntransaction's branch (the system user bypasses both, as in every sibling\nendpoint). At most 1,000 transactions per request, the same limit as a file on\nthe screen. A request over the limit posts nothing and returns HTTP 400 with\n<code>At most 1,000 transactions can be imported in one request.</code></p>\n<p>Delegates to <code>DealerTransactionImportWSServices.ImportDealerTransactionsWS</code>\n(<code>ImportDealerTransactionServices</code> checks, <code>ImportDealerTransactionReportServices</code>\nposts in the background).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/DealerTransactions/Import</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>validateOnly</em></td>\n<td>Optional boolean. True checks the transactions without queuing or posting. Default false.</td>\n</tr>\n<tr>\n<td><em>folderPath</em></td>\n<td>Required unless validateOnly. The Document Manager folder for the results file, by its path from the top. A <code>path</code> from <code>GET api/Client/Setup/ReportSetting/Folders</code>, which lists the folders you can use, works exactly as it is (for example <code>System / Daily Reports</code>), also when a folder name contains <code>/</code> or <code>\\</code>. Names separated by <code>/</code> or <code>\\</code> work too (<code>System/Daily Reports</code>), and <code>System</code> may be left off. You must be able to save to the folder: Full Control, or folder roles that give you View and Add. The system user cannot be given roles, so it may use any folder of the client except Temporary Output. A portal API key cannot call the Folders list; send the folder names as Document Manager shows them.</td>\n</tr>\n<tr>\n<td><em>notificationEmail</em></td>\n<td>Optional string. E-mail address to notify when the import finishes.</td>\n</tr>\n<tr>\n<td><em>transactions</em></td>\n<td>Required array, 1 to 1,000 items, posted in order.</td>\n</tr>\n<tr>\n<td><em>transactions[].vendorCode</em></td>\n<td>Required string. The dealer's vendor code (not case sensitive). The dealer must be active.</td>\n</tr>\n<tr>\n<td><em>transactions[].branchNumber</em></td>\n<td>Required number or string. Branch number.</td>\n</tr>\n<tr>\n<td><em>transactions[].transactionType</em></td>\n<td>Required string. <code>Reserve</code> or <code>Withhold</code>.</td>\n</tr>\n<tr>\n<td><em>transactions[].amount</em></td>\n<td>Required number or string. Not zero, at most 2 decimal places. Positive increases the reserve or withhold.</td>\n</tr>\n<tr>\n<td><em>transactions[].comment</em></td>\n<td>Optional string, up to 30 characters.</td>\n</tr>\n<tr>\n<td><em>transactions[].accountNumber</em></td>\n<td>Number or string. Required for Withhold: an activated indirect account of the same dealer and branch (not a loan application or an account waiting for activation). Not used for Reserve (a warning when supplied).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an object: <code>businessDate</code> (the date the transactions are dated with),\n<code>status</code> (<code>Validated</code>, <code>Queued</code> or <code>Not queued</code>), <code>transactionsPosted</code> (always 0:\nposting happens after the response; see the results file), <code>importsAhead</code>,\n<code>folderPath</code>, and <code>rows</code> (one per transaction: <code>row</code>, <code>vendorCode</code>, <code>errors</code>,\n<code>warnings</code>).</p>\n<p>Errors that stop the request include <code>folderPath is required: ...</code>,\n<code>Folder not found: \"...\"</code>, <code>More than one folder has the path \"...\"</code> (send\nthe path exactly as the Folders list shows it; when the list shows it twice,\nrename one of those folders in Document Manager), <code>You cannot save to the folder \"...\"</code> and <code>notificationEmail is not a valid e-mail address.</code></p>\n","urlObject":{"protocol":"https","path":["api","Client","Servicing","DealerTransactions","Import"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ddd38f4b-1899-4caf-adad-9abbe36cf823","name":"ImportDealerTransactions - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"validateOnly\": false,\n  \"folderPath\": \"Daily Reports\",\n  \"notificationEmail\": \"\",\n  \"transactions\": [\n    { \"vendorCode\": \"AKING\", \"branchNumber\": 90, \"transactionType\": \"Reserve\", \"amount\": 4.00, \"comment\": \"API reserve\" },\n    { \"vendorCode\": \"AKING\", \"branchNumber\": 90, \"transactionType\": \"Withhold\", \"amount\": 3.00, \"comment\": \"API withhold\", \"accountNumber\": 30011709 }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/DealerTransactions/Import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"businessDate\": \"2025-10-01T00:00:00\",\n        \"status\": \"Queued\",\n        \"transactionsPosted\": 0,\n        \"importsAhead\": 1,\n        \"folderPath\": \"System / Daily Reports\",\n        \"rows\": [\n            { \"row\": 1, \"vendorCode\": \"AKING\", \"errors\": [], \"warnings\": [] },\n            { \"row\": 2, \"vendorCode\": \"AKING\", \"errors\": [], \"warnings\": [] }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": [\n        \"Queued: the transactions are posted in the background after the 1 import(s) ahead of them. The results file is saved to \\\"System / Daily Reports\\\". GET api/Client/Servicing/DealerTransactions/Import/Running shows the progress.\"\n    ]\n}"},{"id":"698de499-e02f-4499-99ec-699665253f36","name":"ImportDealerTransactions - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"validateOnly\": true,\n  \"transactions\": [\n    { \"vendorCode\": \"AKING\", \"branchNumber\": 90, \"transactionType\": \"Reserve\", \"amount\": 4.00, \"comment\": \"API reserve\" },\n    { \"vendorCode\": \"NOPE\", \"branchNumber\": 90, \"transactionType\": \"Reserve\", \"amount\": 1.00 },\n    { \"vendorCode\": \"AKING\", \"branchNumber\": 90, \"transactionType\": \"Withhold\", \"amount\": 3.00 },\n    { \"vendorCode\": \"AKING\", \"branchNumber\": \"90\", \"transactionType\": \"reserve\", \"amount\": \"0\" }\n  ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Servicing/DealerTransactions/Import"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": {\n        \"businessDate\": \"2025-10-01T00:00:00\",\n        \"status\": \"Not queued\",\n        \"transactionsPosted\": 0,\n        \"importsAhead\": 0,\n        \"folderPath\": null,\n        \"rows\": [\n            { \"row\": 1, \"vendorCode\": \"AKING\", \"errors\": [], \"warnings\": [] },\n            { \"row\": 2, \"vendorCode\": \"NOPE\", \"errors\": [ \"Invalid Dealer: NOPE\" ], \"warnings\": [] },\n            { \"row\": 3, \"vendorCode\": \"AKING\", \"errors\": [ \"Account Number is required for Withhold transactions\" ], \"warnings\": [] },\n            { \"row\": 4, \"vendorCode\": \"AKING\", \"errors\": [ \"Amount cannot be 0.00\" ], \"warnings\": [] }\n        ]\n    },\n    \"errors\": [\n        \"3 transaction(s) have errors, so nothing was queued or posted.\",\n        \"Row 2: Invalid Dealer: NOPE\",\n        \"Row 3: Account Number is required for Withhold transactions\",\n        \"Row 4: Amount cannot be 0.00\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"8db68c73-d917-46e4-8968-a0e3c395bb38"},{"name":"DealerTransactionsImportRunning","id":"b9e5f51d-9d0c-43d6-a004-a12df4e999d0","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Servicing/DealerTransactions/Import/Running?token={{token}}","description":"<h3 id=\"import-dealer-transactions---running\">Import Dealer Transactions - Running</h3>\n<p>The client's dealer transaction imports that are running or waiting for their\nturn, oldest first, whether started on the <strong>Import Dealer Transactions</strong>\nscreen or through <strong>Import Dealer Transactions</strong> (POST). Imports run one per\nclient at a time; an import no longer listed has finished and its results file\nis in the folder it was given. Delegates to\n<code>DealerTransactionImportWSServices.ReturnImportsWS</code>, which reads the shared\nrunning-work register (the same progress the screen shows under Running\nReports for This Screen).</p>\n<p>Requires the <strong>Import Dealer Transactions</strong> permission.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Servicing/DealerTransactions/Import/Running</code></p>\n<h4 id=\"query-string-parameters\">Query String Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is a list, empty when no import is running or waiting. Each item:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid of the run.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td><code>Running</code> or <code>Queued</code> (waiting for the import ahead of it).</td>\n</tr>\n<tr>\n<td><em>userName</em></td>\n<td>The user who started the import.</td>\n</tr>\n<tr>\n<td><em>details</em></td>\n<td>What it is doing, e.g. <code>Posted 15 of 60 dealer transactions</code> or <code>Queued behind another run of this report; position 1</code>.</td>\n</tr>\n<tr>\n<td><em>processed</em> / <em>total</em></td>\n<td>Transactions posted so far and the number to post (<code>total</code> is null until posting starts).</td>\n</tr>\n<tr>\n<td><em>startedAt</em> / <em>lastActivityAt</em></td>\n<td>Server times the import was started and last reported progress.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Servicing","DealerTransactions","Import","Running"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"bb57e682-e1e6-44a8-85f0-7f0edda995cc","name":"ImportDealerTransactionsRunning - Successful","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Servicing/DealerTransactions/Import/Running?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Servicing","DealerTransactions","Import","Running"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": [\n        {\n            \"id\": \"4ad2b163-3fe0-4c67-bea7-99f497f005b5\",\n            \"status\": \"Running\",\n            \"userName\": \"developer\",\n            \"details\": \"Posted 37 of 60 dealer transactions\",\n            \"processed\": 37,\n            \"total\": 60,\n            \"startedAt\": \"2026-10-14T13:18:10.1248103-07:00\",\n            \"lastActivityAt\": \"2026-10-14T13:18:31.5581383-07:00\"\n        },\n        {\n            \"id\": \"451b88a3-dad1-459a-801a-4c740fa727fe\",\n            \"status\": \"Queued\",\n            \"userName\": \"developer\",\n            \"details\": \"Queued behind another run of this report; position 1\",\n            \"processed\": 0,\n            \"total\": null,\n            \"startedAt\": \"2026-10-14T13:18:10.7572079-07:00\",\n            \"lastActivityAt\": \"2026-10-14T13:18:10.7582192-07:00\"\n        }\n    ],\n    \"errors\": [],\n    \"warnings\": []\n}"}],"_postman_id":"b9e5f51d-9d0c-43d6-a004-a12df4e999d0"}],"id":"ed7c9b42-09e5-4ada-b483-c044d66442bb","_postman_id":"ed7c9b42-09e5-4ada-b483-c044d66442bb","description":""},{"name":"Setup","item":[{"name":"APIAccessRolesGetAll","id":"0224d71a-1d30-4d67-aaf2-f51b8da5ebd2","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role/APIAccess","description":"<h3 id=\"get-all-api-access-roles\">Get All API Access Roles</h3>\n<p>Returns every <code>Setup.Role</code> row whose <code>RoleType</code> identifies it as an API access role. API access roles control which endpoints a token or API key may invoke. Used by the user edit screen to populate the \"API Access Role\" dropdown.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Role/APIAccess</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","Role","APIAccess"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0eb8dd34-e2c9-4c89-aa58-7cb0e36141ae","name":"GetAllAPIAccessRoles - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role/APIAccess"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"b1c2d3e4-aaaa-4222-9333-abcdef012345\",\n            \"RoleName\": \"API - Read Only\",\n            \"RoleType\": 3,\n            \"Active\": true,\n            \"Description\": \"API role with read-only endpoint access\"\n        },\n        {\n            \"Id\": \"b1c2d3e4-bbbb-4222-9333-abcdef012345\",\n            \"RoleName\": \"API - Full\",\n            \"RoleType\": 3,\n            \"Active\": true,\n            \"Description\": \"API role with full endpoint access\"\n        }\n    ]\n}"},{"id":"18c5bb90-4a9f-45df-8382-c94e7ad693d1","name":"GetAllAPIAccessRoles - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role/APIAccess"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving API access roles: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"0224d71a-1d30-4d67-aaf2-f51b8da5ebd2"},{"name":"BranchAdd","id":"e743006e-adc2-43d2-8dfe-b6ef7db254d9","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"branchNumber\": 5,\n  \"branchName\": \"Westside\",\n  \"email\": \"westside@example.com\",\n  \"active\": true,\n  \"notes\": \"New location opened 2026\",\n  \"websiteAddress\": \"\",\n  \"branchIPAddress\": \"\",\n  \"lotsAgentNumber\": \"\",\n  \"securianAgentNumber\": \"\",\n  \"dayendReportFormat\": 1,\n  \"dayendEmail\": \"dayend@example.com\",\n  \"defaultTimeZone\": \"11111111-1111-1111-1111-111111111111\",\n  \"overrideFromEmailAddress\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"unsubscribeEmailForwardAddress\": \"\",\n  \"unsubscribeEmailDisclaimer\": \"\",\n  \"mergeFieldMessage1\": \"\",\n  \"mergeFieldMessage2\": \"\",\n  \"mergeFieldMessage3\": \"\",\n  \"mergeFieldMessage4\": \"\",\n  \"mergeFieldMessage5\": \"\",\n  \"mergeFieldMessage6\": \"\",\n  \"mergeFieldMessage7\": \"\",\n  \"mergeFieldMessage8\": \"\",\n  \"mergeFieldMessage9\": \"\",\n  \"mergeFieldMessage10\": \"\",\n  \"defaultTimeZoneCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch","description":"<h3 id=\"add-branch\">Add Branch</h3>\n<p>Creates a new <code>Setup.Branch</code> for the current client via <code>BranchWSServices.AddBranchWS</code>. The controller maps <code>AddBranchParameter</code> to <code>AddSaveBranchParameter</code> with null id/ts so the WS service treats the call as an add. Returns the new branch <code>Id</code> on success.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Branch</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>branchNumber</em></td>\n<td>Required integer. New branch number. Must be unique within the client.</td>\n</tr>\n<tr>\n<td><em>branchName</em></td>\n<td>Required string. Display name.</td>\n</tr>\n<tr>\n<td><em>email</em></td>\n<td>Optional string. Default branch email.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the branch is active.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string. Free-form notes.</td>\n</tr>\n<tr>\n<td><em>websiteAddress</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>branchIPAddress</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>lotsAgentNumber</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>securianAgentNumber</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>dayendReportFormat</em></td>\n<td>Optional integer. Day-end report format enum.</td>\n</tr>\n<tr>\n<td><em>dayendEmail</em></td>\n<td>Optional string. Email address for day-end reports.</td>\n</tr>\n<tr>\n<td><em>defaultTimeZone</em></td>\n<td>Optional Guid. <code>Global.TimeZone.Id</code>.</td>\n</tr>\n<tr>\n<td><em>overrideFromEmailAddress</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>overrideDefaultEmailDisplayName</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>unsubscribeEmailForwardAddress</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>unsubscribeEmailDisclaimer</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>mergeFieldMessage1</em> through <em>mergeFieldMessage10</em></td>\n<td>Optional strings. Merge-field messages 1-10 used by branch-scoped templates.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ \"Id\": \"&lt;new branch Guid&gt;\" }</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>defaultTimeZoneCodeOrId</code></td>\n<td><code>defaultTimeZone</code></td>\n<td>String. time-zone code or time-zone GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"defaultTimeZoneCodeOrId\": \"PST\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","Branch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"69c698f8-3c3c-444c-a3b6-f681c23693fc","name":"AddBranch - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"branchNumber\": 5,\n  \"branchName\": \"Westside\",\n  \"email\": \"westside@example.com\",\n  \"active\": true,\n  \"notes\": \"New location opened 2026\",\n  \"websiteAddress\": \"\",\n  \"branchIPAddress\": \"\",\n  \"lotsAgentNumber\": \"\",\n  \"securianAgentNumber\": \"\",\n  \"dayendReportFormat\": 1,\n  \"dayendEmail\": \"dayend@example.com\",\n  \"defaultTimeZone\": \"11111111-1111-1111-1111-111111111111\",\n  \"overrideFromEmailAddress\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"unsubscribeEmailForwardAddress\": \"\",\n  \"unsubscribeEmailDisclaimer\": \"\",\n  \"mergeFieldMessage1\": \"\",\n  \"mergeFieldMessage2\": \"\",\n  \"mergeFieldMessage3\": \"\",\n  \"mergeFieldMessage4\": \"\",\n  \"mergeFieldMessage5\": \"\",\n  \"mergeFieldMessage6\": \"\",\n  \"mergeFieldMessage7\": \"\",\n  \"mergeFieldMessage8\": \"\",\n  \"mergeFieldMessage9\": \"\",\n  \"mergeFieldMessage10\": \"\",\n  \"defaultTimeZoneCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c3d4e5f6-3333-4444-9555-cdef01234567\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8d981ec2-9078-4bf8-bc2c-37e441be6ca3","name":"AddBranch - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"branchNumber\": 0,\n  \"branchName\": \"\",\n  \"email\": \"westside@example.com\",\n  \"active\": true,\n  \"notes\": \"New location opened 2026\",\n  \"websiteAddress\": \"\",\n  \"branchIPAddress\": \"\",\n  \"lotsAgentNumber\": \"\",\n  \"securianAgentNumber\": \"\",\n  \"dayendReportFormat\": 1,\n  \"dayendEmail\": \"dayend@example.com\",\n  \"defaultTimeZone\": \"11111111-1111-1111-1111-111111111111\",\n  \"overrideFromEmailAddress\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"unsubscribeEmailForwardAddress\": \"\",\n  \"unsubscribeEmailDisclaimer\": \"\",\n  \"mergeFieldMessage1\": \"\",\n  \"mergeFieldMessage2\": \"\",\n  \"mergeFieldMessage3\": \"\",\n  \"mergeFieldMessage4\": \"\",\n  \"mergeFieldMessage5\": \"\",\n  \"mergeFieldMessage6\": \"\",\n  \"mergeFieldMessage7\": \"\",\n  \"mergeFieldMessage8\": \"\",\n  \"mergeFieldMessage9\": \"\",\n  \"mergeFieldMessage10\": \"\",\n  \"defaultTimeZoneCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Branch name is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"e743006e-adc2-43d2-8dfe-b6ef7db254d9"},{"name":"BranchesGetAll","id":"bc509847-d7d5-43ee-845f-81cdec62dded","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Branch","description":"<h3 id=\"get-all-branches\">Get All Branches</h3>\n<p>Returns every <code>Setup.Branch</code> row for the current client via <code>BranchWSServices.ReturnAllBranchesWS</code>. Used by the admin branch list grid and by any integration that needs the branch catalog. Each entry includes branch number, name, active flag, email, notes, default time zone, LOTS/Securian agent numbers, and day-end reporting options.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Branch</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of branch records. Ordering follows <code>BranchServices.ReturnAllBranches</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","Branch"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0b68ac5e-58e9-4621-a9cd-97ff9e3de086","name":"GetAllBranches - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Branch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"BranchNumber\": 1,\n            \"BranchName\": \"Main Branch\",\n            \"Active\": true,\n            \"Email\": \"main@example.com\",\n            \"Notes\": \"Headquarters branch\",\n            \"DefaultTimeZoneId\": \"11111111-1111-1111-1111-111111111111\",\n            \"LOTSAgentNumber\": \"\",\n            \"SecurianAgentNumber\": \"\",\n            \"DayEndReportFormat\": 1\n        },\n        {\n            \"Id\": \"a1b2c3d4-2222-4222-9333-abcdef012345\",\n            \"BranchNumber\": 2,\n            \"BranchName\": \"Downtown\",\n            \"Active\": true,\n            \"Email\": \"downtown@example.com\",\n            \"Notes\": \"\",\n            \"DefaultTimeZoneId\": \"11111111-1111-1111-1111-111111111111\",\n            \"LOTSAgentNumber\": \"\",\n            \"SecurianAgentNumber\": \"\",\n            \"DayEndReportFormat\": 1\n        }\n    ]\n}"},{"id":"796a3e14-50b0-400d-a1d6-5e81a41e24b5","name":"GetAllBranches - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Branch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving branches: Object reference not set to an instance of an object.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"bc509847-d7d5-43ee-845f-81cdec62dded"},{"name":"BranchGet","id":"d88cb3f1-6928-48bd-a7fc-355ba246c8bc","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Branch/{{branch_number_or_id}}","description":"<h3 id=\"get-branch\">Get Branch</h3>\n<p>Returns a single <code>Setup.Branch</code> record resolved by either the <code>BranchNumber</code> (int) or the <code>Id</code> (Guid). <code>SharedWSServices.GetSetupBranchId</code> accepts both forms. Returns <code>BadRequest</code> when the branch cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Branch/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required. Either the <code>Setup.Branch.BranchNumber</code> (int) or the <code>Setup.Branch.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","Branch","{{branch_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"86c652b7-9a16-4629-97d6-890d59b446ef","name":"GetBranch - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Branch/{{branch_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"BranchNumber\": 1,\n        \"BranchName\": \"Main Branch\",\n        \"Active\": true,\n        \"Email\": \"main@example.com\",\n        \"Notes\": \"Headquarters branch\",\n        \"WebsiteAddress\": \"https://example.com\",\n        \"BranchIPAddress\": \"\",\n        \"LOTSAgentNumber\": \"\",\n        \"SecurianAgentNumber\": \"\",\n        \"DayEndReportFormat\": 1,\n        \"DayEndEmail\": \"dayend@example.com\",\n        \"DefaultTimeZoneId\": \"11111111-1111-1111-1111-111111111111\",\n        \"OverrideFromEmailAddress\": \"\",\n        \"OverrideDefaultEmailDisplayName\": \"\",\n        \"UnsubscribeEmailForwardAddress\": \"\",\n        \"UnsubscribeEmailDisclaimer\": \"\"\n    }\n}"},{"id":"edfdc188-96a5-4153-8902-2fa79d9d0bd1","name":"GetBranch - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Branch/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Branch not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"d88cb3f1-6928-48bd-a7fc-355ba246c8bc"},{"name":"BranchUpdate","id":"b9beb0bd-7bf6-4365-b94f-429d48a142ef","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"branchNumber\": 5,\n  \"branchName\": \"Westside Renamed\",\n  \"email\": \"westside@example.com\",\n  \"active\": true,\n  \"notes\": \"Updated 2026\",\n  \"websiteAddress\": \"\",\n  \"branchIPAddress\": \"\",\n  \"lotsAgentNumber\": \"\",\n  \"securianAgentNumber\": \"\",\n  \"dayendReportFormat\": 1,\n  \"dayendEmail\": \"dayend@example.com\",\n  \"defaultTimeZone\": \"11111111-1111-1111-1111-111111111111\",\n  \"overrideFromEmailAddress\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"unsubscribeEmailForwardAddress\": \"\",\n  \"unsubscribeEmailDisclaimer\": \"\",\n  \"mergeFieldMessage1\": \"\",\n  \"mergeFieldMessage2\": \"\",\n  \"mergeFieldMessage3\": \"\",\n  \"mergeFieldMessage4\": \"\",\n  \"mergeFieldMessage5\": \"\",\n  \"mergeFieldMessage6\": \"\",\n  \"mergeFieldMessage7\": \"\",\n  \"mergeFieldMessage8\": \"\",\n  \"mergeFieldMessage9\": \"\",\n  \"mergeFieldMessage10\": \"\",\n  \"defaultTimeZoneCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch/{{branch_number_or_id}}","description":"<h3 id=\"update-branch\">Update Branch</h3>\n<p>Updates an existing <code>Setup.Branch</code> record resolved by <code>{numberOrId}</code>. The controller maps <code>UpdateBranchParameter</code> to <code>AddSaveBranchParameter</code> with the resolved <code>Id</code> and the existing timestamp, then calls <code>BranchWSServices.UpdateBranchWS</code>. The WS service re-fetches the current row first so screen-owned fields that are not part of this parameter model are preserved.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Branch/{numberOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>numberOrId</em></td>\n<td>Required. Either <code>Setup.Branch.BranchNumber</code> (int) or <code>Setup.Branch.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <code>Add Branch</code> (see <code>AddBranch.request.yaml</code>). The <code>branchNumber</code> field is used to update the branch number; all other fields are applied on top of the existing record.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ \"Id\": \"&lt;branch Guid&gt;\" }</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>defaultTimeZoneCodeOrId</code></td>\n<td><code>defaultTimeZone</code></td>\n<td>String. time-zone code or time-zone GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"defaultTimeZoneCodeOrId\": \"PST\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","Branch","{{branch_number_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"09085b04-ba40-471c-897e-21a9951fb734","name":"UpdateBranch - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"branchNumber\": 5,\n  \"branchName\": \"Westside Renamed\",\n  \"email\": \"westside@example.com\",\n  \"active\": true,\n  \"notes\": \"Updated 2026\",\n  \"websiteAddress\": \"\",\n  \"branchIPAddress\": \"\",\n  \"lotsAgentNumber\": \"\",\n  \"securianAgentNumber\": \"\",\n  \"dayendReportFormat\": 1,\n  \"dayendEmail\": \"dayend@example.com\",\n  \"defaultTimeZone\": \"11111111-1111-1111-1111-111111111111\",\n  \"overrideFromEmailAddress\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"unsubscribeEmailForwardAddress\": \"\",\n  \"unsubscribeEmailDisclaimer\": \"\",\n  \"mergeFieldMessage1\": \"\",\n  \"mergeFieldMessage2\": \"\",\n  \"mergeFieldMessage3\": \"\",\n  \"mergeFieldMessage4\": \"\",\n  \"mergeFieldMessage5\": \"\",\n  \"mergeFieldMessage6\": \"\",\n  \"mergeFieldMessage7\": \"\",\n  \"mergeFieldMessage8\": \"\",\n  \"mergeFieldMessage9\": \"\",\n  \"mergeFieldMessage10\": \"\",\n  \"defaultTimeZoneCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch/{{branch_number_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c3d4e5f6-3333-4444-9555-cdef01234567\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"40258967-d05d-4512-a659-ace50d7a8747","name":"UpdateBranch - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"branchNumber\": 999999,\n  \"branchName\": \"Westside Renamed\",\n  \"email\": \"westside@example.com\",\n  \"active\": true,\n  \"notes\": \"Updated 2026\",\n  \"websiteAddress\": \"\",\n  \"branchIPAddress\": \"\",\n  \"lotsAgentNumber\": \"\",\n  \"securianAgentNumber\": \"\",\n  \"dayendReportFormat\": 1,\n  \"dayendEmail\": \"dayend@example.com\",\n  \"defaultTimeZone\": \"11111111-1111-1111-1111-111111111111\",\n  \"overrideFromEmailAddress\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"unsubscribeEmailForwardAddress\": \"\",\n  \"unsubscribeEmailDisclaimer\": \"\",\n  \"mergeFieldMessage1\": \"\",\n  \"mergeFieldMessage2\": \"\",\n  \"mergeFieldMessage3\": \"\",\n  \"mergeFieldMessage4\": \"\",\n  \"mergeFieldMessage5\": \"\",\n  \"mergeFieldMessage6\": \"\",\n  \"mergeFieldMessage7\": \"\",\n  \"mergeFieldMessage8\": \"\",\n  \"mergeFieldMessage9\": \"\",\n  \"mergeFieldMessage10\": \"\",\n  \"defaultTimeZoneCodeOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch/999999"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Branch not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"b9beb0bd-7bf6-4365-b94f-429d48a142ef"},{"name":"CurrentUserGet","id":"12587a0e-8395-4c66-9a71-4e252814fdb1","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/GetCurrentUser","description":"<h3 id=\"get-current-user\">Get Current User</h3>\n<p>Returns the <code>Setup.User</code> record for the authenticated caller (<code>loginInfo.UserId</code>) via <code>Omega.Setup.BLL.UserServices.ReturnUserById</code> with the field list <code>Id</code>, <code>UserLogin</code>, <code>FirstName</code>, <code>LastName</code>, <code>MegasysDepartment</code>, <code>ActiveStatus</code>. Unlike most Setup endpoints, the response body is the raw <code>MySetupUserEntity</code> (not a <code>GenericResultObject</code> envelope). When <code>LoginInfo</code> is missing, the endpoint returns HTTP 200 with an empty body rather than 401.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/GetCurrentUser</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Response is the <code>MySetupUserEntity</code> directly (not wrapped). Key fields:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Id</em></td>\n<td>Guid. <code>Setup.User.Id</code>.</td>\n</tr>\n<tr>\n<td><em>UserLogin</em></td>\n<td>String. <code>Setup.User.UserLogin</code>.</td>\n</tr>\n<tr>\n<td><em>FirstName</em></td>\n<td>String. <code>Setup.User.FirstName</code>.</td>\n</tr>\n<tr>\n<td><em>LastName</em></td>\n<td>String. <code>Setup.User.LastName</code>.</td>\n</tr>\n<tr>\n<td><em>MegasysDepartment</em></td>\n<td>Int. <code>Setup.User.MegasysDepartment</code> enum value (0 = non-Megasys).</td>\n</tr>\n<tr>\n<td><em>ActiveStatus</em></td>\n<td>Bool. <code>Setup.User.ActiveStatus</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","GetCurrentUser"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9b031ad7-078f-44c8-ab1d-c2f8d96ffce9","name":"GetCurrentUser - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Setup/GetCurrentUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"Id\": \"a1f2b3c4-d5e6-47f8-9012-3456789abcde\",\n    \"UserLogin\": \"developer\",\n    \"FirstName\": \"Dev\",\n    \"LastName\": \"User\",\n    \"MegasysDepartment\": 0,\n    \"ActiveStatus\": true\n}"},{"id":"8570f854-0056-41dc-9396-07d6b898f085","name":"GetCurrentUser - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"url":"https://{{base_url}}/api/Client/Setup/GetCurrentUser"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"12587a0e-8395-4c66-9a71-4e252814fdb1"},{"name":"CustomerPortalConfiguration","id":"993af0af-89cd-4576-ba88-25296fb9343c","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"subdomainName\": \"acmefinance\",\n    \"customerPortalBackgroundUrl\": \"https://cdn.example.com/portal/bg.png\",\n    \"customerPortalLogoUrl\": \"https://cdn.example.com/portal/logo.png\",\n    \"customerPortalCustomPaymentUrl\": \"\",\n    \"numberOfFailedAttemptsBeforeLockout\": 5,\n    \"contactPhoneNumber\": \"8135551234\",\n    \"contactEmailAddress\": \"support@acme.example.com\",\n    \"contactStatement\": \"Contact us Mon-Fri 8a-6p ET.\",\n    \"legalStatement\": \"Use of this portal is subject to our terms.\",\n    \"privacyNotice\": \"We protect your personal information.\",\n    \"termsAndConditionsStatement\": \"By accessing this portal you agree to the following terms...\",\n    \"paperlessTermsAndConditionsStatement\": \"Paperless delivery terms...\",\n    \"includeOrExcludeAdminStatus\": 2,\n    \"includeOrExcludeRemarkStatus\": 1,\n    \"profileEditOption\": 2,\n    \"newDocSbtFormFileNameOrId\": \"ffffffff-1111-2222-3333-444444444444\",\n    \"maxDaysFutureScheduledPayment\": 30,\n    \"showDueDateChangeRequest\": true,\n    \"showExtensionRequest\": true,\n    \"adminStatusCodes\": [\n        \"SA\"\n    ],\n    \"remarkCodes\": [\n        \"RC1\",\n        \"RC2\"\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration","description":"<h3 id=\"update-customer-portal-configuration\">Update Customer Portal Configuration</h3>\n<p>Upserts the current client's <code>Common.CustomerPortalConfiguration</code> row via <code>CustomerPortalConfigurationWSServices.AddSaveCustomerPortalConfigurationWS</code>. The controller copies the incoming <code>UpdateCustomerPortalConfigurationParameter</code> to the internal <code>AddSaveCustomerPortalConfigurationParameter</code>, resolving <code>newDocSbtFormFileNameOrId</code> to a Guid via <code>Guid.TryParse</code> (a non-Guid string resolves to <code>null</code>).</p>\n<p>Validation and side-effects mirror <code>CustomerPortalConfiguration.aspx.cs</code>:</p>\n<ul>\n<li><code>subdomainName</code> is trimmed and must be non-empty alphanumeric only; any non-alphanumeric character is rejected with <code>Invalid Subdomain Name</code>.</li>\n<li><code>subdomainName</code> containing the substring <code>sandbox</code> (case-insensitive) is rejected with <code>Sandbox not allowed in subdomain name</code>.</li>\n<li>If the saved <code>termsAndConditionsStatement</code> differs from the existing row, <code>TermsAndConditionsStatementLastUpdatedDate</code> is set to today.</li>\n<li>If the saved <code>paperlessTermsAndConditionsStatement</code> differs from the existing row, <code>PaperlessTermsAndConditionsStatementLastUpdatedDate</code> is set to today.</li>\n<li>After the save, <code>remarkCodes</code> and <code>adminStatusCodes</code> arrays (when non-null) are persisted via <code>CustomerPortalServices.saveSetupCustomerPortalConfigurationRemarkCodes</code> and <code>saveSetupCustomerPortalConfigurationAdminStatus</code>.</li>\n<li>The Live and Sandbox <code>Client_Portal_API</code> <code>Common.ClientVendorMapping</code> rows are ensured/refreshed via <code>EnsureClientPortalApiMapping</code> for both <code>sandbox=false</code> and <code>sandbox=true</code>. New rows get a randomly generated <code>publicKey</code> and <code>privateKey</code>; existing rows keep their keys.</li>\n</ul>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>subdomainName</em></td>\n<td>Required string. Alphanumeric only. May not contain <code>sandbox</code>.</td>\n</tr>\n<tr>\n<td><em>customerPortalBackgroundUrl</em></td>\n<td>Optional string. Background image URL.</td>\n</tr>\n<tr>\n<td><em>customerPortalLogoUrl</em></td>\n<td>Optional string. Logo image URL.</td>\n</tr>\n<tr>\n<td><em>customerPortalCustomPaymentUrl</em></td>\n<td>Optional string. Override URL for the Make Payment link.</td>\n</tr>\n<tr>\n<td><em>numberOfFailedAttemptsBeforeLockout</em></td>\n<td>Optional integer.</td>\n</tr>\n<tr>\n<td><em>contactPhoneNumber</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>contactEmailAddress</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>contactStatement</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>legalStatement</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>privacyNotice</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>termsAndConditionsStatement</em></td>\n<td>Optional string. Changing this value triggers an update of <code>TermsAndConditionsStatementLastUpdatedDate</code>.</td>\n</tr>\n<tr>\n<td><em>paperlessTermsAndConditionsStatement</em></td>\n<td>Optional string. Changing this value triggers an update of <code>PaperlessTermsAndConditionsStatementLastUpdatedDate</code>.</td>\n</tr>\n<tr>\n<td><em>includeOrExcludeAdminStatus</em></td>\n<td>Required integer. <code>IncludeOrExcludeStatus</code> (1=Include, 2=Exclude). Drives whether the <code>adminStatusCodes</code> list is included or excluded.</td>\n</tr>\n<tr>\n<td><em>includeOrExcludeRemarkStatus</em></td>\n<td>Required integer. <code>IncludeOrExcludeStatus</code> (1=Include, 2=Exclude). Drives whether the <code>remarkCodes</code> list is included or excluded.</td>\n</tr>\n<tr>\n<td><em>profileEditOption</em></td>\n<td>Required integer. <code>ProfileEditOptions</code> (1=Restricted, 2=Allow_And_Create_Task_For_Change_Review).</td>\n</tr>\n<tr>\n<td><em>newDocSbtFormFileNameOrId</em></td>\n<td>Optional string. Accepts a Guid string for <code>DocSafe.MergeForms.Id</code>. Non-Guid values resolve to <code>null</code> (<code>ResolveMergeFormId</code> only honors <code>Guid.TryParse</code>).</td>\n</tr>\n<tr>\n<td><em>maxDaysFutureScheduledPayment</em></td>\n<td>Optional integer.</td>\n</tr>\n<tr>\n<td><em>showDueDateChangeRequest</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>showExtensionRequest</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>adminStatusCodes</em></td>\n<td>Optional <code>string[]</code>. Codes saved via <code>saveSetupCustomerPortalConfigurationAdminStatus</code>. Pass <code>null</code> to leave the existing list unchanged; pass <code>[]</code> to clear it.</td>\n</tr>\n<tr>\n<td><em>remarkCodes</em></td>\n<td>Optional <code>string[]</code>. Codes saved via <code>saveSetupCustomerPortalConfigurationRemarkCodes</code>. Pass <code>null</code> to leave the existing list unchanged; pass <code>[]</code> to clear it.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns the saved <code>Common.CustomerPortalConfiguration.Id</code> Guid (as string) in <code>data</code> when successful, or empty string if the saved row could not be re-read. Validation failures return <code>statusCode = Error</code> with the offending message in <code>errors</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>newDocSbtFormFileNameOrId</code></td>\n<td><code>newDocSbtFormFileNameOrId</code></td>\n<td>String. Solutions by Text text merge-form filename or matching form GUID. Existing optional field; blank retains its clear behavior.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply. Existing optional key-or-GUID fields listed above retain blank-to-clear behavior; a nonblank unknown key now fails instead of clearing the setting.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"newDocSbtFormFileNameOrId\": \"New Document Text\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","CustomerPortalConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"38682642-a16f-4781-823a-3f60f9a41ab0","name":"UpdateCustomerPortalConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"subdomainName\": \"acmefinance\",\n    \"customerPortalBackgroundUrl\": \"https://cdn.example.com/portal/bg.png\",\n    \"customerPortalLogoUrl\": \"https://cdn.example.com/portal/logo.png\",\n    \"customerPortalCustomPaymentUrl\": \"\",\n    \"numberOfFailedAttemptsBeforeLockout\": 5,\n    \"contactPhoneNumber\": \"8135551234\",\n    \"contactEmailAddress\": \"support@acme.example.com\",\n    \"contactStatement\": \"Contact us Mon-Fri 8a-6p ET.\",\n    \"legalStatement\": \"Use of this portal is subject to our terms.\",\n    \"privacyNotice\": \"We protect your personal information.\",\n    \"termsAndConditionsStatement\": \"By accessing this portal you agree to the following terms...\",\n    \"paperlessTermsAndConditionsStatement\": \"Paperless delivery terms...\",\n    \"includeOrExcludeAdminStatus\": 2,\n    \"includeOrExcludeRemarkStatus\": 1,\n    \"profileEditOption\": 2,\n    \"newDocSbtFormFileNameOrId\": \"ffffffff-1111-2222-3333-444444444444\",\n    \"maxDaysFutureScheduledPayment\": 30,\n    \"showDueDateChangeRequest\": true,\n    \"showExtensionRequest\": true,\n    \"adminStatusCodes\": [\n        \"SA\"\n    ],\n    \"remarkCodes\": [\n        \"RC1\",\n        \"RC2\"\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"11111111-2222-3333-4444-555555555555\",\n    \"errors\": []\n}"},{"id":"7c5d1c75-cf8d-4054-92c2-a15ba626395c","name":"UpdateCustomerPortalConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"subdomainName\": \"acme finance!\",\n    \"customerPortalBackgroundUrl\": \"https://cdn.example.com/portal/bg.png\",\n    \"customerPortalLogoUrl\": \"https://cdn.example.com/portal/logo.png\",\n    \"customerPortalCustomPaymentUrl\": \"\",\n    \"numberOfFailedAttemptsBeforeLockout\": 5,\n    \"contactPhoneNumber\": \"8135551234\",\n    \"contactEmailAddress\": \"support@acme.example.com\",\n    \"contactStatement\": \"Contact us Mon-Fri 8a-6p ET.\",\n    \"legalStatement\": \"Use of this portal is subject to our terms.\",\n    \"privacyNotice\": \"We protect your personal information.\",\n    \"termsAndConditionsStatement\": \"By accessing this portal you agree to the following terms...\",\n    \"paperlessTermsAndConditionsStatement\": \"Paperless delivery terms...\",\n    \"includeOrExcludeAdminStatus\": 2,\n    \"includeOrExcludeRemarkStatus\": 1,\n    \"profileEditOption\": 2,\n    \"newDocSbtFormFileNameOrId\": \"ffffffff-1111-2222-3333-444444444444\",\n    \"maxDaysFutureScheduledPayment\": 30,\n    \"showDueDateChangeRequest\": true,\n    \"showExtensionRequest\": true,\n    \"adminStatusCodes\": [\n        \"SA\"\n    ],\n    \"remarkCodes\": [\n        \"RC1\",\n        \"RC2\"\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid Subdomain Name\"\n    ]\n}"}],"_postman_id":"993af0af-89cd-4576-ba88-25296fb9343c"},{"name":"CustomerPortalConfiguration","id":"9c40db69-cbb7-4cb0-be3e-d48e3dcacd11","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration","description":"<h3 id=\"get-customer-portal-configuration\">Get Customer Portal Configuration</h3>\n<p>Returns the current client's <code>Common.CustomerPortalConfiguration</code> row via <code>CustomerPortalConfigurationWSServices.GetCustomerPortalConfigurationWS</code>. In addition to the saved config the response includes the configured <code>adminStatusIds</code> (from <code>CustomerPortalServices.GetSavedAdminStatusForList</code>) and <code>remarkCodeIds</code> (from <code>CustomerPortalServices.GetSavedRemarkCodesForList</code>).</p>\n<p>When no configuration row exists yet, <code>data</code> is <code>null</code> and <code>statusCode</code> is still <code>Ok</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> shape (when a row exists):</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid. <code>Common.CustomerPortalConfiguration.Id</code>.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Byte array. Row version timestamp.</td>\n</tr>\n<tr>\n<td><em>omegaClientId</em></td>\n<td>Guid. Owning <code>Setup.Client.Id</code>.</td>\n</tr>\n<tr>\n<td><em>subdomainName</em></td>\n<td>String. Customer portal subdomain (alphanumeric only, <code>sandbox</code> not allowed).</td>\n</tr>\n<tr>\n<td><em>customerPortalBackgroundUrl</em></td>\n<td>String. Background image URL.</td>\n</tr>\n<tr>\n<td><em>customerPortalLogoUrl</em></td>\n<td>String. Logo image URL.</td>\n</tr>\n<tr>\n<td><em>customerPortalCustomPaymentUrl</em></td>\n<td>String. Optional override for the Make Payment link.</td>\n</tr>\n<tr>\n<td><em>numberOfFailedAttemptsBeforeLockout</em></td>\n<td>Integer.</td>\n</tr>\n<tr>\n<td><em>contactPhoneNumber</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>contactEmailAddress</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>contactStatement</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>legalStatement</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>privacyNotice</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>termsAndConditionsStatement</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>termsAndConditionsStatementLastUpdatedDate</em></td>\n<td>Date. Set on the save call when the portal terms text changes.</td>\n</tr>\n<tr>\n<td><em>paperlessTermsAndConditionsStatement</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>paperlessTermsAndConditionsStatementLastUpdatedDate</em></td>\n<td>Date. Set on the save call when the paperless terms text changes.</td>\n</tr>\n<tr>\n<td><em>includeOrExcludeAdminStatus</em></td>\n<td>Integer. <code>Omega.ClientCustomerPortal.Types.Enums.IncludeOrExcludeStatus</code> (1=Include, 2=Exclude).</td>\n</tr>\n<tr>\n<td><em>includeOrExcludeRemarkStatus</em></td>\n<td>Integer. Same enum as above.</td>\n</tr>\n<tr>\n<td><em>profileEditOption</em></td>\n<td>Integer. <code>ProfileEditOptions</code> (1=Restricted, 2=Allow_And_Create_Task_For_Change_Review).</td>\n</tr>\n<tr>\n<td><em>defaultCustomerPortalNewDocSbtFormId</em></td>\n<td>Guid?. <code>DocSafe.MergeForms.Id</code> used as the default new-document form.</td>\n</tr>\n<tr>\n<td><em>maxDaysFutureScheduledPayment</em></td>\n<td>Integer?.</td>\n</tr>\n<tr>\n<td><em>showDueDateChangeRequest</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>showExtensionRequest</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>adminStatusIds</em></td>\n<td>Array of Guid. <code>Servicing.AdminStatus.Id</code> rows linked to the configuration.</td>\n</tr>\n<tr>\n<td><em>remarkCodeIds</em></td>\n<td>Array of Guid. <code>Servicing.RemarkCode.Id</code> rows linked to the configuration.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","CustomerPortalConfiguration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6e4cb51d-f884-489c-bba2-28aa726c13f8","name":"GetCustomerPortalConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"11111111-2222-3333-4444-555555555555\",\n        \"ts\": \"AAAAAAAAB+E=\",\n        \"omegaClientId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n        \"subdomainName\": \"acmefinance\",\n        \"customerPortalBackgroundUrl\": \"https://cdn.example.com/portal/bg.png\",\n        \"customerPortalLogoUrl\": \"https://cdn.example.com/portal/logo.png\",\n        \"customerPortalCustomPaymentUrl\": \"\",\n        \"numberOfFailedAttemptsBeforeLockout\": 5,\n        \"contactPhoneNumber\": \"8135551234\",\n        \"contactEmailAddress\": \"support@acme.example.com\",\n        \"contactStatement\": \"Contact us Mon-Fri 8a-6p ET.\",\n        \"legalStatement\": \"Use of this portal is subject to our terms.\",\n        \"privacyNotice\": \"We protect your personal information.\",\n        \"termsAndConditionsStatement\": \"By accessing this portal you agree to the following terms...\",\n        \"termsAndConditionsStatementLastUpdatedDate\": \"2026-01-15T00:00:00\",\n        \"paperlessTermsAndConditionsStatement\": \"Paperless delivery terms...\",\n        \"paperlessTermsAndConditionsStatementLastUpdatedDate\": \"2025-11-01T00:00:00\",\n        \"includeOrExcludeAdminStatus\": 2,\n        \"includeOrExcludeRemarkStatus\": 1,\n        \"profileEditOption\": 2,\n        \"defaultCustomerPortalNewDocSbtFormId\": \"ffffffff-1111-2222-3333-444444444444\",\n        \"maxDaysFutureScheduledPayment\": 30,\n        \"showDueDateChangeRequest\": true,\n        \"showExtensionRequest\": true,\n        \"adminStatusIds\": [\n            \"12121212-3434-5656-7878-909090909090\"\n        ],\n        \"remarkCodeIds\": [\n            \"21212121-4343-6565-8787-090909090909\",\n            \"21212121-4343-6565-8787-191919191919\"\n        ]\n    },\n    \"errors\": []\n}"},{"id":"9e34fb91-e848-464e-9193-79178ad46b4a","name":"GetCustomerPortalConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/CustomerPortalConfiguration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Authentication failed: invalid or expired token\"\n    ]\n}"}],"_postman_id":"9c40db69-cbb7-4cb0-be3e-d48e3dcacd11"},{"name":"DealerPermissionAdd","id":"a33864fe-cfd9-4a12-bac9-fa7a9f7dec04","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"ACTIVATE\",\n    \"description\": \"Allow dealer to activate new accounts\",\n    \"allowAccountActivation\": true,\n    \"allowBookNewAccount\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DealerPermission","description":"<h3 id=\"add-dealer-permission\">Add Dealer Permission</h3>\n<p>Creates a new <code>Common.AgentDealerPermission</code> row for the current client via <code>DealerPermissionWSServices.AddDealerPermissionWS</code> which delegates to <code>AddSaveDealerPermissionWS</code> / <code>DealerPermissionServices.AddSavDealerPermission</code>. Permission rows control what dealer users can do inside the Agent portal (book a new account, activate an existing account, etc.).</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/DealerPermission</code></p>\n<h4 id=\"validation\">Validation</h4>\n<ul>\n<li><code>code</code> is required. If a row already exists with the same <code>Code</code> (looked up via <code>DealerPermissionServices.ReturnDealerPermissionId</code>), the request fails with <code>\"A dealer permission with that code already exists\"</code>.</li>\n<li><code>Common.AgentDealerPermission.Code</code> is unique and capped at 10 characters in the underlying table.</li>\n</ul>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Unique permission code (max 10 characters).</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>allowAccountActivation</em></td>\n<td>Required bool. Allows assigned dealer users to activate accounts in the Agent portal.</td>\n</tr>\n<tr>\n<td><em>allowBookNewAccount</em></td>\n<td>Required bool. Allows assigned dealer users to book new accounts in the Agent portal.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new <code>Common.AgentDealerPermission.Id</code> as a string.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","DealerPermission"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"efbb6523-eb3e-4989-bf58-60438e69b764","name":"AddDealerPermission - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"ACTIVATE\",\n    \"description\": \"Allow dealer to activate new accounts\",\n    \"allowAccountActivation\": true,\n    \"allowBookNewAccount\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DealerPermission"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"e1f2a3b4-3333-4222-9333-abcdef012345\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"3051e6da-92e0-4b53-8e5b-91044b5fdf95","name":"AddDealerPermission - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"ACTIVATE\",\n    \"description\": \"Allow dealer to activate new accounts\",\n    \"allowAccountActivation\": true,\n    \"allowBookNewAccount\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DealerPermission"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A dealer permission with that code already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"a33864fe-cfd9-4a12-bac9-fa7a9f7dec04"},{"name":"DealerPermissionUpdate","id":"0a132015-30e5-442b-b849-eb1f79e7469a","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"ACTIVATE\",\n    \"description\": \"Allow dealer to activate new accounts (updated)\",\n    \"allowAccountActivation\": true,\n    \"allowBookNewAccount\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DealerPermission/{{dealerPermissionCodeOrId}}","description":"<h3 id=\"update-dealer-permission\">Update Dealer Permission</h3>\n<p>Updates an existing <code>Common.AgentDealerPermission</code> row by code or id via <code>DealerPermissionWSServices.UpdateDealerPermissionWS</code>. <code>codeOrId</code> is resolved through <code>SharedWSServices.GetCommonDealerPermissionId</code> (accepts the Guid id or the case-sensitive <code>Code</code>) and the existing row's <code>Ts</code> is reused as the optimistic-concurrency token before the save path is invoked.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/DealerPermission/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the <code>Common.AgentDealerPermission.Id</code> Guid or the case-sensitive <code>Code</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. Unique permission code (max 10 characters). Updating the code is allowed; the updated row must still be unique.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>allowAccountActivation</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>allowBookNewAccount</em></td>\n<td>Required bool.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the updated <code>Common.AgentDealerPermission.Id</code> as a string. Returns <code>statusCode: Error</code> with <code>\"Dealer permission not found\"</code> when <code>codeOrId</code> cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","DealerPermission","{{dealerPermissionCodeOrId}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"816ff5da-d26c-422c-9c60-00d178fd716e","name":"UpdateDealerPermission - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"ACTIVATE\",\n    \"description\": \"Allow dealer to activate new accounts (updated)\",\n    \"allowAccountActivation\": true,\n    \"allowBookNewAccount\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DealerPermission/ACTIVATE"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"e1f2a3b4-3333-4222-9333-abcdef012345\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"97087002-17ab-4fe1-a036-8d81244d81de","name":"UpdateDealerPermission - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"NONEXISTENT\",\n    \"description\": \"Allow dealer to activate new accounts (updated)\",\n    \"allowAccountActivation\": true,\n    \"allowBookNewAccount\": false\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DealerPermission/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Dealer permission not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"0a132015-30e5-442b-b849-eb1f79e7469a"},{"name":"DirectFromBureauConfigurationGet","id":"1c981ebb-4a1b-4ec4-a149-f96528abd034","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration/{{directFromBureauCodeOrId}}","description":"<h3 id=\"get-direct-from-bureau-configuration\">Get Direct From Bureau Configuration</h3>\n<p>Returns a single <code>Common.DirectFromBureauConfig</code> plus its custom vendor-config fields and product list via <code>DirectFromBureauConfigurationWSServices.GetDirectFromBureauConfigurationWS</code>. <code>codeOrId</code> is resolved through <code>SharedWSServices.GetCommonDirectFromBureauConfigId</code>, which accepts either the configuration <code>Id</code> (Guid) or the <code>DirectFromBureauCode</code> string. The custom vendor-config payload is loaded via <code>CustomVendorConfigServices.ReturnCompanyVendorConfiguration</code> with <code>VendorConfigurationTypes.DirectFromBureauConfig</code> and cast to <code>MyDirectFromBureauConfigCustomEntity</code>; when no custom row exists, the credential/OAuth fields come back as nulls/zeroes and <code>products</code> is an empty array.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration/{codeOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>codeOrId</em></td>\n<td>Required string. Either the <code>Common.DirectFromBureauConfig.Id</code> Guid or the case-sensitive <code>DirectFromBureauCode</code> value. Returns <code>statusCode: Error</code> with <code>\"Direct From Bureau configuration not found\"</code> when unresolved.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> shape:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid. <code>DirectFromBureauConfig.Id</code>.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Byte[]. Row <code>Ts</code> (concurrency token).</td>\n</tr>\n<tr>\n<td><em>omegaClientId</em></td>\n<td>Guid. <code>DirectFromBureauConfig.OmegaClientId</code>.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>String. <code>DirectFromBureauConfig.DirectFromBureauCode</code>.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool. <code>DirectFromBureauConfig.Active</code>.</td>\n</tr>\n<tr>\n<td><em>vendorType</em></td>\n<td>Int. <code>DirectFromBureauConfig.VendorType</code> enum value (1 = Equifax, 2 = Experian).</td>\n</tr>\n<tr>\n<td><em>customId</em></td>\n<td>Guid?. <code>MyDirectFromBureauConfigCustomEntity.Id</code>, or null when no custom row exists.</td>\n</tr>\n<tr>\n<td><em>customTs</em></td>\n<td>Byte[]. Custom row concurrency token, or null.</td>\n</tr>\n<tr>\n<td><em>reportExpirationDays</em></td>\n<td>Int. <code>ReportExpirationDays</code> on the custom entity (0 when missing).</td>\n</tr>\n<tr>\n<td><em>duplicateCheckDays</em></td>\n<td>Int. <code>DuplicateCheckDays</code> on the custom entity (0 when missing).</td>\n</tr>\n<tr>\n<td><em>bureauUsername</em></td>\n<td>String?. <code>BureauUsername</code>.</td>\n</tr>\n<tr>\n<td><em>bureauPassword</em></td>\n<td>String?. <code>BureauPassword</code>.</td>\n</tr>\n<tr>\n<td><em>clientReference</em></td>\n<td>String?. <code>ClientReference</code>.</td>\n</tr>\n<tr>\n<td><em>clientId</em></td>\n<td>String?. <code>ClientId</code>.</td>\n</tr>\n<tr>\n<td><em>clientSecretKey</em></td>\n<td>String?. <code>ClientSecretKey</code>.</td>\n</tr>\n<tr>\n<td><em>oAuthEndpoint</em></td>\n<td>String?. <code>OAuthEndpoint</code>.</td>\n</tr>\n<tr>\n<td><em>products</em></td>\n<td>Array of objects. Per-item: <code>productConfigId</code> (Guid), <code>isDefault</code> (bool), <code>productConfigCode</code> (string), <code>active</code> (bool). Sourced from <code>MyDirectFromBureauConfigCustomEntity.DirectFromBureauAvailableProductList</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","DirectFromBureau","Configuration","{{directFromBureauCodeOrId}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"75550065-2201-4e3e-a466-f07ea7e83e72","name":"GetDirectFromBureauConfiguration - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration/EQ-MAIN"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"id\": \"7f1b9c3a-6e2d-4b85-9c41-2a1f8c3e54a0\",\n        \"ts\": \"AAAAAAAAB9E=\",\n        \"omegaClientId\": \"11111111-2222-3333-4444-555555555555\",\n        \"code\": \"EQ-MAIN\",\n        \"active\": true,\n        \"vendorType\": 1,\n        \"customId\": \"c8ab77d1-2c3e-4bb1-8a97-6f1e9d5a6c10\",\n        \"customTs\": \"AAAAAAAAB9I=\",\n        \"reportExpirationDays\": 30,\n        \"duplicateCheckDays\": 14,\n        \"bureauUsername\": \"EQX_USER\",\n        \"bureauPassword\": \"********\",\n        \"clientReference\": \"CLIENT_REF_001\",\n        \"clientId\": \"equifax-client-id\",\n        \"clientSecretKey\": \"********\",\n        \"oAuthEndpoint\": \"https://api.equifax.com/v2/oauth/token\",\n        \"products\": [\n            {\n                \"productConfigId\": \"a4e1b2c3-d5f6-47a8-9012-3456789abcde\",\n                \"isDefault\": true,\n                \"productConfigCode\": \"FICO_SCORE_9\",\n                \"active\": true\n            },\n            {\n                \"productConfigId\": \"b5f1c2d3-e6a7-48b9-9012-3456789abcde\",\n                \"isDefault\": false,\n                \"productConfigCode\": \"CREDIT_REPORT_FULL\",\n                \"active\": true\n            }\n        ]\n    },\n    \"errors\": []\n}"},{"id":"dfbe2839-c3e2-4fb2-b6f7-8f99ef450492","name":"GetDirectFromBureauConfiguration - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration/NONEXISTENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Direct From Bureau configuration not found\"\n    ]\n}"}],"_postman_id":"1c981ebb-4a1b-4ec4-a149-f96528abd034"},{"name":"FileTransferJobAdd","id":"e390667f-6ee1-4452-9693-bed507280ed5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Nightly Payments Export\",\n  \"active\": true,\n  \"method\": 1,\n  \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n  \"remoteAddress\": \"sftp.lender.example.com\",\n  \"destinationPath\": \"/inbound/payments\",\n  \"fileName\": \"payments_{yyyyMMdd}.csv\",\n  \"username\": \"omega_payments\",\n  \"password\": \"<production-password>\",\n  \"privateKey\": null,\n  \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"port\": 22,\n  \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n  \"sbDestinationPath\": \"/sandbox/payments\",\n  \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n  \"sbUsername\": \"omega_payments_sb\",\n  \"sbPassword\": \"<sandbox-password>\",\n  \"sbPrivateKey\": null,\n  \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"sbPort\": 22,\n  \"successUserLoginOrId\": null,\n  \"failureUserLoginOrId\": null,\n  \"sbSuccessUserLoginOrId\": null,\n  \"sbFailureUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob","description":"<h3 id=\"add-file-transfer-job\">Add File Transfer Job</h3>\n<p>Creates a new <code>Setup.FileTransferJob</code> for the current client via <code>FileTransferJobWSServices.AddSaveFileTransferJobWS</code> (add path). The controller forces <code>id</code>/<code>ts</code> to null so a new job id is generated on save. <code>method</code> must be a defined <code>FileTransferJobMethod</code> value (1=SFTP, 2=FTPS, 3=__SFTP_Retrieve) or the request is rejected with \"Invalid method\". <code>name</code> is required.</p>\n<p>On success the saved <code>Setup.FileTransferJob.Id</code> is returned as a string in <code>data</code>.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/FileTransferJob</code></p>\n<h4 id=\"secret-handling\">Secret Handling</h4>\n<p><code>password</code>, <code>privateKey</code>, <code>sbPassword</code>, and <code>sbPrivateKey</code> are written to the row when provided. The API never re-emits secret values — the GET response only reports whether each secret is present (<code>hasPassword</code>, <code>hasPrivateKey</code>, <code>sbHasPassword</code>, <code>sbHasPrivateKey</code>).</p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>name</em></td>\n<td>Required string. Unique job name.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>method</em></td>\n<td>Required integer. <code>FileTransferJobMethod</code> enum (1=SFTP, 2=FTPS, 3=__SFTP_Retrieve).</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>remoteAddress</em></td>\n<td>Required string for production. SFTP/FTPS host.</td>\n</tr>\n<tr>\n<td><em>destinationPath</em></td>\n<td>Optional string. Remote destination path.</td>\n</tr>\n<tr>\n<td><em>fileName</em></td>\n<td>Optional string. File name pattern written to the remote.</td>\n</tr>\n<tr>\n<td><em>username</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>password</em></td>\n<td>Optional string. Production password.</td>\n</tr>\n<tr>\n<td><em>privateKey</em></td>\n<td>Optional string. Production SFTP private key.</td>\n</tr>\n<tr>\n<td><em>successUserId</em></td>\n<td>Optional Guid. <code>Setup.User.Id</code> notified on success.</td>\n</tr>\n<tr>\n<td><em>failureUserId</em></td>\n<td>Optional Guid. <code>Setup.User.Id</code> notified on failure.</td>\n</tr>\n<tr>\n<td><em>port</em></td>\n<td>Optional integer. Production port override.</td>\n</tr>\n<tr>\n<td><em>sbRemoteAddress</em></td>\n<td>Optional string. Sandbox host.</td>\n</tr>\n<tr>\n<td><em>sbDestinationPath</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>sbFileName</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>sbUsername</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>sbPassword</em></td>\n<td>Optional string. Sandbox password.</td>\n</tr>\n<tr>\n<td><em>sbPrivateKey</em></td>\n<td>Optional string. Sandbox SFTP private key.</td>\n</tr>\n<tr>\n<td><em>sbSuccessUserId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>sbFailureUserId</em></td>\n<td>Optional Guid.</td>\n</tr>\n<tr>\n<td><em>sbPort</em></td>\n<td>Optional integer.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the new <code>Setup.FileTransferJob.Id</code> as a string.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>successUserLoginOrId</code></td>\n<td><code>successUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>failureUserLoginOrId</code></td>\n<td><code>failureUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>sbSuccessUserLoginOrId</code></td>\n<td><code>sbSuccessUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>sbFailureUserLoginOrId</code></td>\n<td><code>sbFailureUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"successUserLoginOrId\": \"collector.login\",\n  \"failureUserLoginOrId\": \"collector.login\",\n  \"sbSuccessUserLoginOrId\": \"collector.login\",\n  \"sbFailureUserLoginOrId\": \"collector.login\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","FileTransferJob"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6bf301ff-3a8d-4279-aa97-79bd6229910d","name":"AddFileTransferJob - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Nightly Payments Export\",\n  \"active\": true,\n  \"method\": 1,\n  \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n  \"remoteAddress\": \"sftp.lender.example.com\",\n  \"destinationPath\": \"/inbound/payments\",\n  \"fileName\": \"payments_{yyyyMMdd}.csv\",\n  \"username\": \"omega_payments\",\n  \"password\": \"<production-password>\",\n  \"privateKey\": null,\n  \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"port\": 22,\n  \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n  \"sbDestinationPath\": \"/sandbox/payments\",\n  \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n  \"sbUsername\": \"omega_payments_sb\",\n  \"sbPassword\": \"<sandbox-password>\",\n  \"sbPrivateKey\": null,\n  \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"sbPort\": 22,\n  \"successUserLoginOrId\": null,\n  \"failureUserLoginOrId\": null,\n  \"sbSuccessUserLoginOrId\": null,\n  \"sbFailureUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"d1e2f3a4-1111-4222-9333-abcdef012345\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"aa2816ed-b89f-4c88-9de7-aa1560eeb573","name":"AddFileTransferJob - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Nightly Payments Export\",\n  \"active\": true,\n  \"method\": 99,\n  \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n  \"remoteAddress\": \"sftp.lender.example.com\",\n  \"destinationPath\": \"/inbound/payments\",\n  \"fileName\": \"payments_{yyyyMMdd}.csv\",\n  \"username\": \"omega_payments\",\n  \"password\": \"<production-password>\",\n  \"privateKey\": null,\n  \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"port\": 22,\n  \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n  \"sbDestinationPath\": \"/sandbox/payments\",\n  \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n  \"sbUsername\": \"omega_payments_sb\",\n  \"sbPassword\": \"<sandbox-password>\",\n  \"sbPrivateKey\": null,\n  \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"sbPort\": 22,\n  \"successUserLoginOrId\": null,\n  \"failureUserLoginOrId\": null,\n  \"sbSuccessUserLoginOrId\": null,\n  \"sbFailureUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Invalid method\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"e390667f-6ee1-4452-9693-bed507280ed5"},{"name":"FileTransferJobGet","id":"cbd3e35b-961f-4e3b-bf6c-cdd03aca139b","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob/{{fileTransferJobNameOrId}}","description":"<h3 id=\"get-file-transfer-job\">Get File Transfer Job</h3>\n<p>Returns a single <code>Setup.FileTransferJob</code> by name or id via <code>FileTransferJobWSServices.GetFileTransferJobWS</code>. <code>jobNameOrId</code> is resolved through <code>SharedWSServices.GetSetupFileTransferJobId</code> which accepts the Guid id or the job <code>Name</code>. Secrets (<code>Password</code>/<code>PrivateKey</code> and the <code>Sb*</code> sandbox equivalents) are never returned — only <code>hasPassword</code>, <code>hasPrivateKey</code>, <code>sbHasPassword</code>, and <code>sbHasPrivateKey</code> boolean flags.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/FileTransferJob/{jobNameOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>jobNameOrId</em></td>\n<td>Required string. Either the <code>Setup.FileTransferJob.Id</code> Guid or the case-sensitive <code>Name</code> value.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is the same per-item shape as <code>GET api/Client/Setup/FileTransferJob</code>. Returns <code>statusCode: Error</code> with <code>\"File transfer job not found\"</code> when <code>jobNameOrId</code> cannot be resolved.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","FileTransferJob","{{fileTransferJobNameOrId}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3961c1fd-6a90-41bd-8992-f6db143d0ae7","name":"GetFileTransferJob - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob/Nightly%20Payments%20Export"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"id\": \"d1e2f3a4-1111-4222-9333-abcdef012345\",\n        \"ts\": \"AAAAAAAAB9E=\",\n        \"omegaClientId\": \"c1d2e3f4-0000-4222-9333-abcdef012345\",\n        \"name\": \"Nightly Payments Export\",\n        \"active\": true,\n        \"method\": 1,\n        \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n        \"remoteAddress\": \"sftp.lender.example.com\",\n        \"destinationPath\": \"/inbound/payments\",\n        \"fileName\": \"payments_{yyyyMMdd}.csv\",\n        \"username\": \"omega_payments\",\n        \"hasPassword\": true,\n        \"hasPrivateKey\": false,\n        \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n        \"port\": 22,\n        \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n        \"sbDestinationPath\": \"/sandbox/payments\",\n        \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n        \"sbUsername\": \"omega_payments_sb\",\n        \"sbHasPassword\": true,\n        \"sbHasPrivateKey\": false,\n        \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n        \"sbPort\": 22\n    }\n}"},{"id":"1fb5123a-dc1b-4fce-8a5a-7b908c4d61af","name":"GetFileTransferJob - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob/Nonexistent%20Job"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"File transfer job not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"cbd3e35b-961f-4e3b-bf6c-cdd03aca139b"},{"name":"FileTransferJobsGetAll","id":"633cb685-2298-4f2c-9dfd-2090429d618d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob","description":"<h3 id=\"get-all-file-transfer-jobs\">Get All File Transfer Jobs</h3>\n<p>Returns every <code>Setup.FileTransferJob</code> row for the current client via <code>FileTransferJobWSServices.GetAllFileTransferJobsWS</code> which delegates to <code>FileTransferJobServices.ReturnAllFileTransferJobConfiguration</code>. Each record is projected through the safe shape that the <code>FileTransferJobMaintenance.aspx</code> screen uses — secrets are never returned, only boolean flags indicating whether each secret is set.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/FileTransferJob</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is an array of job objects. Per-item shape:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>id</em></td>\n<td>Guid. <code>Setup.FileTransferJob.Id</code>.</td>\n</tr>\n<tr>\n<td><em>ts</em></td>\n<td>Byte array. Row version timestamp.</td>\n</tr>\n<tr>\n<td><em>omegaClientId</em></td>\n<td>Guid. Owning client id.</td>\n</tr>\n<tr>\n<td><em>name</em></td>\n<td>String. Unique job name.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool.</td>\n</tr>\n<tr>\n<td><em>method</em></td>\n<td>Integer. <code>FileTransferJobMethod</code> enum (1=SFTP, 2=FTPS, 3=__SFTP_Retrieve).</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>remoteAddress</em></td>\n<td>String. Production host.</td>\n</tr>\n<tr>\n<td><em>destinationPath</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>fileName</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>username</em></td>\n<td>String.</td>\n</tr>\n<tr>\n<td><em>hasPassword</em></td>\n<td>Bool. True when a production password is stored. Plaintext is never returned.</td>\n</tr>\n<tr>\n<td><em>hasPrivateKey</em></td>\n<td>Bool. True when a production private key is stored.</td>\n</tr>\n<tr>\n<td><em>successUserId</em></td>\n<td>Guid?. <code>Setup.User.Id</code> notified on success.</td>\n</tr>\n<tr>\n<td><em>failureUserId</em></td>\n<td>Guid?. <code>Setup.User.Id</code> notified on failure.</td>\n</tr>\n<tr>\n<td><em>port</em></td>\n<td>Integer?. Production port override.</td>\n</tr>\n<tr>\n<td><em>sbRemoteAddress</em>, <em>sbDestinationPath</em>, <em>sbFileName</em>, <em>sbUsername</em>, <em>sbSuccessUserId</em>, <em>sbFailureUserId</em>, <em>sbPort</em></td>\n<td>Sandbox equivalents of the corresponding production fields.</td>\n</tr>\n<tr>\n<td><em>sbHasPassword</em></td>\n<td>Bool. True when a sandbox password is stored.</td>\n</tr>\n<tr>\n<td><em>sbHasPrivateKey</em></td>\n<td>Bool. True when a sandbox private key is stored.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","FileTransferJob"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d9e25e5d-38d8-46b8-96db-6e4059da964c","name":"GetAllFileTransferJobs - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"id\": \"d1e2f3a4-1111-4222-9333-abcdef012345\",\n            \"ts\": \"AAAAAAAAB9E=\",\n            \"omegaClientId\": \"c1d2e3f4-0000-4222-9333-abcdef012345\",\n            \"name\": \"Nightly Payments Export\",\n            \"active\": true,\n            \"method\": 1,\n            \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n            \"remoteAddress\": \"sftp.lender.example.com\",\n            \"destinationPath\": \"/inbound/payments\",\n            \"fileName\": \"payments_{yyyyMMdd}.csv\",\n            \"username\": \"omega_payments\",\n            \"hasPassword\": true,\n            \"hasPrivateKey\": false,\n            \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n            \"port\": 22,\n            \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n            \"sbDestinationPath\": \"/sandbox/payments\",\n            \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n            \"sbUsername\": \"omega_payments_sb\",\n            \"sbHasPassword\": true,\n            \"sbHasPrivateKey\": false,\n            \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n            \"sbPort\": 22\n        }\n    ]\n}"},{"id":"933a890e-fb37-4593-a134-a18842126fab","name":"GetAllFileTransferJobs - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving file transfer jobs: Session has expired.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"633cb685-2298-4f2c-9dfd-2090429d618d"},{"name":"FileTransferJobUpdate","id":"3ad82dd5-0d51-48cd-8a54-6ec270721f51","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Nightly Payments Export\",\n  \"active\": true,\n  \"method\": 1,\n  \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n  \"remoteAddress\": \"sftp.lender.example.com\",\n  \"destinationPath\": \"/inbound/payments/v2\",\n  \"fileName\": \"payments_{yyyyMMdd}.csv\",\n  \"username\": \"omega_payments\",\n  \"password\": null,\n  \"privateKey\": null,\n  \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"port\": 22,\n  \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n  \"sbDestinationPath\": \"/sandbox/payments/v2\",\n  \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n  \"sbUsername\": \"omega_payments_sb\",\n  \"sbPassword\": null,\n  \"sbPrivateKey\": null,\n  \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"sbPort\": 22,\n  \"successUserLoginOrId\": null,\n  \"failureUserLoginOrId\": null,\n  \"sbSuccessUserLoginOrId\": null,\n  \"sbFailureUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob/{{fileTransferJobNameOrId}}","description":"<h3 id=\"update-file-transfer-job\">Update File Transfer Job</h3>\n<p>Updates an existing <code>Setup.FileTransferJob</code> by name or id via <code>FileTransferJobWSServices.UpdateFileTransferJobWS</code>. <code>jobNameOrId</code> is resolved through <code>SharedWSServices.GetSetupFileTransferJobId</code> (accepts the Guid id or the case-sensitive <code>Name</code>) and the existing row's <code>Ts</code> is reused as the optimistic-concurrency token before the save path is invoked.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/FileTransferJob/{jobNameOrId}</code></p>\n<h4 id=\"secret-preservation-change-password-panel-semantics\">Secret Preservation (Change-Password Panel Semantics)</h4>\n<p>This matches the <code>FileTransferJobMaintenance.aspx</code> \"change password\" / \"change private key\" panel behavior used by <code>FileTransferJobServices.AddSaveFileTransferJobConfiguration</code>:</p>\n<ul>\n<li>Leaving <code>password</code> <strong>null</strong> preserves the existing production password. Sending an empty string overwrites it with empty.</li>\n<li>Leaving <code>privateKey</code> <strong>null or empty</strong> preserves the existing production private key. Sending any non-empty string overwrites it.</li>\n<li>Leaving <code>sbPassword</code> <strong>null</strong> preserves the existing sandbox password. Sending an empty string overwrites it with empty.</li>\n<li>Leaving <code>sbPrivateKey</code> <strong>null or empty</strong> preserves the existing sandbox private key. Sending any non-empty string overwrites it.</li>\n</ul>\n<p>Because secrets are not returned by the GET endpoints, a typical update re-sends all non-secret fields and simply omits the secret fields to keep the stored credentials intact.</p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>jobNameOrId</em></td>\n<td>Required string. Either the <code>Setup.FileTransferJob.Id</code> Guid or the case-sensitive <code>Name</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <code>POST api/Client/Setup/FileTransferJob</code>. See the Add request for a full field table. In addition to \"Invalid method\" and \"Name is required\", this endpoint also returns <code>\"File transfer job not found\"</code> when <code>jobNameOrId</code> cannot be resolved.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is the updated <code>Setup.FileTransferJob.Id</code> as a string.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>successUserLoginOrId</code></td>\n<td><code>successUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>failureUserLoginOrId</code></td>\n<td><code>failureUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>sbSuccessUserLoginOrId</code></td>\n<td><code>sbSuccessUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>sbFailureUserLoginOrId</code></td>\n<td><code>sbFailureUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"successUserLoginOrId\": \"collector.login\",\n  \"failureUserLoginOrId\": \"collector.login\",\n  \"sbSuccessUserLoginOrId\": \"collector.login\",\n  \"sbFailureUserLoginOrId\": \"collector.login\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","FileTransferJob","{{fileTransferJobNameOrId}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dca404ef-0fe3-47f0-bc95-c384bd4709e4","name":"UpdateFileTransferJob - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Nightly Payments Export\",\n  \"active\": true,\n  \"method\": 1,\n  \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n  \"remoteAddress\": \"sftp.lender.example.com\",\n  \"destinationPath\": \"/inbound/payments/v2\",\n  \"fileName\": \"payments_{yyyyMMdd}.csv\",\n  \"username\": \"omega_payments\",\n  \"password\": null,\n  \"privateKey\": null,\n  \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"port\": 22,\n  \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n  \"sbDestinationPath\": \"/sandbox/payments/v2\",\n  \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n  \"sbUsername\": \"omega_payments_sb\",\n  \"sbPassword\": null,\n  \"sbPrivateKey\": null,\n  \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"sbPort\": 22,\n  \"successUserLoginOrId\": null,\n  \"failureUserLoginOrId\": null,\n  \"sbSuccessUserLoginOrId\": null,\n  \"sbFailureUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob/Nightly%20Payments%20Export"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"d1e2f3a4-1111-4222-9333-abcdef012345\",\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"28c2b3d6-bf4f-49d6-8e28-8fd7f485c667","name":"UpdateFileTransferJob - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"Nonexistent Job\",\n  \"active\": true,\n  \"method\": 1,\n  \"description\": \"Uploads nightly payment batches to the lender SFTP\",\n  \"remoteAddress\": \"sftp.lender.example.com\",\n  \"destinationPath\": \"/inbound/payments/v2\",\n  \"fileName\": \"payments_{yyyyMMdd}.csv\",\n  \"username\": \"omega_payments\",\n  \"password\": null,\n  \"privateKey\": null,\n  \"successUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"failureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"port\": 22,\n  \"sbRemoteAddress\": \"sftp-sandbox.lender.example.com\",\n  \"sbDestinationPath\": \"/sandbox/payments/v2\",\n  \"sbFileName\": \"payments_{yyyyMMdd}.csv\",\n  \"sbUsername\": \"omega_payments_sb\",\n  \"sbPassword\": null,\n  \"sbPrivateKey\": null,\n  \"sbSuccessUserId\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n  \"sbFailureUserId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n  \"sbPort\": 22,\n  \"successUserLoginOrId\": null,\n  \"failureUserLoginOrId\": null,\n  \"sbSuccessUserLoginOrId\": null,\n  \"sbFailureUserLoginOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/FileTransferJob/Nonexistent%20Job"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"File transfer job not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"3ad82dd5-0d51-48cd-8a54-6ec270721f51"},{"name":"OptionalFeatures","id":"50cbe831-7fff-4e8e-b105-5b498c1fd6ed","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"enableOmegaSign\": true,\n    \"enableDocumentScanning\": false,\n    \"enableOmegaMailer\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/OptionalFeatures","description":"<h3 id=\"update-optional-features\">Update Optional Features</h3>\n<p>Toggles optional-feature flags on the current client license via <code>OptionalFeaturesWSServices.UpdateOptionalFeaturesWS</code>. Each flag is a nullable bool on the request body and is <strong>only applied when the value is non-null AND differs from the current <code>OptionalFeatures</code> bitmask</strong> on <code>SetupInternal.ClientLicense</code>. Every change is written to <code>Common.MaintenanceLog</code> so the GET endpoint can return the history.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/OptionalFeatures</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>enableOmegaSign</em></td>\n<td>Optional bool. When non-null and different from the current state, toggles <code>OptionalFeatures.OmegaSign</code>.</td>\n</tr>\n<tr>\n<td><em>enableDocumentScanning</em></td>\n<td>Optional bool. When non-null and different from the current state, toggles <code>OptionalFeatures.Dynamsoft</code> (Dynamsoft document scanning).</td>\n</tr>\n<tr>\n<td><em>enableOmegaMailer</em></td>\n<td>Optional bool. When non-null and different from the current state, toggles <code>OptionalFeatures.OmegaMailer</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"conflict-rules\">Conflict Rules</h4>\n<ul>\n<li><strong>OmegaSign disable blocked by merge-form usage.</strong> If <code>enableOmegaSign</code> is <code>false</code> and at least one active merge form still uses OmegaSign, the request fails with <code>\"OmegaSign is in use by a merge form.\"</code> and no flags change.</li>\n<li><strong>OmegaMailer disable blocked by merge-form usage.</strong> If <code>enableOmegaMailer</code> is <code>false</code> and at least one active merge form still uses OmegaMailer, the request fails with <code>\"OmegaMailer is in use by a merge form.\"</code> and no flags change.</li>\n<li><strong>Dynamsoft (document scanning)</strong> has no merge-form conflict check and can always be toggled.</li>\n</ul>\n<h4 id=\"side-effects\">Side Effects</h4>\n<ul>\n<li><strong>Enabling OmegaMailer</strong> invokes <code>SetupOmegaMailerFileTransferJobAndDocSafeFolder</code>, which provisions the OmegaMailer <code>Setup.FileTransferJob</code> row and the required DocSafe folder if they are not already present.</li>\n<li><strong>Disabling OmegaMailer</strong> does not remove the provisioned file transfer job or DocSafe folder.</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p>Returns the same shape as <code>GET /api/Client/Setup/OptionalFeatures</code> so the caller sees the post-update flag state and the newly appended maintenance-log history entry/entries:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>enableOmegaSign</em></td>\n<td>Bool. Post-update state of <code>OptionalFeatures.OmegaSign</code>.</td>\n</tr>\n<tr>\n<td><em>enableDocumentScanning</em></td>\n<td>Bool. Post-update state of <code>OptionalFeatures.Dynamsoft</code>.</td>\n</tr>\n<tr>\n<td><em>enableOmegaMailer</em></td>\n<td>Bool. Post-update state of <code>OptionalFeatures.OmegaMailer</code>.</td>\n</tr>\n<tr>\n<td><em>history</em></td>\n<td>Array. Maintenance-log entries sorted by most recent <code>EventDate</code> first. Per-item shape: <code>date</code> (DateTime), <code>description</code> (string), <code>user</code> (string?).</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","OptionalFeatures"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0801ba9a-4668-4b4f-92f0-77ed4ea2dcef","name":"UpdateOptionalFeatures - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"enableOmegaSign\": true,\n    \"enableDocumentScanning\": false,\n    \"enableOmegaMailer\": true\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/OptionalFeatures"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"enableOmegaSign\": true,\n        \"enableDocumentScanning\": false,\n        \"enableOmegaMailer\": true,\n        \"history\": [\n            {\n                \"date\": \"2026-04-18T09:15:32.000\",\n                \"description\": \"OmegaMailer enabled\",\n                \"user\": \"developer\"\n            },\n            {\n                \"date\": \"2026-04-18T09:15:32.000\",\n                \"description\": \"OmegaSign enabled\",\n                \"user\": \"developer\"\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8ce078fc-3f9f-4f4f-b558-73f24f945d32","name":"UpdateOptionalFeatures - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"enableOmegaSign\": false,\n    \"enableDocumentScanning\": false,\n    \"enableOmegaMailer\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/OptionalFeatures"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"OmegaSign is in use by a merge form.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"50cbe831-7fff-4e8e-b105-5b498c1fd6ed"},{"name":"OptionalFeatures","id":"4de1bfcb-8132-45ae-a45e-2c706bdfd890","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/OptionalFeatures","description":"<h3 id=\"get-optional-features\">Get Optional Features</h3>\n<p>Returns the optional-feature flag state for the current client plus the associated maintenance-log history via <code>OptionalFeaturesWSServices.GetOptionalFeaturesWS</code>. Flags are derived from the <code>OptionalFeatures</code> bitmask returned by <code>Omega.SetupInternal.BLL.ClientLicenseServices.GetOptionalFeatures</code>. The history array is taken from <code>Common.MaintenanceLog</code> via <code>Omega.Common.Log.MaintenanceLogServices.ReturnMaintenanceLogs</code> and sorted descending by <code>EventDate</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/OptionalFeatures</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> shape:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>enableOmegaSign</em></td>\n<td>Bool. True when <code>OptionalFeatures.OmegaSign</code> is set on the client license.</td>\n</tr>\n<tr>\n<td><em>enableDocumentScanning</em></td>\n<td>Bool. True when <code>OptionalFeatures.Dynamsoft</code> (Dynamsoft document scanning) is set.</td>\n</tr>\n<tr>\n<td><em>enableOmegaMailer</em></td>\n<td>Bool. True when <code>OptionalFeatures.OmegaMailer</code> is set.</td>\n</tr>\n<tr>\n<td><em>history</em></td>\n<td>Array. Maintenance-log entries from <code>Common.MaintenanceLog</code> (all sources, not just optional-feature toggles) sorted by most recent <code>EventDate</code> first. Per-item shape: <code>date</code> (DateTime, <code>EventDate</code>), <code>description</code> (string, <code>EventDescription</code>), <code>user</code> (string?, <code>SetupUser.UserLogin</code> when the log row references a user).</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","OptionalFeatures"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9494f7c4-9ad1-442d-936b-394727fe75ca","name":"GetOptionalFeatures - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Setup/OptionalFeatures"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"enableOmegaSign\": true,\n        \"enableDocumentScanning\": false,\n        \"enableOmegaMailer\": true,\n        \"history\": [\n            {\n                \"date\": \"2026-04-15T13:22:41.000\",\n                \"description\": \"OmegaMailer enabled\",\n                \"user\": \"developer\"\n            },\n            {\n                \"date\": \"2026-03-02T10:05:00.000\",\n                \"description\": \"OmegaSign enabled\",\n                \"user\": \"developer\"\n            }\n        ]\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"8bac9d6b-9718-4420-90b5-9a808fcea28b","name":"GetOptionalFeatures - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"invalid-token"}],"url":"https://{{base_url}}/api/Client/Setup/OptionalFeatures"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error retrieving optional features: Session has expired.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"4de1bfcb-8132-45ae-a45e-2c706bdfd890"},{"name":"RoleAdd","id":"117a80e9-ed6a-41b5-a169-c00f1dfce7e9","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"roleType\": 1,\n    \"roleName\": \"Collection Supervisor\",\n    \"description\": \"Supervisor-level access to collection queues\",\n    \"active\": true,\n    \"permissions\": [\n        \"e1f2a3b4-1111-4222-9333-abcdef012345\",\n        \"e1f2a3b4-2222-4222-9333-abcdef012345\"\n    ],\n    \"customPermissions\": [],\n    \"roleAccountEntryDetails\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Role","description":"<h3 id=\"add-role\">Add Role</h3>\n<p>Creates a new <code>Setup.Role</code> for the current client via <code>RoleWSServices.AddSaveRoleWS</code> (add path). The add path sets the new role id to <code>param.id ?? Guid.NewGuid()</code> before persisting. Returns the new role id.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Role</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>roleType</em></td>\n<td>Required integer. <code>RoleTypes</code> enum — <code>1</code> Application, <code>2</code> AccountEntry, <code>3</code> APIAccess, etc.</td>\n</tr>\n<tr>\n<td><em>roleName</em></td>\n<td>Required string. Unique role name.</td>\n</tr>\n<tr>\n<td><em>description</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Required bool. Whether the role is active.</td>\n</tr>\n<tr>\n<td><em>permissions</em></td>\n<td>Required <code>List&lt;Guid&gt;</code>. <code>Global.Permission.Id</code> values granted by this role.</td>\n</tr>\n<tr>\n<td><em>customPermissions</em></td>\n<td>Required <code>List&lt;Guid&gt;</code>. Client-level custom permission ids. Pass <code>[]</code> when not used.</td>\n</tr>\n<tr>\n<td><em>roleAccountEntryDetails</em></td>\n<td>Optional list. Populated only for AccountEntry roles. Each entry: <code>id</code> (Guid?), <code>ts</code> (byte[]?), <code>fieldType</code> (int — <code>RoleAccountEntryFieldTypes</code> enum), <code>formattedMinValue</code>/<code>formattedMaxValue</code> (string), <code>minRateValue</code>/<code>maxRateValue</code>, <code>minIntValue</code>/<code>maxIntValue</code>, <code>minMoneyValue</code>/<code>maxMoneyValue</code>, <code>display</code> (bool).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ \"Id\": \"&lt;new role Guid&gt;\" }</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","Role"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"dd0c5267-fa6f-414d-b7b7-9a116c317cec","name":"AddRole - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"roleType\": 1,\n    \"roleName\": \"Collection Supervisor\",\n    \"description\": \"Supervisor-level access to collection queues\",\n    \"active\": true,\n    \"permissions\": [\n        \"e1f2a3b4-1111-4222-9333-abcdef012345\",\n        \"e1f2a3b4-2222-4222-9333-abcdef012345\"\n    ],\n    \"customPermissions\": [],\n    \"roleAccountEntryDetails\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Role"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-9999-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"2335d7ec-c9b3-434e-a198-0d1adeb196e1","name":"AddRole - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"roleType\": 1,\n    \"roleName\": \"\",\n    \"description\": \"Supervisor-level access to collection queues\",\n    \"active\": true,\n    \"permissions\": [\n        \"e1f2a3b4-1111-4222-9333-abcdef012345\",\n        \"e1f2a3b4-2222-4222-9333-abcdef012345\"\n    ],\n    \"customPermissions\": [],\n    \"roleAccountEntryDetails\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Role"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Role name is required\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"117a80e9-ed6a-41b5-a169-c00f1dfce7e9"},{"name":"RoleGet","id":"e1e4edc1-e7ae-4ace-bc29-d138b14b512f","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}","description":"<h3 id=\"get-role\">Get Role</h3>\n<p>Returns a single <code>Setup.Role</code> record resolved by either the role name (string) or the <code>Id</code> (Guid). <code>RoleWSServices.ReturnRoleWS</code> calls <code>Guid.TryParse</code> first and falls back to a name lookup when the value is not a Guid. Returns <code>BadRequest</code> when the role cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Role/{nameOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>nameOrId</em></td>\n<td>Required. Either <code>Setup.Role.RoleName</code> (string) or <code>Setup.Role.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","Role","{{role_name_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f5c84585-725d-443b-b9f3-d2481fd46164","name":"GetRole - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n        \"RoleName\": \"Administrator\",\n        \"RoleType\": 1,\n        \"Active\": true,\n        \"Description\": \"Full system access\"\n    }\n}"},{"id":"f0c3dc26-4483-47fd-853e-f87060d3be48","name":"GetRole - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Role not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"e1e4edc1-e7ae-4ace-bc29-d138b14b512f"},{"name":"RolePermissionsGet","id":"75a7a9dd-c8f3-4a67-beab-f96747984f35","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}/Permissions?activeOnly=true","description":"<h3 id=\"get-role-permissions\">Get Role Permissions</h3>\n<p>Returns the general permission set granted by a role via <code>RolePermissionServices.ReturnGeneralRolePermission</code> (wrapped by <code>RoleWSServices.ReturnRolePermissionsWS</code>). The <code>nameOrId</code> path segment supports either the role name or the role id. The optional <code>activeOnly</code> query flag restricts results to active permissions.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Role/{nameOrId}/Permissions</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>nameOrId</em></td>\n<td>Required. Either <code>Setup.Role.RoleName</code> (string) or <code>Setup.Role.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>activeOnly</em></td>\n<td>Optional bool. When <code>true</code>, returns only active permissions. Defaults to <code>false</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","Role","{{role_name_or_id}}","Permissions"],"host":["{{base_url}}"],"query":[{"key":"activeOnly","value":"true"}],"variable":[]}},"response":[{"id":"5ee556e2-eac1-47a4-b1a9-2a31dcc0be05","name":"GetRolePermissions - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}/Permissions?activeOnly=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","Role","{{role_name_or_id}}","Permissions"],"query":[{"key":"activeOnly","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"PermissionId\": \"e1f2a3b4-1111-4222-9333-abcdef012345\",\n            \"PermissionName\": \"Accounts - View\",\n            \"Active\": true\n        },\n        {\n            \"PermissionId\": \"e1f2a3b4-2222-4222-9333-abcdef012345\",\n            \"PermissionName\": \"Accounts - Edit\",\n            \"Active\": true\n        }\n    ]\n}"},{"id":"0f86223c-e05c-4fad-b3ef-85d9423a2f89","name":"GetRolePermissions - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}/Permissions?activeOnly=true","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","Role","{{role_name_or_id}}","Permissions"],"query":[{"key":"activeOnly","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Role not found\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"75a7a9dd-c8f3-4a67-beab-f96747984f35"},{"name":"RolesGetAll","id":"b091fdd1-3776-477c-9279-2907f5a1c919","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role","description":"<h3 id=\"get-all-roles\">Get All Roles</h3>\n<p>Returns every <code>Setup.Role</code> row for the current client via <code>RoleWSServices.ReturnAllRolesWS</code>. Roles are application-level permission bundles (not to be confused with permissions themselves). Each record includes the role id, name, role type, active flag, and description.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Role</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","Role"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7f825a34-5190-493c-8d7b-699fa5a0ebd1","name":"GetAllRoles - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"b1c2d3e4-1111-4222-9333-abcdef012345\",\n            \"RoleName\": \"Administrator\",\n            \"RoleType\": 1,\n            \"Active\": true,\n            \"Description\": \"Full system access\"\n        },\n        {\n            \"Id\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n            \"RoleName\": \"Collector\",\n            \"RoleType\": 2,\n            \"Active\": true,\n            \"Description\": \"Collection queue access\"\n        }\n    ]\n}"},{"id":"472f848f-5535-4b61-99e8-86224b2384fc","name":"GetAllRoles - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/Role"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving roles: Authentication failed\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"b091fdd1-3776-477c-9279-2907f5a1c919"},{"name":"RoleUpdate","id":"da280342-38bd-40fe-b6d6-9ae726d2c4d2","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"roleType\": 1,\n    \"roleName\": \"Collection Supervisor\",\n    \"description\": \"Updated description\",\n    \"active\": true,\n    \"permissions\": [\n        \"e1f2a3b4-1111-4222-9333-abcdef012345\"\n    ],\n    \"customPermissions\": [],\n    \"roleAccountEntryDetails\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}","description":"<h3 id=\"update-role\">Update Role</h3>\n<p>Updates an existing <code>Setup.Role</code> resolved by <code>{nameOrId}</code>. The controller calls <code>RoleWSServices.AddSaveRoleWS</code> with <code>isAdd = false</code>. The update path uses <code>SharedWSServices.GetSetupRoleId</code> to resolve the id, then fetches existing permissions to build the oldPermissions/oldCustomPermissions dictionaries used for delta application.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Role/{nameOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>nameOrId</em></td>\n<td>Required. Either <code>Setup.Role.RoleName</code> (string) or <code>Setup.Role.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <code>Add Role</code> (see <code>AddRole.request.yaml</code>). The <code>permissions</code> list represents the desired final set; the WS service computes adds/removes against the existing role state.</p>\n<h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ \"Id\": \"&lt;role Guid&gt;\" }</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","Role","{{role_name_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3360d042-a83d-4e1b-b5a4-4653747c2bde","name":"UpdateRole - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"roleType\": 1,\n    \"roleName\": \"Collection Supervisor\",\n    \"description\": \"Updated description\",\n    \"active\": true,\n    \"permissions\": [\n        \"e1f2a3b4-1111-4222-9333-abcdef012345\"\n    ],\n    \"customPermissions\": [],\n    \"roleAccountEntryDetails\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"b1c2d3e4-9999-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"e4a80f0c-bf8a-4ced-b394-e49b23e24da5","name":"UpdateRole - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"roleType\": 1,\n    \"roleName\": \"\",\n    \"description\": \"Updated description\",\n    \"active\": true,\n    \"permissions\": [\n        \"e1f2a3b4-1111-4222-9333-abcdef012345\"\n    ],\n    \"customPermissions\": [],\n    \"roleAccountEntryDetails\": []\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Role/{{role_name_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Role not found\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"da280342-38bd-40fe-b6d6-9ae726d2c4d2"},{"name":"SaveClientAdd","id":"01a310d0-7bbc-4acb-978c-3549e442d88b","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"useGeneralLedger\": true,\n  \"useAccountsPayable\": true,\n  \"useServicing\": true,\n  \"useOriginations\": false,\n  \"timeZoneId\": \"Eastern Standard Time\",\n  \"billingEmail\": \"billing@example.com\",\n  \"pdfPassword\": \"\",\n  \"dayendCompleteNotificationEmail\": \"ops@example.com\",\n  \"currency\": 1,\n  \"daysOfOperation\": 62,\n  \"userInactivityTimeoutSeconds\": 1800,\n  \"twoFactorRequirement\": 1,\n  \"twoFactorRememberMeDays\": 30,\n  \"omegaMailerTaskTemplateId\": null,\n  \"omegaMailerAssignedToUserId\": null,\n  \"omegaMailerAssignedToRoleId\": null,\n  \"overrideSenderEmail\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"ofacMinMatchScore\": 85,\n  \"mailingAddressLine1\": \"123 Main Street\",\n  \"mailingAddressLine2\": \"\",\n  \"mailingAddressLine3\": \"\",\n  \"mailingAddressCity\": \"Tampa\",\n  \"mailingAddressZipCode\": \"33602\",\n  \"mailingAddressProvinceId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"omegaMailerTaskTemplateNumberOrId\": null,\n  \"omegaMailerAssignedToUserLoginOrId\": null,\n  \"omegaMailerAssignedToRoleNameOrId\": null,\n  \"mailingAddressProvinceAbbreviationOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Client","description":"<h3 id=\"add-save-client\">Add Save Client</h3>\n<p>Upserts the current client's <code>Setup.Client</code> row via <code>ClientWSServices.AddSaveClientWS</code>. The existing client is resolved with <code>ClientServices.ReturnClientWithId(databaseName, clientId)</code>; if a row exists <code>ClientServices.SaveClient</code> is called, otherwise <code>ClientServices.AddClient</code> is called with a new id. After the client upsert, the Mailing address is added or saved through <code>Omega.Common.BLL.AddressServices</code> (single existing <code>Mailing</code> address is updated, otherwise a new one is added).</p>\n<p>Validation rules enforced by <code>ValidateClientParameter</code>:</p>\n<ul>\n<li><code>useGeneralLedger</code> requires <code>useAccountsPayable</code>.</li>\n<li>OmegaMailer template and assignee must be provided together (<code>omegaMailerTaskTemplateId</code> paired with exactly one of <code>omegaMailerAssignedToUserId</code> or <code>omegaMailerAssignedToRoleId</code>).</li>\n<li><code>mailingAddressLine1</code> and <code>mailingAddressCity</code> are required.</li>\n</ul>\n<p>When <code>timeZoneId</code> is omitted, the caller's <code>LoginInfo.TimeZoneId</code> is used.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Client</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token returned by Login.</td>\n</tr>\n<tr>\n<td><em>useGeneralLedger</em></td>\n<td>Required bool. Enables the General Ledger module. Requires <code>useAccountsPayable=true</code>.</td>\n</tr>\n<tr>\n<td><em>useAccountsPayable</em></td>\n<td>Required bool. Enables Accounts Payable.</td>\n</tr>\n<tr>\n<td><em>useServicing</em></td>\n<td>Required bool. Enables Servicing.</td>\n</tr>\n<tr>\n<td><em>useOriginations</em></td>\n<td>Required bool. Enables Originations.</td>\n</tr>\n<tr>\n<td><em>timeZoneId</em></td>\n<td>Optional string. IANA/Windows time-zone id. Falls back to the caller's <code>LoginInfo.TimeZoneId</code> when blank.</td>\n</tr>\n<tr>\n<td><em>billingEmail</em></td>\n<td>Optional string. Stored as empty when null.</td>\n</tr>\n<tr>\n<td><em>pdfPassword</em></td>\n<td>Optional string. Stored as empty when null.</td>\n</tr>\n<tr>\n<td><em>dayendCompleteNotificationEmail</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>currency</em></td>\n<td>Required integer. <code>Megasys.Framework.Types.Enums.SystemCurrencyTypes</code> (1=Dollar, 2=Peso).</td>\n</tr>\n<tr>\n<td><em>daysOfOperation</em></td>\n<td>Required integer. Bitmask of <code>Megasys.Framework.Types.Enums.DaysOfWeek</code> (Sun=1, Mon=2, Tue=4, Wed=8, Thu=16, Fri=32, Sat=64).</td>\n</tr>\n<tr>\n<td><em>userInactivityTimeoutSeconds</em></td>\n<td>Required integer. Idle seconds before forced logout.</td>\n</tr>\n<tr>\n<td><em>twoFactorRequirement</em></td>\n<td>Required integer. <code>TwoFactorRequirementTypes</code> (1=None, 2=Any_Two_Factor_Authentication, 3=Email, 4=Google_Authenticator). Only applied on existing client saves.</td>\n</tr>\n<tr>\n<td><em>twoFactorRememberMeDays</em></td>\n<td>Required integer. Days the Remember-Me cookie is honored. Only applied on existing client saves.</td>\n</tr>\n<tr>\n<td><em>omegaMailerTaskTemplateId</em></td>\n<td>Optional Guid. OmegaMailer task template. Must be paired with an assignee (user or role).</td>\n</tr>\n<tr>\n<td><em>omegaMailerAssignedToUserId</em></td>\n<td>Optional Guid. OmegaMailer assignee user. Mutually exclusive with <code>omegaMailerAssignedToRoleId</code>.</td>\n</tr>\n<tr>\n<td><em>omegaMailerAssignedToRoleId</em></td>\n<td>Optional Guid. OmegaMailer assignee role. Mutually exclusive with <code>omegaMailerAssignedToUserId</code>.</td>\n</tr>\n<tr>\n<td><em>overrideSenderEmail</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>overrideDefaultEmailDisplayName</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>ofacMinMatchScore</em></td>\n<td>Optional integer. OFAC minimum match score (0-100).</td>\n</tr>\n<tr>\n<td><em>mailingAddressLine1</em></td>\n<td>Required string. Mailing address line 1.</td>\n</tr>\n<tr>\n<td><em>mailingAddressLine2</em></td>\n<td>Optional string. Mailing address line 2.</td>\n</tr>\n<tr>\n<td><em>mailingAddressLine3</em></td>\n<td>Optional string. Mailing address line 3.</td>\n</tr>\n<tr>\n<td><em>mailingAddressCity</em></td>\n<td>Required string. Mailing address city.</td>\n</tr>\n<tr>\n<td><em>mailingAddressZipCode</em></td>\n<td>Optional string. Mailing address zip/postal code.</td>\n</tr>\n<tr>\n<td><em>mailingAddressProvinceId</em></td>\n<td>Optional Guid. <code>Common.Province.Id</code> (state / province).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Returns <code>{ \"Id\": \"&lt;Setup.Client.Id Guid&gt;\" }</code> on success. Validation failures return <code>statusCode = Error</code> with detail messages in <code>errors</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>omegaMailerTaskTemplateNumberOrId</code></td>\n<td><code>omegaMailerTaskTemplateId</code></td>\n<td>String. task-template number or template GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>omegaMailerAssignedToUserLoginOrId</code></td>\n<td><code>omegaMailerAssignedToUserId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>omegaMailerAssignedToRoleNameOrId</code></td>\n<td><code>omegaMailerAssignedToRoleId</code></td>\n<td>String. general-role name or general-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>mailingAddressProvinceAbbreviationOrId</code></td>\n<td><code>mailingAddressProvinceId</code></td>\n<td>String. province/state abbreviation or province/state GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"omegaMailerTaskTemplateNumberOrId\": \"1\",\n  \"omegaMailerAssignedToUserLoginOrId\": \"collector.login\",\n  \"omegaMailerAssignedToRoleNameOrId\": \"Collections\",\n  \"mailingAddressProvinceAbbreviationOrId\": \"CA\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","Client"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"99835a24-9488-4350-ae74-f696845c1a2e","name":"AddSaveClient - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"useGeneralLedger\": true,\n  \"useAccountsPayable\": true,\n  \"useServicing\": true,\n  \"useOriginations\": false,\n  \"timeZoneId\": \"Eastern Standard Time\",\n  \"billingEmail\": \"billing@example.com\",\n  \"pdfPassword\": \"\",\n  \"dayendCompleteNotificationEmail\": \"ops@example.com\",\n  \"currency\": 1,\n  \"daysOfOperation\": 62,\n  \"userInactivityTimeoutSeconds\": 1800,\n  \"twoFactorRequirement\": 1,\n  \"twoFactorRememberMeDays\": 30,\n  \"omegaMailerTaskTemplateId\": null,\n  \"omegaMailerAssignedToUserId\": null,\n  \"omegaMailerAssignedToRoleId\": null,\n  \"overrideSenderEmail\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"ofacMinMatchScore\": 85,\n  \"mailingAddressLine1\": \"123 Main Street\",\n  \"mailingAddressLine2\": \"\",\n  \"mailingAddressLine3\": \"\",\n  \"mailingAddressCity\": \"Tampa\",\n  \"mailingAddressZipCode\": \"33602\",\n  \"mailingAddressProvinceId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"omegaMailerTaskTemplateNumberOrId\": null,\n  \"omegaMailerAssignedToUserLoginOrId\": null,\n  \"omegaMailerAssignedToRoleNameOrId\": null,\n  \"mailingAddressProvinceAbbreviationOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Client"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-8888-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"5563c30c-4d60-4ce4-b8d1-1c1d5c1b7d6e","name":"AddSaveClient - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"useGeneralLedger\": true,\n  \"useAccountsPayable\": false,\n  \"useServicing\": true,\n  \"useOriginations\": false,\n  \"timeZoneId\": \"Eastern Standard Time\",\n  \"billingEmail\": \"billing@example.com\",\n  \"pdfPassword\": \"\",\n  \"dayendCompleteNotificationEmail\": \"ops@example.com\",\n  \"currency\": 1,\n  \"daysOfOperation\": 62,\n  \"userInactivityTimeoutSeconds\": 1800,\n  \"twoFactorRequirement\": 1,\n  \"twoFactorRememberMeDays\": 30,\n  \"omegaMailerTaskTemplateId\": null,\n  \"omegaMailerAssignedToUserId\": null,\n  \"omegaMailerAssignedToRoleId\": null,\n  \"overrideSenderEmail\": \"\",\n  \"overrideDefaultEmailDisplayName\": \"\",\n  \"ofacMinMatchScore\": 85,\n  \"mailingAddressLine1\": \"123 Main Street\",\n  \"mailingAddressLine2\": \"\",\n  \"mailingAddressLine3\": \"\",\n  \"mailingAddressCity\": \"Tampa\",\n  \"mailingAddressZipCode\": \"33602\",\n  \"mailingAddressProvinceId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"omegaMailerTaskTemplateNumberOrId\": null,\n  \"omegaMailerAssignedToUserLoginOrId\": null,\n  \"omegaMailerAssignedToRoleNameOrId\": null,\n  \"mailingAddressProvinceAbbreviationOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Client"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Accounts Payable module is required when using the General Ledger module.\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"01a310d0-7bbc-4acb-978c-3549e442d88b"},{"name":"SaveDirectFromBureauConfigurationAdd","id":"33045209-2357-4247-a3e1-f4fc11600085","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"EQ-MAIN\",\n    \"active\": true,\n    \"vendorType\": 1,\n    \"reportExpirationDays\": 30,\n    \"duplicateCheckDays\": 14,\n    \"bureauUsername\": \"EQX_USER\",\n    \"bureauPassword\": \"REPLACE_WITH_SECRET\",\n    \"clientReference\": \"CLIENT_REF_001\",\n    \"clientId\": \"equifax-client-id\",\n    \"clientSecretKey\": \"REPLACE_WITH_SECRET\",\n    \"oAuthEndpoint\": \"https://api.equifax.com/v2/oauth/token\",\n    \"products\": [\n        {\n            \"productConfigId\": \"a4e1b2c3-d5f6-47a8-9012-3456789abcde\",\n            \"isDefault\": true,\n            \"productConfigCode\": \"FICO_SCORE_9\",\n            \"active\": true\n        },\n        {\n            \"productConfigId\": \"b5f1c2d3-e6a7-48b9-9012-3456789abcde\",\n            \"isDefault\": false,\n            \"productConfigCode\": \"CREDIT_REPORT_FULL\",\n            \"active\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration","description":"<h3 id=\"add-or-save-direct-from-bureau-configuration\">Add or Save Direct From Bureau Configuration</h3>\n<p>Upserts a <code>Common.DirectFromBureauConfig</code> plus its custom vendor-config row via <code>DirectFromBureauConfigurationWSServices.AddSaveDirectFromBureauConfigurationWS</code>. The lookup uses <code>code</code>: when <code>DirectFromBureauServices.ReturnDirectFromBureauConfigId</code> finds an existing row, the existing <code>Id</code>/<code>Ts</code> are reused for optimistic concurrency; otherwise new Guids are allocated for both the main row and the custom row. All vendor credentials and OAuth settings live on the custom <code>MyDirectFromBureauConfigCustomEntity</code> stored through <code>CustomVendorConfigServices</code> with <code>VendorConfigurationTypes.DirectFromBureauConfig</code>. The save is committed through <code>Omega.Framework.BLL.Database.Transaction.CommitTransaction</code>.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>code</em></td>\n<td>Required string. <code>DirectFromBureauCode</code>. Used as the upsert key; empty/whitespace returns <code>\"Code is required\"</code>.</td>\n</tr>\n<tr>\n<td><em>active</em></td>\n<td>Bool. Sets <code>DirectFromBureauConfig.Active</code>.</td>\n</tr>\n<tr>\n<td><em>vendorType</em></td>\n<td>Required int. Cast to <code>Omega.CreditInquiry.Types.Enums.DirectFromBureauVendorType</code> (1 = Equifax, 2 = Experian).</td>\n</tr>\n<tr>\n<td><em>reportExpirationDays</em></td>\n<td>Int. Days a pulled report remains valid.</td>\n</tr>\n<tr>\n<td><em>duplicateCheckDays</em></td>\n<td>Int. Duplicate-pull prevention window.</td>\n</tr>\n<tr>\n<td><em>bureauUsername</em></td>\n<td>String. Credential.</td>\n</tr>\n<tr>\n<td><em>bureauPassword</em></td>\n<td>String. Credential.</td>\n</tr>\n<tr>\n<td><em>clientReference</em></td>\n<td>String. Bureau-specific client reference.</td>\n</tr>\n<tr>\n<td><em>clientId</em></td>\n<td>String. OAuth client id.</td>\n</tr>\n<tr>\n<td><em>clientSecretKey</em></td>\n<td>String. OAuth client secret.</td>\n</tr>\n<tr>\n<td><em>oAuthEndpoint</em></td>\n<td>String. OAuth token endpoint.</td>\n</tr>\n<tr>\n<td><em>products</em></td>\n<td>Required array. <strong>At least one element must have <code>isDefault=true</code></strong> or the save fails with <code>\"A default product must be added\"</code>. Per-item fields: <code>productConfigId</code> (Guid, 00...0 if new), <code>isDefault</code> (bool), <code>productConfigCode</code> (string), <code>active</code> (bool). Each item becomes a <code>DirectFromBureauProductObject</code> in the product list.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"validation\">Validation</h4>\n<ul>\n<li><code>param.code</code> is required and must be non-whitespace.</li>\n<li><code>param.products</code> must be non-null and must contain at least one item with <code>isDefault=true</code>; otherwise the save is rejected before any DB write.</li>\n</ul>\n<h4 id=\"response\">Response</h4>\n<p><code>GenericUpdateResultObject</code>:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td>Int. <code>OmegaStatusCode.Ok</code> (0) on success, <code>OmegaStatusCode.Error</code> otherwise.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>String. <code>\"Ok\"</code> on success.</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>String. The upserted configuration <code>Id</code> as a string.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of strings. Populated on validation or persistence failure.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","DirectFromBureau","Configuration"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"85095642-429e-4b98-9242-d3f334b1b725","name":"AddSaveDirectFromBureauConfiguration - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"EQ-MAIN\",\n    \"active\": true,\n    \"vendorType\": 1,\n    \"reportExpirationDays\": 30,\n    \"duplicateCheckDays\": 14,\n    \"bureauUsername\": \"EQX_USER\",\n    \"bureauPassword\": \"REPLACE_WITH_SECRET\",\n    \"clientReference\": \"CLIENT_REF_001\",\n    \"clientId\": \"equifax-client-id\",\n    \"clientSecretKey\": \"REPLACE_WITH_SECRET\",\n    \"oAuthEndpoint\": \"https://api.equifax.com/v2/oauth/token\",\n    \"products\": [\n        {\n            \"productConfigId\": \"a4e1b2c3-d5f6-47a8-9012-3456789abcde\",\n            \"isDefault\": true,\n            \"productConfigCode\": \"FICO_SCORE_9\",\n            \"active\": true\n        },\n        {\n            \"productConfigId\": \"b5f1c2d3-e6a7-48b9-9012-3456789abcde\",\n            \"isDefault\": false,\n            \"productConfigCode\": \"CREDIT_REPORT_FULL\",\n            \"active\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": \"7f1b9c3a-6e2d-4b85-9c41-2a1f8c3e54a0\",\n    \"errors\": []\n}"},{"id":"ebd4926c-ea12-4b25-9c46-58bd0c4905b6","name":"AddSaveDirectFromBureauConfiguration - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"code\": \"EQ-MAIN\",\n    \"active\": true,\n    \"vendorType\": 1,\n    \"reportExpirationDays\": 30,\n    \"duplicateCheckDays\": 14,\n    \"bureauUsername\": \"EQX_USER\",\n    \"bureauPassword\": \"REPLACE_WITH_SECRET\",\n    \"clientReference\": \"CLIENT_REF_001\",\n    \"clientId\": \"equifax-client-id\",\n    \"clientSecretKey\": \"REPLACE_WITH_SECRET\",\n    \"oAuthEndpoint\": \"https://api.equifax.com/v2/oauth/token\",\n    \"products\": [\n        {\n            \"productConfigId\": \"a4e1b2c3-d5f6-47a8-9012-3456789abcde\",\n            \"isDefault\": false,\n            \"productConfigCode\": \"FICO_SCORE_9\",\n            \"active\": true\n        }\n    ]\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/DirectFromBureau/Configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"A default product must be added\"\n    ]\n}"}],"_postman_id":"33045209-2357-4247-a3e1-f4fc11600085"},{"name":"SelectBranch","id":"33ddc7bd-1c79-4b1e-825a-0b21df278951","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch/Select","description":"<h3 id=\"select-branch\">Select Branch</h3>\n<p>Switches the active branch context for the current request by calling <code>BranchWSServices.SwitchClientBranchWS</code>. The endpoint mirrors <code>BranchServices.SwitchClientBranch</code> permission gating inline: Megasys staff and system users bypass the check; all other users must pass <code>PermissionServices.CheckUserPermission</code> against the resolved branch id.</p>\n<p><strong>Statelessness warning:</strong> API callers do not have a persisted <code>OmegaClientSession</code>. This endpoint only updates <code>LoginInfo.CurrentBranchId</code> for the current request. Subsequent API requests revert to the user's primary branch unless they also call <code>Select Branch</code> or unless the branch id is implicit in the route. Stateless callers that need to operate against a non-primary branch must invoke this endpoint each time the context must change.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/Branch/Select</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>branchNumberOrId</em></td>\n<td>Required. Either <code>Setup.Branch.BranchNumber</code> (int) or <code>Setup.Branch.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ \"Id\": \"&lt;branch Guid&gt;\", \"BranchNumber\": &lt;int&gt;, \"BranchName\": \"&lt;string&gt;\" }</code>.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","Branch","Select"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"59ec9910-526d-485b-8aa7-ff1d60c3dd8a","name":"SelectBranch - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": 2\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch/Select"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"a1b2c3d4-2222-4222-9333-abcdef012345\",\n        \"BranchNumber\": 2,\n        \"BranchName\": \"Downtown\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"1620b229-56ec-43c9-b9d0-c5781ddec046","name":"SelectBranch - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"token\": \"{{token}}\",\n    \"branchNumberOrId\": 9999\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/Branch/Select"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error switching branch: Invalid branch number or id\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"33ddc7bd-1c79-4b1e-825a-0b21df278951"},{"name":"UserAdd","id":"176a043c-5385-4eb7-83be-c2fabbb59182","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"activeStatus\": 1,\n  \"userLogin\": \"newcollector\",\n  \"password\": \"TempPassword!1\",\n  \"firstName\": \"New\",\n  \"middleName\": \"\",\n  \"lastName\": \"Collector\",\n  \"email\": \"new@example.com\",\n  \"mobileTestPhoneNumber\": \"\",\n  \"notes\": \"\",\n  \"isLockedOut\": false,\n  \"language\": 1,\n  \"primaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"supervisorId\": null,\n  \"roles\": [\n    \"b1c2d3e4-2222-4222-9333-abcdef012345\"\n  ],\n  \"limitLogin\": false,\n  \"limitLoginDays\": null,\n  \"limitLoginAfterTime\": null,\n  \"limitLoginBeforeTime\": null,\n  \"passwordExpirationLength\": 90,\n  \"showFullNoteGrid\": true,\n  \"accountEntryRoleId\": null,\n  \"paymentusAgentSSOLoginId\": \"\",\n  \"paymentusAgentSSOLoginGroup\": \"\",\n  \"rdnCollector\": false,\n  \"notesViewDefault\": 0,\n  \"apiAccessRoleId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"supervisorLoginOrId\": null,\n  \"roleNamesOrIds\": null,\n  \"accountEntryRoleNameOrId\": null,\n  \"apiAccessRoleNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/User","description":"<h3 id=\"add-user\">Add User</h3>\n<p>Creates a new <code>Setup.User</code> via <code>UserWSServices.AddUserWS</code>. The controller forces <code>forcePasswordChangeUponLogin = false</code> when mapping <code>AddUserParameter</code> to the WS parameter model (use <code>UpdateUser</code> if you need to require a password change). Returns the new user id.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/User</code></p>\n<h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>token</em></td>\n<td>Required string. Authentication token.</td>\n</tr>\n<tr>\n<td><em>activeStatus</em></td>\n<td>Required integer. <code>1</code> Active, <code>0</code> Inactive.</td>\n</tr>\n<tr>\n<td><em>userLogin</em></td>\n<td>Required string. Unique user login.</td>\n</tr>\n<tr>\n<td><em>password</em></td>\n<td>Required string. Initial password.</td>\n</tr>\n<tr>\n<td><em>firstName</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>middleName</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>lastName</em></td>\n<td>Required string.</td>\n</tr>\n<tr>\n<td><em>email</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>mobileTestPhoneNumber</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>notes</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>isLockedOut</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>language</em></td>\n<td>Required integer. Language enum.</td>\n</tr>\n<tr>\n<td><em>primaryBranchId</em></td>\n<td>Required Guid. <code>Setup.Branch.Id</code>.</td>\n</tr>\n<tr>\n<td><em>supervisorId</em></td>\n<td>Optional Guid. <code>Setup.User.Id</code> of the supervisor.</td>\n</tr>\n<tr>\n<td><em>roles</em></td>\n<td>Required <code>List&lt;Guid&gt;</code>. <code>Setup.Role.Id</code> values assigned to this user.</td>\n</tr>\n<tr>\n<td><em>limitLogin</em></td>\n<td>Required bool. Whether to restrict login by day/time.</td>\n</tr>\n<tr>\n<td><em>limitLoginDays</em></td>\n<td>Optional integer. Allowed-days bitmask.</td>\n</tr>\n<tr>\n<td><em>limitLoginAfterTime</em></td>\n<td>Optional TimeSpan. Login allowed only after this time.</td>\n</tr>\n<tr>\n<td><em>limitLoginBeforeTime</em></td>\n<td>Optional TimeSpan. Login allowed only before this time.</td>\n</tr>\n<tr>\n<td><em>passwordExpirationLength</em></td>\n<td>Optional integer. Days until password expires.</td>\n</tr>\n<tr>\n<td><em>showFullNoteGrid</em></td>\n<td>Required bool. UI preference.</td>\n</tr>\n<tr>\n<td><em>accountEntryRoleId</em></td>\n<td>Optional Guid. <code>Setup.Role.Id</code> of an AccountEntry-type role.</td>\n</tr>\n<tr>\n<td><em>paymentusAgentSSOLoginId</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>paymentusAgentSSOLoginGroup</em></td>\n<td>Optional string.</td>\n</tr>\n<tr>\n<td><em>rdnCollector</em></td>\n<td>Required bool.</td>\n</tr>\n<tr>\n<td><em>notesViewDefault</em></td>\n<td>Required integer.</td>\n</tr>\n<tr>\n<td><em>apiAccessRoleId</em></td>\n<td>Optional Guid. <code>Setup.Role.Id</code> for API access (role type 3).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ \"Id\": \"&lt;new user Guid&gt;\" }</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>primaryBranchNumberOrId</code></td>\n<td><code>primaryBranchId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>supervisorLoginOrId</code></td>\n<td><code>supervisorId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>roleNamesOrIds</code></td>\n<td><code>roles</code></td>\n<td>Array of strings. Each entry: general-role name or general-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>accountEntryRoleNameOrId</code></td>\n<td><code>accountEntryRoleId</code></td>\n<td>String. account-entry-role name or account-entry-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>apiAccessRoleNameOrId</code></td>\n<td><code>apiAccessRoleId</code></td>\n<td>String. API-access-role name or API-access-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"primaryBranchNumberOrId\": \"90\",\n  \"supervisorLoginOrId\": \"collector.login\",\n  \"roleNamesOrIds\": [\n    \"Collections\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ],\n  \"accountEntryRoleNameOrId\": \"Standard Entry\",\n  \"apiAccessRoleNameOrId\": \"Servicing API\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","User"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6969cd15-c30d-4cff-9ac3-03a0fa667326","name":"AddUser - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"activeStatus\": 1,\n  \"userLogin\": \"newcollector\",\n  \"password\": \"TempPassword!1\",\n  \"firstName\": \"New\",\n  \"middleName\": \"\",\n  \"lastName\": \"Collector\",\n  \"email\": \"new@example.com\",\n  \"mobileTestPhoneNumber\": \"\",\n  \"notes\": \"\",\n  \"isLockedOut\": false,\n  \"language\": 1,\n  \"primaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"supervisorId\": null,\n  \"roles\": [\n    \"b1c2d3e4-2222-4222-9333-abcdef012345\"\n  ],\n  \"limitLogin\": false,\n  \"limitLoginDays\": null,\n  \"limitLoginAfterTime\": null,\n  \"limitLoginBeforeTime\": null,\n  \"passwordExpirationLength\": 90,\n  \"showFullNoteGrid\": true,\n  \"accountEntryRoleId\": null,\n  \"paymentusAgentSSOLoginId\": \"\",\n  \"paymentusAgentSSOLoginGroup\": \"\",\n  \"rdnCollector\": false,\n  \"notesViewDefault\": 0,\n  \"apiAccessRoleId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"supervisorLoginOrId\": null,\n  \"roleNamesOrIds\": null,\n  \"accountEntryRoleNameOrId\": null,\n  \"apiAccessRoleNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/User"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-9999-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"4fcd166c-f72a-49e9-afb9-e64e819765f1","name":"AddUser - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"activeStatus\": 1,\n  \"userLogin\": \"newcollector\",\n  \"password\": \"TempPassword!1\",\n  \"firstName\": \"New\",\n  \"middleName\": \"\",\n  \"lastName\": \"Collector\",\n  \"email\": \"new@example.com\",\n  \"mobileTestPhoneNumber\": \"\",\n  \"notes\": \"\",\n  \"isLockedOut\": false,\n  \"language\": 1,\n  \"primaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"supervisorId\": null,\n  \"roles\": [\n    \"b1c2d3e4-2222-4222-9333-abcdef012345\"\n  ],\n  \"limitLogin\": false,\n  \"limitLoginDays\": null,\n  \"limitLoginAfterTime\": null,\n  \"limitLoginBeforeTime\": null,\n  \"passwordExpirationLength\": 90,\n  \"showFullNoteGrid\": true,\n  \"accountEntryRoleId\": null,\n  \"paymentusAgentSSOLoginId\": \"\",\n  \"paymentusAgentSSOLoginGroup\": \"\",\n  \"rdnCollector\": false,\n  \"notesViewDefault\": 0,\n  \"apiAccessRoleId\": null,\n  \"primaryBranchNumberOrId\": null,\n  \"supervisorLoginOrId\": null,\n  \"roleNamesOrIds\": null,\n  \"accountEntryRoleNameOrId\": null,\n  \"apiAccessRoleNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/User"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error adding user: The user login 'newcollector' already exists\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"176a043c-5385-4eb7-83be-c2fabbb59182"},{"name":"UserGet","id":"58372a34-de58-4a98-b622-8c3aef670175","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}","description":"<h3 id=\"get-user\">Get User</h3>\n<p>Returns a single <code>Setup.User</code> record resolved by either <code>UserLogin</code> (string) or <code>Id</code> (Guid). <code>SharedWSServices.GetSetupUserId</code> accepts both forms. Returns <code>BadRequest</code> when the user cannot be resolved.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/User/{loginOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>loginOrId</em></td>\n<td>Required. Either <code>Setup.User.UserLogin</code> (string) or <code>Setup.User.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","User","{{user_login_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0beada22-616a-4b9f-a04c-ee0579c842b1","name":"GetUser - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": {\n        \"Id\": \"c1d2e3f4-2222-4222-9333-abcdef012345\",\n        \"UserLogin\": \"collector1\",\n        \"FirstName\": \"Chris\",\n        \"MiddleName\": \"\",\n        \"LastName\": \"Collector\",\n        \"Email\": \"chris@example.com\",\n        \"MobileTestPhoneNumber\": \"\",\n        \"Notes\": \"\",\n        \"ActiveStatus\": 1,\n        \"IsLockedOut\": false,\n        \"Language\": 1,\n        \"PrimaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n        \"SupervisorId\": null,\n        \"LimitLogin\": false,\n        \"LimitLoginDays\": null,\n        \"LimitLoginAfterTime\": null,\n        \"LimitLoginBeforeTime\": null,\n        \"PasswordExpirationLength\": null,\n        \"ShowFullNoteGrid\": true,\n        \"AccountEntryRoleId\": null,\n        \"PaymentusAgentSSOLoginId\": \"\",\n        \"PaymentusAgentSSOLoginGroup\": \"\",\n        \"RDNCollector\": false,\n        \"NotesViewDefault\": 0,\n        \"APIAccessRoleId\": null\n    }\n}"},{"id":"be2d9f2f-7acb-4cc2-90e2-c42dc9899dae","name":"GetUser - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error fetching user: Invalid user login or id\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"58372a34-de58-4a98-b622-8c3aef670175"},{"name":"UserRolesGet","id":"ea450568-81e2-40b6-a7f3-58f33ac17fc5","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}/Roles","description":"<h3 id=\"get-user-roles\">Get User Roles</h3>\n<p>Returns the set of <code>Setup.Role</code> ids assigned to a user, resolved via <code>UserWSServices.ReturnUserRolesWS</code>. The <code>loginOrId</code> path segment supports either <code>UserLogin</code> or <code>Id</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/User/{loginOrId}/Roles</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>loginOrId</em></td>\n<td>Required. Either <code>Setup.User.UserLogin</code> (string) or <code>Setup.User.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","User","{{user_login_or_id}}","Roles"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"89323cb7-f33a-47d9-9f46-b7005ad86153","name":"GetUserRoles - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}/Roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"RoleId\": \"b1c2d3e4-2222-4222-9333-abcdef012345\",\n            \"RoleName\": \"Collector\",\n            \"Active\": true\n        }\n    ]\n}"},{"id":"19433e0b-be99-4d93-8ccb-bbe056381020","name":"GetUserRoles - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}/Roles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error fetching user roles: Invalid user login or id\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"ea450568-81e2-40b6-a7f3-58f33ac17fc5"},{"name":"UsersGet","id":"0a338d17-6ec5-4e91-85f7-53c2244eaee4","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/GetUsers","description":"<h3 id=\"get-users\">Get Users</h3>\n<p>Returns the list of <code>Setup.User</code> rows for the current client via <code>SetupController.GetUsers</code>. Data is loaded with <code>Omega.Setup.BLL.UserServices.ReturnRegularUsers</code> using the field list <code>Id</code>, <code>UserLogin</code>, <code>FirstName</code>, <code>LastName</code>, <code>MegasysDepartment</code>, <code>ActiveStatus</code>. When <code>currentUserOnly=true</code>, the list is reduced to the authenticated caller (via <code>UserServices.ReturnUserById</code>). Each item is projected into a JSON object that adds an <code>IsCurrentUser</code> flag comparing the row id to <code>loginInfo.UserId</code>.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/GetUsers</code></p>\n<h4 id=\"query-parameters\">Query Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>activeOnly</em></td>\n<td>Optional bool. Default <code>false</code>. When <code>true</code>, only users with <code>ActiveStatus=true</code> are returned. Ignored when <code>currentUserOnly=true</code>.</td>\n</tr>\n<tr>\n<td><em>currentUserOnly</em></td>\n<td>Optional bool. Default <code>false</code>. When <code>true</code>, returns only the authenticated user (a single-row array or empty array if the user is not found).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p>Wrapped in the standard API response object:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>statusCode</em></td>\n<td><code>OmegaStatusCode.Ok</code> (0) on success.</td>\n</tr>\n<tr>\n<td><em>result</em></td>\n<td>Friendly status name (<code>\"Ok\"</code> / <code>\"Error\"</code>).</td>\n</tr>\n<tr>\n<td><em>data</em></td>\n<td>JSON array. Per-item fields: <code>Id</code> (Guid), <code>UserLogin</code> (string), <code>FirstName</code> (string), <code>LastName</code> (string), <code>ActiveStatus</code> (bool), <code>IsCurrentUser</code> (bool, true when the row id matches <code>loginInfo.UserId</code>).</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Array of strings. Populated only when the controller catches an exception.</td>\n</tr>\n<tr>\n<td><em>warnings</em></td>\n<td>Array of warning messages; empty when no warnings are returned.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","GetUsers"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"79809d5a-a659-40aa-b821-0630c792d424","name":"GetUsers - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Setup/GetUsers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Ok\",\n    \"data\": [\n        {\n            \"Id\": \"a1f2b3c4-d5e6-47f8-9012-3456789abcde\",\n            \"UserLogin\": \"developer\",\n            \"FirstName\": \"Dev\",\n            \"LastName\": \"User\",\n            \"ActiveStatus\": true,\n            \"IsCurrentUser\": true\n        },\n        {\n            \"Id\": \"b2e3c4d5-e6f7-48a9-b012-3456789abcde\",\n            \"UserLogin\": \"jsmith\",\n            \"FirstName\": \"Jane\",\n            \"LastName\": \"Smith\",\n            \"ActiveStatus\": true,\n            \"IsCurrentUser\": false\n        }\n    ],\n    \"errors\": []\n}"},{"id":"e5b49162-9bdc-4b85-8ff2-c595ac0ed5ac","name":"GetUsers - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"url":"https://{{base_url}}/api/Client/Setup/GetUsers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"status\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"GetUsers: Object reference not set to an instance of an object.\"\n    ]\n}"}],"_postman_id":"0a338d17-6ec5-4e91-85f7-53c2244eaee4"},{"name":"UsersGetAll","id":"822c88f1-7664-4cab-8002-ef7ce9ce0643","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User","description":"<h3 id=\"get-all-users\">Get All Users</h3>\n<p>Returns every <code>Setup.User</code> row for the current client via <code>UserWSServices.ReturnAllUsersWS</code>. Used by the user admin grid and by integrations that need the user catalog. Returned records include the user id, login, name, email, active status, primary branch, lockout flag, and API access role id.</p>\n<p><strong>HTTP Method:</strong> GET</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/User</code></p>\n<h4 id=\"headers\">Headers</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Authorization</em></td>\n<td>Required. Session ID, token, or API key header accepted by <code>AuthenticateBySessionIdOrTokenOrApiKey</code>.</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["api","Client","Setup","User"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"d4ff657e-fe30-4084-833a-8dd9584d813f","name":"GetAllUsers - Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/User"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Ok\",\n    \"result\": \"Success\",\n    \"errors\": [],\n    \"warnings\": [],\n    \"data\": [\n        {\n            \"Id\": \"c1d2e3f4-1111-4222-9333-abcdef012345\",\n            \"UserLogin\": \"developer\",\n            \"FirstName\": \"Dev\",\n            \"MiddleName\": \"\",\n            \"LastName\": \"User\",\n            \"Email\": \"dev@example.com\",\n            \"ActiveStatus\": 1,\n            \"IsLockedOut\": false,\n            \"PrimaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"APIAccessRoleId\": null\n        },\n        {\n            \"Id\": \"c1d2e3f4-2222-4222-9333-abcdef012345\",\n            \"UserLogin\": \"collector1\",\n            \"FirstName\": \"Chris\",\n            \"MiddleName\": \"\",\n            \"LastName\": \"Collector\",\n            \"Email\": \"chris@example.com\",\n            \"ActiveStatus\": 1,\n            \"IsLockedOut\": false,\n            \"PrimaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n            \"APIAccessRoleId\": null\n        }\n    ]\n}"},{"id":"1d039539-5b59-40c2-b4ca-5f4df1507e6b","name":"GetAllUsers - Fail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"invalid-session-token"}],"url":"https://{{base_url}}/api/Client/Setup/User"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": \"Error\",\n    \"result\": \"Error\",\n    \"errors\": [\n        \"Error retrieving users: The session is invalid or has expired.\"\n    ],\n    \"warnings\": [],\n    \"data\": null\n}"}],"_postman_id":"822c88f1-7664-4cab-8002-ef7ce9ce0643"},{"name":"UserUpdate","id":"d6e7c938-3fe0-4569-b4ea-d08ade569457","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"activeStatus\": 1,\n  \"password\": \"\",\n  \"firstName\": \"New\",\n  \"middleName\": \"\",\n  \"lastName\": \"Collector\",\n  \"email\": \"new@example.com\",\n  \"mobileTestPhoneNumber\": \"\",\n  \"notes\": \"Updated notes\",\n  \"isLockedOut\": false,\n  \"language\": 1,\n  \"primaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"supervisorId\": null,\n  \"roles\": [\n    \"b1c2d3e4-2222-4222-9333-abcdef012345\"\n  ],\n  \"limitLogin\": false,\n  \"limitLoginDays\": null,\n  \"limitLoginAfterTime\": null,\n  \"limitLoginBeforeTime\": null,\n  \"passwordExpirationLength\": 90,\n  \"showFullNoteGrid\": true,\n  \"accountEntryRoleId\": null,\n  \"paymentusAgentSSOLoginId\": \"\",\n  \"paymentusAgentSSOLoginGroup\": \"\",\n  \"rdnCollector\": false,\n  \"notesViewDefault\": 0,\n  \"apiAccessRoleId\": null,\n  \"forcePasswordChangeUponLogin\": false,\n  \"primaryBranchNumberOrId\": null,\n  \"supervisorLoginOrId\": null,\n  \"roleNamesOrIds\": null,\n  \"accountEntryRoleNameOrId\": null,\n  \"apiAccessRoleNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}","description":"<h3 id=\"update-user\">Update User</h3>\n<p>Updates an existing <code>Setup.User</code> resolved by <code>{loginOrId}</code>. The controller resolves the user id via <code>SharedWSServices.GetSetupUserId</code>, sets <code>userLogin = null</code> on the WS parameter (login is identified by the route, not the body), and calls <code>UserWSServices.UpdateUserWS</code>. Unlike <code>AddUser</code>, this endpoint respects the supplied <code>forcePasswordChangeUponLogin</code> value.</p>\n<p><strong>HTTP Method:</strong> PUT</p>\n<p><strong>Endpoint:</strong> <code>https://{{base_url}}/api/Client/Setup/User/{loginOrId}</code></p>\n<h4 id=\"path-parameters\">Path Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>loginOrId</em></td>\n<td>Required. Either <code>Setup.User.UserLogin</code> (string) or <code>Setup.User.Id</code> (Guid).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-body-parameters\">Request Body Parameters</h4>\n<p>Same shape as <code>Add User</code> (see <code>AddUser.request.yaml</code>), with these differences:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>userLogin</em></td>\n<td>Ignored by the controller (user is resolved from the route path).</td>\n</tr>\n<tr>\n<td><em>password</em></td>\n<td>Optional. Only set a value when changing the user's password.</td>\n</tr>\n<tr>\n<td><em>forcePasswordChangeUponLogin</em></td>\n<td>Optional bool. When <code>true</code>, the user must set a new password at next login.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response\">Response</h4>\n<p><code>data</code> is <code>{ \"Id\": \"&lt;user Guid&gt;\" }</code>.</p>\n<h4 id=\"numbercode-or-guid-lookups\">Number/code-or-GUID lookups</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>JSON field</th>\n<th>Existing field</th>\n<th>Accepted value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>primaryBranchNumberOrId</code></td>\n<td><code>primaryBranchId</code></td>\n<td>String. branch number or branch GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>supervisorLoginOrId</code></td>\n<td><code>supervisorId</code></td>\n<td>String. user login or user GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>roleNamesOrIds</code></td>\n<td><code>roles</code></td>\n<td>Array of strings. Each entry: general-role name or general-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>accountEntryRoleNameOrId</code></td>\n<td><code>accountEntryRoleId</code></td>\n<td>String. account-entry-role name or account-entry-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n<tr>\n<td><code>apiAccessRoleNameOrId</code></td>\n<td><code>apiAccessRoleId</code></td>\n<td>String. API-access-role name or API-access-role GUID. Optional alternative to the existing GUID field.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Unknown records, ambiguous keys, mismatched record types and invalid ownership are rejected. Use an exact GUID to resolve an ambiguous key. Codes, descriptions, names and filenames are matched as stored; preserve leading zeros in text codes. Client-owned records must belong to the authenticated client.</p>\n<p>For new optional aliases, null/omitted uses the existing field and a blank string is invalid. Both scalar forms may be supplied only when they identify the same record. Choose one form for each list; mixing numbers and GUID strings within the new list is allowed. Other required fields, permissions, and operation-specific validation still apply.</p>\n<p>Example selector fields (illustrative values; replace with records from your system and keep the operation's other required fields). Omit the corresponding old fields when using this example:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"primaryBranchNumberOrId\": \"90\",\n  \"supervisorLoginOrId\": \"collector.login\",\n  \"roleNamesOrIds\": [\n    \"Collections\",\n    \"11111111-1111-4111-8111-111111111111\"\n  ],\n  \"accountEntryRoleNameOrId\": \"Standard Entry\",\n  \"apiAccessRoleNameOrId\": \"Servicing API\"\n}\n</code></pre>\n<p>Optional new related aliases are null in the request template. Keep the original fields when using their existing values, or populate the new alternatives and remove conflicting old fields. Normal save/clear behavior and all other required inputs still apply.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","User","{{user_login_or_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6ce926fc-f1e2-4bbb-a201-e9a6788b3cd9","name":"UpdateUser - Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"activeStatus\": 1,\n  \"password\": \"\",\n  \"firstName\": \"New\",\n  \"middleName\": \"\",\n  \"lastName\": \"Collector\",\n  \"email\": \"new@example.com\",\n  \"mobileTestPhoneNumber\": \"\",\n  \"notes\": \"Updated notes\",\n  \"isLockedOut\": false,\n  \"language\": 1,\n  \"primaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"supervisorId\": null,\n  \"roles\": [\n    \"b1c2d3e4-2222-4222-9333-abcdef012345\"\n  ],\n  \"limitLogin\": false,\n  \"limitLoginDays\": null,\n  \"limitLoginAfterTime\": null,\n  \"limitLoginBeforeTime\": null,\n  \"passwordExpirationLength\": 90,\n  \"showFullNoteGrid\": true,\n  \"accountEntryRoleId\": null,\n  \"paymentusAgentSSOLoginId\": \"\",\n  \"paymentusAgentSSOLoginGroup\": \"\",\n  \"rdnCollector\": false,\n  \"notesViewDefault\": 0,\n  \"apiAccessRoleId\": null,\n  \"forcePasswordChangeUponLogin\": false,\n  \"primaryBranchNumberOrId\": null,\n  \"supervisorLoginOrId\": null,\n  \"roleNamesOrIds\": null,\n  \"accountEntryRoleNameOrId\": null,\n  \"apiAccessRoleNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 0,\n    \"result\": \"Ok\",\n    \"data\": {\n        \"Id\": \"c1d2e3f4-9999-4222-9333-abcdef012345\"\n    },\n    \"errors\": [],\n    \"warnings\": []\n}"},{"id":"65b7a9a3-0599-429c-86b8-ddc34150f85f","name":"UpdateUser - Fail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": \"{{token}}\",\n  \"activeStatus\": 1,\n  \"password\": \"\",\n  \"firstName\": \"New\",\n  \"middleName\": \"\",\n  \"lastName\": \"Collector\",\n  \"email\": \"new@example.com\",\n  \"mobileTestPhoneNumber\": \"\",\n  \"notes\": \"Updated notes\",\n  \"isLockedOut\": false,\n  \"language\": 1,\n  \"primaryBranchId\": \"a1b2c3d4-1111-4222-9333-abcdef012345\",\n  \"supervisorId\": null,\n  \"roles\": [\n    \"b1c2d3e4-2222-4222-9333-abcdef012345\"\n  ],\n  \"limitLogin\": false,\n  \"limitLoginDays\": null,\n  \"limitLoginAfterTime\": null,\n  \"limitLoginBeforeTime\": null,\n  \"passwordExpirationLength\": 90,\n  \"showFullNoteGrid\": true,\n  \"accountEntryRoleId\": null,\n  \"paymentusAgentSSOLoginId\": \"\",\n  \"paymentusAgentSSOLoginGroup\": \"\",\n  \"rdnCollector\": false,\n  \"notesViewDefault\": 0,\n  \"apiAccessRoleId\": null,\n  \"forcePasswordChangeUponLogin\": false,\n  \"primaryBranchNumberOrId\": null,\n  \"supervisorLoginOrId\": null,\n  \"roleNamesOrIds\": null,\n  \"accountEntryRoleNameOrId\": null,\n  \"apiAccessRoleNameOrId\": null\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/User/{{user_login_or_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"statusCode\": 50,\n    \"result\": \"Error\",\n    \"data\": null,\n    \"errors\": [\n        \"Error updating user: Invalid user login or id\"\n    ],\n    \"warnings\": []\n}"}],"_postman_id":"d6e7c938-3fe0-4569-b4ea-d08ade569457"},{"name":"ReportSettingsReports","id":"a7df196a-ec95-4e4f-a64b-04f6c0b3a377","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/Reports?token={{token}}","description":"<p>Returns the installed, supported report types that this client user can author settings for. Each item includes reportId, name, supportsWrite, XML root/namespace, definitionVersion, definitionUrl and a JSON templateUrl. URLs are relative API paths; use your API host and authentication.</p>\n<p>The linked success example shows an illustrative two-entry catalog (New Account and General Ledger Account List), not an exhaustive or captured live response. Use IDs and current versions returned by your own server.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Workflow: choose reportId here, read its Definition, then obtain a JSON Template for a new setting or use List and JSON GET for an existing one. Edit the complete response.data object, optionally Validate it, then POST to copy/create or PUT to replace. A report has its own parameter contract; do not reuse another report's fields. \"Company\" means the report's branch/company filter, not OmegaClientId (the authenticated tenant).</p>\n<p>The catalog is filtered by installation, report access, licensing and module/vendor configuration. It is not a list of every screen visible to other users. An empty array is valid. There is no includeUnsupported option or explanation for individual missing reports. Catalog presence does not supply all dynamic lookup values or guarantee a default template will validate.</p>\n<p>Initial-release exceptions: Spireon GPS Serial Number Import (1ee33aa0-03ce-4c8a-9e27-653798e0d563) is not available for API authoring; use its front-end upload workflow. Purge Closed Accounts (ec305ccd-3b4c-472c-894c-3be158949856) and Repurchase Batch Purge (6f2b90d4-5c1e-4a7b-9f38-2e4d71c0a8b3) support report-only settings: keep ReportOnlyMode=true. Destructive settings remain behind front-end confirmation. CommonQuery Dealer filters support Include only; retain their fixed true flags.</p>\n<p>All ReportSetting endpoints manage settings only. They do not execute a report, purge, mass update, upload, message or job stream. Job-stream settings are a separate operation; a later job run can use an updated saved report setting.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","Reports"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"c44bc924-3d76-4ebb-9b34-d2cd947ff703","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Reports?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Reports"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": [\n    {\n      \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n      \"name\": \"New Account Report\",\n      \"supportsWrite\": true,\n      \"xmlRoot\": \"NewAccountReport\",\n      \"xmlNamespace\": \"http://omega.megasys-inc.com/Schemas/Servicing/Reports\",\n      \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\",\n      \"definitionUrl\": \"api/Client/Setup/ReportSetting/Definition/8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n      \"templateUrl\": \"api/Client/Setup/ReportSetting/Template/8bc6d748-6a81-474a-8d17-1320a10ac5f3?representation=json\"\n    },\n    {\n      \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n      \"name\": \"Account List\",\n      \"supportsWrite\": true,\n      \"xmlRoot\": \"AccountList\",\n      \"xmlNamespace\": \"http://omega.megasys-inc.com/Schemas/GeneralLedger/Reports\",\n      \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\",\n      \"definitionUrl\": \"api/Client/Setup/ReportSetting/Definition/5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n      \"templateUrl\": \"api/Client/Setup/ReportSetting/Template/5d8123f6-fd85-4e70-85bf-ead9f875e33a?representation=json\"\n    }\n  ],\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"f8f381f9-ef6e-485c-aeeb-d784e4f02994","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Reports?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Reports"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"A client user identity is required.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"a7df196a-ec95-4e4f-a64b-04f6c0b3a377"},{"name":"ReportSettingsDefinition","id":"5cddf1ec-2f6c-4706-9cb2-862c8119bf12","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/Definition/{{report_id}}?token={{token}}","description":"<p>Returns the selected report's parameter definition: fields, types, nested groups, allowed values/ranges, conditions, variants, bindings, output formats and version. This is documentation for constructing parameters, not a settings body to submit to Save.</p>\n<p>The linked success example is the complete General Ledger Account List definition, not the New Account definition. Sample identities/versions are illustrative, not live values; discover the current report and version from your server.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_id</code></td>\n<td>Required GUID path value. Use reportId returned by ReportSettingsReports.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Definitions are per report ID, not shared across reports. Call JSON Template for a new setting or JSON GET for a saved one, edit response.data using this definition, then Validate and POST/PUT that settings object. Callers do not generate schema files. Optional fields missing from a saved setting can be discovered here.</p>\n<p>A nonempty formats array restricts the allowed output formats. Empty formats means no additional report-specific restriction; Save still accepts only PDF, EXCEL, EXCELOPENXML, WORD, WORDOPENXML, CSV, XML, IMAGE or MHTML. PDF is the model default, not a guarantee that every report accepts it.</p>\n<p>Honor required, when, fixedValue, serverBinding and referenceKind, as well as variantSelector/defaultVariant/variants. A variant has its own complete fields rather than a union of all modes. Native JSON booleans must remain booleans; other template values are represented losslessly as strings, including codes, large account numbers, ranges and date macros. Keep those values as returned unless making an intentional supported change. Definition describes dynamic reference types; it is not a universal lookup-values endpoint.</p>\n<p>Keep fixed tenant/user values from Template or JSON GET. If folder/email metadata changes, update any matching bound parameter leaves too. A template default is not necessarily required, fixed, or sufficient for validation. Fetch a fresh definition/template after a definitionVersion conflict.</p>\n<p>Report-only purge definitions require ReportOnlyMode=true (XML text True); missing or false values are rejected. Spireon upload authoring is unsupported. Existing XML-only settings can remain readable without becoming authorable. Report access, installation, licensing/configuration and installed report-definition compatibility checks still apply. This call neither saves nor executes anything.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","Definition","{{report_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"0ee26c6b-7de2-4633-be72-4cf24cdd8c2b","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Definition/5d8123f6-fd85-4e70-85bf-ead9f875e33a?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Definition","5d8123f6-fd85-4e70-85bf-ead9f875e33a"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n    \"sourcePage\": \"Omega.WebApp/Client/GeneralLedger/Reports/AccountList.aspx.cs\",\n    \"reportClass\": \"Omega.GeneralLedger.BLL.Reports.AccountListServices,Omega.GeneralLedger.BLL\",\n    \"root\": {\n      \"name\": \"AccountList\",\n      \"namespace\": \"http://omega.megasys-inc.com/Schemas/GeneralLedger/Reports\"\n    },\n    \"ordered\": false,\n    \"reviewed\": true,\n    \"fields\": [\n      {\n        \"name\": \"AccountNumbers\",\n        \"namespace\": null,\n        \"label\": \"GL Account\",\n        \"kind\": \"list\",\n        \"valueType\": \"integerFilter\",\n        \"required\": false,\n        \"enumValues\": null,\n        \"serverBinding\": null,\n        \"templateBinding\": null,\n        \"referenceKind\": null,\n        \"defaultValue\": null,\n        \"fixedValue\": null,\n        \"allowedRanges\": [\n          \"Single\",\n          \"SingleList\",\n          \"RangeList\"\n        ],\n        \"allowNull\": null,\n        \"allowEmptyItems\": false,\n        \"itemName\": \"Value\",\n        \"itemNamespace\": \"http://omega.megasys-inc.com/Schemas/Framework/Reports\",\n        \"maxLength\": 1024,\n        \"valueMaxLength\": 6,\n        \"maxItems\": 1000,\n        \"minItems\": 0,\n        \"minimum\": 0,\n        \"maximum\": 999999,\n        \"fields\": [],\n        \"description\": \"GL account numbers, or Omega ranges such as {1000} - {1999}. Empty selects all accounts within this client.\",\n        \"when\": null\n      },\n      {\n        \"name\": \"ShowInactiveAccounts\",\n        \"namespace\": null,\n        \"label\": \"Show Inactive Accounts\",\n        \"kind\": \"scalar\",\n        \"valueType\": \"boolean01\",\n        \"required\": true,\n        \"enumValues\": null,\n        \"serverBinding\": null,\n        \"templateBinding\": null,\n        \"referenceKind\": null,\n        \"defaultValue\": false,\n        \"fixedValue\": null,\n        \"allowedRanges\": null,\n        \"allowNull\": null,\n        \"allowEmptyItems\": false,\n        \"itemName\": \"Value\",\n        \"itemNamespace\": \"http://omega.megasys-inc.com/Schemas/Framework/Reports\",\n        \"maxLength\": 1024,\n        \"valueMaxLength\": null,\n        \"maxItems\": 1000,\n        \"minItems\": 0,\n        \"minimum\": null,\n        \"maximum\": null,\n        \"fields\": [],\n        \"description\": null,\n        \"when\": null\n      },\n      {\n        \"name\": \"OmegaClientId\",\n        \"namespace\": null,\n        \"label\": null,\n        \"kind\": \"scalar\",\n        \"valueType\": \"guid\",\n        \"required\": true,\n        \"enumValues\": null,\n        \"serverBinding\": \"clientId\",\n        \"templateBinding\": null,\n        \"referenceKind\": null,\n        \"defaultValue\": null,\n        \"fixedValue\": null,\n        \"allowedRanges\": null,\n        \"allowNull\": null,\n        \"allowEmptyItems\": false,\n        \"itemName\": \"Value\",\n        \"itemNamespace\": \"http://omega.megasys-inc.com/Schemas/Framework/Reports\",\n        \"maxLength\": 1024,\n        \"valueMaxLength\": null,\n        \"maxItems\": 1000,\n        \"minItems\": 0,\n        \"minimum\": null,\n        \"maximum\": null,\n        \"fields\": [],\n        \"description\": null,\n        \"when\": null\n      }\n    ],\n    \"variantSelector\": null,\n    \"defaultVariant\": null,\n    \"variants\": [],\n    \"rules\": [],\n    \"configurationGates\": [],\n    \"formats\": [],\n    \"sourceEvidence\": [\n      \"AccountListServices.GenerateMergeXml\",\n      \"AccountList.aspx ReportFilter Int_Data MinValue=0 MaxValue=999999\",\n      \"AccountList.LoadSetting\"\n    ],\n    \"saveModes\": [],\n    \"version\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"798301e9-24eb-4280-b0b1-316f6fd0d198","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Definition/5d8123f6-fd85-4e70-85bf-ead9f875e33a?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Definition","5d8123f6-fd85-4e70-85bf-ead9f875e33a"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"You do not have access to this report.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"5cddf1ec-2f6c-4706-9cb2-862c8119bf12"},{"name":"ReportSettingsFolders","id":"0ab34688-962e-460b-9c1c-d1824b972cea","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/Folders?token={{token}}","description":"<p>Returns the DocSafe folders this client user may save report settings into. Use a returned folderId as the setting's folderId on Create/Update. Every folder listed here passes the same folder check Create and Update apply, so a listed folderId is never rejected for folder access.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint permissions still apply.</td>\n</tr>\n<tr>\n<td><code>search</code></td>\n<td>Optional string query value, up to 100 characters. Case-insensitive match against the folder path, for example <code>daily</code> finds <code>System / Daily Reports</code>. Omit it to list every saveable folder.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Each item has folderId, name, path (names from the top-level System folder down, separated by \" / \"), parentId (null for the top-level folder) and active. Results are sorted by path. An empty array is valid.</p>\n<p>Rules: folders belong to the authenticated client; folders with Full Control are listed; folders that use folder roles are listed only when the user's roles on the top-level folder grant both View and Add. The client's system user cannot be given roles, so folder roles do not limit it: every folder of the client except Temporary Output is listed and accepted for it. The hidden Temporary Output folder is never listed or accepted. Reports whose parameters also carry a folder (fields with serverBinding \"folderId\" or referenceKind \"folder\") use the same folder check.</p>\n<p>The imports that save a results file to a folder named by its path (<code>folderPath</code> on POST api/Client/Servicing/DealerTransactions/Import, <code>folder_path</code> on POST api/Client/Account/Bulk/AccountImportFile) use the same folder check and accept a <code>path</code> from this list exactly as it is, also when a folder name contains <code>/</code> or <code>\\</code>. When the list shows the same path for two folders, the imports refuse that path; rename one of the folders in Document Manager.</p>\n<p>Read-only. It does not create, move or change folders or permissions.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","Folders"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"4f58953a-5d97-4e79-ab6a-c92d31dcab3d","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Folders?search=reports&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Folders"],"query":[{"key":"search","value":"reports"},{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": [\n    {\n      \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n      \"name\": \"Daily Reports\",\n      \"path\": \"System / Daily Reports\",\n      \"parentId\": \"33333333-3333-4333-8333-333333333333\",\n      \"active\": true\n    },\n    {\n      \"folderId\": \"55555555-5555-4555-8555-555555555555\",\n      \"name\": \"Month End Reports\",\n      \"path\": \"System / Month End Reports\",\n      \"parentId\": \"33333333-3333-4333-8333-333333333333\",\n      \"active\": true\n    }\n  ],\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"264c6a40-0f66-4cc2-9114-50cc213b2235","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Folders?search=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Folders"],"query":[{"key":"search","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"},{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"search is limited to 100 characters.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"0ab34688-962e-460b-9c1c-d1824b972cea"},{"name":"ReportSettingsTemplate","id":"cf812142-2b6b-41c6-bf5c-2e0215b14611","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/Template/{{report_id}}?token={{token}}&branchNumber={{branch_number}}","description":"<p>Returns an unsaved settings body containing filterXml for the selected report. Prefer ReportSettingsJsonTemplate for structured editing; XML remains available for existing integrations.</p>\n<p>The linked success example shows New Account's unsaved defaults, not a ready-to-save named setting. Its identities are illustrative; use your own server's current Template and permitted references.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_id</code></td>\n<td>Required GUID path value. Choose reportId from Reports and inspect its Definition.</td>\n</tr>\n<tr>\n<td><code>representation</code></td>\n<td>Optional string query value; defaults to xml. Only xml or json is accepted.</td>\n</tr>\n<tr>\n<td><code>branchNumber</code> / <code>branch_number</code></td>\n<td>Integer query value / example variable. Required for New Account's XML template; optional for other reports. A supplied value must be a permitted branch. Remove this query parameter for reports that do not need it.</td>\n</tr>\n<tr>\n<td><code>variant</code></td>\n<td>Optional string query value. Use a name from Definition.variants; omission uses its default variant.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Copy response.data and edit XML with an XML library before JSON-serializing the complete settings body. Preserve the report-specific XML root, namespaces, ordered elements, fixed values and identity bindings. OmegaClientId identifies the authenticated tenant, not the branch/company filter. branchNumber is not a universal branch-array filter.</p>\n<p>Before POST, supply a unique name, real permitted folderId and a format allowed by Definition. Update folder/email-bound XML leaves if the outer metadata changes. PDF is the model default even when disallowed for this report. Templates can require additional lookup/date/configuration inputs and are not guaranteed to validate unchanged.</p>\n<p>Spireon upload authoring is unavailable. The two purge reports require ReportOnlyMode with XML boolean text True (not 1) and reject destructive modes. This call does not save settings or run a report.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","Template","{{report_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"branchNumber","value":"{{branch_number}}"}],"variable":[]}},"response":[{"id":"865a2651-7a72-4a80-839b-71e7a5de540f","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Template/8bc6d748-6a81-474a-8d17-1320a10ac5f3?token={{token}}&branchNumber=1","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Template","8bc6d748-6a81-474a-8d17-1320a10ac5f3"],"query":[{"key":"token","value":"{{token}}"},{"key":"branchNumber","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": null,\n    \"ts\": null,\n    \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n    \"folderId\": \"00000000-0000-0000-0000-000000000000\",\n    \"name\": null,\n    \"description\": \"\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n    \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"cdd5b605-5f31-4708-9713-be2d8aabcebd","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Template/8bc6d748-6a81-474a-8d17-1320a10ac5f3?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Template","8bc6d748-6a81-474a-8d17-1320a10ac5f3"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"branchNumber is required for this report's XML template.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"cf812142-2b6b-41c6-bf5c-2e0215b14611"},{"name":"ReportSettingsJsonTemplate","id":"98fe46e4-c8d4-45cd-b277-3e04f4db06c8","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/Template/{{report_id}}?representation=json&token={{token}}","description":"<p>Returns an unsaved JSON editing skeleton for the selected report. It supplies parameter structure and context-bound values, not guaranteed-valid test data or a saved setting.</p>\n<p>The linked success example uses General Ledger Account List. Sample tenant/folder/setting identities are synthetic; obtain real values from your server's Reports, Template and GET.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_id</code></td>\n<td>Required GUID path value. Choose reportId from Reports and read that report's Definition.</td>\n</tr>\n<tr>\n<td><code>representation</code></td>\n<td>Optional string query value; xml is the API default. This request explicitly selects json. Only xml or json is accepted.</td>\n</tr>\n<tr>\n<td><code>branchNumber</code></td>\n<td>Optional integer query value. If supplied, it must identify a permitted branch. For New Account it seeds that branch; when omitted, New Account uses permitted branch numbers. It does not universally narrow other reports' branch arrays.</td>\n</tr>\n<tr>\n<td><code>variant</code></td>\n<td>Optional string query value. Use a name in Definition.variants; omission uses the report's default variant. Add this query parameter only when needed.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Copy response.data, not the outer envelope or Definition. Choose a unique name, a real permitted folderId and an allowed output format. A nonempty Definition.formats restricts the global formats documented by Save; empty formats means no extra report-specific restriction. PDF is the model default even when a report requires another format. Fill required references/dates and reconcile folder/email-bound parameter leaves with the outer metadata. Keep server-bound tenant/user values and fixed values; no separate system-user creation is required.</p>\n<p>Store the edited object's JSON serialization in report_setting_json (without wrapping it in another quoted string). Optionally call Validate, then ReportSettingJsonCreate. Required references, installed configuration and permissions may still prevent validation; do not blindly save the untouched template. For an existing setting, use JSON GET and preserve its ts before PUT.</p>\n<p>Spireon upload settings are unavailable. The two supported purge reports require ReportOnlyMode=true and reject destructive settings. This request never saves, uploads or runs a report/program.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","Template","{{report_id}}"],"host":["{{base_url}}"],"query":[{"key":"representation","value":"json"},{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"f61daf7a-1c31-42c3-a59a-67333f72f335","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Template/5d8123f6-fd85-4e70-85bf-ead9f875e33a?representation=json&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Template","5d8123f6-fd85-4e70-85bf-ead9f875e33a"],"query":[{"key":"representation","value":"json"},{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": null,\n    \"ts\": null,\n    \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n    \"folderId\": \"00000000-0000-0000-0000-000000000000\",\n    \"name\": null,\n    \"description\": \"\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"parameters\": {\n      \"AccountNumbers\": [],\n      \"ShowInactiveAccounts\": false,\n      \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n    },\n    \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"d3d5ac53-5cc3-45b5-a0ed-0e52373acc10","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Template/5d8123f6-fd85-4e70-85bf-ead9f875e33a?representation=json&variant=Query&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Template","5d8123f6-fd85-4e70-85bf-ead9f875e33a"],"query":[{"key":"representation","value":"json"},{"key":"variant","value":"Query"},{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"This report does not have variants.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"98fe46e4-c8d4-45cd-b277-3e04f4db06c8"},{"name":"ReportSettingsValidate","id":"bbca04a4-67b1-4f45-9485-6ae575478558","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{{report_setting_json}}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/Validate?token={{token}}","description":"<p>Validates report parameters and applicable tenant/reference permissions without saving or executing anything. Success returns valid, reportId, definitionVersion and a scope explanation; it is not the saved/editable settings object.</p>\n<p>The linked success example uses General Ledger Account List with synthetic identities, not a captured HTTP request. Build your validation body from your own server's Template or GET.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_setting_json</code></td>\n<td>Required string Postman variable containing the full edited response.data JSON object from Template or GET, serialized without surrounding quotes.</td>\n</tr>\n<tr>\n<td><code>reportId</code></td>\n<td>Required GUID body value. Use the supported report selected from Reports.</td>\n</tr>\n<tr>\n<td><code>parameters</code></td>\n<td>Required JSON object unless filterXml is supplied instead. Follow the report's Definition, including required/conditional fields, fixed values and context bindings.</td>\n</tr>\n<tr>\n<td><code>filterXml</code></td>\n<td>Alternative XML string instead of parameters. Must match that report's XML contract; generic limit 4,194,304 characters and New Account limit 262,144. Do not supply both representations.</td>\n</tr>\n<tr>\n<td><code>definitionVersion</code></td>\n<td>Optional string body value; retain Template/GET's version. A supplied stale version returns 409.</td>\n</tr>\n<tr>\n<td><code>folderId</code></td>\n<td>GUID body value; required when the report's parameters bind or refer to a folder. Keep it consistent with bound parameter leaves. Save always requires a permitted folder.</td>\n</tr>\n<tr>\n<td><code>email</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Used for any email-bound parameter leaves. This check does not replace Save's full delivery validation.</td>\n</tr>\n<tr>\n<td><code>id</code>, <code>ts</code></td>\n<td>Optional GUID/base64 string body values retained from GET. Validate does not check a target setting's rowversion or authorize a specific PUT.</td>\n</tr>\n<tr>\n<td><code>name</code>, <code>description</code>, <code>format</code>, <code>saveToServerPath</code></td>\n<td>Optional string metadata retained from Template/GET. Save, not this endpoint, enforces their full metadata rules.</td>\n</tr>\n<tr>\n<td><code>isPrivate</code>, <code>userDefault</code>, <code>clientDefault</code></td>\n<td>Optional boolean metadata; omission defaults to false. Save enforces visibility/default-change rules.</td>\n</tr>\n<tr>\n<td><code>fileTransferJobId</code></td>\n<td>Optional GUID/null body metadata retained from GET; Save checks its tenant ownership.</td>\n</tr>\n<tr>\n<td><code>token</code> (body)</td>\n<td>Optional string when the query token is supplied. Use a consistent client-user identity.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Use Reports -&gt; Definition -&gt; JSON Template, or List -&gt; JSON GET; edit the complete response.data and submit it here. Keep that original editing object for POST/PUT. Do not submit this endpoint's response to Save.</p>\n<p>Validation can reject missing tenant lookup/configuration prerequisites even when discovery/template succeeded. It does not guarantee name uniqueness, all metadata/folder access, delivery values, client-default permission or PUT rowversion acceptance. Folder/reference permissions are checked where the chosen parameters require them.</p>\n<p>Spireon upload authoring is unsupported. Purge reports must retain ReportOnlyMode=true (XML text True); destructive modes are rejected. No settings, reports, purges, account transactions, messages, uploads or job streams are created/executed by Validate.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","Validate"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"081a4b64-1a98-4115-8a8f-dea08e082347","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": null,\n  \"ts\": null,\n  \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"GL accounts - 1000 to 1999\",\n  \"description\": \"Illustrative private setting\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"parameters\": {\n    \"AccountNumbers\": [\n      \"{1000} - {1999}\"\n    ],\n    \"ShowInactiveAccounts\": false,\n    \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n  },\n  \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Validate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Validate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"valid\": true,\n    \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n    \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\",\n    \"scope\": \"parameters only; save also checks setting metadata, folder access and concurrency\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"9b49a66a-b1db-4146-bddf-2ce541529094","name":"Validation failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": null,\n  \"ts\": null,\n  \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"GL accounts - 1000 to 1999\",\n  \"description\": \"Illustrative private setting\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"parameters\": {\n    \"AccountNumbers\": [\n      \"{1000} - {1999}\"\n    ],\n    \"ShowInactiveAccounts\": false,\n    \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n  },\n  \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\",\n  \"filterXml\": \"<AccountList />\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Validate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Validate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"Supply parameters or filterXml, not both. GET with representation=json for a JSON editing body.\"\n  ],\n  \"warnings\": []\n}"},{"id":"a1e474ea-1f7b-47bf-8e20-3794ade0519a","name":"Stale definition","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": null,\n  \"ts\": null,\n  \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"GL accounts - 1000 to 1999\",\n  \"description\": \"Illustrative private setting\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"parameters\": {\n    \"AccountNumbers\": [\n      \"{1000} - {1999}\"\n    ],\n    \"ShowInactiveAccounts\": false,\n    \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n  },\n  \"definitionVersion\": \"0000000000000000000000000000000000000000000000000000000000000000\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/Validate?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","Validate"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"The report definition changed. GET its definition and template again.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"bbca04a4-67b1-4f45-9485-6ae575478558"},{"name":"ReportSettingsList","id":"b3c82baa-d034-46eb-ab24-dc6a8f2ca6a6","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}&reportId={{report_id}}&page=1&pageSize=50","description":"<p>Lists visible saved settings for one report, returning page, pageSize and settings. Private settings are visible only to their owner; shared settings are restricted to the authenticated tenant.</p>\n<p>The linked success example contains an illustrative New Account row, not captured live data. List leaves definitionVersion null; use GET for the current version and a JSON editing body.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>reportId</code> / <code>report_id</code></td>\n<td>Required GUID query value / example variable. Identify the report; use Reports for supported authoring IDs.</td>\n</tr>\n<tr>\n<td><code>page</code></td>\n<td>Optional integer query value, 1-10000; defaults to 1.</td>\n</tr>\n<tr>\n<td><code>pageSize</code></td>\n<td>Optional integer query value, 1-100; defaults to 50.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Results are ordered by setting ID. Increment page until settings is empty; there is no total-count field. Pick an id and call JSON GET for a supported editing body, or XML GET for its saved XML. The list contains saved values, not all optional fields from the report definition.</p>\n<p>List/XML GET can read other installed reports when permitted; that does not grant authoring support for an unsupported report or mode. These reads do not change settings, owner, defaults, delivery configuration or job streams.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"},{"key":"reportId","value":"{{report_id}}"},{"key":"page","value":"1"},{"key":"pageSize","value":"50"}],"variable":[]}},"response":[{"id":"73cb149c-d20a-4efc-a546-8c89f88f4da5","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}&reportId=8bc6d748-6a81-474a-8d17-1320a10ac5f3&page=1&pageSize=50","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting"],"query":[{"key":"token","value":"{{token}}"},{"key":"reportId","value":"8bc6d748-6a81-474a-8d17-1320a10ac5f3"},{"key":"page","value":"1"},{"key":"pageSize","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"page\": 1,\n    \"pageSize\": 50,\n    \"settings\": [\n      {\n        \"token\": null,\n        \"id\": \"11111111-1111-4111-8111-111111111111\",\n        \"ts\": \"AAAAAAAAAAE=\",\n        \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n        \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n        \"name\": \"New accounts - company 1 - dealer 1001\",\n        \"description\": \"Current business month\",\n        \"format\": \"PDF\",\n        \"isPrivate\": true,\n        \"userDefault\": false,\n        \"clientDefault\": false,\n        \"email\": \"\",\n        \"saveToServerPath\": \"\",\n        \"fileTransferJobId\": null,\n        \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n        \"definitionVersion\": null\n      }\n    ]\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"aafcf377-460c-4817-8b0b-ce3fde571dc0","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}&reportId=8bc6d748-6a81-474a-8d17-1320a10ac5f3&page=0&pageSize=50","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting"],"query":[{"key":"token","value":"{{token}}"},{"key":"reportId","value":"8bc6d748-6a81-474a-8d17-1320a10ac5f3"},{"key":"page","value":"0"},{"key":"pageSize","value":"50"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"page must be 1-10000 and pageSize 1-100.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"b3c82baa-d034-46eb-ab24-dc6a8f2ca6a6"},{"name":"ReportSettingGet","id":"e4562662-3cd9-454e-864c-3e34f1da5c21","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/{{report_setting_id}}?token={{token}}","description":"<p>Returns a visible saved setting's complete metadata, rowversion ts and original filterXml. This is the raw XML read path, including permitted legacy XML-only settings.</p>\n<p>The linked success example is an illustrative New Account setting. Do not copy its synthetic IDs or rowversion into a live update; GET your own visible setting.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_setting_id</code></td>\n<td>Required GUID path value. Use a setting id from ReportSettingsList.</td>\n</tr>\n<tr>\n<td><code>representation</code></td>\n<td>Optional string query value; defaults to xml. Only xml or json is accepted.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Copy response.data, not the outer envelope. Use an XML library to edit supported parameters, then JSON-serialize the whole settings object for POST (copy) or PUT (replace). PUT requires the latest base64 ts from GET. Saved XML does not describe every optional field; consult the selected report's Definition when authoring is supported.</p>\n<p>Unavailable or another user's private settings return 404. Report access still applies. Raw XML GET does not rebind actors, modify stored XML or make an unsupported legacy mode authorable. Spireon upload and destructive purge settings cannot be copied/updated through this API just because they can be read. No setting, report or job is executed or changed by GET.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","{{report_setting_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"60781d7e-ed0a-40cd-a497-2b8849c18ae9","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": \"11111111-1111-4111-8111-111111111111\",\n    \"ts\": \"AAAAAAAAAAE=\",\n    \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n    \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n    \"name\": \"New accounts - company 1 - dealer 1001\",\n    \"description\": \"Current business month\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n    \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"f876f727-10ff-4f1c-a695-14bdede22729","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"Report setting not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"e4562662-3cd9-454e-864c-3e34f1da5c21"},{"name":"ReportSettingJsonGet","id":"9e8882f2-1868-4e0c-bdf2-2504127493eb","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/{{report_setting_id}}?representation=json&token={{token}}","description":"<p>Returns a visible saved setting as a full JSON editing body with parameters, metadata, ts and definitionVersion. It converts supported saved XML to that report's reviewed contract.</p>\n<p>The linked success example uses General Ledger Account List, not New Account. Its IDs and rowversion are synthetic; use your own server's current JSON GET.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_setting_id</code></td>\n<td>Required GUID path value. Use a visible setting id from ReportSettingsList for the chosen report.</td>\n</tr>\n<tr>\n<td><code>representation</code></td>\n<td>Optional string query value; xml is the API default. This request explicitly selects json. Only xml or json is accepted.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Copy response.data and retain fields you are not changing. Use the report's Definition for optional fields absent from this setting; definitions are not interchangeable across reports. Keep native JSON booleans and lossless string codes/macros as returned. Actor fields in this editing copy are bound to the caller, but GET does not change the stored row or original creator.</p>\n<p>GET checks the stored structure and identity bindings without rerunning save-time business-date rules. Previously valid literal dates remain readable after the business date advances. Validate, POST and PUT still apply today's save rules, so adjust dates or other inputs as needed before saving.</p>\n<p>Edit the complete body, optionally Validate, then POST to copy or PUT to replace. PUT needs the latest ts and unchanged reportId; a supplied body id must match the path. Reconcile any changed folder/email metadata with its bound parameter leaves. Do not submit the outer envelope, Definition or a parameters-only fragment.</p>\n<p>Unavailable/private settings return 404. Unsupported definitions return an XML-only error; other legacy values may fail the reviewed editing contract. Use raw XML GET to read these without claiming write support. Spireon upload, destructive purge and unsupported CommonQuery Dealer exclusions are not silently converted into supported modes. GET never saves or runs a report.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","{{report_setting_id}}"],"host":["{{base_url}}"],"query":[{"key":"representation","value":"json"},{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"87c366e9-7970-47b7-89e7-0146942c82dc","name":"Successful","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/55555555-5555-4555-8555-555555555555?representation=json&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","55555555-5555-4555-8555-555555555555"],"query":[{"key":"representation","value":"json"},{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": \"55555555-5555-4555-8555-555555555555\",\n    \"ts\": \"AAAAAAAAAAE=\",\n    \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n    \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n    \"name\": \"GL accounts - 1000 to 1999\",\n    \"description\": \"Illustrative private setting\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"parameters\": {\n      \"AccountNumbers\": [\n        \"{1000} - {1999}\"\n      ],\n      \"ShowInactiveAccounts\": false,\n      \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n    },\n    \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"5fda44d1-3c75-4b86-bdd8-f2de60032fdc","name":"Validation failure","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/55555555-5555-4555-8555-555555555555?representation=json&token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","55555555-5555-4555-8555-555555555555"],"query":[{"key":"representation","value":"json"},{"key":"token","value":"{{token}}"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"Report setting not found.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"9e8882f2-1868-4e0c-bdf2-2504127493eb"},{"name":"ReportSettingCreate","id":"c87d307f-be43-4fd3-aa68-11ac22a9fdf8","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n  \"folderId\": \"{{folder_id}}\",\n  \"name\": \"New accounts - company 1 - dealer 9316\",\n  \"description\": \"Current business month\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\" xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\"><AccountInstallmentGeneralGroup><BranchNumbers><fr:Value>1</fr:Value></BranchNumbers><Dealers><fr:Value>9316</fr:Value></Dealers><ActivationDates><fr:Value>MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup/><AccountCustomerGroup/><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><OmegaClientId>{{omega_client_id}}</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}","description":"<p>Creates one new saved setting from an XML settings body and returns its new id, ts and saved metadata/XML. The body below is a New Account example, not a shared schema for every report. For structured editing use ReportSettingJsonCreate.</p>\n<p>The linked success example uses New Account with illustrative company/dealer filters and synthetic identities. It is not a captured live save; obtain your own Template/GET values and permitted references.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>reportId</code></td>\n<td>Required GUID body value. Select a supported report from Reports; its Definition controls the parameters. On PUT this cannot change.</td>\n</tr>\n<tr>\n<td><code>folderId</code></td>\n<td>Required GUID body value. An existing folder for this tenant with the caller's view/add access. Match any folder-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Required string body value, 1-50 characters after trimming; unique for this report.</td>\n</tr>\n<tr>\n<td><code>description</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty.</td>\n</tr>\n<tr>\n<td><code>format</code></td>\n<td>Optional string body value, up to 50 characters; defaults to PDF. Global values are PDF, EXCEL, EXCELOPENXML, WORD, WORDOPENXML, CSV, XML, IMAGE and MHTML. A nonempty Definition.formats further restricts these; empty means no extra report-specific restriction. The default may be disallowed.</td>\n</tr>\n<tr>\n<td><code>isPrivate</code></td>\n<td>Optional boolean body value; omission defaults to false. True limits visibility to the owner. Templates start at true.</td>\n</tr>\n<tr>\n<td><code>userDefault</code></td>\n<td>Optional boolean body value; defaults to false. Sets the owner's report default when allowed.</td>\n</tr>\n<tr>\n<td><code>clientDefault</code></td>\n<td>Optional boolean body value; defaults to false. Requires client-default permission, isPrivate=false and userDefault=false. Editing an existing client default also requires that permission.</td>\n</tr>\n<tr>\n<td><code>email</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Nonempty recipients must pass email validation; match any email-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>saveToServerPath</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Saved delivery destination; nothing is written there by this request.</td>\n</tr>\n<tr>\n<td><code>fileTransferJobId</code></td>\n<td>Optional GUID or null body value; defaults to null. A supplied job must belong to this tenant. It is not run here.</td>\n</tr>\n<tr>\n<td><code>definitionVersion</code></td>\n<td>Optional string body value; retain the value from Template/GET. A supplied stale version returns 409.</td>\n</tr>\n<tr>\n<td><code>token</code> (body)</td>\n<td>Optional string when the query token is supplied. Retain one consistent authenticated client-user identity.</td>\n</tr>\n<tr>\n<td><code>filterXml</code></td>\n<td>Required XML string for this example. Match the selected report's root, namespaces, element order, types and bindings from Definition. Generic limit is 4,194,304 characters; New Account retains its stricter 262,144-character limit.</td>\n</tr>\n<tr>\n<td><code>parameters</code></td>\n<td>Alternative JSON object instead of filterXml; omit it for this XML example. Both cannot be supplied together.</td>\n</tr>\n<tr>\n<td><code>id</code>, <code>ts</code></td>\n<td>Optional copied GUID/base64 string body values; POST ignores them and creates a new setting.</td>\n</tr>\n<tr>\n<td><code>folder_id</code></td>\n<td>Required GUID example variable used for body folderId. Choose a real permitted folder, not a placeholder.</td>\n</tr>\n<tr>\n<td><code>omega_client_id</code></td>\n<td>Required GUID example variable inside XML. Use the authenticated tenant ID from its template, not a company/branch number.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Choose reportId from Reports and read its Definition, then use XML Template or XML GET. Edit with an XML library and JSON-serialize the complete response.data object. The sample's branch 1, dealer 9316 and current-month macro are illustrative: replace them with permitted values. Do not reuse the New Account XML for another report.</p>\n<p>POST ignores copied id/ts, assigns the caller as owner and creates a new setting. Choose a unique name and normally clear copied default flags. Duplicate name or a stale supplied definitionVersion returns 409.</p>\n<p>Copy the complete response.data object, not the outer response envelope or Definition. Keep fields you are not changing, including output/default flags and fixed/server-bound values. If folder/email metadata changes, reconcile the corresponding parameter leaves. Company selection is report-specific branch/company filtering; never replace the authenticated OmegaClientId with a company number.</p>\n<p>Spireon upload settings cannot be authored here. Purge Closed Accounts and Repurchase Batch Purge require ReportOnlyMode=true; missing/false values are rejected. CommonQuery Dealer Include/Exclude flags exposed as fixed true must remain true.</p>\n<p>These calls save settings only; they do not execute reports, mass updates, messages, file delivery or job streams. Job-stream configuration is separate, and later job runs use the saved settings. Validate checks parameters first but does not guarantee Save's metadata, permission, uniqueness or concurrency checks.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"fd800c4b-96dc-48ec-9d30-73147d1a7cd7","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": null,\n  \"ts\": null,\n  \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"New accounts - company 1 - dealer 1001\",\n  \"description\": \"Current business month\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n  \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": \"11111111-1111-4111-8111-111111111111\",\n    \"ts\": \"AAAAAAAAAAE=\",\n    \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n    \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n    \"name\": \"New accounts - company 1 - dealer 1001\",\n    \"description\": \"Current business month\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n    \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"ceb99c18-2bd5-49ed-a6ac-52706cb741f7","name":"Validation failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": null,\n  \"ts\": null,\n  \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"New accounts - company 1 - dealer 1001\",\n  \"description\": \"Current business month\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n  \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"A setting with this name already exists for this report.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"c87d307f-be43-4fd3-aa68-11ac22a9fdf8"},{"name":"ReportSettingJsonCreate","id":"feb51f10-f866-4987-a407-ba59d75443c9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{{report_setting_json}}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}","description":"<p>Creates one new saved setting using the full edited JSON body from ReportSettingsJsonTemplate or ReportSettingJsonGet. Returns the saved setting with its new id and ts. POST always creates a copy; it does not update the source setting.</p>\n<p>The linked success example uses General Ledger Account List with synthetic identities/rowversions. It illustrates the contract and is not a captured live save; use your own Template/GET and permitted references.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_setting_json</code></td>\n<td>Required string Postman variable containing the JSON serialization of the complete edited response.data object. It is inserted as the request object, without an additional pair of quotes.</td>\n</tr>\n<tr>\n<td><code>reportId</code></td>\n<td>Required GUID body value. Select a supported report from Reports; its Definition controls the parameters. On PUT this cannot change.</td>\n</tr>\n<tr>\n<td><code>folderId</code></td>\n<td>Required GUID body value. An existing folder for this tenant with the caller's view/add access. Match any folder-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Required string body value, 1-50 characters after trimming; unique for this report.</td>\n</tr>\n<tr>\n<td><code>description</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty.</td>\n</tr>\n<tr>\n<td><code>format</code></td>\n<td>Optional string body value, up to 50 characters; defaults to PDF. Global values are PDF, EXCEL, EXCELOPENXML, WORD, WORDOPENXML, CSV, XML, IMAGE and MHTML. A nonempty Definition.formats further restricts these; empty means no extra report-specific restriction. The default may be disallowed.</td>\n</tr>\n<tr>\n<td><code>isPrivate</code></td>\n<td>Optional boolean body value; omission defaults to false. True limits visibility to the owner. Templates start at true.</td>\n</tr>\n<tr>\n<td><code>userDefault</code></td>\n<td>Optional boolean body value; defaults to false. Sets the owner's report default when allowed.</td>\n</tr>\n<tr>\n<td><code>clientDefault</code></td>\n<td>Optional boolean body value; defaults to false. Requires client-default permission, isPrivate=false and userDefault=false. Editing an existing client default also requires that permission.</td>\n</tr>\n<tr>\n<td><code>email</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Nonempty recipients must pass email validation; match any email-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>saveToServerPath</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Saved delivery destination; nothing is written there by this request.</td>\n</tr>\n<tr>\n<td><code>fileTransferJobId</code></td>\n<td>Optional GUID or null body value; defaults to null. A supplied job must belong to this tenant. It is not run here.</td>\n</tr>\n<tr>\n<td><code>definitionVersion</code></td>\n<td>Optional string body value; retain the value from Template/GET. A supplied stale version returns 409.</td>\n</tr>\n<tr>\n<td><code>token</code> (body)</td>\n<td>Optional string when the query token is supplied. Retain one consistent authenticated client-user identity.</td>\n</tr>\n<tr>\n<td><code>parameters</code></td>\n<td>Required JSON object for this JSON example. Use the selected report's complete parameter structure, with its required and conditional fields.</td>\n</tr>\n<tr>\n<td><code>filterXml</code></td>\n<td>Alternative XML string instead of parameters; omit it for this JSON request. Both representations cannot be supplied together.</td>\n</tr>\n<tr>\n<td><code>id</code>, <code>ts</code></td>\n<td>Optional copied GUID/base64 string body values. POST ignores both and assigns a new setting ID/version.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Use Reports -&gt; Definition -&gt; JSON Template (or List -&gt; JSON GET) -&gt; edit response.data -&gt; optional Validate -&gt; this POST. Choose a new unique name and normally clear userDefault/clientDefault for a copy. The caller becomes its owner. A duplicate name or stale supplied definitionVersion returns 409; do not blindly retry creation.</p>\n<p>Copy the complete response.data object, not the outer response envelope or Definition. Keep fields you are not changing, including output/default flags and fixed/server-bound values. If folder/email metadata changes, reconcile the corresponding parameter leaves. Company selection is report-specific branch/company filtering; never replace the authenticated OmegaClientId with a company number.</p>\n<p>Spireon upload settings cannot be authored here. Purge Closed Accounts and Repurchase Batch Purge require ReportOnlyMode=true; missing/false values are rejected. CommonQuery Dealer Include/Exclude flags exposed as fixed true must remain true.</p>\n<p>These calls save settings only; they do not execute reports, mass updates, messages, file delivery or job streams. Job-stream configuration is separate, and later job runs use the saved settings. Validate checks parameters first but does not guarantee Save's metadata, permission, uniqueness or concurrency checks.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"d096b48b-17db-4868-bb00-bf27b8e59fbd","name":"Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": null,\n  \"ts\": null,\n  \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"GL accounts - 1000 to 1999\",\n  \"description\": \"Illustrative private setting\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"parameters\": {\n    \"AccountNumbers\": [\n      \"{1000} - {1999}\"\n    ],\n    \"ShowInactiveAccounts\": false,\n    \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n  },\n  \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": \"55555555-5555-4555-8555-555555555555\",\n    \"ts\": \"AAAAAAAAAAE=\",\n    \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n    \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n    \"name\": \"GL accounts - 1000 to 1999\",\n    \"description\": \"Illustrative private setting\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"parameters\": {\n      \"AccountNumbers\": [\n        \"{1000} - {1999}\"\n      ],\n      \"ShowInactiveAccounts\": false,\n      \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n    },\n    \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"5574882a-2b65-4017-b6c3-0d3096c6a18a","name":"Validation failure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": null,\n  \"ts\": null,\n  \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"GL accounts - 1000 to 1999\",\n  \"description\": \"Illustrative private setting\",\n  \"format\": \"TXT\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"parameters\": {\n    \"AccountNumbers\": [\n      \"{1000} - {1999}\"\n    ],\n    \"ShowInactiveAccounts\": false,\n    \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n  },\n  \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"Unsupported report format.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"feb51f10-f866-4987-a407-ba59d75443c9"},{"name":"ReportSettingUpdate","id":"ab01eccc-bd6b-44a2-a745-3cade7a34ce1","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"id\": \"{{report_setting_id}}\",\n  \"ts\": \"{{report_setting_ts}}\",\n  \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n  \"folderId\": \"{{folder_id}}\",\n  \"name\": \"New accounts - company 1 - dealer 9316\",\n  \"description\": \"Current business month\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\" xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\"><AccountInstallmentGeneralGroup><BranchNumbers><fr:Value>1</fr:Value></BranchNumbers><Dealers><fr:Value>9316</fr:Value></Dealers><ActivationDates><fr:Value>MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup/><AccountCustomerGroup/><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><OmegaClientId>{{omega_client_id}}</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\"\n}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/{{report_setting_id}}?token={{token}}","description":"<p>Replaces a visible saved setting using its full edited XML settings body and returns the new ts with its saved values. This is PUT, not PATCH. The sample is specific to New Account; use ReportSettingJsonUpdate for structured editing.</p>\n<p>The linked success example uses New Account with synthetic identities/rowversions. It is not a captured live update; GET the actual setting's latest ts and values before changing it.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_setting_id</code></td>\n<td>Required GUID path variable. Identifies the visible setting to replace.</td>\n</tr>\n<tr>\n<td><code>reportId</code></td>\n<td>Required GUID body value. Select a supported report from Reports; its Definition controls the parameters. On PUT this cannot change.</td>\n</tr>\n<tr>\n<td><code>folderId</code></td>\n<td>Required GUID body value. An existing folder for this tenant with the caller's view/add access. Match any folder-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Required string body value, 1-50 characters after trimming; unique for this report.</td>\n</tr>\n<tr>\n<td><code>description</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty.</td>\n</tr>\n<tr>\n<td><code>format</code></td>\n<td>Optional string body value, up to 50 characters; defaults to PDF. Global values are PDF, EXCEL, EXCELOPENXML, WORD, WORDOPENXML, CSV, XML, IMAGE and MHTML. A nonempty Definition.formats further restricts these; empty means no extra report-specific restriction. The default may be disallowed.</td>\n</tr>\n<tr>\n<td><code>isPrivate</code></td>\n<td>Optional boolean body value; omission defaults to false. True limits visibility to the owner. Templates start at true.</td>\n</tr>\n<tr>\n<td><code>userDefault</code></td>\n<td>Optional boolean body value; defaults to false. Sets the owner's report default when allowed.</td>\n</tr>\n<tr>\n<td><code>clientDefault</code></td>\n<td>Optional boolean body value; defaults to false. Requires client-default permission, isPrivate=false and userDefault=false. Editing an existing client default also requires that permission.</td>\n</tr>\n<tr>\n<td><code>email</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Nonempty recipients must pass email validation; match any email-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>saveToServerPath</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Saved delivery destination; nothing is written there by this request.</td>\n</tr>\n<tr>\n<td><code>fileTransferJobId</code></td>\n<td>Optional GUID or null body value; defaults to null. A supplied job must belong to this tenant. It is not run here.</td>\n</tr>\n<tr>\n<td><code>definitionVersion</code></td>\n<td>Optional string body value; retain the value from Template/GET. A supplied stale version returns 409.</td>\n</tr>\n<tr>\n<td><code>token</code> (body)</td>\n<td>Optional string when the query token is supplied. Retain one consistent authenticated client-user identity.</td>\n</tr>\n<tr>\n<td><code>filterXml</code></td>\n<td>Required XML string for this example. Follow this report's Definition. Generic limit is 4,194,304 characters; New Account retains its stricter 262,144-character limit.</td>\n</tr>\n<tr>\n<td><code>parameters</code></td>\n<td>Alternative JSON object instead of filterXml; omit it for this XML example. Both cannot be supplied together.</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>Optional GUID body value; if supplied, must match report_setting_id.</td>\n</tr>\n<tr>\n<td><code>ts</code> / <code>report_setting_ts</code></td>\n<td>Required base64 string body value / example variable. Use the latest eight-byte rowversion from GET.</td>\n</tr>\n<tr>\n<td><code>folder_id</code></td>\n<td>Required GUID example variable used for body folderId. Use a real permitted folder.</td>\n</tr>\n<tr>\n<td><code>omega_client_id</code></td>\n<td>Required GUID example variable inside XML. Keep the authenticated tenant ID, not a company/branch number.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Start with XML GET's complete response.data, edit using an XML library, then JSON-serialize the object. Preserve unchanged metadata, defaults and delivery destinations explicitly: omitted properties are not a partial update. Do not apply the New Account example's branch 1/dealer 9316 to another report or tenant.</p>\n<p>The original owner is retained; another user's public setting cannot be made private or your user default. reportId cannot change. A stale ts or supplied definitionVersion returns 409; fetch the current setting/definition and reconcile instead of blindly retrying.</p>\n<p>Copy the complete response.data object, not the outer response envelope or Definition. Keep fields you are not changing, including output/default flags and fixed/server-bound values. If folder/email metadata changes, reconcile the corresponding parameter leaves. Company selection is report-specific branch/company filtering; never replace the authenticated OmegaClientId with a company number.</p>\n<p>Spireon upload settings cannot be authored here. Purge Closed Accounts and Repurchase Batch Purge require ReportOnlyMode=true; missing/false values are rejected. CommonQuery Dealer Include/Exclude flags exposed as fixed true must remain true.</p>\n<p>These calls save settings only; they do not execute reports, mass updates, messages, file delivery or job streams. Job-stream configuration is separate, and later job runs use the saved settings. Validate checks parameters first but does not guarantee Save's metadata, permission, uniqueness or concurrency checks.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","{{report_setting_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"a78c0ccb-482c-42f1-a649-17856607c8a0","name":"Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": \"11111111-1111-4111-8111-111111111111\",\n  \"ts\": \"AAAAAAAAAAE=\",\n  \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"New accounts - company 1 - dealer 1001\",\n  \"description\": \"Current business month\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n  \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": \"11111111-1111-4111-8111-111111111111\",\n    \"ts\": \"AAAAAAAAAAI=\",\n    \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n    \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n    \"name\": \"New accounts - company 1 - dealer 1001\",\n    \"description\": \"Current business month\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n    \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"20411ad0-87b1-4e40-8a2f-08a01a1d29cc","name":"Validation failure","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": \"11111111-1111-4111-8111-111111111111\",\n  \"ts\": \"AAAAAAAAAAE=\",\n  \"reportId\": \"8bc6d748-6a81-474a-8d17-1320a10ac5f3\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"New accounts - company 1 - dealer 1001\",\n  \"description\": \"Current business month\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"filterXml\": \"<NewAccountReport xmlns=\\\"http://omega.megasys-inc.com/Schemas/Servicing/Reports\\\"><AccountInstallmentGeneralGroup><IncludeExcludeAccountNumbers>1</IncludeExcludeAccountNumbers><IncludeExcludeClassNumbers>1</IncludeExcludeClassNumbers><IncludeExcludeAdminStatuses>1</IncludeExcludeAdminStatuses><IncludeExcludePortfolioNumbers>1</IncludeExcludePortfolioNumbers><IncludeExcludeCollectors>1</IncludeExcludeCollectors><IncludeExcludeApprovedByUserID>1</IncludeExcludeApprovedByUserID><IncludeExcludeRegionalSalesRepID>1</IncludeExcludeRegionalSalesRepID><IncludeExcludeTerritorialSalesRepID>1</IncludeExcludeTerritorialSalesRepID><IncludeExcludeDealers>1</IncludeExcludeDealers><IncludeExcludeEnterDates>1</IncludeExcludeEnterDates><IncludeExcludeActivationDates>1</IncludeExcludeActivationDates><BranchNumbers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1</fr:Value></BranchNumbers><Dealers><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">1001</fr:Value></Dealers><ActivationDates><fr:Value xmlns:fr=\\\"http://omega.megasys-inc.com/Schemas/Framework/Reports\\\">MACRO@CM@0</fr:Value></ActivationDates></AccountInstallmentGeneralGroup><AccountInstallmentFinancialGroup><IncludeExcludeOpenDates>1</IncludeExcludeOpenDates><IncludeExcludeNextDueDates>1</IncludeExcludeNextDueDates><IncludeExcludeNextEftDraftDate>1</IncludeExcludeNextEftDraftDate><IncludeExcludeLastPaymentDates>1</IncludeExcludeLastPaymentDates><IncludeExcludeMaturityDates>1</IncludeExcludeMaturityDates><IncludeExcludeAPRs>1</IncludeExcludeAPRs><IncludeExcludeYields>1</IncludeExcludeYields><IncludeExcludeTerms>1</IncludeExcludeTerms><IncludeExcludeCurrentBalances>1</IncludeExcludeCurrentBalances><IncludeExcludeTotalCurrentBalances>1</IncludeExcludeTotalCurrentBalances><IncludeExcludePaymentAmounts>1</IncludeExcludePaymentAmounts><IncludeExcludeWholePayments>1</IncludeExcludeWholePayments><IncludeExcludeOpeningBalance>1</IncludeExcludeOpeningBalance><IncludeExcludeChargeOffDate>1</IncludeExcludeChargeOffDate><IncludeExcludeLateCharges>1</IncludeExcludeLateCharges><IncludeExcludePastDue>1</IncludeExcludePastDue><IncludeExcludeOriginalReserveAmount>1</IncludeExcludeOriginalReserveAmount><IncludeExcludeAvailableCredit>1</IncludeExcludeAvailableCredit><IncludeExcludeHighCreditLimit>1</IncludeExcludeHighCreditLimit><IncludeExcludePromiseToPayDate>1</IncludeExcludePromiseToPayDate></AccountInstallmentFinancialGroup><AccountCustomerGroup><IncludeExcludeCustomerNumbers>1</IncludeExcludeCustomerNumbers><IncludeExcludeLastNames>1</IncludeExcludeLastNames><IncludeExcludeCities>1</IncludeExcludeCities><IncludeExcludeProvinces>1</IncludeExcludeProvinces><IncludeExcludePostalCodes>1</IncludeExcludePostalCodes><IncludeConsumerIndicators>1</IncludeConsumerIndicators><ActiveOnly>1</ActiveOnly></AccountCustomerGroup><ActiveAccounts>1</ActiveAccounts><InProgressAccounts>0</InProgressAccounts><BulkImport>0</BulkImport><SummaryMode>0</SummaryMode><YTD>0</YTD><LastThreeMonths>0</LastThreeMonths><OmegaClientId>22222222-2222-4222-8222-222222222222</OmegaClientId><DetailLevel>1</DetailLevel></NewAccountReport>\",\n  \"definitionVersion\": \"29cbe42b987bb5c3082d783aed27ff558321fdd0c3f3d731ee5269410acbc330\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/11111111-1111-4111-8111-111111111111?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","11111111-1111-4111-8111-111111111111"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"The setting changed. GET it again before updating.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"ab01eccc-bd6b-44a2-a745-3cade7a34ce1"},{"name":"ReportSettingJsonUpdate","id":"699178b4-a679-472e-b603-0ebb9c102c5f","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{{report_setting_json}}","options":{"raw":{"language":"text"}}},"url":"https://{{base_url}}/api/Client/Setup/ReportSetting/{{report_setting_id}}?token={{token}}","description":"<p>Replaces one visible saved setting with the complete edited JSON body returned by JSON GET. Returns its saved values and new ts. This is a full PUT, not a partial PATCH.</p>\n<p>The linked success example uses General Ledger Account List with synthetic identities/rowversions. It is not a captured live save. Obtain your setting's current id, ts and parameters from JSON GET before updating.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Input</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>base_url</code></td>\n<td>Required string collection/environment variable. Omega API host (and optional port), without the HTTPS prefix.</td>\n</tr>\n<tr>\n<td><code>token</code></td>\n<td>Required string query value for this token-authenticated example. Use an active client-user token; endpoint, report and module permissions still apply.</td>\n</tr>\n<tr>\n<td><code>report_setting_id</code></td>\n<td>Required GUID path value. Identify the setting returned by List/GET.</td>\n</tr>\n<tr>\n<td><code>report_setting_json</code></td>\n<td>Required string Postman variable containing the complete edited response.data JSON serialization, without surrounding quotes.</td>\n</tr>\n<tr>\n<td><code>reportId</code></td>\n<td>Required GUID body value. Select a supported report from Reports; its Definition controls the parameters. On PUT this cannot change.</td>\n</tr>\n<tr>\n<td><code>folderId</code></td>\n<td>Required GUID body value. An existing folder for this tenant with the caller's view/add access. Match any folder-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>Required string body value, 1-50 characters after trimming; unique for this report.</td>\n</tr>\n<tr>\n<td><code>description</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty.</td>\n</tr>\n<tr>\n<td><code>format</code></td>\n<td>Optional string body value, up to 50 characters; defaults to PDF. Global values are PDF, EXCEL, EXCELOPENXML, WORD, WORDOPENXML, CSV, XML, IMAGE and MHTML. A nonempty Definition.formats further restricts these; empty means no extra report-specific restriction. The default may be disallowed.</td>\n</tr>\n<tr>\n<td><code>isPrivate</code></td>\n<td>Optional boolean body value; omission defaults to false. True limits visibility to the owner. Templates start at true.</td>\n</tr>\n<tr>\n<td><code>userDefault</code></td>\n<td>Optional boolean body value; defaults to false. Sets the owner's report default when allowed.</td>\n</tr>\n<tr>\n<td><code>clientDefault</code></td>\n<td>Optional boolean body value; defaults to false. Requires client-default permission, isPrivate=false and userDefault=false. Editing an existing client default also requires that permission.</td>\n</tr>\n<tr>\n<td><code>email</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Nonempty recipients must pass email validation; match any email-bound parameter leaves.</td>\n</tr>\n<tr>\n<td><code>saveToServerPath</code></td>\n<td>Optional string body value, up to 255 characters; defaults to empty. Saved delivery destination; nothing is written there by this request.</td>\n</tr>\n<tr>\n<td><code>fileTransferJobId</code></td>\n<td>Optional GUID or null body value; defaults to null. A supplied job must belong to this tenant. It is not run here.</td>\n</tr>\n<tr>\n<td><code>definitionVersion</code></td>\n<td>Optional string body value; retain the value from Template/GET. A supplied stale version returns 409.</td>\n</tr>\n<tr>\n<td><code>token</code> (body)</td>\n<td>Optional string when the query token is supplied. Retain one consistent authenticated client-user identity.</td>\n</tr>\n<tr>\n<td><code>parameters</code></td>\n<td>Required JSON object for this JSON example. Preserve the complete per-report structure; follow Definition for intentional changes.</td>\n</tr>\n<tr>\n<td><code>filterXml</code></td>\n<td>Alternative XML string instead of parameters; omit it for this JSON request. Both cannot be supplied together.</td>\n</tr>\n<tr>\n<td><code>id</code></td>\n<td>Optional GUID body value; if supplied, it must match report_setting_id.</td>\n</tr>\n<tr>\n<td><code>ts</code></td>\n<td>Required base64 string body value representing the latest eight-byte rowversion returned by GET.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Use List -&gt; JSON GET -&gt; consult Definition -&gt; edit the complete response.data -&gt; optional Validate -&gt; this PUT. Do not submit Definition, the Validate response or a parameters-only fragment. Omitted metadata is not preserved automatically: model defaults replace omitted values. A 409 means re-read and reconcile the latest setting/definition before retrying.</p>\n<p>The original creator remains the owner. Another user's public setting cannot be made private or the caller's user default. Invisible settings return 404; lacking report, folder or required default permissions returns an error.</p>\n<p>Copy the complete response.data object, not the outer response envelope or Definition. Keep fields you are not changing, including output/default flags and fixed/server-bound values. If folder/email metadata changes, reconcile the corresponding parameter leaves. Company selection is report-specific branch/company filtering; never replace the authenticated OmegaClientId with a company number.</p>\n<p>Spireon upload settings cannot be authored here. Purge Closed Accounts and Repurchase Batch Purge require ReportOnlyMode=true; missing/false values are rejected. CommonQuery Dealer Include/Exclude flags exposed as fixed true must remain true.</p>\n<p>These calls save settings only; they do not execute reports, mass updates, messages, file delivery or job streams. Job-stream configuration is separate, and later job runs use the saved settings. Validate checks parameters first but does not guarantee Save's metadata, permission, uniqueness or concurrency checks.</p>\n","urlObject":{"protocol":"https","path":["api","Client","Setup","ReportSetting","{{report_setting_id}}"],"host":["{{base_url}}"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"63d5ac1e-8b73-4108-9f95-936d820c8770","name":"Successful","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": \"55555555-5555-4555-8555-555555555555\",\n  \"ts\": \"AAAAAAAAAAE=\",\n  \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"GL accounts - 1000 to 1999\",\n  \"description\": \"Illustrative private setting\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"parameters\": {\n    \"AccountNumbers\": [\n      \"{1000} - {1999}\"\n    ],\n    \"ShowInactiveAccounts\": false,\n    \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n  },\n  \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/55555555-5555-4555-8555-555555555555?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","55555555-5555-4555-8555-555555555555"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 0,\n  \"result\": \"Ok\",\n  \"data\": {\n    \"token\": null,\n    \"id\": \"55555555-5555-4555-8555-555555555555\",\n    \"ts\": \"AAAAAAAAAAI=\",\n    \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n    \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n    \"name\": \"GL accounts - 1000 to 1999\",\n    \"description\": \"Illustrative private setting\",\n    \"format\": \"PDF\",\n    \"isPrivate\": true,\n    \"userDefault\": false,\n    \"clientDefault\": false,\n    \"email\": \"\",\n    \"saveToServerPath\": \"\",\n    \"fileTransferJobId\": null,\n    \"parameters\": {\n      \"AccountNumbers\": [\n        \"{1000} - {1999}\"\n      ],\n      \"ShowInactiveAccounts\": false,\n      \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n    },\n    \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n  },\n  \"errors\": [],\n  \"warnings\": []\n}"},{"id":"15e5fe20-647b-4b2f-b3e6-d54a7d37bee5","name":"Validation failure","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"token\": null,\n  \"id\": \"55555555-5555-4555-8555-555555555555\",\n  \"ts\": \"AAAAAAAAAAE=\",\n  \"reportId\": \"5d8123f6-fd85-4e70-85bf-ead9f875e33a\",\n  \"folderId\": \"44444444-4444-4444-8444-444444444444\",\n  \"name\": \"GL accounts - 1000 to 1999\",\n  \"description\": \"Illustrative private setting\",\n  \"format\": \"PDF\",\n  \"isPrivate\": true,\n  \"userDefault\": false,\n  \"clientDefault\": false,\n  \"email\": \"\",\n  \"saveToServerPath\": \"\",\n  \"fileTransferJobId\": null,\n  \"parameters\": {\n    \"AccountNumbers\": [\n      \"{1000} - {1999}\"\n    ],\n    \"ShowInactiveAccounts\": false,\n    \"OmegaClientId\": \"22222222-2222-4222-8222-222222222222\"\n  },\n  \"definitionVersion\": \"9ee584290c1ef112bed8d01aef6c7a86d402eee253b73eec5673139ffbd83a5e\"\n}","options":{"raw":{"language":"text"}}},"url":{"raw":"https://{{base_url}}/api/Client/Setup/ReportSetting/55555555-5555-4555-8555-555555555555?token={{token}}","protocol":"https","host":["{{base_url}}"],"path":["api","Client","Setup","ReportSetting","55555555-5555-4555-8555-555555555555"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n  \"statusCode\": 50,\n  \"result\": \"Error\",\n  \"data\": null,\n  \"errors\": [\n    \"The setting changed. GET it again before updating.\"\n  ],\n  \"warnings\": []\n}"}],"_postman_id":"699178b4-a679-472e-b603-0ebb9c102c5f"}],"id":"862723dc-4aa4-46bb-913d-092dd6e4247c","_postman_id":"862723dc-4aa4-46bb-913d-092dd6e4247c","description":""},{"name":"Omega Webhook","item":[{"name":"Account Entry Webhook","id":"3bf8e1c8-8058-41c5-a817-a579012fe2a4","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{account_entry_webhook_bearer_token}}"},{"key":"purchaseCode","value":"{{purchase_code}}"}],"body":{"mode":"raw","raw":"{\n    \"schemaVersion\": \"1.0\",\n    \"requestId\": \"8f3c2a1e-4b5d-6e7f-8091-a2b3c4d5e6f7\",\n    \"eventType\": \"accountEntry.calculate\",\n    \"sourceFlow\": \"Repurchase\",\n    \"client\": {\n        \"clientNumber\": 8\n    },\n    \"account\": {\n        \"entityRef\": \"account\",\n        \"parentType\": \"Account\",\n        \"accountNumber\": 30009504,\n        \"accountClassNumber\": 1,\n        \"state\": \"CA\",\n        \"accountType\": \"Interest_Bearing_Indirect\",\n        \"portfolioNumber\": 2,\n        \"oldPortfolioNumber\": 1,\n        \"interestRate\": 0.129900,\n        \"contractualRate\": 0.129900,\n        \"contractualApr\": 0.142500,\n        \"paymentFrequency\": \"Monthly\",\n        \"actualTerm\": 60,\n        \"amortizedTerm\": 60,\n        \"openDate\": \"2024-01-15T00:00:00\",\n        \"firstDueDate\": \"2024-02-15T00:00:00\",\n        \"interestStartDate\": \"2024-01-15T00:00:00\",\n        \"dealerCode\": \"DLR001\",\n        \"recourseTerm\": 12,\n        \"amountFinanced\": 18500.00,\n        \"cashPrice\": 20000.00,\n        \"downPayment\": 1500.00,\n        \"tradeInValue\": 0.00,\n        \"remainingActualTerm\": 48,\n        \"remainingAmortizedTerm\": 48,\n        \"nextDueDate\": \"2026-08-15T00:00:00\",\n        \"paymentExtensions\": 0,\n        \"conversionDate\": null,\n        \"currentInterestRate\": 0.129900,\n        \"totalPaid\": 4200.00,\n        \"totalPrincipalPaid\": 2800.00,\n        \"totalInterestAccrued\": 1600.00,\n        \"totalInterestPaid\": 1400.00,\n        \"currentBalance\": 15700.00,\n        \"customers\": [\n            {\n                \"entityRef\": \"customer:primary\",\n                \"parentType\": \"Customer\",\n                \"customerType\": \"Primary_Customer\",\n                \"customerNumber\": 1001,\n                \"firstName\": \"Jane\",\n                \"lastName\": \"Doe\",\n                \"dateOfBirth\": \"1985-06-20\",\n                \"ssnLast4\": \"6789\",\n                \"address\": {\n                    \"line1\": \"123 Main St\",\n                    \"city\": \"Irvine\",\n                    \"state\": \"CA\",\n                    \"postalCode\": \"92618\"\n                },\n                \"creditScores\": [\n                    {\n                        \"score\": 720,\n                        \"source\": \"Experian\",\n                        \"scoreDate\": \"2024-01-10\",\n                        \"scoreModel\": \"FICO\",\n                        \"comment\": null\n                    }\n                ]\n            }\n        ],\n        \"collateral\": [\n            {\n                \"entityRef\": \"collateral:1\",\n                \"parentType\": \"Collateral\",\n                \"collateralType\": \"Automobile\",\n                \"year\": 2022,\n                \"make\": \"Toyota\",\n                \"model\": \"Camry\",\n                \"vin\": \"4T1B11HK0JU123456\"\n            }\n        ],\n        \"remarkCodes\": [\n            \"BKPT\",\n            \"REPO\"\n        ],\n        \"customScreenFields\": [\n            {\n                \"parentType\": \"Account\",\n                \"entityRef\": \"account\",\n                \"key\": \"StoreName\",\n                \"type\": \"Text\",\n                \"label\": \"Store Name\",\n                \"value\": \"Example Motors\"\n            }\n        ]\n    }\n}","options":{"raw":{"language":"text"}}},"url":"{{account_entry_webhook_url}}","description":"<h3 id=\"indirect-account-entry-webhook-outbound-contract\">Indirect Account Entry Webhook (Outbound Contract)</h3>\n<p>Omega POSTs the in-progress deal to the client's HTTPS endpoint configured\nunder Third Party Configuration → Indirect Account Entry Webhook. The\nendpoint's JSON response supplies pricing, fee and credit reporting decisions\nthat Omega applies. <strong>Indirect accounts only</strong> — direct accounts never call\nthis webhook.</p>\n<p>Used by:</p>\n<ul>\n<li>New-account booking <strong>Calculate</strong> (<code>sourceFlow</code> = <code>webFormsCalculate</code>)</li>\n<li><strong>Repurchase</strong> rebook (<code>sourceFlow</code> = <code>Repurchase</code>)</li>\n</ul>\n<p>On repurchase, a required webhook that does not succeed <strong>fails the account</strong>\n(no silent class-default rebook). The raw response body is stored on the\nrepurchase batch detail for audit.</p>\n<p><strong>HTTP Method:</strong> POST</p>\n<p><strong>Endpoint:</strong> <code>{{account_entry_webhook_url}}</code> (client-configured HTTPS URL)</p>\n<p><strong>Headers</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Header</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>Content-Type</em></td>\n<td><code>application/json</code></td>\n</tr>\n<tr>\n<td><em>Authorization</em></td>\n<td><code>Bearer &lt;API key&gt;</code> from Third Party Configuration for the current deployment</td>\n</tr>\n<tr>\n<td><em>purchaseCode</em></td>\n<td>Optional. Turnaround purchase code on repurchase / repurchase API calls. Not part of the JSON body.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"top-level-request-parameters\">Top-Level Request Parameters</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>schemaVersion</em></td>\n<td>Contract version. Currently <code>\"1.0\"</code>.</td>\n</tr>\n<tr>\n<td><em>requestId</em></td>\n<td>Unique GUID for this call. Echo it back in the response when you send <code>requestId</code>.</td>\n</tr>\n<tr>\n<td><em>eventType</em></td>\n<td>Event name. Typically <code>accountEntry.calculate</code>.</td>\n</tr>\n<tr>\n<td><em>sourceFlow</em></td>\n<td>Caller flow. Booking Calculate: <code>webFormsCalculate</code>. Repurchase: <code>Repurchase</code>.</td>\n</tr>\n<tr>\n<td><em>client.clientNumber</em></td>\n<td>Omega client number.</td>\n</tr>\n<tr>\n<td><em>account</em></td>\n<td>Deal / loan payload (see below).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-account-deal-terms\">Request <code>account</code> Deal Terms</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>entityRef</em> / <em>parentType</em></td>\n<td>Correlation refs for the account parent when present.</td>\n</tr>\n<tr>\n<td><em>accountNumber</em></td>\n<td>Account number (long). May be null until assigned on new booking.</td>\n</tr>\n<tr>\n<td><em>accountClassNumber</em></td>\n<td>Class number.</td>\n</tr>\n<tr>\n<td><em>state</em></td>\n<td>Province/state abbreviation.</td>\n</tr>\n<tr>\n<td><em>accountType</em></td>\n<td>e.g. <code>Interest_Bearing_Indirect</code>.</td>\n</tr>\n<tr>\n<td><em>portfolioNumber</em></td>\n<td>Portfolio for this request. On repurchase this is the <strong>new</strong> target portfolio.</td>\n</tr>\n<tr>\n<td><em>oldPortfolioNumber</em></td>\n<td><strong>Repurchase only.</strong> Pre-repurchase portfolio. Omitted/null on new-account Calculate.</td>\n</tr>\n<tr>\n<td><em>interestRate</em></td>\n<td>Interest rate.</td>\n</tr>\n<tr>\n<td><em>contractualRate</em></td>\n<td>Contractual rate.</td>\n</tr>\n<tr>\n<td><em>contractualApr</em></td>\n<td>Contractual APR.</td>\n</tr>\n<tr>\n<td><em>paymentFrequency</em></td>\n<td>Payment frequency.</td>\n</tr>\n<tr>\n<td><em>actualTerm</em> / <em>amortizedTerm</em></td>\n<td>Term values.</td>\n</tr>\n<tr>\n<td><em>openDate</em> / <em>firstDueDate</em> / <em>interestStartDate</em></td>\n<td>Loan dates.</td>\n</tr>\n<tr>\n<td><em>dealerCode</em></td>\n<td>Dealer code (indirect).</td>\n</tr>\n<tr>\n<td><em>recourseTerm</em></td>\n<td>Recourse term (indirect).</td>\n</tr>\n<tr>\n<td><em>amountFinanced</em> / <em>cashPrice</em> / <em>downPayment</em> / <em>tradeInValue</em></td>\n<td>Deal amounts. Booking uses live screen values; repurchase uses the pre-write-off snapshot where applicable.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-account-aged--current-loan-context\">Request <code>account</code> Aged / Current-Loan Context</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>remainingActualTerm</em> / <em>remainingAmortizedTerm</em></td>\n<td>Remaining terms when aged/conversion context exists.</td>\n</tr>\n<tr>\n<td><em>nextDueDate</em></td>\n<td>Next due date.</td>\n</tr>\n<tr>\n<td><em>paymentExtensions</em></td>\n<td>Payment extension count.</td>\n</tr>\n<tr>\n<td><em>conversionDate</em></td>\n<td>Conversion date when present.</td>\n</tr>\n<tr>\n<td><em>currentInterestRate</em></td>\n<td>Current interest rate.</td>\n</tr>\n<tr>\n<td><em>totalPaid</em> / <em>totalPrincipalPaid</em> / <em>totalInterestAccrued</em> / <em>totalInterestPaid</em></td>\n<td>Paid / accrued totals.</td>\n</tr>\n<tr>\n<td><em>currentBalance</em></td>\n<td>Pre-repurchase balance. Used on repurchase for holdback cash-price substitution and Current Balance fee uplift.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-accountcustomers\">Request <code>account.customers[]</code></h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>entityRef</em></td>\n<td>e.g. <code>customer:primary</code>, <code>customer:spouse</code>, <code>customer:co-signer:N</code>, <code>customer:guarantor:N</code>. The response's <code>creditReporting.customers[]</code> refer to customers by this value.</td>\n</tr>\n<tr>\n<td><em>parentType</em> / <em>customerType</em> / <em>customerNumber</em></td>\n<td>Customer identity fields.</td>\n</tr>\n<tr>\n<td><em>firstName</em> / <em>lastName</em></td>\n<td>Name.</td>\n</tr>\n<tr>\n<td><em>dateOfBirth</em></td>\n<td><code>yyyy-MM-dd</code>.</td>\n</tr>\n<tr>\n<td><em>ssnLast4</em></td>\n<td>Last four of SSN.</td>\n</tr>\n<tr>\n<td><em>address</em></td>\n<td><code>line1</code>, <code>city</code>, <code>state</code>, <code>postalCode</code>.</td>\n</tr>\n<tr>\n<td><em>creditScores[]</em></td>\n<td><code>score</code>, <code>source</code>, <code>scoreDate</code>, <code>scoreModel</code>, <code>comment</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-accountcollateral\">Request <code>account.collateral[]</code></h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>entityRef</em></td>\n<td>e.g. <code>collateral:N</code></td>\n</tr>\n<tr>\n<td><em>parentType</em> / <em>collateralType</em></td>\n<td>Collateral identity.</td>\n</tr>\n<tr>\n<td><em>year</em> / <em>make</em> / <em>model</em> / <em>vin</em></td>\n<td>Vehicle / collateral details.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-accountremarkcodes\">Request <code>account.remarkCodes[]</code></h4>\n<p>Array of strings, sent immediately after <code>collateral</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>remarkCodes[]</em></td>\n<td>The account's CURRENT remark codes — <code>[Common].[RemarkCode].Code</code> values. Empty array when the account has none (e.g. a brand-new application). On repurchase these are the codes carried over from the pre-repurchase account.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"request-accountcustomscreenfields\">Request <code>account.customScreenFields[]</code></h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>parentType</em> / <em>entityRef</em></td>\n<td>Parent the field belongs to (Application, Account, Customer, Collateral).</td>\n</tr>\n<tr>\n<td><em>key</em> / <em>type</em> / <em>label</em> / <em>value</em></td>\n<td>Custom form field snapshot.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"expected-response-top-level\">Expected Response (Top Level)</h4>\n<p>Only <code>account</code> is required. If you send <code>status</code>, <code>requestId</code>, or <code>errors</code>, Omega validates them.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>schemaVersion</em></td>\n<td>Optional. Echo <code>\"1.0\"</code> if sent.</td>\n</tr>\n<tr>\n<td><em>requestId</em></td>\n<td>Optional. Must match the request when present.</td>\n</tr>\n<tr>\n<td><em>status</em></td>\n<td>Optional. Must be <code>\"success\"</code> when present.</td>\n</tr>\n<tr>\n<td><em>errors</em></td>\n<td>Optional array. Any entry fails the call. Items: <code>code</code>, <code>message</code>.</td>\n</tr>\n<tr>\n<td><em>account</em></td>\n<td><strong>Required.</strong> Values Omega applies (below).</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-account-dealer-economics-percent-only\">Response <code>account</code> Dealer Economics (percent-only)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>discountPercent</em> / <em>reservePercent</em> / <em>withholdPercent</em></td>\n<td>Decimal <strong>fraction</strong> (8% = <code>0.080000</code>). Amounts are not accepted.</td>\n</tr>\n<tr>\n<td><em>discountBasis</em> / <em>reserveBasis</em> / <em>withholdBasis</em></td>\n<td><strong>Required</strong> when the matching percent is set. Holdback basis name or GUID (<code>CashPrice</code>, <code>DownPayment</code>, <code>AmountFinanced</code> / <code>Amount Finance</code>, or a client-defined basis). Unknown = error. On repurchase, a basis that includes Cash Price uses <strong>current balance (before write-off)</strong> for that cash-price component.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-accountlate_charge-optional\">Response <code>account.late_charge</code> (optional)</h4>\n<p>A returned <code>late_charge</code> replaces the account's late fee setup as a whole: a\nfield left out inside it (<code>min</code>, <code>max</code>, <code>threshold</code>) is cleared, not kept\nfrom the old setup. A <code>late_charge</code> that is missing a value day end needs\nfor its <code>calculationMethod</code> (see the field table) is rejected, so every late\nfee the webhook sets can be assessed.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Case</strong></th>\n<th><strong>Result</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>late_charge</code> omitted</td>\n<td>The class (state rule) setup applies. Booking: Activate Account fills it in from the class; if an earlier Calculate returned a <code>late_charge</code> and the application has not been closed and reopened since, Omega first puts the class setup back. Repurchase: the account keeps its late fee, except that an account that was Interest Bearing before the repurchase and moves into a Collection Account portfolio has its late fee reset to the class setup.</td>\n</tr>\n<tr>\n<td><code>Flat_Rate</code> with <code>amount: 0</code></td>\n<td><strong>No late fee.</strong> Omega saves a $0 late fee, and day end never assesses a $0 late fee. This is the only late charge that may leave out <code>graceDays</code> (saved as 0).</td>\n</tr>\n<tr>\n<td>Any other <code>late_charge</code></td>\n<td>Replaces the account's late fee setup with the returned values.</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>calculationMethod</em></td>\n<td>Named late-fee method (e.g. <code>Flat_Rate</code>). Required if <code>late_charge</code> is sent.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Currency, 0 or more. <strong>Required</strong> with <code>Flat_Rate</code> (<code>0</code> = no late fee); for <code>Flat_Rate</code> only.</td>\n</tr>\n<tr>\n<td><em>percent</em></td>\n<td>Decimal fraction. <strong>Required</strong> with <code>Percent_of_Current_Payment_Amount</code>, <code>Percent_of_Payment_Amount_Due</code>, <code>Daily_Percent_of_Payment_Amount_Due_Mexico</code> and FA installment methods 5–7. Not used by <code>Flat_Rate</code> or FA installment method 4. Do not send both amount and percent.</td>\n</tr>\n<tr>\n<td><em>graceDays</em></td>\n<td>Whole days after the due date before a late fee is charged, 0 or more. <strong>Required</strong>, except with a <code>Flat_Rate</code> amount of 0.</td>\n</tr>\n<tr>\n<td><em>min</em> / <em>max</em></td>\n<td>Currency. <strong>Required</strong> with <code>Percent_of_Current_Payment_Amount</code>, <code>Percent_of_Payment_Amount_Due</code> and FA installment methods 4–7.</td>\n</tr>\n<tr>\n<td><em>threshold</em></td>\n<td>Required for FA installment methods 4–6.</td>\n</tr>\n<tr>\n<td><em>includePartialPayments</em></td>\n<td>Optional bool; FA installment methods 4–7.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Negative amounts, limits, thresholds, percents and grace days are rejected.\nThe error message names the field.</p>\n<h4 id=\"response-accountnsf-optional\">Response <code>account.nsf</code> (optional)</h4>\n<p>Omit <code>nsf</code> (or send <code>fee</code> as null) to keep the class (state rule) setup.\nBooking: Activate Account fills it in from the class; if an earlier\nCalculate returned an NSF fee and the application has not been closed and\nreopened since, Omega first puts the class setup back. Repurchase: the\naccount keeps its NSF fee.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>fee</em></td>\n<td>NSF fee (currency). <code>0</code> = no NSF fee.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-accountoriginationfees-optional\">Response <code>account.originationFees[]</code> (optional)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Must match an existing Omega origination fee description valid for the class/state.</td>\n</tr>\n<tr>\n<td><em>amount</em> <strong>or</strong> <em>percentage</em></td>\n<td>Exactly one. Amount = manual fee; percentage = calculated on the fee's Omega-configured basis. No <code>basis</code> field in the response (an incoming <code>basis</code> key is ignored). Booking: merge named fees. Repurchase: full replacement (empty/omitted list clears fees). Current Balance basis fees are repurchase-only.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-accountadvanceadjustmentfees-optional\">Response <code>account.advanceAdjustmentFees[]</code> (optional)</h4>\n<p>Applied on repurchase (full replacement). Ignored on booking Calculate.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>description</em></td>\n<td>Must match an available advance-adjustment fee on the class fee set.</td>\n</tr>\n<tr>\n<td><em>amount</em></td>\n<td>Required currency. No percentage option.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-accountremarkcodes-optional\">Response <code>account.remarkCodes[]</code> (optional)</h4>\n<p>Array of strings, returned immediately before <code>customScreenFields</code>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>remarkCodes[]</em></td>\n<td><strong>Full replacement</strong> of the account's remark codes (<code>[Common].[RemarkCode].Code</code>). Codes the account already has are kept; codes not returned are removed; codes returned that it does not have are added. On repurchase this replaces the list carried over from the pre-repurchase account.</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Case</strong></th>\n<th><strong>Meaning</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Key omitted, or <code>null</code></td>\n<td>Leave the account's remark codes exactly as they are.</td>\n</tr>\n<tr>\n<td><code>[]</code> (present, empty)</td>\n<td>The account should carry no remark codes — clears them.</td>\n</tr>\n<tr>\n<td><code>[\"ABC\",\"DEF\"]</code></td>\n<td>The account should end up with exactly these codes.</td>\n</tr>\n</tbody>\n</table>\n</div><p>Codes that do not exist for the client are <strong>dropped, never created</strong> — and reported (see below).</p>\n<h4 id=\"response-accountcustomscreenfields-optional\">Response <code>account.customScreenFields[]</code> (optional)</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>key</em></td>\n<td>Omega custom-field API key for the <strong>Account</strong> parent. Unknown / DB-backed keys are skipped (not errors).</td>\n</tr>\n<tr>\n<td><em>value</em></td>\n<td>JSON scalar. Saved with the account in the same transaction.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"response-accountcreditreporting-optional\">Response <code>account.creditReporting</code> (optional)</h4>\n<p>Sets the View Account &gt; Credit fields a user can edit. Only the values you\nreturn change: an omitted or blank value leaves that field as it is, and\nomitting the section changes nothing. Omega writes one account log entry\nlisting what changed.</p>\n<ul>\n<li><strong>Booking:</strong> the values are checked at Calculate and saved with the\napplication, in the same transaction as the account save. A Calculate\nthat is never saved writes nothing.</li>\n<li><strong>Repurchase:</strong> saved with the repurchase. Report Only applies nothing. A\nrepurchase reversal puts back the values the webhook set.</li>\n</ul>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>reportToExperian</em> / <em>reportToEquifax</em> / <em>reportToTransUnion</em></td>\n<td><code>Yes</code> or <code>No</code> (<code>Delete</code> is rejected). Applied only when the client creates separate files for each bureau.</td>\n</tr>\n<tr>\n<td><em>consumerComplianceCode</em></td>\n<td>Metro 2 compliance condition code, <code>XA</code>–<code>XR</code>. Its date is the business date when the code is first set.</td>\n</tr>\n<tr>\n<td><em>fcraOccurrenceDate</em></td>\n<td>Date. <strong>Booking only.</strong> A repurchase takes it from the credit reporting transfer (the seller's date of first delinquency).</td>\n</tr>\n<tr>\n<td><em>originalCreditor</em></td>\n<td>Up to 30 characters. K1 Original Creditor (reported for Collection Account portfolios). On a repurchase it <strong>replaces the seller's name</strong>, which the purchaser would otherwise report as original creditor after the first credit reporting run.</td>\n</tr>\n<tr>\n<td><em>originalCreditorType</em></td>\n<td>Original Creditor Type name, e.g. <code>Retail</code>, <code>Medical_Health_Care</code>, <code>Automotive</code> (underscores/spaces optional).</td>\n</tr>\n<tr>\n<td><em>previousLenderName</em></td>\n<td>Up to 30 characters. K2 Previous Lender Name; applied to Purchased Aged accounts only.</td>\n</tr>\n<tr>\n<td><em>customers[]</em></td>\n<td>Consumer information indicator details per customer (below).</td>\n</tr>\n</tbody>\n</table>\n</div><div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong><code>customers[]</code> Field</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><em>entityRef</em></td>\n<td>Required. Must match a customer sent in the request (<code>customer:primary</code>, <code>customer:co-signer:1</code>, …). No duplicates.</td>\n</tr>\n<tr>\n<td><em>consumerInfoIndicator</em></td>\n<td>Metro 2 consumer information indicator (<code>A</code>–<code>Z</code>, <code>1A</code>, …). Required when any other customer field is sent. A bankruptcy indicator opts the customer's cell phones out of texting, as the Credit tab does.</td>\n</tr>\n<tr>\n<td><em>consumerInfoIndicatorDate</em></td>\n<td>Status date. Left out: the stored date is kept while the indicator stays the same; a new or changed indicator gets the business date.</td>\n</tr>\n<tr>\n<td><em>bankruptcyPetitionDate</em></td>\n<td><strong>Required</strong> with indicators <code>A</code>–<code>H</code>. Left out with another indicator: the stored date is kept.</td>\n</tr>\n<tr>\n<td><em>creditBureauAccountStatus</em></td>\n<td>Metro 2 account status (<code>05</code>, <code>13</code>, …). Only with indicator <code>V</code> or <code>A</code>–<code>H</code>. Left out: the stored status is kept. Not kept for a <code>V</code> or <code>A</code>–<code>D</code> petition dated in the current reporting month (the credit reporting run sets it).</td>\n</tr>\n</tbody>\n</table>\n</div><p>An invalid section (unknown code, value too long, unmatched <code>entityRef</code>,\nmissing petition date, …) is rejected: booking Calculate fails with the\nmessage, and a repurchase fails the account.</p>\n<h4 id=\"what-happens-to-values-omega-cannot-find\">What happens to values Omega cannot find</h4>\n<p>Unknown <code>remarkCodes</code> and unknown <code>customScreenFields</code> keys are skipped rather than failing the call —\nbut they are no longer discarded silently:</p>\n<ul>\n<li><strong>Account log note</strong> — one note per call listing every dropped remark code and custom field\n(with its value), written in the same transaction as the account save.</li>\n<li><strong>Repurchase results report</strong> — a <code>WebhookDroppedItems</code> column carries a one-line summary for the\naccount, in both the posted-batch results CSV and the Report Only eligibility CSV.</li>\n</ul>\n","urlObject":{"host":["{{account_entry_webhook_url}}"],"query":[],"variable":[]}},"response":[{"id":"42b1b031-6067-4d65-8fa1-be8b10a0593c","name":"Account Entry Webhook - Successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{account_entry_webhook_bearer_token}}"},{"key":"purchaseCode","value":"{{purchase_code}}"}],"body":{"mode":"raw","raw":"{\n    \"schemaVersion\": \"1.0\",\n    \"requestId\": \"8f3c2a1e-4b5d-6e7f-8091-a2b3c4d5e6f7\",\n    \"eventType\": \"accountEntry.calculate\",\n    \"sourceFlow\": \"Repurchase\",\n    \"client\": {\n        \"clientNumber\": 8\n    },\n    \"account\": {\n        \"accountNumber\": 30009504,\n        \"accountClassNumber\": 1,\n        \"state\": \"CA\",\n        \"accountType\": \"Interest_Bearing_Indirect\",\n        \"portfolioNumber\": 2,\n        \"oldPortfolioNumber\": 1,\n        \"interestRate\": 0.129900,\n        \"contractualRate\": 0.129900,\n        \"contractualApr\": 0.142500,\n        \"paymentFrequency\": \"Monthly\",\n        \"actualTerm\": 60,\n        \"amortizedTerm\": 60,\n        \"amountFinanced\": 18500.00,\n        \"cashPrice\": 20000.00,\n        \"downPayment\": 1500.00,\n        \"currentBalance\": 15700.00,\n        \"customers\": [\n            {\n                \"entityRef\": \"customer:primary\",\n                \"parentType\": \"Customer\",\n                \"customerType\": \"Primary_Customer\",\n                \"customerNumber\": 1001,\n                \"firstName\": \"Jane\",\n                \"lastName\": \"Doe\"\n            }\n        ],\n        \"collateral\": [],\n        \"remarkCodes\": [\"BKPT\", \"REPO\"],\n        \"customScreenFields\": []\n    }\n}","options":{"raw":{"language":"text"}}},"url":"{{account_entry_webhook_url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"schemaVersion\": \"1.0\",\n    \"requestId\": \"8f3c2a1e-4b5d-6e7f-8091-a2b3c4d5e6f7\",\n    \"status\": \"success\",\n    \"account\": {\n        \"discountBasis\": \"Amount Financed\",\n        \"discountPercent\": 0.075000,\n        \"reserveBasis\": \"Amount Financed\",\n        \"reservePercent\": 0.022500,\n        \"withholdBasis\": \"Amount Financed\",\n        \"withholdPercent\": 0.015000,\n        \"late_charge\": {\n            \"calculationMethod\": \"Flat_Rate\",\n            \"graceDays\": 7,\n            \"min\": 5.00,\n            \"max\": 75.00,\n            \"amount\": 25.00,\n            \"threshold\": null,\n            \"includePartialPayments\": null\n        },\n        \"nsf\": {\n            \"fee\": 35.00\n        },\n        \"originationFees\": [\n            {\n                \"description\": \"ACQ Fee\",\n                \"amount\": 195.00\n            },\n            {\n                \"description\": \"Other Finance Fees\",\n                \"percentage\": 0.020000\n            }\n        ],\n        \"advanceAdjustmentFees\": [\n            {\n                \"description\": \"AdvanceAdjustment Fee\",\n                \"amount\": 300.00\n            }\n        ],\n        \"remarkCodes\": [\n            \"REPO\"\n        ],\n        \"customScreenFields\": [\n            {\n                \"key\": \"StoreName\",\n                \"value\": \"Example Motors\"\n            },\n            {\n                \"key\": \"SaleAmount\",\n                \"value\": 987.65\n            }\n        ],\n        \"creditReporting\": {\n            \"reportToExperian\": \"Yes\",\n            \"reportToEquifax\": \"Yes\",\n            \"reportToTransUnion\": \"No\",\n            \"consumerComplianceCode\": \"XB\",\n            \"originalCreditor\": \"Example Auto Finance\",\n            \"originalCreditorType\": \"Automotive\",\n            \"customers\": [\n                {\n                    \"entityRef\": \"customer:primary\",\n                    \"consumerInfoIndicator\": \"T\",\n                    \"consumerInfoIndicatorDate\": \"2026-10-01\"\n                }\n            ]\n        }\n    },\n    \"errors\": []\n}"},{"id":"311ab5f7-3f59-44aa-8ace-1e983e07e6bf","name":"Account Entry Webhook - No Late Fee","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{account_entry_webhook_bearer_token}}"}],"body":{"mode":"raw","raw":"{\n    \"schemaVersion\": \"1.0\",\n    \"requestId\": \"0b6e4f2a-91c3-4d7e-a5b8-3c2d1e0f9a87\",\n    \"eventType\": \"accountEntry.calculate\",\n    \"sourceFlow\": \"webFormsCalculate\",\n    \"client\": {\n        \"clientNumber\": 8\n    },\n    \"account\": {\n        \"accountNumber\": null,\n        \"accountClassNumber\": 1,\n        \"state\": \"CA\",\n        \"accountType\": \"Interest_Bearing_Indirect\",\n        \"portfolioNumber\": 1,\n        \"interestRate\": 0.129900,\n        \"paymentFrequency\": \"Monthly\",\n        \"actualTerm\": 60,\n        \"amortizedTerm\": 60,\n        \"dealerCode\": \"DLR001\",\n        \"amountFinanced\": 18500.00,\n        \"cashPrice\": 20000.00,\n        \"downPayment\": 1500.00,\n        \"customers\": [],\n        \"collateral\": [],\n        \"remarkCodes\": [],\n        \"customScreenFields\": []\n    }\n}","options":{"raw":{"language":"text"}}},"url":"{{account_entry_webhook_url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"schemaVersion\": \"1.0\",\n    \"requestId\": \"0b6e4f2a-91c3-4d7e-a5b8-3c2d1e0f9a87\",\n    \"status\": \"success\",\n    \"account\": {\n        \"late_charge\": {\n            \"calculationMethod\": \"Flat_Rate\",\n            \"amount\": 0.00\n        },\n        \"nsf\": {\n            \"fee\": 0.00\n        }\n    },\n    \"errors\": []\n}"},{"id":"f7fe21f0-b713-4518-aaa6-aa6e03ed8fcc","name":"Account Entry Webhook - Fail","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{account_entry_webhook_bearer_token}}"},{"key":"purchaseCode","value":"{{purchase_code}}"}],"body":{"mode":"raw","raw":"{\n    \"schemaVersion\": \"1.0\",\n    \"requestId\": \"8f3c2a1e-4b5d-6e7f-8091-a2b3c4d5e6f7\",\n    \"eventType\": \"accountEntry.calculate\",\n    \"sourceFlow\": \"Repurchase\",\n    \"client\": {\n        \"clientNumber\": 8\n    },\n    \"account\": {\n        \"accountNumber\": 30009504,\n        \"portfolioNumber\": 2,\n        \"oldPortfolioNumber\": 1,\n        \"accountType\": \"Interest_Bearing_Indirect\",\n        \"currentBalance\": 15700.00,\n        \"customers\": [],\n        \"collateral\": [],\n        \"remarkCodes\": [\"BKPT\", \"REPO\"],\n        \"customScreenFields\": []\n    }\n}","options":{"raw":{"language":"text"}}},"url":"{{account_entry_webhook_url}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n    \"schemaVersion\": \"1.0\",\n    \"requestId\": \"8f3c2a1e-4b5d-6e7f-8091-a2b3c4d5e6f7\",\n    \"status\": \"error\",\n    \"account\": null,\n    \"errors\": [\n        {\n            \"code\": \"PRICING_UNAVAILABLE\",\n            \"message\": \"Unable to resolve dealer economics for this account.\"\n        }\n    ]\n}"}],"_postman_id":"3bf8e1c8-8058-41c5-a817-a579012fe2a4"}],"id":"6a9d74bc-617f-4154-ac25-e7b83d5fc426","description":"<p>Outbound webhook contracts Omega calls on the client's HTTPS endpoint.\nConfigure Indirect Account Entry Webhook in Third Party Configuration\n(production and sandbox URL / bearer key pairs). Live deployments use the\nproduction pair; non-live deployments use the sandbox pair.</p>\n<p>These requests document the JSON Omega sends and the response Omega expects.\nThey are not Omega Client API routes. Point <code>{{account_entry_webhook_url}}</code> at\nyour integration endpoint.</p>\n","_postman_id":"6a9d74bc-617f-4154-ac25-e7b83d5fc426"}]}