Description
This is the API Call if you want to get more than one invoice line back. All parameters are optional.
Request Parameters
| # |
Name |
Type |
Required |
Example |
Description |
| 1 |
InvoiceNr |
string |
0 |
abcdefg |
Filter by one specific invoice number |
| 2 |
ShopID |
string |
0 |
abcdefg |
Filter invoices from one shop |
| 3 |
PaymentType |
string |
0 |
Single character : "g" |
Filter invoices by payment type. |
| 4 |
OrderNR |
integer |
0 |
123 |
All invoicelines related to one order. Might be several invoices. |
| 5 |
OrderNRExternal |
string |
0 |
abcdefg |
Same as OrderNR - but with the external order number from the shop. |
| 6 |
InvDateFrom |
string |
0 |
YYYYMMDD[ hh:mm:ss[.mmm]] |
Filter by invoice date (from). |
| 7 |
InvDateTo |
string |
0 |
YYYYMMDD[ hh:mm:ss[.mmm]] |
Filter by invoice date (to). |
| 8 |
UpdateDateFrom |
string |
0 |
YYYYMMDD[ hh:mm:ss[.mmm]] |
Filter by update date (last time the invoiceline was updated). Invoice lines are updated after the creation of the invoice e.g. if they are shipped or returned. |
| 9 |
UpdateDateTo |
string |
0 |
YYYYMMDD[ hh:mm:ss[.mmm]] |
Filter by update date (to). |
| 10 |
RowCount |
integer |
0 |
123 |
Be carefull - the details of one invoice might be cut! |
| 11 |
AddCCPPayID |
boolean |
0 |
0 or 1 |
Adds a field "CcpPayID" that holds the external payment authorization reference for credit card processing. |
| 12 |
OnlyUnpaidInvoices |
boolean |
0 |
0 or 1 |
Only returns invoice lines from unpaid or partially paid invoices. |
| 13 |
IncludeSpecialInvLines |
boolean |
0 |
0 or 1 |
If set to 1, it will return discounts, shipping costs and manualy created invoices without items as special lines. |
| 14 |
Status |
string |
0 |
EIN |
Filter invoice lines according to the status of the orderlines related to them. Possible statusses: AUS, EIN, NLB, RET, STO, MIN |
| 15 |
CustomerNrExternal |
string |
0 |
customer@pixi |
Filter by customer number external |
| 16 |
IsReplacementOnly |
boolean |
0 |
0 |
Show only replacement Orderlines/Invlines |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiGetInvoiceLinesExtended>
<dem:InvoiceNr>abcdefg</dem:InvoiceNr>
<dem:ShopID>abcdefg</dem:ShopID>
<dem:PaymentType>Single character : "g"</dem:PaymentType>
<dem:OrderNR>123</dem:OrderNR>
<dem:OrderNRExternal>abcdefg</dem:OrderNRExternal>
<dem:InvDateFrom>YYYYMMDD[ hh:mm:ss[.mmm]]</dem:InvDateFrom>
<dem:InvDateTo>YYYYMMDD[ hh:mm:ss[.mmm]]</dem:InvDateTo>
<dem:UpdateDateFrom>YYYYMMDD[ hh:mm:ss[.mmm]]</dem:UpdateDateFrom>
<dem:UpdateDateTo>YYYYMMDD[ hh:mm:ss[.mmm]]</dem:UpdateDateTo>
<dem:RowCount>123</dem:RowCount>
<dem:AddCCPPayID>0 or 1</dem:AddCCPPayID>
<dem:OnlyUnpaidInvoices>0 or 1</dem:OnlyUnpaidInvoices>
<dem:IncludeSpecialInvLines>0 or 1</dem:IncludeSpecialInvLines>
<dem:Status>EIN</dem:Status>
<dem:CustomerNrExternal>customer@pixi</dem:CustomerNrExternal>
<dem:IsReplacementOnly>0</dem:IsReplacementOnly>
</dem:pixiGetInvoiceLinesExtended>
</soapenv:Body>
</soapenv:Envelope>
Response
Body 1: Invoice lines details
| # |
Name |
Type |
Description |
| 1 |
InvoiceNr |
string |
pixi* invoice number |
| 2 |
InvoiceDate |
string |
Date of the invoice |
| 3 |
ShopID |
string |
Shop ID |
| 4 |
PaymentAddressId |
integer |
Billing address ID |
| 5 |
ShipmentAddressId |
integer |
Shipping address ID |
| 6 |
CustKey |
integer |
Customer ID |
| 7 |
Total |
number |
Invoice total |
| 8 |
VATSum |
number |
Sum of VAT |
| 9 |
VATHigh |
number |
Sum of high VAT |
| 10 |
VATLow |
number |
Sum of low VAT |
| 11 |
TotalNoVAT |
number |
Invoice total without VAT |
| 12 |
ShipCost |
number |
The total shipping costs of the whole order |
| 13 |
ShipCostNoVAT |
number |
The total shipping costs of the whole order excluding VAT |
| 14 |
Discount_Invoice |
number |
Discount amount on the invoice itself |
| 15 |
Discount_InvLines |
number |
Sum of invlines discout amounts |
| 16 |
PaymentCode |
string |
Payment code |
| 17 |
PaymentText |
string |
Payment text / description |
| 18 |
PaymentDate |
string |
Date of the payment |
| 19 |
Paid |
boolean |
Flag if the invoice was paid already |
| 20 |
TotalToPay |
number |
Total amount to pay |
| 21 |
PaidSum |
number |
Actual paid amount |
| 22 |
CcCardType |
string |
Type of credit card |
| 23 |
CcCardNr |
string |
Number of the credit card used for payment |
| 24 |
CcCardName |
string |
Name of the credit institute |
| 25 |
CcCardExp |
string |
Expiry date of the credit card |
| 26 |
Account |
string |
Account number |
| 27 |
Blz |
string |
Bank Code |
| 28 |
BankName |
string |
Name of the Bank |
| 29 |
AccountName |
string |
Name of the owner of this bank account |
| 30 |
TrackingID |
string |
Tracking ID of the shipment. Applies to the orders that have been shipped |
| 31 |
ShipDate |
string |
Ship this order at this date only! Not before |
| 32 |
UpdateDate |
string |
Last update date of the record |
| 33 |
ReminderLevel |
integer |
Reminder level |
| 34 |
OrderNr |
integer |
Order number in pixi* |
| 35 |
OrderNrExternal |
string |
External order number |
| 36 |
Note |
string |
Invoice note |
| 37 |
ShipVendor |
string |
Shipping vendor code |
| 38 |
CcpPayID |
string |
ID of credit card payment |
| 39 |
Currency |
string |
Currency |
| 40 |
OrderCurrency |
string |
Currency |
| 41 |
TotalToPay_OrderCurr |
number |
Pay amount in order currency |
| 42 |
ReturnReason |
string |
Return reason text |
| 43 |
InvoiceKey |
integer |
Invoice ID |
| 44 |
RefToInvoiceNr |
string |
Reference to the original invoice number in case of returns |
| 45 |
RefToInvoiceKey |
integer |
Reference to the original invoice ID |
| 46 |
Anrede |
string |
Salutation |
| 47 |
Name |
string |
First and last name |
| 48 |
Name2 |
string |
2nd name |
| 49 |
FirstName |
string |
First Name |
| 50 |
LastName |
string |
Last Name |
| 51 |
CareOf |
string |
Company name |
| 52 |
Address |
string |
Address |
| 53 |
Street |
string |
Street |
| 54 |
HouseNr |
string |
House Number |
| 55 |
City |
string |
City |
| 56 |
State |
string |
State |
| 57 |
ZIP |
string |
Postal code |
| 58 |
Country |
string |
Country |
| 59 |
CustomerNrExternal |
string |
External Reference to the Customer (imported from Shop) |
| 60 |
Orderlinekey |
integer |
ID for the Orderline record |
| 61 |
EANUPC |
string |
Item barcode |
| 62 |
ItemName |
string |
Item name |
| 63 |
SpecialNote |
string |
Item special note |
| 64 |
OrderDate |
string |
Order create date imported from |
| 65 |
OrderQty |
integer |
Item quantity |
| 66 |
ItemQty |
integer |
Item quantity |
| 67 |
ItemPrice_Brutto |
number |
Item price with VAT |
| 68 |
ItemPrice_Netto |
number |
Item price without VAT |
| 69 |
ItemPrice_VAT |
number |
Item VAT amount |
| 70 |
SupplPrice |
number |
Supplier price of the item |
| 71 |
ItemNrSuppl |
string |
Supplier item number |
| 72 |
ItemNrInt |
string |
Shop item number |
| 73 |
SerialNr |
string |
Item serial number |
| 75 |
STATUS |
string |
Invoice line status |
| 76 |
FullPrice |
number |
Item full price |
| 77 |
DiscountValue |
number |
Discount value |
| 78 |
DiscountPerc |
number |
Discount percent |
| 79 |
DF_Type |
string |
Direct fulfillment type |
| 80 |
DFShipDate |
string |
Direct fulfillment ship date |
| 81 |
DFShipmentTrackingID |
string |
Direct fulfillment shipment tracking ID |
| 82 |
SubShopLogo |
string |
URL of the logo of the sub shop |
| 83 |
SubShopNAme |
string |
Name of the sub shop |
| 84 |
Referrer |
string |
Referrer of the order |
| 85 |
Type |
string |
Invoice type (Invoice/Credit) |
| 86 |
ReturnCostsAmount |
number |
Amount of return costs |
| 87 |
InvLineKey |
integer |
Invoice line ID |
| 88 |
SupplNr |
string |
Supplier number (code) |
| 89 |
BatchNumber |
string |
Item batch number |
| 90 |
BestBeforeDate |
string |
Item best before date |
| 91 |
IBAN |
string |
International Bank Account Number |
| 92 |
BIC |
string |
Bank Identifier Code |
Additional Notes
You can bypass the RowCount limit when you use "@RowCount = 0"