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

Since pixi version: LOU Official (6.3.0.4452) 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!


Request

POST https://apigateway.descartes.com/tms/pixi/pixiCreateReturn

Request body

Name Type Required Description
BIC string false

BIC

Type: varchar(11)

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)

BLZ string false

BLZ - Bankleitzahl (bank code)

Type: char

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

IBAN string false

IBAN

Type: varchar(30)

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)

Note string false

Note

Type: varchar(255)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

Prices string true

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

Type: varchar(8000)

Default value:

Example: 5,99;

Available from: LOU Official (6.3.0.4452)

Account string false

Bank account number

Type: varchar(10)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

ShipCost number false

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

Type: money

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

CAComment string false

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

Type: varchar(1000)

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)

CreateEmp string false

pixi* user name that creates return

Type: varchar(50)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

InvoiceNr string true

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

Type: varchar(20)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

CreateDate string false

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

Type: datetime

Default value:

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

Available from: LOU Official (6.3.0.4452)

LanguageId integer false

Language ID used when creating history records.

Type: int

Default value: 2 - German

Example:

Available from: AVA 17.03 (8.4.27.29272)

Quantities string true

Returned items quantities. Separator is semicolon.

Type: varchar(8000)

Default value:

Example: 1;2;3;

Available from: LOU Official (6.3.0.4452)

AccountName string true

Bank account name

Type: varchar(27)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

CreateDTAUS boolean false

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

Type: bit

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)

DoNotRefund boolean false

Do not refund. Bit value.

Type: bit

Default value: False

Example:

Available from: AVA 17.03 (8.4.27.29272)

InvoiceDate string false

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

Type: datetime

Default value:

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

Available from: LOU Official (6.3.0.4452)

PaymentType string true

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

Type: char

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

InvoiceLines string true

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

Type: varchar(8000)

Default value:

Example: 123;

Available from: LOU Official (6.3.0.4452)

ReturnCaseID integer false

Repairs Return Case ID

Type: int

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)

ReturnClosed boolean false

Return closed. Bit value.

Type: bit

Default value: True

Example:

Available from: LOU Official (6.3.0.4452)

ReturnReason string false

Return reason

Type: varchar(100)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

Voucher_Amount number false

Voucher amount

Type: money

Default value: Voucher amount form connected invoice or 0

Example: 9.78

Available from: 18.07 (8.4.43.34931)

ReturnCostsAmount number false

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.

Type: money

Default value:

Example:

Available from: AVA 17.03 (8.4.27.29272)

MarkReturnDocumentForPrinting boolean false

Mark if Document (Credit) has to be printed.

Type: bit

Default value: 0

Example: 0

Available from: 23.04 (23.4.0.37024)


Response

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

Name Type Description
1SS boolean

One scan shipping flag.

Type: bit

Available from: / (25.8.0.59841)

BLZ string

Type: varchar

Available from: / (25.8.0.59841)

LSNr integer

Type: int

Available from: / (25.8.0.59841)

Note string

Type: varchar

Available from: / (25.8.0.59841)

BoxNr integer

Box number that holds the items of the invoice.

Type: int

Available from: / (25.8.0.59841)

Payed string

Type: datetime

Available from: / (25.8.0.59841)

VATNo string

Type: varchar

Available from: / (25.8.0.59841)

total number

Invoice amount.

Type: money

Available from: / (25.8.0.59841)

CardNr string

Type: varchar

Available from: / (25.8.0.59841)

LSDate string

Type: datetime

Available from: / (25.8.0.59841)

NODRef integer

Type: int

Available from: / (25.8.0.59841)

PLHref integer

Picklist number used for this invoice.

Type: int

Available from: / (25.8.0.59841)

PayDay string

Type: datetime

Available from: / (25.8.0.59841)

SUGKTO string

Type: varchar

Available from: / (25.8.0.59841)

VATLow number

Total sum of low VAT.

Type: money

Available from: / (25.8.0.59841)

AccName string

Type: varchar

