POST JournalEntry/Calculate

Calculates the totals of the Journal Entry sent through.

Request Information

URI Parameters

None.

Body Parameters

The Journal Entry object.

Name	Type	Additional information	Description
ID	integer	None.
Date	date	Required
Effect	Effect	None.	Gets or sets the Journal Entry. Debit = 1, Credit = 2
AccountId	integer	None.
Reference	string	None.
Description	string	None.
TaxTypeId	nullable integer	None.
TaxPeriodId	nullable integer	None.
Exclusive	decimal	None.
Tax	decimal	None.
Total	decimal	None.
ContraAccountId	integer	None.
Memo	string	None.
HasAttachments	bool	None.
AnalysisCategoryId1	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId2	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId3	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
Editable	bool	Read Only / System Generated
Locked	bool	Read Only / System Generated
$TrackingCode	string	None.
Debit	decimal	None.
Credit	decimal	None.
BusinessId	nullable integer	None.
PayRunId	nullable integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Date": "2024-11-15",
  "Effect": 1,
  "AccountId": 2,
  "Reference": "sample string 3",
  "Description": "sample string 4",
  "TaxTypeId": 1,
  "TaxPeriodId": 1,
  "Exclusive": 5.0,
  "Tax": 6.0,
  "Total": 7.0,
  "ContraAccountId": 8,
  "Memo": "sample string 9",
  "HasAttachments": true,
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "Editable": true,
  "Locked": true,
  "$TrackingCode": "sample string 13",
  "Debit": 5.0,
  "Credit": 0.0,
  "BusinessId": 1,
  "PayRunId": 1
}

Response Information

Resource Description

Returns the Journal Entry sent through with the calculated totals.

Journal Entry

Name	Type	Additional information	Description
ID	integer	None.
Date	date	Required
Effect	Effect	None.	Gets or sets the Journal Entry. Debit = 1, Credit = 2
AccountId	integer	None.
Reference	string	None.
Description	string	None.
TaxTypeId	nullable integer	None.
TaxPeriodId	nullable integer	None.
Exclusive	decimal	None.
Tax	decimal	None.
Total	decimal	None.
ContraAccountId	integer	None.
Memo	string	None.
HasAttachments	bool	None.
AnalysisCategoryId1	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId2	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId3	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
Editable	bool	Read Only / System Generated
Locked	bool	Read Only / System Generated
$TrackingCode	string	None.
Debit	decimal	None.
Credit	decimal	None.
BusinessId	nullable integer	None.
PayRunId	nullable integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Date": "2024-11-15",
  "Effect": 1,
  "AccountId": 2,
  "Reference": "sample string 3",
  "Description": "sample string 4",
  "TaxTypeId": 1,
  "TaxPeriodId": 1,
  "Exclusive": 5.0,
  "Tax": 6.0,
  "Total": 7.0,
  "ContraAccountId": 8,
  "Memo": "sample string 9",
  "HasAttachments": true,
  "AnalysisCategoryId1": 1,
  "AnalysisCategoryId2": 1,
  "AnalysisCategoryId3": 1,
  "Editable": true,
  "Locked": true,
  "$TrackingCode": "sample string 13",
  "Debit": 5.0,
  "Credit": 0.0,
  "BusinessId": 1,
  "PayRunId": 1
}