pixi Developer & Integration Documentation

pixiCreateReturn

Description

This API call is used to actually create a new credit.


Request Parameters

#

Name

Type

Required

Example

Description

1

InvoiceNr

string

1

Sample text

Invoice nr. for which return needs to be created. You can create return only for one invoice per call.

2

InvoiceLines

string

1

123;

Invoice line keys for which items return needs to be created. Semicolon as separator is mandatory even only one Key is provided.

3

Quantities

string

1

1;2;3;

Returned items quantities. Separator is semicolon.

4

Prices

string

1

5,99;

Returned items prices (always gross). Separator is semicolon.

5

PaymentType

string

1

A

Payment type code - Payment codes: L (Direct Debit), B (Cash), N (Cash on Delivery), K (Credit Card)

6

Account

string

0

Sample text

Bank account number

7

BLZ

string

0

A

BLZ - Bankleitzahl (bank code)

8

AccountName

string

1

Sample text

Bank account name

9

ShipCost

number

0

19.90

Returned ship costs price, with minus sign. If Ship costs are not set, then inovice ship costs are returned.

10

Note

string

0

Sample text

Note

11

ReturnReason

string

0

Sample text

Return reason

12

CreateDate

string

0

date format: YYYYMMDD hh:mm:ss[.mmm]

Create date of the return; despite what was entered, always current datetime is used!

13

CreateEmp

string

0

Sample text

pixi* user name that creates return

14

InvoiceDate

string

0

date format: YYYYMMDD hh:mm:ss[.mmm]

Invoice date; Despite what was entered, always current datetime is used!

15

ReturnClosed

boolean

0

0/1

Return closed. Bit value.

16

ReturnCaseID

integer

0

123

Repairs Return Case ID

17

CreateDTAUS

boolean

0

0/1

Create DTAUS/SEPA when return is done. Bit value, default is true. If @DoNotRefund is true, then create DTAUS/SEPA is false.

18

DoNotRefund

boolean

0

0/1

Do not refund. Bit value.

19

CAComment

string

0

Sample text

Comment which is saved to Customer Account History (Do not Create DTAUS/SEPA, Do not Refund...)

20

IBAN

string

0

Sample text

IBAN

21

BIC

string

0

Sample text

BIC

22

LanguageId

integer

0

123

Language ID used when creating history records.

23

ReturnCostsAmount

number

0

19.90

Charge customers return costs for sending their items back. Positive price. If it is bigger then total returned, return costs are reset to -total and then total is set to 0. Used from Lou Update 26 and Ava Update 2 on.

24

Voucher_Amount

number

0

9.78

Voucher amount

25

MarkReturnDocumentForPrinting

boolean

0

0

Mark if Document (Credit) has to be printed.


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:pixiCreateReturn>
         <dem:InvoiceNr>Sample text</dem:InvoiceNr>
         <dem:InvoiceLines>123;</dem:InvoiceLines>
         <dem:Quantities>1;2;3;</dem:Quantities>
         <dem:Prices>5,99;</dem:Prices>
         <dem:PaymentType>A</dem:PaymentType>
         <dem:Account>Sample text</dem:Account>
         <dem:BLZ>A</dem:BLZ>
         <dem:AccountName>Sample text</dem:AccountName>
         <dem:ShipCost>19.90</dem:ShipCost>
         <dem:Note>Sample text</dem:Note>
         <dem:ReturnReason>Sample text</dem:ReturnReason>
         <dem:CreateDate>date format: YYYYMMDD hh:mm:ss[.mmm]</dem:CreateDate>
         <dem:CreateEmp>Sample text</dem:CreateEmp>
         <dem:InvoiceDate>date format: YYYYMMDD hh:mm:ss[.mmm]</dem:InvoiceDate>
         <dem:ReturnClosed>0/1</dem:ReturnClosed>
         <dem:ReturnCaseID>123</dem:ReturnCaseID>
         <dem:CreateDTAUS>0/1</dem:CreateDTAUS>
         <dem:DoNotRefund>0/1</dem:DoNotRefund>
         <dem:CAComment>Sample text</dem:CAComment>
         <dem:IBAN>Sample text</dem:IBAN>
         <dem:BIC>Sample text</dem:BIC>
         <dem:LanguageId>123</dem:LanguageId>
         <dem:ReturnCostsAmount>19.90</dem:ReturnCostsAmount>
         <dem:Voucher_Amount>9.78</dem:Voucher_Amount>
         <dem:MarkReturnDocumentForPrinting>0</dem:MarkReturnDocumentForPrinting>
      </dem:pixiCreateReturn>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1: When a return is created, a complete set of columns fomt the corresponding invoice is returned.

#

Name

Type

Description

1

InvoiceKey

integer

ID of the invoice.

2

InvoiceNr

string

Invoice number.

3

InvDate

string

Invoice date.

4

CustRef

integer

ID of customer.

5

AddrRef

integer

ID of billing address.

6

Summary

number


7

VATBaseHigh

number

Sum of high VAT.

8

VATBaseLow

number

Sum of low VAT.

9

VATType

string


10

VATNo

string


11

skontoprozent

smallint


12

SkontoAbz

number


13

total

number

Invoice amount.

14

Payment

string

ID of payment type.

15

Printed

string

-

16

PrintDate

string

-

17

Supporter

string

-

18

SupportPhone

string

-

19

PayDay

string


20

Payed

string


21

PayedSum

number

Payed amount.

22

SUGKTO

string

-

23

BuchuText

string

-

24

AuszugNr

string

-

25

Account

string


26

BLZ

string


27

AccName

string


28

LSDate

string


29

LSNr

integer


30

RLSDate

string


31