Available from: / (25.8.0.59841)

Account string

Type: varchar

Available from: / (25.8.0.59841)

AddrRef integer

ID of billing address.

Type: int

Available from: / (25.8.0.59841)

CardExp string

Type: varchar

Available from: / (25.8.0.59841)

CustRef integer

ID of customer.

Type: int

Available from: / (25.8.0.59841)

DueDate string

Type: datetime

Available from: / (25.8.0.59841)

InvDate string

Invoice date.

Type: datetime

Available from: / (25.8.0.59841)

IssueNr string

Type: varchar

Available from: / (25.8.0.59841)

Payment string

ID of payment type.

Type: varchar

Available from: / (25.8.0.59841)

Printed string

Type: varchar

Available from: / (25.8.0.59841)

RLSCost number

Type: money

Available from: / (25.8.0.59841)

RLSDate string

Type: datetime

Available from: / (25.8.0.59841)

Summary number

Type: money

Available from: / (25.8.0.59841)

VATHigh number

Total sum of high VAT.

Type: money

Available from: / (25.8.0.59841)

VATType string

Type: varchar

Available from: / (25.8.0.59841)

AuszugNr string

Type: varchar

Available from: / (25.8.0.59841)

CCAddFee number

Type: money

Available from: / (25.8.0.59841)

CardDate string

Type: datetime

Available from: / (25.8.0.59841)

CardName string

Type: varchar

Available from: / (25.8.0.59841)

CardType string

Type: varchar

Available from: / (25.8.0.59841)

Packages integer

Number of packages for the invoice.

Type: int

Available from: / (25.8.0.59841)

PayedSum number

Payed amount.

Type: money

Available from: / (25.8.0.59841)

ShipCode string

Type: varchar

Available from: / (25.8.0.59841)

VATHText string

Text representation of high VAT.

Type: varchar

Available from: / (25.8.0.59841)

VATLText string

Text representation of low VAT.

Type: varchar

Available from: / (25.8.0.59841)

ccpPayID string

ID of credit card payment.

Type: varchar

Available from: / (25.8.0.59841)

BuchuText string

Type: varchar

Available from: / (25.8.0.59841)

CardCheck string

Type: varchar

Available from: / (25.8.0.59841)

ChargeVAT string

The flag that marks if the VAT should be charged.

Type: char

Available from: / (25.8.0.59841)

CreateEmp string

Employee who created the invoice.

Type: varchar

Available from: / (25.8.0.59841)

GNMcharge string

Type: varchar

Available from: / (25.8.0.59841)

InvShopID string

Shop ID that invoice was created for.

Type: varchar

Available from: / (25.8.0.59841)

InvoiceNr string

Invoice number.

Type: varchar

Available from: / (25.8.0.59841)

OrderType string

Type of the order/invoice.

Type: varchar

Available from: / (25.8.0.59841)

PrintDate string

Type: datetime

Available from: / (25.8.0.59841)

SkontoAbz number

Type: money

Available from: / (25.8.0.59841)

StockNote string

Type: varchar

Available from: / (25.8.0.59841)

Supporter string

Type: varchar

Available from: / (25.8.0.59841)

Total_Net number

Type: money

Available from: / (25.8.0.59841)

UpdateEmp string

Employee who last updated the invoice.

Type: varchar

Available from: / (25.8.0.59841)

VoucherID string

ID of the voucher.

Type: varchar

Available from: / (25.8.0.59841)

CreateDate string

Creation date of the invoice.

Type: datetime

Available from: / (25.8.0.59841)

InvoiceKey integer

ID of the invoice.

Type: int

Available from: / (25.8.0.59841)

ShipAdrRef integer

ID of shipping address.

Type: int

Available from: / (25.8.0.59841)

ShipVendor string

Shipping vendor code.

Type: varchar

Available from: / (25.8.0.59841)

UpdateDate string

Last update date of the invoice.

Type: datetime

Available from: / (25.8.0.59841)

VATBaseLow number

Sum of low VAT.

