PATCH
/
api
/
integrations
/
pdfs
/
{heron_id}
/
processed
curl --request PATCH \
  --url https://app.herondata.io/api/integrations/pdfs/{heron_id}/processed \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "exclude": true,
  "index": 123,
  "summary": {
    "account_number": "<string>",
    "bank_name": "<string>",
    "company": "<string>",
    "currency": "<string>",
    "end_balance": 123,
    "fraud_reasons": [
      "<string>"
    ],
    "fraud_score": 123,
    "start_balance": 123,
    "statement_end_date": "2023-11-07T05:31:56Z",
    "statement_start_date": "2023-11-07T05:31:56Z"
  },
  "transactions": [
    {
      "amount": 123,
      "balance": 123,
      "bounds": {
        "page": 123,
        "x_max": 123,
        "x_min": 123,
        "y_max": 123,
        "y_min": 123
      },
      "currency": "<string>",
      "description": "<string>",
      "ocr_suspect": true,
      "reference_id": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "transaction_code": "<string>"
    }
  ]
}'
{
  "ok": true
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
heron_id
string
required

heron_id of the pdf

Body

application/json
​
index
integer
required

The index of the statement in the pdf to patch

​
transactions
object[]
required

The full list of transactions that will be used to override the extracted transactions for the specified statement

​
exclude
boolean

True if the statement should be excluded from processing

​
summary
object

Response

200 - application/json
Ok
​
ok
boolean

Was this page helpful?