Resource: salespaymentlist.nv
HTTP-method: GET
Querystring parameters:
Parameter name | Occurs | Description | Example |
abovenetvisorkey | 0...1 | Return only sales payment above given id | 123 |
begindate | 0...1 | Return only sales payments with date after defined value | 2021-10-23 |
enddate | 0...1 | Return only sales payments with date before defined value | 2021-10-24 |
searchbyname | 0...1 | Return only sales payments with given name |
|
limitlinkedpayments | 0...1 | Limits based on linked invoices | 1 |
limitbytype | 0...1 | Limits based on payment type | excludecreditloss |
lastmodifiedstart | 0...1 | Returns sales payments that have been changed since the given date. Given as yyyy-MM-ddTHH:mm:ss | 2021-12-10 12:00:00 |
lastmodifiedend | 0...1 | Returns sales payments that have been changed before the given date. Given as yyyy-MM-ddTHH:mm:ss | 2021-12-10T12:00:00 |
invoicenetvisorkey | 0...1 | Returns sales payments related to a specific sales invoice by the given sales invoice's NetvisorKey | 123 |
invoicenumber | 0...1 | Returns sales payments related to a specific sales invoice by the given sales invoice's invoice number | 45876 |
replyoption | 0..1 | Returns the reference transaction's archive identifier, raw record, or both inside the Bank aggregate. | 2 |
Response:
Level | Element name | Type and length | Occurs | Description | Example |
Root | Root | Aggr. | 1 |
|
|
1 | SalesPaymentList | Aggr. | 1 |
|
|
2 | SalesPayment | Aggr. | 0...n |
|
|
3 | NetvisorKey | Numeric | 1 | Sales payment identifier in Netvisor | 123 |
3 | Name | String | 1 | Name of the payment |
|
3 | Date | Date | 1 | Date of the payment |
|
3 | Sum | Numeric | 1 | Sum of the payment |
|
3 | ReferenceNumber | String | 1 | Reference number of the payment |
|
3 | ForeignCurrencyAmount | Numeric | 1 |
|
|
3 | InvoiceNumber | Numeric | 1 | Invoice number |
|
3 | PaymentAccountName | String | 1 | Name of the bank/payment method | cash |
3 | VoucherID | Numeric | 1 | Voucher's NetvisorKey | 44 |
3 | LastModifiedTimestamp | String | 1 | The last time the voucher was modified | 7.10.2021 14:24:42 |
3 | PaymentAccountNumber | String | 1 | Account number if payment from bank | FI12 3456 xxx |
3 | PaymentSource | Numeric | 1 | Source of the payment | 1 |
3 | BankStatus | String | 1 | OK or FAILED | OK |
3 | BankStatusErrorDescription | String | 0...1 | D escription of error |
|
Attr. | code | String | 0...1 | Error code, see below |
|
3 | Bank | Aggr. | 0..1 | Returns, if replyoption parameter is used |
|
4 | ArchiveIdentifier | String | 0..1 | Reference number archive identifier | 110432 |
4 | TransactionRecord | String | 0..1 | Reference number raw record | 325049230 |
Bank status error codes:
NO_ACCOUNT_FOUND | Account was not found |
NO_PAYMENT_SERVICE_ACCOUNT | Account is not for payments |
ERROR_IN_DUE_DATE | Duedate is incorrect |
BALANCE_IS_EXCEEDED | Balance is not sufficient |
PAYER_HAS_CANCELED | Payer cancelled payment |
FORM_NOT_CORRECT | Formal error |
BANK_HAS_CANCELLED | Bank cancelled operation |
CANCELLATION_NOT_CLEARING |
|
AUTHORIZATION_IS_MISSING | Authorization is missing |
