pixiGetInvoiceLinesExtended

This is the API Call if you want to get more than one invoice line back. All parameters are optional.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: You can bypass the RowCount limit when you use "@RowCount = 0"


Request

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

Request body

Name Type Required Description
ShopID string false

Filter invoices from one shop

Type: varchar(3)

Default value: NULL

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

Status string false

Filter invoice lines according to the status of the orderlines related to them. Possible statusses: AUS, EIN, NLB, RET, STO, MIN

Type: varchar(3)

Default value: NULL

Example: EIN

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNR integer false

All invoicelines related to one order. Might be several invoices.

Type: int

Default value: NULL

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

RowCount integer false

Be carefull - the details of one invoice might be cut!

Type: int

Default value: 1000

Example: 123

Available from: LOU Official - Update 46 (6.9.46.27927)

InvDateTo string false

Filter by invoice date (to).

Type: datetime

Default value: NULL

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

Available from: LOU Official - Update 46 (6.9.46.27927)

InvoiceNr string false

Filter by one specific invoice number

Type: varchar(20)

Default value: NULL

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

AddCCPPayID boolean false

Adds a field "CcpPayID" that holds the external payment authorization reference for credit card processing.

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)

InvDateFrom string false

Filter by invoice date (from).

Type: datetime

Default value: NULL

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

Available from: LOU Official - Update 46 (6.9.46.27927)

PaymentType string false

Filter invoices by payment type.

Type: char

Default value: NULL

Example: Single character : "g"

Available from: LOU Official - Update 46 (6.9.46.27927)

UpdateDateTo string false

Filter by update date (to).

Type: datetime

Default value: NULL

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

Available from: LOU Official - Update 46 (6.9.46.27927)

UpdateDateFrom string false

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.

Type: datetime

Default value: NULL

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

Available from: LOU Official - Update 46 (6.9.46.27927)

OrderNRExternal string false

Same as OrderNR - but with the external order number from the shop.

Type: varchar(50)

Default value: NULL

Example: abcdefg

Available from: LOU Official - Update 46 (6.9.46.27927)

IsReplacementOnly boolean false

Show only replacement Orderlines/Invlines

Type: bit

Default value: 0

Example: 0 or 1

Available from: 22.09 (22.9.0.30861)

CustomerNrExternal string false

Filter by customer number external

Type: varchar(60)

Default value: NULL

Example: customer@pixi

Available from: 18.08 (8.4.44.35152)

OnlyUnpaidInvoices boolean false

Only returns invoice lines from unpaid or partially paid invoices.

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)

ConsiderInvoiceUpdates boolean true

When 1 use Invoice when 0 use Invlines Update Date from and to

Type: bit

Default value: 0

Example: 0 or 1

Available from: 25.03 (25.3.0.56141)

IncludeSpecialInvLines boolean false

If set to 1, it will return discounts, shipping costs and manualy created invoices without items as special lines.

Type: bit

Default value: 0

Example: 0 or 1

Available from: LOU Official - Update 46 (6.9.46.27927)


Response

1. Invoice lines details

Name Type Description
BIC string

Bank Identifier Code

Type: varchar

Available from: 25.06 (25.6.0.58802)

Blz string

Bank Code

Type: varchar

Available from: 25.06 (25.6.0.58802)

ZIP string

Postal code

Type: varchar

Available from: 25.06 (25.6.0.58802)

City string

City

Type: varchar

Available from: 25.06 (25.6.0.58802)

IBAN string

International Bank Account Number

Type: varchar

Available from: 25.06 (25.6.0.58802)

Name string

First and last name

Type: varchar

Available from: 25.06 (25.6.0.58802)

Note string

Invoice note

Type: varchar

Available from: 25.06 (25.6.0.58802)

Paid boolean

Flag if the invoice was paid already

Type: bit

Available from: 25.06 (25.6.0.58802)

Type string

Invoice type (Invoice/Credit)

Type: varchar

Available from: 25.06 (25.6.0.58802)

Name2 string

2nd name

Type: varchar

Available from: 25.06 (25.6.0.58802)

State string

State

Type: varchar

Available from: 25.06 (25.6.0.58802)

