Appearance
List of Payments
Endpoints v1
https://app.passelimerit.fi/api/v1/getpaymentsEndpoints v2
https://app.passelimerit.fi/api/v2/getpaymentsQuery Payload
json
{
"PeriodStart": "YYYYmmDD",
"PeriodEnd": "YYYYmmDD"
}Click to see the query parameters
| Field | Type | Comment | Required |
|---|---|---|---|
| PeriodStart | Date | In format YYYYmmDD | Required |
| PeriodEnd | Date | In format YYYYmmDD. Period length max 3 months! | Required |
| UnPaid | Bool | true/false |
Successful Result v1
json
[
{
"PHId": "350999b0-7015-44e3-82c4-cd64b7357950",
"BankName": "testaus",
"CounterPartType": 2,
"CounterPartName": "Mari Maasikas",
"CurrencyCode": "EUR",
"CurrencyRate": 1.0000000,
"DocumentDate": "2019-04-13T00:00:00",
"DocumentNo": "9",
"Direction": 1,
"Amount": 100.00
},
// ...
]Click to see the v1 result parameters
| Field | Type | Comment |
|---|---|---|
| PIHId | Guid | |
| BankName | Str | |
| CounterPartType | Int | 2 – customer, 3 - vendor |
| CounterPartName | Str | |
| CurrencyCode | Str | |
| CurrencyRate | Decimal | |
| DocumentDate | Date | |
| DocumentNo | Str | |
| Direction | Int | 1 - transactions with customers, 2 - with vendors, 3 - other income, 4 - other expenses |
| Amount | Decimal |
Successful Result v2
json
[
{
"PHId": "350999b0-7015-44e3-82c4-cd64b7357950",
"BankName": "testaus",
"CounterPartType": 2,
"CounterPartName": "Mari Maasikas",
"CurrencyCode": "EUR",
"CurrencyRate": 1.0000000,
"DocumentDate": "2019-04-13T00:00:00",
"DocumentNo": "9",
"Direction": 1,
"Amount": 100.00,
"Details": [
{
"PaymId": "350999b0-7015-44e3-82c4-cd64b7357950",
"DocNo": "BL942019-PGG",
"DocAmount": 100.00,
"PaidAmount": 100.00,
"CurrencyCode": "EUR",
"CurrencyRate": 1.0000000
}
]
},
// ...
]Click to see the v2 result parameters
| Field | Type | Comment |
|---|---|---|
| PIHId | Guid | |
| BankName | Str | |
| CounterPartType | Int | 2 – customer, 3- vendor |
| CounterPartName | Str | |
| CurrencyCode | Str | |
| CurrencyRate | Decimal | |
| DocumentDate | Date | |
| DocumentNo | Str | |
| Direction | Int | 1 - transactions with customers, 2 - with vendors, 3 - other income, 4 - other expenses |
| Amount | Decimal | |
| PaymAPIDetails | PaymAPIDetails object |
PaymAPIDetails Object
| Field | Type | Comment |
|---|---|---|
| PaymId | Guid | |
| DocNo | Str | Document (Invoice, Offer,Order) No |
| DocAmount | Decimal | |
| PaidAmount | Decimal | Amount paid by payment |
| CurrencyCode | Str | |
| CurrencyRate | Decimal | Document currency rate |