Inward Collections - Amendments APIs

Name Description Introduced In
createAmendment This API is a mock service to create Inward Collections Amendments records. 2022.10
GetInwardCollectionsAmendments This API retrieves list of Inward Collections Amendments. 2022.10
GetInwardCollectionsAmendmentById This API retrieves Inward Collections Amendments record by record id. 2022.10
updateInwardCollectionAmendment This API updates an Inward Collections Amendments record. 2022.10
generateAmendmentReport This API downloads report for Inward Collections Amendments record. 2022.10
generateAmendmentsList This API exports list of Inward Collections Amendments records. 2022.10
Object Data Model This Object Data Model describes the parameter name and other attribute details for Trade Finance.  
ClosedcreateAmendment
 
Description: This API creates Guarantees Amendments.
Method: POST
URL: {base_url} /services/data/v1/TradeFinance/operations/InwardCollections/createAmendment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "amendAmount": "23",
    "amendDocuments": "[{\"documentName\":\"Export Letter Of Credit Acknowledgement.pdf\",\"documentReferences\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\"}]",
    "amendMaturityDate": "2022-02-02",
    "amendRemittingBank": "ABC Bank",
    "amendTenorType": "Usance",
    "amendUsanceDetails": "Some details",
    "amount": "23",
    "collectionSrmsId": "INCL222597AHJD",
    "currency": "USD",
    "drawer": "Drawer",
    "maturityDate": "2022-02-02",
    "messageFromBank": "Hello",
    "receivedOn": "2022-02-02",
    "remittingBank": "ABC Bank",
    "tenorType": "Usance",
    "transactionReference": "INC22259PFN84"

}
Response: 
{

    "amendmentSrmsId": "INCL22262ZPV8Z",
    "amendAmount": "23",
    "amendDocuments": "[{\"documentName\":\"Export Letter Of Credit Acknowledgement.pdf\",\"documentReferences\":\"TFD-c05H9v6E-T1fdRSeb-6Id2RQ3u-ztrtQBhU\"}]",
    "amendMaturityDate": "2022-02-02",
    "amendRemittingBank": "ABC Bank",
    "amendTenorType": "Usance",
    "amendUsanceDetails": "Some details",
    "amount": "23",
    "collectionSrmsId": "INCL222597AHJD",
    "createdDate": "2022-09-19T12:29:00Z",
    "currency": "USD",
    "draweeAcknowledgement": "Pending",
    "drawer": "Drawer",
    "maturityDate": "2022-02-02",
    "messageFromBank": "Hello",
    "receivedOn": "2022-02-02",
    "remittingBank": "ABC Bank",
    "status": "New",
    "tenorType": "Usance",
    "transactionReference": "INC22259PFN84",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • Error Code: 12001
    Error Message: "Guarantee is not eligible to create amendment"
  • Error Code: 29049
    Error Message: "Mandatory Fields are Missing"
  • Error Code: 29073
    Error Message: "Record Cannot be Edited"
  • Error Code: 29093
    Error Message: "Requested Collections is not found"
  • Error Code: 29091
    Error Message: "Failed to create Inward Collections Amendments request order"
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA amendmentSrmsId          NA NA
Amount amendAmount    NA NA
Documents amendDocuments     NA NA
Maturity Date amendMaturityDate      NA NA
Remitting Bank amendRemittingBank     NA NA
Tenor Type amendTenorType    NA NA
Usuance Details amendUsanceDetails   NA NA
Amendment No amendmentNo   NA NA
Amount amount     NA NA
Cancellation Status cancellationStatus      NA NA
Created Date collectionSrmsId   NA NA
Currency createdDate     NA NA
Drawee Acknowledgement currency  NA NA
Drawee Acknowledgement Date draweeAcknowledgement  NA NA
Drawer Details draweeAcknowledgementDate     NA NA
Maturity Date drawer     NA NA
Message from Bank maturityDate      NA NA
Message to Bank messageFromBank   NA NA
Reason for Cancellation messageToBank     NA NA
Reason for Rejection reasonForCancellation      NA NA
Received On receivedOn       NA NA
Remitting Bank remittingBank NA NA
Status status       NA NA
Tenor Type tenorType      NA NA
Transaction Ref transactionReference  NA NA
ClosedGetInwardCollectionsAmendments
 
Description: This API retrieves list of Inward Collections Amendments.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/GetInwardCollectionsAmendments
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": ""
}
Response: 
{

    "InwardCollectionAmendments": [
        {
            "amendAmount": "12",
            "amendDocuments": "",
            "amendMaturityDate": "05/05/2022",
            "amendRemittingBank": "Hdfc",
            "amendTenorType": "Usance",
            "amendUsanceDetails": "45 days from shipment",
            "amendmentNo": "1",
            "amendmentSrmsId": "INCA22263NWR44",
            "amount": "200",
            "createdDate": "14/07/2022",
            "currency": "USD",
            "drawer": "Naveen",
            "maturityDate": "05/05/2022",
            "messageFromBank": "Nothing",
            "receivedOn": "14/07/2022",
            "remittingBank": "RBI",
            "tenorType": "Usance",
            "transactionReference": "124321"
        },

        {

            "amendAmount": "12",
            "amendDocuments": "",
            "amendMaturityDate": "05/05/2022",
            "amendRemittingBank": "Hdfc",
            "amendTenorType": "Usance",
            "amendUsanceDetails": "45 days from shipment",
            "amendmentNo": "1",
            "amendmentSrmsId": "INCA22263MO4AF",
            "amount": "200",
            "createdDate": "14/07/2022",
            "currency": "USD",
            "drawer": "Naveen",
            "maturityDate": "05/05/2022",
            "messageFromBank": "Nothing",
            "receivedOn": "14/07/2022",
            "remittingBank": "RBI",
            "tenorType": "Usance",
            "transactionReference": "124321"
        }
    ],

    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
  • Error Code: 29093
    Error Message: "Requested Collections is not found"
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/party/$partyId?$queryParams

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA searchString NA NA
NA pageSize NA NA
NA pageOffset NA NA
NA sortByParam NA NA
NA timeParam NA NA
NA timeValue NA NA
NA filterByValue NA NA
NA filterByParam NA NA
Amount amendAmount    NA NA
Documents amendDocuments     NA NA
Maturity Date amendMaturityDate      NA NA
Remitting Bank amendRemittingBank     NA NA
Tenor Type amendTenorType    NA NA
Usuance Details amendUsanceDetails   NA NA
Amendment No amendmentNo   NA NA
NA amendmentSrmsId NA NA
Amount amount     NA NA
Cancellation Status cancellationStatus      NA NA
Created Date collectionSrmsId   NA NA
Currency createdDate     NA NA
Drawee Acknowledgement currency  NA NA
Drawee Acknowledgement Date draweeAcknowledgement  NA NA
Drawer Details draweeAcknowledgementDate     NA NA
Maturity Date drawer     NA NA
Message from Bank maturityDate      NA NA
Message to Bank messageFromBank   NA NA
Reason for Cancellation messageToBank     NA NA
Reason for Rejection reasonForCancellation      NA NA
Received On receivedOn       NA NA
Remitting Bank remittingBank NA NA
Status status       NA NA
Tenor Type tenorType      NA NA
Transaction Ref transactionReference  NA NA
NA paymentAdvices NA NA
NA swiftMessages NA NA
ClosedGetInwardCollectionsAmendmentById
 
Description: This API retrieves Inward Collections Amendments record by record id.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/GetInwardCollectionsAmendmentById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
     "amendmentSrmsId": "INCA22263NWR44"
}
Response: 
{

    "amendAmount": "12",
    "amendDocuments": "",
    "amendMaturityDate": "05/05/2022",
    "amendRemittingBank": "Hdfc",
    "amendTenorType": "Usance",
    "amendUsanceDetails": "45 days from shipment",
    "amendmentNo": "1",
    "amendmentSrmsId": "INCA22263NWR44",
    "amount": "200",
    "createdDate": "14/07/2022",
    "currency": "USD",
    "drawer": "Naveen",
    "maturityDate": "05/05/2022",
    "messageFromBank": "Nothing",
    "receivedOn": "14/07/2022",
    "remittingBank": "RBI",
    "tenorType": "Usance",
    "transactionReference": "124321",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 29049
    Error Message: "Mandatory fields are missing"
  • Error Code: 29071
    Error Message: "Unable to fetch the record"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/serviceRequest/$serviceRequestIds

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA amendmentSrmsId NA NA
Amount amendAmount    NA NA
Documents amendDocuments     NA NA
Maturity Date amendMaturityDate      NA NA
Remitting Bank amendRemittingBank     NA NA
Tenor Type amendTenorType    NA NA
Usuance Details amendUsanceDetails   NA NA
Amendment No amendmentNo   NA NA
Amount amount     NA NA
Cancellation Status cancellationStatus      NA NA
Created Date collectionSrmsId   NA NA
Currency createdDate     NA NA
Drawee Acknowledgement currency  NA NA
Drawee Acknowledgement Date draweeAcknowledgement  NA NA
Drawer Details draweeAcknowledgementDate     NA NA
Maturity Date drawer     NA NA
Message from Bank maturityDate      NA NA
Message to Bank messageFromBank   NA NA
Reason for Cancellation messageToBank     NA NA
Reason for Rejection reasonForCancellation      NA NA
Received On receivedOn       NA NA
Remitting Bank remittingBank NA NA
Status status       NA NA
Tenor Type tenorType      NA NA
Transaction Ref transactionReference NA NA
NA paymentAdvices NA NA
NA swiftMessages NA NA
ClosedupdateInwardCollectionAmendment
 
Description: This API updates an Inward Collections Amendments record.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/updateInwardCollectionAmendment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "amendmentSrmsId": "INCA222637NDT4",
    "amendAmount": "12",
    "amendDocuments": "",
    "amendMaturityDate": "05/05/2022",
    "amendRemittingBank": "Hdfc",
    "amendTenorType": "Usance",
    "amendUsanceDetails": "45 days from shipment",
    "amendmentNo": "1",
    "amount": "200",
    "createdDate": "14/07/2022",
    "currency": "USD",
    "drawer": "Naveen",
    "maturityDate": "05/05/2022",
    "messageFromBank": "Nothing",
    "receivedOn": "14/07/2022",
    "remittingBank": "RBI",
    "tenorType": "Usance",
    "transactionReference": "124321",
    "collectionSrmsId": "INCL22263TP0RP",
    "draweeAcknowledgement": "Accept",
    "draweeAcknowledgementDate": "05/05/2022"

}
Response: 
{

    "amendmentSrmsId": "INCA222637NDT4",
    "amendAmount": "12",
    "amendDocuments": "",
    "amendMaturityDate": "05/05/2022",
    "amendRemittingBank": "Hdfc",
    "amendTenorType": "Usance",
    "amendUsanceDetails": "45 days from shipment",
    "amendmentNo": "1",
    "amount": "200",
    "createdDate": "14/07/2022",
    "currency": "USD",
    "drawer": "Naveen",
    "maturityDate": "05/05/2022",
    "messageFromBank": "Nothing",
    "receivedOn": "14/07/2022",
    "remittingBank": "RBI",
    "tenorType": "Usance",
    "transactionReference": "124321",
    "collectionSrmsId": "INCL22263TP0RP",
    "draweeAcknowledgement": "Accept",
    "draweeAcknowledgementDate": "05/05/2022"

}
Error Code(s):
  • Error Code: 26014
    Error Message: "Failed to fetch Customer ID"
  • Error Code: 29092
    Error Message: "Unable to update guarantee request order"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 29071
    Error Message: "Unable to fetch the record"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/serviceRequest/$serviceReqId

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA amendmentSrmsId NA NA
Amount amendAmount    NA NA
Documents amendDocuments     NA NA
Maturity Date amendMaturityDate      NA NA
Remitting Bank amendRemittingBank     NA NA
Tenor Type amendTenorType    NA NA
Usance Details amendUsanceDetails   NA NA
Amount  amount NA NA
Status status   NA NA
Cancellation Status cancellationStatus      NA NA
NA collectionSrmsId   NA NA
Currency currency NA NA
Drawer Details drawerDetails NA NA
Maturity Date maturityDetails NA NA
Message from Bank messageFromBank NA NA
Reason for Cancellation reasonForCancellation NA NA
Received On receivedOn NA NA
Remitting Bank remittingBank NA NA
Tenor Type tenorType NA NA
Reason For Rejection reasonForRejection      NA NA
Message to Bank messageToBank NA NA
Drawee Acknowledgement draweeAcknowledgement NA NA
Transaction Ref transactionReference NA NA
ClosedgenerateAmendmentReport
 
