Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
hiddentrue

Status

Status
colourPurple
titlestarted

Approver

In order to process your first document with the Gini Pay API, perform the following steps.

Info

The usage examples on the right are executed with cURL, a command-line tool to perform HTTP requests.

...

In order to get an access token for the Gini account, run the example command on the right. Make sure to replace:
random@example.org with your username,
geheim with your password,
client-id with your client ID,
client-secret with your client secret.

...

Now that you have the access token, you can upload your first document by sending an API request. The request must contain the corresponding Gini API version number. For example, for our first document, we use the Gini Pay API version v1. The command on the right sends a request against the corresponding version of the API.

...

The example response (shortened, on the right) is an invoice issued by Deutsche Post AG. The receiver of the invoice has to pay 12€ (see amountToPay). It contains one line item with article number 10101, a tax rate 19%, and an amount 12€.

...

In order to inform the system whether the extraction was correct or incorrect, send back the correct value in the feedback request. It is important that it should be the value exactly as it appears on the actual document (not calculated or inferred). Once the feedback is received it gets compared to the extracted value and the result is used further in reports and is included into a self-learning mechanism of the Gini extraction system.