Total number

Invoice total

Type: money

Available from: 25.06 (25.6.0.58802)

Anrede string

Salutation

Type: varchar

Available from: 25.06 (25.6.0.58802)

CareOf string

Company name

Type: varchar

Available from: 25.06 (25.6.0.58802)

EANUPC string

Item barcode

Type: varchar

Available from: 25.06 (25.6.0.58802)

STATUS string

Invoice line status

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)

Street string

Street

Type: varchar

Available from: 25.06 (25.6.0.58802)

VATLow number

Sum of low VAT

Type: money

Available from: 25.06 (25.6.0.58802)

VATSum number

Sum of VAT

Type: money

Available from: 25.06 (25.6.0.58802)

Account string

Account number

Type: varchar

Available from: 25.06 (25.6.0.58802)

Address string

Address

Type: varchar

Available from: 25.06 (25.6.0.58802)

Country string

Country

Type: varchar

Available from: 25.06 (25.6.0.58802)

CustKey integer

Customer ID

Type: int

Available from: 25.06 (25.6.0.58802)

DF_Type string

Direct fulfillment type

Type: varchar

Available from: 25.06 (25.6.0.58802)

HouseNr string

House Number

Type: varchar

Available from: 25.06 (25.6.0.58802)

ItemQty integer

Item quantity

Type: int

Available from: 25.06 (25.6.0.58802)

OrderNr integer

Order number in pixi*

Type: int

Available from: 25.06 (25.6.0.58802)

PaidSum number

Actual paid amount

Type: money

Available from: 25.06 (25.6.0.58802)

SupplNr string

Supplier number (code)

Type: varchar

Available from: 25.06 (25.6.0.58802)

VATHigh number

Sum of high VAT

Type: money

Available from: 25.06 (25.6.0.58802)

BankName string

Name of the Bank

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardNr string

Number of the credit card used for payment

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcpPayID string

ID of credit card payment

Type: varchar

Available from: 25.06 (25.6.0.58802)

Currency string

Currency

Type: varchar

Available from: 25.06 (25.6.0.58802)

ItemName string

Item name

Type: varchar

Available from: 25.06 (25.6.0.58802)

LastName string

Last Name

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderQty integer

Item quantity

Type: int

Available from: 25.06 (25.6.0.58802)

Referrer string

Referrer of the order

Type: varchar

Available from: 25.06 (25.6.0.58802)

SerialNr string

Item serial number

Type: varchar

Available from: 25.06 (25.6.0.58802)

ShipCost number

The total shipping costs of the whole order

Type: money

Available from: 25.06 (25.6.0.58802)

ShipDate string

Ship this order at this date only! Not before

Type: datetime

Available from: 25.06 (25.6.0.58802)

CcCardExp string

Expiry date of the credit card

Type: varchar

Available from: 25.06 (25.6.0.58802)

FirstName string

First Name

Type: varchar

Available from: 25.06 (25.6.0.58802)

FullPrice number

Item full price

Type: money

Available from: 25.06 (25.6.0.58802)

InvoiceNr string

pixi* invoice number

Type: varchar

Available from: 25.06 (25.6.0.58802)

ItemNrInt string

Shop item number

Type: varchar

Available from: 25.06 (25.6.0.58802)

OrderDate string

Order create date imported from

Type: datetime

Available from: 25.06 (25.6.0.58802)

CcCardName string

Name of the credit institute

Type: varchar

Available from: 25.06 (25.6.0.58802)

CcCardType string

Type of credit card

Type: varchar

Available from: 25.06 (25.6.0.58802)

DFShipDate string

Direct fulfillment ship date

Type: datetime

Available from: 25.06 (25.6.0.58802)

InvLineKey integer

Invoice line ID

Type: int

Available from: 25.06 (25.6.0.58802)

InvoiceKey integer

Invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)

ShipVendor string

Shipping vendor code

Type: varchar

Available from: 25.06 (25.6.0.58802)

SupplPrice number

Supplier price of the item

Type: money

Available from: 25.06 (25.6.0.58802)

TotalNoVAT number

Invoice total without VAT

Type: money

