GET api/V3/DetailedVisit/list?lastVisitId={lastVisitId}&DistributorERPId={DistributorERPId}&includeUnproductive={includeUnproductive}

Provides List of Visits from Transaction Db

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lastVisitId

integer

Required
DistributorERPId

string

None.
includeUnproductive

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Top 100 visits are returned

V3.NewVisit
NameDescriptionTypeAdditional information
VisitGuid

Visit unique Id

 globally unique identifier

None.
VisitId

Id of the visit

 integer

None.
InvoiceNumber

Invoice Number received from App

 string

None.
EmployeeName

Name of the Employee.

 string

None.
EmployeeGuid

Employee unique Id

 globally unique identifier

None.
Position

Name of Position for the Visit

 string

None.
PositionCode

Code of Position for the Visit

 string

None.
DistributorErpId

Distributor ErpId for the Visit

 string

None.
SuperStockistName

SuperStockist Name for the Visit

 string

None.
SuperStockistErpId

SuperStockist ErpId for the Visit

 string

None.
EmployeeDesignation

Current Designation of the User

 string

None.
EmpoyeeERPId

id of the Employee.

 string

None.
EmployeeType

Current Type of the User

 string

None.
OutletName

Outlet Name.

 string

None.
OutletERPId

Unique Id for the outlet/customer.

 string

None.
IsFocused

Whether the outlet is focused or not.

 boolean

None.
BeatName

BeatName

 string

None.
BeatERPId

Beat ERP Id

 string

None.
VanName

Van Name

 string

None.
VanChasisNumber

Van Chasis Number

 string

None.
Latitude

Latitude if available

 decimal number

None.
Longitude

Longitude if available

 decimal number

None.
Productive

Is the visit productive.

 boolean

None.
Valid

If the sale valid. If the order is changed on a later stage it may change.

 boolean

None.
NoSalesReason

If there was no sales, the reason for that.

 string

None.
RemarksManagement

Additional remark added by the sales executive for management.

 string

None.
RemarksDistributor

Additional remark added by the sales executive for distributor.

 string

None.
RemarksOther

Other additional remark added by the sales executive.

 string

None.
Time

Time of the visit.

 date

None.
SyncTime

Time of Syncing of Call to server

 date

None.
Discount

Discount in amount given on the Order

 decimal number

None.
Sales

List of the booked items

 Collection of V3.DetailedSale

None.
OutOfTurn

Was this Visit Out of turn (Not Scheduled for the Day)

 boolean

None.
IsTelephonic

Was this Telephonic Visit

 boolean

None.
Outlet

Outlet Details when ERPID for Outlet is Null

 V3.VisitOutlet

None.
EmployeeLocalName

Employee Local Name

 string

None.
RouteErpId

ErpId of Route

 string

None.
CallStartTime

Start time of Call

 date

None.
CallEndTime

End time of Call

 date

None.
OrderInUnits

Order in Units for the Visit or Visit of Distributor

 decimal number

None.
OrderInValue

Order value for the Visit or Visit of Distributor

 decimal number

None.
TotalGST

GST for the Order for the Visit or Visit of Distributor

 decimal number

None.
TotalDiscount

Total Discount for the order for the visit /Visit of distributor

 decimal number

None.
NetValue

Total Order value-Discount for order for the visit /Visit of distributor

 decimal number

None.
GrossValue

Total Order value-Discount + GST for the order for the visit /Visit of distributor

 decimal number

None.
IsNewOutlet

boolean

None.
InternationDiscounts

List of internation discounts applied for visit

 Collection of V3.VisitInternationDiscount

None.
SecondarySalesType

string

None.
IsOVC

boolean

None.
NoSaleReasonCategory

No Sale Reason Category

 string

None.
OrderSource

