Contents x
    [PREVIEW] Send only the PDF of an invoice to be put in the system
    • 20 Jun 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    [PREVIEW] Send only the PDF of an invoice to be put in the system

    • Updated on 20 Jun 2025
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /api/v1/invoices/purchaseinvoices/pdfonly

    [PREVIEW] Send the PDF of an invoice to be scanned and processed further based on the given PDF.

    Description

    This endpoint allows users to upload purchase invoices as PDF documents to Bloxs. This functionality is only available to users who have activated the "Scan and Recognize" module (available at an additional cost). 

    The field recognition feature automatically populates the purchase invoice entry screen based on the scanned PDF. After the initial recognition, the user must review the invoice screen to verify the recognized fields, complete any missing information, and confirm the data before proceeding with further processing.

    Only PDF files are supported, including multi-page documents. There is no maximum size to the pdf file. 

    Use Case

    The user utilizes a different program for creating its purchase invoices, however uses Bloxs for further adminstrative processing. After creating the purchase invoice the user wants to have the invoice available in Bloxs. By using this endpoint the user will be able to see the pdf file in Bloxs, and have the individual data fields from the invoice available as structured data in Bloxs.

    Request fields

    The request contains the following fields:

    FieldDescription
    subjectThe subject field of the purchase invoice. In many cases, the invoice number is used as the subject (text). The most logical approach is to combine the invoice number with a brief description. The description field is the field used when searching for the purchase invoice in Bloxs especially when no invoice number can be extracted directly from the PDF.
    file.fileNameThis property defines the name of the file which is added.
    file.mimeTypeThe format of the file in accordance with the MIME standards. The only MIME type which is accepted is PDF (application/pdf).
    file.base64The base64 string of the document.
    relatedIdentifiers

    Used to specify references of service tickets, contracts, purchase orders and/or supplier code. These values are used in Bloxs to retrieve data and automatically populate fields in the purchase order screen, facilitating the financial process. In particular for object details and general ledger accounts.

    A maximum of 10 entries can be entered, each with a maximum length of 50 characters. Multiple references can be entered in 1 request. In this case they need to be entered as an array. It is not necessary to specify to which type of entity the number is linked to (for example a service ticket or a contract).


    Security
    HTTP
    Type Bearer

    Please enter a valid token

    Body parameters
    Expand All
    object
    subject
    string Required
    Min length0
    Max length512
    file
    object (APIFilePutModel) Required
    fileName
    string Required
    Min length1
    Max length512
    mimeType
    string Required
    Min length1
    Max length100
    base64
    string Required
    Min length1
    relatedIdentifiers
    Array of string | null
    string
    Responses
    202

    null

    400

    The PDF file data has validation issues

    Expand All
    object
    type
    string | null
    title
    string | null
    traceId
    string | null
    status
    integer (int32)
    errors
    object | null
    property*
    Array of string | null additionalProperties
    string
    What's Next