GET v1/Companies({CompanyId})/Accounts({GLAccountId})
Returns Details for a General Ledger Account
Information:
Base URL:
https://api.covasoft.net/generalledger
Example of a call would be:
https://api.covasoft.net/generalledger/v1/Companies({CompanyId})/Accounts({GLAccountId})
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
| GLAccountId |
The GL Account Id Guid you want to get Details |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Details for a General Ledger Account
GlAccountDetailsReturn| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| AccountName | string |
None. |
|
| AccountNumber | string |
None. |
|
| AccountCategory | string |
None. |
|
| SubCategory | string |
None. |
|
| CurrencyCode | string |
None. |
|
| IsEnabled | boolean |
None. |
|
| Description | string |
None. |
|
| CustomProperties | Object |
None. |
|
| DateCreatedUTC | date |
None. |
|
| CreatedByUserID | integer |
None. |
|
| CreatedByUserName | string |
None. |
|
| DateUpdatedUTC | date |
None. |
|
| UpdatedByUserID | integer |
None. |
|
| UpdatedByUserName | string |
None. |
|
| Version | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "57ee34ea-e192-415e-8aa5-9aef1fd9f3c6",
"AccountName": "sample string 2",
"AccountNumber": "sample string 3",
"AccountCategory": "sample string 4",
"SubCategory": "sample string 5",
"CurrencyCode": "sample string 6",
"IsEnabled": true,
"Description": "sample string 8",
"CustomProperties": {},
"DateCreatedUTC": "2024-11-25T11:36:33.3262949+00:00",
"CreatedByUserID": 11,
"CreatedByUserName": "sample string 12",
"DateUpdatedUTC": "2024-11-25T11:36:33.3262949+00:00",
"UpdatedByUserID": 14,
"UpdatedByUserName": "sample string 15",
"Version": 16
}