GET v1/Companies({CompanyId})/Transactions?filter={filter}
Returns General Ledger Transactions by Date Range
Information:
Base URL:
https://api.covasoft.net/generalledger
Example of a call would be:
https://api.covasoft.net/generalledger/v1/Companies({CompanyId})/Transactions?$filter=TransactionDateUTC ge datetime'2019-09-11T00:00:00.000' and TransactionDateUTC le datetime'2019-09-12T00:00:00.000' & $skip=0 & $top=200
Odata Filters
Required: filter=TransactionDateUTC ge datetime'{UTCdatetime}' and TransactionDateUTC le datetime'{UTCdatetime}'
This can be no more than a 30 day span
Normal Odata pagings with $top & $skip
Max $top is 200 records
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
The unique Company Id that was provided in your onboarding pacakage. |
integer |
Required |
filter |
The Odata filter applied to this call, see Odata filter section above |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
General Ledger Transactions by Date Range
Collection of GlTransactionsByDateRangeReturnName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
TransactionDateUTC | date |
None. |
|
CreatedByUserID | integer |
None. |
|
CreatedByUserName | string |
None. |
|
Entries | Collection of GLEntry |
None. |
Response Formats
application/json, text/json
[ { "Id": "7ae0054e-521b-4b7c-8f69-8d0c924c2c99", "TransactionDateUTC": "2024-11-07T08:47:16.9782898+00:00", "CreatedByUserID": 3, "CreatedByUserName": "sample string 4", "Entries": [ { "LineNumber": 1, "AccountID": "6f4f135d-bbd2-47cb-a3f0-61b86424146b", "EntityID": 3, "Debit": 4.1, "Credit": 5.1, "Memo": "sample string 6", "ReferenceID": "d4b937d1-7958-44b1-be90-9428bcdbb5ae", "ReferenceType": "sample string 8", "CustomProperties": { "CatalogItemID": "1ee8f610-bf57-4399-8a2a-1c02b3e9b3ef", "SupplierID": 1, "PaymentMethodID": 2, "PaymentID": "b8f88466-c68a-4a33-9fe2-d67c0d4320e9", "TaxID": "719e56cd-33f6-43e0-a43a-64b33c9bc1d4" } }, { "LineNumber": 1, "AccountID": "6f4f135d-bbd2-47cb-a3f0-61b86424146b", "EntityID": 3, "Debit": 4.1, "Credit": 5.1, "Memo": "sample string 6", "ReferenceID": "d4b937d1-7958-44b1-be90-9428bcdbb5ae", "ReferenceType": "sample string 8", "CustomProperties": { "CatalogItemID": "1ee8f610-bf57-4399-8a2a-1c02b3e9b3ef", "SupplierID": 1, "PaymentMethodID": 2, "PaymentID": "b8f88466-c68a-4a33-9fe2-d67c0d4320e9", "TaxID": "719e56cd-33f6-43e0-a43a-64b33c9bc1d4" } } ] }, { "Id": "7ae0054e-521b-4b7c-8f69-8d0c924c2c99", "TransactionDateUTC": "2024-11-07T08:47:16.9782898+00:00", "CreatedByUserID": 3, "CreatedByUserName": "sample string 4", "Entries": [ { "LineNumber": 1, "AccountID": "6f4f135d-bbd2-47cb-a3f0-61b86424146b", "EntityID": 3, "Debit": 4.1, "Credit": 5.1, "Memo": "sample string 6", "ReferenceID": "d4b937d1-7958-44b1-be90-9428bcdbb5ae", "ReferenceType": "sample string 8", "CustomProperties": { "CatalogItemID": "1ee8f610-bf57-4399-8a2a-1c02b3e9b3ef", "SupplierID": 1, "PaymentMethodID": 2, "PaymentID": "b8f88466-c68a-4a33-9fe2-d67c0d4320e9", "TaxID": "719e56cd-33f6-43e0-a43a-64b33c9bc1d4" } }, { "LineNumber": 1, "AccountID": "6f4f135d-bbd2-47cb-a3f0-61b86424146b", "EntityID": 3, "Debit": 4.1, "Credit": 5.1, "Memo": "sample string 6", "ReferenceID": "d4b937d1-7958-44b1-be90-9428bcdbb5ae", "ReferenceType": "sample string 8", "CustomProperties": { "CatalogItemID": "1ee8f610-bf57-4399-8a2a-1c02b3e9b3ef", "SupplierID": 1, "PaymentMethodID": 2, "PaymentID": "b8f88466-c68a-4a33-9fe2-d67c0d4320e9", "TaxID": "719e56cd-33f6-43e0-a43a-64b33c9bc1d4" } } ] } ]