Skip to content

Create Sales Invoice with multiple payments

Endpoints

https://app.passelimerit.fi/api/v1/sendinvoice2

Query Payload

json
{
  "Customer": {
    "Id": "abcd1234-56ef-78gh-90ij-klmn1234opqr",
    "Name": "Example Customer",
    "RegNo": "12345678",
    "NotTDCustomer": true,
    "VatRegNo": "EE123456789",
    "CurrencyCode": "EUR",
    "PaymentDeadLine": 30,
    "OverDueCharge": 1.25,
    "RefNoBase": "REF123456",
    "Address": "123 Example Street",
    "CountryCode": "EE",
    "County": "Example County",
    "City": "Example City",
    "PostalCode": "12345",
    "PhoneNo": "123-456-7890",
    "PhoneNo2": "098-765-4321",
    "HomePage": "http://example.com",
    "Email": "customer@example.com",
    "SalesInvLang": "EN",
    "Contact": "John Doe",
    "GLNCode": "1234567890",
    "PartyCode": "EX123",
    "EInvOperator": 2,
    "EInvPaymId": "PAY123456",
    "BankAccount": "EE123456789012345678",
    "Dimensions": [
      {
        "DimensionId": "dim123",
        "DimensionValue": "value123"
      }
    ],
    "CustGrCode": "GRP123",
    "ShowBalance": true,
    "ApixEinv": "APIX123",
    "GroupInv": false
  },
  "DocDate": "2024-06-12",
  "DueDate": "2024-07-12",
  "TransactionDate": "2024-06-12",
  "InvoiceNo": "123",
  "RefNo": "INV123456",
  "CurrencyCode": "EUR",
  "DepartmentCode": "DEPT123",
  "ProjectCode": "PROJ123",
  "InvoiceRow": [
    {
      "Item": {
        "Code": "ITEM123",
        "Description": "Example Item",
        "Type": 1,
        "UOMName": "pcs",
        "DefLocationCode": "LOC123"
      },
      "Quantity": 10,
      "Price": 20.00,
      "DiscountPct": 5.00,
      "DiscountAmount": 10.00,
      "TaxId": "973a4395-665f-47a6-a5b6-5384dd24f8d0",
      "LocationCode": "LOC123",
      "DepartmentCode": "DEPT123",
      "GLAccountCode": "GL123",
      "Dimensions": [
        {
          "DimensionId": "dim123",
          "DimensionValue": "value123"
        }
      ],
      "ItemCostAmount": 15.00,
      "VatDate": "20240612",
      "SalesAccCode": "SALES123",
      "PurchaseAccCode": "PUR123",
      "InventoryAccCode": "INV123",
      "CostAccCode": "COST123"
    }
  ],
  "TaxAmount": [
    {
      "TaxId": "973a4395-665f-47a6-a5b6-5384dd24f8d0",
      "Amount": 400.00
    }
  ],
  "RoundingAmount": 0.50,
  "TotalAmount": 200.00,
  "Payments": [
    {
      "PaymentMethod": "testaus",
      "PaidAmount": 100.00,
      "PaymDate": "20240612"
    }
  ],
  "Hcomment": "Header comment",
  "Fcomment": "Footer comment"
}
Click to view the query payload details
FieldTypeCommentRequired
CustomerCustomerObjectRequired
DocDateDate
DueDateDate
TransactionDateDate
InvoiceNoStr 35Required
RefNoStr 36
CurrencyCodeStr 4
DepartmentCodeStr 20If used then must be found in the company database.
ProjectCodeStr 20If used then must be found in the company database.
InvoiceRowArray of InvoiceRow objects
TaxAmountArray of VAT objectsRequired
RoundingAmountDecimal 18.2Use it for getting PDF invoice to round number. Does not affect TotalAmount.
TotalAmountDecimal 18.2Amount without VAT
PaymentsArray of Payment objects
RefNoStr 36Please validate this number yourself.
HcommentStr 4KIf not specified, API will get it from the client record, if it's written there.
FcommentStr 4KIf not specified, API will get it from the client record, if it's written there.

