Outward Collections - Amendments APIs

Name Description Introduced In
createAmendment This API creates Outward Collections amendments records. 2023.01
getAmendments This API retrieves all the Outward Collection amendment records. 2023.01
getAmendmentById This API retrieves the Outward Collection amendment record by ID. 2023.01
updateAmendment This API updates the Outward Collections amendments record. 2023.01
updateAmendmentByBank This API updates an Outward Collections Amendments by Bank record. 2023.01
generateAmendmentReport This API downloads report for Outward Collection amendments. 2023.01
generateAmendmentsList This API exports list of Outward Collections Amendment records. 2023.01
ClosedcreateAmendment
 
Description: This API creates Outward Collections amendments records.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/createAmendment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "allowUsanceAcceptance": "Yes",
    "amendTenorType": "Usance",
    "amount": "50.00",
    "chargesDebitAccount": "130125",
    "collectionReference": "OCL23006H4Z7G",
    "corporateUserName": "MEIY",
    "creditAccount": "130125",
    "currency": "USD",
    "documentNo": "12345",
    "messageToBank": "message to bank",
    "otherCollectionDetails": "other collection details",
    "physicalDocuments": "[{\"documentTitle\":\"Drafts\",\"originalsCount\":\"0 Originals\",\"copiesCount\":\"1 Copies\"},{\"documentTitle\":\"B/L or AWB\",\"originalsCount\":\"2 Originals\",\"copiesCount\":\"3 Copies\"}]",
    "uploadDocuments": "[{\"documentName\":\"Print.pdf\",\"documentReferences\":\"TFD-CZsdW07C-wnBjd1r3-2WpBcids-pOr0pfwm\"}]",
    "usanceDays": "678",
    "usanceDetails": "usance details"

}
Response: 
{

    "amendmentNo": "1",
    "amendmentReference": "OUA23006LVU88",
    "status": "Submitted to Bank",
    "allowUsanceAcceptance": "Yes",
    "amendTenorType": "Usance",
    "amount": "50.00",
    "chargesDebitAccount": "130125",
    "collectingBank": "Bank of America",
    "collectionReference": "OCL23006H4Z7G",
    "corporateUserName": "MEIY",
    "creditAccount": "130125",
    "currency": "USD",
    "documentNo": "12345",
    "messageToBank": "message to bank",
    "otherCollectionDetails": "other collection details",
    "physicalDocuments": "[{\"copiesCount\":\"1 Copies\",\"originalsCount\":\"0 Originals\",\"documentTitle\":\"Drafts\"},{\"copiesCount\":\"3 Copies\",\"originalsCount\":\"2 Originals\",\"documentTitle\":\"B/L or AWB\"}]",
    "requestedOn": "2023-01-06T04:52:11Z",
    "tenorType": "Usance",
    "updatedOn": "2023-01-06T04:52:11Z",
    "uploadDocuments": "[{\"documentName\":\"Print.pdf\",\"documentReferences\":\"TFD-CZsdW07C-wnBjd1r3-2WpBcids-pOr0pfwm\"}]",
    "usanceDays": "678",
    "usanceDetails": "usance details",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 10118
    Error Message: "Input Validation Failed"
  • Error Code: 12001
    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/party/$partyId/type/$type/subtype/$subtype/serviceRequest

Field Mapping

UI Field Experience API field MS API field Transact API field
NA alertData NA NA
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amendment Number amendmentNo NA NA
Amendment Reference amendmentReference NA NA
Tenor Type amendTenorType NA NA
Amount amount NA NA
Cancellation Status cancellationStatus NA NA
Charges Debit Account chargesDebitAccount NA NA
Bank Name collectingBank NA NA
NA collectionReference NA NA
Corporate User Name corporateUserName NA NA
Courier Tracking Details courierTrackingDetails NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Document Number documentNo NA NA
Maturity Date maturityDate NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Document Details physicalDocuments NA NA
Reason for Rejection reasonForRejection NA NA
Reason for Return reasonForReturn NA NA
Requested On requestedOn NA NA
Returned History returnedHistory NA NA
Status status NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedgetAmendments
 
Description: This API retrieves all the Outward Collection amendment records.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/getAmendments
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "searchString": "",
    "pageSize": "",
    "pageOffset": "",
    "sortByParam": "",
    "sortOrder": "",
    "timeParam": "",
    "timeValue": "",
    "filterByValue": "",
    "filterByParam": ""
}
Response: 
{
    "OutwardCollectionAmendments": [{
        "amendmentNo": "1",
        "amendmentReference": "OUA23004H1Q6G",
        "collectionReference": "OCL230047ONYJ",
        "allowUsanceAcceptance": "Yes",
        "amendTenorType": "Usance",
        "amount": "50.00",
        "chargesDebitAccount": "130125",
        "collectingBank": "Bank of America",
        "creditAccount": "130125",
        "currency": "USD",
        "documentNo": "12345",
        "messageToBank": "message to bank",
        "otherCollectionDetails": "other collection details",
        "physicalDocuments": "[{\"copiesCount\":\"1 Copies\",\"originalsCount\":\"0 Originals\",\"documentTitle\":\"Drafts\"},{\"copiesCount\":\"3 Copies\",\"originalsCount\":\"2 Originals\",\"documentTitle\":\"B/L or AWB\"}]",
        "requestedOn": "2023-01-04T10:55:00Z",
        "status": "Approved",
        "tenorType": "Sight",
        "updatedOn": "2023-01-04T10:55:33Z",
        "uploadDocuments": "[{\"documentName\":\"Print.pdf\",\"documentReferences\":\"TFD-0DGzyfLZ-NstG9pMV-5fquaaFM-nmqa2lgj\"},{\"documentName\":\"DBB-13527.pdf\",\"documentReferences\":\"TFD-Iz8EClxy-Mu3BdLCe-Fl3BbiQ0-KRkQT1hV\"}]",
        "usanceDays": "678",
        "usanceDetails": "usance details",
        "serviceRequestSrmsId": "OUA23004H1Q6G",
        "product": "Outward Collection Amendment",
        "tradeCurrency": "USD"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 29093
    Error Message: "Failed to fetch record"
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
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amendment Number amendmentNo NA NA
Amendment Reference amendmentReference NA NA
Tenor Type amendTenorType NA NA
Amount amount NA NA
Cancellation Status cancellationStatus NA NA
Charges Debit Account chargesDebitAccount NA NA
Bank Name collectingBank NA NA
NA collectionReference NA NA
Corporate User Name corporateUserName NA NA
Courier Tracking Details courierTrackingDetails NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Document Number documentNo NA NA
Maturity Date maturityDate NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Document Details physicalDocuments NA NA
Reason for Rejection reasonForRejection NA NA
Reason for Return reasonForReturn NA NA
Requested On requestedOn NA NA
Returned History returnedHistory NA NA
Status status NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedgetAmendmentById
 
Description: This API retrieves the Outward Collection amendment record by ID.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/getAmendmentById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "amendmentReference": "OUA23006LVU88"

}
Response: 
{

    "allowUsanceAcceptance": "Yes",
    "amendTenorType": "Usance",
    "amendmentNo": "1",
    "amendmentReference": "OUA23006LVU88",
    "amount": "50.00",
    "chargesDebitAccount": "130125",
    "collectingBank": "Bank of America",
    "collectionReference": "OCL23006H4Z7G",
    "corporateUserName": "MEIY",
    "creditAccount": "130125",
    "currency": "USD",
    "documentNo": "12345",
    "messageToBank": "message to bank",
    "otherCollectionDetails": "other collection details",
    "physicalDocuments": "[{\"copiesCount\":\"1 Copies\",\"originalsCount\":\"0 Originals\",\"documentTitle\":\"Drafts\"},{\"copiesCount\":\"3 Copies\",\"originalsCount\":\"2 Originals\",\"documentTitle\":\"B/L or AWB\"}]",
    "requestedOn": "2023-01-06T04:52:11Z",
    "status": "Submitted to Bank",
    "tenorType": "Usance",
    "updatedOn": "2023-01-06T04:52:12.306Z",
    "uploadDocuments": "[{\"documentName\":\"Print.pdf\",\"documentReferences\":\"TFD-CZsdW07C-wnBjd1r3-2WpBcids-pOr0pfwm\"}]",
    "usanceDays": "678",
    "usanceDetails": "usance details",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 29049
    Error Message: "Mandatory fields are missing"
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
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amendment Number amendmentNo NA NA
Amendment Reference amendmentReference NA NA
Tenor Type amendTenorType NA NA
Amount amount NA NA
Cancellation Status cancellationStatus NA NA
Charges Debit Account chargesDebitAccount NA NA
Bank Name collectingBank NA NA
NA collectionReference NA NA
Corporate User Name corporateUserName NA NA
Courier Tracking Details courierTrackingDetails NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Document Number documentNo NA NA
Maturity Date maturityDate NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Document Details physicalDocuments NA NA
Reason for Rejection reasonForRejection NA NA
Reason for Return reasonForReturn NA NA
Requested On requestedOn NA NA
Returned History returnedHistory NA NA
Status status NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedupdateAmendment
 
Description: This API updates the Outward Collections amendments record.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/updateAmendment
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "amendmentReference": "OUA23006LVU88",
    "allowUsanceAcceptance": "Yes",
    "amendTenorType": "Usance",
    "amount": "100.00",
    "cancellationStatus": "Requested",
    "chargesDebitAccount": "123161",
    "collectionReference": "",
    "creditAccount": "123153",
    "currency": "USD",
    "documentNo": "10011002",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"documentName\":\"Invoices\",\"originalsCount\":\"2\",\"copiesCount\":\"3\"},{\"documentName\":\"Bill of Landing\",\"originalsCount\":\"Will not submit\",\"copiesCount\":\"Will not Submit\"}]",
    "uploadedDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance"

}
Response: 
{

    "updatedOn": "2023-01-06T04:52:12.306Z",
    "status": "Submitted to Bank",
    "amendmentReference": "OUA23006LVU88",
    "allowUsanceAcceptance": "Yes",
    "amendTenorType": "Usance",
    "amount": "100.00",
    "cancellationStatus": "Requested",
    "chargesDebitAccount": "123161",
    "collectionReference": "OCL23006H4Z7G",
    "creditAccount": "123153",
    "currency": "USD",
    "documentNo": "10011002",
    "messageToBank": "Please proceed for the payment",
    "otherCollectionDetails": "First batch goods shipped, BOE send us a copy",
    "physicalDocuments": "[{\"documentTitle\":\"Invoices\",\"originalsCount\":\"2\",\"copiesCount\":\"3\"},{\"documentTitle\":\"Bill of Landing\",\"originalsCount\":\"Will not submit\",\"copiesCount\":\"Will not Submit\"}]",
    "uploadDocuments": "[{\"documentName\":\"Clearance Statement.pdf\"},{\"documentName\":\"Docuement1.zip\"}]",
    "usanceDays": "100",
    "usanceDetails": "From the Acceptance"

}
Error Code(s):
  • Error Code: 12003
    Error Message: "Invalid Status"
  • Error Code: 10118
    Error Message: "Input Validation Failed"
  • Error Code: 12002
    Error Message: "Record is not eligible to update. Reached maximum returns."
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
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amendment Number amendmentNo NA NA
Amendment Reference amendmentReference NA NA
Tenor Type amendTenorType NA NA
Amount amount NA NA
Cancellation Status cancellationStatus NA NA
Charges Debit Account chargesDebitAccount NA NA
Bank Name collectingBank NA NA
NA collectionReference NA NA
Corporate User Name corporateUserName NA NA
Courier Tracking Details courierTrackingDetails NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Document Number documentNo NA NA
Maturity Date maturityDate NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Document Details physicalDocuments NA NA
Reason for Rejection reasonForRejection NA NA
Reason for Return reasonForReturn NA NA
Requested On requestedOn NA NA
Returned History returnedHistory NA NA
Status status NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedupdateAmendmentByBank
 
Description: This API updates an Outward Collections Amendments by Bank record.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/updateAmendmentByBank
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{

    "amendmentReference": "OUA23006H8P16",
    "status": "Rejected"

}
Response: 
{

    "amendmentNo": "1",
    "amendmentReference": "OUA23006H8P16",
    "status": "Rejected",
    "allowUsanceAcceptance": "Yes",
    "amendTenorType": "Usance",
    "amount": "50.00",
    "chargesDebitAccount": "130125",
    "collectingBank": "Bank of America",
    "collectionReference": "OCL23006AJ2K3",
    "corporateUserName": "MEIY",
    "creditAccount": "130125",
    "currency": "USD",
    "documentNo": "12345",
    "messageToBank": "message to bank",
    "otherCollectionDetails": "other collection details",
    "physicalDocuments": "[{\"copiesCount\":\"1 Copies\",\"originalsCount\":\"0 Originals\",\"documentTitle\":\"Drafts\"},{\"copiesCount\":\"3 Copies\",\"originalsCount\":\"2 Originals\",\"documentTitle\":\"B/L or AWB\"}]",
    "requestedOn": "2023-01-06T05:00:44Z",
    "tenorType": "Usance",
    "updatedOn": "2023-01-06T05:02:42Z",
    "uploadDocuments": "[{\"documentName\":\"Print.pdf\",\"documentReferences\":\"TFD-CZsdW07C-wnBjd1r3-2WpBcids-pOr0pfwm\"}]",
    "usanceDays": "678",
    "usanceDetails": "usance details",
    "opstatus": 0,
    "httpStatusCode": 0

}
Error Code(s):
  • Error Code: 12003
    Error Message: "Invalid Status"
  • Error Code: 12005
    Error Message: "Record is not eligible to update. Reached maximum returns"
  • Error Code: 29077
    Error Message: "Unknown Status."
  • 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
Allow Usance Acceptance allowUsanceAcceptance NA NA
Amendment Number amendmentNo NA NA
Amendment Reference amendmentReference NA NA
Tenor Type amendTenorType NA NA
Amount amount NA NA
Cancellation Status cancellationStatus NA NA
Charges Debit Account chargesDebitAccount NA NA
Bank Name collectingBank NA NA
NA collectionReference NA NA
Corporate User Name corporateUserName NA NA
Courier Tracking Details courierTrackingDetails NA NA
Amount Credit Account creditAccount NA NA
Currency currency NA NA
Document Number documentNo NA NA
Maturity Date maturityDate NA NA
Message to Bank messageToBank NA NA
Other Collection Details otherCollectionDetails NA NA
Physical Document Details physicalDocuments NA NA
Reason for Rejection reasonForRejection NA NA
Reason for Return reasonForReturn NA NA
Requested On requestedOn NA NA
Returned History returnedHistory NA NA
Status status NA NA
Tenor Type tenorType NA NA
Updated On updatedOn NA NA
Uploaded Documents uploadDocuments NA NA
Usance Days usanceDays NA NA
Usance Details usanceDetails NA NA
ClosedgenerateAmendmentReport
 
Description: This API downloads report for Outward Collection amendments.
Method: POST
URL: {base_url}/services/data/v1/TradeFinance/operations/OutwardCollections/generateAmendmentReport
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    "amendmentReference": "OUA23006LVU88"
}
Response: 
{
    "fileId": "OUAM-IrEGW0k7-nVh8Yi77-MheLkYdW-pY7uskUN",
    "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 allowUsanceAcceptance NA NA
NA amendmentNo NA NA
ClosedgenerateAmendmentsList
 
Description: This API exports list of Outward Collections Amendment records.
Method: POST
URL: {base_url} /services/data/v1/TradeFinance/operations/OutwardCollections/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": "OUAM-IrEGW0k7-nVh8Yi77-MheLkYdW-pY7uskUN",
    "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/serviceRequest/$serviceRequestIds

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
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 9:47:05 PM IST