pixi Developer & Integration Documentation

pixiReadInvoices

Description

API Call to retrieve all relevant invoice data


Request Parameters

# Name Type Required Example Description
1 InvoiceKey integer 0 123 Invoice ID
2 InvoiceNr string 0 Sample text Invoice number
3 CreateDateFrom string 0 YYYY-MM-DD hh:mm:ss Create date from (including)
4 CreateDateTo string 0 YYYY-MM-DD hh:mm:ss Create date to (excluding)
5 UpdateDateFrom string 0 YYYY-MM-DD hh:mm:ss Update date from (including)
6 UpdateDateTo string 0 YYYY-MM-DD hh:mm:ss Update date to (excluding)
7 CreateAndUpdateDateFrom string 0 YYYY-MM-DD hh:mm:ss Create or update date from (including)
8 CreateAndUpdateDateTo string 0 YYYY-MM-DD hh:mm:ss Create or update date to (excluding)
9 RowCount integer 0 123 Number of rows returned maximum

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:pixiReadInvoices>
         <dem:InvoiceKey>123</dem:InvoiceKey>
         <dem:InvoiceNr>Sample text</dem:InvoiceNr>
         <dem:CreateDateFrom>YYYY-MM-DD hh:mm:ss</dem:CreateDateFrom>
         <dem:CreateDateTo>YYYY-MM-DD hh:mm:ss</dem:CreateDateTo>
         <dem:UpdateDateFrom>YYYY-MM-DD hh:mm:ss</dem:UpdateDateFrom>
         <dem:UpdateDateTo>YYYY-MM-DD hh:mm:ss</dem:UpdateDateTo>
         <dem:CreateAndUpdateDateFrom>YYYY-MM-DD hh:mm:ss</dem:CreateAndUpdateDateFrom>
         <dem:CreateAndUpdateDateTo>YYYY-MM-DD hh:mm:ss</dem:CreateAndUpdateDateTo>
         <dem:RowCount>123</dem:RowCount>
      </dem:pixiReadInvoices>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Retrieve invoice data

# Name Type Description
1 InvoiceKey integer Invoice ID
2 InvoiceNr string Invoice number
3 InvDate string Invoice date
4 CustRef integer ID of customer
5 AddrRef integer Addres reference
6 Summary number Summary
7 VATBaseHigh number VAT base high
8 VATBaseLow number VAT base low
9 VATType string VAT type
10 VATNo string VAT number
11 total number Total amount
12 Payment string Payment
13 Printed string Printed
14 PrintDate string Print date
15 PayDay string Pay day
16 Payed string Payed
17 PayedSum number Payed sum
18 SUGKTO string SUGKTO
19 BuchuText string Buchu text
20 AuszugNr string Auszug Nr
21 Account string Account
22 BLZ string Bank code
23 AccName string Account name
24 LSDate string LS date
25 LSNr integer LS number
26 RLSDate string RLS date
27 RLSCost number RLS cost
28 Reminder1Date string Reminder1 date
29 Reminder2Date string Reminder2 date
30 Reminder3Date string Reminder3 date
31 Note string Note
32 ShipCode string Ship code
33 CreateDate string Create date
34 CreateEmp string Creator of the recodr (pixi user)
35 UpdateDate string Last update date of the record
36 UpdateEmp string User who last updated the record
37 BoxNr integer Box number
38 Total_OrderCurr number Total order currency
39 Total_ShipCost number The total of ship costs
40 Total_ShipCost_OrderCurr number Total ship cost order currency
41 ScanOutDate string Invoice ship out date
42 OrderCurrency string Order currency
43 VATBaseHigh_OrderCurr number VAT base high order currency
44 VATBaseLow_OrderCurr number VAT base low order currency
45 VATHighPerc number The VAT percent of high VAT
46 VATLowPerc number VAT low percent
47 VATHigh number VAT high
48 VATLow number VAT low
49 VATHigh_OrderCurr number VAT high order currency
50 VATLow_OrderCurr number VAT low order currency
51 VATHText string Text representation of high VAT
52 VATLText string Text representation of low VAT
53 RefToInvoiceNr string Reference to the original invoice number in case of returns
54 RefToInvoiceKey integer Reference to the original invoice ID
55 ChargeVAT string The flag that marks if the VAT should be charged
56 ShipVendor string Shipping vendor code
57 CCPPaymentDone string CCP payment done
58 CCPAuthCode string CCP authorization code
59 CCPNumOfTries integer CCP number of tries
60 CCPReCharge string CCP re charge
61 ShipAdrRef integer Shipping address ID
62 InvLocationID string Invoice location ID
63 InvShopID string Invoice shop ID
64 PackageNetWeight number Package net weight
65 PackageGrossWeight number Package gross weight
66 IsPackageLost string Is package lost
67 InvShipLock string Invoice ship lock
68 InvTrackNumber string Invoice track number
69 VoucherSum_OrderCurr number Voucher Sum order currency
70 VoucherID string ID of the voucher
71 VATinShipCost string VAT in ship cost
72 ShippedByVendor boolean Shipped by vendor
73 VATBaseLow_ShipCost number VAT base low ship cost
74 VATBaseHigh_ShipCost number VAT base high ship cost
75 ccpPayID string ID of credit card payment
76 ccpTransID string CCP transaction ID
77 ReminderLevel integer Reminder level
78 ReminderProcessed string Reminder processed
79 ReminderCosts number Reminder costs
80 ReminderReason string Reminder reason
81 ShipmentTrackingID string Shipment tracking ID
82 ReturnReason string Return reason
83 StockNote string Stock note
84 ReturnSupplier string Return supplier
85 ReturnClosed string Return closed
86 Fulfillment boolean Fulfillment
87 InvoiceMailSent boolean Invoice mail sent
88 TrackingIDsent string Tracking ID sent
89 PaidByCustomer number Paid by customer
90 PLHref integer Picklist number
91 Packages integer Packages
92 DiscountTotal number Discount total
93 PaidAtCreation number Paid at creation
94 TextIfNoInvlines string Text if no Invlines
95 retTrackID string Return track ID
96 retTrackIDhist string Return track ID history
97 1SS boolean One scan shipping flag
98 DueDate string Due date
99 CreateDTAUS boolean Create DTAUS
100 InvCreationMode string Invoice creation mode
101 VATBaseHigh_ShipCost_OrderCurr number VAT base high ship cost order currency
102 VATBaseLow_ShipCost_OrderCurr number VAT base low ship cost order currency

Additional Notes