AddOrdersInvoice

Use the AddOrdersInvoice call to attach invoices to (different) sales orders. You can either use the OrderID or the ExternalOrderID to specify the sales orders.

The invoice needs to be saved as a PDF document. The Base64 encoded document needs to be specified in the FileData parameter.

This call is available since SOAP version 101.
You can attach up to 10 invoices to (different) sales orders per call.

AddOrdersInvoice Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
OrderInvoiceList ObjectOptional Invoices 105
OrderInvoiceList.
PlentySoapObject_AddOrdersInvoice.
ExternalOrderID
String Required External order ID 105
OrderInvoiceList.
PlentySoapObject_AddOrdersInvoice.
OrderID
Integer Required Order ID 105
OrderInvoiceList.
PlentySoapObject_AddOrdersInvoice.
OrderInvoice
ObjectOptional Order invoice 105
OrderInvoiceList.
PlentySoapObject_AddOrdersInvoice.
OrderInvoice.
PlentySoapObject_FileBase64Encoded.
FileData
base64Binary Required base64 encoded document data 105
OrderInvoiceList.
PlentySoapObject_AddOrdersInvoice.
OrderInvoice.
PlentySoapObject_FileBase64Encoded.
FileEnding
String Optional The ending of the file (currently, this is always .pdf for invoice documents) 105
OrderInvoiceList.
PlentySoapObject_AddOrdersInvoice.
OrderInvoice.
PlentySoapObject_FileBase64Encoded.
FileName
String Required The name of the document (should be unique) 105

AddOrdersInvoice 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.

AddOrdersInvoice Output

Field Type Occurrence Meaning Available since
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

AddOrdersInvoice 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

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

Key Value
FileName dynamicValue

Identification Output schema

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

Success messages

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

Code Key Value Message Explanation
100 - - - Invoice added to the sales order

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 10 Max 10 Documents Only 10 documents can be added at the same time.
800 ExternalOrderID Missing parameter Required parameter was not entered
800 FileName Missing parameter Required parameter was not entered
800 FilaData Missing parameter Required parameter was not entered
800 ExternalOrderID Invalid parameter The value of entered parameter is not allowed
800 Error adding invoice document An error occurred while adding the document.

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.

<ErrorMessages>
<item> </item>
<item>
<Value>Missing parameter</Value>
<Key>ExternalOrderID</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>FileName</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>FilaData</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>ExternalOrderID</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben