Retrieve GL Documents By Code
- 20 Mar 2024
- 1 Minute to read
- Print
- DarkLight
Retrieve GL Documents By Code
- Updated on 20 Mar 2024
- 1 Minute to read
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
Get
/glrestapi/rest/v1/gldocument
Query Standards
Finder
Following row finders are available for data filtering and optimizing request performance.
- Select Document
- By UUID
Select Document
Recommended finder parameters. Refer to Query Parameters for example.
| Parameter | Description | Sample |
|---|---|---|
| documentCode | Document Code | BALANCE |
By UUID
This is an optional finder for querying a specific Department by row ID.
| Parameter | Description | Sample |
|---|---|---|
| /VUUID | The VUuid attribute is the Unique row ID | /glrestapi/rest/v1/gldocument/EA02BA00A0C88811E053B08610ACE770 |
Security
HTTP
Type basic
Basic authentication
Query parameters
finder
string
ExampleselectDocument;documentCode=BALANCE
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleDocName:desc
Responses
200
OK
Headers
Content-Type
string
{
"items": [
{
"DocCatCode": "BS",
"DocCatName": "Balance Sheet",
"DocCode": "BALANCE",
"DocCompCode": null,
"DocCon2Code": "SOL",
"DocConschartCode": "CMIC",
"DocConschartName": "CMiC Chart of Accounts",
"DocCtrlAccFlag": "N",
"DocCurrCode": null,
"DocDesc": "CMiC Cloud Inc.",
"DocDesc2": "Consolidated Balance Sheet",
"DocDesc3": "as at October 31, 2021",
"DocDesc4": null,
"DocInterCompAccFlag": "Y",
"DocIuCreateDate": "2014-04-25T18:39:43Z",
"DocIuCreateUser": "ADWAIT",
"DocIuUpdateDate": "2021-09-29T17:54:31Z",
"DocIuUpdateUser": "JONATHAN",
"DocName": "Balance Sheet - Consolidated",
"DocSeqtypeCode": "A",
"DocSuprDetCode": null,
"DocSuprTtlCode": null,
"DocTypeCode": "T",
"DocVUuid": "EA02BA00A0C88811E053B08610ACE770",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocument/EA02BA00A0C88811E053B08610ACE770",
"name": "gldocument",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocument/EA02BA00A0C88811E053B08610ACE770",
"name": "gldocument",
"kind": "item"
}
]
}
],
"totalResults": 1,
"count": 1,
"hasMore": false,
"limit": 2,
"offset": 0,
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocument",
"name": "gldocument",
"kind": "collection"
}
]
}object