API shema | Vodnik po Typless aplikaciji

Process Invoice

post

Process a single invoice document using V1 format. The V1 format is the legacy format and is deprecated.

Authorizations

X-API-KeystringRequired

API key authentication

Body

file_namestringRequired

Name of the invoice file to be processed

Example: invoice.pdf

base64filestring · binaryRequired

File content as base64 encoded string

business_unit_idany ofOptional

ID of the business unit processing the invoice. If not provided (i.e. when using API key), the invoice will be processed for the processing business unit of that API key.

Example: 123e4567-e89b-12d3-a456-426614174000

string · uuidOptional

or

nullOptional

Responses

202

Accepted

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

post

/api/v1/process-invoice

POST /api/v1/process-invoice HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "file_name": "invoice.pdf",
  "base64file": "binary",
  "business_unit_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "poll_key": "1458b05b6b429f569c7c1512712d50b6e465595e",
  "message": "Put to processing!"
}

Process Invoice V2

post

Process a single invoice document using V2 format. The V2 format contains more information about the document compared to the V1 format.

Authorizations

X-API-KeystringRequired

API key authentication

Body

file_namestringRequired

Name of the invoice file to be processed

Example: invoice.pdf

base64filestring · binaryRequired

File content as base64 encoded string

business_unit_idany ofOptional

ID of the business unit processing the invoice. If not provided (i.e. when using API key), the invoice will be processed for the processing business unit of that API key.

Example: 123e4567-e89b-12d3-a456-426614174000

string · uuidOptional

or

nullOptional

Responses

202

Accepted

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

post

/api/v2/process-invoice

POST /api/v2/process-invoice HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "file_name": "invoice.pdf",
  "base64file": "binary",
  "business_unit_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "poll_key": "1458b05b6b429f569c7c1512712d50b6e465595e",
  "message": "Put to processing!"
}

Batch Process Document

post

Start processing a batch of documents. Documents should be in a single PDF file and should be split using the Typless stamp.

Authorizations

X-API-KeystringRequired

API key authentication

Body

file_namestringRequired

Name of the file to be processed

Example: invoice_batch.pdf

filestring · binaryOptional

File content as base64 encoded string

file_urlstring · uriOptional

URL to download the file

business_unit_idany ofOptional

ID of the business unit processing the document

Example: 123e4567-e89b-12d3-a456-426614174000

string · uuidOptional

or

nullOptional

Responses

202

Accepted

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

post

/api/v1/batch/process-document

POST /api/v1/batch/process-document HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "file_name": "invoice_batch.pdf",
  "file": "binary",
  "file_url": "https://example.com",
  "business_unit_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "poll_key": "1458b05b6b429f569c7c1512712d50b6e465595e"
}

Poll Invoice V1

get

Poll invoice processing status and get results in V1 format

Authorizations

X-API-KeystringRequired

API key authentication

Query parameters

inv_keystring · uuidRequired

Unique identifier for the invoice

Example: 123e4567-e89b-12d3-a456-426614174000

eslogbooleanOptional

Whether to return eSlog XML in the response

Default: falseExample: false

number_of_pagesbooleanOptional

Whether to include the number of pages in the response

Default: falseExample: false

add_candidatesbooleanOptional

Whether to include candidate matches in the response

Default: falseExample: false

Responses

200

Successful Response

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

get

/api/v1/poll-invoice

