Skip to content

Get Customer List

Endpoints

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

Query Payload

json
{ }
Click to see the query parameters
FieldTypeCommentRequired
IdGuidIf filled, next fields will be ignored
RegNoStrExact match.
VatRegNoStrExact match.
NameStrBroad match.
WithCommentsBooltrue, false
CommentsFromDateDate later
ChangedDateDateDate of changing or creating customer/vendor (YYYYmmDD)

Successful response

json
[
  {
    "CustomerId": "7da4cd44-9b49-4a35-8d1b-f339a68e7058",
    "Name": "FirstCustomer Inc",
    "RegNo": "1122334755",
    "Contact": "test@example.com",
    "PhoneNo": "6548765",
    "PhoneNo2": null,
    "Address": "Merimiehenkatu 31",
    "City": "Helsinki",
    "County": null,
    "PostalCode": "00100",
    "CountryCode": "FI",
    "CountryName": "FINLAND",
    "FaxNo": null,
    "Email": "customermail@gmail.com",
    "HomePage": null,
    "PaymentDeadLine": 7,
    "OverdueCharge": 7.000,
    "CurrencyCode": "EUR",
    "CustomerGroupName": null,
    "VatRegNo": "11222344",
    "BankName": null,
    "BankAccount": null,
    "NotTDCustomer": false,
    "SalesInvLang": "FI",
    "RefNoBase": "1",
    "Comments": [
      {
        "Comment": "This is a comment",
        "CommDate": "20240528"
      }
    ],
    "Dimensions": [
      {
        "Id": "7da4cd44-9b49-4a35-8d1b-f339a68e7058",
        "DimId": 3,
        "DimValueId": "67d83637-6929-4254-a312-55558581c76c",
        "DimCode": "testCode100"
      }
    ]
  }
]

Result parameters

Click to see the result parameters
FieldTypeComment
CustomerIdGuid
NameStr
RegNoStr
ContactStr
PhoneNoStr
PhoneNo2Str
AddressStr
CityStr
CountyStr
PostalCodeStr
CountryCodeStr
CountryNameStr
FaxNoStr
EmailStr
HomePageStr
PaymentDeadLineInt
OverdueChargeDecimal
CurrencyCodeStr
CustomerGroupNameStr
VatRegNoStr
BankNameStr
BankAccountStr
NotTDCustomerBool
SalesInvLangStr
RefNoBaseStr
CommentsArray of comments
DimensionsArray of dimensions

Comments parameters

Comments parameters
FieldTypeComment
CommentStrComment
CommDateDateDate

Dimensions parameters

Dimensions parameters
FieldTypeComment
IdGuid
DimIdInt
DimValueIdGuid
DimCodeStr

IMPORTANT

We're aware of the problem of big responses. If you try to query full list of customers or vendors, it will respond with stacktrace that tells our server is unable to compile JSON that big. We're working on it.