POST api/sales/GetBranchCanceledResidentialPCSales

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
branchCode	string	None.
yearMonth	string	None.
user	string	None.
deviceID	string	None.
ticketID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "branchCode": "sample string 1",
  "yearMonth": "sample string 2",
  "user": "sample string 3",
  "deviceID": "sample string 4",
  "ticketID": "sample string 5"
}

application/xml, text/xml

Sample:

<BranchMetricsParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <branchCode>sample string 1</branchCode>
  <deviceID>sample string 4</deviceID>
  <ticketID>sample string 5</ticketID>
  <user>sample string 3</user>
  <yearMonth>sample string 2</yearMonth>
</BranchMetricsParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CancelsActivityModel

Name	Type	Additional information
CancelItems	Collection of CancelsFinalItem	None.
CancelRequestItems	Collection of CancelsFinalItem	None.
CancelPendingItems	Collection of CancelsFinalItem	None.
ReturnMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CancelItems": [
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "SalesAgreementType": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "CustomerPhone1": "sample string 6",
      "CustomerPhone1DNC": "sample string 7",
      "CustomerPhone2": "sample string 8",
      "CustomerPhone2DNC": "sample string 9",
      "CustomerAddress": "sample string 10",
      "CustomerCity": "sample string 11",
      "CustomerState": "sample string 12",
      "CustomerZip": "sample string 13",
      "ServiceLine": "sample string 14",
      "SAEffectiveDate": 15,
      "SAActEffectiveDate": 16,
      "SAAmount": 17.0,
      "EmployeeCode": "sample string 18",
      "EmployeeName": "sample string 19",
      "CancelReason": "sample string 20",
      "CancelDate": "sample string 21",
      "CancelRequestDate": "sample string 22",
      "CancelRequestReason": "sample string 23",
      "DeliquentBalanceAmount": 24.0,
      "FinHoldStatus": "sample string 25",
      "DelinquentAge": "sample string 26",
      "ARBalanceAmount": 27.0,
      "TechRouteNumber": "sample string 28"
    },
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "SalesAgreementType": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "CustomerPhone1": "sample string 6",
      "CustomerPhone1DNC": "sample string 7",
      "CustomerPhone2": "sample string 8",
      "CustomerPhone2DNC": "sample string 9",
      "CustomerAddress": "sample string 10",
      "CustomerCity": "sample string 11",
      "CustomerState": "sample string 12",
      "CustomerZip": "sample string 13",
      "ServiceLine": "sample string 14",
      "SAEffectiveDate": 15,
      "SAActEffectiveDate": 16,
      "SAAmount": 17.0,
      "EmployeeCode": "sample string 18",
      "EmployeeName": "sample string 19",
      "CancelReason": "sample string 20",
      "CancelDate": "sample string 21",
      "CancelRequestDate": "sample string 22",
      "CancelRequestReason": "sample string 23",
      "DeliquentBalanceAmount": 24.0,
      "FinHoldStatus": "sample string 25",
      "DelinquentAge": "sample string 26",
      "ARBalanceAmount": 27.0,
      "TechRouteNumber": "sample string 28"
    }
  ],
  "CancelRequestItems": [
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "SalesAgreementType": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "CustomerPhone1": "sample string 6",
      "CustomerPhone1DNC": "sample string 7",
      "CustomerPhone2": "sample string 8",
      "CustomerPhone2DNC": "sample string 9",
      "CustomerAddress": "sample string 10",
      "CustomerCity": "sample string 11",
      "CustomerState": "sample string 12",
      "CustomerZip": "sample string 13",
      "ServiceLine": "sample string 14",
      "SAEffectiveDate": 15,
      "SAActEffectiveDate": 16,
      "SAAmount": 17.0,
      "EmployeeCode": "sample string 18",
      "EmployeeName": "sample string 19",
      "CancelReason": "sample string 20",
      "CancelDate": "sample string 21",
      "CancelRequestDate": "sample string 22",
      "CancelRequestReason": "sample string 23",
      "DeliquentBalanceAmount": 24.0,
      "FinHoldStatus": "sample string 25",
      "DelinquentAge": "sample string 26",
      "ARBalanceAmount": 27.0,
      "TechRouteNumber": "sample string 28"
    },
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "SalesAgreementType": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "CustomerPhone1": "sample string 6",
      "CustomerPhone1DNC": "sample string 7",
      "CustomerPhone2": "sample string 8",
      "CustomerPhone2DNC": "sample string 9",
      "CustomerAddress": "sample string 10",
      "CustomerCity": "sample string 11",
      "CustomerState": "sample string 12",
      "CustomerZip": "sample string 13",
      "ServiceLine": "sample string 14",
      "SAEffectiveDate": 15,
      "SAActEffectiveDate": 16,
      "SAAmount": 17.0,
      "EmployeeCode": "sample string 18",
      "EmployeeName": "sample string 19",
      "CancelReason": "sample string 20",
      "CancelDate": "sample string 21",
      "CancelRequestDate": "sample string 22",
      "CancelRequestReason": "sample string 23",
      "DeliquentBalanceAmount": 24.0,
      "FinHoldStatus": "sample string 25",
      "DelinquentAge": "sample string 26",
      "ARBalanceAmount": 27.0,
      "TechRouteNumber": "sample string 28"
    }
  ],
  "CancelPendingItems": [
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "SalesAgreementType": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "CustomerPhone1": "sample string 6",
      "CustomerPhone1DNC": "sample string 7",
      "CustomerPhone2": "sample string 8",
      "CustomerPhone2DNC": "sample string 9",
      "CustomerAddress": "sample string 10",
      "CustomerCity": "sample string 11",
      "CustomerState": "sample string 12",
      "CustomerZip": "sample string 13",
      "ServiceLine": "sample string 14",
      "SAEffectiveDate": 15,
      "SAActEffectiveDate": 16,
      "SAAmount": 17.0,
      "EmployeeCode": "sample string 18",
      "EmployeeName": "sample string 19",
      "CancelReason": "sample string 20",
      "CancelDate": "sample string 21",
      "CancelRequestDate": "sample string 22",
      "CancelRequestReason": "sample string 23",
      "DeliquentBalanceAmount": 24.0,
      "FinHoldStatus": "sample string 25",
      "DelinquentAge": "sample string 26",
      "ARBalanceAmount": 27.0,
      "TechRouteNumber": "sample string 28"
    },
    {
      "BranchCode": "sample string 1",
      "SalesAgreementNumber": "sample string 2",
      "SalesAgreementType": "sample string 3",
      "CustomerNumber": "sample string 4",
      "CustomerName": "sample string 5",
      "CustomerPhone1": "sample string 6",
      "CustomerPhone1DNC": "sample string 7",
      "CustomerPhone2": "sample string 8",
      "CustomerPhone2DNC": "sample string 9",
      "CustomerAddress": "sample string 10",
      "CustomerCity": "sample string 11",
      "CustomerState": "sample string 12",
      "CustomerZip": "sample string 13",
      "ServiceLine": "sample string 14",
      "SAEffectiveDate": 15,
      "SAActEffectiveDate": 16,
      "SAAmount": 17.0,
      "EmployeeCode": "sample string 18",
      "EmployeeName": "sample string 19",
      "CancelReason": "sample string 20",
      "CancelDate": "sample string 21",
      "CancelRequestDate": "sample string 22",
      "CancelRequestReason": "sample string 23",
      "DeliquentBalanceAmount": 24.0,
      "FinHoldStatus": "sample string 25",
      "DelinquentAge": "sample string 26",
      "ARBalanceAmount": 27.0,
      "TechRouteNumber": "sample string 28"
    }
  ],
  "ReturnMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<CancelsActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMXWebAPI.Models">
  <CancelItems>
    <CancelsFinalItem>
      <ARBalanceAmount>27</ARBalanceAmount>
      <BranchCode>sample string 1</BranchCode>
      <CancelDate>sample string 21</CancelDate>
      <CancelReason>sample string 20</CancelReason>
      <CancelRequestDate>sample string 22</CancelRequestDate>
      <CancelRequestReason>sample string 23</CancelRequestReason>
      <CustomerAddress>sample string 10</CustomerAddress>
      <CustomerCity>sample string 11</CustomerCity>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <CustomerPhone1>sample string 6</CustomerPhone1>
      <CustomerPhone1DNC>sample string 7</CustomerPhone1DNC>
      <CustomerPhone2>sample string 8</CustomerPhone2>
      <CustomerPhone2DNC>sample string 9</CustomerPhone2DNC>
      <CustomerState>sample string 12</CustomerState>
      <CustomerZip>sample string 13</CustomerZip>
      <DelinquentAge>sample string 26</DelinquentAge>
      <DeliquentBalanceAmount>24</DeliquentBalanceAmount>
      <EmployeeCode>sample string 18</EmployeeCode>
      <EmployeeName>sample string 19</EmployeeName>
      <FinHoldStatus>sample string 25</FinHoldStatus>
      <SAActEffectiveDate>16</SAActEffectiveDate>
      <SAAmount>17</SAAmount>
      <SAEffectiveDate>15</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <SalesAgreementType>sample string 3</SalesAgreementType>
      <ServiceLine>sample string 14</ServiceLine>
      <TechRouteNumber>sample string 28</TechRouteNumber>
    </CancelsFinalItem>
    <CancelsFinalItem>
      <ARBalanceAmount>27</ARBalanceAmount>
      <BranchCode>sample string 1</BranchCode>
      <CancelDate>sample string 21</CancelDate>
      <CancelReason>sample string 20</CancelReason>
      <CancelRequestDate>sample string 22</CancelRequestDate>
      <CancelRequestReason>sample string 23</CancelRequestReason>
      <CustomerAddress>sample string 10</CustomerAddress>
      <CustomerCity>sample string 11</CustomerCity>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <CustomerPhone1>sample string 6</CustomerPhone1>
      <CustomerPhone1DNC>sample string 7</CustomerPhone1DNC>
      <CustomerPhone2>sample string 8</CustomerPhone2>
      <CustomerPhone2DNC>sample string 9</CustomerPhone2DNC>
      <CustomerState>sample string 12</CustomerState>
      <CustomerZip>sample string 13</CustomerZip>
      <DelinquentAge>sample string 26</DelinquentAge>
      <DeliquentBalanceAmount>24</DeliquentBalanceAmount>
      <EmployeeCode>sample string 18</EmployeeCode>
      <EmployeeName>sample string 19</EmployeeName>
      <FinHoldStatus>sample string 25</FinHoldStatus>
      <SAActEffectiveDate>16</SAActEffectiveDate>
      <SAAmount>17</SAAmount>
      <SAEffectiveDate>15</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <SalesAgreementType>sample string 3</SalesAgreementType>
      <ServiceLine>sample string 14</ServiceLine>
      <TechRouteNumber>sample string 28</TechRouteNumber>
    </CancelsFinalItem>
  </CancelItems>
  <CancelPendingItems>
    <CancelsFinalItem>
      <ARBalanceAmount>27</ARBalanceAmount>
      <BranchCode>sample string 1</BranchCode>
      <CancelDate>sample string 21</CancelDate>
      <CancelReason>sample string 20</CancelReason>
      <CancelRequestDate>sample string 22</CancelRequestDate>
      <CancelRequestReason>sample string 23</CancelRequestReason>
      <CustomerAddress>sample string 10</CustomerAddress>
      <CustomerCity>sample string 11</CustomerCity>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <CustomerPhone1>sample string 6</CustomerPhone1>
      <CustomerPhone1DNC>sample string 7</CustomerPhone1DNC>
      <CustomerPhone2>sample string 8</CustomerPhone2>
      <CustomerPhone2DNC>sample string 9</CustomerPhone2DNC>
      <CustomerState>sample string 12</CustomerState>
      <CustomerZip>sample string 13</CustomerZip>
      <DelinquentAge>sample string 26</DelinquentAge>
      <DeliquentBalanceAmount>24</DeliquentBalanceAmount>
      <EmployeeCode>sample string 18</EmployeeCode>
      <EmployeeName>sample string 19</EmployeeName>
      <FinHoldStatus>sample string 25</FinHoldStatus>
      <SAActEffectiveDate>16</SAActEffectiveDate>
      <SAAmount>17</SAAmount>
      <SAEffectiveDate>15</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <SalesAgreementType>sample string 3</SalesAgreementType>
      <ServiceLine>sample string 14</ServiceLine>
      <TechRouteNumber>sample string 28</TechRouteNumber>
    </CancelsFinalItem>
    <CancelsFinalItem>
      <ARBalanceAmount>27</ARBalanceAmount>
      <BranchCode>sample string 1</BranchCode>
      <CancelDate>sample string 21</CancelDate>
      <CancelReason>sample string 20</CancelReason>
      <CancelRequestDate>sample string 22</CancelRequestDate>
      <CancelRequestReason>sample string 23</CancelRequestReason>
      <CustomerAddress>sample string 10</CustomerAddress>
      <CustomerCity>sample string 11</CustomerCity>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <CustomerPhone1>sample string 6</CustomerPhone1>
      <CustomerPhone1DNC>sample string 7</CustomerPhone1DNC>
      <CustomerPhone2>sample string 8</CustomerPhone2>
      <CustomerPhone2DNC>sample string 9</CustomerPhone2DNC>
      <CustomerState>sample string 12</CustomerState>
      <CustomerZip>sample string 13</CustomerZip>
      <DelinquentAge>sample string 26</DelinquentAge>
      <DeliquentBalanceAmount>24</DeliquentBalanceAmount>
      <EmployeeCode>sample string 18</EmployeeCode>
      <EmployeeName>sample string 19</EmployeeName>
      <FinHoldStatus>sample string 25</FinHoldStatus>
      <SAActEffectiveDate>16</SAActEffectiveDate>
      <SAAmount>17</SAAmount>
      <SAEffectiveDate>15</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <SalesAgreementType>sample string 3</SalesAgreementType>
      <ServiceLine>sample string 14</ServiceLine>
      <TechRouteNumber>sample string 28</TechRouteNumber>
    </CancelsFinalItem>
  </CancelPendingItems>
  <CancelRequestItems>
    <CancelsFinalItem>
      <ARBalanceAmount>27</ARBalanceAmount>
      <BranchCode>sample string 1</BranchCode>
      <CancelDate>sample string 21</CancelDate>
      <CancelReason>sample string 20</CancelReason>
      <CancelRequestDate>sample string 22</CancelRequestDate>
      <CancelRequestReason>sample string 23</CancelRequestReason>
      <CustomerAddress>sample string 10</CustomerAddress>
      <CustomerCity>sample string 11</CustomerCity>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <CustomerPhone1>sample string 6</CustomerPhone1>
      <CustomerPhone1DNC>sample string 7</CustomerPhone1DNC>
      <CustomerPhone2>sample string 8</CustomerPhone2>
      <CustomerPhone2DNC>sample string 9</CustomerPhone2DNC>
      <CustomerState>sample string 12</CustomerState>
      <CustomerZip>sample string 13</CustomerZip>
      <DelinquentAge>sample string 26</DelinquentAge>
      <DeliquentBalanceAmount>24</DeliquentBalanceAmount>
      <EmployeeCode>sample string 18</EmployeeCode>
      <EmployeeName>sample string 19</EmployeeName>
      <FinHoldStatus>sample string 25</FinHoldStatus>
      <SAActEffectiveDate>16</SAActEffectiveDate>
      <SAAmount>17</SAAmount>
      <SAEffectiveDate>15</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <SalesAgreementType>sample string 3</SalesAgreementType>
      <ServiceLine>sample string 14</ServiceLine>
      <TechRouteNumber>sample string 28</TechRouteNumber>
    </CancelsFinalItem>
    <CancelsFinalItem>
      <ARBalanceAmount>27</ARBalanceAmount>
      <BranchCode>sample string 1</BranchCode>
      <CancelDate>sample string 21</CancelDate>
      <CancelReason>sample string 20</CancelReason>
      <CancelRequestDate>sample string 22</CancelRequestDate>
      <CancelRequestReason>sample string 23</CancelRequestReason>
      <CustomerAddress>sample string 10</CustomerAddress>
      <CustomerCity>sample string 11</CustomerCity>
      <CustomerName>sample string 5</CustomerName>
      <CustomerNumber>sample string 4</CustomerNumber>
      <CustomerPhone1>sample string 6</CustomerPhone1>
      <CustomerPhone1DNC>sample string 7</CustomerPhone1DNC>
      <CustomerPhone2>sample string 8</CustomerPhone2>
      <CustomerPhone2DNC>sample string 9</CustomerPhone2DNC>
      <CustomerState>sample string 12</CustomerState>
      <CustomerZip>sample string 13</CustomerZip>
      <DelinquentAge>sample string 26</DelinquentAge>
      <DeliquentBalanceAmount>24</DeliquentBalanceAmount>
      <EmployeeCode>sample string 18</EmployeeCode>
      <EmployeeName>sample string 19</EmployeeName>
      <FinHoldStatus>sample string 25</FinHoldStatus>
      <SAActEffectiveDate>16</SAActEffectiveDate>
      <SAAmount>17</SAAmount>
      <SAEffectiveDate>15</SAEffectiveDate>
      <SalesAgreementNumber>sample string 2</SalesAgreementNumber>
      <SalesAgreementType>sample string 3</SalesAgreementType>
      <ServiceLine>sample string 14</ServiceLine>
      <TechRouteNumber>sample string 28</TechRouteNumber>
    </CancelsFinalItem>
  </CancelRequestItems>
  <ReturnMessage>sample string 1</ReturnMessage>
</CancelsActivityModel>