GetIncomingPayments

The GetIncomingPayments call returns a list of incoming payments.

This call is available since SOAP version 101.

GetIncomingPayments Input

Field Type Occurrence Meaning Available since
AssignmentStatus Integer Required Assigned payments (1), unassigned payments (0) 105
CallItemsLimit Integer Optional Call items limit for own server 112
CustomerID Integer Required Customer ID 105
DateFrom Integer Required From date - timestamp ... 105
DateTill Integer Required ... until date - timestamp. 105
MethodOfPaymentID Integer Required Payment method ID 105
OrderID Integer Required Order ID 105
Page Integer Optional Seite 105
TransactionID String Required Transaction ID 105

GetIncomingPayments Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapRequest_GetIncomingPayments>
<DateFrom>Integer</DateFrom>
<DateTill>Integer</DateTill>
<OrderID>Integer</OrderID>
<Page>Integer</Page>
</PlentySoapRequest_GetIncomingPayments>

GetIncomingPayments Output

Field Type Occurrence Meaning Available since
IncomingPayments ObjectOptional List with payments 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
Amount
Double Optional Amount 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
Currency
String Optional Currency 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
CustomerEmail
String Optional The customer's E-mail address 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
CustomerID
Integer Optional Customer ID 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
CustomerName
String Optional Customer's name 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
Date
Integer Optional Date - timestamp 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
ExternalInvoiceNumber
String Optional External invoice number 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
IncomingPaymentID
Integer Optional Incoming payment ID 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
InvoiceNumber
String Optional Invoice number 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
MethodOfPaymentID
Integer Optional Payment method ID 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
OrderID
Integer Optional Order ID 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
ReasonForPayment
String Optional Designated use 105
IncomingPayments.
PlentySoapObject_GetIncomingPayments.
TransactionID
String Optional Transaction ID 105
Pages Integer Optional Pages 105
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

GetIncomingPayments Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

Identification Keys

For this call no identification keys and values exist.

Identification Output schema

For this call no identification output schema exists.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 - - - The incoming payment was successfully returned along with its ID.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

For this call no error messages exist

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

Warnings

Code Key Value Message Explanation
110 Page Unused parameter Parameter was not entered. A default value was used for the call.
110 No data No Incoming Payments Available No incoming payments were found for the search request.

Warnings Output schema

The box below lists all warning fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<Warnings>
<item>
<Value>Unused parameter</Value>
</item>
<item> </item>
</Warnings>
Nach oben