API doc changes
This commit is contained in:
Pramod Nuthakki
@@ -1369,6 +1369,24 @@
|
||||
<td><a href="#accountingrules_update">Update a Accounting Rule</a></td>
|
||||
<td><a href="#accountingrules_delete">Delete a Accounting Rule</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="#officeglaccount">Office GL Account Mappings</a></td>
|
||||
<td>officeglaccounts</td>
|
||||
<td><a href="#officeglaccounts_create">Create Office GL Account Mapping</a><br> </td>
|
||||
<td><a href="#officeglaccounts_list">List Journal Entries</a></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>officeglaccounts/{entryId}</td>
|
||||
<td></td>
|
||||
<td><a href="#officeglaccounts_retrieve">Retrieve a single Entry</a></td>
|
||||
<td><a href="#officeglaccounts_update">Update Office GL Account Mapping</a></td>
|
||||
<td><a href="#officeglaccounts_delete">Delete Office GL Account Mapping</a></td>
|
||||
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
@@ -28241,6 +28259,232 @@ Content-Type: application/json
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- start office gl accout mappings-->
|
||||
|
||||
<a id="officeglaccount" name="officeglaccount" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h3>Office GL Accounting Mappings</h3>
|
||||
<p>
|
||||
These are the Branch level intermediate accounts to move funds between banches
|
||||
</p>
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG">
|
||||
<td><div class="mifosXHeading2">Field Descriptions</div></td>
|
||||
</tr>
|
||||
<tr class=alt>
|
||||
<td>officeId</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class=fielddesc>The identifier of the office (
|
||||
cost center) at which the financial activity
|
||||
occurs</td>
|
||||
</tr>
|
||||
<tr class=alt>
|
||||
<td>liabilityTransferInSuspenseAccountId</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class=fielddesc>The identifier of the liability account (
|
||||
Ledger Account) against which transfer journal entry
|
||||
should made
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="officeglaccounts_list" name="officeglaccounts_list" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>List Office Level GL Account Mappings</h4>
|
||||
<p>The <i>list</i> of Account Mapping entries through <b>pagination</b> and <b>sorting</b>.</p>
|
||||
<h5>Optional Arguments</h5>
|
||||
<dl class="argument-list">
|
||||
<dt>offset</dt>
|
||||
<dd>
|
||||
Integer <span>optional</span>, defaults to 0
|
||||
</dd>
|
||||
<dd>Indicates from what result to start from.</dd>
|
||||
|
||||
<dt>limit</dt>
|
||||
<dd>
|
||||
Integer <span>optional</span>, defaults to 200
|
||||
</dd>
|
||||
<dd>Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1</dd>
|
||||
|
||||
<dt>orderBy</dt>
|
||||
<dd>
|
||||
String <span>optional</span>, one of <span>displayName, accountNo, officeId, officeName</span>
|
||||
</dd>
|
||||
<dd>Orders the results by the field indicated.</dd>
|
||||
|
||||
<dt>sortBy</dt>
|
||||
<dd>
|
||||
String <span>optional</span>, one of <span>ASC, DESC</span>
|
||||
</dd>
|
||||
<dd>Indicates what way to order results if <i>orderBy</i> is used.</dd>
|
||||
|
||||
<dt>officeId</dt>
|
||||
<dd>
|
||||
Integer <span>optional</span>
|
||||
</dd>
|
||||
<dd>Provides ability to restrict list of centers returned based on the office there associated with.</dd>
|
||||
|
||||
|
||||
</dl>
|
||||
<p>Example Requests:</p>
|
||||
<div class=apiClick>officeglaccounts</div>
|
||||
<br>
|
||||
<div class=apiClick>officeglaccounts?orderBy=id&sortOrder=DESC</div>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">
|
||||
GET https://DomainName/api/v1/officeglaccounts
|
||||
</code>
|
||||
<code class="method-response">
|
||||
|
||||
{
|
||||
"totalFilteredRecords": 1,
|
||||
"pageItems": [
|
||||
{
|
||||
"id": 1,
|
||||
"officeData": {
|
||||
"id": 2,
|
||||
"name": "Office_BX38"
|
||||
},
|
||||
"glAccountData": {
|
||||
"id": 29,
|
||||
"name": "ACCOUNT_NAME_P9UWO",
|
||||
"glCode": "LIABILITY_7E1401198314394"
|
||||
}
|
||||
}]}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="officeglaccounts_create" name="officeglaccounts_create" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Create Office GL Account</h4>
|
||||
<table class=matrixHeading>
|
||||
<tr class="matrixHeadingBG">
|
||||
<td><div class="mifosXHeading2">Mandatory Fields</div></td>
|
||||
</tr>
|
||||
<tr class=alt>
|
||||
<td>officeId, liabilityTransferInSuspenseAccountId
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
<br />
|
||||
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">
|
||||
POST https://DomainName/api/v1/officeglaccounts
|
||||
</code>
|
||||
<code class="method-request">
|
||||
POST officeglaccounts
|
||||
Content-Type: application/json
|
||||
Request Body:
|
||||
{
|
||||
"officeId": 1,
|
||||
"liabilityTransferInSuspenseAccountId" : 2
|
||||
}
|
||||
</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"resourceId": 1
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="officeglaccounts_update" name="officeglaccounts_update" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Update Office GL Account Mappings</h4>
|
||||
<p>
|
||||
the API Updates the mapping GL Accoiunt for office.
|
||||
<br>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">
|
||||
POST https://DomainName/api/v1/officeglaccounts/1
|
||||
</code>
|
||||
<code class="method-request">
|
||||
POST officeglaccounts
|
||||
Content-Type: application/json
|
||||
Request Body:
|
||||
{
|
||||
"liabilityTransferInSuspenseAccountId": 2
|
||||
}
|
||||
</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"liabilityTransferInSuspenseAccountId": 2
|
||||
}
|
||||
</code>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a id="officeglaccounts_retrieve" name="officeglaccounts_retrieve"
|
||||
class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Retrieve a single Entry</h4>
|
||||
<p>Example Requests:</p>
|
||||
<div class=apiClick>officeglaccounts/1</div>
|
||||
<br>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">
|
||||
GET https://DomainName/api/v1/officeglaccounts/{entryId}
|
||||
</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"id": 1,
|
||||
"officeData": {
|
||||
"id": 2,
|
||||
"name": "Office_BX38"
|
||||
},
|
||||
"glAccountData": {
|
||||
"id": 29,
|
||||
"name": "ACCOUNT_NAME_P9UWO",
|
||||
"glCode": "LIABILITY_7E1401198314394"
|
||||
}
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a id="officeglaccounts_delete" name="officeglaccounts_delete"
|
||||
class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
<div class="method-description">
|
||||
<h4>Delete Office GL Mapping</h4>
|
||||
</div>
|
||||
<div class="method-example">
|
||||
<code class="method-declaration">
|
||||
GET https://DomainName/api/v1/officeglaccounts/{mappingId}
|
||||
</code>
|
||||
<code class="method-request">
|
||||
POST officeglaccounts/C1MAE935K0IAEYA?command=reverse
|
||||
Content-Type: application/json
|
||||
</code>
|
||||
<code class="method-response">
|
||||
{
|
||||
"resourceId": "2"
|
||||
}
|
||||
</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<!-- start of Search API doc -->
|
||||
<a id="search" name="search" class="old-syle-anchor"> </a>
|
||||
<div class="method-section">
|
||||
|
||||
Reference in New Issue
Block a user