GET /api/v1/poll-invoice?inv_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "file_name": "invoice.pdf",
  "details": {
    "iban": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "inv_num": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "purpose_code": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "reference": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "vat_id_buyer": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "vat_id_publisher": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "inv_date": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "pay_until": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "service_provided_at": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "gross": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "net": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "vat": {
      "value": "FieldValue",
      "found": true,
      "validated": true
    },
    "vat_id_details": [
      {
        "address": "123 Business Street",
        "capital": "1000000",
        "country": "SI",
        "date_reg": "2020-01-01",
        "iban": [
          "SI561234123412341234"
        ],
        "mat_id": "MAT123",
        "name": "Example Corp",
        "name_long": "Example Corporation GmbH",
        "post": "12345",
        "vat_id": "SI12345678"
      }
    ],
    "vats": [
      {
        "gross": {
          "value": "FieldValue",
          "found": true,
          "validated": true
        },
        "net": {
          "value": "FieldValue",
          "found": true,
          "validated": true
        },
        "vat": {
          "value": "FieldValue",
          "found": true,
          "validated": true,
          "percentage": "22.0000",
          "type": "base"
        }
      }
    ],
    "products": [
      {
        "text": "Product A",
        "ident": "SKU12345",
        "value": "100.0000",
        "price": "100.0000",
        "quantity": "1.0000",
        "discount": "0.0000",
        "gross": "122.0000",
        "net": "100.0000",
        "vat": "22.0000",
        "unit": "kos",
        "vat_percentage": "22.0000",
        "discount_percentage": "0.0000",
        "id": 1
      }
    ]
  },
  "number_of_pages": 2
}

Poll Invoice V2

get

Poll invoice processing status and get results in V2 format with enhanced features

Authorizations

X-API-KeystringRequired

API key authentication

Query parameters

inv_keystring · uuidRequired

Unique identifier for the invoice

Example: 123e4567-e89b-12d3-a456-426614174000

eslogbooleanOptional

Whether to return eSlog XML in the response

Default: falseExample: false

number_of_pagesbooleanOptional

Whether to include the number of pages in the response

Default: falseExample: false

add_candidatesbooleanOptional

Whether to include candidate matches in the response

Default: falseExample: false

Responses

200

Successful Response

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

get

/api/v2/poll-invoice

GET /api/v2/poll-invoice?inv_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "file_name": "invoice.pdf",
  "details": {
    "metadata": {
      "supplier_name": "Example Supplier Ltd.",
      "supplier_vat_id": "SI12345678",
      "buyer_name": "Example Buyer Inc.",
      "buyer_vat_id": "SI87654321",
      "invoice_number": "INV-123456",
      "invoice_date": "2023-05-01",
      "service_date": "2023-04-30",
      "payment_due_date": "2023-05-31",
      "received_at_date": "2023-05-02",
      "net_amount": "100.00",
      "vat_amount": "22.00",
      "total_amount": "122.00",
      "currency": "EUR",
      "payment_reference": "REF123456",
      "purchasing_order": "PO-78901",
      "IBAN": "SI56123456789012345",
      "payment_purpose_code": "OTHR",
      "document_type": "INVOICE"
    },
    "line_items": [
      {
        "text": "Product A",
        "ident": "SKU12345",
        "value": "100.0000",
        "price": "100.0000",
        "quantity": "1.0000",
        "discount": "0.0000",
        "gross": "122.0000",
        "net": "100.0000",
        "vat": "22.0000",
        "unit": "kos",
        "vat_percentage": "22.0000",
        "discount_percentage": "0.0000",
        "id": 1
      }
    ],
    "vat_id_details": {
      "buyer": {
        "address": "123 Business Street",
        "capital": "1000000",
        "country": "SI",
        "date_reg": "2020-01-01",
        "iban": [
          "SI561234123412341234"
        ],
        "mat_id": "MAT123",
        "name": "Example Corp",
        "name_long": "Example Corporation GmbH",
        "post": "12345",
        "vat_id": "SI12345678"
      },
      "supplier": {
        "address": "123 Business Street",
        "capital": "1000000",
        "country": "SI",
        "date_reg": "2020-01-01",
        "iban": [
          "SI561234123412341234"
        ],
        "mat_id": "MAT123",
        "name": "Example Corp",
        "name_long": "Example Corporation GmbH",
        "post": "12345",
        "vat_id": "SI12345678"
      }
    }
  },
  "number_of_pages": 2
}

Poll Invoice Blocks

get

Get text blocks from a processed invoice

Authorizations

X-API-KeystringRequired

API key authentication

Query parameters

inv_keystring · uuidRequired

Unique identifier for the invoice

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Successful Response

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

get

/api/v1/poll-invoice/blocks

GET /api/v1/poll-invoice/blocks?inv_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "file_name": "invoice.pdf",
  "details": {
    "iban": {
      "found": true,
      "validated": true,
      "blocks": [
        {
          "height": 10,
          "page": "0",
          "value": "SI56 1234 5678 9012 345",
          "width": 150,
          "x": 100,
          "y": 200
        }
      ]
    }
  }
}