CustomerObject

3 use cases:

  1. new customer – you will create new client record when this name was not found

  2. existing customer by name – if this name exists in our system, Merit will take info from client record instead of reading it from the payload

  3. customer by ID – every time you add new customer, the CustomerId is returned, you can use this ID instead of name, the object = { CustomerId: <guid-of-the-customer }

json
{
  "Customer": {
    "Id": "abcd1234-56ef-78gh-90ij-klmn1234opqr",
    "Name": "Example Customer",
    "RegNo": "12345678",
    "NotTDCustomer": true,
    "VatRegNo": "EE123456789",
    "CurrencyCode": "EUR",
    "PaymentDeadLine": 30,
    "OverDueCharge": 1.25,
    "RefNoBase": "REF123456",
    "Address": "123 Example Street",
    "CountryCode": "EE",
    "County": "Example County",
    "City": "Example City",
    "PostalCode": "12345",
    "PhoneNo": "123-456-7890",
    "PhoneNo2": "098-765-4321",
    "HomePage": "http://example.com",
    "Email": "customer@example.com",
    "SalesInvLang": "EN",
    "Contact": "John Doe",
    "GLNCode": "1234567890",
    "PartyCode": "EX123",
    "EInvOperator": 2,
    "EInvPaymId": "PAY123456",
    "BankAccount": "EE123456789012345678",
    "Dimensions": [
      {
        "DimensionId": "dim123",
        "DimensionValue": "value123"
      }
    ],
    "CustGrCode": "GRP123",
    "ShowBalance": true,
    "ApixEinv": "APIX123",
    "GroupInv": false
  },
  // ...
}
Click to view the CustomerObject details
FieldTypeCommentRequired
IdGuidIf filled and customer is found in the database then following fields are not important. If not found, the customer is added using the following fields.
NameStr 150Required, when a new customer is added.
RegNoStr 30
NotTDCustomerBoolEE True for physical persons and foreign companies.

PL True for physical persons.


Allowed "true" or "false" (lowercase).
Required, when a new customer is added.
VatRegNoStr 30
CurrencyCodeStr 30
PaymentDeadLineIntIf missing then taken from default settings.
OverDueChargeDecimal 5.2If missing then taken from default settings.
RefNoBaseStr 36
AddressStr 100
CountryCodeStr 2Required, when a new customer is added.
CountyStr 100
CityStr 30
PostalCodeStr 15
PhoneNoStr 50
PhoneNo2Str 50
HomePageStr 80
EmailStr 80
SalesInvLangStr 8Invoice language for this specific customer.(ET, EN, RU, FI, PL, SV)
ContactStr 35
GLNCodeStr 10
PartyCodeStr 20
EInvOperatorInt1 - Not exist,
2 - E-invoices to the bank through Omniva,
3 - Bank (full extent E-invoice),
4 - Bank (limited extent E-invoice)
EInvPaymIdStr 20
BankAccountStr 50
DimensionsArray of DimensionsObjects
CustGrCodeStr 20
ShowBalanceBool
ApixEinvStr 20
GroupInvBool

InvoiceRowObject

Every invoice has its rows. Row has its quantity and price, it also has its general ledger record and that's why it has its own tax calculation.

