IncomingPayments

Queryable, Introduced in version 22.8

GET https://localhost:8001/sv/001.1/api/v1/Accounting/IncomingPayments

Represents an incoming payment.

GUID

8FB6A6F5-9ADA-482D-8E00-6CE9F956701D

Required permission

Show accounts receivable

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the incoming payment.
BankChargeAmount Decimal? The bank charge amount of the incoming payment.
BankChargeAmountCurrencyId Int64? The business key identifier of the bank charge amount's currency.
BookingId Int64? The business key identifier of the incoming payment's booking.
CancelDate DateTimeOffset? The date the payment was cancelled.
CancelledByUserId Int64? The business key identifier of the user that cancelled the payment.
CancelPaymentDate DateTimeOffset The date the cancellation is booked.
CreationDate DateTimeOffset The date the incoming payment was created.
CurrencyExchangeRate Decimal The exchange rate of the incoming payment.
InterestType Int32 The interest type of the incoming payment.

  • InterestInvoice: 0
  • NextRegularInvoice: 1
  • None: 2
IsCancelled Boolean Whether or not the payment is cancelled.
PaidAmount Decimal The paid amount.
PaidAmountCurrencyId Int64? The business key identifier of the paid amount's currency.
PaidAmountInCompanyCurrency Decimal The paid amount in company currency.
PaidAmountInCompanyCurrencyCurrencyId Int64? The business key identifier of the paid amount in company currency's currency.
PaidVatAmount Decimal? The paid VAT amount.
PaidVatAmountCurrencyId Int64? The business key identifier of the paid VAT amount's currency.
ParentId Int64 The business key identifier of the paid accounts receivable.
PaymentDate DateTimeOffset The payment date.
PaymentMethodId Int64? The business key identifier of the payment method.
VoucherText String The voucher text of the incoming payment.

  • Max length is 100
WriteOffAmount Decimal? The amount written off for the incoming payment.
WriteOffAmountCurrencyId Int64? The business key identifier of the currency of the amount written off.
WriteOffAmountInCompanyCurrency Decimal? The amount written off in company currency for the incoming payment.
WriteOffAmountInCompanyCurrencyCurrencyId Int64? The business key identifier of the currency of the amount written off in company currency for the incoming payment.
WriteOffCodeId Int64? The business key identifier of the incoming payment's write off code.
InterestInvoicingStatus Int32 The interest invoicing status of the incoming payment.

  • NoInterest: 0
  • Interest: 1
  • InterestInvoiced: 9
IsSetOffPayment Boolean Specifies if the incoming payment is a set off payment.
LedgerId Int64? The business key identifier of the incoming payment ledger.

References IncomingPaymentLedger.
ChequeNumber String The cheque number of the incoming payment.

  • Max length is 30

Example

{
  "Id": 0,
  "BankChargeAmount": null,
  "BankChargeAmountCurrencyId": null,
  "BookingId": null,
  "CancelDate": null,
  "CancelledByUserId": null,
  "CancelPaymentDate": "0001-01-01T00:00:00+00:00",
  "CreationDate": "0001-01-01T00:00:00+00:00",
  "CurrencyExchangeRate": 0.0,
  "InterestType": 0,
  "IsCancelled": false,
  "PaidAmount": 0.0,
  "PaidAmountCurrencyId": null,
  "PaidAmountInCompanyCurrency": 0.0,
  "PaidAmountInCompanyCurrencyCurrencyId": null,
  "PaidVatAmount": null,
  "PaidVatAmountCurrencyId": null,
  "ParentId": 0,
  "PaymentDate": "0001-01-01T00:00:00+00:00",
  "PaymentMethodId": null,
  "VoucherText": null,
  "WriteOffAmount": null,
  "WriteOffAmountCurrencyId": null,
  "WriteOffAmountInCompanyCurrency": null,
  "WriteOffAmountInCompanyCurrencyCurrencyId": null,
  "WriteOffCodeId": null,
  "InterestInvoicingStatus": 0,
  "IsSetOffPayment": false,
  "LedgerId": null,
  "ChequeNumber": null
}