Previous Next JavaScript must be enabled to correctly display this content

## Get all Valid Sweep Monitor

get

/sweepmonitor

This endpoint is used to get all valid sweep monitor maintenance records.

### Request

Supported Media Types

- application/json
- application/xml

Query Parameters

- bookDateFrom(optional): string
- bookDateTo(optional): string
- bvtReversal(optional): boolean
- crossCcy(optional): boolean
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- executionId(optional): string
- extSysRefId(optional): string
- externalTxnNo(optional): string
- filterBy(optional): string
- fromAccount(optional): string
- includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
- interfaceMasterId(optional): string
- isExtSysFilter(optional): string
  isExtSysFilter need to be set to fetch non null isExtSysFilter
- isReverseSweep(optional): string
- limit(optional): integer
  limit is maximum no of records to be fetched
- offset(optional): integer
  offset is starting no of records to be fetched
- onlyLinkedCustomers(optional): string
  onlyLinkedCustomers need to be set to fetch sweep log based on only Linked Customers
- structureId(optional): string
  Pattern: `[0-9a-fA-Z-]{1,36}`
- sweepId(optional): string
- toAccount(optional): string
- toCcy(optional): string
- valueDateFrom(optional): string
- valueDateTo(optional): string

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of succes or failure
Headers

- Location: string

Body ()
Root Schema : LmsTbSweepLogCollection
Type: `object`
Collection of sweeplog.
Show Source

- data(optional): array data

    {
        "description":"Collection of sweeplog.",
        "type":"object",
        "properties":{
            "data":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/LmsTbSweepLogDTO"
                }
            }
        }
    }

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmsTbSweepLogDTO

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/LmsTbSweepLogDTO"
        }
    }

Nested Schema : LmsTbSweepLogDTO
Type: `object`
Show Source

- amount(optional): number
- balanceTimestamp(optional): string
- balanceTimeStamp(optional): string(date)
- childExtAcc(optional): boolean
- customerExtRef(optional): string
- customerId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- customerName(optional): string
- executionId(optional): string
- extSysRefId(optional): string
- extTransactionNo(optional): string
- fromAccBranchAdddr1(optional): string
- fromAccBranchAdddr2(optional): string
- fromAccBranchAdddr3(optional): string
- fromAccBranchAdddr4(optional): string
- fromAccBranchAdddr5(optional): string
- fromAccFcyAmount(optional): number
- fromAccLcyAmount(optional): number
- fromAccnoDesc(optional): string
- fromAccountBalance(optional): number
- fromAccountLcy(optional): string
- fromAccountNumber(optional): string
- fromAccPostBal(optional): number
- fromAcForcePost(optional): string
- fromAmount(optional): number
- fromBicCode(optional): string
- fromBranchCode(optional): string
- fromCurrencyCode(optional): string
- fromCustomerName(optional): string
- fromCustomerNo(optional): string
- fromExtAccno(optional): string
- fromExtBranchRef(optional): string
- fromHostCode(optional): string
- fromIBanForAccno(optional): string
- fxRate(optional): number
- headerBranch(optional): string
- headerBranchExtRef(optional): string
- headerHostCode(optional): string
- instructionId(optional): string
- interfaceMasterId(optional): string
- isTwoway(optional): string
- keyId(optional): string
- logTime(optional): string
- manualUpdateTimestamp(optional): string
- pmtAckTime(optional): string
- pmtInitiated(optional): string
- pmtMessage(optional): string
- retryCount(optional): integer
- status(optional): string
- statusMessage(optional): string
- structureId(optional): string
  Pattern: `[A-Z0-9]{1,30}`