Invoice Text Blocks

get

Authorizations

X-API-KeystringRequired

API key authentication

Query parameters

inv_keystring · uuidRequired

Unique identifier for the invoice

Example: 123e4567-e89b-12d3-a456-426614174000

page_numberinteger · max: 100Required

Page number of the invoice to retrieve text blocks from

Example: 1

Responses

200

Successful Response

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

get

/api/v1/invoice/text-blocks

GET /api/v1/invoice/text-blocks?inv_key=123e4567-e89b-12d3-a456-426614174000&page_number=1 HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "text_blocks": [
    {
      "num": 1,
      "original_coordinates": {
        "height": 1,
        "width": 1,
        "x": 1,
        "y": 1
      },
      "text": "text",
      "x": 1,
      "y": 1,
      "width": 1,
      "height": 1,
      "page_number": 1,
      "doc_height": 1,
      "doc_width": 1
    }
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "page_number": 1
}

Batch Poll Document

get

Check the status of a batch document processing job and get the extracted data for all invoices in the batch when processing is complete.

Authorizations

X-API-KeystringRequired

API key authentication

Query parameters

poll_keystring · uuidRequired

Unique identifier for the batch processing job

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Successful Response - Processing complete

application/json

202

Processing in progress

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

get

/api/v1/batch/poll-document

