Reminder

Send a payment reminder via the Ropo One API.

If the debtor does not pay on time, you can send a reminder.

Differences vs an invoice

Set jobtype to 1.
Do not send invoice rows (payrow).
Send the open amount in amount.
billcode (bank reference) is required.

Digital delivery methods

Reminders can be delivered digitally, for example as e-invoices or email.

B2C e-invoice

sendtype=b2c
evoice=<receiver e-invoice address>
evoiceint=<receiver e-invoice intermediary>
propertyrow.propname=job_finvoice_paymentid
propertyrow.propvalue=<invoicing subject>

B2B e-invoice

sendtype=evoice
evoice=<receiver e-invoice address>
evoiceint=<receiver e-invoice intermediary>

Email

sendtype=email
email=<receiver email address>

Other methods

Contact Ropo support.

Legacy notes

The message type 1 is 1 (jobtype tag)

2. The payment reminder does not contain any invoice rows (payrow tag)

3. The open sum of the invoice is presented with the amount tag

4. The Bank's reference number (billcode tag) is required

Set digital delivery method for the reminder

Reminders can be delivered by using different digital delivery methods, like b2c and b2b e-invoice, email.

For delivering reminders by using digital delivery methods the fields below must be populated.

• b2c e-invoice

o sendtype=b2c

o evoice=[receiver e-invoice address]

o evoiceint=[receiver e-invoice intermediator]

o propertyrow.propname = job_finvoice_paymentid

o propertyrow.propvalue = [invoicing subject]

• b2b e-invoice

o sendtype=evoice o evoice=[receiver e-invoice address] o evoiceint=[receiver e-invoice intermediator]

• email

o sendtype=email o email = [receiver email address]

• Other methods o Please contact Ropo support.

Minimum data

Minimum dataset fields required to post a reminder.

Fields

Key

Value

Notes

jobtype

Type of the job

1 = reminder

billcode

Invoice reference

Used as the default settlement reference for payment to your settlement account.

amount

Open amount of the invoice

billnum

Invoice number of the invoice

person

Consumer debtor’s name

Use the company field for a company debtor.

address

Debtor’s street address

postcode

Debtor’s post code

city

Debtor’s postal town

customertype

Customer type

2 = person, 1 = company

billdate

Invoice date

YYYY-MM-DD

paydate

Due date

YYYY-MM-DD

Example

{
    "datastream": {
        "dataset": [
            {
                "jobtype": "1",
                "billcode": "4349",
                "amount": "55.32",
                "billnum": "1000",
                "person": "Nelli Niirulainen",
                "address": "Kellokoskenkatu 15 A 3",
                "postcode": "70100",
                "city": "KUOPIO",
                "customertype": "2",
                "billdate": "2017-01-01",
                "paydate": "2017-01-14"
            }
        ]
    }
}

Add bills

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

DataIdentifierstringOptional

Data identifier defined by customer for tracking purposes

DataTypeIdentifierstringOptional

Data type identifier

Content-TypestringOptional

Content type

Body

Job

Responses

201

Successful operation

application/json

400

Bad request

application/json

401

Unauthorized

post

/jobs

POST /rest/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24435

