Jump to

• Request
• Response

Retrieve the list of account party details by account IDs and relevant filters.

post

/dmaccount-service/accounts/limitedAcctPartyDetails

This endpoint is used to retrieve the list of account party details by account ID and relevant filters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit: integer
  Limit is the maximum number of records to be fetched.
• offset: integer
  Offset is the starting number of records to be fetched.

Header Parameters

• appId(required): string
  The application ID of the host service.
• branchCode(required): string
  The branch code of the requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The userid of the requesting user.

Body ()

Request body that contains the data required for fetching account party details.

Root Schema : DmAccountIdsAndFilterCollection

Type: object

Collection of Account ID filter

Show Source

• dmAccountFilter: object DmAccountFilterDTO
• dmAccountIdsList: array dmAccountIdsList
  Account IDs List

{
    "description":"Collection of Account ID filter",
    "type":"object",
    "properties":{
        "dmAccountIdsList":{
            "description":"Account IDs List",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dmAccountFilter":{
            "description":"Account Filter",
            "$ref":"#/definitions/DmAccountFilterDTO"
        }
    }
}

Nested Schema : DmAccountFilterDTO

Type: object

Show Source

• daysPastDueMax: number
  Days Past Due Maximum
• daysPastDueMin: number
  Days Past Due Minimum
• overDueAmountMax: number
  Overdue Amount Maximum
• overDueAmountMin: number
  Overdue Amount Minimum

{
    "type":"object",
    "properties":{
        "daysPastDueMin":{
            "type":"number",
            "description":"Days Past Due Minimum"
        },
        "daysPastDueMax":{
            "type":"number",
            "description":"Days Past Due Maximum"
        },
        "overDueAmountMin":{
            "type":"number",
            "description":"Overdue Amount Minimum"
        },
        "overDueAmountMax":{
            "type":"number",
            "description":"Overdue Amount Maximum"
        }
    }
}

Nested Schema : dmAccountIdsList

Type: array

Account IDs List

Show Source

• Array of: string

{
    "description":"Account IDs List",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns list of account party details.

Body ()

Root Schema : DmAccountPartySummaryDTOCollection

Type: object

Collection of Account Party Summary

Show Source

• dmAccountPartySummaryDTOList: array dmAccountPartySummaryDTOList
  Account Party Summary List

{
    "description":"Collection of Account Party Summary",
    "type":"object",
    "properties":{
        "dmAccountPartySummaryDTOList":{
            "description":"Account Party Summary List",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmAccountPartySummaryDTO"
            }
        }
    }
}

Nested Schema : dmAccountPartySummaryDTOList

Type: array

Account Party Summary List

Show Source

• Array of: object DmAccountPartySummaryDTO
  Account party summary data transfer object

{
    "description":"Account Party Summary List",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DmAccountPartySummaryDTO"
    }
}

Nested Schema : DmAccountPartySummaryDTO

Type: object

Account party summary data transfer object

Show Source

• accountId: string
  Account ID
• accountNbr: string
  Account Number
• acctCurrCd: string
  Account currency code of the DmAccount
• customerName: string
  Customer Name
• daysPastDue: number
  Days Past Due of the DmAccount
• overdueAmt: number
  overdue amount of the DmAccount
• partyId: string
  Party ID
• prdProcessrCd: string
  Product Processor Code of the DmAccount
• productSubTypCd: string
  product SubType Code of the DmAccount
• productTypCd: string
  product Type Code of the DmAccount

{
    "type":"object",
    "description":"Account party summary data transfer object",
    "properties":{
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "accountNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "productTypCd":{
            "description":"product Type Code of the DmAccount",
            "type":"string"
        },
        "productSubTypCd":{
            "description":"product SubType Code of the DmAccount",
            "type":"string"
        },
        "overdueAmt":{
            "description":"overdue amount of the DmAccount",
            "type":"number"
        },
        "acctCurrCd":{
            "description":"Account currency code of the DmAccount",
            "type":"string"
        },
        "daysPastDue":{
            "description":"Days Past Due of the DmAccount",
            "type":"number"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code of the DmAccount",
            "type":"string"
        },
        "partyId":{
            "description":"Party ID",
            "type":"string"
        },
        "customerName":{
            "description":"Customer Name",
            "type":"string"
        }
    }
}

