pixi Developer & Integration Documentation

pixiGetReminders

Description

Returns list of Invoices (Reminder candidates) for given parameters - Reminder level, Payment type, Shop and Reminder days.


Request Parameters

#

Name

Type

Required

Example

Description

1

ReminderLevel

integer

1

123

Allows to filter results by Reminder level. Value should be 1 or higher.

2

PaymentType

string

1

A

Allows to filter results by Invoice Payment type.

3

ShopID

string

1

A

Allows to filter results by Shop.

4

ReminderDays

integer

0

123

Allows to filter results by Invoice age (in days). If not set, DB setting or default values are used.


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:pixiGetReminders>
         <dem:ReminderLevel>123</dem:ReminderLevel>
         <dem:PaymentType>A</dem:PaymentType>
         <dem:ShopID>A</dem:ShopID>
         <dem:ReminderDays>123</dem:ReminderDays>
      </dem:pixiGetReminders>
   </soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Returns list of Reminders

#

Name

Type

Description

1

invoicenr

string

Invoice number

2

invdate

string

Invoice creation date

3

total

number

Invoice total amount

4

payment

string

Invoice payment type

5

shipmenttrackingid

string

Shipment tracking Id. Can contain multiple values, separated by delimiter (semicolon by default)

6

name

string

Name of customer

7

name2

string

Name of customer (2nd part) - optional

8

careof

string

Company of customer - optional

9

street

string

Street from address of customer

10

housenr

string

House number from address of customer

11

city

string

City from address of customer

12

state

string

State from address of customer

13

zip

string

ZIP from address of customer

14

country

string

Country code from address of customer

15

phone

string

Phone number from address of customer

16

email

string

Email address from address of customer

17

ShopName

string

Shop name

18

CuseMail

string

Shop email address


Additional Notes

Customers data is taken from Billing Address