json
{
  // ...
  "InvoiceRow": [
    {
      "Item": {
        "Code": "ITEM123",
        "Description": "Example Item",
        "Type": 1,
        "UOMName": "pcs",
        "DefLocationCode": "LOC123"
      },
      "Quantity": 10,
      "Price": 20.00,
      "DiscountPct": 5.00,
      "DiscountAmount": 10.00,
      "TaxId": "973a4395-665f-47a6-a5b6-5384dd24f8d0",
      "LocationCode": "LOC123",
      "DepartmentCode": "DEPT123",
      "GLAccountCode": "GL123",
      "Dimensions": [
        {
          "DimensionId": "dim123",
          "DimensionValue": "value123"
        }
      ],
      "ItemCostAmount": 15.00,
      "VatDate": "20240612",
      "SalesAccCode": "SALES123",
      "PurchaseAccCode": "PUR123",
      "InventoryAccCode": "INV123",
      "CostAccCode": "COST123"
    }
  ],
  // ...
}
Click to view the InvoiceRowObject details
FieldTypeCommentRequired
ItemItemObjectSometimes the volume of transactions in the sales software is very high and there is no need to duplicate all the data in accounting. In those cases, you could consider using the same item code for the items with the same VAT rate.

Items with different VAT rates must have different item codes.

Also, for the VAT declarations to work, goods and services may not be summed up and must have different item codes.
QuantityDecimal 18.3
PriceDecimal 18.7
DiscountPctDecimal 18.2
DiscountAmountDecimal 18.2Amount * Price * (DiscountPCt / 100). This is not rounded. Will be substracted from row amount before row roundings.
TaxIdGuidUse gettaxes endpoint to detect the guid neededRequired
LocationCodeStr 20Used for stock items and multiple stocks. If used then must be found in the company database.
DepartmentCodeStr 20If used then must be found in the company database.
GLAccountCodeStr 10If used, must be found in the company database.
DimensionsArray of DimensionsObjects
ItemCostAmountDecimal 18.2Required for credit invoices when crediting stock items.
VatDateDate StrYYYYMMDD type date. In some countries where you have to specify VatDate.
SalesAccCodeStr 10If included GLAccountCode then the SalesAccCode not used
PurchaseAccCodeStr 10
InventoryAccCodeStr 10
CostAccCodeStr 10

ItemObject

json
{
  // ...
  "InvoiceRow": [
    {
      "Item": {
        "Code": "ITEM123",
        "Description": "Example Item",
        "Type": 1,
        "UOMName": "pcs",
        "DefLocationCode": "LOC123"
      },
      // ...
    }
  ],
  // ...
}
Click to view the ItemObject details
FieldTypeCommentRequired
CodeStr 20Required
DescriptionStr 100Required
TypeInt1 - stock item,
2 - service,
3 - item.
Required
UOMNameStr 64Name for the unit
DefLocationCodeStr 20Required for all stock items, if company has more than one (default) stock

PaymentObject

You can mark the invoice already paid.

json
{
  // ...
  "Payments": [
    {
      "PaymentMethod": "testaus",
      "PaidAmount": 100.00,
      "PaymDate": "20240612"
    }
  ],
  // ...
}
Click to view the PaymentObject details
FieldTypeCommentRequired
PaymentMethodStr 150Name of the payment method. Must be found in the company database.
PaidAmountDecimal 18.2Amount with VAT (not more) or less if partial payment
PaymDateDateYYYYmmddHHii

TaxObject

Every invoice has section of taxes. Those taxes have to be calculated grouped and summed by TaxId. Every row has its own tax calculation, you have to group and sum them up.

This is because you can have different tax rates for different articles.

API always counts it as well to assure you have correct calculation.

json
{
  // ...
  "TaxAmount": [
    {
      "TaxId": "973a4395-665f-47a6-a5b6-5384dd24f8d0",
      "Amount": 400.00
    }
  ],
  // ...
}
Click to view the TaxObject details
FieldTypeCommentRequired
TaxIdGuidUse gettaxes endpoint to detect the guid neededRequired
AmountDecimal 18.2

Successful Result

json
{
  "CustomerId": "7da4cd44-9b49-4a35-8d1b-f339a68e7058",
  "InvoiceId": "1ff271b6-2bfb-4d48-9752-49abfc783a6a",
  "InvoiceNo": "123",
  "RefNo": "INV123456",
  "NewCustomer": null
}