POST RecurringJournal/RunRecurrenceNow

Runs the active Recurring Journal's Recurrence and creates the Journal Entries and Open Batch Journals if valid.

Request Information

URI Parameters

None.

Body Parameters

Recurring Journal Run Schedule Request Model

Name	Type	Additional information	Description
ID	integer	None.
RunScheduleAndUpdateNextRunDate	bool	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "RunScheduleAndUpdateNextRunDate": true
}

Response Information

Resource Description

Recurring Journal

Name	Type	Additional information	Description
ID	integer	None.	The identifier.
Active	bool	None.	Indicates whether the Recurring Journal is active/enabled for execution.
MarkAsReviewed	bool	None.	True if Recurring Journal is marked as reviewed. Otherwise false.
TemplateName	string	None.	Template description.
Created	date	Read Only / System Generated	Created date.
Modified	nullable date	Read Only / System Generated	Modified date.
RecurringJournalTransactions	Collection of Recurring Journal Transaction	None.	List of Recurring Journals.
RecurringJournalRecurrence	Recurring Journal Recurrence	None.	The recurrence linked to this Recurring Journal used to determine when to execute.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Active": true,
  "MarkAsReviewed": true,
  "TemplateName": "sample string 5",
  "Created": "2024-11-15",
  "Modified": "2024-11-15",
  "RecurringJournalTransactions": [
    {
      "Created": "2024-11-15",
      "Modified": "2024-11-15",
      "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": "2024-11-15",
      "Modified": "2024-11-15",
      "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": "2024-11-15",
    "NextRunDate": "2024-11-15",
    "LastRunDate": "2024-11-15",
    "EndDate": "2024-11-15",
    "NumberOfOccurrences": 1,
    "Created": "2024-11-15",
    "Modified": "2024-11-15"
  }
}