Jump to

• Request
• Response

Get Initial or Filtered Task Summary for Account

post

/api/1.0/taskSummary/account

This endpoint is used to view Task Summary for Account by user ID from headers.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  Limit is maximum number of records to be fetched.
• mode(optional): boolean
  Mode is total results count to be fetched.
• offset(optional): integer
  Offset is starting number of records to be fetched.

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• userId: string
  The user ID of requesting user.

Body ()

Request Body contin data required to fetch task summary details for account tab.

Root Schema : DmAccountTabFilterDTO

Type: object

Show Source

• accountNumber(optional): string
  Account Number
• daysPastDueMax(optional): number
  Days past Due Maximum
• daysPastDueMin(optional): number
  Days Past Due Minimum
• overDueAmountMax(optional): number
  Overdue Amount Maximum
• overDueAmountMin(optional): number
  Overdue Amount Minimum
• partyId(optional): string
  Party ID
• segmentCodes(optional): array segmentCodes
  Segment Code
• userAssigned(optional): array userAssigned
  User Assigned

{
    "type":"object",
    "properties":{
        "segmentCodes":{
            "description":"Segment Code",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "daysPastDueMin":{
            "description":"Days Past Due Minimum",
            "type":"number"
        },
        "accountNumber":{
            "description":"Account Number",
            "type":"string"
        },
        "daysPastDueMax":{
            "description":"Days past Due Maximum",
            "type":"number"
        },
        "userAssigned":{
            "type":"array",
            "description":"User Assigned",
            "items":{
                "type":"string"
            }
        },
        "partyId":{
            "description":"Party ID",
            "type":"string"
        },
        "overDueAmountMin":{
            "description":"Overdue Amount Minimum",
            "type":"number"
        },
        "overDueAmountMax":{
            "description":"Overdue Amount Maximum",
            "type":"number"
        }
    }
}

Nested Schema : segmentCodes

Type: array

Segment Code

Show Source

• Array of: string

{
    "description":"Segment Code",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : userAssigned

Type: array

User Assigned

Show Source

• Array of: string

{
    "type":"array",
    "description":"User Assigned",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Return accounts assigned to user.

Body ()

Root Schema : AccountTabCollection

Type: object

Collection of thr Account Details.

Show Source

• data(optional): array data
  Data
• paging(optional): object PagingDto

{
    "description":"Collection of thr Account Details.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"Data",
            "items":{
                "$ref":"#/definitions/AccountTabDTO"
            }
        },
        "paging":{
            "description":"Paging",
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Data

Show Source

• Array of: object AccountTabDTO

{
    "type":"array",
    "description":"Data",
    "items":{
        "$ref":"#/definitions/AccountTabDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : AccountTabDTO

Type: object

Show Source

• accountId(optional): string
  Account ID
• accountNumber(optional): string
  Account Number
• acctCurrCd(optional): string
  Account Currency Code of the DmAccount
• caseNumber(optional): string
  Case Number
• customerName(optional): string
  Customer Name
• dpd(optional): number
  Days Past Due
• escalated(optional): integer
  Escalated
• notStarted(optional): integer
  not Started
• overDueAmt(optional): number
  Overdue Amount
• prdProcessrCd(optional): string
  Product Processor Code
• productType(optional): string
  Product Type
• segmentCode(optional): array segmentCode
  Segment Code
• segmentDesc(optional): array segmentDesc
  Segment Description
• userAssigned(optional): string
  User Assigned
• workInProgress(optional): integer
  Work In Progress

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "segmentCode":{
            "type":"array",
            "description":"Segment Code",
            "items":{
                "type":"string"
            }
        },
        "accountNumber":{
            "description":"Account Number",
            "type":"string"
        },
        "customerName":{
            "type":"string",
            "description":"Customer Name"
        },
        "segmentDesc":{
            "description":"Segment Description",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "prdProcessrCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "acctCurrCd":{
            "description":"Account Currency Code of the DmAccount",
            "type":"string"
        },
        "overDueAmt":{
            "type":"number",
            "description":"Overdue Amount"
        },
        "productType":{
            "type":"string",
            "description":"Product Type"
        },
        "dpd":{
            "type":"number",
            "description":"Days Past Due"
        },
        "notStarted":{
            "type":"integer",
            "description":"not Started"
        },
        "escalated":{
            "type":"integer",
            "description":"Escalated"
        },
        "workInProgress":{
            "type":"integer",
            "description":"Work In Progress"
        },
        "userAssigned":{
            "type":"string",
            "description":"User Assigned"
        },
        "caseNumber":{
            "type":"string",
            "description":"Case Number"
        }
    }
}

Nested Schema : segmentCode

Type: array

Segment Code

Show Source

• Array of: string

{
    "type":"array",
    "description":"Segment Code",
    "items":{
        "type":"string"
    }
}

Nested Schema : segmentDesc

Type: array

Segment Description

Show Source

• Array of: string

{
    "description":"Segment Description",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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