PostInvoicePaymentStatusUpdate (POST)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

This POST API allows pushing Invoice Payment Status Update posted in ERP into GEP SMART for further processing.

 

URL Format: https://<Instance>/SmartInterfaceAPI/api/Invoice/InvoicePaymentStatusUpdate

Request 
{
   "paymentReferenceNumber": "string",
   "paymentRemittanceId": "string",
   "remittanceStatus": "string"
}

 

Response 
{{
   "data": {},
   "statusCode": "string",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "string"
      }
   ]
}

 

Examples

Success Scenario - Request 


Request below describes that this contains only the mandatory attributes:

{
   "paymentReferenceNumber": "PRN13_14132019",
   "paymentRemittanceId": "PRN13_1413201902",
   "remittanceStatus": "canceled"
}

Success Scenario - Response 

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "PRN13_14132019"
      }
   ]
}

Error Scenario - Request 

{
   "paymentReferenceNumber": "PRN13_14132019",
   "paymentRemittanceId": "PRN13_14132019",
   "remittanceStatus": ""
}

Error Scenario - Response 

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "Document",
         "errors": [
            {
               "errorCode": "MandatoryField",
               "errorDescription": "Remittance Status is mandatory."
            }
         ]
      }
   ],
   "successDetails": []
}

 

Data Elements

Invoice Payment Status Update Model

Property

Required?

Data type

Description

Validations/Exceptions

PaymentReferenceNumber

Yes

String

Payment Reference Number of Invoice entity

  • Payment Reference Number is mandatory

  • Invalid Payment Reference Number

  • Payment Reference Number is already in Cancelled status

PaymentRemittanceId

Yes

String

Payment Remittance Id of Invoice entity

  • Payment Remittance Id is mandatory

  • Payment Remittance Id already exists

RemittanceStatus

Yes

String

Remittance Status for Invoice

  • Remittance Status Type is mandatory

  • Remittance Status Type is invalid or not supported