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 GlTransactionsByDateRangeReturn

Name	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

Sample:

[
  {
    "Id": "b0d54fc0-7459-4f59-85c8-8f99fcb81f17",
    "TransactionDateUTC": "2024-11-25T11:37:51.9007016+00:00",
    "CreatedByUserID": 3,
    "CreatedByUserName": "sample string 4",
    "Entries": [
      {
        "LineNumber": 1,
        "AccountID": "3c997301-727f-45a3-b4e2-375926062d94",
        "EntityID": 3,
        "Debit": 4.1,
        "Credit": 5.1,
        "Memo": "sample string 6",
        "ReferenceID": "3c600fef-1f08-4f67-85d0-c94291c6d9a2",
        "ReferenceType": "sample string 8",
        "CustomProperties": {
          "CatalogItemID": "97d6f068-89d6-457b-b985-96fb49efc1d8",
          "SupplierID": 1,
          "PaymentMethodID": 2,
          "PaymentID": "b835a97f-703c-4fc5-9843-4e52a47cdd58",
          "TaxID": "10c8bd06-d4dc-4822-8297-35b6e1f7c840"
        }
      },
      {
        "LineNumber": 1,
        "AccountID": "3c997301-727f-45a3-b4e2-375926062d94",
        "EntityID": 3,
        "Debit": 4.1,
        "Credit": 5.1,
        "Memo": "sample string 6",
        "ReferenceID": "3c600fef-1f08-4f67-85d0-c94291c6d9a2",
        "ReferenceType": "sample string 8",
        "CustomProperties": {
          "CatalogItemID": "97d6f068-89d6-457b-b985-96fb49efc1d8",
          "SupplierID": 1,
          "PaymentMethodID": 2,
          "PaymentID": "b835a97f-703c-4fc5-9843-4e52a47cdd58",
          "TaxID": "10c8bd06-d4dc-4822-8297-35b6e1f7c840"
        }
      }
    ]
  },
  {
    "Id": "b0d54fc0-7459-4f59-85c8-8f99fcb81f17",
    "TransactionDateUTC": "2024-11-25T11:37:51.9007016+00:00",
    "CreatedByUserID": 3,
    "CreatedByUserName": "sample string 4",
    "Entries": [
      {
        "LineNumber": 1,
        "AccountID": "3c997301-727f-45a3-b4e2-375926062d94",
        "EntityID": 3,
        "Debit": 4.1,
        "Credit": 5.1,
        "Memo": "sample string 6",
        "ReferenceID": "3c600fef-1f08-4f67-85d0-c94291c6d9a2",
        "ReferenceType": "sample string 8",
        "CustomProperties": {
          "CatalogItemID": "97d6f068-89d6-457b-b985-96fb49efc1d8",
          "SupplierID": 1,
          "PaymentMethodID": 2,
          "PaymentID": "b835a97f-703c-4fc5-9843-4e52a47cdd58",
          "TaxID": "10c8bd06-d4dc-4822-8297-35b6e1f7c840"
        }
      },
      {
        "LineNumber": 1,
        "AccountID": "3c997301-727f-45a3-b4e2-375926062d94",
        "EntityID": 3,
        "Debit": 4.1,
        "Credit": 5.1,
        "Memo": "sample string 6",
        "ReferenceID": "3c600fef-1f08-4f67-85d0-c94291c6d9a2",
        "ReferenceType": "sample string 8",
        "CustomProperties": {
          "CatalogItemID": "97d6f068-89d6-457b-b985-96fb49efc1d8",
          "SupplierID": 1,
          "PaymentMethodID": 2,
          "PaymentID": "b835a97f-703c-4fc5-9843-4e52a47cdd58",
          "TaxID": "10c8bd06-d4dc-4822-8297-35b6e1f7c840"
        }
      }
    ]
  }
]