Order Source

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "VisitGuid": "1a86e19b-44f6-47af-8265-b8d70d17815f",
  "VisitId": 2,
  "InvoiceNumber": "sample string 3",
  "EmployeeName": "sample string 4",
  "EmployeeGuid": "4529540d-6163-4246-9ab4-d671994239ad",
  "Position": "sample string 6",
  "PositionCode": "sample string 7",
  "DistributorErpId": "sample string 8",
  "SuperStockistName": "sample string 9",
  "SuperStockistErpId": "sample string 10",
  "EmployeeDesignation": "sample string 11",
  "EmpoyeeERPId": "sample string 12",
  "EmployeeType": "sample string 13",
  "OutletName": "sample string 14",
  "OutletERPId": "sample string 15",
  "IsFocused": true,
  "BeatName": "sample string 17",
  "BeatERPId": "sample string 18",
  "VanName": "sample string 19",
  "VanChasisNumber": "sample string 20",
  "Latitude": 1.0,
  "Longitude": 1.0,
  "Productive": true,
  "Valid": true,
  "NoSalesReason": "sample string 21",
  "RemarksManagement": "sample string 22",
  "RemarksDistributor": "sample string 23",
  "RemarksOther": "sample string 24",
  "Time": "2025-04-04T05:42:00.8330652+00:00",
  "SyncTime": "2025-04-04T05:42:00.8330652+00:00",
  "Discount": 27.1,
  "Sales": [
    {
      "ProductERPId": "sample string 1",
      "ProductName": "sample string 2",
      "ProductDivision": "sample string 3",
      "Variant": "sample string 4",
      "Material": "sample string 5",
      "Quantity": 6.1,
      "Price": 1.1,
      "OrderType": "sample string 7",
      "Discount_Product": 1.1,
      "SchemeCashDiscount": 8.0,
      "SchemeQuantity": 9.1,
      "SchemeErpId": "sample string 10",
      "SuggestiveQuantity": 1.1,
      "VisitId": 11,
      "AlternateCategory": "sample string 12",
      "DistributorErpId": "sample string 13",
      "OriginalPTR": 1.1,
      "DistributorType": "sample string 14",
      "FAUnifySource": "sample string 15",
      "ProductUnit": "sample string 16",
      "CGST": 1.0,
      "SGST": 1.0,
      "IGST": 1.0,
      "VAT": 1.0,
      "FirstLevelDiscountAmount": 1.1,
      "SecondLevelDiscountAmount": 1.1,
      "IsProductMustSell": true,
      "IsFocused": true,
      "IsAssorted": true,
      "AdditionalProductAttributes": {
        "StandardUnitConversionFactor": 1.1,
        "StandardUnit": 2.1,
        "CasePrice": 1.1,
        "ProductWiseTotalSales": 1.1
      }
    },
    {
      "ProductERPId": "sample string 1",
      "ProductName": "sample string 2",
      "ProductDivision": "sample string 3",
      "Variant": "sample string 4",
      "Material": "sample string 5",
      "Quantity": 6.1,
      "Price": 1.1,
      "OrderType": "sample string 7",
      "Discount_Product": 1.1,
      "SchemeCashDiscount": 8.0,
      "SchemeQuantity": 9.1,
      "SchemeErpId": "sample string 10",
      "SuggestiveQuantity": 1.1,
      "VisitId": 11,
      "AlternateCategory": "sample string 12",
      "DistributorErpId": "sample string 13",
      "OriginalPTR": 1.1,
      "DistributorType": "sample string 14",
      "FAUnifySource": "sample string 15",
      "ProductUnit": "sample string 16",
      "CGST": 1.0,
      "SGST": 1.0,
      "IGST": 1.0,
      "VAT": 1.0,
      "FirstLevelDiscountAmount": 1.1,
      "SecondLevelDiscountAmount": 1.1,
      "IsProductMustSell": true,
      "IsFocused": true,
      "IsAssorted": true,
      "AdditionalProductAttributes": {
        "StandardUnitConversionFactor": 1.1,
        "StandardUnit": 2.1,
        "CasePrice": 1.1,
        "ProductWiseTotalSales": 1.1
      }
    }
  ],
  "OutOfTurn": true,
  "IsTelephonic": true,
  "Outlet": {
    "OutletId": 1,
    "OutletName": "sample string 2",
    "ShopType": "sample string 3",
    "ShopTypeErpId": "sample string 4",
    "ChannelErpId": "sample string 5",
    "OutletChannelName": "sample string 6",
    "Address": "sample string 7",
    "FormattedAddress": "sample string 8",
    "OwnersName": "sample string 9",
    "OwnersNo": "sample string 10",
    "TIN": "sample string 11",
    "GSTIN": "sample string 12",
    "PAN": "sample string 13",
    "Aadhar": "sample string 14",
    "Email": "sample string 15",
    "PinCode": "sample string 16",
    "MarketName": "sample string 17",
    "City": "sample string 18",
    "SubCity": "sample string 19",
    "State": "sample string 20",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 22",
    "AccountHoldersName": "sample string 23",
    "IFSCCode": "sample string 24",
    "AttributeText1": "sample string 25",
    "AttributeText2": "sample string 26",
    "AttributeText3": "sample string 27",
    "SegmentationDisplayName": "sample string 28",
    "Segmentation": 29,
    "SegmentationErpId": "sample string 30",
    "OutletGuid": "sample string 31",
    "Latitude": 1.0,
    "Longitude": 1.0,
    "PlaceOfDelivery": "sample string 32",
    "AttributeDate1": "2025-04-04T05:42:00.8486923+00:00",
    "AttributeDate2": "2025-04-04T05:42:00.8486923+00:00",
    "AttributeText4": "sample string 33",
    "AttributeNumber1": 1.1,
    "AttributeNumber2": 1.1,
    "AttributeNumber3": 1.1,
    "AttributeNumber4": 1.1,
    "AttributeBoolean1": true,
    "AttributeBoolean2": true,
    "BillToId": 1,
    "BillingAlternateAddress": "sample string 34",
    "BillingAlternateAddressErp": "sample string 35",
    "ShippedToId": 1,
    "ShippingAlternateAddress": "sample string 36",
    "ShippingAlternateAddressErp": "sample string 37"
  },
  "EmployeeLocalName": "sample string 30",
  "RouteErpId": "sample string 31",
  "CallStartTime": "2025-04-04T05:42:00.8486923+00:00",
  "CallEndTime": "2025-04-04T05:42:00.8486923+00:00",
  "OrderInUnits": 34.1,
  "OrderInValue": 1.1,
  "TotalGST": 1.0,
  "TotalDiscount": 1.1,
  "NetValue": 1.1,
  "GrossValue": 1.1,
  "IsNewOutlet": true,
  "InternationDiscounts": [
    {
      "ProductERPId": "sample string 1",
      "ProductName": "sample string 2",
      "Variant": "sample string 3",
      "Material": "sample string 4",
      "FirstLevelDiscountAmount": 1.1,
      "SecondLevelDiscountAmount": 1.1,
      "FOCQty": 5.1,
      "FOCSaleValue": 1.1
    },
    {
      "ProductERPId": "sample string 1",
      "ProductName": "sample string 2",
      "Variant": "sample string 3",
      "Material": "sample string 4",
      "FirstLevelDiscountAmount": 1.1,
      "SecondLevelDiscountAmount": 1.1,
      "FOCQty": 5.1,
      "FOCSaleValue": 1.1
    }
  ],
  "SecondarySalesType": "sample string 36",
  "IsOVC": true,
  "NoSaleReasonCategory": "sample string 38",
  "OrderSource": "sample string 39"
}

