GET Reporting/V1/Stock/GetTransfersReport

Gets the Transfers report data for given sites.

Request Information

URI Parameters

Name Type Description Additional information
RequestingSiteID integer

SiteID which is requesting report

None.

ProductTypeIDs Collection of integer

Optional: will refine report by given product type IDs, if empty will not refine the report

None.

ProductGroupIDs Collection of integer

Optional: will refine report by given product group IDs, if empty will not refine the report

None.

SiteIDs Collection of integer

Site IDs which the report will be run on

None.

DateUtcFrom date

Date which the report will start from

None.

DateUtcTo date

Date which the report will end till

None.

Body Parameters

ReportingRequestCommand
Name Type Description Additional information
RequestingSiteID integer

SiteID which is requesting report

None.

ProductTypeIDs Collection of integer

Optional: will refine report by given product type IDs, if empty will not refine the report

None.

ProductGroupIDs Collection of integer

Optional: will refine report by given product group IDs, if empty will not refine the report

None.

SiteIDs Collection of integer

Site IDs which the report will be run on

None.

DateUtcFrom date

Date which the report will start from

None.

DateUtcTo date

Date which the report will end till

None.

Request Formats

application/json, text/json

Sample:
{
  "RequestingSiteID": 1,
  "ProductTypeIDs": [
    1,
    2
  ],
  "ProductGroupIDs": [
    1,
    2
  ],
  "SiteIDs": [
    1,
    2
  ],
  "DateUtcFrom": "2024-11-21T06:23:43.7633608+00:00",
  "DateUtcTo": "2024-11-21T06:23:43.7633608+00:00"
}

application/xml, text/xml

Sample:
<ReportingRequestCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models">
  <DateUtcFrom>2024-11-21T06:23:43.7633608+00:00</DateUtcFrom>
  <DateUtcTo>2024-11-21T06:23:43.7633608+00:00</DateUtcTo>
  <ProductGroupIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProductGroupIDs>
  <ProductTypeIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProductTypeIDs>
  <RequestingSiteID>1</RequestingSiteID>
  <SiteIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SiteIDs>
</ReportingRequestCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of TransfersReportItemDto
Name Type Description Additional information
LocalTimeZoneID string

None.

TransferID integer

None.

Name string

None.

TransferType string

None.

TransferMethod string

None.

TransferDateUtc date

None.

Sender string

None.

Receiver string

None.

ProductType string

None.

ProductGroup string

None.

Item string

None.

Measure string

None.

Unit string

None.

SentLocation string

None.

ReceivedLocation string

None.

UnitQtyTransferred decimal number

None.

NetCost decimal number

None.

TransferDate date

None.

PageSize integer

None.

TotalCount integer

None.

