GET api/v2/GL/RetrieveJournalTransactions?BeginEffDate={BeginEffDate}&EndEffDate={EndEffDate}&PostedOnly={PostedOnly}

Retrieves a list of Journal Transactions by effective date.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
BeginEffDate

Select Journal Transactions posted on or after this date.

string

Required

EndEffDate

Optional - Select Journal Transactions posted on or before this date.

string

Default value is

PostedOnly

Optional - Set to true to retreive only posted transactions.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of JournalTransaction
NameDescriptionTypeAdditional information
Id

string

None.

AcctDate

string

None.

DateEntered

string

None.

DatePosted

string

None.

Description

string

None.

Memo

string

None.

TransactionLines

Collection of JournalTransactionLine

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "sample string 1",
    "AcctDate": "sample string 2",
    "DateEntered": "sample string 3",
    "DatePosted": "sample string 4",
    "Description": "sample string 5",
    "Memo": "sample string 6",
    "TransactionLines": [
      {
        "GLAccount": "sample string 1",
        "GLAccountDesc": "sample string 2",
        "GLAccountAltDesc": "sample string 3",
        "LineComment": "sample string 4",
        "DebitAmount": 5.0,
        "CreditAmount": 6.0
      },
      {
        "GLAccount": "sample string 1",
        "GLAccountDesc": "sample string 2",
        "GLAccountAltDesc": "sample string 3",
        "LineComment": "sample string 4",
        "DebitAmount": 5.0,
        "CreditAmount": 6.0
      }
    ]
  },
  {
    "Id": "sample string 1",
    "AcctDate": "sample string 2",
    "DateEntered": "sample string 3",
    "DatePosted": "sample string 4",
    "Description": "sample string 5",
    "Memo": "sample string 6",
    "TransactionLines": [
      {
        "GLAccount": "sample string 1",
        "GLAccountDesc": "sample string 2",
        "GLAccountAltDesc": "sample string 3",
        "LineComment": "sample string 4",
        "DebitAmount": 5.0,
        "CreditAmount": 6.0
      },
      {
        "GLAccount": "sample string 1",
        "GLAccountDesc": "sample string 2",
        "GLAccountAltDesc": "sample string 3",
        "LineComment": "sample string 4",
        "DebitAmount": 5.0,
        "CreditAmount": 6.0
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfJournalTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <JournalTransaction>
    <AcctDate>sample string 2</AcctDate>
    <DateEntered>sample string 3</DateEntered>
    <DatePosted>sample string 4</DatePosted>
    <Description>sample string 5</Description>
    <Id>sample string 1</Id>
    <Memo>sample string 6</Memo>
    <TransactionLines>
      <JournalTransactionLine>
        <CreditAmount>6</CreditAmount>
        <DebitAmount>5</DebitAmount>
        <GLAccount>sample string 1</GLAccount>
        <GLAccountAltDesc>sample string 3</GLAccountAltDesc>
        <GLAccountDesc>sample string 2</GLAccountDesc>
        <LineComment>sample string 4</LineComment>
      </JournalTransactionLine>
      <JournalTransactionLine>
        <CreditAmount>6</CreditAmount>
        <DebitAmount>5</DebitAmount>
        <GLAccount>sample string 1</GLAccount>
        <GLAccountAltDesc>sample string 3</GLAccountAltDesc>
        <GLAccountDesc>sample string 2</GLAccountDesc>
        <LineComment>sample string 4</LineComment>
      </JournalTransactionLine>
    </TransactionLines>
  </JournalTransaction>
  <JournalTransaction>
    <AcctDate>sample string 2</AcctDate>
    <DateEntered>sample string 3</DateEntered>
    <DatePosted>sample string 4</DatePosted>
    <Description>sample string 5</Description>
    <Id>sample string 1</Id>
    <Memo>sample string 6</Memo>
    <TransactionLines>
      <JournalTransactionLine>
        <CreditAmount>6</CreditAmount>
        <DebitAmount>5</DebitAmount>
        <GLAccount>sample string 1</GLAccount>
        <GLAccountAltDesc>sample string 3</GLAccountAltDesc>
        <GLAccountDesc>sample string 2</GLAccountDesc>
        <LineComment>sample string 4</LineComment>
      </JournalTransactionLine>
      <JournalTransactionLine>
        <CreditAmount>6</CreditAmount>
        <DebitAmount>5</DebitAmount>
        <GLAccount>sample string 1</GLAccount>
        <GLAccountAltDesc>sample string 3</GLAccountAltDesc>
        <GLAccountDesc>sample string 2</GLAccountDesc>
        <LineComment>sample string 4</LineComment>
      </JournalTransactionLine>
    </TransactionLines>
  </JournalTransaction>
</ArrayOfJournalTransaction>