Jump to

• Request
• Response

Update arrear details for an existing account

put

/dmaccountarrears-service/accountarrears

This endpoint is used to update arrear details for an existing account.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request body containing the data required to update the existing account arrears.

Root Schema : DmFeedAccountArrearsWrapperDTO

Type: object

Collection of Arrear Details

Show Source

• accountArrears: array accountArrears
• acctNbr: string
  Account Number
• prdProcessrCd: string
  Product Processor Code

{
    "description":"Collection of Arrear Details",
    "type":"object",
    "properties":{
        "acctNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "accountArrears":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmFeedAccountArrearsDTO"
            }
        }
    }
}

Nested Schema : accountArrears

Type: array

Show Source

• Array of: object DmFeedAccountArrearsDTO
  Account Arrears Model

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

Nested Schema : DmFeedAccountArrearsDTO

Type: object

Account Arrears Model

Show Source

• acctNbr: string
  Account Number
• arsAssessedAmt: number
  Arrear Amount
• arsDueAmt: number
  Arrear Due Amount
• arsDueDt: string
  Arrears Due Date
• arsPaidAmt: number
  Arrear Paid Amount
• arsTypCd: string
  Arrear Type Code
• daysInArs: number
  Days in Arrears
• installmentNum: number
  Installment Number
• lastPaymentDt: string
  Last payment Date
• prdProcessrCd: string
  Product PRocessor Code
• rcdType: string
  Record Type
• referenceVal: string
  Reference Value
• subArsTyp: string
  Sub Arrear Type
• udf1: number
  udf1 of the arrear details entity
• udf10: number
  udf10 of the arrear details entity
• udf11: number
  udf11 of the arrear details entity
• udf12: number
  udf12 of the arrear details entity
• udf13: number
  udf13 of the arrear details entity
• udf14: number
  udf14 of the arrear details entity
• udf15: number
  udf15 of the arrear details entity
• udf16: number
  udf16 of the arrear details entity
• udf17: number
  udf17 of the arrear details entity
• udf18: number
  udf18 of the arrear details entity
• udf19: number
  udf19 of the arrear details entity
• udf2: number
  udf2 of the arrear details entity
• udf20: number
  udf20 of the arrear details entity
• udf21: number
  udf21 of the arrear details entity
• udf22: number
  udf22 of the arrear details entity
• udf23: number
  udf23 of the arrear details entity
• udf24: number
  udf24 of the arrear details entity
• udf25: number
  udf25 of the arrear details entity
• udf26: number
  udf26 of the arrear details entity
• udf27: number
  udf27 of the arrear details entity
• udf28: number
  udf28 of the arrear details entity
• udf29: number
  udf29 of the arrear details entity
• udf3: number
  udf3 of the arrear details entity
• udf30: number
  udf30 of the arrear details entity
• udf31: string
  udf31 of the arrear details entity
• udf32: string
  udf32 of the arrear details entity
• udf33: string
  udf33 of the arrear details entity
• udf34: string
  udf34 of the arrear details entity
• udf35: string
  udf35 of the arrear details entity
• udf36: string
  udf36 of the arrear details entity
• udf37: string
  udf37 of the arrear details entity
• udf38: string
  udf38 of the arrear details entity
• udf39: string
  udf39 of the arrear details entity
• udf4: number
  udf4 of the arrear details entity
• udf40: string
  udf40 of the arrear details entity
• udf41: string
  udf41 of the arrear details entity
• udf42: string
  udf42 of the arrear details entity
• udf43: string
  udf43 of the arrear details entity
• udf44: string
  udf44 of the arrear details entity
• udf45: string
  udf45 of the arrear details entity
• udf46: string
  udf46 of the arrear details entity
• udf47: string
  udf47 of the arrear details entity
• udf48: string
  udf48 of the arrear details entity
• udf49: string
  udf49 of the arrear details entity
• udf5: number
  udf5 of the arrear details entity
• udf50: string
  udf50 of the arrear details entity
• udf6: number
  udf6 of the arrear details entity
• udf7: number
  udf7 of the arrear details entity
• udf8: number
  udf8 of the arrear details entity
• udf9: number
  udf9 of the arrear details entity

