GET api/journalpage/{id}

Get Journal page by id.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/journalpage/{id}. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

JournalPage id.

integer

Required

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an Journal Page for a given id.

JournalPageDto
NameDescriptionTypeAdditional information
JournalPageID

Unique identifier of Journal Page.

integer
JournalID

Unique identifier of Journal.

integer
DebitAccID

Unique Identifier of a Debit Account.

integer
CreditAccID

Unique Identifier of a Credit Account.

integer
JournalEntry

Journal Entries associated with Journal Page.

Collection of JournalEntry
IsBalancedLevel

byte
ContraAccountId

integer
DetailedContra

boolean
JournalReferenceType

JournalReferenceTypes
AnalysisLinks

Analysis Field Details of JournalPage.

Collection of AnalysisLinkDto
PageDescription

string
ApplyToAllEntries

boolean
BranchID

integer
ValueDate

string
CurrencyID

integer
AutoReverse

boolean
IsPostAndClose

boolean

Response Formats

application/json, text/json

Sample:
{
  "journalPageID": 1,
  "journalID": 1,
  "debitAccID": 1,
  "creditAccID": 1,
  "journalEntry": [
    {
      "journalEntryID": 1,
      "journalPageID": 2,
      "chequeID": 3,
      "description": "sample string 4",
      "reference": "sample string 5",
      "valueDate": "sample string 6",
      "accountID": 7,
      "credit": true,
      "amount": 9.0,
      "currencyAmount": 10.0,
      "currencyID": 11,
      "exchangeRate": 12.0,
      "branchID": 13,
      "branchName": "sample string 14",
      "accountName": "sample string 15",
      "amountString": "sample string 16",
      "currencyAmountString": "sample string 17",
      "valueDate1": "2019-06-04T21:08:15.7261544-04:00",
      "journalPageDescription": "sample string 19",
      "journalID": 20,
      "transactionNumber": "sample string 21"
    },
    {
      "journalEntryID": 1,
      "journalPageID": 2,
      "chequeID": 3,
      "description": "sample string 4",
      "reference": "sample string 5",
      "valueDate": "sample string 6",
      "accountID": 7,
      "credit": true,
      "amount": 9.0,
      "currencyAmount": 10.0,
      "currencyID": 11,
      "exchangeRate": 12.0,
      "branchID": 13,
      "branchName": "sample string 14",
      "accountName": "sample string 15",
      "amountString": "sample string 16",
      "currencyAmountString": "sample string 17",
      "valueDate1": "2019-06-04T21:08:15.7261544-04:00",
      "journalPageDescription": "sample string 19",
      "journalID": 20,
      "transactionNumber": "sample string 21"
    }
  ],
  "isBalancedLevel": 64,
  "contraAccountId": 1,
  "detailedContra": true,
  "journalReferenceType": 0,
  "analysisLinks": [
    {
      "analysisLinkID": 1,
      "analysisFieldID": 1,
      "customerID": 1,
      "cuAccountID": 1,
      "receiptNo": 1,
      "productID": 1,
      "accountID": 1,
      "journalPageID": 1,
      "journalEntryID": 1,
      "journalPostID": 1,
      "recurringPageID": 1,
      "recurringEntryID": 1,
      "cuInsurancePolicyID": 1,
      "selected": true
    },
    {
      "analysisLinkID": 1,
      "analysisFieldID": 1,
      "customerID": 1,
      "cuAccountID": 1,
      "receiptNo": 1,
      "productID": 1,
      "accountID": 1,
      "journalPageID": 1,
      "journalEntryID": 1,
      "journalPostID": 1,
      "recurringPageID": 1,
      "recurringEntryID": 1,
      "cuInsurancePolicyID": 1,
      "selected": true
    }
  ],
  "pageDescription": "sample string 1",
  "applyToAllEntries": true,
  "branchID": 1,
  "valueDate": "sample string 2",
  "currencyID": 1,
  "autoReverse": true,
  "isPostAndClose": true
}

application/xml, text/xml

