Retrieve GL Ledgers By Code
- 06 Jan 2025
- 6 Minutes to read
- Print
- DarkLight
Retrieve GL Ledgers By Code
- Updated on 06 Jan 2025
- 6 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/glrestapi/rest/v1/rtigledgerwithyearperiod
Overview
This endpoint allows for the retrieval of General Ledger (GL) records by their unique ledger code. The General Ledger is designed to maintain comprehensive financial records, including companies, departments, and accounts
Notes
To efficiently query this view, it is essential to use finders, as the view supports querying only through primary keys such as 'company code' and 'account code'. This design ensures precise and targeted data retrieval based on key identifiers
UI Navigation
Financial > General Ledger
Reference Article
[https://docs.cmicglobal.com/general_ledger/GL_R12.pdf\](https://docs.cmicglobal.com/general_ledger/GL_R12.pdf)
Query Standards
| Key | Recommended | Description |
|---|---|---|
| finder | Yes | Filters data based on attributes. See finder details below. Finders can be combined using a comma delimiter between parameters that implies an "and" statement. For more information on using the finder functionality please see Best Practice | Data Filtering requirements |
| limit | Yes | A limit restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, then the framework will return all available resources. For additional information on using the limit functionality please visit Best Practice | Data Filtering requirements |
| offset | Yes | The offset skips a specified number of items in a data list before it starts showing results. For example, if you set an offset of 10, it skips the first 10 items and begins showing from the 11th item. For additional information on using Offset functionality please visit Best Practice | Data Filtering requirements |
| orderBy | Yes | The orderBy attribute retrieves rows using an order ensuring the response payload displays data in the order supplied in the URL parameter using the GET method. For more information on using orderBy functionality please visit Best Practice | Data Filtering requirements |
rtigledgerwithyearperiod Finders
| Finder | Parameter | Data Type | Data Length | Description | Example |
|---|---|---|---|---|---|
| glSummary | auditDate | datetime | Find specific records for a specific audit date. This finder will retrieve records that have an audit date on or after the specified date. Must be used in tandem with the Company Code, From Account Code, and Fiscal Year | /glrestapi/rest/v1/rtigledgerwithyearperiod?finder=glSummary;companyCode=ZZ, fromAccountCode=1000, fiscalYear=2024, auditDate=2024-12-12 | |
| glSummary | companyCode | string | Find specific records for a given company based on the Company Code. Must be used in tandem with the From Account Code, and Fiscal Year | /glrestapi/rest/v1/rtigledgerwithyearperiod?finder=glSummary;companyCode=ZZ, fromAccountCode=1000, fiscalYear=2024 | |
| glSummary | departmentCode | string | Find specific records based on the department code. Must be used in tandem with the Company Code, From Account Code, and Fiscal Year | /glrestapi/rest/v1/rtigledgerwithyearperiod?finder=glSummary;departmentCode=50, companyCode=ZZ, fromAccountCode=1000, fiscalYear=2024 | |
| glSummary | fiscalPeriod | string | Find specific records based on the Fiscal Period. Must be used in tandem with the Company Code, From Account Code, and Fiscal Year | /glrestapi/rest/v1/rtigledgerwithyearperiod?finder=glSummary;fiscalPeriod=4, companyCode=ZZ, fromAccountCode=1000, fiscalYear=2024 | |
| glSummary | fiscalQuarter | string | Find specific records based on the Fiscal Quarter. Must be used in tandem with the Company Code, From Account Code, and Fiscal Year | /glrestapi/rest/v1/rtigledgerwithyearperiod?finder=glSummary;fiscalQuarter=1, companyCode=ZZ, fromAccountCode=1000, fiscalYear=2023 | |
| glSummary | fiscalYear | string | Find specific records based on the Fiscal Year. Must be used in tandem with the Company Code and the From Account Code | glrestapi/rest/v1/rtigledgerwithyearperiod?finder=glSummary;fiscalYear=2023, companyCode=ZZ, fromAccountCode=1000 | |
| glSummary | fromAccountCode | string | Find specific records based on the From Account Code. Must be used in tandem with the Company Code and Fiscal Year | glrestapi/rest/v1/rtigledgerwithyearperiod?finder=glSummary;fiscalYear=2023, companyCode=ZZ, fromAccountCode=1000 | |
| glSummary | toAccountCode | string | Find specific records based on the To Account Field. Must be used in tandem with the Company Code, From Account Code, and Fiscal Year | glSummary;toAccountCode=400, companyCode=ZZ, fromAccountCode=100, fiscalYear=2023 |
rtigledgerwithyearperiod Attributes
| CMiC UI Fieldname | Object | Name | Description | Type | Data Length | Examples |
|---|---|---|---|---|---|---|
| Account Code | rtigledgerwithyearperiod | GlAccCode | The General Ledger (GL) account code to which this transaction line item is posted. Used to identify the specific G/L account in the chart of accounts. | string | 16 | 50040 |
| Account Description | rtigledgerwithyearperiod | GlAcctDescription | A descriptive name for the GL account. Helps users recognize the account’s purpose in inquiries and reports. This is a description field can be found on different programs header record in different modules like AP, AR, PO, SC RFP to indentify the type of transactions | string | 500 | |
| Adjustment Period | rtigledgerwithyearperiod | GlAdjPer | The period number dedicated to adjustment entries (e.g., period 13 for year-end adjustments). Used primarily in year-end closing or audit adjustments. | integer | 2 | |
| Adjustment Transaction Flag | rtigledgerwithyearperiod | GlAdjTransFlag | Indicates whether the line is part of an adjustment transaction created by the currency evaluation program (e.g., "Y") or a regular transaction ("N"). This helps distinguish between normal postings and special adjusting entries. | string | 1 | Y |
| Adjustment Year | rtigledgerwithyearperiod | GlAdjYr | The fiscal year used for adjustment postings if different from the standard fiscal year. Supports year-end adjustments that occur after the main year has closed. | integer | 4 | 2024 |
| Amount | rtigledgerwithyearperiod | GlAmt | The net amount of the transaction line. Whether this represents a debit or credit depends on the associated Debit/Credit fields. Critical for financial balances and reporting. | number | 18 | 21824 |
| Batch Number | rtigledgerwithyearperiod | GlBchNum | The batch number associated with this transaction. Batches group transactions for posting and audit control. Useful for tracking the posting process and reviewing unposted or posted batches. | integer | 15 | 5730280 |
| Company Code | rtigledgerwithyearperiod | GlCompCode | The CMiC company code under which this transaction was recorded. Enables multi-company accounting by segregating ledgers per company/entity. | string | 8 | 1 |
| Credit Amount | rtigledgerwithyearperiod | GlCreditAmt | The credit portion of this transaction line if applicable. If populated, it indicates the amount credited to the specified G/L account. | number | 18 | |
| Currency Code | rtigledgerwithyearperiod | GlCurrCode | The currency in which the transaction was recorded. Important for multi-currency environments, enabling currency-specific inquiries and consolidation. | string | 3 | USD |
| Debit Amount | rtigledgerwithyearperiod | GlDebitAmt | The debit portion of this transaction line if applicable. If populated, it indicates the amount debited to the specified G/L account. | number | 18 | |
| Department Code | rtigledgerwithyearperiod | GlDeptCode | Department identifier if the G/L account is departmentalized. Facilitates departmental reporting and cost center analysis. | string | 6 | 113 |
| Data Source Code | rtigledgerwithyearperiod | GlDsrcCode | A code indicating the origin of the transaction (e.g., a particular sub-module). Useful for tracing back transactions to their source system or process. Examples include SC-Subcontract; AP-Accounts Payable; JC-Job Cost; JB-Job Billing; PY-Payroll; AR-Accounts Receivable | string | 2 | EM |
| Fiscal Period | rtigledgerwithyearperiod | GlFiscalPeriod | The fiscal period number (e.g., 1 to 12) in which the transaction is posted. Essential for period-based reporting (monthly, quarterly, or yearly). | integer | 2 | 1 |
| Fiscal Quarter | rtigledgerwithyearperiod | GlFiscalQuarter | The fiscal quarter (1 through 4) associated with the posting period. Aids in quarterly financial analysis and statutory reporting. | number | 1 | |
| Fiscal Year | rtigledgerwithyearperiod | GlFiscalYear | The fiscal year the transaction belongs to. Key for annual reporting, budgeting, and year-to-date analyses. | integer | 4 | 2022 |
| Invoice Date | rtigledgerwithyearperiod | GlInvDate | This date is used to get the correct reporting currency conversion rate when amounts are being recalculated by balance recalculation program | datetime | ||
| Job Code | rtigledgerwithyearperiod | GlJobCode | populated from the journal line transaction, a job code if related to job costing. Integrates with Job Cost module to track expenses/income at the project level. | string | 10 | 51188 |
| Number | rtigledgerwithyearperiod | GlNum | The line transaction for this ledger line item. Used to link multiple detail lines to a single record or to reference back to source documents. This number is unique per batch. | integer | 11 | 3918624 |
| Oracle Sequence | rtigledgerwithyearperiod | GlOraseq | An oraseq is a number (an oracle sequence) that uniquely describes this transaction line item and the specified module. This is a unique line sequence number. | number | 1.08E+09 | |
| Post Date | rtigledgerwithyearperiod | GlPostDate | The date the transaction was committed to the G/L. Determines when the transaction officially affects financial statements and period balances. | datetime | 2022-01-31T00:00:00-05:00 | |
| Reference Code | rtigledgerwithyearperiod | GlRefCode | A user-defined reference or document number associated with the transaction. Helpful for cross-referencing checks, invoices, or other documents for reconciliation. | string | 25 | 51188 |
| Source Code | rtigledgerwithyearperiod | GlSrcCode | A descriptive code providing context about the source or nature of the transaction. Useful for inquiry screens and reports to understand the transaction’s purpose. | string | 16 | 1001.01 |
| Source Description | rtigledgerwithyearperiod | GlSrcDesc | A descriptive field providing context about the source or nature of the transaction. Useful for inquiry screens and reports to understand the transaction’s purpose. Frequently used to include information regarding vendor codes and customer codes. | string | 30 | CAT Excavator 336 |
| Transaction Number | rtigledgerwithyearperiod | GlTransNum | A numeric identifier assigned by the system linking this entry to a particular transaction event. This number is unique per batch. It can be used to group multiple line items into one logical transaction for audit or reporting purposes. | integer | 11 | 118 |
| Transaction Type | rtigledgerwithyearperiod | GlTransType | A code indicating the type of transaction (e.g., JE = Journal Entry, AP = Accounts Payable). Classifies transactions to streamline reporting and inquiries. Transacion Type (ENTRY or PAYMENT) used in Exchange Rate function to determine rates | string | 7 |
Security
HTTP
Type basic
Basic authentication
Query parameters
finder
string
ExampleglSummary;companyCode=001,departmentCode=00,fromAccountCode=20059,toAccountCode=20059,fiscalYear=2021,fiscalQuarter=1,fiscalPeriod=1,auditDate=2024-01-01
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
ExampleTrue
orderBy
string
ExampleGlFiscalYear:desc
Responses
200
Successful response