Jump to

• Request
• Response

Update an existing feecharge.

put

/obcr-fees-charges-services/feecharge/{id}

This endpoint is used to Update an existing feecharge.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  key of the feecharge Maintenance

Header Parameters

• appId(required): string
  Application ID
• branchCode(required): string
  Branch Code
• contentType: string
  Content Type
• tenantId: string
  Tenant ID
• userId(required): string
  User ID

Body ()

Request Body that contains data required for updating an existing feecharge

Root Schema : DmTmFeeChargeDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object DmTmFeeChargeDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "description":"ID",
                    "type":"string"
                },
                "feeChrgCd":{
                    "description":"Fee Charge Code",
                    "type":"string"
                },
                "feeChrgDesc":{
                    "description":"Fee Charge Description",
                    "type":"string"
                },
                "productProcessorCd":{
                    "description":"Product Processor Code",
                    "type":"string"
                },
                "feeChrgTyp":{
                    "description":"Fee Charge Type",
                    "type":"string"
                },
                "feeCatgry":{
                    "description":"Fee Category",
                    "type":"string"
                },
                "feeMthd":{
                    "description":"Fee Method",
                    "type":"string"
                },
                "effectiveDt":{
                    "description":"Effective Date",
                    "type":"string"
                },
                "expiryDt":{
                    "description":"Expiry Date",
                    "type":"string"
                },
                "ruleId":{
                    "description":"Rule ID",
                    "type":"string"
                },
                "resourceId":{
                    "description":"Resource ID",
                    "type":"string"
                },
                "chgPrcTmpltId":{
                    "description":"Charge Price ID",
                    "type":"string"
                },
                "DmTmFeesDtlsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmFeesDtlsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmFeeChargeDTO-allOf[1]

Type: object

Show Source

• chgPrcTmpltId: string
  Charge Price ID
• DmTmFeesDtlsDTO: array DmTmFeesDtlsDTO
• effectiveDt: string
  Effective Date
• expiryDt: string
  Expiry Date
• feeCatgry: string
  Fee Category
• feeChrgCd: string
  Fee Charge Code
• feeChrgDesc: string
  Fee Charge Description
• feeChrgTyp: string
  Fee Charge Type
• feeMthd: string
  Fee Method
• id: string
  ID
• productProcessorCd: string
  Product Processor Code
• resourceId: string
  Resource ID
• ruleId: string
  Rule ID

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID",
            "type":"string"
        },
        "feeChrgCd":{
            "description":"Fee Charge Code",
            "type":"string"
        },
        "feeChrgDesc":{
            "description":"Fee Charge Description",
            "type":"string"
        },
        "productProcessorCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "feeChrgTyp":{
            "description":"Fee Charge Type",
            "type":"string"
        },
        "feeCatgry":{
            "description":"Fee Category",
            "type":"string"
        },
        "feeMthd":{
            "description":"Fee Method",
            "type":"string"
        },
        "effectiveDt":{
            "description":"Effective Date",
            "type":"string"
        },
        "expiryDt":{
            "description":"Expiry Date",
            "type":"string"
        },
        "ruleId":{
            "description":"Rule ID",
            "type":"string"
        },
        "resourceId":{
            "description":"Resource ID",
            "type":"string"
        },
        "chgPrcTmpltId":{
            "description":"Charge Price ID",
            "type":"string"
        },
        "DmTmFeesDtlsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmFeesDtlsDTO"
            }
        }
    }
}

Nested Schema : DmTmFeesDtlsDTO

Type: array

Show Source

• Array of: object DmTmFeesDtlsDTO

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

Nested Schema : DmTmFeesDtlsDTO

Type: object

Show Source

• baseAmnt: string
  Base Amount
• feechargeMasterId: string
  Fee Charge Master ID
• feesVal: number
  Fee Value
• id: string
  ID

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID",
            "type":"string"
        },
        "feesVal":{
            "description":"Fee Value",
            "type":"number"
        },
        "baseAmnt":{
            "description":"Base Amount",
            "type":"string"
        },
        "feechargeMasterId":{
            "type":"string",
            "description":"Fee Charge Master ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns updated feecharge

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