- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/v23.1/PrePayments
Security
HTTP
Type Bearer
Please enter a valid token
Query parameters
StoreId
integer (int32)
PrePaymentId
integer (int32)
PrePaymentNumber
integer (int32)
PrePaymentRequestId
integer (int32)
ParentPrePaymentId
integer (int32)
CustomerId
integer (int32)
SaleOrderId
integer (int32)
UserId
integer (int32)
ProductId
integer (int32)
PrePaymentTypeId
integer (int32)
PosTerminalId
integer (int32)
CashSaleRowId
integer (int32)
InvoiceSaleId
integer (int32)
Note
string
Reference
string
IsPaymentPendingOnly
string
Valid values[ "All", "Yes", "No" ]
IsIncludeSiblingPayments
boolean
UnassignedPrePaymentsOnly
string
Valid values[ "All", "Yes", "No" ]
Status
string
Valid values[ "NotSpecified", "New", "Approved", "Completed", "Failed" ]
Action
string
Valid values[ "NotSpecified", "Prepayment", "Withdrawal", "Refund", "RefundRequest" ]
CashSaleInvoiceSaleOnly
string
Valid values[ "All", "Yes", "No" ]
ChildPrePaymentsOnly
string
Valid values[ "All", "Yes", "No" ]
PspProviderAssignedOnly
string
Valid values[ "All", "Yes", "No" ]
TransactionDateFrom
string (date-time)
TransactionDateTo
string (date-time)
PrePaymentType
string
Valid values[ "NotSpecified", "PaymentServiceProvider", "CashByPosTerminal", "GiftCard", "BankTransfer" ]
CreatedDateFrom
string (date-time)
CreatedDateTo
string (date-time)
Offset
integer (int32)
RecordCount
integer (int32)
ItemId
integer (int32)
IncludeItemId
integer (int32)
ExcludeItemId
integer (int32)
ModifiedSinceDateTime
string (date-time)
Responses
200
Success
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
prePaymentNumber
integer (int32)
prePaymentRequestId
integer (int32)
parentPrePaymentId
integer (int32)
customerId
integer (int32)
saleOrderId
integer (int32)
userId
integer (int32)
productId
integer (int32)
prePaymentTypeId
integer (int32)
posTerminalId
integer (int32)
cashSaleRowId
integer (int32)
invoiceSaleId
integer (int32)
paid
number (double)
note
string
reference
string
iban
string
bic
string
ibanName
string
status
string
Valid values[ "NotSpecified", "New", "Approved", "Completed", "Failed" ]
action
string
Valid values[ "NotSpecified", "Prepayment", "Withdrawal", "Refund", "RefundRequest" ]
reason
string
saleOrderNumber
integer (int32)
saleOrderReference
string
parentPrePaymentNumber
integer (int32)
paymentTypeId
integer (int32)
prePaymentType
string
Valid values[ "NotSpecified", "PaymentServiceProvider", "CashByPosTerminal", "GiftCard", "BankTransfer" ]
prePaymentTypeCode
string
prePaymentTypeDescription
string
transactionNumber
integer (int32)
invoiceSaleNumber
integer (int32)
processedAmount
number (double)
paymentServiceProviderId
integer (int32)
pspAutoRefund
boolean
Default"False"
remainingAmount
number (double)
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
prePaymentNumber
integer (int32)
prePaymentRequestId
integer (int32)
parentPrePaymentId
integer (int32)
customerId
integer (int32)
saleOrderId
integer (int32)
userId
integer (int32)
productId
integer (int32)
prePaymentTypeId
integer (int32)
posTerminalId
integer (int32)
cashSaleRowId
integer (int32)
invoiceSaleId
integer (int32)
paid
number (double)
note
string
reference
string
iban
string
bic
string
ibanName
string
status
string
Valid values[ "NotSpecified", "New", "Approved", "Completed", "Failed" ]
action
string
Valid values[ "NotSpecified", "Prepayment", "Withdrawal", "Refund", "RefundRequest" ]
reason
string
saleOrderNumber
integer (int32)
saleOrderReference
string
parentPrePaymentNumber
integer (int32)
paymentTypeId
integer (int32)
prePaymentType
string
Valid values[ "NotSpecified", "PaymentServiceProvider", "CashByPosTerminal", "GiftCard", "BankTransfer" ]
prePaymentTypeCode
string
prePaymentTypeDescription
string
transactionNumber
integer (int32)
invoiceSaleNumber
integer (int32)
processedAmount
number (double)
paymentServiceProviderId
integer (int32)
pspAutoRefund
boolean
Default"False"
remainingAmount
number (double)
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
companyId
integer (int32)
storeId
integer (int32)
prePaymentNumber
integer (int32)
prePaymentRequestId
integer (int32)
parentPrePaymentId
integer (int32)
customerId
integer (int32)
saleOrderId
integer (int32)
userId
integer (int32)
productId
integer (int32)
prePaymentTypeId
integer (int32)
posTerminalId
integer (int32)
cashSaleRowId
integer (int32)
invoiceSaleId
integer (int32)
paid
number (double)
note
string
reference
string
iban
string
bic
string
ibanName
string
status
string
Valid values[ "NotSpecified", "New", "Approved", "Completed", "Failed" ]
action
string
Valid values[ "NotSpecified", "Prepayment", "Withdrawal", "Refund", "RefundRequest" ]
reason
string
saleOrderNumber
integer (int32)
saleOrderReference
string
parentPrePaymentNumber
integer (int32)
paymentTypeId
integer (int32)
prePaymentType
string
Valid values[ "NotSpecified", "PaymentServiceProvider", "CashByPosTerminal", "GiftCard", "BankTransfer" ]
prePaymentTypeCode
string
prePaymentTypeDescription
string
transactionNumber
integer (int32)
invoiceSaleNumber
integer (int32)
processedAmount
number (double)
paymentServiceProviderId
integer (int32)
pspAutoRefund
boolean
Default"False"
remainingAmount
number (double)
401
Unauthorized
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403
Forbidden
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
404
Not Found
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
Was this article helpful?