Post remittance data in Spirit

This API allows to post the remittance data extracted and send it to Spirit.

#### Request URI

Request Body

The request body contains the remittance data extracted by the AI process. The payload structure is dynamic and may vary according to the extraction result.

#### Request Example

{
  "response": {
    "Output": {
      "RequestId": "{{REQUEST ID}}",
      "Extraction": {
        "ExtractionDetails": {
          "Entities": [
            [
              {
                "EntityName": "iban_code",
                "EntityValue": "",
                "EntityScoring": 0.96,
                "EntityAttachment": "00000000000000000000000000000000"
              },
              {
                "EntityName": "client_code",
                "EntityValue": "",
                "EntityScoring": 1,
                "EntityAttachment": "00000000000000000000000000000000"
              },
              {
                "EntityName": "client_name",
                "EntityValue": "OCADO",
                "EntityScoring": 0.96,
                "EntityAttachment": "00000000000000000000000000000000"
              },
              {
                "EntityName": "amount",
                "EntityValue": "25117,18",
                "EntityScoring": 0.96,
                "EntityAttachment": "00000000000000000000000000000000"
              },
              {
                "EntityName": "currency_extracted1",
                "EntityValue": "GBP",
                "EntityScoring": 0.96,
                "EntityAttachment": "00000000000000000000000000000000"
              },
              {
                "EntityName": "bank_statement_date",
                "EntityValue": "24/06/2024",
                "EntityScoring": 0.96,
                "EntityAttachment": "00000000000000000000000000000000"
              },
              {
                "EntityName": "document_number",
                "EntityValue": "80566",
                "EntityScoring": 0.96,
                "EntityAttachment": "00000000000000000000000000000000"
              },
              {
                "EntityName": "multi_remittance",
                "EntityValue": "false",
                "EntityScoring": 0.96,
                "EntityAttachment": ""
              },
              {
                "EntityName": "u_remittance_related_data",
                "EntityAttachment": "00000000000000000000000000000000",
                "EntityValue": [
                  {
                    "EntityName": "invoice_number",
                    "EntityValue": "1024001572",
                    "EntityScoring": 0.96
                  },
                  {
                    "EntityName": "amount_doc_currency",
                    "EntityValue": "8518,27",
                    "EntityScoring": 0.96
                  },
                  {
                    "EntityName": "currency_extracted2",
                    "EntityValue": "GBP",
                    "EntityScoring": 0.96
                  },
                  {
                    "EntityName": "document_date",
                    "EntityValue": "01/05/2024",
                    "EntityScoring": 0.96
                  }
                ]
              }
            ]
          ]
        }
      }
    }
  }
}

Response Structure

Field	Type	Description
`Message`	String	Execution result message
`Code`	String	HTTP response code

#### Response Example

{
  "Message": "Success",
  "Code": "200"
}

version 5 as of 2 weeks ago by Giuseppe Modena

0 Comments

Please sign in to post a comment.

Post remittance data in Spirit

Request Body

Response Structure

0 Comments

Docs Navigation