---
title: "Update PDF attributes including status"
method: PUT
path: "/api/integrations/pdfs/{heron_id}"
tags: ["EndUserIntegrations"]
---

# Update PDF attributes including status

`PUT /api/integrations/pdfs/{heron_id}`

Update PDF attributes including status

## Path parameters

- `heron_id` string, required

## Request body

- PdfPutSchema
  - `filename` string — The filename of the PDF
  - `fraud_reason` string, nullable — If fraud reason
  - `is_fraud` boolean — True if fraud was detected in the PDF
  - `notes` string — Notes associated with PDF, e.g., rejected reason, failed reason
  - `reference_id` string — An optional field for your unique identifier for the PDF
  - `status` 'new' | 'parsing' | 'parsed' | 'processed' | 'human_reviewing' | 'approved' | 'rejected' | 'failed' | 'transactions_loaded' | 'transactions_unloaded' — Status of PDF

## Response `200`

OK

- object
  - `pdf` PdfGetSchema
    - `account_id` string — Unique ID for account associated with PDF
    - `created` string, date-time — Timestamp when PDF was created in Heron system
    - `currency` 'USD' | 'GBP' — ISO 4217 currency code for transactions in account. We currently only support GBP and USD PDFs
    - `data_source` DataSourceNested
      - `heron_id` string — Heron ID of the data source
      - `is_enabled` boolean — Whether this data source is enabled
    - `end_user` EndUser2
      - `heron_id` string — Unique id for end user generated by Heron
    - `filename` string — The filename of the PDF
    - `heron_id` string — ID generated by Heron Data
    - `is_image_based` boolean, nullable — True if the PDF was processed using image-based OCR. None if not yet processed
    - `last_updated` string, date-time — Timestamp when PDF was last updated in Heron system
    - `notes` string — Notes for the PDF, e.g., failed reason
    - `parsing_version` string — Indicates which provider was used to parse this pdf
    - `reference_id` string — An optional field for your unique identifier for the PDF
    - `statements` PdfStatement[]
      - `data_source_account` DataSourceAccountNested
        - `heron_id` string — Heron ID of the data source account
        - `is_enabled` boolean — Whether this data source account is enabled
      - `exclude` boolean — True if the statement should be excluded from processing
      - `invalid_transaction_partials` PdfPatchTransaction[]
        - `amount` number, nullable
        - `balance` number, nullable
        - `bounds` MoneyThumbTransactionBounds
          - `page` integer, nullable, required
          - `x_max` integer, nullable, required
          - `x_min` integer, nullable, required
          - `y_max` integer, nullable, required
          - `y_min` integer, nullable, required
        - `currency` string, nullable
        - `description` string, nullable
        - `ocr_suspect` boolean, nullable
        - `reference_id` string, nullable
        - `timestamp` string, date-time, nullable
        - `transaction_code` string, nullable
      - `summary` MoneyThumbStatementSummary
        - `account_number` string
        - `account_title` string
        - `bank_name` string
        - `company` string
        - `currency` string
        - `end_balance` number, required
        - `fraud_reasons` string[]
        - `fraud_score` integer
        - `is_business_account` boolean
        - `is_ocr` boolean
        - `max_resolution` integer
        - `min_resolution` integer
        - `num_credits` integer, required
        - `num_debits` integer, required
        - `num_transactions` integer, required
        - `reconciled` boolean, required
        - `start_balance` number, required
        - `statement_end_date` string, date-time
        - `statement_start_date` string, date-time
        - `total_credits` number, required
        - `total_debits` number, required
        - `unreconciled_end_balance` number
        - `web_report` boolean
      - `transaction_partials` PdfTransaction[]
        - `amount` number, required
        - `balance` number
        - `bounds` MoneyThumbTransactionBounds
          - `page` integer, nullable, required
          - `x_max` integer, nullable, required
          - `x_min` integer, nullable, required
          - `y_max` integer, nullable, required
          - `y_min` integer, nullable, required
        - `currency` string, nullable
        - `description` string, required
        - `ocr_suspect` boolean
        - `reference_id` string
        - `timestamp` string, date-time, required
        - `transaction_code` string
    - `status` 'new' | 'parsing' | 'parsed' | 'processed' | 'human_reviewing' | 'approved' | 'rejected' | 'failed' | 'transactions_loaded' | 'transactions_unloaded' — Status of PDF
  - `request_id` string — Unique UUID per request

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)