{
  "datastream": {
    "debug": "true",
    "noreport": "true",
    "operator": "123456",
    "origname": "invoices.xml",
    "transferkey": "7d843a4e0d13ceb69b61e919ca4b0fbe",
    "fileid": "7d843a4e0d13ceb69b61e919ca4b0fbe",
    "batchid": "batch123123",
    "dataset": [
      {
        "accountdate": "2017-10-10",
        "address": "Satamakatu 123",
        "addressaddline1": "Johto",
        "addressaddline2": "PL 43",
        "addressaddline3": "CO Mauno Mansikka",
        "addresscountry": "FIN",
        "advancepayment": "15.00",
        "amount": "19.96",
        "billcode": "4349",
        "billdate": "2017-01-01",
        "xmldate": "2017-01-01",
        "billnum": "11213",
        "billtemplate": "CUSTOM",
        "billtemplateid": "123",
        "cashbill": "1",
        "checkbillnum": "1",
        "city": "KUOPIO",
        "claimtext": "Unpaid bill 123456.",
        "collectionprocess": "AUTO",
        "color": "0",
        "collectioninvoice": "0",
        "company": "Matin konepaja Oy",
        "contactperson": "Liisa Liukaas",
        "contactpersontitle": "Assistentti",
        "contactpersondepartment": "Customer service",
        "country": "FIN",
        "countryname": "Finland",
        "currency": "EUR",
        "custnum": "1022",
        "customerid": "1022",
        "customertype": "1",
        "deliverydate": "2017-01-24",
        "deliverymethod": "Kiitolinja",
        "deliveryterm": "NOK",
        "department": "Sales",
        "doublesided": "0",
        "email": "[email protected]",
        "email2": "[email protected]",
        "evoice": "FI123578612717718",
        "evoiceint": "NDEAFIHH",
        "finance": "0",
        "foreignamount": "123.32",
        "foreigncurrency": "SEK",
        "freetext": "Kiitokset tilauksesta!",
        "govid": "2262509-5",
        "jobtype": "0",
        "language": "fin",
        "model": "Malli tai merkki",
        "negvat": "1",
        "netamount": "16.10",
        "noticedate": "2017-03-24",
        "noticedate2": "2017-04-24",
        "noticedate3": "2017-05-24",
        "noticedate4": "2017-06-24",
        "noticefee": "10.00",
        "ordernumber": "10232",
        "ourcode": "Volvo ABC-553",
        "overdueinterest": "8.0",
        "ovt": "00371234567800001",
        "ownref": "155",
        "origbillnum": "123456",
        "paydate": "2017-01-17",
        "payplanamount": "100.00",
        "payplancount": "5",
        "payplaninterval": "1",
        "payplan": {
          "instalment": [
            {
              "date": "2017-01-17",
              "amount": "10.00"
            }
          ]
        },
        "pdfname": "preview.pdf",
        "period": "2017-02-17",
        "person": "Teppo Nuutinen",
        "phone": "+358441234567",
        "postclass": "2",
        "postcode": "70100",
        "putonhold": 1,
        "refundtobillnum": "11213",
        "refundtojobid": "31211",
        "refundiban": "FI2112345600000785",
        "refundmessage": "tm 22141739 tili 1514 va 4804",
        "refundmessagetype": "3",
        "salesman": "12",
        "salesmanname": "Sam Salesman",
        "sendtype": "post",
        "secondarysendtype": [
          {
            "sendtype": "b2c",
            "evoice": "FI123578612717718",
            "evoiceint": "NDEAFIHH"
          }
        ],
        "sensible": "0",
        "servicecode": "1",
        "servicecode_name": "Center X",
        "servicecode_dimension": "123",
        "TA0001": "TA-FI-STVOY0001-B",
        "TA0002": "1234",
        "TA0003": "Y",
        "totalamount": "19.96",
        "vatamount": "3.86",
        "vatlayout": "0",
        "vatid": "FI22059054",
        "vatperiod": "2017-02-17",
        "voucherbatch": "43",
        "vouchernum": "202132",
        "yourcode": "Teppo Nuutinen",
        "addaddress": [
          {
            "address": "Kuninkaankatu 15",
            "city": "KUOPIO",
            "addressaddline1": "Johto",
            "addressaddline2": "PL 43",
            "addressaddline3": "CO Mauno Mansikka",
            "addresstype": "1",
            "person": "Tauno Testaaja",
            "company": "Toiminimi Testaaja",
            "addresscountry": "FIN",
            "postcode": "70100",
            "custnum": "123456",
            "govid": "123456-7",
            "vatid": "FI1234567",
            "customertype": "1",
            "email": "[email protected]",
            "phone": "+3581234567",
            "partytext": "Workshop",
            "partycode": "xyz",
            "sitecode": "123456",
            "contactperson": "Liisa Assistentti",
            "countryname": "Sweden",
            "ovt": "00371234567800001",
            "department": "Kuopio",
            "contactpersontitle": "Salesmanager",
            "contactpersondepartment": "Sales"
          }
        ],
        "accountrow": [
          {
            "accountid": "3000",
            "credit": "100.00",
            "debit": "100.00",
            "desc": "Leivokset",
            "servicecode": "0",
            "servicecode_name": "300",
            "netamount": "120.01",
            "taxpr": "24.00",
            "vatamount": "27.62",
            "type": "A12345",
            "type2": "B12345",
            "type3": "C12345",
            "type4": "D12345",
            "type5": "123",
            "type6": "123",
            "type7": "123",
            "type8": "123",
            "type9": "123",
            "type10": "123",
            "kwh": "123,10",
            "voucherbatch": "A123",
            "batch": "OLDLEDGER",
            "vatcode": "1"
          }
        ],
        "advancepayments": [
          {
            "paid_amount": null,
            "paid_vat_excluded_amount": null,
            "unpaid_amount": null,
            "unpaid_vat_excluded_amount": null,
            "interest_percent": null,
            "prosessing_costs_amount": null,
            "vat_included_amount": null,
            "vat_excluded_amount": null,
            "duedate": null,
            "reference_identifier": null
          }
        ],
        "attachment": [
          {
            "attachmentid": "2519700",
            "attachmentfile": "JVBERi0xLjQNJeLjz9MNCjE",
            "attachmentname": "Attachment.pdf",
            "securityclass": "SEI01",
            "type": "cover",
            "jobid": "123456789"
          }
        ],
        "cashdiscountrow": [
          {
            "discountamount": "28.30",
            "discountbaseamount": "28.30",
            "discountdate": "2017-02-17",
            "discountpercent": "2",
            "discountfreetext": "10 pv -2%"
          }
        ],
        "contract": [
          {
            "contract_no": "123456",
            "name": "Network contract",
            "startdate": "2017-06-01",
            "enddate": "2018-06-01",
            "contractstatus": "closed",
            "type": "insurance",
            "termination_date": "2022-06-01",
            "terminationterm": "14",
            "product": "Home insurance"
          }
        ],
        "originalcurrency": [
          {
            "source": "job",
            "currency": "DKK",
            "rate": "1.501",
            "amount": "1.001",
            "currency_date": "2017-06-01"
          }
        ],
        "definitiondetails": [
          {
            "headertext": "Vuosikayttoarvio",
            "code": "E1003",
            "value": "17030",
            "unitcode": "kWh",
            "unitcodeun": "KWH"
          }
        ],
        "image": {
          "file": "JVBERi0xLjQNJeLjz9MNCjE",
          "pagecount": "2",
          "fileType": "txt"
        },
        "links": [
          {
            "name": "SellerReferenceIdentifierUrlText",
            "link": "http://www.seller.com/reference"
          }
        ],
        "packagedetails": {
          "packagelength": "1",
          "lengthquantityunitcode": "m",
          "lengthquantityunitcodeun": "M",
          "packagewidth": "1",
          "widthquantityunitcode": "m",
          "widthquantityunitcodeun": "M",
          "packageheight": "2",
          "heightquantityunitcode": "m",
          "heightquantityunitcodeun": "M",
          "packageweight": "100",
          "weightquantityunitcode": "kg",
          "weightquantityunitcodeun": "KG",
          "packagenetweight": "40",
          "netweightquantityunitcode": "kg",
          "netweightquantityunitcodeun": "TN",
          "packagevolume": "3",
          "volumequantityunitcode": "m3",
          "volumequantityunitcodeun": "M3",
          "transportcarriagequantity": "2",
          "carriagequantityunitcode": "kpl",
          "carriagequantityunitcodeun": "PCS"
        },
        "payee": {
          "address": "Sienikatu 3",
          "address2": "Sienikatu 3",
          "addressaddline1": "Johto",
          "addressaddline2": "PL 43",
          "addressaddline3": "CO Mauno Mansikka",
          "city": "Kuopio",
          "countryname": "Norway",
          "countrycode": "NOR",
          "contact_email": "[email protected]",
          "contact_name": "Asiakaspalvelu",
          "contact_phone": "020-123123",
          "govid": "1234567-8",
          "name": "Yritys Oy",
          "name_extension": "Kuopion toimipaikka",
          "ovt": "003712345678",
          "postcode": "00100",
          "vatid": "FI1234567",
          "www": "www.company.fi",
          "fax": "020-123123",
          "bankinfos": [
            {
              "name": "Nordea",
              "iban": "FI1234345312312312",
              "bic": "OKOYFIHH",
              "bban": "1234345312312312",
              "bankgiro": "123456789",
              "plusgirot": "123456789"
            }
          ]
        },
        "payrow": [
          {
            "accountid": "3000",
            "allownullvalues": "0",
            "amount": "0.76",
            "count": "10",
            "desc": "Leivokset",
            "discount": "25",
            "eancode": "5901234123457",
            "enddate": "2017-02-17",
            "freetext": "- 500 Mt kotisivutilaa",
            "invoicerowtype": "25600",
            "itemtype": "pcs",
            "netamount": "7.60",
            "priceunit": "e/kwh",
            "productid": "XN5",
            "rowline": "1",
            "rowtype": "3",
            "salesman": "12",
            "salesmanname": "Sam Salesman",
            "servicecode": "0",
            "startdate": "2017-02-17",
            "storage": "12345",
            "TA0001": "TA-FI-STVOY0001-B",
            "TA0002": "1234",
            "TA0003": "Y",
            "taxpr": "24.00",
            "totalamount": "10.00",
            "itemprice": "147.60",
            "totalitemprice": "147.60",
            "vatamount": "2.40",
            "vatcode": "1",
            "vatfreetext": "MOMS Directive 44 type",
            "subidentifier": "1",
            "identifier": "INDENFIER",
            "rowpositionidentifier": "1",
            "usageplacecode": "123456",
            "definitions": [
              {
                "headertext": "Vuosikayttoarvio",
                "code": "E1003",
                "value": "17030",
                "unitcode": "kWh",
                "unitcodeun": "KWH"
              }
            ],
            "packagedetails": {
              "packagelength": "1",
              "lengthquantityunitcode": "m",
              "lengthquantityunitcodeun": "M",
              "packagewidth": "1",
              "widthquantityunitcode": "m",
              "widthquantityunitcodeun": "M",
              "packageheight": "2",
              "heightquantityunitcode": "m",
              "heightquantityunitcodeun": "M",
              "packageweight": "100",
              "weightquantityunitcode": "kg",
              "weightquantityunitcodeun": "KG",
              "packagenetweight": "40",
              "netweightquantityunitcode": "kg",
              "netweightquantityunitcodeun": "TN",
              "packagevolume": "3",
              "volumequantityunitcode": "m3",
              "volumequantityunitcodeun": "M3",
              "transportcarriagequantity": "2",
              "carriagequantityunitcode": "kpl",
              "carriagequantityunitcodeun": "PCS"
            },
            "propertyrow": [
              {
                "propname": "E1002",
                "propvalue": "1402465093"
              }
            ],
            "discounts": [
              {
                "freetext": "Platinum customer discount",
                "reasoncode": "XYZ",
                "percent": "10.0",
                "amount": "10.00",
                "vatamount": "10.00",
                "baseamount": "100.00",
                "vatcategorycode": "ABC",
                "vatratepercent": "24"
              }
            ],
            "charges": [
              {
                "freetext": "Platinum customer discount",
                "reasoncode": "XYZ",
                "percent": "10.0",
                "amount": "10.00",
                "vatamount": "10.00",
                "baseamount": "100.00",
                "vatcategorycode": "ABC",
                "vatratepercent": "24"
              }
            ],
            "links": [
              {
                "name": "SellerReferenceIdentifierUrlText",
                "link": "http://www.seller.com/reference"
              }
            ],
            "rowoverdue": {
              "original_invoice_identifier": null,
              "original_invoice_date": null,
              "original_due_date": null,
              "original_invoice_total_amount": null,
              "original_epi_remittance_info_identifier": null,
              "paid_vat_excluded_amount": null,
              "paid_vat_included_amount": null,
              "paid_date": null,
              "un_paid_vat_excluded_amount": null,
              "un_paid_vat_included_amount": null,
              "collection_date": null,
              "collection_quantity": null,
              "quantity_unit_code": null,
              "quantity_unit_code_u_n": null,
              "collection_charge_amount": null,
              "interest_rate": null,
              "interest_start_date": null,
              "interest_end_date": null,
              "interest_period_text": null,
              "interest_date_number": null,
              "interest_charge_amount": null,
              "interest_charge_vat_amount": null,
              "amount_currency_identifier": null
            },
            "invoicerowaddress": [
              {
                "party_text": null,
                "party_code": null,
                "party_identifier": null,
                "party_identifier_scheme_id": null,
                "name": null,
                "name2": null,
                "department": null,
                "tax_code": null,
                "any_party_code": null,
                "any_party_code_scheme_id": null,
                "address": null,
                "address2": null,
                "address3": null,
                "postcode": null,
                "city": null,
                "country_code": null,
                "country_name": null,
                "subdivision": null,
                "post_box_id": null,
                "organisation_unit_number": null,
                "site_code": null
              }
            ]
          }
        ],
        "propertyrow": [
          {
            "propname": "E1002",
            "propvalue": "1402465093"
          }
        ],
        "marks": [
          {
            "jobid": "3000",
            "statustime": "2018-10-23 10:12:32",
            "text": "",
            "whodid": "3000",
            "specialmark": "1",
            "customermark": "1",
            "restricted": "1"
          }
        ],
        "taxrow": [
          {
            "netamount": "16.10",
            "taxpr": "24",
            "totalamount": "19.96",
            "vatamount": "3.86",
            "vatfreetext": "ALV 24",
            "vatcode": "AE",
            "vatexemptionreasoncode": "REC"
          }
        ],
        "xmldetailsrow": [
          {
            "text": "Rekisterinumero",
            "source": "teapps",
            "code": "rekno",
            "value": "ABC-123",
            "group": "123456"
          }
        ],
        "usageplaces": [
          {
            "address": {
              "address": "Kuninkaankatu 15",
              "city": "KUOPIO",
              "addressaddline1": "Johto",
              "addressaddline2": "PL 43",
              "addressaddline3": "CO Mauno Mansikka",
              "addresstype": "1",
              "person": "Tauno Testaaja",
              "company": "Toiminimi Testaaja",
              "addresscountry": "FIN",
              "postcode": "70100",
              "custnum": "123456",
              "govid": "123456-7",
              "vatid": "FI1234567",
              "customertype": "1",
              "email": "[email protected]",
              "phone": "+3581234567",
              "partytext": "Workshop",
              "partycode": "xyz",
              "sitecode": "123456",
              "contactperson": "Liisa Assistentti",
              "countryname": "Sweden",
              "ovt": "00371234567800001",
              "department": "Kuopio",
              "contactpersontitle": "Salesmanager",
              "contactpersondepartment": "Sales"
            },
            "energycontract": [
              {
                "contract_no": "123456",
                "name": "Verkkosopimus",
                "vendor_name": "Testiverkot",
                "startdate": "2017-06-01",
                "enddate": "2018-06-01",
                "expdate": "2018-06-01"
              }
            ],
            "code": "0070100",
            "fuse": "25 A",
            "usage_estimate": "20000",
            "usage_estimate_unit": "kWh",
            "grid_usageplace": "JSE000_2000111",
            "grid_edielno": "JSE000",
            "grid_govid": "0981408-6",
            "gsrn_code": "12345749012345678",
            "consumptionhistory": [
              {
                "consumption": "1234.76",
                "monthly_avg_peak": "234.76",
                "startdate": "2020-06-01",
                "enddate": "2020-07-01",
                "yoy_percentage_change": "8.00"
              }
            ],
            "freetext": [
              {
                "texttype": "HEADER",
                "textname": "Text header",
                "textvalue": "This is jobs free text"
              }
            ]
          }
        ],
        "freetexts": [
          {
            "texttype": "HEADER",
            "textname": "Text header",
            "textvalue": "This is jobs free text"
          }
        ],
        "discounts": [
          {
            "freetext": "Platinum customer discount",
            "reasoncode": "XYZ",
            "percent": "10.0",
            "amount": "10.00",
            "vatamount": "10.00",
            "baseamount": "100.00",
            "vatcategorycode": "ABC",
            "vatratepercent": "24"
          }
        ],
        "charges": [
          {
            "freetext": "Platinum customer discount",
            "reasoncode": "XYZ",
            "percent": "10.0",
            "amount": "10.00",
            "vatamount": "10.00",
            "baseamount": "100.00",
            "vatcategorycode": "ABC",
            "vatratepercent": "24"
          }
        ],
        "originalinvoicereferences": [
          {
            "invoicenumber": "123456",
            "invoicedate": "2017-12-31",
            "netamount": "7.60",
            "totalamount": "10.00"
          }
        ],
        "partialpayments": [
          {
            "paid_amount": null,
            "paid_vat_excluded_amount": null,
            "unpaid_amount": null,
            "unpaid_vat_excluded_amount": null,
            "interest_percent": null,
            "prosessing_costs_amount": null,
            "vat_included_amount": null,
            "vat_excluded_amount": null,
            "duedate": null,
            "reference_identifier": null
          }
        ],
        "interestrates": [
          {
            "interest_type": "text",
            "annual_rate": "19.90",
            "real_annual_rate": "27.29",
            "start_from_date": "2026-03-28",
            "end_at_date": null
          }
        ],
        "classification": {
          "documenttype": "GeneralNote"
        },
        "sendparameters": {
          "earliestsenddate": "2022-10-24",
          "delivery_channel_priority": "peppol,b2b"
        },
        "avtalegiro": "avtalegiro",
        "autogiro": "autogiro",
        "subset": [
          {
            "accountdate": "2017-10-10",
            "address": "Satamakatu 123",
            "addressaddline1": "Johto",
            "addressaddline2": "PL 43",
            "addressaddline3": "CO Mauno Mansikka",
            "addresscountry": "FIN",
            "advancepayment": "15.00",
            "amount": "19.96",
            "billcode": "4349",
            "billdate": "2017-01-01",
            "xmldate": "2017-01-01",
            "billnum": "11213",
            "billtemplate": "CUSTOM",
            "billtemplateid": "123",
            "cashbill": "1",
            "checkbillnum": "1",
            "city": "KUOPIO",
            "claimtext": "Unpaid bill 123456.",
            "collectionprocess": "AUTO",
            "color": "0",
            "collectioninvoice": "0",
            "company": "Matin konepaja Oy",
            "contactperson": "Liisa Liukaas",
            "contactpersontitle": "Assistentti",
            "contactpersondepartment": "Customer service",
            "country": "FIN",
            "countryname": "Finland",
            "currency": "EUR",
            "custnum": "1022",
            "customerid": "1022",
            "customertype": "1",
            "deliverydate": "2017-01-24",
            "deliverymethod": "Kiitolinja",
            "deliveryterm": "NOK",
            "department": "Sales",
            "doublesided": "0",
            "email": "[email protected]",
            "email2": "[email protected]",
            "evoice": "FI123578612717718",
            "evoiceint": "NDEAFIHH",
            "finance": "0",
            "foreignamount": "123.32",
            "foreigncurrency": "SEK",
            "freetext": "Kiitokset tilauksesta!",
            "govid": "2262509-5",
            "jobtype": "0",
            "language": "fin",
            "model": "Malli tai merkki",
            "negvat": "1",
            "netamount": "16.10",
            "noticedate": "2017-03-24",
            "noticedate2": "2017-04-24",
            "noticedate3": "2017-05-24",
            "noticedate4": "2017-06-24",
            "noticefee": "10.00",
            "ordernumber": "10232",
            "ourcode": "Volvo ABC-553",
            "overdueinterest": "8.0",
            "ovt": "00371234567800001",
            "ownref": "155",
            "origbillnum": "123456",
            "paydate": "2017-01-17",
            "payplanamount": "100.00",
            "payplancount": "5",
            "payplaninterval": "1",
            "payplan": {
              "instalment": [
                {
                  "date": "2017-01-17",
                  "amount": "10.00"
                }
              ]
            },
            "pdfname": "preview.pdf",
            "period": "2017-02-17",
            "person": "Teppo Nuutinen",
            "phone": "+358441234567",
            "postclass": "2",
            "postcode": "70100",
            "putonhold": 1,
            "refundtobillnum": "11213",
            "refundtojobid": "31211",
            "refundiban": "FI2112345600000785",
            "refundmessage": "tm 22141739 tili 1514 va 4804",
            "refundmessagetype": "3",
            "salesman": "12",
            "salesmanname": "Sam Salesman",
            "sendtype": "post",
            "secondarysendtype": [
              {
                "sendtype": "b2c",
                "evoice": "FI123578612717718",
                "evoiceint": "NDEAFIHH"
              }
            ],
            "sensible": "0",
            "servicecode": "1",
            "servicecode_name": "Center X",
            "servicecode_dimension": "123",
            "TA0001": "TA-FI-STVOY0001-B",
            "TA0002": "1234",
            "TA0003": "Y",
            "totalamount": "19.96",
            "vatamount": "3.86",
            "vatlayout": "0",
            "vatid": "FI22059054",
            "vatperiod": "2017-02-17",
            "voucherbatch": "43",
            "vouchernum": "202132",
            "yourcode": "Teppo Nuutinen",
            "addaddress": [
              {
                "address": "Kuninkaankatu 15",
                "city": "KUOPIO",
                "addressaddline1": "Johto",
                "addressaddline2": "PL 43",
                "addressaddline3": "CO Mauno Mansikka",
                "addresstype": "1",
                "person": "Tauno Testaaja",
                "company": "Toiminimi Testaaja",
                "addresscountry": "FIN",
                "postcode": "70100",
                "custnum": "123456",
                "govid": "123456-7",
                "vatid": "FI1234567",
                "customertype": "1",
                "email": "[email protected]",
                "phone": "+3581234567",
                "partytext": "Workshop",
                "partycode": "xyz",
                "sitecode": "123456",
                "contactperson": "Liisa Assistentti",
                "countryname": "Sweden",
                "ovt": "00371234567800001",
                "department": "Kuopio",
                "contactpersontitle": "Salesmanager",
                "contactpersondepartment": "Sales"
              }
            ],
            "accountrow": [
              {
                "accountid": "3000",
                "credit": "100.00",
                "debit": "100.00",
                "desc": "Leivokset",
                "servicecode": "0",
                "servicecode_name": "300",
                "netamount": "120.01",
                "taxpr": "24.00",
                "vatamount": "27.62",
                "type": "A12345",
                "type2": "B12345",
                "type3": "C12345",
                "type4": "D12345",
                "type5": "123",
                "type6": "123",
                "type7": "123",
                "type8": "123",
                "type9": "123",
                "type10": "123",
                "kwh": "123,10",
                "voucherbatch": "A123",
                "batch": "OLDLEDGER",
                "vatcode": "1"
              }
            ],
            "advancepayments": [
              {
                "paid_amount": null,
                "paid_vat_excluded_amount": null,
                "unpaid_amount": null,
                "unpaid_vat_excluded_amount": null,
                "interest_percent": null,
                "prosessing_costs_amount": null,
                "vat_included_amount": null,
                "vat_excluded_amount": null,
                "duedate": null,
                "reference_identifier": null
              }
            ],
            "attachment": [
              {
                "attachmentid": "2519700",
                "attachmentfile": "JVBERi0xLjQNJeLjz9MNCjE",
                "attachmentname": "Attachment.pdf",
                "securityclass": "SEI01",
                "type": "cover",
                "jobid": "123456789"
              }
            ],
            "cashdiscountrow": [
              {
                "discountamount": "28.30",
                "discountbaseamount": "28.30",
                "discountdate": "2017-02-17",
                "discountpercent": "2",
                "discountfreetext": "10 pv -2%"
              }
            ],
            "contract": [
              {
                "contract_no": "123456",
                "name": "Network contract",
                "startdate": "2017-06-01",
                "enddate": "2018-06-01",
                "contractstatus": "closed",
                "type": "insurance",
                "termination_date": "2022-06-01",
                "terminationterm": "14",
                "product": "Home insurance"
              }
            ],
            "originalcurrency": [
              {
                "source": "job",
                "currency": "DKK",
                "rate": "1.501",
                "amount": "1.001",
                "currency_date": "2017-06-01"
              }
            ],
            "definitiondetails": [
              {
                "headertext": "Vuosikayttoarvio",
                "code": "E1003",
                "value": "17030",
                "unitcode": "kWh",
                "unitcodeun": "KWH"
              }
            ],
            "image": {
              "file": "JVBERi0xLjQNJeLjz9MNCjE",
              "pagecount": "2",
              "fileType": "txt"
            },
            "links": [
              {
                "name": "SellerReferenceIdentifierUrlText",
                "link": "http://www.seller.com/reference"
              }
            ],
            "packagedetails": {
              "packagelength": "1",
              "lengthquantityunitcode": "m",
              "lengthquantityunitcodeun": "M",
              "packagewidth": "1",
              "widthquantityunitcode": "m",
              "widthquantityunitcodeun": "M",
              "packageheight": "2",
              "heightquantityunitcode": "m",
              "heightquantityunitcodeun": "M",
              "packageweight": "100",
              "weightquantityunitcode": "kg",
              "weightquantityunitcodeun": "KG",
              "packagenetweight": "40",
              "netweightquantityunitcode": "kg",
              "netweightquantityunitcodeun": "TN",
              "packagevolume": "3",
              "volumequantityunitcode": "m3",
              "volumequantityunitcodeun": "M3",
              "transportcarriagequantity": "2",
              "carriagequantityunitcode": "kpl",
              "carriagequantityunitcodeun": "PCS"
            },
            "payee": {
              "address": "Sienikatu 3",
              "address2": "Sienikatu 3",
              "addressaddline1": "Johto",
              "addressaddline2": "PL 43",
              "addressaddline3": "CO Mauno Mansikka",
              "city": "Kuopio",
              "countryname": "Norway",
              "countrycode": "NOR",
              "contact_email": "[email protected]",
              "contact_name": "Asiakaspalvelu",
              "contact_phone": "020-123123",
              "govid": "1234567-8",
              "name": "Yritys Oy",
              "name_extension": "Kuopion toimipaikka",
              "ovt": "003712345678",
              "postcode": "00100",
              "vatid": "FI1234567",
              "www": "www.company.fi",
              "fax": "020-123123",
              "bankinfos": [
                {
                  "name": "Nordea",
                  "iban": "FI1234345312312312",
                  "bic": "OKOYFIHH",
                  "bban": "1234345312312312",
                  "bankgiro": "123456789",
                  "plusgirot": "123456789"
                }
              ]
            },
            "payrow": [
              {
                "accountid": "3000",
                "allownullvalues": "0",
                "amount": "0.76",
                "count": "10",
                "desc": "Leivokset",
                "discount": "25",
                "eancode": "5901234123457",
                "enddate": "2017-02-17",
                "freetext": "- 500 Mt kotisivutilaa",
                "invoicerowtype": "25600",
                "itemtype": "pcs",
                "netamount": "7.60",
                "priceunit": "e/kwh",
                "productid": "XN5",
                "rowline": "1",
                "rowtype": "3",
                "salesman": "12",
                "salesmanname": "Sam Salesman",
                "servicecode": "0",
                "startdate": "2017-02-17",
                "storage": "12345",
                "TA0001": "TA-FI-STVOY0001-B",
                "TA0002": "1234",
                "TA0003": "Y",
                "taxpr": "24.00",
                "totalamount": "10.00",
                "itemprice": "147.60",
                "totalitemprice": "147.60",
                "vatamount": "2.40",
                "vatcode": "1",
                "vatfreetext": "MOMS Directive 44 type",
                "subidentifier": "1",
                "identifier": "INDENFIER",
                "rowpositionidentifier": "1",
                "usageplacecode": "123456",
                "definitions": [
                  {
                    "headertext": "Vuosikayttoarvio",
                    "code": "E1003",
                    "value": "17030",
                    "unitcode": "kWh",
                    "unitcodeun": "KWH"
                  }
                ],
                "packagedetails": {
                  "packagelength": "1",
                  "lengthquantityunitcode": "m",
                  "lengthquantityunitcodeun": "M",
                  "packagewidth": "1",
                  "widthquantityunitcode": "m",
                  "widthquantityunitcodeun": "M",
                  "packageheight": "2",
                  "heightquantityunitcode": "m",
                  "heightquantityunitcodeun": "M",
                  "packageweight": "100",
                  "weightquantityunitcode": "kg",
                  "weightquantityunitcodeun": "KG",
                  "packagenetweight": "40",
                  "netweightquantityunitcode": "kg",
                  "netweightquantityunitcodeun": "TN",
                  "packagevolume": "3",
                  "volumequantityunitcode": "m3",
                  "volumequantityunitcodeun": "M3",
                  "transportcarriagequantity": "2",
                  "carriagequantityunitcode": "kpl",
                  "carriagequantityunitcodeun": "PCS"
                },
                "propertyrow": [
                  {
                    "propname": "E1002",
                    "propvalue": "1402465093"
                  }
                ],
                "discounts": [
                  {
                    "freetext": "Platinum customer discount",
                    "reasoncode": "XYZ",
                    "percent": "10.0",
                    "amount": "10.00",
                    "vatamount": "10.00",
                    "baseamount": "100.00",
                    "vatcategorycode": "ABC",
                    "vatratepercent": "24"
                  }
                ],
                "charges": [
                  {
                    "freetext": "Platinum customer discount",
                    "reasoncode": "XYZ",
                    "percent": "10.0",
                    "amount": "10.00",
                    "vatamount": "10.00",
                    "baseamount": "100.00",
                    "vatcategorycode": "ABC",
                    "vatratepercent": "24"
                  }
                ],
                "links": [
                  {
                    "name": "SellerReferenceIdentifierUrlText",
                    "link": "http://www.seller.com/reference"
                  }
                ],
                "rowoverdue": {
                  "original_invoice_identifier": null,
                  "original_invoice_date": null,
                  "original_due_date": null,
                  "original_invoice_total_amount": null,
                  "original_epi_remittance_info_identifier": null,
                  "paid_vat_excluded_amount": null,
                  "paid_vat_included_amount": null,
                  "paid_date": null,
                  "un_paid_vat_excluded_amount": null,
                  "un_paid_vat_included_amount": null,
                  "collection_date": null,
                  "collection_quantity": null,
                  "quantity_unit_code": null,
                  "quantity_unit_code_u_n": null,
                  "collection_charge_amount": null,
                  "interest_rate": null,
                  "interest_start_date": null,
                  "interest_end_date": null,
                  "interest_period_text": null,
                  "interest_date_number": null,
                  "interest_charge_amount": null,
                  "interest_charge_vat_amount": null,
                  "amount_currency_identifier": null
                },
                "invoicerowaddress": [
                  {
                    "party_text": null,
                    "party_code": null,
                    "party_identifier": null,
                    "party_identifier_scheme_id": null,
                    "name": null,
                    "name2": null,
                    "department": null,
                    "tax_code": null,
                    "any_party_code": null,
                    "any_party_code_scheme_id": null,
                    "address": null,
                    "address2": null,
                    "address3": null,
                    "postcode": null,
                    "city": null,
                    "country_code": null,
                    "country_name": null,
                    "subdivision": null,
                    "post_box_id": null,
                    "organisation_unit_number": null,
                    "site_code": null
                  }
                ]
              }
            ],
            "propertyrow": [
              {
                "propname": "E1002",
                "propvalue": "1402465093"
              }
            ],
            "marks": [
              {
                "jobid": "3000",
                "statustime": "2018-10-23 10:12:32",
                "text": "",
                "whodid": "3000",
                "specialmark": "1",
                "customermark": "1",
                "restricted": "1"
              }
            ],
            "taxrow": [
              {
                "netamount": "16.10",
                "taxpr": "24",
                "totalamount": "19.96",
                "vatamount": "3.86",
                "vatfreetext": "ALV 24",
                "vatcode": "AE",
                "vatexemptionreasoncode": "REC"
              }
            ],
            "xmldetailsrow": [
              {
                "text": "Rekisterinumero",
                "source": "teapps",
                "code": "rekno",
                "value": "ABC-123",
                "group": "123456"
              }
            ],
            "usageplaces": [
              {
                "address": {
                  "address": "Kuninkaankatu 15",
                  "city": "KUOPIO",
                  "addressaddline1": "Johto",
                  "addressaddline2": "PL 43",
                  "addressaddline3": "CO Mauno Mansikka",
                  "addresstype": "1",
                  "person": "Tauno Testaaja",
                  "company": "Toiminimi Testaaja",
                  "addresscountry": "FIN",
                  "postcode": "70100",
                  "custnum": "123456",
                  "govid": "123456-7",
                  "vatid": "FI1234567",
                  "customertype": "1",
                  "email": "[email protected]",
                  "phone": "+3581234567",
                  "partytext": "Workshop",
                  "partycode": "xyz",
                  "sitecode": "123456",
                  "contactperson": "Liisa Assistentti",
                  "countryname": "Sweden",
                  "ovt": "00371234567800001",
                  "department": "Kuopio",
                  "contactpersontitle": "Salesmanager",
                  "contactpersondepartment": "Sales"
                },
                "energycontract": [
                  {
                    "contract_no": "123456",
                    "name": "Verkkosopimus",
                    "vendor_name": "Testiverkot",
                    "startdate": "2017-06-01",
                    "enddate": "2018-06-01",
                    "expdate": "2018-06-01"
                  }
                ],
                "code": "0070100",
                "fuse": "25 A",
                "usage_estimate": "20000",
                "usage_estimate_unit": "kWh",
                "grid_usageplace": "JSE000_2000111",
                "grid_edielno": "JSE000",
                "grid_govid": "0981408-6",
                "gsrn_code": "12345749012345678",
                "consumptionhistory": [
                  {
                    "consumption": "1234.76",
                    "monthly_avg_peak": "234.76",
                    "startdate": "2020-06-01",
                    "enddate": "2020-07-01",
                    "yoy_percentage_change": "8.00"
                  }
                ],
                "freetext": [
                  {
                    "texttype": "HEADER",
                    "textname": "Text header",
                    "textvalue": "This is jobs free text"
                  }
                ]
              }
            ],
            "freetexts": [
              {
                "texttype": "HEADER",
                "textname": "Text header",
                "textvalue": "This is jobs free text"
              }
            ],
            "discounts": [
              {
                "freetext": "Platinum customer discount",
                "reasoncode": "XYZ",
                "percent": "10.0",
                "amount": "10.00",
                "vatamount": "10.00",
                "baseamount": "100.00",
                "vatcategorycode": "ABC",
                "vatratepercent": "24"
              }
            ],
            "charges": [
              {
                "freetext": "Platinum customer discount",
                "reasoncode": "XYZ",
                "percent": "10.0",
                "amount": "10.00",
                "vatamount": "10.00",
                "baseamount": "100.00",
                "vatcategorycode": "ABC",
                "vatratepercent": "24"
              }
            ],
            "originalinvoicereferences": [
              {
                "invoicenumber": "123456",
                "invoicedate": "2017-12-31",
                "netamount": "7.60",
                "totalamount": "10.00"
              }
            ],
            "partialpayments": [
              {
                "paid_amount": null,
                "paid_vat_excluded_amount": null,
                "unpaid_amount": null,
                "unpaid_vat_excluded_amount": null,
                "interest_percent": null,
                "prosessing_costs_amount": null,
                "vat_included_amount": null,
                "vat_excluded_amount": null,
                "duedate": null,
                "reference_identifier": null
              }
            ],
            "interestrates": [
              {
                "interest_type": "text",
                "annual_rate": "19.90",
                "real_annual_rate": "27.29",
                "start_from_date": "2026-03-28",
                "end_at_date": null
              }
            ],
            "classification": {
              "documenttype": "GeneralNote"
            },
            "sendparameters": {
              "earliestsenddate": "2022-10-24",
              "delivery_channel_priority": "peppol,b2b"
            },
            "avtalegiro": "avtalegiro",
            "autogiro": "autogiro",
            "subset": "[Circular Reference]"
          }
        ]
      }
    ]
  }
}

{
  "result": [
    {
      "accepted": "1",
      "amount": "49.53",
      "billnum": "11213",
      "billcode": "112134",
      "error": "Billnum 1002 already exists",
      "evoicetype": "elasku",
      "jobid": "549198",
      "jobstatus": "0",
      "jobtype": "0",
      "notice": [
        "Please check the chosen customer type",
        "Please check the address"
      ],
      "origbillnum": "11213",
      "ownref": "155",
      "print": "null",
      "receiver": "Receivers name. Company or Person depending on customertype",
      "reference": "2011035491985",
      "sendtype": "post"
    }
  ],
  "errors": [
    {
      "error": "Billnum 11213 already exists"
    }
  ],
  "accepted": "1"
}

PreviousExamples of invoice accountings NextDebt Collection

Last updated 1 month ago

Was this helpful?

Good night

hashtagDifferences vs an invoice

hashtagDigital delivery methods

hashtagB2C e-invoice

hashtagB2B e-invoice

hashtagEmail

hashtagOther methods

hashtagMinimum data

hashtagFields

hashtagExample

hashtagAdd bills