GET POS/Sales/Invoices/{invoiceId}/Payments?FromDate={FromDate}&ToDate={ToDate}&FilterByTime={FilterByTime} Try Now

Gets the Invoice Payments.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
invoiceId
The invoice identifier.
string
Required
FromDate
Start Date of UpdatedSince Date Range
string
None.
ToDate
End Date of UpdatedSince Date Range
string
None.
FilterByTime
Include or Exclude Time in Date Range
boolean
None.

Body Parameters

None.

Response Information

Resource Description

Collection of InvoicePaymentResponse
NameDescriptionTypeAdditional information
PaymentId
The payment identifier.
string
None.
Amount
The amount.
Money
None.
PaymentDate
The payment date.
date
None.
ReferenceNo
The reference no.
string
None.
Note
The note.
string
None.
ContraEntryId
The additional cost.
string
None.
PaymentModeId
The customer payment mode identifier.
string
None.
PayPalPendingReason
The pay pal pending reason.
PendingStatusCodeType
None.
PayPalFee
The pay pal fee.
decimal number
None.
PayPalPaymentStatus
The pay pal payment status.
PaymentStatusCodeType
None.
GateWay
The gate way.
PaymentProcessors
None.
GatewayStatus
The gateway status.
string
None.
GatewayResponse
The gateway response.
string
None.
PaymentStatus
The payment status.
TransactionResponseType
None.
PaymentType
The type of the payment.
ProcessType
None.
GatewayMerchantId
The gateway merchant identifier.
string
None.
IsPaymentVerified
The value indicating whether this instance is payment verified.
boolean
None.
IsDeleted
Is Payment Deleted.
boolean
None.
RemainingRefundAmount
Remaining Refund Amount
Money
None.
DateUpdated
The Date updated.
date
None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PaymentId": "",
    "Amount": {
      "Currency": "",
      "Amount": 1.0
    },
    "PaymentDate": "2020-01-24T15:17",
    "ReferenceNo": "",
    "Note": "",
    "ContraEntryId": "",
    "PaymentModeId": "",
    "PayPalPendingReason": "none",
    "PayPalFee": 7.0,
    "PayPalPaymentStatus": "None",
    "GateWay": "None",
    "GatewayStatus": "",
    "GatewayResponse": "",
    "PaymentStatus": "None",
    "PaymentType": "Sale",
    "GatewayMerchantId": "",
    "IsPaymentVerified": true,
    "IsDeleted": true,
    "RemainingRefundAmount": {
      "Currency": "",
      "Amount": 1.0
    },
    "DateUpdated": "2020-01-24T15:17"
  }
]