RLSCost

number


32

Reminder1Date

string


33

Reminder2Date

string


34

Reminder3Date

string


35

CardDate

string


36

CardCheck

string


37

CardType

string


38

CardName

string


39

CardNr

string


40

CardExp

string


41

Note

string


42

NODRef

integer


43

ShipCode

string


44

CreateDate

string

Creation date of the invoice.

45

CreateEmp

string

Employee who created the invoice.

46

UpdateDate

string

Last update date of the invoice.

47

UpdateEmp

string

Employee who last updated the invoice.

48

BoxNr

integer

Box number that holds the items of the invoice.

49

Total_OrderCurr

number

Invoice amount.

50

Total_ShipCost

number

The total of ship costs.

51

Total_ShipCost_OrderCurr

number

The total of ship costs.

52

GNMcharge

string


53

ScanOutDate

string

Date of the ship out.

54

OrderCurrency

string

Invoice currency.

55

VATBaseHigh_OrderCurr

number


56

VATBaseLow_OrderCurr

number


57

VATHighPerc

number

The VAT percent of high VAT.

58

VATLowPerc

number

The VAT percent of low VAT.

59

VATHigh

number

Total sum of high VAT.

60

VATLow

number

Total sum of low VAT.

61

VATHigh_OrderCurr

number

Total sum of high VAT.

62

VATLow_OrderCurr

number

Total sum of low VAT.

63

VATHText

string

Text representation of high VAT.

64

VATLText

string

Text representation of low VAT.

65

RefToInvoiceNr

string

Reference to the original invoice number.

66

RefToInvoiceKey

integer

Reference to the original invoice ID.

67

CCFeeProvision

string


68

CCAddFee

number


69

CCFeeCurrency

string


70

BankFeeAmmount

number


71

CostChargeShop

number


72

CostChargeCurrency

string


73

ChargeVAT

string

The flag that marks if the VAT should be charged.

74

IssueNr

string


75

ShipVendor

string

Shipping vendor code.

76

CCPPaymentDone

string

Credit card payment done flag.

77

CCPAuthCode

string


78

CCPNumOfTries

integer

Number of tries of credit card processing.

79

CCPReCharge

string


80

ShipAdrRef

integer

ID of shipping address.

81

InvLocationID

string

Location where invoice was created.

82

TimesPrinted

integer

Count of how many times the invoice was printed.

83

InvShopID

string

Shop ID that invoice was created for.

84

CCPShipCostChargedYN

string


85

CCPChargedSoFar

number


86

PackageNetWeight

string


87

PackageGrossWeight

string

Weight of the package shipped with this invoice.

88

IsPackageLost

string


89

InvShipLock

string

Shipping lock activated flag.

90

InvTrackNumber

string

Tracking number for the invoice.

91

ShipVendorIncrement1

integer


92

VoucherSum

number

Total sum of the voucher for the invoice.

93

VoucherID

string

ID of the voucher.

94

VATinShipCost

string

VAT is included in shipping costs.

95

ShippedByVendor

boolean

Invoice was shipped by shipping vendor flag.

96

VATBaseLow_ShipCost

number

Total of low VAT in shipping costs.

97

VATBaseHigh_ShipCost

number

Total of high VAT in shipping costs.

98

ccpPayID

string

ID of credit card payment.

99

ccpTransID

string

ID of credit card transaction.

100

ReminderLevel

integer


101

ReminderProcessed

string


102

ReminderCosts

number


103

ReminderReason

string


104

ccpSetFailTries

integer


105

ccpSetFailLastTime

string


106

ShipmentTrackingID

string

ID of shipment tracking.

107

ReturnReason

string

Return reason text.

108

StockNote

string


109

ReturnSupplier

string


110

ReturnClosed

string

Return closed flag.

111

Fulfillment

boolean


112

InvoiceMailSent

boolean


113

TrackingIDsent

string

Date when the tracking ID was sent.

114

PaidByCustomer

number


115

PLHref

integer

Picklist number used for this invoice.

116

Packages

integer

Number of packages for the invoice.

117

DiscountTotal

number

Discount total for the invoice.

118

PaidAtCreation

number


119

TextIfNoInvlines

string


120

retTrackID

string

Tracking ID of the return.

121

retTrackIDhist

string

History of tracking IDs of returns.

122

1SS

boolean

One scan shipping flag.

123

DueDate

string


124

CreateDTAUS

boolean

DTAUS record should be created.

125

InvCreationMode

string

How was the invoice created.

126

VATBaseHigh_ShipCost_OrderCurr

number


127

VATBaseLow_ShipCost_OrderCurr

number


128

VATBaseZero_ShipCost

number


129

VATHigh_ShipCost

number

Total of high VAT in shipping costs.

130

VATLow_ShipCost

number

Total of low VAT in shipping costs.

131

OrderType

string

Type of the order/invoice.

132

Total_Net

number


133

VATBaseZero

number


134

Total_ShipCost_Net

number

Total of shipping costs without VAT.

135

ChargeHighVATInShipCost

boolean

Charge high VAT for shipping costs flag.

136

DontChargeShipCostOn2ndDelivery

string

Do not charge shipping costs on 2nd delivery flag.

137

ExecutionDate

string

Date of create return execution.

138

SEPAMandateReferenceRef

integer

ID of SEPA mandante reference.

139

ReturnCostsAmount

number

Return cost amount.

140

ReturnCostsAmount_Net

number

Return cost amount without VAT.


Additional Notes

**This API call creates a new *credit* based on an invoice.**
The call cannot be used to create a new return that is shown in pixi* Web and that can be worked on with pixi* Mobile!

The call allows to create returns with more than 1000 items.