- structureMasterId(optional): string
- sweepMode(optional): string
- sweepProduct(optional): string
- toAccBranchAdddr1(optional): string
- toAccBranchAdddr2(optional): string
- toAccBranchAdddr3(optional): string
- toAccBranchAdddr4(optional): string
- toAccBranchAdddr5(optional): string
- toAccFcyAmount(optional): number
- toAccLcyAmount(optional): number
- toAccnoDesc(optional): string
- toAccountBalance(optional): number
- toAccountLcy(optional): string
- toAccountNumber(optional): string
- toAccPostBal(optional): number
- toAcForcePost(optional): string
- toAmount(optional): number
- toBicCode(optional): string
- toBranchCode(optional): string
- toCurrencyCode(optional): string
- toCustomerName(optional): string
- toCustomerNo(optional): string
- toExtAccno(optional): string
- toExtBranchRef(optional): string
- toHostCode(optional): string
- toIBanForAccno(optional): string
- valueDate(optional): string
- versionNo(optional): number

    {
        "type":"object",
        "properties":{
            "amount":{
                "type":"number",
                "description":""
            },
            "fromAccLcyAmount":{
                "type":"number",
                "description":""
            },
            "fromAccFcyAmount":{
                "type":"number",
                "description":""
            },
            "toAccLcyAmount":{
                "type":"number",
                "description":""
            },
            "toAccFcyAmount":{
                "type":"number",
                "description":""
            },
            "balanceTimestamp":{
                "type":"string",
                "description":""
            },
            "customerId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "executionId":{
                "type":"string",
                "description":""
            },
            "extTransactionNo":{
                "type":"string",
                "description":""
            },
            "fromAccountBalance":{
                "type":"number",
                "description":""
            },
            "fromAccountNumber":{
                "type":"string",
                "description":""
            },
            "fromAccPostBal":{
                "type":"number",
                "description":""
            },
            "fromAmount":{
                "type":"number",
                "description":""
            },
            "fromBicCode":{
                "type":"string",
                "description":""
            },
            "fromBranchCode":{
                "type":"string",
                "description":""
            },
            "fromCurrencyCode":{
                "type":"string",
                "description":""
            },
            "fromAccountLcy":{
                "type":"string",
                "description":""
            },
            "fxRate":{
                "type":"number",
                "description":""
            },
            "instructionId":{
                "type":"string",
                "description":""
            },
            "isTwoway":{
                "type":"string",
                "description":""
            },
            "logTime":{
                "type":"string",
                "description":""
            },
            "status":{
                "type":"string",
                "description":""
            },
            "statusMessage":{
                "type":"string",
                "description":""
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[A-Z0-9]{1,30}"
            },
            "sweepMode":{
                "type":"string",
                "description":""
            },
            "sweepProduct":{
                "type":"string",
                "description":""
            },
            "toAccountBalance":{
                "type":"number",
                "description":""
            },
            "toAccountNumber":{
                "type":"string",
                "description":""
            },
            "toAccPostBal":{
                "type":"number",
                "description":""
            },
            "toAmount":{
                "type":"number",
                "description":""
            },
            "toBicCode":{
                "type":"string",
                "description":""
            },
            "toBranchCode":{
                "type":"string",
                "description":""
            },
            "toCurrencyCode":{
                "type":"string",
                "description":""
            },
            "toAccountLcy":{
                "type":"string",
                "description":""
            },
            "valueDate":{
                "type":"string",
                "description":""
            },
            "fromExtAccno":{
                "type":"string",
                "description":""
            },
            "fromIBanForAccno":{
                "type":"string",
                "description":""
            },
            "fromAccnoDesc":{
                "type":"string",
                "description":""
            },
            "fromExtBranchRef":{
                "type":"string",
                "description":""
            },
            "fromAccBranchAdddr1":{
                "type":"string",
                "description":""
            },
            "fromAccBranchAdddr2":{
                "type":"string",
                "description":""
            },
            "fromAccBranchAdddr3":{
                "type":"string",
                "description":""
            },
            "fromAccBranchAdddr4":{
                "type":"string",
                "description":""
            },
            "fromAccBranchAdddr5":{
                "type":"string",
                "description":""
            },
            "toExtAccno":{
                "type":"string",
                "description":""
            },
            "toIBanForAccno":{
                "type":"string",
                "description":""
            },
            "toAccnoDesc":{
                "type":"string",
                "description":""
            },
            "toExtBranchRef":{
                "type":"string",
                "description":""
            },
            "toAccBranchAdddr1":{
                "type":"string",
                "description":""
            },
            "toAccBranchAdddr2":{
                "type":"string",
                "description":""
            },
            "toAccBranchAdddr3":{
                "type":"string",
                "description":""
            },
            "toAccBranchAdddr4":{
                "type":"string",
                "description":""
            },
            "toAccBranchAdddr5":{
                "type":"string",
                "description":""
            },
            "versionNo":{
                "type":"number",
                "description":""
            },
            "customerExtRef":{
                "type":"string",
                "description":""
            },
            "customerName":{
                "type":"string",
                "description":""
            },
            "headerBranch":{
                "type":"string",
                "description":""
            },
            "headerBranchExtRef":{
                "type":"string",
                "description":""
            },
            "balanceTimeStamp":{
                "type":"string",
                "format":"date",
                "description":""
            },
            "childExtAcc":{
                "type":"boolean",
                "description":""
            },
            "interfaceMasterId":{
                "type":"string",
                "description":""
            },
            "structureMasterId":{
                "type":"string",
                "description":""
            },
            "fromHostCode":{
                "type":"string",
                "description":""
            },
            "toHostCode":{
                "type":"string",
                "description":""
            },
            "headerHostCode":{
                "type":"string",
                "description":""
            },
            "keyId":{
                "type":"string",
                "description":""
            },
            "retryCount":{
                "type":"integer",
                "description":""
            },
            "extSysRefId":{
                "type":"string",
                "description":""
            },
            "manualUpdateTimestamp":{
                "type":"string",
                "description":""
            },
            "pmtInitiated":{
                "type":"string",
                "description":""
            },
            "pmtAckTime":{
                "type":"string",
                "description":""
            },
            "pmtMessage":{
                "type":"string",
                "description":""
            },
            "fromAcForcePost":{
                "type":"string",
                "description":""
            },
            "toAcForcePost":{
                "type":"string",
                "description":""
            },
            "toCustomerNo":{
                "type":"string",
                "description":""
            },
            "toCustomerName":{
                "type":"string",
                "description":""
            },
            "fromCustomerNo":{
                "type":"string",
                "description":""
            },
            "fromCustomerName":{
                "type":"string",
                "description":""
            }
        }
    }

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 405 Response

Invalid input

#### 500 Response

Internal error
Back to Top