Get started Integration Guide Services & Reach API Specification Changelogs
Search
API overview REST API Getting Started Common & authentication API Invoices API Documents API Companies & settings API Lookups API Detect API Validator API Receivables API Billing API Scanning API B2CFI API B2CNO API B2CSE API Partner API SOAP API Getting Started Account Configuration API Methods Invoice Sending API Methods Invoice Receiving API Methods B2C Norway API Methods B2C Finland API Methods Other API Methods

Invoice Receiving API Methods

API methods for invoice receiving. For new integrations, we recommend using the REST API instead.

invoice_download

Used for downloading company’s received invoices.

/v1.1/api/invoice_download

Input

api_keys ApiKeys

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key
Key Type Description
id string invoice id
xmlformat array Specify 1-n formats for download. If the original file being downloaded is any of the specified formats, the original file is returned. Otherwise the first format of the array is returned. Supported formats: finvoice, finvoice20, finvoice30, teapps, teapps30, ubl, liinos, svefaktura, sedi, ehf, ehf20, vismaxml, vismaxml60, e2b, woodx, axflow, facturae, bgc, peppolbis20, peppolbis30, siubl, siubl12, siubl20, vismaubl, vismaubl30
include_metadata boolean Return invoice related information in the metadata. See the fields included in the metadata from the example response below
options InvoiceDownloadOptionArray Array Of InvoiceOptions

options

options InvoiceDownloadOptionArray

Key Type Description
generate_image_if_missing boolean If there is no original invoice image specified, setting this to true creates a custom Maventa invoice image PDF based on the invoice XML data. False by default.

FIX_IMAGE_PENDING

Output

status string  
attachments FileAttachmentArray Array of attachments. Contains always the invoice XML. For XML formats not supporting embedded attachments, image and attachments are returned as separate objects. For XML formats supporting embedded attachments, the original attachments are returned only embedded to the XML file. With the exception that if the generate_image_if_missing is set as true, then the image we have created will be returned as a separate attachment, and not embedded into the XML file.
metadata InvoiceDownloadMetadata Information about the invoice, that may be used for invoice handling related controls. Returned only if requested.

attachments

attachments FileAttachmentArray

Key Type Description
attachment_type string For invoice XML value is the XML format requested e.g. PEPPOLBIS30. For invoice image, INVOICE_IMAGE and for other attachments ATTACHMENT
filename string Original or service generated filename
file base64 File contents in base64 format

metadata

metadata InvoiceDownloadMetadata

Key Type Description
origin string Source of the invoice, either EINVOICE or SCAN
original_format string Original XML format, value is empty if requested format is same as invoice’s original format
company_name string Sender company name
company_bid string Sender company business identifier
invoice_nr string  
reference_nr string  
sum string Invoice total without VAT
sum_tax string Invoice total including VAT (payable amount)
currency string  
date string  
date_due string  

Return values

Key Type Message Description
status string OK  
    ERROR: INVOICE NOT FOUND OR NO RIGHTS Requested invoice doesn’t exist for the company
    ERROR: USER NOT FOUND  
    ERROR: FORMAT NOT SUPPORTED Invoice format specified is not supported
    ERROR: INVOICE NOT COMPATIBLE WITH SELECTED FORMAT Invoice format specified is not compatible with original invoice format
    ERROR: VENDOR KEY MISSING Invalid or no vendor key provided

invoice_list_ids

Used for getting a list of invoice id’s. Otherwise the same as invoice_list_between_dates and invoice_list_inbound_between_dates but a lot faster as it only returns the invoice id’s.

/v1.1/api/invoice_list_ids

Input

api_keys ApiKeys

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key (mandatory)
Key Type Description
direction string IN or OUT
timestamp_start string Start time for search, format “YYYYMMDDHHMMSS”
timestamp_end string End time for search, format “YYYYMMDDHHMMSS”
options string Not yet implemented any

Output

return InvoiceListIdsStruct