201 Response

Returns a message indicating either success or failure.

Headers

• Location: string
  Account party details.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data: object ResponseResourceSupport
• messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes: array codes
  An array of response codes.
• getResponse: object NotesCollection
  Collection of Notes.
• id: string
  The ID of the response.
• requestId: string
  The ID of the request associated with the response.
• saveResponse: object inlineResponse201
  ID of the newly created order.
• status: string
  The status of the response.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the response."
        },
        "status":{
            "type":"string",
            "description":"The status of the response."
        },
        "codes":{
            "type":"array",
            "description":"An array of response codes.",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"The ID of the request associated with the response."
        },
        "saveResponse":{
            "$ref":"#/definitions/inlineResponse201"
        },
        "getResponse":{
            "$ref":"#/definitions/NotesCollection"
        }
    }
}

Nested Schema : codes

Type: array

An array of response codes.

Show Source

• Array of: object ResponseCode
  Response code for account.

{
    "type":"array",
    "description":"An array of response codes.",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : NotesCollection

Type: object

Collection of Notes.

Show Source

• notesList: array notesList

{
    "description":"Collection of Notes.",
    "type":"object",
    "properties":{
        "notesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NotesModel"
            }
        }
    }
}

Nested Schema : inlineResponse201

Type: object

ID of the newly created order.

Show Source

• id: string

{
    "description":"ID of the newly created order.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseCode

Type: object

Response code for account.

Show Source

• arg: string
  The argument used in the response message.
• args: array args
  The arguments used in the response message.
• Code: string
  The code representing the response status.
• Desc: string
  The description of the response status.
• Language: string
  The language used for the response message.
• Type: string
  The type of the response status.

{
    "type":"object",
    "description":"Response code for account.",
    "properties":{
        "Code":{
            "type":"string",
            "description":"The code representing the response status."
        },
        "Desc":{
            "type":"string",
            "description":"The description of the response status."
        },
        "Type":{
            "type":"string",
            "description":"The type of the response status."
        },
        "Language":{
            "type":"string",
            "description":"The language used for the response message."
        },
        "args":{
            "type":"array",
            "description":"The arguments used in the response message.",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"The argument used in the response message."
        }
    }
}

Nested Schema : args

Type: array

The arguments used in the response message.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The arguments used in the response message.",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : notesList

Type: array

Show Source

• Array of: object NotesModel
  Notes model

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

Nested Schema : NotesModel

Type: object

Notes model

Show Source

• accountId: string
  The unique identifier of the account for which the note is created.
• actionId: string
  Action ID linked to the Note
• alert: string
  Alert Flag
• applyToAllAccounts: boolean
  Apply To All Accounts Flag
• capturedBy: string
  The unique identifier of the user who captured the note.
• caseId: string
  Case Id
• createdDate: string
  Created Date
• desc: string
  A description of the note.
• notesId: string
  The unique identifier of the note.
• notesType: string
  The type of the note.
• status: string
  The status of the note.

{
    "description":"Notes model",
    "type":"object",
    "properties":{
        "notesId":{
            "description":"The unique identifier of the note.",
            "type":"string"
        },
        "accountId":{
            "description":"The unique identifier of the account for which the note is created.",
            "type":"string"
        },
        "alert":{
            "description":"Alert Flag",
            "type":"string"
        },
        "createdDate":{
            "description":"Created Date",
            "type":"string"
        },
        "capturedBy":{
            "description":"The unique identifier of the user who captured the note.",
            "type":"string"
        },
        "status":{
            "description":"The status of the note.",
            "type":"string"
        },
        "notesType":{
            "description":"The type of the note.",
            "type":"string"
        },
        "desc":{
            "description":"A description of the note.",
            "type":"string"
        },
        "actionId":{
            "description":"Action ID linked to the Note",
            "type":"string"
        },
        "applyToAllAccounts":{
            "description":"Apply To All Accounts Flag",
            "type":"boolean"
        },
        "caseId":{
            "description":"Case Id",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error.

Back to Top