From c7e7a00071acaca343d6bbb66f0c447d1279d553 Mon Sep 17 00:00:00 2001 From: Pramod Nuthakki Date: Wed, 28 May 2014 00:17:58 +0530 Subject: [PATCH] API doc changes --- api-docs/apiLive.htm | 244 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 244 insertions(+) diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm index 11e1a2e41..be06e7613 100644 --- a/api-docs/apiLive.htm +++ b/api-docs/apiLive.htm @@ -1369,6 +1369,24 @@ Update a Accounting Rule Delete a Accounting Rule + + Office GL Account Mappings + officeglaccounts + Create Office GL Account Mapping
+ List Journal Entries + + + + + + officeglaccounts/{entryId} + + Retrieve a single Entry + Update Office GL Account Mapping + Delete Office GL Account Mapping + + + @@ -28241,6 +28259,232 @@ Content-Type: application/json + + +  +
+
+

Office GL Accounting Mappings

+

+ These are the Branch level intermediate accounts to move funds between banches +

+ + + + + + + + + + + + + + + + +
Field Descriptions
officeId
The identifier of the office ( + cost center) at which the financial activity + occurs
liabilityTransferInSuspenseAccountId
The identifier of the liability account ( + Ledger Account) against which transfer journal entry + should made +
+
+
+ +   +
+
+

List Office Level GL Account Mappings

+

The list of Account Mapping entries through pagination and sorting.

+
Optional Arguments
+
+
offset
+
+ Integer optional, defaults to 0 +
+
Indicates from what result to start from.
+ +
limit
+
+ Integer optional, defaults to 200 +
+
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
+ +
orderBy
+
+ String optional, one of displayName, accountNo, officeId, officeName +
+
Orders the results by the field indicated.
+ +
sortBy
+
+ String optional, one of ASC, DESC +
+
Indicates what way to order results if orderBy is used.
+ +
officeId
+
+ Integer optional +
+
Provides ability to restrict list of centers returned based on the office there associated with.
+ + +
+

Example Requests:

+
officeglaccounts
+
+
officeglaccounts?orderBy=id&sortOrder=DESC
+
+
+ +GET https://DomainName/api/v1/officeglaccounts + + + +{ + "totalFilteredRecords": 1, + "pageItems": [ + { + "id": 1, + "officeData": { + "id": 2, + "name": "Office_BX38" + }, + "glAccountData": { + "id": 29, + "name": "ACCOUNT_NAME_P9UWO", + "glCode": "LIABILITY_7E1401198314394" + } + }]} + +
+
+ +   +
+
+

Create Office GL Account

+ + + + + + + + +
Mandatory Fields
officeId, liabilityTransferInSuspenseAccountId +
+
+ +
+
+ +POST https://DomainName/api/v1/officeglaccounts + + +POST officeglaccounts +Content-Type: application/json +Request Body: +{ +"officeId": 1, +"liabilityTransferInSuspenseAccountId" : 2 +} + + +{ + "resourceId": 1 +} + +
+
+ +   +
+
+

Update Office GL Account Mappings

+

+ the API Updates the mapping GL Accoiunt for office. +
+

+ +
+
+ +POST https://DomainName/api/v1/officeglaccounts/1 + + +POST officeglaccounts +Content-Type: application/json +Request Body: +{ +"liabilityTransferInSuspenseAccountId": 2 +} + + +{ + "liabilityTransferInSuspenseAccountId": 2 +} + + +
+
+ + +   +
+
+

Retrieve a single Entry

+

Example Requests:

+
officeglaccounts/1
+
+
+
+ +GET https://DomainName/api/v1/officeglaccounts/{entryId} + + +{ + "id": 1, + "officeData": { + "id": 2, + "name": "Office_BX38" + }, + "glAccountData": { + "id": 29, + "name": "ACCOUNT_NAME_P9UWO", + "glCode": "LIABILITY_7E1401198314394" + } +} + +
+
+ +   +
+
+

Delete Office GL Mapping

+
+
+ +GET https://DomainName/api/v1/officeglaccounts/{mappingId} + + +POST officeglaccounts/C1MAE935K0IAEYA?command=reverse +Content-Type: application/json + + +{ + "resourceId": "2" +} + +
+
+ +