POST api/Customer/GetCustomerCrm?customerNumber={customerNumber}&repId={repId}&asOfDate={asOfDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNumber

string

Required

repId

string

Default value is

asOfDate

string

Default value is

Body Parameters

None.

Response Information

Resource Description

CustomerCrm
NameDescriptionTypeAdditional information
MtdSales

decimal number

None.

MtdSalesPrior

decimal number

None.

MtdCost

decimal number

None.

MtdCostPrior

decimal number

None.

MtdMargin

decimal number

None.

MtdMarginPrior

decimal number

None.

MtdMarginPct

decimal number

None.

MtdMarginPctPrior

decimal number

None.

MtdMarginPtsDelta

integer

None.

YtdSales

decimal number

None.

YtdSalesPrior

decimal number

None.

YtdCost

decimal number

None.

YtdCostPrior

decimal number

None.

YtdMargin

decimal number

None.

YtdMarginPrior

decimal number

None.

YtdMarginPct

decimal number

None.

YtdMarginPctPrior

decimal number

None.

YtdMarginPtsDelta

integer

None.

Growth12Mo

decimal number

None.

Growth12MoPrior

decimal number

None.

EopSales

decimal number

None.

EopSalesPrior

decimal number

None.

Top5Items

Collection of CrmRankRow

None.

Top5Vendors

Collection of CrmRankRow

None.

Response Formats

application/json, text/json

Sample:
{
  "MtdSales": 1.0,
  "MtdSalesPrior": 2.0,
  "MtdCost": 3.0,
  "MtdCostPrior": 4.0,
  "MtdMargin": 5.0,
  "MtdMarginPrior": 6.0,
  "MtdMarginPct": 7.0,
  "MtdMarginPctPrior": 8.0,
  "MtdMarginPtsDelta": 9,
  "YtdSales": 10.0,
  "YtdSalesPrior": 11.0,
  "YtdCost": 12.0,
  "YtdCostPrior": 13.0,
  "YtdMargin": 14.0,
  "YtdMarginPrior": 15.0,
  "YtdMarginPct": 16.0,
  "YtdMarginPctPrior": 17.0,
  "YtdMarginPtsDelta": 18,
  "Growth12Mo": 19.0,
  "Growth12MoPrior": 20.0,
  "EopSales": 21.0,
  "EopSalesPrior": 22.0,
  "Top5Items": [
    {
      "Key": "sample string 1",
      "Description": "sample string 2",
      "Sales": 3.0,
      "Pct": 4,
      "ItemCount": 5
    },
    {
      "Key": "sample string 1",
      "Description": "sample string 2",
      "Sales": 3.0,
      "Pct": 4,
      "ItemCount": 5
    }
  ],
  "Top5Vendors": [
    {
      "Key": "sample string 1",
      "Description": "sample string 2",
      "Sales": 3.0,
      "Pct": 4,
      "ItemCount": 5
    },
    {
      "Key": "sample string 1",
      "Description": "sample string 2",
      "Sales": 3.0,
      "Pct": 4,
      "ItemCount": 5
    }
  ]
}

application/xml, text/xml

Sample:
<CustomerCrm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
  <EopSales>21</EopSales>
  <EopSalesPrior>22</EopSalesPrior>
  <Growth12Mo>19</Growth12Mo>
  <Growth12MoPrior>20</Growth12MoPrior>
  <MtdCost>3</MtdCost>
  <MtdCostPrior>4</MtdCostPrior>
  <MtdMargin>5</MtdMargin>
  <MtdMarginPct>7</MtdMarginPct>
  <MtdMarginPctPrior>8</MtdMarginPctPrior>
  <MtdMarginPrior>6</MtdMarginPrior>
  <MtdMarginPtsDelta>9</MtdMarginPtsDelta>
  <MtdSales>1</MtdSales>
  <MtdSalesPrior>2</MtdSalesPrior>
  <Top5Items>
    <CrmRankRow>
      <Description>sample string 2</Description>
      <ItemCount>5</ItemCount>
      <Key>sample string 1</Key>
      <Pct>4</Pct>
      <Sales>3</Sales>
    </CrmRankRow>
    <CrmRankRow>
      <Description>sample string 2</Description>
      <ItemCount>5</ItemCount>
      <Key>sample string 1</Key>
      <Pct>4</Pct>
      <Sales>3</Sales>
    </CrmRankRow>
  </Top5Items>
  <Top5Vendors>
    <CrmRankRow>
      <Description>sample string 2</Description>
      <ItemCount>5</ItemCount>
      <Key>sample string 1</Key>
      <Pct>4</Pct>
      <Sales>3</Sales>
    </CrmRankRow>
    <CrmRankRow>
      <Description>sample string 2</Description>
      <ItemCount>5</ItemCount>
      <Key>sample string 1</Key>
      <Pct>4</Pct>
      <Sales>3</Sales>
    </CrmRankRow>
  </Top5Vendors>
  <YtdCost>12</YtdCost>
  <YtdCostPrior>13</YtdCostPrior>
  <YtdMargin>14</YtdMargin>
  <YtdMarginPct>16</YtdMarginPct>
  <YtdMarginPctPrior>17</YtdMarginPctPrior>
  <YtdMarginPrior>15</YtdMarginPrior>
  <YtdMarginPtsDelta>18</YtdMarginPtsDelta>
  <YtdSales>10</YtdSales>
  <YtdSalesPrior>11</YtdSalesPrior>
</CustomerCrm>