Available from: 25.06 (25.6.0.58802)

TotalToPay number

Total amount to pay

Type: money

Available from: 25.06 (25.6.0.58802)

TrackingID string

Tracking ID of the shipment. Applies to the orders that have been shipped

Type: varchar

Available from: 25.06 (25.6.0.58802)

UpdateDate string

Last update date of the record

Type: datetime

Available from: 25.06 (25.6.0.58802)

AccountName string

Name of the owner of this bank account

Type: varchar

Available from: 25.06 (25.6.0.58802)

BatchNumber string

Item batch number

Type: varchar

Available from: 25.06 (25.6.0.58802)

InvoiceDate string

Date of the invoice

Type: datetime

Available from: 25.06 (25.6.0.58802)

ItemNrSuppl string

Supplier item number

Type: varchar

Available from: 25.06 (25.6.0.58802)

PaymentCode string

Payment code

Type: varchar

Available from: 25.06 (25.6.0.58802)

PaymentDate string

Date of the payment

Type: datetime

Available from: 25.06 (25.6.0.58802)

PaymentText string

Payment text / description

Type: varchar

Available from: 25.06 (25.6.0.58802)

SpecialNote string

Item special note

Type: varchar

Available from: 25.06 (25.6.0.58802)

SubShopLogo string

URL of the logo of the sub shop

Type: varchar

Available from: 25.06 (25.6.0.58802)

SubShopNAme string

Name of the sub shop

Type: varchar

Available from: 25.06 (25.6.0.58802)

DiscountPerc number

Discount percent

Type: numeric

Available from: 25.06 (25.6.0.58802)

Orderlinekey integer

ID for the Orderline record

Type: int

Available from: 25.06 (25.6.0.58802)

ReturnReason string

Return reason text

Type: varchar

Available from: 25.06 (25.6.0.58802)

DiscountValue number

Discount value

Type: money

Available from: 25.06 (25.6.0.58802)

ItemPrice_VAT number

Item VAT amount

Type: numeric

Available from: 25.06 (25.6.0.58802)

OrderCurrency string

Currency

Type: varchar

Available from: 25.06 (25.6.0.58802)

ReminderLevel integer

Reminder level

Type: int

Available from: 25.06 (25.6.0.58802)

ShipCostNoVAT number

The total shipping costs of the whole order excluding VAT

Type: numeric

Available from: 25.06 (25.6.0.58802)

BestBeforeDate string

Item best before date

Type: datetime

Available from: 25.06 (25.6.0.58802)

RefToInvoiceNr string

Reference to the original invoice number in case of returns

Type: varchar

Available from: 25.06 (25.6.0.58802)

ItemPrice_Netto number

Item price without VAT

Type: numeric

Available from: 25.06 (25.6.0.58802)

OrderNrExternal string

External order number

Type: varchar

Available from: 25.06 (25.6.0.58802)

RefToInvoiceKey integer

Reference to the original invoice ID

Type: int

Available from: 25.06 (25.6.0.58802)

Discount_Invoice number

Discount amount on the invoice itself (Net value in case of B2B Invoice)

Type: money

Available from: 25.06 (25.6.0.58802)

ItemPrice_Brutto number

Item price with VAT

Type: money

Available from: 25.06 (25.6.0.58802)

PaymentAddressId integer

Billing address ID

Type: int

Available from: 25.06 (25.6.0.58802)

Discount_InvLines number

Sum of invlines discout amounts

Type: money

Available from: 25.06 (25.6.0.58802)

ReturnCostsAmount number

Amount of return costs

Type: money

Available from: 25.06 (25.6.0.58802)

ShipmentAddressId integer

Shipping address ID

Type: int

Available from: 25.06 (25.6.0.58802)

CustomerNrExternal string

External Reference to the Customer (imported from Shop)

Type: varchar

Available from: 25.06 (25.6.0.58802)

DFShipmentTrackingID string

Direct fulfillment shipment tracking ID

Type: varchar

Available from: 25.06 (25.6.0.58802)

TotalToPay_OrderCurr number

Pay amount in order currency

Type: money

Available from: 25.06 (25.6.0.58802)