application/xml, text/xml

Sample: 
<NewVisit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <BeatERPId>sample string 18</BeatERPId>
  <BeatName>sample string 17</BeatName>
  <CallEndTime>2025-04-04T05:42:00.8486923+00:00</CallEndTime>
  <CallStartTime>2025-04-04T05:42:00.8486923+00:00</CallStartTime>
  <Discount>27.1</Discount>
  <DistributorErpId>sample string 8</DistributorErpId>
  <EmployeeDesignation>sample string 11</EmployeeDesignation>
  <EmployeeGuid>4529540d-6163-4246-9ab4-d671994239ad</EmployeeGuid>
  <EmployeeLocalName>sample string 30</EmployeeLocalName>
  <EmployeeName>sample string 4</EmployeeName>
  <EmployeeType>sample string 13</EmployeeType>
  <EmpoyeeERPId>sample string 12</EmpoyeeERPId>
  <GrossValue>1.1</GrossValue>
  <InternationDiscounts>
    <VisitInternationDiscount>
      <FOCQty>5.1</FOCQty>
      <FOCSaleValue>1.1</FOCSaleValue>
      <FirstLevelDiscountAmount>1.1</FirstLevelDiscountAmount>
      <ProductERPId>sample string 1</ProductERPId>
      <ProductName>sample string 2</ProductName>
      <SecondLevelDiscountAmount>1.1</SecondLevelDiscountAmount>
      <Variant>sample string 3</Variant>
    </VisitInternationDiscount>
    <VisitInternationDiscount>
      <FOCQty>5.1</FOCQty>
      <FOCSaleValue>1.1</FOCSaleValue>
      <FirstLevelDiscountAmount>1.1</FirstLevelDiscountAmount>
      <ProductERPId>sample string 1</ProductERPId>
      <ProductName>sample string 2</ProductName>
      <SecondLevelDiscountAmount>1.1</SecondLevelDiscountAmount>
      <Variant>sample string 3</Variant>
    </VisitInternationDiscount>
  </InternationDiscounts>
  <InvoiceNumber>sample string 3</InvoiceNumber>
  <IsFocused>true</IsFocused>
  <IsNewOutlet>true</IsNewOutlet>
  <IsOVC>true</IsOVC>
  <IsTelephonic>true</IsTelephonic>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <NetValue>1.1</NetValue>
  <NoSaleReasonCategory>sample string 38</NoSaleReasonCategory>
  <NoSalesReason>sample string 21</NoSalesReason>
  <OrderInUnits>34.1</OrderInUnits>
  <OrderInValue>1.1</OrderInValue>
  <OrderSource>sample string 39</OrderSource>
  <OutOfTurn>true</OutOfTurn>
  <Outlet>
    <Aadhar>sample string 14</Aadhar>
    <AccountHoldersName>sample string 23</AccountHoldersName>
    <Address>sample string 7</Address>
    <AttributeBoolean1>true</AttributeBoolean1>
    <AttributeBoolean2>true</AttributeBoolean2>
    <AttributeDate1>2025-04-04T05:42:00.8486923+00:00</AttributeDate1>
    <AttributeDate2>2025-04-04T05:42:00.8486923+00:00</AttributeDate2>
    <AttributeNumber1>1.1</AttributeNumber1>
    <AttributeNumber2>1.1</AttributeNumber2>
    <AttributeNumber3>1.1</AttributeNumber3>
    <AttributeNumber4>1.1</AttributeNumber4>
    <AttributeText1>sample string 25</AttributeText1>
    <AttributeText2>sample string 26</AttributeText2>
    <AttributeText3>sample string 27</AttributeText3>
    <AttributeText4>sample string 33</AttributeText4>
    <BankAccountNumber>sample string 22</BankAccountNumber>
    <BillToId>1</BillToId>
    <BillingAlternateAddress>sample string 34</BillingAlternateAddress>
    <BillingAlternateAddressErp>sample string 35</BillingAlternateAddressErp>
    <ChannelErpId>sample string 5</ChannelErpId>
    <City>sample string 18</City>
    <Email>sample string 15</Email>
    <FormattedAddress>sample string 8</FormattedAddress>
    <GSTIN>sample string 12</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 24</IFSCCode>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <MarketName>sample string 17</MarketName>
    <OutletChannelName>sample string 6</OutletChannelName>
    <OutletGuid>sample string 31</OutletGuid>
    <OutletId>1</OutletId>
    <OutletName>sample string 2</OutletName>
    <OwnersName>sample string 9</OwnersName>
    <OwnersNo>sample string 10</OwnersNo>
    <PAN>sample string 13</PAN>
    <PinCode>sample string 16</PinCode>
    <PlaceOfDelivery>sample string 32</PlaceOfDelivery>
    <Segmentation>29</Segmentation>
    <SegmentationDisplayName>sample string 28</SegmentationDisplayName>
    <SegmentationErpId>sample string 30</SegmentationErpId>
    <ShippedToId>1</ShippedToId>
    <ShippingAlternateAddress>sample string 36</ShippingAlternateAddress>
    <ShippingAlternateAddressErp>sample string 37</ShippingAlternateAddressErp>
    <ShopType>sample string 3</ShopType>
    <ShopTypeErpId>sample string 4</ShopTypeErpId>
    <State>sample string 20</State>
    <SubCity>sample string 19</SubCity>
    <TIN>sample string 11</TIN>
  </Outlet>
  <OutletERPId>sample string 15</OutletERPId>
  <OutletName>sample string 14</OutletName>
  <Position>sample string 6</Position>
  <PositionCode>sample string 7</PositionCode>
  <Productive>true</Productive>
  <RemarksDistributor>sample string 23</RemarksDistributor>
  <RemarksManagement>sample string 22</RemarksManagement>
  <RemarksOther>sample string 24</RemarksOther>
  <RouteErpId>sample string 31</RouteErpId>
  <Sales>
    <NewDetailedSale>
      <AdditionalProductAttributes>
        <CasePrice>1.1</CasePrice>
        <ProductWiseTotalSales>1.1</ProductWiseTotalSales>
        <StandardUnit>2.1</StandardUnit>
        <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor>
      </AdditionalProductAttributes>
      <AlternateCategory>sample string 12</AlternateCategory>
      <CGST>1</CGST>
      <Discount_Product>1.1</Discount_Product>
      <DistributorErpId>sample string 13</DistributorErpId>
      <DistributorType>sample string 14</DistributorType>
      <FAUnifySource>sample string 15</FAUnifySource>
      <FirstLevelDiscountAmount>1.1</FirstLevelDiscountAmount>
      <IGST>1</IGST>
      <IsAssorted>true</IsAssorted>
      <IsFocused>true</IsFocused>
      <IsProductMustSell>true</IsProductMustSell>
      <OrderType>sample string 7</OrderType>
      <OriginalPTR>1.1</OriginalPTR>
      <Price>1.1</Price>
      <ProductDivision>sample string 3</ProductDivision>
      <ProductERPId>sample string 1</ProductERPId>
      <ProductName>sample string 2</ProductName>
      <ProductUnit>sample string 16</ProductUnit>
      <Quantity>6.1</Quantity>
      <SGST>1</SGST>
      <SchemeCashDiscount>8</SchemeCashDiscount>
      <SchemeErpId>sample string 10</SchemeErpId>
      <SchemeQuantity>9.1</SchemeQuantity>
      <SecondLevelDiscountAmount>1.1</SecondLevelDiscountAmount>
      <SuggestiveQuantity>1.1</SuggestiveQuantity>
      <VAT>1</VAT>
      <Variant>sample string 4</Variant>
      <VisitId>11</VisitId>
    </NewDetailedSale>
    <NewDetailedSale>
      <AdditionalProductAttributes>
        <CasePrice>1.1</CasePrice>
        <ProductWiseTotalSales>1.1</ProductWiseTotalSales>
        <StandardUnit>2.1</StandardUnit>
        <StandardUnitConversionFactor>1.1</StandardUnitConversionFactor>
      </AdditionalProductAttributes>
      <AlternateCategory>sample string 12</AlternateCategory>
      <CGST>1</CGST>
      <Discount_Product>1.1</Discount_Product>
      <DistributorErpId>sample string 13</DistributorErpId>
      <DistributorType>sample string 14</DistributorType>
      <FAUnifySource>sample string 15</FAUnifySource>
      <FirstLevelDiscountAmount>1.1</FirstLevelDiscountAmount>
      <IGST>1</IGST>
      <IsAssorted>true</IsAssorted>
      <IsFocused>true</IsFocused>
      <IsProductMustSell>true</IsProductMustSell>
      <OrderType>sample string 7</OrderType>
      <OriginalPTR>1.1</OriginalPTR>
      <Price>1.1</Price>
      <ProductDivision>sample string 3</ProductDivision>
      <ProductERPId>sample string 1</ProductERPId>
      <ProductName>sample string 2</ProductName>
      <ProductUnit>sample string 16</ProductUnit>
      <Quantity>6.1</Quantity>
      <SGST>1</SGST>
      <SchemeCashDiscount>8</SchemeCashDiscount>
      <SchemeErpId>sample string 10</SchemeErpId>
      <SchemeQuantity>9.1</SchemeQuantity>
      <SecondLevelDiscountAmount>1.1</SecondLevelDiscountAmount>
      <SuggestiveQuantity>1.1</SuggestiveQuantity>
      <VAT>1</VAT>
      <Variant>sample string 4</Variant>
      <VisitId>11</VisitId>
    </NewDetailedSale>
  </Sales>
  <SecondarySalesType>sample string 36</SecondarySalesType>
  <SuperStockistErpId>sample string 10</SuperStockistErpId>
  <SuperStockistName>sample string 9</SuperStockistName>
  <SyncTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-04T05:42:00.8330652Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </SyncTime>
  <Time xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-04T05:42:00.8330652Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Time>
  <TotalDiscount>1.1</TotalDiscount>
  <TotalGST>1</TotalGST>
  <Valid>true</Valid>
  <VanChasisNumber>sample string 20</VanChasisNumber>
  <VanName>sample string 19</VanName>
  <VisitGuid>1a86e19b-44f6-47af-8265-b8d70d17815f</VisitGuid>
  <VisitId>2</VisitId>
</NewVisit>