getInventoryTransferReport

Get an inventory transfer report.

API returns a link to CSV file that contains the report.

To retrieve the documents (Inventory Transfers) themselves, see getInventoryTransfers.

Sales and purchase data is also available in report format. See getSalesReport and getPurchaseReport.

Input parameters

Parameter name Description Possible value Required
type  Retrieve either a report of inventory transfers (actual movements that have taken place), or inventory transfer orders.

Possible values are "TRANSFER", "TRANSFER_ORDER". 
String  yes  
dateStart  Date range filter.  ISO date (yyyy-mm-dd)  yes  
dateEnd  Date range filter.  ISO date (yyyy-mm-dd)  yes  
currencyCode  Currency code: EUR, USD.

Setting this parameter will return a report where all sums have been re-calculated into specified currency. In other words, this is NOT a filter. In almost all cases, you will want the report in your account default currency, so it is recommended to omit this parameter.

The specified currency must be defined in Erply. If omitted, or an unknown currency code is provided, API uses your default currency. 
String (3)    
warehouseFromID  Filter inventory transfers by source location (warehouse, store).  Integer    
warehouseToID  Filter inventory transfers by destination location (warehouse, store).  Integer    
supplierID  Filter inventory transfers by supplier.  Integer    

Response

Field name Type Description
reportLink  String  Link to report file.

The report is a CSV file in "latin1" encoding. Fields are separated by semicolons and quoted with double quotes. The file has a header line (with standard column headers, for identifying which field contains which data) and a footer line (with totals). Here is a sample:

"LINE_NUMBER";"PRODUCT_ID";"PRODUCT_CODE";
"PRODUCT_NAME";"COST";"AMOUNT";"LINE_TOTAL";
"INVENTORY_TRANSFER_ID";"DATE";"NUMBER";
"NOTES";"WAREHOUSE_FROM_ID";"WAREHOUSE_TO_ID";"EMPLOYEE_ID"
"1";"6";"2014091611";"Croissant";"3";"1";"3";"3";"2014-08-25";"44";"notes 1";"3";"4";"31"
"2";"5";"2014091619";"Large​Coffee";"5";"1";"5";"59";"2014-09-16";"47";"notes 2";"4";"3";"33"
"TOTAL";"";"";"";"";"";"8";"";"";"";"";"";"";""


The escape character for literal quote characters is ", like in Microsoft Excel: "This ""word"" is quoted".

First line is a header line. Each column has a specific header identifier and you can use the headers to parse data out of the file. The last line in file is a total line, identified by the word "TOTAL" in line number column.

Report currently has the following columns, but new ones may be added in the future, so you should configure your CSV parser to extract information based on file headers.
  • LINE_NUMBER
  • PRODUCT_ID
  • PRODUCT_CODE
  • PRODUCT_NAME
  • COST
  • AMOUNT
  • LINE_TOTAL
  • INVENTORY_TRANSFER_ID
  • DATE
  • NUMBER
  • NOTES
  • WAREHOUSE_FROM_ID
  • WAREHOUSE_TO_ID
  • y
  • EMPLOYEE_ID