HasMorePages boolean

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<ArrayOfTransfersReportItemDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Reports.Dto">
  <TransfersReportItemDto>
    <_x003C_Item_x003E_k__BackingField>sample string 11</_x003C_Item_x003E_k__BackingField>
    <_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 1</_x003C_LocalTimeZoneID_x003E_k__BackingField>
    <_x003C_Measure_x003E_k__BackingField>sample string 12</_x003C_Measure_x003E_k__BackingField>
    <_x003C_Name_x003E_k__BackingField>sample string 3</_x003C_Name_x003E_k__BackingField>
    <_x003C_NetCost_x003E_k__BackingField>17</_x003C_NetCost_x003E_k__BackingField>
    <_x003C_PageSize_x003E_k__BackingField>18</_x003C_PageSize_x003E_k__BackingField>
    <_x003C_ProductGroup_x003E_k__BackingField>sample string 10</_x003C_ProductGroup_x003E_k__BackingField>
    <_x003C_ProductType_x003E_k__BackingField>sample string 9</_x003C_ProductType_x003E_k__BackingField>
    <_x003C_ReceivedLocation_x003E_k__BackingField>sample string 15</_x003C_ReceivedLocation_x003E_k__BackingField>
    <_x003C_Receiver_x003E_k__BackingField>sample string 8</_x003C_Receiver_x003E_k__BackingField>
    <_x003C_Sender_x003E_k__BackingField>sample string 7</_x003C_Sender_x003E_k__BackingField>
    <_x003C_SentLocation_x003E_k__BackingField>sample string 14</_x003C_SentLocation_x003E_k__BackingField>
    <_x003C_TotalCount_x003E_k__BackingField>19</_x003C_TotalCount_x003E_k__BackingField>
    <_x003C_TransferDateUtc_x003E_k__BackingField>2024-11-21T06:23:43.7791547+00:00</_x003C_TransferDateUtc_x003E_k__BackingField>
    <_x003C_TransferID_x003E_k__BackingField>2</_x003C_TransferID_x003E_k__BackingField>
    <_x003C_TransferMethod_x003E_k__BackingField>sample string 5</_x003C_TransferMethod_x003E_k__BackingField>
    <_x003C_TransferType_x003E_k__BackingField>sample string 4</_x003C_TransferType_x003E_k__BackingField>
    <_x003C_UnitQtyTransferred_x003E_k__BackingField>16</_x003C_UnitQtyTransferred_x003E_k__BackingField>
    <_x003C_Unit_x003E_k__BackingField>sample string 13</_x003C_Unit_x003E_k__BackingField>
  </TransfersReportItemDto>
  <TransfersReportItemDto>
    <_x003C_Item_x003E_k__BackingField>sample string 11</_x003C_Item_x003E_k__BackingField>
    <_x003C_LocalTimeZoneID_x003E_k__BackingField>sample string 1</_x003C_LocalTimeZoneID_x003E_k__BackingField>
    <_x003C_Measure_x003E_k__BackingField>sample string 12</_x003C_Measure_x003E_k__BackingField>
    <_x003C_Name_x003E_k__BackingField>sample string 3</_x003C_Name_x003E_k__BackingField>
    <_x003C_NetCost_x003E_k__BackingField>17</_x003C_NetCost_x003E_k__BackingField>
    <_x003C_PageSize_x003E_k__BackingField>18</_x003C_PageSize_x003E_k__BackingField>
    <_x003C_ProductGroup_x003E_k__BackingField>sample string 10</_x003C_ProductGroup_x003E_k__BackingField>
    <_x003C_ProductType_x003E_k__BackingField>sample string 9</_x003C_ProductType_x003E_k__BackingField>
    <_x003C_ReceivedLocation_x003E_k__BackingField>sample string 15</_x003C_ReceivedLocation_x003E_k__BackingField>
    <_x003C_Receiver_x003E_k__BackingField>sample string 8</_x003C_Receiver_x003E_k__BackingField>
    <_x003C_Sender_x003E_k__BackingField>sample string 7</_x003C_Sender_x003E_k__BackingField>
    <_x003C_SentLocation_x003E_k__BackingField>sample string 14</_x003C_SentLocation_x003E_k__BackingField>
    <_x003C_TotalCount_x003E_k__BackingField>19</_x003C_TotalCount_x003E_k__BackingField>
    <_x003C_TransferDateUtc_x003E_k__BackingField>2024-11-21T06:23:43.7791547+00:00</_x003C_TransferDateUtc_x003E_k__BackingField>
    <_x003C_TransferID_x003E_k__BackingField>2</_x003C_TransferID_x003E_k__BackingField>
    <_x003C_TransferMethod_x003E_k__BackingField>sample string 5</_x003C_TransferMethod_x003E_k__BackingField>
    <_x003C_TransferType_x003E_k__BackingField>sample string 4</_x003C_TransferType_x003E_k__BackingField>
    <_x003C_UnitQtyTransferred_x003E_k__BackingField>16</_x003C_UnitQtyTransferred_x003E_k__BackingField>
    <_x003C_Unit_x003E_k__BackingField>sample string 13</_x003C_Unit_x003E_k__BackingField>
  </TransfersReportItemDto>
</ArrayOfTransfersReportItemDto>