---
title: "[Internal] Get received invoice by id"
method: GET
path: "/api/received-invoices/{aggregate_id}"
tags: ["Received invoices"]
---

# \[Internal\] Get received invoice by id

`GET /api/received-invoices/{aggregate_id}`

## Request

- Base URL: `https://api.typless.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.typless.com/api/received-invoices/{aggregate_id}`
- Auth: none declared

## Path parameters

- `aggregate_id` string, uuid, required

## Query parameters

- `put_in_review` boolean

## Response `200`

Successful Response

- ReceivedDocumentDetailsDTO
  - `aggregate_id` string, uuid, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `file` string, uri, required
  - `adjusted_file` string, uri, nullable, required
  - `s3_location` S3Location, required
    - `bucket` string, required
    - `object` string, required
    - `original_file_name` string
  - `adjusted_s3_location` S3Location, required
    - `bucket` string, required
    - `object` string, required
    - `original_file_name` string
  - `source` union, required
    - SourceEmail
      - `type` 'EMAIL'
      - `created_at` string, date-time, required
      - `original_file_extension` string
      - `object_id` string, nullable
      - `from_email` string, nullable
      - `subject` string, nullable
      - `recipient_email` string, nullable
    - SourceMinimax
      - `type` 'MINIMAX'
      - `created_at` string, date-time, required
      - `original_file_extension` string
      - `organization_id` integer, required
      - `inbox_id` integer, required
      - `inbox_attachment_id` integer, required
    - SourceUpload
      - `type` 'UPLOAD'
      - `created_at` string, date-time, required
      - `original_file_extension` string
      - `identifier` string, required
      - `user_id` string, uuid, nullable
  - `status` 'CREATED' | 'EXTRACTION_IN_PROGRESS' | 'EXTRACTION_FINISHED' | 'EXTRACTION_FAILED' | 'WAITING_REVIEW' | 'IN_REVIEW' | 'CONFIRMED' | 'WAITING_EXPORT' | 'IN_EXPORT' | 'REJECTED' | 'EXPORTED' | 'EXPORT_ERROR' | 'MERGED', required
  - `approval_status` 'NOT_REQUIRED' | 'PENDING_EVALUATION' | 'WAITING_APPROVAL' | 'APPROVED' | 'REJECTED': The approval axis, orthogonal to ``DocumentStatus``.
  - `details` DocumentDetailsDTO, required
    - `fields` ExtractedField[]
      - `name` string, required
      - `data_type` 'AUTHOR' | 'STRING' | 'VAT_ID' | 'CURRENCY' | 'DATE' | 'NUMBER' | 'BOOLEAN' | 'SELECT' | 'CONSTANT' | 'MULTISELECT' | 'DATETIME' | 'UUID' | 'TAG', required
      - `values` ExtractedValue[], required
        - `x` integer
        - `y` integer
        - `width` integer
        - `height` integer
        - `page_number` integer
        - `value` string, nullable
        - `confidence_score` number
      - `multiple_values` boolean
    - `vat_rates` VatRateDTO[], required
      - `percentage` string, required
      - `net` string, required
      - `vat` string, required
      - `gross` string, nullable
    - `line_items` array[]
      - ExtractedField[]
        - `name` string, required
        - `data_type` 'AUTHOR' | 'STRING' | 'VAT_ID' | 'CURRENCY' | 'DATE' | 'NUMBER' | 'BOOLEAN' | 'SELECT' | 'CONSTANT' | 'MULTISELECT' | 'DATETIME' | 'UUID' | 'TAG', required
        - `values` ExtractedValue[], required
          - `x` integer
          - `y` integer
          - `width` integer
          - `height` integer
          - `page_number` integer
          - `value` string, nullable
          - `confidence_score` number
        - `multiple_values` boolean
  - `received_details` DocumentDetailsDTO, required
    - `fields` ExtractedField[]
      - `name` string, required
      - `data_type` 'AUTHOR' | 'STRING' | 'VAT_ID' | 'CURRENCY' | 'DATE' | 'NUMBER' | 'BOOLEAN' | 'SELECT' | 'CONSTANT' | 'MULTISELECT' | 'DATETIME' | 'UUID' | 'TAG', required
      - `values` ExtractedValue[], required
        - `x` integer
        - `y` integer
        - `width` integer
        - `height` integer
        - `page_number` integer
        - `value` string, nullable
        - `confidence_score` number
      - `multiple_values` boolean
    - `vat_rates` VatRateDTO[], required
      - `percentage` string, required
      - `net` string, required
      - `vat` string, required
      - `gross` string, nullable
    - `line_items` array[]
      - ExtractedField[]
        - `name` string, required
        - `data_type` 'AUTHOR' | 'STRING' | 'VAT_ID' | 'CURRENCY' | 'DATE' | 'NUMBER' | 'BOOLEAN' | 'SELECT' | 'CONSTANT' | 'MULTISELECT' | 'DATETIME' | 'UUID' | 'TAG', required
        - `values` ExtractedValue[], required
          - `x` integer
          - `y` integer
          - `width` integer
          - `height` integer
          - `page_number` integer
          - `value` string, nullable
          - `confidence_score` number
        - `multiple_values` boolean
  - `text_blocks` TextBlock[], nullable, required
    - `x` integer, required
    - `y` integer, required
    - `width` integer, required
    - `height` integer, required
    - `value` string, required
    - `page_number` integer, required
    - `number` integer, required
    - `parsed_values` ParsedValues
      - `number` string, nullable
      - `date` string, nullable
      - `vat_id` string, nullable
  - `business_unit_id` string, uuid, required
  - `modified_by` string, nullable, required
  - `recognition_type` string, nullable, required
  - `is_proforma` boolean, nullable, required
  - `document_type_name` string, nullable, required
  - `extraction_failed` boolean, nullable, required
  - `processed_by` string, nullable, required
  - `document_type_id` string, uuid, nullable, required
  - `file_name` string, required
  - `notes` string, nullable, required
  - `ever_confirmed` boolean, required
  - `locked_by` string, uuid, nullable, required
  - `locked_until` string, date-time, nullable, required
  - `tags` TagDTO[], required
    - `aggregate_id` string, uuid, required
    - `tenant_id` string, uuid, required
    - `parent_id` string, uuid, nullable, required
    - `name` string, required
    - `slug` string, required
    - `description` string, nullable, required
    - `color` string, nullable, required
    - `is_protected` boolean, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `version` integer, required
  - `payment_status` 'NOT_APPLICABLE' | 'UNPAID' | 'SCHEDULED' | 'PARTIALLY_PAID' | 'PAID' | 'OVERPAID'
  - `payment_records` PaymentRecordDTO[], nullable
    - `id` string, uuid, required
    - `document_id` string, uuid, required
    - `transaction_id` string, uuid, nullable, required
    - `payment_type` 'BANK_TRANSFER' | 'CASH' | 'OTHER', required
    - `amount` string, required
    - `currency` string, required
    - `document_amount` string, nullable
    - `matched_at` string, date-time, required
    - `matched_by` string, required
    - `match_method` 'AUTO_EXACT' | 'MANUAL' | 'SUGGESTED', required
    - `confirmed` boolean, required
    - `notes` string, nullable, required
  - `file_size` integer, nullable
  - `page_count` integer, nullable
  - `original_file_size` integer, nullable
  - `original_file_type` string, nullable
  - `checksum` string, nullable
  - `partner` PartnerDTO
    - `aggregate_id` string, uuid, required
    - `tenant_id` string, uuid, required
    - `company_id` string, uuid, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `vat_id` string, nullable, required
    - `registration_number` string, nullable, required
    - `name` string, nullable, required
    - `address_line_1` string, nullable, required
    - `address_line_2` string, nullable, required
    - `city` string, nullable, required
    - `postal_code` string, nullable, required
    - `country_code` string, nullable, required
    - `email` string, nullable, required
    - `phone` string, nullable, required
    - `website` string, nullable, required
    - `default_currency` string, nullable, required
    - `is_vat_registered` boolean, required
    - `notes` string, nullable, required
    - `bank_accounts` BankAccount[], nullable, required
      - `iban` string, nullable
      - `swift_bic` string, nullable
      - `bank_name` string, nullable
    - `registry_bank_accounts` BankAccount[], nullable, required
      - `iban` string, nullable
      - `swift_bic` string, nullable
      - `bank_name` string, nullable
    - `source` 'MANUAL' | 'CONFIRMATION' | 'EXTRACTION', required
    - `is_verified` boolean, required
    - `is_active` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/typless/apis/typless-api.md) · [All operations](https://skmtc.dev/typless/apis/typless-api/llms.txt) · [OpenAPI document](https://skmtc.dev/typless/apis/typless-api/revisions/d614787a47ef?raw)