DownloadThis Put API can be used to cancel payment details on the invoice document along with some additional action in Quantum by GEP to cancel payment details received from ERP.
URL Format: https://api-leouat.gep.com/leo-invoice-interface/api/v1/PaymentCancellation
https://api-leoqc.gep.com/leo-invoice-interface/api/v1/PaymentCancellation
Payload : [
{
"paymentReferenceNumber": "string",
"paymentRemittanceId": "string",
"documentNumber":"string",
"lob":"string",
"commentText":"string"
}
]
{
"returnValue": {
"errorDetails": [
{
"errors": [
{
"documentNumber": "string",
"documentStatus": "string",
"interfaceStatus": "string",
"documentURL": "string",
"errorCode": "string",
"errorDescription": "string"
}
],
"success": [],
"paymentReferenceNumber": "string",
"paymentRemittanceId": "string",
"paymentMethod": "string",
"paymentDate": "datetime",
"grossAmount": “decimal”,
"netAmount": “decimal”,
"discountAmount":”decimal”,
"adjustmentAmount": “decimal”,
"currency": "string",
"statusInfo": "string",
"comments": ”object”,
"batchId": "string",
"documentNumber": "string",
"clientSupplierCode": "string",
"sourceSystemName": "string",
"supplierInvoiceNumber": "string"
}
],
"successDetails": []
},
"isSuccess": “Boolean”,
"errors": “string”,
"exception": “object”,
"errorMessage": “string”,
"errorCode": “string”,
"correlationId": "string"
}
Payload/Request | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
documentNumber | No | String (100) | If Document Number is present in the payload, we’ll include in the search along with payment reference number and remittance id. | |
commentText | No | String | Comment can be passed to updated on document if anything required | |
paymentReferenceNumber | Yes | String | Reference Number of payment. This is used to search the documents for payment cancellation. | 1. Payment reference number is Mandatory 2. Invalid payment reference |
paymentRemittanceId | Yes | String | Remittance Id of payment | Payment remittance id is Mandatory |
lob | No | String | If Document Lob is present in the payload we’ll include in the search along with payment reference number and remittance id. | |
Payment Cancellation Response | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
returnValue | Object | Its an object that contains actual response data from API | ||
isSuccess | boolean | It’s a Boolean flag that defines API is successfully executed or not | ||
exception | Object | It’s provide stack trace if any exception occurred at API level | ||
errorMessage | string | It will just show as Exception Occurred if any | ||
Return Value | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
errorDetails |
| List of errorDetail object | An array of errorDetail comes in response specific to document given in payload. |
|
successDetails |
| List of successDetail object | An array of successDetail comes in response specific to document given in payload. |
|
Error Details | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
documentNumber | String (100) | Document Number against which action to be performed. Will be sending in payload and same will come in response under erroDetail/successDetail | ||
supplierInvoiceNumber | String | This always be null as not required in the input payload | ||
sourceSystemName | string | This always be null as not required in the input payload | ||
clientSupplierCode | string | This always be null as not required in the input payload. | ||
documentStatus | string | Current Document Status will get in the response under erroDetail/successDetail | ||
InterfaceStatus | String | Current Interface status on the document will get in the response under erroDetail/successDetail | ||
documentURL | String | This will be null in Error object. Actual document url will get in successDetails | ||
errors | Object | Array of objects will get with document details if any error records. Error object will contain Error code and Error Description fields. | ||
Success Details | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
documentNumber | String (100) | Document Number against which action to be performed. Will be sending in payload and same will come in response under errorDetail/successDetail | ||
paymentRemittanceId | String | Payment Remittance Id will be sending in payload and same will come in response under successDetails | ||
paymentReferenceNumber | string | Payment Remittance Number will be sending in payload and same will come in response under successDetails | ||
lob | string | Document Lob will be sending in payload and same will come in response under successDetails. | ||
documentStatus | string | Current Document Status will get in the response under successDetails | ||
InterfaceStatus | String | Current Interface status on the document will get in the response under successDetails | ||
documentURL | String | This will be null in Error object. Actual document url will get in successDetails | ||