InvoiceInterfaceStatus (PUT) | GEP TECH DOCUMENTATION

Overview

This Put API can be used to update the interface status on the invoice document, along with some additional action in Quantum by GEP to post the interface status received from the ERP/Financial System.

URL Format: https://api-leouat.gep.com/leo-invoice-interface/api/v1/InterfaceStatus

Request

https://api-leoqc.gep.com/leo-invoice-interface/api/v1/InterfaceStatus
Payload : [
    {
        "invoiceDocumentType":"string",
        "documentNumber": "string",
        "supplierInvoiceNumber":"string",
        "clientSupplierCode":"string",
        "sourceSystemName":"string",
        "comments":{
            "accessType":"int",
            "commentText":"string"
        },
        "statusInfo": "string",
        "interfaceSourceSystemName":"string"
    }
]

Response

 {
    "returnValue": {
        "errorDetails": [],
        "successDetails": [
            {
                "invoiceDocumentType": “string”,
                "documentNumber": "string",
                "supplierInvoiceNumber": "string",
                "clientSupplierCode": " string ",
                "sourceSystemName": " string ",
                "statusInfo": " string ",
                "documentStatus": "string",
                "interfaceStatus": "string",
                "documentURL": "string",
                "errorDetails": {
                    "errorCode": "string",
                    "errorDescription": "string"
                },
                "interfaceSourceSystemName": “string”
            }
        ]
    },
    "isSuccess": true,
    "errors": null,
    "exception": null,
    "errorMessage": null,
    "errorCode": null,
    "correlationId": "0HN52BAMD1GUV:00000001"
}

Data Elements

Payload/Request
Property	Required?	Data type	Description	Validations / Exceptions
invoiceDocumentType	No	String	Name of invoice document type.
documentNumber	Yes, if supplierInvoiceNumber /clientSupplierCode was not provided in the payload	String (100)	Document Number against which action to be performed.	Document Number or Supplier Document Number is Mandatory
supplierInvoiceNumber	Yes, if documentNumber /clientSupplierCode was not provided in the payload	String	Supplier Invoice Number against which action to be performed.	Document Number or Supplier Document Number is Mandatory
sourceSystemName	Yes, if clientSupplierCode was provided in the payload.	String	It is the source system name from which request came.
clientSupplierCode	Yes, if supplierInvoiceNumber /documentNumber was not provided in the payload	String	Client Supplier Code will be used to filter the documents against which action to be performed. Will be sending in payload and same will come in response under erroDetail/successDetail.
statusInfo	Yes	String	Interface Status that we’re trying to update on the document.	Incorrect status: does not exist in the system
comments	No	Object	Check the Comments object data
interfaceSourceSystemName	No	String	Interface Source System Name like ERP/Financial System

Interface Status 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.

Success/Error Details
Property	Required?	Data type	Description	Validations / Exceptions
invoiceDocumentType		String	Name of invoice document type. This will always null in error/success object
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	Supplier Invoice Number against which action to be performed. Will be sending in payload and same will come in response under erroDetail/successDetail.
sourceSystemName		string	It is the source system name from which request came. Will be sending in payload and same will come in response under erroDetail/successDetail
clientSupplierCode		string	Client Supplier Code will be used to filter the documents against which action to be performed. Will be sending in payload and same will come in response under erroDetail/successDetail.
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
statusInfo		string	Interface Status that we’re trying to update on the document. Will be sending in payload and same will come in response under erroDetail/successDetail.
comments		Object	Check the Comments object data
documentURL		String	This will be null in Error object. Actual document url will get in successDetails
errorDetails		Object	This object contains errorCode and errorDescription. This will empty for successDetails
interfaceSourceSystemName		String	Interface Source System Name like ERP/Financial System

Comments

Property	Required?	Data type	Description	Validations / Exceptions
commentText		String	Comment can be passed to updated on document if anything required