GET RecurringJournal/Get?includeDetail={includeDetail}

Gets a list of Recurring Journals.

Request Information

This method supports OData queries.

URI Parameters

NameTypeAdditional informationDescription
includeDetail bool

Default value is False

Optional. If set to true, include the lines.

Body Parameters

None.

Response Information

Resource Description

Returns a list of Recurring Journals.

This collection is wrapped in a paging response object.

Paging response of Recurring Journal
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Recurring Journal

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "ID": 1,
      "Active": true,
      "MarkAsReviewed": true,
      "TemplateName": "sample string 5",
      "Created": "2021-10-20",
      "Modified": "2021-10-20",
      "RecurringJournalTransactions": [
        {
          "Created": "2021-10-20",
          "Modified": "2021-10-20",
          "HasAttachments": false,
          "ID": 4,
          "Effect": 1,
          "AccountId": 5,
          "Reference": "sample string 6",
          "Description": "sample string 7",
          "TaxTypeId": 1,
          "Exclusive": 8.0,
          "Tax": 9.0,
          "Total": 10.0,
          "ContraAccountId": 11,
          "Memo": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "Editable": true,
          "Locked": true,
          "$TrackingCode": "sample string 15",
          "Debit": 8.0,
          "Credit": 0.0
        },
        {
          "Created": "2021-10-20",
          "Modified": "2021-10-20",
          "HasAttachments": false,
          "ID": 4,
          "Effect": 1,
          "AccountId": 5,
          "Reference": "sample string 6",
          "Description": "sample string 7",
          "TaxTypeId": 1,
          "Exclusive": 8.0,
          "Tax": 9.0,
          "Total": 10.0,
          "ContraAccountId": 11,
          "Memo": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "Editable": true,
          "Locked": true,
          "$TrackingCode": "sample string 15",
          "Debit": 8.0,
          "Credit": 0.0
        }
      ],
      "RecurringJournalRecurrence": {
        "ID": 1,
        "FrequencyType": 3,
        "FrequencyInterval": 4,
        "FrequencyRelativeInterval": 5,
        "FrequencyRecurrenceFactor": 6,
        "FrequencyYearlyMonth": 7,
        "RecurrenceRangeType": 8,
        "StartDate": "2021-10-20",
        "NextRunDate": "2021-10-20",
        "LastRunDate": "2021-10-20",
        "EndDate": "2021-10-20",
        "NumberOfOccurrences": 1,
        "Created": "2021-10-20",
        "Modified": "2021-10-20"
      }
    },
    {
      "ID": 1,
      "Active": true,
      "MarkAsReviewed": true,
      "TemplateName": "sample string 5",
      "Created": "2021-10-20",
      "Modified": "2021-10-20",
      "RecurringJournalTransactions": [
        {
          "Created": "2021-10-20",
          "Modified": "2021-10-20",
          "HasAttachments": false,
          "ID": 4,
          "Effect": 1,
          "AccountId": 5,
          "Reference": "sample string 6",
          "Description": "sample string 7",
          "TaxTypeId": 1,
          "Exclusive": 8.0,
          "Tax": 9.0,
          "Total": 10.0,
          "ContraAccountId": 11,
          "Memo": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "Editable": true,
          "Locked": true,
          "$TrackingCode": "sample string 15",
          "Debit": 8.0,
          "Credit": 0.0
        },
        {
          "Created": "2021-10-20",
          "Modified": "2021-10-20",
          "HasAttachments": false,
          "ID": 4,
          "Effect": 1,
          "AccountId": 5,
          "Reference": "sample string 6",
          "Description": "sample string 7",
          "TaxTypeId": 1,
          "Exclusive": 8.0,
          "Tax": 9.0,
          "Total": 10.0,
          "ContraAccountId": 11,
          "Memo": "sample string 12",
          "AnalysisCategoryId1": 1,
          "AnalysisCategoryId2": 1,
          "AnalysisCategoryId3": 1,
          "Editable": true,
          "Locked": true,
          "$TrackingCode": "sample string 15",
          "Debit": 8.0,
          "Credit": 0.0
        }
      ],
      "RecurringJournalRecurrence": {
        "ID": 1,
        "FrequencyType": 3,
        "FrequencyInterval": 4,
        "FrequencyRelativeInterval": 5,
        "FrequencyRecurrenceFactor": 6,
        "FrequencyYearlyMonth": 7,
        "RecurrenceRangeType": 8,
        "StartDate": "2021-10-20",
        "NextRunDate": "2021-10-20",
        "LastRunDate": "2021-10-20",
        "EndDate": "2021-10-20",
        "NumberOfOccurrences": 1,
        "Created": "2021-10-20",
        "Modified": "2021-10-20"
      }
    }
  ]
}