{
    "description":"Account Arrears Model",
    "type":"object",
    "properties":{
        "acctNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "arsTypCd":{
            "description":"Arrear Type Code",
            "type":"string"
        },
        "rcdType":{
            "description":"Record Type",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product PRocessor Code",
            "type":"string"
        },
        "arsAssessedAmt":{
            "description":"Arrear Amount",
            "type":"number"
        },
        "arsPaidAmt":{
            "description":"Arrear Paid Amount",
            "type":"number"
        },
        "arsDueAmt":{
            "description":"Arrear Due Amount",
            "type":"number"
        },
        "lastPaymentDt":{
            "description":"Last payment Date",
            "type":"string"
        },
        "daysInArs":{
            "description":"Days in Arrears",
            "type":"number"
        },
        "referenceVal":{
            "description":"Reference Value",
            "type":"string"
        },
        "installmentNum":{
            "description":"Installment Number",
            "type":"number"
        },
        "arsDueDt":{
            "description":"Arrears Due Date",
            "type":"string"
        },
        "subArsTyp":{
            "description":"Sub Arrear Type",
            "type":"string"
        },
        "udf1":{
            "description":"udf1 of the arrear details entity",
            "type":"number"
        },
        "udf2":{
            "description":"udf2 of the arrear details entity",
            "type":"number"
        },
        "udf3":{
            "description":"udf3 of the arrear details entity",
            "type":"number"
        },
        "udf4":{
            "description":"udf4 of the arrear details entity",
            "type":"number"
        },
        "udf5":{
            "description":"udf5 of the arrear details entity",
            "type":"number"
        },
        "udf6":{
            "description":"udf6 of the arrear details entity",
            "type":"number"
        },
        "udf7":{
            "description":"udf7 of the arrear details entity",
            "type":"number"
        },
        "udf8":{
            "description":"udf8 of the arrear details entity",
            "type":"number"
        },
        "udf9":{
            "description":"udf9 of the arrear details entity",
            "type":"number"
        },
        "udf10":{
            "description":"udf10 of the arrear details entity",
            "type":"number"
        },
        "udf11":{
            "description":"udf11 of the arrear details entity",
            "type":"number"
        },
        "udf12":{
            "description":"udf12 of the arrear details entity",
            "type":"number"
        },
        "udf13":{
            "description":"udf13 of the arrear details entity",
            "type":"number"
        },
        "udf14":{
            "description":"udf14 of the arrear details entity",
            "type":"number"
        },
        "udf15":{
            "description":"udf15 of the arrear details entity",
            "type":"number"
        },
        "udf16":{
            "description":"udf16 of the arrear details entity",
            "type":"number"
        },
        "udf17":{
            "description":"udf17 of the arrear details entity",
            "type":"number"
        },
        "udf18":{
            "description":"udf18 of the arrear details entity",
            "type":"number"
        },
        "udf19":{
            "description":"udf19 of the arrear details entity",
            "type":"number"
        },
        "udf20":{
            "description":"udf20 of the arrear details entity",
            "type":"number"
        },
        "udf21":{
            "description":"udf21 of the arrear details entity",
            "type":"number"
        },
        "udf22":{
            "description":"udf22 of the arrear details entity",
            "type":"number"
        },
        "udf23":{
            "description":"udf23 of the arrear details entity",
            "type":"number"
        },
        "udf24":{
            "description":"udf24 of the arrear details entity",
            "type":"number"
        },
        "udf25":{
            "description":"udf25 of the arrear details entity",
            "type":"number"
        },
        "udf26":{
            "description":"udf26 of the arrear details entity",
            "type":"number"
        },
        "udf27":{
            "description":"udf27 of the arrear details entity",
            "type":"number"
        },
        "udf28":{
            "description":"udf28 of the arrear details entity",
            "type":"number"
        },
        "udf29":{
            "description":"udf29 of the arrear details entity",
            "type":"number"
        },
        "udf30":{
            "description":"udf30 of the arrear details entity",
            "type":"number"
        },
        "udf31":{
            "description":"udf31 of the arrear details entity",
            "type":"string"
        },
        "udf32":{
            "description":"udf32 of the arrear details entity",
            "type":"string"
        },
        "udf33":{
            "description":"udf33 of the arrear details entity",
            "type":"string"
        },
        "udf34":{
            "description":"udf34 of the arrear details entity",
            "type":"string"
        },
        "udf35":{
            "description":"udf35 of the arrear details entity",
            "type":"string"
        },
        "udf36":{
            "description":"udf36 of the arrear details entity",
            "type":"string"
        },
        "udf37":{
            "description":"udf37 of the arrear details entity",
            "type":"string"
        },
        "udf38":{
            "description":"udf38 of the arrear details entity",
            "type":"string"
        },
        "udf39":{
            "description":"udf39 of the arrear details entity",
            "type":"string"
        },
        "udf40":{
            "description":"udf40 of the arrear details entity",
            "type":"string"
        },
        "udf41":{
            "description":"udf41 of the arrear details entity",
            "type":"string"
        },
        "udf42":{
            "description":"udf42 of the arrear details entity",
            "type":"string"
        },
        "udf43":{
            "description":"udf43 of the arrear details entity",
            "type":"string"
        },
        "udf44":{
            "description":"udf44 of the arrear details entity",
            "type":"string"
        },
        "udf45":{
            "description":"udf45 of the arrear details entity",
            "type":"string"
        },
        "udf46":{
            "description":"udf46 of the arrear details entity",
            "type":"string"
        },
        "udf47":{
            "description":"udf47 of the arrear details entity",
            "type":"string"
        },
        "udf48":{
            "description":"udf48 of the arrear details entity",
            "type":"string"
        },
        "udf49":{
            "description":"udf49 of the arrear details entity",
            "type":"string"
        },
        "udf50":{
            "description":"udf50 of the arrear details entity",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation.

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.

405 Response

Invalid input

500 Response

Internal error

Back to Top