PUT api/journalentries/{journalEntryId}/preview

Update journal entry but does not commit the data to the database

Request Information

URI Parameters

NameDescriptionTypeAdditional information
journalEntryId

integer

Required

Body Parameters

UpdateJournalEntryViewModel
NameDescriptionTypeAdditional information
LineItems

Collection of UpdateJournalEntryLineItemViewModel

Required

Attachment

JournalEntryAttachmentViewModel

None.

SuperEntityId

integer

Required

GLDate

date

Required

Description

string

Required

Max length: 100

IsPosted

boolean

None.

JournalEntryTypeId

JournalEntryTypeCode

Required

SubLedgerId

SubLedger

Required

ReversingDate

date

None.

Notes

string

Max length: 250

Request Formats

application/json, text/json

Sample:
{
  "lineItems": [
    {
      "id": 1,
      "glEntityId": 1,
      "lineDescription": "sample string 2",
      "chartOfAccountId": 1,
      "glSubAccountId": 1,
      "fundId": 1,
      "debit": 3.0,
      "credit": 4.0
    },
    {
      "id": 1,
      "glEntityId": 1,
      "lineDescription": "sample string 2",
      "chartOfAccountId": 1,
      "glSubAccountId": 1,
      "fundId": 1,
      "debit": 3.0,
      "credit": 4.0
    }
  ],
  "attachment": {
    "journalEntryAttachmentId": 1,
    "journalEntryId": 2,
    "fileName": "sample string 3",
    "originalFileName": "sample string 4",
    "filePath": "sample string 5",
    "errors": [
      "sample string 1",
      "sample string 2"
    ],
    "isNewOrChange": 6
  },
  "superEntityId": 1,
  "glDate": "2024-10-14T08:18:39.2138957-04:00",
  "description": "sample string 1",
  "isPosted": true,
  "journalEntryTypeId": 1,
  "subLedgerId": 1,
  "reversingDate": "2024-10-14T08:18:39.2138957-04:00",
  "notes": "sample string 3"
}

application/xml, text/xml

Sample:
<UpdateJournalEntryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.JournalEntry">
  <Description>sample string 1</Description>
  <GLDate>2024-10-14T08:18:39.2138957-04:00</GLDate>
  <IsPosted>true</IsPosted>
  <JournalEntryTypeId>AVC</JournalEntryTypeId>
  <Notes>sample string 3</Notes>
  <ReversingDate>2024-10-14T08:18:39.2138957-04:00</ReversingDate>
  <SubLedgerId>AR</SubLedgerId>
  <SuperEntityId>1</SuperEntityId>
  <Attachment>
    <Errors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Errors>
    <FileName>sample string 3</FileName>
    <FilePath>sample string 5</FilePath>
    <IsNewOrChange>6</IsNewOrChange>
    <JournalEntryAttachmentId>1</JournalEntryAttachmentId>
    <JournalEntryId>2</JournalEntryId>
    <OriginalFileName>sample string 4</OriginalFileName>
  </Attachment>
  <LineItems>
    <UpdateJournalEntryLineItemViewModel>
      <ChartOfAccountId>1</ChartOfAccountId>
      <Credit>4</Credit>
      <Debit>3</Debit>
      <FundId>1</FundId>
      <GLEntityId>1</GLEntityId>
      <GlSubAccountId>1</GlSubAccountId>
      <LineDescription>sample string 2</LineDescription>
      <Id>1</Id>
    </UpdateJournalEntryLineItemViewModel>
    <UpdateJournalEntryLineItemViewModel>
      <ChartOfAccountId>1</ChartOfAccountId>
      <Credit>4</Credit>
      <Debit>3</Debit>
      <FundId>1</FundId>
      <GLEntityId>1</GLEntityId>
      <GlSubAccountId>1</GlSubAccountId>
      <LineDescription>sample string 2</LineDescription>
      <Id>1</Id>
    </UpdateJournalEntryLineItemViewModel>
  </LineItems>
</UpdateJournalEntryViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateJournalEntryViewModel'.

Response Information

Resource Description

List of UpdateJournalEntryResultViewModel

Collection of UpdateJournalEntryResultViewModel
NameDescriptionTypeAdditional information
LineItems

Collection of UpdateJournalEntryDetailsResultViewModel

None.

Attachment

JournalEntryAttachmentViewModel

None.

JournalEntryId

integer

None.

SourceId

integer

None.

JournalEntryType

string

None.

NavigationLinkId

integer

None.

EntityName

string

None.

ManagementCompany

string