Type: money

Available from: / (25.8.0.59841)

VATLowPerc number

The VAT percent of low VAT.

Type: numeric

Available from: / (25.8.0.59841)

VoucherSum number

Total sum of the voucher for the invoice.

Type: money

Available from: / (25.8.0.59841)

ccpTransID string

ID of credit card transaction.

Type: varchar

Available from: / (25.8.0.59841)

retTrackID string

Tracking ID of the return.

Type: varchar

Available from: / (25.8.0.59841)

CCPAuthCode string

Type: varchar

Available from: / (25.8.0.59841)

CCPReCharge string

Type: varchar

Available from: / (25.8.0.59841)

CreateDTAUS boolean

DTAUS record should be created.

Type: bit

Available from: / (25.8.0.59841)

Fulfillment boolean

Type: bit

Available from: / (25.8.0.59841)

InvShipLock string

Shipping lock activated flag.

Type: varchar

Available from: / (25.8.0.59841)

ScanOutDate string

Date of the ship out.

Type: datetime

Available from: / (25.8.0.59841)

VATBaseHigh number

Sum of high VAT.

Type: money

Available from: / (25.8.0.59841)

VATBaseZero number

Type: money

Available from: / (25.8.0.59841)

VATHighPerc number

The VAT percent of high VAT.

Type: numeric

Available from: / (25.8.0.59841)

ReturnClosed string

Return closed flag.

Type: char

Available from: / (25.8.0.59841)

ReturnReason string

Return reason text.

Type: varchar

Available from: / (25.8.0.59841)

SupportPhone string

Type: varchar

Available from: / (25.8.0.59841)

TimesPrinted integer

Count of how many times the invoice was printed.

Type: int

Available from: / (25.8.0.59841)

CCFeeCurrency string

Type: varchar

Available from: / (25.8.0.59841)

CCPNumOfTries integer

Number of tries of credit card processing.

Type: int

Available from: / (25.8.0.59841)

DiscountTotal number

Discount total for the invoice.

Type: money

Available from: / (25.8.0.59841)

ExecutionDate string

Date of create return execution.

Type: datetime

Available from: / (25.8.0.59841)

InvLocationID string

Location where invoice was created.

Type: varchar

Available from: / (25.8.0.59841)

IsPackageLost string

Type: varchar

Available from: / (25.8.0.59841)

OrderCurrency string

Invoice currency.

Type: varchar

Available from: / (25.8.0.59841)

Reminder1Date string

Type: datetime

Available from: / (25.8.0.59841)

Reminder2Date string

Type: datetime

Available from: / (25.8.0.59841)

Reminder3Date string

Type: datetime

Available from: / (25.8.0.59841)

ReminderCosts number

Type: money

Available from: / (25.8.0.59841)

ReminderLevel integer

Type: int

Available from: / (25.8.0.59841)

VATinShipCost string

VAT is included in shipping costs.

Type: varchar

Available from: / (25.8.0.59841)

skontoprozent string

Type: smallint

Available from: / (25.8.0.59841)

BankFeeAmmount number

Type: money

Available from: / (25.8.0.59841)

CCFeeProvision string

Type: float

Available from: / (25.8.0.59841)

CCPPaymentDone string

Credit card payment done flag.

Type: varchar

Available from: / (25.8.0.59841)

CostChargeShop number

Type: money

Available from: / (25.8.0.59841)

InvTrackNumber string

Tracking number for the invoice.

Type: varchar

Available from: / (25.8.0.59841)

PaidAtCreation number

Type: money

Available from: / (25.8.0.59841)

PaidByCustomer number

Type: money

Available from: / (25.8.0.59841)

RefToInvoiceNr string

Reference to the original invoice number.

Type: varchar

Available from: / (25.8.0.59841)

ReminderReason string

Type: varchar

Available from: / (25.8.0.59841)

ReturnSupplier string

Type: varchar

Available from: / (25.8.0.59841)

Total_ShipCost number

The total of ship costs.

