POST api/documentgeneration/generatebulkaccountstatements

Generates Bulk Account Statement correspondence

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Commands.BulkAccountStatementPackDataContract

Name	Type	Additional information
AccountIds	Collection of integer	None.
AssociatedGroupIds	Collection of integer	None.
OwnerGroupRoleIds	Collection of integer	None.
PropertyRoleIds	Collection of integer	None.
TenantGroupRoleIds	Collection of integer	None.
PrimaryCompanyGroupRoleIds	Collection of integer	None.
Filter	Dezrez.Core.DataContracts.External.Api.Lists.Accounting.Filter.TransactionListFilterDataContract	None.
SackFriendlyName	string	None.
EnvelopeTemplatePackId	integer	None.
BrandId	integer	None.
BranchId	integer	None.
NegotiatorPpId	integer	None.
CustomText	string	None.
EnvelopeProcessingMethod	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
AutoProcessSack	boolean	None.
SendToDrafts	boolean	None.
PrintedOnHeaded	boolean	None.
WorkflowIndex	integer	None.
DestinationPrintBagName	string	None.
PostDocGenerationHandler	Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.PostDocGenerationHandlerDataContract	None.
PreviewOnly	boolean	None.
EmailSubject	string	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "AccountIds": [
    1,
    2
  ],
  "AssociatedGroupIds": [
    1,
    2
  ],
  "OwnerGroupRoleIds": [
    1,
    2
  ],
  "PropertyRoleIds": [
    1,
    2
  ],
  "TenantGroupRoleIds": [
    1,
    2
  ],
  "PrimaryCompanyGroupRoleIds": [
    1,
    2
  ],
  "Filter": {
    "AccountId": 1,
    "AccountIds": [
      1,
      2
    ],
    "StartDate": "2024-09-08T02:19:11.4388964Z",
    "ExplicitDate": "2024-09-08T02:19:11.4388964Z",
    "EndDate": "2024-09-08T02:19:11.4388964Z",
    "TransactionTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "ExcludedTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "Description": "sample string 2",
    "PageSize": 3,
    "PageNumber": 4,
    "ExcludeUncleared": true,
    "ClearedStatuses": [
      "sample string 1",
      "sample string 2"
    ],
    "DrOrCrSide": "sample string 5",
    "PaymentTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "AccountTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "IncludeReversals": true,
    "TenantRoleId": 1
  },
  "SackFriendlyName": "sample string 1",
  "EnvelopeTemplatePackId": 2,
  "BrandId": 3,
  "BranchId": 1,
  "NegotiatorPpId": 4,
  "CustomText": "sample string 5",
  "EnvelopeProcessingMethod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AutoProcessSack": true,
  "SendToDrafts": true,
  "PrintedOnHeaded": true,
  "WorkflowIndex": 9,
  "DestinationPrintBagName": "sample string 10",
  "PostDocGenerationHandler": {
    "EntityType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "EntityId": 1,
    "JobHandlerType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Options": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "DocumentSubType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "AccountingSystemId": 2,
    "AgencyId": 3
  },
  "PreviewOnly": true,
  "EmailSubject": "sample string 12",
  "Id": 13
}

Response Information

Resource Description

Details of the account.

Collection of Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract

Name	Type	Additional information
SupportsCancellation	boolean	None.
ReportsProgress	boolean	None.
InitialStatusText	string	None.
JobReference	globally unique identifier	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SupportsCancellation": true,
    "ReportsProgress": true,
    "InitialStatusText": "sample string 3",
    "JobReference": "d500b22a-70d3-4148-a93c-e8bdde6745a5",
    "Success": true
  },
  {
    "SupportsCancellation": true,
    "ReportsProgress": true,
    "InitialStatusText": "sample string 3",
    "JobReference": "d500b22a-70d3-4148-a93c-e8bdde6745a5",
    "Success": true
  }
]