Key Type Description
status string Status of the API call
invoice_ids Array Invoice DB-id

Return values

Key Type Message Description
status string OK  
    ERROR: VENDOR API KEY MISSING  
    ERROR: VENDOR API KEY INVALID OR DISABLED  
    ERROR: TIMESTAMP START FORMAT ERROR  
    ERROR: TIMESTAMP END FORMAT ERROR  
    ERROR: TIMEFRAME TOO LONG Max one month between start and end
    ERROR: INVALID DIRECTION  
    ERROR: USER NOT FOUND  
    ERROR: Unexpected error  

invoice_list_inbound_between_dates

Used for getting list of inbound invoices. With timestamps its possible to recheck an intervall if there’s reason to believe something was missed or need to redownload invoices. Recommended that ‘id’ of downloaded invoices is saved locally to be able to check for duplicates.

/v1.1/api/invoice_list_inbound_between_dates

Input

api_keys ApiKeys

Key Type Description
company_uuid string UUID of current company
user_api_key string User API key
vendor_api_key string Partner software API key
Key Type Description
timestamp_start string start time for search, format “YYYYMMDDHHMMSS”
timestamp_end string end time for search, format “YYYYMMDDHHMMSS”

FIX_EXAMPLE_PENDING

Output

return InboundInvoiceParamsOutCArray

Key Type Description
status string Status
id string Invoice db-id
state int Invoice state
currency string Currency abbrevation
invoice_nr string Invoice number
order_nr string Order number
sum string Total sum without tax
sum_tax string Total sum with tax
delivery_date string Delivery date, YYYYMMDD
delivery_type string Delivery type (e.g. mail)
reference_nr string Invoice reference number
date string Invoicing date, YYYYMMDD
date_due string Invoice due date, YYYYMMDD
customer_reference string Reference for customer (“Viitteenne”)
company_reference string Reference for company (“Viitteemme”)
company_comment string Comment for email invoice
notes string Additional information for invoice
lang string Language code for invoice (e.g. ‘FI’)
customer_nr string Customer number
customer_name string Recipient name
customer_email string Recipient email
customer_bid string Recipient BID/VAT/org number
customer_contact_p string Recipient contact person’s name
customer_address1 string Recipient street address
customer_address2 string Recipient additional address
customer_post_code string Recipient postal code
customer_post_office string Recipient postal office
customer_state string Recipient address state
customer_country string Recipient country code
customer_ovt string Recipient e-invoice address (EDI/OVT/GLN/EAN…)
company_name string Sender name
company_bid string Sender BID/VAT/org number
company_address1 string Sender street address
company_address2 string Sender additional address
company_post_code string Sender post code
company_post_office string Sender post office
company_city string Sender registered city
company_state string Sender address state
company_country string Sender country code
company_phone string Sender phone number
company_gsm string Sender GSM number
company_fax string Sender fax number
company_email string Sender email
company_website string Sender website
company_interest string Invoice late interest rate
company_reminder string Invoice reminder fee
company_paper_fee string Invoice paper fee
user_name string Sender contact person
user_email string Sender contact email
user_phone string Sender contact phone
work_order_nr string Work order nr
payment_terms string Payment terms
invoice_delivery_address InvoiceDeliveryAddressOut Invoice delivery address
invoice_seller_information InvoiceSellerInformationOut Invoice seller information

invoice_delivery_address InvoiceDeliveryAddressOut

Key Type
post_code string
address2 string
country string
post_office string
name string
state string
id string
address1 string

invoice_seller_information InvoiceSellerInformationOut

Key Type
phone string
name string
email string
id string

Return values

Key Type Message
status string OK
    ERROR: TIMESTAMP START FORMAT ERROR
    ERROR: TIMESTAMP END FORMAT ERROR
    ERROR: NO INVOICES
    ERROR: UNKNOWN ERROR
Back to top
Give feedback Contact sales Chat with support