None.

GlDate

date

None.

CreatedDate

date

None.

Description

string

None.

UserName

string

None.

TotalCredits

decimal number

None.

TotalDebits

decimal number

None.

JournalEntryStatus

string

None.

Notes

string

None.

JournalEntryAttachmentID

integer

None.

IsAllowReverse

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "lineItems": [
      {
        "lineDescription": "sample string 1",
        "lineItemId": 2,
        "entityNumber": "sample string 3",
        "glAccountName": "sample string 4",
        "glSubAccountName": "sample string 5",
        "debit": 6.0,
        "credit": 7.0,
        "fundDisplayName": "sample string 8",
        "description": "sample string 9"
      },
      {
        "lineDescription": "sample string 1",
        "lineItemId": 2,
        "entityNumber": "sample string 3",
        "glAccountName": "sample string 4",
        "glSubAccountName": "sample string 5",
        "debit": 6.0,
        "credit": 7.0,
        "fundDisplayName": "sample string 8",
        "description": "sample string 9"
      }
    ],
    "attachment": {
      "journalEntryAttachmentId": 1,
      "journalEntryId": 2,
      "fileName": "sample string 3",
      "originalFileName": "sample string 4",
      "filePath": "sample string 5",
      "errors": [
        "sample string 1",
        "sample string 2"
      ],
      "isNewOrChange": 6
    },
    "journalEntryId": 1,
    "sourceId": 1,
    "journalEntryType": "sample string 2",
    "navigationLinkId": 1,
    "entityName": "sample string 3",
    "managementCompany": "sample string 4",
    "glDate": "2024-10-14T08:18:39.2451441-04:00",
    "createdDate": "2024-10-14T08:18:39.2451441-04:00",
    "description": "sample string 5",
    "userName": "sample string 6",
    "totalCredits": 7.0,
    "totalDebits": 8.0,
    "journalEntryStatus": "sample string 9",
    "notes": "sample string 10",
    "journalEntryAttachmentID": 1,
    "isAllowReverse": true
  },
  {
    "lineItems": [
      {
        "lineDescription": "sample string 1",
        "lineItemId": 2,
        "entityNumber": "sample string 3",
        "glAccountName": "sample string 4",
        "glSubAccountName": "sample string 5",
        "debit": 6.0,
        "credit": 7.0,
        "fundDisplayName": "sample string 8",
        "description": "sample string 9"
      },
      {
        "lineDescription": "sample string 1",
        "lineItemId": 2,
        "entityNumber": "sample string 3",
        "glAccountName": "sample string 4",
        "glSubAccountName": "sample string 5",
        "debit": 6.0,
        "credit": 7.0,
        "fundDisplayName": "sample string 8",
        "description": "sample string 9"
      }
    ],
    "attachment": {
      "journalEntryAttachmentId": 1,
      "journalEntryId": 2,
      "fileName": "sample string 3",
      "originalFileName": "sample string 4",
      "filePath": "sample string 5",
      "errors": [
        "sample string 1",
        "sample string 2"
      ],
      "isNewOrChange": 6
    },
    "journalEntryId": 1,
    "sourceId": 1,
    "journalEntryType": "sample string 2",
    "navigationLinkId": 1,
    "entityName": "sample string 3",
    "managementCompany": "sample string 4",
    "glDate": "2024-10-14T08:18:39.2451441-04:00",
    "createdDate": "2024-10-14T08:18:39.2451441-04:00",
    "description": "sample string 5",
    "userName": "sample string 6",
    "totalCredits": 7.0,
    "totalDebits": 8.0,
    "journalEntryStatus": "sample string 9",
    "notes": "sample string 10",
    "journalEntryAttachmentID": 1,
    "isAllowReverse": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfUpdateJournalEntryResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.JournalEntry">
  <UpdateJournalEntryResultViewModel>
    <CreatedDate>2024-10-14T08:18:39.2451441-04:00</CreatedDate>
    <Description>sample string 5</Description>
    <EntityName>sample string 3</EntityName>
    <GlDate>2024-10-14T08:18:39.2451441-04:00</GlDate>
    <IsAllowReverse>true</IsAllowReverse>
    <JournalEntryAttachmentID>1</JournalEntryAttachmentID>
    <JournalEntryId>1</JournalEntryId>
    <JournalEntryStatus>sample string 9</JournalEntryStatus>
    <JournalEntryType>sample string 2</JournalEntryType>
    <ManagementCompany>sample string 4</ManagementCompany>
    <NavigationLinkId>1</NavigationLinkId>
    <Notes>sample string 10</Notes>
    <SourceId>1</SourceId>
    <TotalCredits>7</TotalCredits>
    <TotalDebits>8</TotalDebits>
    <UserName>sample string 6</UserName>
    <Attachment>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Errors>
      <FileName>sample string 3</FileName>
      <FilePath>sample string 5</FilePath>
      <IsNewOrChange>6</IsNewOrChange>
      <JournalEntryAttachmentId>1</JournalEntryAttachmentId>
      <JournalEntryId>2</JournalEntryId>
      <OriginalFileName>sample string 4</OriginalFileName>
    </Attachment>
    <LineItems>
      <UpdateJournalEntryDetailsResultViewModel>
        <Credit>7</Credit>
        <Debit>6</Debit>
        <Description>sample string 9</Description>
        <EntityNumber>sample string 3</EntityNumber>
        <FundDisplayName>sample string 8</FundDisplayName>
        <GlAccountName>sample string 4</GlAccountName>
        <GlSubAccountName>sample string 5</GlSubAccountName>
        <LineItemId>2</LineItemId>
        <LineDescription>sample string 1</LineDescription>
      </UpdateJournalEntryDetailsResultViewModel>
      <UpdateJournalEntryDetailsResultViewModel>
        <Credit>7</Credit>
        <Debit>6</Debit>
        <Description>sample string 9</Description>
        <EntityNumber>sample string 3</EntityNumber>
        <FundDisplayName>sample string 8</FundDisplayName>
        <GlAccountName>sample string 4</GlAccountName>
        <GlSubAccountName>sample string 5</GlSubAccountName>
        <LineItemId>2</LineItemId>
        <LineDescription>sample string 1</LineDescription>
      </UpdateJournalEntryDetailsResultViewModel>
    </LineItems>
  </UpdateJournalEntryResultViewModel>
  <UpdateJournalEntryResultViewModel>
    <CreatedDate>2024-10-14T08:18:39.2451441-04:00</CreatedDate>
    <Description>sample string 5</Description>
    <EntityName>sample string 3</EntityName>
    <GlDate>2024-10-14T08:18:39.2451441-04:00</GlDate>
    <IsAllowReverse>true</IsAllowReverse>
    <JournalEntryAttachmentID>1</JournalEntryAttachmentID>
    <JournalEntryId>1</JournalEntryId>
    <JournalEntryStatus>sample string 9</JournalEntryStatus>
    <JournalEntryType>sample string 2</JournalEntryType>
    <ManagementCompany>sample string 4</ManagementCompany>
    <NavigationLinkId>1</NavigationLinkId>
    <Notes>sample string 10</Notes>
    <SourceId>1</SourceId>
    <TotalCredits>7</TotalCredits>
    <TotalDebits>8</TotalDebits>
    <UserName>sample string 6</UserName>
    <Attachment>
      <Errors xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Errors>
      <FileName>sample string 3</FileName>
      <FilePath>sample string 5</FilePath>
      <IsNewOrChange>6</IsNewOrChange>
      <JournalEntryAttachmentId>1</JournalEntryAttachmentId>
      <JournalEntryId>2</JournalEntryId>
      <OriginalFileName>sample string 4</OriginalFileName>
    </Attachment>
    <LineItems>
      <UpdateJournalEntryDetailsResultViewModel>
        <Credit>7</Credit>
        <Debit>6</Debit>
        <Description>sample string 9</Description>
        <EntityNumber>sample string 3</EntityNumber>
        <FundDisplayName>sample string 8</FundDisplayName>
        <GlAccountName>sample string 4</GlAccountName>
        <GlSubAccountName>sample string 5</GlSubAccountName>
        <LineItemId>2</LineItemId>
        <LineDescription>sample string 1</LineDescription>
      </UpdateJournalEntryDetailsResultViewModel>
      <UpdateJournalEntryDetailsResultViewModel>
        <Credit>7</Credit>
        <Debit>6</Debit>
        <Description>sample string 9</Description>
        <EntityNumber>sample string 3</EntityNumber>
        <FundDisplayName>sample string 8</FundDisplayName>
        <GlAccountName>sample string 4</GlAccountName>
        <GlSubAccountName>sample string 5</GlSubAccountName>
        <LineItemId>2</LineItemId>
        <LineDescription>sample string 1</LineDescription>
      </UpdateJournalEntryDetailsResultViewModel>
    </LineItems>
  </UpdateJournalEntryResultViewModel>
</ArrayOfUpdateJournalEntryResultViewModel>