POST Statements/StatementBatch?validateOnly={validateOnly}
Add StatementBatch
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
validateOnly |
Validate data, but don't post it |
boolean |
Default value is False |
Body Parameters
StatementBatch data
StatementBatchDTOName | Description | Type | Additional information |
---|---|---|---|
StatementBatchID | integer |
None. |
|
Label | string |
None. |
|
StatementBatchStatus | StatementBatchStatus |
None. |
|
Props | Collection of Object |
None. |
|
GenerationDateUtc | date |
None. |
|
FromDate | date |
None. |
|
ToDate | date |
None. |
|
StatementsInBatchCount | integer |
None. |
|
FacilityIDs | Collection of integer |
None. |
|
BusinessUnitIDs | Collection of integer |
None. |
|
FunderIDs | Collection of integer |
None. |
|
StatementTypes | Collection of StatementType |
None. |
|
ResidentIDs | Collection of integer |
None. |
|
ResidentTypes | Collection of integer |
None. |
|
AdmissionTypes | Collection of integer |
None. |
|
ExcludeCurrentZeroBalanceResidents | boolean |
None. |
|
ExcludeDepartedZeroBalanceResidents | boolean |
None. |
|
IncludeResidentsNoDeposit | boolean |
None. |
|
IncludeBPay | boolean |
None. |
|
DirectDebitDueDate | date |
None. |
|
StatementDate | date |
None. |
|
StatementMessage | string |
None. |
|
Statements | Collection of StatementDTO |
None. |
|
TriggeringUserID | integer |
None. |
|
TriggeringWorkerID | integer |
None. |
|
TriggeringBatchPdfUserID | integer |
None. |
|
TriggeringBatchPdfWorkerID | integer |
None. |
|
StartedGenerationDate | date |
None. |
|
FinishedGenerationDate | date |
None. |
|
RecordState | RecordState |
None. |
|
Created | AuditDataDTO |
None. |
|
LastUpdated | AuditDataDTO |
None. |
|
StatementsSummary | BatchStatementsSummary |
None. |
|
EmailErrorCount | integer |
None. |
|
JobStatusNotFound | boolean |
None. |
Response Information
Resource Description
Success or not
IHttpActionResultNone.