POST api/journalentries/importpreview

Upload, parse and validates journal entries import file.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

JournalEntryImportResultViewModel

Name	Description	Type	Additional information
FileName		string	None.
JournalEntries		Collection of JournalEntryImportViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "fileName": "sample string 1",
  "journalEntries": [
    {
      "lineNumber": 1,
      "lineData": "sample string 2",
      "lineItems": [
        {
          "lineNumber": 1,
          "lineData": "sample string 2",
          "lineDescription": "sample string 3",
          "journalEntryId": 4,
          "glSubAccountId": 1,
          "glAccountId": 5,
          "chartOfAccountsId": 6,
          "active": true,
          "glEntityId": 8,
          "createdOn": "2025-04-03T17:55:10.4741916-04:00",
          "fundId": 1,
          "isValid": true,
          "errors": [
            "sample string 1",
            "sample string 2"
          ],
          "hasWarnings": true,
          "warnings": [
            "sample string 1",
            "sample string 2"
          ],
          "lineItemId": 11,
          "entityNumber": "sample string 12",
          "glAccountName": "sample string 13",
          "glSubAccountName": "sample string 14",
          "debit": 15.0,
          "credit": 16.0,
          "fundDisplayName": "sample string 17",
          "description": "sample string 18"
        },
        {
          "lineNumber": 1,
          "lineData": "sample string 2",
          "lineDescription": "sample string 3",
          "journalEntryId": 4,
          "glSubAccountId": 1,
          "glAccountId": 5,
          "chartOfAccountsId": 6,
          "active": true,
          "glEntityId": 8,
          "createdOn": "2025-04-03T17:55:10.4741916-04:00",
          "fundId": 1,
          "isValid": true,
          "errors": [
            "sample string 1",
            "sample string 2"
          ],
          "hasWarnings": true,
          "warnings": [
            "sample string 1",
            "sample string 2"
          ],
          "lineItemId": 11,
          "entityNumber": "sample string 12",
          "glAccountName": "sample string 13",
          "glSubAccountName": "sample string 14",
          "debit": 15.0,
          "credit": 16.0,
          "fundDisplayName": "sample string 17",
          "description": "sample string 18"
        }
      ],
      "superEntityId": 3,
      "entityId": 4,
      "isAutoPosted": true,
      "journalEntryTypeId": 1,
      "journalEntryStatusId": 1,
      "subLedgerId": 1,
      "reversingDate": "2025-04-03T17:55:10.4741916-04:00",
      "userId": 6,
      "notes": "sample string 7",
      "sourceTableName": "sample string 8",
      "sourceColumnName": "sample string 9",
      "isValid": true,
      "errors": [
        "sample string 1",
        "sample string 2"
      ],
      "hasWarnings": true,
      "warnings": [
        "sample string 1",
        "sample string 2"
      ],
      "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": 12,
      "sourceId": 1,
      "journalEntryType": "sample string 13",
      "navigationLinkId": 1,
      "entityName": "sample string 14",
      "managementCompany": "sample string 15",
      "glDate": "2025-04-03T17:55:10.4741916-04:00",
      "createdDate": "2025-04-03T17:55:10.4741916-04:00",
      "description": "sample string 16",
      "userName": "sample string 17",
      "totalCredits": 18.0,
      "totalDebits": 19.0,
      "journalEntryStatus": "sample string 20",
      "journalEntryAttachmentID": 1,
      "isAllowReverse": true
    },
    {
      "lineNumber": 1,
      "lineData": "sample string 2",
      "lineItems": [
        {
          "lineNumber": 1,
          "lineData": "sample string 2",
          "lineDescription": "sample string 3",
          "journalEntryId": 4,
          "glSubAccountId": 1,
          "glAccountId": 5,
          "chartOfAccountsId": 6,
          "active": true,
          "glEntityId": 8,
          "createdOn": "2025-04-03T17:55:10.4741916-04:00",
          "fundId": 1,
          "isValid": true,
          "errors": [
            "sample string 1",
            "sample string 2"
          ],
          "hasWarnings": true,
          "warnings": [
            "sample string 1",
            "sample string 2"
          ],
          "lineItemId": 11,
          "entityNumber": "sample string 12",
          "glAccountName": "sample string 13",
          "glSubAccountName": "sample string 14",
          "debit": 15.0,
          "credit": 16.0,
          "fundDisplayName": "sample string 17",
          "description": "sample string 18"
        },
        {
          "lineNumber": 1,
          "lineData": "sample string 2",
          "lineDescription": "sample string 3",
          "journalEntryId": 4,
          "glSubAccountId": 1,
          "glAccountId": 5,
          "chartOfAccountsId": 6,
          "active": true,
          "glEntityId": 8,
          "createdOn": "2025-04-03T17:55:10.4741916-04:00",
          "fundId": 1,
          "isValid": true,
          "errors": [
            "sample string 1",
            "sample string 2"
          ],
          "hasWarnings": true,
          "warnings": [
            "sample string 1",
            "sample string 2"
          ],
          "lineItemId": 11,
          "entityNumber": "sample string 12",
          "glAccountName": "sample string 13",
          "glSubAccountName": "sample string 14",
          "debit": 15.0,
          "credit": 16.0,
          "fundDisplayName": "sample string 17",
          "description": "sample string 18"
        }
      ],
      "superEntityId": 3,
      "entityId": 4,
      "isAutoPosted": true,
      "journalEntryTypeId": 1,
      "journalEntryStatusId": 1,
      "subLedgerId": 1,
      "reversingDate": "2025-04-03T17:55:10.4741916-04:00",
      "userId": 6,
      "notes": "sample string 7",
      "sourceTableName": "sample string 8",
      "sourceColumnName": "sample string 9",
      "isValid": true,
      "errors": [
        "sample string 1",
        "sample string 2"
      ],
      "hasWarnings": true,
      "warnings": [
        "sample string 1",
        "sample string 2"
      ],
      "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": 12,
      "sourceId": 1,
      "journalEntryType": "sample string 13",
      "navigationLinkId": 1,
      "entityName": "sample string 14",
      "managementCompany": "sample string 15",
      "glDate": "2025-04-03T17:55:10.4741916-04:00",
      "createdDate": "2025-04-03T17:55:10.4741916-04:00",
      "description": "sample string 16",
      "userName": "sample string 17",
      "totalCredits": 18.0,
      "totalDebits": 19.0,
      "journalEntryStatus": "sample string 20",
      "journalEntryAttachmentID": 1,
      "isAllowReverse": true
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Collections.Generic.List`1[[CamAcctApi.ViewModels.JournalEntry.JournalEntryLineItemDetailedViewModel, CamAcctApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfJournalEntryLineItemDetailedViewModel:http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.JournalEntry' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Collections.Generic.List`1[[CamAcctApi.ViewModels.JournalEntry.JournalEntryLineItemDetailedViewModel, CamAcctApi, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]' with data contract name 'ArrayOfJournalEntryLineItemDetailedViewModel:http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.JournalEntry' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.