Sample:
<JournalPageDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU.GL">
  <AnalysisLinks xmlns:d2p1="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.Analysis">
    <d2p1:AnalysisLinkDto>
      <d2p1:AccountID>1</d2p1:AccountID>
      <d2p1:AnalysisFieldID>1</d2p1:AnalysisFieldID>
      <d2p1:AnalysisLinkID>1</d2p1:AnalysisLinkID>
      <d2p1:CUAccountID>1</d2p1:CUAccountID>
      <d2p1:CUInsurancePolicyID>1</d2p1:CUInsurancePolicyID>
      <d2p1:CustomerID>1</d2p1:CustomerID>
      <d2p1:JournalEntryID>1</d2p1:JournalEntryID>
      <d2p1:JournalPageID>1</d2p1:JournalPageID>
      <d2p1:JournalPostID>1</d2p1:JournalPostID>
      <d2p1:ProductID>1</d2p1:ProductID>
      <d2p1:ReceiptNo>1</d2p1:ReceiptNo>
      <d2p1:RecurringEntryID>1</d2p1:RecurringEntryID>
      <d2p1:RecurringPageID>1</d2p1:RecurringPageID>
      <d2p1:Selected>true</d2p1:Selected>
    </d2p1:AnalysisLinkDto>
    <d2p1:AnalysisLinkDto>
      <d2p1:AccountID>1</d2p1:AccountID>
      <d2p1:AnalysisFieldID>1</d2p1:AnalysisFieldID>
      <d2p1:AnalysisLinkID>1</d2p1:AnalysisLinkID>
      <d2p1:CUAccountID>1</d2p1:CUAccountID>
      <d2p1:CUInsurancePolicyID>1</d2p1:CUInsurancePolicyID>
      <d2p1:CustomerID>1</d2p1:CustomerID>
      <d2p1:JournalEntryID>1</d2p1:JournalEntryID>
      <d2p1:JournalPageID>1</d2p1:JournalPageID>
      <d2p1:JournalPostID>1</d2p1:JournalPostID>
      <d2p1:ProductID>1</d2p1:ProductID>
      <d2p1:ReceiptNo>1</d2p1:ReceiptNo>
      <d2p1:RecurringEntryID>1</d2p1:RecurringEntryID>
      <d2p1:RecurringPageID>1</d2p1:RecurringPageID>
      <d2p1:Selected>true</d2p1:Selected>
    </d2p1:AnalysisLinkDto>
  </AnalysisLinks>
  <ApplyToAllEntries>true</ApplyToAllEntries>
  <AutoReverse>true</AutoReverse>
  <BranchID>1</BranchID>
  <ContraAccountId>1</ContraAccountId>
  <CreditAccID>1</CreditAccID>
  <CurrencyID>1</CurrencyID>
  <DebitAccID>1</DebitAccID>
  <DetailedContra>true</DetailedContra>
  <IsBalancedLevel>64</IsBalancedLevel>
  <IsPostAndClose>true</IsPostAndClose>
  <JournalEntry xmlns:d2p1="http://schemas.datacontract.org/2004/07/Abacus.BusinessRules.GL">
    <d2p1:JournalEntry>
      <d2p1:AccountID>7</d2p1:AccountID>
      <d2p1:AccountName>sample string 15</d2p1:AccountName>
      <d2p1:Amount>9</d2p1:Amount>
      <d2p1:AmountString>sample string 16</d2p1:AmountString>
      <d2p1:BranchID>13</d2p1:BranchID>
      <d2p1:BranchName>sample string 14</d2p1:BranchName>
      <d2p1:ChequeID>3</d2p1:ChequeID>
      <d2p1:Credit>true</d2p1:Credit>
      <d2p1:CurrencyAmount>10</d2p1:CurrencyAmount>
      <d2p1:CurrencyAmountString>sample string 17</d2p1:CurrencyAmountString>
      <d2p1:CurrencyID>11</d2p1:CurrencyID>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:ExchangeRate>12</d2p1:ExchangeRate>
      <d2p1:JournalEntryID>1</d2p1:JournalEntryID>
      <d2p1:JournalID>20</d2p1:JournalID>
      <d2p1:JournalPageDescription>sample string 19</d2p1:JournalPageDescription>
      <d2p1:JournalPageID>2</d2p1:JournalPageID>
      <d2p1:Reference>sample string 5</d2p1:Reference>
      <d2p1:TransactionNumber>sample string 21</d2p1:TransactionNumber>
      <d2p1:ValueDate>sample string 6</d2p1:ValueDate>
      <d2p1:ValueDate1>2019-06-04T21:08:15.7261544-04:00</d2p1:ValueDate1>
    </d2p1:JournalEntry>
    <d2p1:JournalEntry>
      <d2p1:AccountID>7</d2p1:AccountID>
      <d2p1:AccountName>sample string 15</d2p1:AccountName>
      <d2p1:Amount>9</d2p1:Amount>
      <d2p1:AmountString>sample string 16</d2p1:AmountString>
      <d2p1:BranchID>13</d2p1:BranchID>
      <d2p1:BranchName>sample string 14</d2p1:BranchName>
      <d2p1:ChequeID>3</d2p1:ChequeID>
      <d2p1:Credit>true</d2p1:Credit>
      <d2p1:CurrencyAmount>10</d2p1:CurrencyAmount>
      <d2p1:CurrencyAmountString>sample string 17</d2p1:CurrencyAmountString>
      <d2p1:CurrencyID>11</d2p1:CurrencyID>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:ExchangeRate>12</d2p1:ExchangeRate>
      <d2p1:JournalEntryID>1</d2p1:JournalEntryID>
      <d2p1:JournalID>20</d2p1:JournalID>
      <d2p1:JournalPageDescription>sample string 19</d2p1:JournalPageDescription>
      <d2p1:JournalPageID>2</d2p1:JournalPageID>
      <d2p1:Reference>sample string 5</d2p1:Reference>
      <d2p1:TransactionNumber>sample string 21</d2p1:TransactionNumber>
      <d2p1:ValueDate>sample string 6</d2p1:ValueDate>
      <d2p1:ValueDate1>2019-06-04T21:08:15.7261544-04:00</d2p1:ValueDate1>
    </d2p1:JournalEntry>
  </JournalEntry>
  <JournalID>1</JournalID>
  <JournalPageID>1</JournalPageID>
  <JournalReferenceType>Increment</JournalReferenceType>
  <PageDescription>sample string 1</PageDescription>
  <ValueDate>sample string 2</ValueDate>
</JournalPageDto>