Submit Payment Summary on Extractions

Payment Summary is approved or corrected extraction values that are submitted by your application to the extraction system.

You should always submit the summary in order to be able to measure the extraction quality and let Gini know whether the extracted information is correct. This way we can provide the best possible user experience, since it also helps us continuously improve the extraction system and perform valuable data analytics for you.

Gini employs various machine learning techniques in order to learn from the payment summary automatically. Therefore, it is equally important for Gini to receive the summary both on correct and incorrect extractions.

Ways of submitting the payment summary

There are currently two ways to submit the summary.

The first and the most common one is to submit the complete summary in one request. This is the easiest way if your frontend (application) displays the extractions on a screen in an editable form. A user can modify the extractions before pressing the confirmation button.

The second (rarely used) way is where the final approval signal (button click) is not possible. In such case, send the summary on one label per request.

Types of payment summaries

• positive summary (preferred): the extraction was correct and confirmed by the user without modification.

• complementary summary: the extraction system extracted nothing, for example, the response doesn't contain the requested label. The user manually entered the correct value.

• negative summary: the extraction was incomplete or erroneous. The user manually corrected the extraction.

• informative summary: the extraction was changed for another reason, for example, if a line item is returned, the quantity extraction gets summary "0" and a return reason.

The Gini Pay API lets you submit payment summary on multiple extractions for a single document with a single request. It is strongly recommended that you submit the summary in this way for two reasons. On the one hand, the total number of round trips is reduced to one and the summary is handled internally as a batch. Therefore, the update is more efficient for multiple extractions compared to submitting the summary with each separate request. On the other hand, Gini's machine learning training techniques can benefit from the summary on multiple extractions, since Gini is aware of the fact that single parts of the submitted summary belong together.

//submitting payment summary on extractions

    PUT /documents/{id}/extractions/feedback

Request

Headers

Body

Response

Test example

In order to test the integration of the summary functionality, we offer a PDF test document with the expected outcome in a JSON format. This document can be used for an integration test of Gini’s Pay API in general. Furthermore, we provide a query for sending summary where all fields are correct except for the amountToPay. After sending this summary, we show you how to ensure that the summary with your confirmation and correction for the field values was successful.

• Sending the test document to the Gini Pay API. See Submit Files.

• Requesting the results. See Retrieve Extractions.

• You should get a JSON like in the example.

• Correcting the document with the following JSON. Here we change the amountToPay from "995.00:EUR" to "950.00:EUR" and confirm the other field values (iban, bic, paymentRecipient, paymentReference).

{
   "feedback": {
       "amountToPay": {
           "value": "950.00:EUR"
       },
       "iban": {
           "value": "DE68130300000017850360"
       },
       "bic": {
           "value": "BYLADEM1001"
       },
       "paymentPurpose": {
           "value": "RE-20170512-02"
       },
       "paymentRecipient": {
           "value": "Fahrrad Rückenwind"
       }
   }
}

Below we show a more elaborated example here in order to explain different types of the payment summary. The example scenario is as follows: the user uploads a document where the labels amountToPay, paymentReference, iban are extracted. Unfortunately, the label paymentRecipient could not be extracted. The response to the extractions request is as follows:

{
    "candidates": {
    },
    "extractions": {
        "amountToPay": {
            "box": {
                "height": 8.0,
                "left": 545.0,
                "page": 1,
                "top": 586.0,
                "width": 17.0
            },
            "candidates": "amounts",
            "entity": "amount",
            "value": "5.60:EUR"
        },
        "iban": {
            "box": {
                "height": 7.0,
                "left": 447.0,
                "page": 1,
                "top": 746.0,
                "width": 100.0
            },
            "candidates": "ibans",
            "entity": "iban",
            "value": "DE68130300000017850360"
        },
        "paymentReference": {
            "entity": "reference",
            "value": "ReNr 123, KdNr 32"
        }
    },
    "compoundExtractions": {
        "lineItems": [
            {
              "artNumber": {
                "value": "10101",
                "entity": "text" ,
                "box": {
                    "height": 7.0,
                    "left": 55.0,
                    "page": 1,
                    "top": 546.0,
                    "width": 100.0
                }
              },
              "quantity": {
                "value": "12",
                "entity": "numeric"
              }
            },
            {
              "artNumber": {
                "value": "10103",
                "entity": "text"
              },
              "quantity": {
                "value": "3",
                "entity": "numeric"
              }
            }
        ]
    }
}

The user adds the missing paymentRecipient value (complementary summary) and corrects the paymentReference to "ReNr 1735, KdNr 37" (negative summary). Sets the quantity of one line item to 0 and adds a reason for returning the articles. The iban, amountToPay and the remaining part of lineItems are correct (positive summary). The document is not shown, so we can leave out the boxes. Then the resulting summary request is as follows:

{
   "extractions": {
       "amountToPay": {
           "value": "5.60:EUR"
       },
       "iban": {
           "value": "DE68130300000017850360"
       },
       "paymentReference": {
           "value": "ReNr 1735, KdNr 37"
       },
       "paymentRecipient": {
           "value": "Zalando SE"
       }
   },
 "compoundExtractions": {
        "lineItems": [
            {
              "artNumber": {
                "value": "10101"
              },
              "quantity": {
                "value": "0"
              },
              "returnReason": {
                "value": "r3"
              }
            },
            {
              "artNumber": {
                "value": "10103"
              },
              "quantity": {
                "value": "3"
              }
            }
        ]
    }
}

Then the resulting payment summary request is as follows:

{
   "feedback": {
       "amountToPay": {
           "value": "950.00:EUR"
       },
       "iban": {
           "value": "DE68130300000017850360"
       },
       "bic": {
           "value": "BYLADEM1001"
       },
       "paymentPurpose": {
           "value": "RE-20170512-02"
       },
       "paymentRecipient": {
           "value": "Fahrrad Rückenwind"
       }
   }
}

Submit payment summary on invalid extractions

Request

In case an extraction was erroneously found (i.e. not present in the source document), you can delete it by issuing a DELETE request to the extraction URI:

//submitting summary on invalid extractions

    DELETE /documents/{id}/extractions/{label}

Response