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.
EmployeeName

Name of the Employee.

 string

None.
EmployeeGuid

Employee unique Id

 globally unique identifier

None.
DistributorErpId

Distributor ErpId for the Visit

 string

None.
EmpoyeeERPId

id of the Employee.

 string

None.
OutletName

Outlet Name.

 string

None.
OutletERPId

Unique Id for the outlet/customer.

 string

None.
BeatName

BeatName

 string

None.
BeatERPId

Beat ERP Id

 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

None.

Response Formats

application/json, text/json

Sample: 
{
  "VisitGuid": "cb53d798-e74e-4f95-813a-46daba3ffbe4",
  "VisitId": 2,
  "EmployeeName": "sample string 3",
  "EmployeeGuid": "a149607a-5153-4896-acd2-b88d30198267",
  "DistributorErpId": "sample string 5",
  "EmpoyeeERPId": "sample string 6",
  "OutletName": "sample string 7",
  "OutletERPId": "sample string 8",
  "BeatName": "sample string 9",
  "BeatERPId": "sample string 10",
  "Latitude": 1.0,
  "Longitude": 1.0,
  "Productive": true,
  "Valid": true,
  "NoSalesReason": "sample string 11",
  "RemarksManagement": "sample string 12",
  "RemarksDistributor": "sample string 13",
  "RemarksOther": "sample string 14",
  "Time": "2026-04-06T09:11:03.4501667+00:00",
  "SyncTime": "2026-04-06T09:11:03.4501667+00:00",
  "Discount": 17.1,
  "Sales": [
    {
      "ProductERPId": "sample string 1",
      "ProductName": "sample string 2",
      "Variant": "sample string 3",
      "Material": "sample string 4",
      "Quantity": 5.1,
      "Price": 1.1,
      "OrderType": "sample string 6",
      "Discount_Product": 1.1,
      "SchemeCashDiscount": 7.0,
      "SchemeQuantity": 8.1,
      "SuggestiveQuantity": 1.1,
      "VisitId": 9,
      "AlternateCategory": "sample string 10",
      "DistributorErpId": "sample string 11",
      "OriginalPTR": 1.1,
      "DistributorType": "sample string 12",
      "ProductUnit": "sample string 13"
    },
    {
      "ProductERPId": "sample string 1",
      "ProductName": "sample string 2",
      "Variant": "sample string 3",
      "Material": "sample string 4",
      "Quantity": 5.1,
      "Price": 1.1,
      "OrderType": "sample string 6",
      "Discount_Product": 1.1,
      "SchemeCashDiscount": 7.0,
      "SchemeQuantity": 8.1,
      "SuggestiveQuantity": 1.1,
      "VisitId": 9,
      "AlternateCategory": "sample string 10",
      "DistributorErpId": "sample string 11",
      "OriginalPTR": 1.1,
      "DistributorType": "sample string 12",
      "ProductUnit": "sample string 13"
    }
  ],
  "OutOfTurn": true,
  "IsTelephonic": true,
  "Outlet": {
    "OutletName": "sample string 1",
    "ShopType": "sample string 2",
    "ShopTypeErpId": "sample string 3",
    "ChannelErpId": "sample string 4",
    "OutletChannelName": "sample string 5",
    "Address": "sample string 6",
    "OwnersName": "sample string 7",
    "OwnersNo": "sample string 8",
    "TIN": "sample string 9",
    "GSTIN": "sample string 10",
    "PAN": "sample string 11",
    "Aadhar": "sample string 12",
    "Email": "sample string 13",
    "PinCode": "sample string 14",
    "MarketName": "sample string 15",
    "City": "sample string 16",
    "SubCity": "sample string 17",
    "State": "sample string 18",
    "GSTRegistered": true,
    "BankAccountNumber": "sample string 20",
    "AccountHoldersName": "sample string 21",
    "IFSCCode": "sample string 22",
    "AttributeText1": "sample string 23",
    "AttributeText2": "sample string 24",
    "AttributeText3": "sample string 25",
    "SegmentationDisplayName": "sample string 26",
    "Segmentation": 27,
    "SegmentationErpId": "sample string 28",
    "OutletGuid": "sample string 29",
    "Latitude": 1.0,
    "Longitude": 1.0
  },
  "EmployeeLocalName": "sample string 20",
  "RouteErpId": "sample string 21",
  "CallStartTime": "2026-04-06T09:11:03.4501667+00:00",
  "CallEndTime": "2026-04-06T09:11:03.4501667+00:00",
  "IsNewOutlet": true
}

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 10</BeatERPId>
  <BeatName>sample string 9</BeatName>
  <CallEndTime>2026-04-06T09:11:03.4501667+00:00</CallEndTime>
  <CallStartTime>2026-04-06T09:11:03.4501667+00:00</CallStartTime>
  <Discount>17.1</Discount>
  <DistributorErpId>sample string 5</DistributorErpId>
  <EmployeeGuid>a149607a-5153-4896-acd2-b88d30198267</EmployeeGuid>
  <EmployeeLocalName>sample string 20</EmployeeLocalName>
  <EmployeeName>sample string 3</EmployeeName>
  <EmpoyeeERPId>sample string 6</EmpoyeeERPId>
  <IsNewOutlet>true</IsNewOutlet>
  <IsTelephonic>true</IsTelephonic>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <NoSalesReason>sample string 11</NoSalesReason>
  <OutOfTurn>true</OutOfTurn>
  <Outlet>
    <Aadhar>sample string 12</Aadhar>
    <AccountHoldersName>sample string 21</AccountHoldersName>
    <Address>sample string 6</Address>
    <AttributeText1>sample string 23</AttributeText1>
    <AttributeText2>sample string 24</AttributeText2>
    <AttributeText3>sample string 25</AttributeText3>
    <BankAccountNumber>sample string 20</BankAccountNumber>
    <ChannelErpId>sample string 4</ChannelErpId>
    <City>sample string 16</City>
    <Email>sample string 13</Email>
    <GSTIN>sample string 10</GSTIN>
    <GSTRegistered>true</GSTRegistered>
    <IFSCCode>sample string 22</IFSCCode>
    <Latitude>1</Latitude>
    <Longitude>1</Longitude>
    <MarketName>sample string 15</MarketName>
    <OutletChannelName>sample string 5</OutletChannelName>
    <OutletGuid>sample string 29</OutletGuid>
    <OutletName>sample string 1</OutletName>
    <OwnersName>sample string 7</OwnersName>
    <OwnersNo>sample string 8</OwnersNo>
    <PAN>sample string 11</PAN>
    <PinCode>sample string 14</PinCode>
    <Segmentation>27</Segmentation>
    <SegmentationDisplayName>sample string 26</SegmentationDisplayName>
    <SegmentationErpId>sample string 28</SegmentationErpId>
    <ShopType>sample string 2</ShopType>
    <ShopTypeErpId>sample string 3</ShopTypeErpId>
    <State>sample string 18</State>
    <SubCity>sample string 17</SubCity>
    <TIN>sample string 9</TIN>
  </Outlet>
  <OutletERPId>sample string 8</OutletERPId>
  <OutletName>sample string 7</OutletName>
  <Productive>true</Productive>
  <RemarksDistributor>sample string 13</RemarksDistributor>
  <RemarksManagement>sample string 12</RemarksManagement>
  <RemarksOther>sample string 14</RemarksOther>
  <RouteErpId>sample string 21</RouteErpId>
  <Sales>
    <NewDetailedSale>
      <AlternateCategory>sample string 10</AlternateCategory>
      <Discount_Product>1.1</Discount_Product>
      <DistributorErpId>sample string 11</DistributorErpId>
      <DistributorType>sample string 12</DistributorType>
      <Material>sample string 4</Material>
      <OrderType>sample string 6</OrderType>
      <OriginalPTR>1.1</OriginalPTR>
      <Price>1.1</Price>
      <ProductERPId>sample string 1</ProductERPId>
      <ProductName>sample string 2</ProductName>
      <ProductUnit>sample string 13</ProductUnit>
      <Quantity>5.1</Quantity>
      <SchemeCashDiscount>7</SchemeCashDiscount>
      <SchemeQuantity>8.1</SchemeQuantity>
      <SuggestiveQuantity>1.1</SuggestiveQuantity>
      <Variant>sample string 3</Variant>
      <VisitId>9</VisitId>
    </NewDetailedSale>
    <NewDetailedSale>
      <AlternateCategory>sample string 10</AlternateCategory>
      <Discount_Product>1.1</Discount_Product>
      <DistributorErpId>sample string 11</DistributorErpId>
      <DistributorType>sample string 12</DistributorType>
      <Material>sample string 4</Material>
      <OrderType>sample string 6</OrderType>
      <OriginalPTR>1.1</OriginalPTR>
      <Price>1.1</Price>
      <ProductERPId>sample string 1</ProductERPId>
      <ProductName>sample string 2</ProductName>
      <ProductUnit>sample string 13</ProductUnit>
      <Quantity>5.1</Quantity>
      <SchemeCashDiscount>7</SchemeCashDiscount>
      <SchemeQuantity>8.1</SchemeQuantity>
      <SuggestiveQuantity>1.1</SuggestiveQuantity>
      <Variant>sample string 3</Variant>
      <VisitId>9</VisitId>
    </NewDetailedSale>
  </Sales>
  <SyncTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-06T09:11:03.4501667Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </SyncTime>
  <Time xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-06T09:11:03.4501667Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </Time>
  <Valid>true</Valid>
  <VisitGuid>cb53d798-e74e-4f95-813a-46daba3ffbe4</VisitGuid>
  <VisitId>2</VisitId>
</NewVisit>