Description: This API downloads report for Inward Collections Amendments record.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/generateAmendmentReport
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "amendmentSrmsId": "INCL2225972RZ0"
}
Response: 
{
    "fileId": "INAM-YgOHnPR6-mvJTZzAG-i02KX2md-eIFYGaHQ",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29054
    Error Message: "Error occurred while initiating the trade finance download"
  • Error Code: 29056
    Error Message: "Error occurred while generating the trade finance file"
  • Error Code: 29049
    Error Message: "Mandatory fields are Missing"
  • Error Code: 29070
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS"
  • Error Code: 29071
    Error Message: "Unable to fetch the record"
  • Error Code: 12007
    Error Message: "Logged in User is not authorized to perform this action"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/v2.0.0/orders/serviceRequest/$serviceRequestIds

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA amendmentSrmsId NA NA
NA fileId    NA NA
ClosedgenerateAmendmentsList
 
Description: This API exports list of Inward Collections Amendments records.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/InwardCollections/generateAmendmentsList
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": "",
    "exportLCId": ""
}
Response: 
{
    "fileId": "INAM-YgOHnPR6-mvJTZzAG-i02KX2md-eIFYGaHQ",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29054
    Error Message: "Error occurred while initiating the trade finance download"
  • Error Code: 29055
    Error Message: "Something went wrong while generating report"
  • Error Code: 29056
    Error Message: "Error occurred while generating the trade finance file"
Enterprise Provider: Service Request Microservice
Enterprise API:

{base_url}/ v2.0.0/orders/party/$partyId?$queryParams

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA searchString NA NA
NA pageSize NA NA
NA pageOffset NA NA
NA sortByParam NA NA
NA timeParam NA NA
NA timeValue NA NA
NA filterByValue NA NA
NA filterByParam NA NA
NA exportLCId NA NA
NA fileId NA NA
ClosedObject Data Model
ClosedInward Collections
 
Field Name
|
Application/Table name
Expand/ Collapse
Share
Print

In this topic

Temenos Headquarters SA
2 Rue de l'Ecole-de-Chimie
CH - 1205 Geneva
Switzerland

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Tuesday, May 23, 2023 8:38:09 PM IST