Type: money

Available from: / (25.8.0.59841)

TrackingIDsent string

Date when the tracking ID was sent.

Type: datetime

Available from: / (25.8.0.59841)

retTrackIDhist string

History of tracking IDs of returns.

Type: varchar

Available from: / (25.8.0.59841)

CCPChargedSoFar number

Type: money

Available from: / (25.8.0.59841)

InvCreationMode string

How was the invoice created.

Type: varchar

Available from: / (25.8.0.59841)

InvoiceMailSent boolean

Type: bit

Available from: / (25.8.0.59841)

RefToInvoiceKey integer

Reference to the original invoice ID.

Type: int

Available from: / (25.8.0.59841)

ShippedByVendor boolean

Invoice was shipped by shipping vendor flag.

Type: bit

Available from: / (25.8.0.59841)

Total_OrderCurr number

Invoice amount.

Type: money

Available from: / (25.8.0.59841)

VATLow_ShipCost number

Total of low VAT in shipping costs.

Type: money

Available from: / (25.8.0.59841)

ccpSetFailTries integer

Type: int

Available from: / (25.8.0.59841)

PackageNetWeight string

Type: float

Available from: / (25.8.0.59841)

TextIfNoInvlines string

Type: varchar

Available from: / (25.8.0.59841)

VATHigh_ShipCost number

Total of high VAT in shipping costs.

Type: money

Available from: / (25.8.0.59841)

VATLow_OrderCurr number

Total sum of low VAT.

Type: money

Available from: / (25.8.0.59841)

ReminderProcessed string

Type: char

Available from: / (25.8.0.59841)

ReturnCostsAmount number

Return cost amount.

Type: money

Available from: / (25.8.0.59841)

VATHigh_OrderCurr number

Total sum of high VAT.

Type: money

Available from: / (25.8.0.59841)

CostChargeCurrency string

Type: varchar

Available from: / (25.8.0.59841)

PackageGrossWeight string

Weight of the package shipped with this invoice.

Type: float

Available from: / (25.8.0.59841)

ShipmentTrackingID string

ID of shipment tracking.

Type: varchar

Available from: / (25.8.0.59841)

Total_ShipCost_Net number

Total of shipping costs without VAT.

Type: money

Available from: / (25.8.0.59841)

ccpSetFailLastTime string

Type: datetime

Available from: / (25.8.0.59841)

VATBaseLow_ShipCost number

Total of low VAT in shipping costs.

Type: money

Available from: / (25.8.0.59841)

CCPShipCostChargedYN string

Type: varchar

Available from: / (25.8.0.59841)

ShipVendorIncrement1 integer

Type: int

Available from: / (25.8.0.59841)

VATBaseHigh_ShipCost number

Total of high VAT in shipping costs.

Type: money

Available from: / (25.8.0.59841)

VATBaseLow_OrderCurr number

Type: money

Available from: / (25.8.0.59841)

VATBaseZero_ShipCost number

Type: money

Available from: / (25.8.0.59841)

ReturnCostsAmount_Net number

Return cost amount without VAT.

Type: money

Available from: / (25.8.0.59841)

VATBaseHigh_OrderCurr number

Type: money

Available from: / (25.8.0.59841)

ChargeHighVATInShipCost boolean

Charge high VAT for shipping costs flag.

Type: bit

Available from: / (25.8.0.59841)

SEPAMandateReferenceRef integer

ID of SEPA mandante reference.

Type: int

Available from: / (25.8.0.59841)

Total_ShipCost_OrderCurr number

The total of ship costs.

Type: money

Available from: / (25.8.0.59841)

VATBaseLow_ShipCost_OrderCurr number

Type: money

Available from: / (25.8.0.59841)

VATBaseHigh_ShipCost_OrderCurr number

Type: money

Available from: / (25.8.0.59841)

DontChargeShipCostOn2ndDelivery string

Do not charge shipping costs on 2nd delivery flag.

Type: varchar

Available from: / (25.8.0.59841)