pixi Developer & Integration Documentation

pixiReadReturnLines

Description

API call returns return line records


Request Parameters

# Name Type Required Example Description
1 Id integer 0 123 Return line id. If @RowCount is NULL then it returns only this row, otherwise next @RowCount records.
2 CreateDateFrom string 0 YYYY-MM-DD hh:mm:ss Create Date from (including)
3 CreateDateTo string 0 YYYY-MM-DD hh:mm:ss Create Date to (excluding)
4 UpdateDateFrom string 0 YYYY-MM-DD hh:mm:ss Update Date from (including)
5 UpdateDateTo string 0 YYYY-MM-DD hh:mm:ss Update Date To (excluding)
6 CreateAndUpdateDateFrom string 0 YYYY-MM-DD hh:mm:ss Create or Update Date from (including)
7 CreateAndUpdateDateTo string 0 YYYY-MM-DD hh:mm:ss Create or Update Date to (excluding)
8 RowCount integer 0 123 Maximum number of records returned

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:pixiReadReturnLines>
         <dem:Id>123</dem:Id>
         <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:pixiReadReturnLines>
   </soapenv:Body>
</soapenv:Envelope>

Response


Body 1: Return line information

# Name Type Description
1 Id integer Return line Id
2 ReasonId integer Reason Id
3 InvoiceLineId integer Invoice line Id
4 IsSpecialCase boolean Notes that there is something special about item being returned
5 CustomerComment string Customers comment about the returned item
6 UserComment string Users commnet about the returned item
7 RecordModifiedOn string Timestamp of the last modification of the record
8 ReturnId integer Foreign key to Return table.
9 InvBinItemLogId integer Foreign key to the put to stock operation.
10 InvoiceItemQty integer Invoice item quantity.
11 ReturnItemQty integer Returned item quantity.
12 ItemPriceGross number Item gross price.
13 ItemPriceNet number Item net price.
14 RecordCreatedOn string Date of creation.
15 RecordCreatedByUserId integer Foreign key to users table - user name who created the object.
16 RecordModifiedByUserId integer Foreign key to users table - user name who last modified the object.
17 ItemQualityClassificationId integer Foreign key to CodeTableValue Item Quality Classification codetable.

Additional Notes