InvoiceExtract

Retrieves the collection of InvoiceExtractOutput resources.

SecurityBearer
Request
query Parameters
page
integer

The collection page number

Responses
200

InvoiceExtractOutput collection response

get/invoice-extract
Request samples 
Response samples 
[
  • {
    }
]
Extract information from a PDF invoice
Upload a PDF invoice and get back the invoice converted to XML.


The received XML may not contain all the necessary information and the filled data must be validated before sending to the tax authority.


SecurityBearer 
Request 
Request Body schema: multipart/form-data
file
string <binary> 
The PDF invoice to upload


 
conversion_configuration
string
Json object: {'default_vat_rate': {'type': 'number', 'default': 22}, 'convert_amounts': {'type': 'boolean', 'default': true}}


 
Responses 
200
OK


400
Invalid input


post/invoice-extract
Request samples 
Retrieves a InvoiceExtractOutput resource.
SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
200
InvoiceExtractOutput resource response


404
Resource not found


get/invoice-extract/{id}
Request samples 
Response samples 
{
  • "uuid": "string",
  • "acquisition_date": "string",
  • "filename": "string",
  • "job_status": "string",
  • "pages": 0
}
Get the raw extracted information
Retrieve the information extracted from the PDF in a raw JSON format


SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
102
Not ready yet


200
Job done


500
Elaboration error


get/invoice-extract/{id}/raw
Request samples 
Get the converted invoice
Retrieve the converted invoice. If still elaborating you will receive status code 102, otherwise 200 and the XML or JSON Invoice as the response content.


SecurityBearer 
Request 
path Parameters
id
required
string
 
Responses 
102
Not ready yet


200
Job done


500
Elaboration error


get/invoice-extract/{id}/result
Request samples