Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Send transfer summary only on those labels that are physically seen by the user. Unseen labels except Return Assistant (RA) specific “amountsAreConsistent” should be filtered out.

...

Below we show a more elaborated example below including the Return Assistant compound extractions (if RA is enabled) in order to explain different types of the transfer summary. In our current API, we started to support alternative JSON keys for it. For example, instead of "feedback" key when submitting the summary, you can use "extractions" and "compoundExtractions" as you will see in the examples below.

The next example scenario is as follows: the user uploads a document where the labels amountToPay, paymentReference, iban, discount-addon are extracted. Unfortunately, the label paymentRecipient could not be extracted. Such response to the extractions request is as follows:

...

Code Block
languagejson
{
  "extractions": {
    "amountToPay": {
      "value": "45.44:EUR"
    },
    "iban": {
      "value": "DE14200800000816170700"
    },
    "bic": {
      "value": "BYLADEM1001"
    },
    "paymentPurpose": {
      "value": "RE-20170512-02"
    },
    "paymentRecipient": {
      "value": "Tchibo GmbH"
    },
    "amountsAreConsistent": {
      "entity": "text",
      "value": "true"
    },
    "discount-addon": {
      "entity": "amount",
      "value": "-2.51:EUR"
    }
  },
  "compoundExtractions": {
    "lineItems": [
      {
        "artNumber": {
          "value": "10101"
        },
        "quantity": {
          "value": "0"
        },
        "description": {
          "value": "Trocknerbälle, Wolle, 2er",
          "entity": "text"
        },
        "sumGross": {
          "value": "17.98:EUR",
          "entity": "amount"
        },
        "returnReason": {
          "value": "r3"
        }
      },
      {
        "artNumber": {
          "value": "10103"
        },
        "quantity": {
          "value": "3"
        },
        "description": {
          "value": "Faltenstopp f. Wäscheständer",
          "entity": "text"
        },
        "sumGross": {
          "value": "29.97:EUR",
          "entity": "amount"
        }
      }
    ]
  }
}
Info

Notice, that "feedback" key is not present in the above transfer summary. However, you can still keep it when submitting non-compound extractions summary, our API is compatible.

Submit transfer summary on invalid extractions

...