POST DetailedLedgerTransaction/Get

Retrieves a collection of Detailed Ledger Transactions

Request Information

URI Parameters

None.

Body Parameters

The Detailed Ledger Request Model

Detailed Ledger Request Model
NameTypeAdditional informationDescription
FromDate date

None.

Gets or sets From Date.

ToDate date

None.

Gets or sets To Date.

Inactive bool

None.

Gets or sets a value indicating whether or not to include inactive Accounts.

Active bool

None.

Gets or sets a value indicating whether or not to include active Accounts.

FromAccount string

None.

The Account Name to start the range at.

ToAccount string

None.

The Account Name to stop the range at.

AccountCategorieIds Collection of integer

None.

Gets or sets List of Account Category Id's to include. Empty if all Account Categories should be included.

TransactionTypes Collection of integer

None.

Gets or sets List of Transaction Types to include. Empty if all Transaction Types should be included.

AnalysisTypeId1 nullable integer

None.

Gets or sets the Analysis Category Id to use for the first Analysis Code.

AnalysisTypeId2 nullable integer

None.

Gets or sets the Analysis Category Id to use for the second Analysis Code.

AnalysisTypeId3 nullable integer

None.

Gets or sets the Analysis Category Id to use for the third Analysis Code.

ConsolidateAdditionalCost nullable bool

None.

Gets or sets the Consolidate Additional Costs.

IncludeNoTax nullable bool

None.

Gets or sets the Include No Tax.

Request Formats

application/json, text/json

Sample:
{
  "Inactive": true,
  "Active": true,
  "FromAccount": "sample string 3",
  "ToAccount": "sample string 4",
  "AccountCategorieIds": [
    1,
    2
  ],
  "TransactionTypes": [
    1,
    2
  ],
  "AnalysisTypeId1": 1,
  "AnalysisTypeId2": 1,
  "AnalysisTypeId3": 1,
  "ConsolidateAdditionalCost": true,
  "IncludeNoTax": true,
  "FromDate": "2021-10-16",
  "ToDate": "2021-10-16"
}

Response Information

Resource Description

Collection of Detailed Ledger Transactions

Collection of Detailed Ledger Transaction
NameTypeAdditional informationDescription
ID integer

None.

Date date

None.

TransactionTypeId integer

None.

Reference string

None.

Description string

None.

AccountId integer

None.

AccountDescription string

None.

ContraAccountId integer

None.

ContraAccountDescription string

None.

Debit nullable decimal

None.

Credit nullable decimal

None.

TaxTypeId integer

None.

TaxTypeName string

None.

Modified date

None.

AccountCategoryId integer

None.

AccountCategoryDescription string

None.

TransactionTypeDescription string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": 1,
    "Date": "2021-10-16T00:00:00Z",
    "TransactionTypeId": 3,
    "Reference": "sample string 4",
    "Description": "sample string 5",
    "AccountId": 6,
    "AccountDescription": "sample string 7",
    "ContraAccountId": 8,
    "ContraAccountDescription": "sample string 9",
    "Debit": 1.0,
    "Credit": 1.0,
    "TaxTypeId": 10,
    "TaxTypeName": "sample string 11",
    "Modified": "2021-10-16",
    "AccountCategoryId": 13,
    "AccountCategoryDescription": "sample string 14",
    "TransactionTypeDescription": "sample string 15"
  },
  {
    "ID": 1,
    "Date": "2021-10-16T00:00:00Z",
    "TransactionTypeId": 3,
    "Reference": "sample string 4",
    "Description": "sample string 5",
    "AccountId": 6,
    "AccountDescription": "sample string 7",
    "ContraAccountId": 8,
    "ContraAccountDescription": "sample string 9",
    "Debit": 1.0,
    "Credit": 1.0,
    "TaxTypeId": 10,
    "TaxTypeName": "sample string 11",
    "Modified": "2021-10-16",
    "AccountCategoryId": 13,
    "AccountCategoryDescription": "sample string 14",
    "TransactionTypeDescription": "sample string 15"
  }
]