Post remittance data in Spirit

This API allows posting the remittance data extracted by the AI process 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 depending on 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

The API returns a standard response structure for both successful and failed requests.

Field	Type	Description
`status`	String	Outcome of the request. Possible values are Success and Error.
`message`	String	Confirmation message in case of success, or error details in case of failure.

#### Success Response Example

{
  "status": "Success",
  "message": "Request processed successfully."
}

#### Error Response Example

{
  "status": "Error",
  "message": "The requested resource was not found."
}

version 6 as of 3 weeks ago by Daniele.Urciuoli

0 Comments

Please sign in to post a comment.

Post remittance data in Spirit

Request Body

Response Structure

0 Comments

Docs Navigation