GET /api/v1/batch/poll-document?poll_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "status": "SUCCESS",
  "results": [
    {
      "extraction_id": "123e4567-e89b-12d3-a456-426614174000",
      "results": {
        "supplier_name": {
          "values": [
            {
              "value": "Example Supplier Ltd.",
              "confidence_score": 0.95
            }
          ],
          "data_type": "AUTHOR",
          "multiple_values": false
        },
        "supplier_vat_id": {
          "values": [
            {
              "value": "SI12345678",
              "confidence_score": 0.98
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        },
        "buyer_vat_id": {
          "values": [
            {
              "value": "SI87654321",
              "confidence_score": 0.97
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        },
        "invoice_number": {
          "values": [
            {
              "value": "INV-12345",
              "confidence_score": 0.99
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        },
        "invoice_date": {
          "values": [
            {
              "value": "2023-05-15",
              "confidence_score": 0.95
            }
          ],
          "data_type": "DATE",
          "multiple_values": false
        },
        "payment_due_date": {
          "values": [
            {
              "value": "2023-06-15",
              "confidence_score": 0.9
            }
          ],
          "data_type": "DATE",
          "multiple_values": false
        },
        "net_amount": {
          "values": [
            {
              "value": "100.00",
              "confidence_score": 0.95
            }
          ],
          "data_type": "NUMBER",
          "multiple_values": false
        },
        "vat_amount": {
          "values": [
            {
              "value": "22.00",
              "confidence_score": 0.95
            }
          ],
          "data_type": "NUMBER",
          "multiple_values": false
        },
        "total_amount": {
          "values": [
            {
              "value": "122.00",
              "confidence_score": 0.99
            }
          ],
          "data_type": "NUMBER",
          "multiple_values": false
        },
        "currency": {
          "values": [
            {
              "value": "EUR",
              "confidence_score": 0.99
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        },
        "IBAN": {
          "values": [
            {
              "value": "SI56123456789012345",
              "confidence_score": 0.98
            }
          ],
          "data_type": "STRING",
          "multiple_values": true
        },
        "payment_reference": {
          "values": [
            {
              "value": "REF123-456",
              "confidence_score": 0.9
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        },
        "vat_rates": [
          {
            "percentage": "22.0000",
            "net": "100.0000",
            "vat": "22.0000",
            "gross": "122.0000"
          }
        ],
        "line_items": [
          {
            "description": "Product A",
            "ident": "SKU12345",
            "net_amount": "100.0000",
            "vat_amount": "22.0000",
            "vat_percentage": "22.0000",
            "total_amount": "122.0000",
            "unit_net_price": "100.0000",
            "unit_gross_price": "122.0000",
            "unit_price_discount": "0.0000",
            "quantity": "1.0000",
            "discount_percentage": "0.0000"
          }
        ]
      }
    },
    {
      "extraction_id": "223e4567-e89b-12d3-a456-426614174001",
      "results": {
        "supplier_name": {
          "values": [
            {
              "value": "Another Supplier Inc.",
              "confidence_score": 0.95
            }
          ],
          "data_type": "AUTHOR",
          "multiple_values": false
        },
        "supplier_vat_id": {
          "values": [
            {
              "value": "SI55555555",
              "confidence_score": 0.98
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        },
        "invoice_number": {
          "values": [
            {
              "value": "INV-54321",
              "confidence_score": 0.99
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        },
        "invoice_date": {
          "values": [
            {
              "value": "2023-05-16",
              "confidence_score": 0.95
            }
          ],
          "data_type": "DATE",
          "multiple_values": false
        },
        "total_amount": {
          "values": [
            {
              "value": "245.00",
              "confidence_score": 0.99
            }
          ],
          "data_type": "NUMBER",
          "multiple_values": false
        },
        "net_amount": {
          "values": [
            {
              "value": "200.82",
              "confidence_score": 0.95
            }
          ],
          "data_type": "NUMBER",
          "multiple_values": false
        },
        "vat_amount": {
          "values": [
            {
              "value": "44.18",
              "confidence_score": 0.95
            }
          ],
          "data_type": "NUMBER",
          "multiple_values": false
        },
        "currency": {
          "values": [
            {
              "value": "EUR",
              "confidence_score": 0.99
            }
          ],
          "data_type": "STRING",
          "multiple_values": false
        }
      }
    }
  ],
  "error": null
}

Batch Upload Url

post

Get a pre-signed URL for uploading a batch of documents. The uploaded documents are in a single PDF file and are split using the Typless stamp.

Authorizations

X-API-KeystringRequired

API key authentication

Query parameters

file_namestringRequired

Name of the file to be uploaded

Example: batch_invoices.pdf

Responses

200

Successful Response

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

post

/api/v1/batch/upload-url

POST /api/v1/batch/upload-url?file_name=batch_invoices.pdf HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "url": "https://s3.amazonaws.com/bucket/path/to/upload",
  "x-amz-tagging": "type=batch&source=api",
  "poll_key": "123e4567-e89b-12d3-a456-426614174000"
}

Batch Download Url

get

Get download URLs for split batch documents.

Authorizations

X-API-KeystringRequired

API key authentication

Query parameters

poll_keystring · uuidRequired

Unique identifier for the batch processing job

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Successful Response - Processing complete

application/json

202

Processing in progress

application/json

400

Bad request response. Check your input data.

application/json

401

Unauthorized. Check the URL and your authentication token.

application/json

403

Forbidden. Check the URL and your authentication token.

application/json

422

Validation Error

application/json

500

Internal server error

application/json

get

/api/v1/batch/download-urls

GET /api/v1/batch/download-urls?poll_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: tapp-api.typless.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "file_name": "batch_invoices.pdf",
  "status": "SUCCESS",
  "error": null,
  "documents_in_file": [
    {
      "file_name": "invoice_1.pdf",
      "url": "https://storage.example.com/invoices/batch_1/invoice_1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
    },
    {
      "file_name": "invoice_2.pdf",
      "url": "https://storage.example.com/invoices/batch_1/invoice_2.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
    },
    {
      "file_name": "invoice_3.pdf",
      "url": "https://storage.example.com/invoices/batch_1/invoice_3.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
    }
  ]
}

hashtagProcess Invoice

hashtagProcess Invoice V2

hashtagBatch Process Document

hashtagPoll Invoice V1

hashtagPoll Invoice V2

hashtagPoll Invoice Blocks

hashtagInvoice Text Blocks

hashtagBatch Poll Document

hashtagBatch Upload Url

hashtagBatch Download Url

Process Invoice

Process Invoice V2

Batch Process Document

Poll Invoice V1

Poll Invoice V2

Poll Invoice Blocks

Invoice Text Blocks

Batch Poll Document

Batch Upload Url

Batch Download Url