# Get Inbox Document Statuses

Get Inbox Document Statuses By VAT Number And DateFrom/To Range.

Endpoint: POST /rest/v1/documents/inbox/status
Version: v1.0.0
Security: PublicApiKey

## Query parameters:

  - `pageNumber` (integer)
    Page number (starting from 1)
    Example: 1

  - `pageSize` (integer)
    Number of items per page
    Example: 200

## Request fields (application/json):

  - `companyVatNumber` (string, required)
    The VAT number of the company.
    Example: "HR12345678910"

  - `dateFrom` (string)
    Start date for document search (optional)

  - `dateTo` (string)
    End date for document search (optional)

## Response 200 fields (application/json):

  - `items` (array, required)
    List of documents inbox statuses return model.

  - `items.documentId` (string, required)
    The unique identifier of the invoice document.
    Example: "6787a98e15306d37eed688a8"

  - `items.documentSenderName` (string, required)
    The name of the sender of the document.
    Example: "Example Sender Ltd."

  - `items.documentNumber` (string, required)
    The document number of the invoice.
    Example: "INV-2023-001"

  - `items.internalStatus` (string, required)
    The internal status of the document.
    Example: "NEW|OK|FAILED"

  - `items.externalStatus` (object, required)
    Response returned by the fiscalization service.

  - `items.externalStatus.responseId` (string, required)
    Identifier of the response received from the fiscalization service.
    Example: "resp-879812"

  - `items.externalStatus.requestId` (string, required)
    Identifier of the fiscalization request sent.
    Example: "req-123456"

  - `items.externalStatus.responseDateTime` (string, required)
    Timestamp from the fiscalization response.
    Example: "2025-07-21T10:15:30Z"

  - `items.externalStatus.successful` (boolean, required)
    Indicates if the fiscalization was successful.
    Example: true

  - `items.externalStatus.errorCode` (string)
    Error code returned if the fiscalization failed.
    Example: "ERR_FIS_1001"

  - `items.externalStatus.errorMessage` (string)
    Error message returned if the fiscalization failed.
    Example: "Invalid taxpayer ID."

  - `items.externalStatus.invalidRecordNumber` (integer)
    Index of the invalid record in the request.
    Example: 3

  - `items.externalStatus.retryRecommended` (boolean, required)
    Indicates whether a retry is recommended.

  - `items.supplierVatNumber` (string)
    The VAT number of the document supplier (optional).
    Example: "12345678901"

  - `items.supplierGln` (string)
    The GLN (Global Location Number) of the document supplier organization (optional).
    Example: "1234567890124"

  - `items.customerGln` (string)
    The GLN (Global Location Number) of the document customer organization (optional).
    Example: "1234567890125"

  - `items.customerName` (string)
    The name of the document customer.
    Example: "Example Customer Ltd."

  - `items.supplierBusinessUnit` (string)
    The business unit of the supplier organization (optional).
    Example: "Sales Department"

  - `items.customerBusinessUnit` (string)
    The business unit of the customer organization (optional).
    Example: "Procurement Department"

  - `items.amount` (string)
    The total amount of the document (optional).

  - `items.currency` (string)
    The currency of the document amount (optional).
    Example: "EUR"

  - `items.created` (string)
    The document creation timestamp.
    Example: "2024-11-15T15:52:47.331Z"

  - `items.modified` (string)
    The document last modification timestamp.
    Example: "2024-11-17T11:26:02.850Z"

  - `items.customerVatNumber` (string)
    The VAT number of the document customer (optional).
    Example: "98765432101"

  - `items.documentEdiType` (string)
    The EDI type of the document from document data.
    Example: "PLACEHOLDER"

  - `totalElements` (integer, required)
    Total number of inbox documents
    Example: 150

  - `totalPages` (integer, required)
    Total number of pages
    Example: 6

  - `size` (integer, required)
    Current page size
    Example: 25

  - `number` (integer, required)
    Current page number (1-based)
    Example: 1

  - `numberOfElements` (integer, required)
    Number of elements in current page
    Example: 25

  - `first` (boolean, required)
    Whether this is the first page
    Example: true

  - `last` (boolean, required)
    Whether this is the last page

  - `empty` (boolean, required)
    Whether the page is empty