--- title: "Retrieve Document Top Levels By Code" slug: "retrieve-document-top-levels-by-code" updated: 2026-05-26T12:53:14Z published: 2026-05-26T12:53:48Z canonical: "developers.cmicglobal.com/retrieve-document-top-levels-by-code" --- > ## Documentation Index > Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Document Top Levels By Code Get/glrestapi/rest/v1/gldoctoplevel # GL Document Print — Top Level ## Overview Generates and retrieves GL financial document print output at the top level. All write operations (POST, PATCH, DELETE) on the collection are disabled — this endpoint is **read-only**. --- ## Endpoint | Property | Value | | --- | --- | | URL | `{base_url}/glrestapi/rest/v1/gldoctoplevel` | | Media Type | `application/json` | | DB Table | `DA.GL#DOCPRINT` | --- ## Supported Operations | Method | URL | Description | | --- | --- | --- | | GET | `/glrestapi/rest/v1/gldoctoplevel` | Generate and retrieve report data | --- ## GET — Generate and Retrieve Report ### Query Parameters | Parameter | Type | Required | Default | Description | | --- | --- | --- | --- | --- | | `finder` | String | No | — | Named finder to apply. Use `selectTopLevel` to generate the report | | `offset` | Integer | No | 0 | Pagination offset (starting record index) | | `limit` | Integer | No | 1000 | Maximum number of records to return | | `totalResults` | Boolean | No | false | Include total record count in the response envelope | > **Note:** A GET without a `finder` returns whatever rows currently exist in `DA.GL#DOCPRINT` for the session. Always use `finder=selectTopLevel` to trigger fresh report generation. ### Named Finder — `selectTopLevel` Triggers `da.dbk_gl_docfrm.populate_doc_view()`, then filters results by the requested `documentCode`. | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `documentCode` | `java.lang.String` | **Yes** | Document code (e.g. `BS`, `IS`) | | `runYear` | `java.math.BigDecimal` | **Yes** | Fiscal year for the report (e.g. `2026`) | | `runPeriod` | `java.math.BigDecimal` | **Yes** | Fiscal period for the report (e.g. `3`) | | `suppressDetailLines` | `java.lang.String` | **Yes** | `Y` / `N` — suppress detail lines in output | | `suppressTotalLines` | `java.lang.String` | **Yes** | `Y` / `N` — suppress total lines in output | **Finder URL syntax:** ``` ?finder=selectTopLevel;documentCode=,runYear=,runPeriod=,suppressDetailLines=,suppressTotalLines= ``` **Example** ``` ?finder=selectTopLevel;documentCode=000A, runPeriod=1, runYear=2026, suppressTotalLines=Y, suppressDetailLines=Y ``` ### Response — Status Codes | Code | Description | | --- | --- | | 200 | Success — report data returned | | 401 | Unauthorized — missing or invalid credentials | | 500 | Internal server error / stored procedure failure | ### Response Body Structure ```json { "items": [ { "R01": "125000.00", "R02": "130000.00", "R03": null, "R04": null, "R05": null, "R06": null, "R07": null, "R08": null, "R09": null, "R10": null, "R11": null, "R12": null, "R13": null, "R14": null, "R15": null, "R16": null, "R17": null, "R18": null, "R19": null, "R20": null, "RAccCode": "1000", "RAccSeq": 1, "RDapLineCode": "D", "RDocCode": "BS", "RDocDesc": "Balance Sheet", "RJobid": 12345, "RRunPeriod": 3, "RRunYear": 2026, "RSeqNum": 10, "RTotalNum": "0", "RType": 1 } ], "count": 1, "hasMore": false, "limit": 1000, "offset": 0 } ``` > **Hidden from payload** (PAYLOADHINT = Hide): `RRowid`, `RSuppressDetailLines`, `RSuppressTotalLines`. ### Response Attributes | Attribute | Java Type | DB Column | DB Type | Description | | --- | --- | --- | --- | --- | | `R01` | `java.lang.String` | `R_01` (VARCHAR2 21) | VARCHAR2 | Report column 1 value | | `R02` | `java.lang.String` | `R_02` (VARCHAR2 21) | VARCHAR2 | Report column 2 value | | `R03` | `java.lang.String` | `R_03` (VARCHAR2 21) | VARCHAR2 | Report column 3 value | | `R04` | `java.lang.String` | `R_04` (VARCHAR2 21) | VARCHAR2 | Report column 4 value | | `R05` | `java.lang.String` | `R_05` (VARCHAR2 21) | VARCHAR2 | Report column 5 value | | `R06` | `java.lang.String` | `R_06` (VARCHAR2 21) | VARCHAR2 | Report column 6 value | | `R07` | `java.lang.String` | `R_07` (VARCHAR2 21) | VARCHAR2 | Report column 7 value | | `R08` | `java.lang.String` | `R_08` (VARCHAR2 21) | VARCHAR2 | Report column 8 value | | `R09` | `java.lang.String` | `R_09` (VARCHAR2 21) | VARCHAR2 | Report column 9 value | | `R10` | `java.lang.String` | `R_10` (VARCHAR2 21) | VARCHAR2 | Report column 10 value | | `R11` | `java.lang.String` | `R_11` (VARCHAR2 21) | VARCHAR2 | Report column 11 value | | `R12` | `java.lang.String` | `R_12` (VARCHAR2 21) | VARCHAR2 | Report column 12 value | | `R13` | `java.lang.String` | `R_13` (VARCHAR2 21) | VARCHAR2 | Report column 13 value | | `R14` | `java.lang.String` | `R_14` (VARCHAR2 21) | VARCHAR2 | Report column 14 value | | `R15` | `java.lang.String` | `R_15` (VARCHAR2 21) | VARCHAR2 | Report column 15 value | | `R16` | `java.lang.String` | `R_16` (VARCHAR2 21) | VARCHAR2 | Report column 16 value | | `R17` | `java.lang.String` | `R_17` (VARCHAR2 21) | VARCHAR2 | Report column 17 value | | `R18` | `java.lang.String` | `R_18` (VARCHAR2 21) | VARCHAR2 | Report column 18 value | | `R19` | `java.lang.String` | `R_19` (VARCHAR2 21) | VARCHAR2 | Report column 19 value | | `R20` | `java.lang.String` | `R_20` (VARCHAR2 21) | VARCHAR2 | Report column 20 value | | `RAccCode` | `java.lang.String` | `R_ACC_CODE` (VARCHAR2 16) | VARCHAR2 | Account code for the row | | `RAccSeq` | `java.math.BigDecimal` | `R_ACC_SEQ` (NUMBER) | NUMBER | Account sequence number | | `RDapLineCode` | `java.lang.String` | `R_DAP_LINE_CODE` (VARCHAR2 1) | VARCHAR2 | Document row line code | | `RDocCode` | `java.lang.String` | `R_DOC_CODE` (VARCHAR2 256) | VARCHAR2 | Document code (primary key component) | | `RDocDesc` | `java.lang.String` | `R_DOC_DESC` (VARCHAR2 80) | VARCHAR2 | Document description | | `RJobid` | `java.math.BigDecimal` | `R_JOBID` (NUMBER) | NUMBER | Job ID assigned to this report generation run | | `RRunPeriod` | `java.math.BigDecimal` | `R_RUN_PERIOD` (NUMBER) | NUMBER | Fiscal period used for report generation | | `RRunYear` | `java.math.BigDecimal` | `R_RUN_YEAR` (NUMBER) | NUMBER | Fiscal year used for report generation | | `RSeqNum` | `java.math.BigDecimal` | `R_SEQ_NUM` (NUMBER) | NUMBER | Row sequence number | | `RTotalNum` | `java.lang.String` | `R_TOTAL_NUM` (VARCHAR2 1) | VARCHAR2 | Total number reference flag | | `RType` | `java.math.BigDecimal` | `R_TYPE` (NUMBER) | NUMBER | Row type | > **Hidden attributes** (present in DB/entity, not exposed in REST payload): --- SecurityHTTPType basic Basic authentication Query parametersfinderstringExampleselectTopLevel;documentCode=000A, runPeriod=1, runYear=2026, suppressTotalLines=1, suppressDetailLines=1 limitintegerExample500 offsetintegerExample0 totalResultsbooleanExampletrue Responses200 OK HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourcecollection+json example-0 Successful Response ```json { "items": [], "totalResults": 0, "count": 0, "hasMore": false, "limit": 2, "offset": 0, "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoctoplevel", "name": "gldoctoplevel", "kind": "collection" } ] } ``` example-1 Successful Response ```json { "items": [], "totalResults": 0, "count": 0, "hasMore": false, "limit": 2, "offset": 0, "links": [ { "rel": "self", "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoctoplevel", "name": "gldoctoplevel", "kind": "collection" } ] } ``` object