POST api/documentgeneration/paymentstatementjobpack
Generates Payment Statement correspondence Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The payment statement pack data contract supplied with the request.
PaymentStatementPackDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| OwnerGroupRoleIds |
The unique identifiers of the related owner group role resources. |
Collection of integer |
None. |
| PaymentStatementId |
The unique identifier of the related payment statement resource. |
integer |
None. |
| PropertyRoleIds |
The unique identifiers of the related property role resources. |
Collection of integer |
None. |
| TenantGroupRoleIds |
The unique identifiers of the related tenant group role resources. |
Collection of integer |
None. |
| PrimaryCompanyGroupRoleIds |
The unique identifiers of the related primary company group role resources. |
Collection of integer |
None. |
| SackFriendlyName |
The sack friendly name value. |
string |
None. |
| EnvelopeTemplatePackId |
The unique identifier of the related envelope template pack resource. |
integer |
None. |
| BrandId |
The unique identifier of the related brand resource. |
integer |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| NegotiatorPpId |
The unique identifier of the related negotiator pp resource. |
integer |
None. |
| CustomText |
The custom text value. |
string |
None. |
| EnvelopeProcessingMethod |
The envelope processing method value. |
EnumDataContract |
None. |
| AutoProcessSack |
Indicates whether auto process sack is true. |
boolean |
None. |
| SendToDrafts |
Indicates whether send to drafts is true. |
boolean |
None. |
| SendToConveyancing |
Indicates whether send to conveyancing is true. |
boolean |
None. |
| PrintedOnHeaded |
Indicates whether printed on headed is true. |
boolean |
None. |
| WorkflowIndex |
The workflow index value. |
integer |
None. |
| DestinationPrintBagName |
The destination print bag name value. |
string |
None. |
| PostDocGenerationHandler |
The post doc generation handler value. |
PostDocGenerationHandlerDataContract |
None. |
| PreviewOnly |
Indicates whether preview only is true. |
boolean |
None. |
| EmailSubject |
The email subject value. |
string |
None. |
| Attachments |
The collection of attachments. |
Collection of DocumentDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json
Sample not available.
text/json
Sample not available.
Response Information
Resource Description
Details of the payment.
JobInvocationDetailsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SupportsCancellation |
Indicates whether supports cancellation is true. |
boolean |
None. |
| ReportsProgress |
Indicates whether reports progress is true. |
boolean |
None. |
| InitialStatusText |
The initial status text value. |
string |
None. |
| JobReference |
The job reference globally unique identifier. |
globally unique identifier |
None. |
| Success |
Indicates whether success is true. |
boolean |
None. |
Response Formats
application/json, text/json
{
"SupportsCancellation": true,
"ReportsProgress": true,
"InitialStatusText": "sample string 3",
"JobReference": "66b793fd-a407-42cb-8f8c-2f110abc309a",
"Success": true
}