GET v1/Payment/BillHistoryDetail/Id/{Id}

Retrieve Bill History Detail for a specific Bill History ID, needed to create an Invoice

Request Information

URI Parameters

Name	Description	Type	Additional information
Id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Retrieve Bill History Detail for a specific Bill History ID, needed to create an Invoice

BillHistoryDetailOutboundDTO

Name	Description	Type	Additional information
PolicyNumber		string	String length: inclusive between 0 and 30
EffectiveDateTime		date	None.
EffectiveDate		date	None.
ExpirationDate		date	None.
TransEffDate		date	None.
TermMonths		integer	None.
AmendmentId		integer	None.
AmendmentDescription		string	None.
AmendmentOutputDesc		string	None.
AmendmentText		string	None.
IssueDate		date	None.
UnderwritingCompanyName		string	None.
UnderwritingCompanyAddress		string	None.
UnderwritingCompanyCityStateZip		string	None.
UnderwritingCompanyPhoneNumber		string	None.
UnderwritingCompanyFaxNumber		string	None.
UnderwritingCompanyBulkMailingAddress		string	None.
UnderwritingCompanyMailingCityStateZip		string	None.
UnderwriterFirstName		string	None.
UnderwriterLastName		string	None.
CancellationDate		date	None.
RenewalPending		string	None.
NonRenewal		string	None.
BillPlanType		string	None.
ThirdPartyBilling		string	None.
InsuredCommercialName		string	None.
InsuredFirstName		string	None.
InsuredMiddleName		string	None.
InsuredLastName		string	None.
Address1		string	None.
Address2		string	None.
City		string	None.
StateCode		string	None.
Zipcode1		string	None.
Zipcode2		string	None.
Phone1		string	None.
Phone2		string	None.
Email		string	None.
RiskAddress1		string	None.
RiskAddress2		string	None.
RiskCity		string	None.
RiskStateCode		string	None.
RiskZipcode		string	None.
RiskCityStZip		string	None.
AgencyCommercialName		string	None.
AgencyAddress1		string	None.
AgencyAddress2		string	None.
AgencyCity		string	None.
AgencyStateCode		string	None.
AgencyZipcode1		string	None.
AgencyZipcode2		string	None.
AgencyPhone1		string	None.
AgencyPhone2		string	None.
AgencyPhone3		string	None.
AgencyPhone4		string	None.
AgencyEmail		string	None.
AgentFirstName		string	None.
AgentLastName		string	None.
AgentAddress1		string	None.
AgentAddress2		string	None.
AgentCity		string	None.
AgentStateCode		string	None.
AgentZipcode1		string	None.
AgentZipcode2		string	None.
AgentPhone1		string	None.
AgentPhone2		string	None.
AgentPhone3		string	None.
AgentPhone4		string	None.
AgentEmail		string	None.
AgentTIN		string	None.
BillType		string	None.
FullAmountDue		decimal number	None.
MinimumAmountDue		decimal number	None.
TotalBalance		decimal number	None.
OffsetAmount		decimal number	None.
AmountDue		decimal number	None.
DueDate		date	None.
PaymentMethod		string	None.
AutopayFlag		string	None.
AccountNumber		string	None.
BankName		string	None.
TransitCode		string	None.
PreviousBalance		decimal number	None.
Premium		decimal number	None.
PremiumAdjustment		decimal number	None.
PolicyFee		decimal number	None.
UWFee		decimal number	None.
InstallmentFee		decimal number	None.
OtherBillingFee		decimal number	None.
PaymentActivity		decimal number	None.
BillingAdjustment		decimal number	None.
NumberOfInstallments		integer	None.
DeductionDate		date	None.
NextPostalDate		date	None.
BillingCycle		string	None.
SystemDate		date	None.
PayorType		string	None.
ScanLine		string	None.
Installments		Collection of BillHistoryDetailInstallmentDTO	None.
CancelDueDate		date	None.
CancelAmountDue		decimal number	None.
LoanNumber		string	None.
MortgageeName		string	None.
MortgageeAddress1		string	None.
MortgageeAddress2		string	None.
MortgageeCity		string	None.
MortgageeState		string	None.
MortgageeZipcode1		string	None.
MortgageeZipcode2		string	None.
PolicyType		string	None.
InstallmentFeeToCharge		decimal number	None.
Id	Primary Id	integer	None.
WarningMessages	List of warning messages encountered while servicing request	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "PolicyNumber": "sample string 1",
  "EffectiveDateTime": "2025-05-09T06:23:41.6681996-10:00",
  "EffectiveDate": "2025-05-09T06:23:41.6681996-10:00",
  "ExpirationDate": "2025-05-09T06:23:41.6681996-10:00",
  "TransEffDate": "2025-05-09T06:23:41.6681996-10:00",
  "TermMonths": 1,
  "AmendmentId": 1,
  "AmendmentDescription": "sample string 2",
  "AmendmentOutputDesc": "sample string 3",
  "AmendmentText": "sample string 4",
  "IssueDate": "2025-05-09T06:23:41.6681996-10:00",
  "UnderwritingCompanyName": "sample string 5",
  "UnderwritingCompanyAddress": "sample string 6",
  "UnderwritingCompanyCityStateZip": "sample string 7",
  "UnderwritingCompanyPhoneNumber": "sample string 8",
  "UnderwritingCompanyFaxNumber": "sample string 9",
  "UnderwritingCompanyBulkMailingAddress": "sample string 10",
  "UnderwritingCompanyMailingCityStateZip": "sample string 11",
  "UnderwriterFirstName": "sample string 12",
  "UnderwriterLastName": "sample string 13",
  "CancellationDate": "2025-05-09T06:23:41.6681996-10:00",
  "RenewalPending": "sample string 14",
  "NonRenewal": "sample string 15",
  "BillPlanType": "sample string 16",
  "ThirdPartyBilling": "sample string 17",
  "InsuredCommercialName": "sample string 18",
  "InsuredFirstName": "sample string 19",
  "InsuredMiddleName": "sample string 20",
  "InsuredLastName": "sample string 21",
  "Address1": "sample string 22",
  "Address2": "sample string 23",
  "City": "sample string 24",
  "StateCode": "sample string 25",
  "Zipcode1": "sample string 26",
  "Zipcode2": "sample string 27",
  "Phone1": "sample string 28",
  "Phone2": "sample string 29",
  "Email": "sample string 30",
  "RiskAddress1": "sample string 31",
  "RiskAddress2": "sample string 32",
  "RiskCity": "sample string 33",
  "RiskStateCode": "sample string 34",
  "RiskZipcode": "sample string 35",
  "RiskCityStZip": "sample string 36",
  "AgencyCommercialName": "sample string 37",
  "AgencyAddress1": "sample string 38",
  "AgencyAddress2": "sample string 39",
  "AgencyCity": "sample string 40",
  "AgencyStateCode": "sample string 41",
  "AgencyZipcode1": "sample string 42",
  "AgencyZipcode2": "sample string 43",
  "AgencyPhone1": "sample string 44",
  "AgencyPhone2": "sample string 45",
  "AgencyPhone3": "sample string 46",
  "AgencyPhone4": "sample string 47",
  "AgencyEmail": "sample string 48",
  "AgentFirstName": "sample string 49",
  "AgentLastName": "sample string 50",
  "AgentAddress1": "sample string 51",
  "AgentAddress2": "sample string 52",
  "AgentCity": "sample string 53",
  "AgentStateCode": "sample string 54",
  "AgentZipcode1": "sample string 55",
  "AgentZipcode2": "sample string 56",
  "AgentPhone1": "sample string 57",
  "AgentPhone2": "sample string 58",
  "AgentPhone3": "sample string 59",
  "AgentPhone4": "sample string 60",
  "AgentEmail": "sample string 61",
  "AgentTIN": "sample string 62",
  "BillType": "sample string 63",
  "FullAmountDue": 1.0,
  "MinimumAmountDue": 1.0,
  "TotalBalance": 64.0,
  "OffsetAmount": 65.0,
  "AmountDue": 66.0,
  "DueDate": "2025-05-09T06:23:41.6681996-10:00",
  "PaymentMethod": "sample string 67",
  "AutopayFlag": "sample string 68",
  "AccountNumber": "sample string 69",
  "BankName": "sample string 70",
  "TransitCode": "sample string 71",
  "PreviousBalance": 1.0,
  "Premium": 1.0,
  "PremiumAdjustment": 1.0,
  "PolicyFee": 1.0,
  "UWFee": 1.0,
  "InstallmentFee": 1.0,
  "OtherBillingFee": 1.0,
  "PaymentActivity": 1.0,
  "BillingAdjustment": 1.0,
  "NumberOfInstallments": 1,
  "DeductionDate": "2025-05-09T06:23:41.6732068-10:00",
  "NextPostalDate": "2025-05-09T06:23:41.6732068-10:00",
  "BillingCycle": "sample string 72",
  "SystemDate": "2025-05-09T06:23:41.6732068-10:00",
  "PayorType": "sample string 73",
  "ScanLine": "sample string 74",
  "Installments": [
    {
      "<InstallmentNumber>k__BackingField": 1,
      "<DueDate>k__BackingField": "2025-05-09T06:23:41.6732068-10:00",
      "<AmountDue>k__BackingField": 1.0,
      "<Balance>k__BackingField": 1.0,
      "<InstallmentFee>k__BackingField": 1.0
    },
    {
      "<InstallmentNumber>k__BackingField": 1,
      "<DueDate>k__BackingField": "2025-05-09T06:23:41.6732068-10:00",
      "<AmountDue>k__BackingField": 1.0,
      "<Balance>k__BackingField": 1.0,
      "<InstallmentFee>k__BackingField": 1.0
    }
  ],
  "CancelDueDate": "2025-05-09T06:23:41.6732068-10:00",
  "CancelAmountDue": 1.0,
  "LoanNumber": "sample string 75",
  "MortgageeName": "sample string 76",
  "MortgageeAddress1": "sample string 77",
  "MortgageeAddress2": "sample string 78",
  "MortgageeCity": "sample string 79",
  "MortgageeState": "sample string 80",
  "MortgageeZipcode1": "sample string 81",
  "MortgageeZipcode2": "sample string 82",
  "PolicyType": "sample string 83",
  "InstallmentFeeToCharge": 1.0,
  "Id": 84
}

application/xml, text/xml

Sample:

<BillHistoryDetailOutboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Outbound">
  <Id>84</Id>
  <AccountNumber>sample string 69</AccountNumber>
  <Address1>sample string 22</Address1>
  <Address2>sample string 23</Address2>
  <AgencyAddress1>sample string 38</AgencyAddress1>
  <AgencyAddress2>sample string 39</AgencyAddress2>
  <AgencyCity>sample string 40</AgencyCity>
  <AgencyCommercialName>sample string 37</AgencyCommercialName>
  <AgencyEmail>sample string 48</AgencyEmail>
  <AgencyPhone1>sample string 44</AgencyPhone1>
  <AgencyPhone2>sample string 45</AgencyPhone2>
  <AgencyPhone3>sample string 46</AgencyPhone3>
  <AgencyPhone4>sample string 47</AgencyPhone4>
  <AgencyStateCode>sample string 41</AgencyStateCode>
  <AgencyZipcode1>sample string 42</AgencyZipcode1>
  <AgencyZipcode2>sample string 43</AgencyZipcode2>
  <AgentAddress1>sample string 51</AgentAddress1>
  <AgentAddress2>sample string 52</AgentAddress2>
  <AgentCity>sample string 53</AgentCity>
  <AgentEmail>sample string 61</AgentEmail>
  <AgentFirstName>sample string 49</AgentFirstName>
  <AgentLastName>sample string 50</AgentLastName>
  <AgentPhone1>sample string 57</AgentPhone1>
  <AgentPhone2>sample string 58</AgentPhone2>
  <AgentPhone3>sample string 59</AgentPhone3>
  <AgentPhone4>sample string 60</AgentPhone4>
  <AgentStateCode>sample string 54</AgentStateCode>
  <AgentTIN>sample string 62</AgentTIN>
  <AgentZipcode1>sample string 55</AgentZipcode1>
  <AgentZipcode2>sample string 56</AgentZipcode2>
  <AmendmentDescription>sample string 2</AmendmentDescription>
  <AmendmentId>1</AmendmentId>
  <AmendmentOutputDesc>sample string 3</AmendmentOutputDesc>
  <AmendmentText>sample string 4</AmendmentText>
  <AmountDue>66</AmountDue>
  <AutopayFlag>sample string 68</AutopayFlag>
  <BankName>sample string 70</BankName>
  <BillPlanType>sample string 16</BillPlanType>
  <BillType>sample string 63</BillType>
  <BillingAdjustment>1</BillingAdjustment>
  <BillingCycle>sample string 72</BillingCycle>
  <CancelAmountDue>1</CancelAmountDue>
  <CancelDueDate>2025-05-09T06:23:41.6732068-10:00</CancelDueDate>
  <CancellationDate>2025-05-09T06:23:41.6681996-10:00</CancellationDate>
  <City>sample string 24</City>
  <DeductionDate>2025-05-09T06:23:41.6732068-10:00</DeductionDate>
  <DueDate>2025-05-09T06:23:41.6681996-10:00</DueDate>
  <EffectiveDate>2025-05-09T06:23:41.6681996-10:00</EffectiveDate>
  <EffectiveDateTime>2025-05-09T06:23:41.6681996-10:00</EffectiveDateTime>
  <Email>sample string 30</Email>
  <ExpirationDate>2025-05-09T06:23:41.6681996-10:00</ExpirationDate>
  <FullAmountDue>1</FullAmountDue>
  <InstallmentFee>1</InstallmentFee>
  <InstallmentFeeToCharge>1</InstallmentFeeToCharge>
  <Installments xmlns:d2p1="http://schemas.datacontract.org/2004/07/DRC.DecisionMaker.DMII.CustomTypes">
    <d2p1:BillHistoryDetailInstallmentDTO>
      <d2p1:_x003C_AmountDue_x003E_k__BackingField>1</d2p1:_x003C_AmountDue_x003E_k__BackingField>
      <d2p1:_x003C_Balance_x003E_k__BackingField>1</d2p1:_x003C_Balance_x003E_k__BackingField>
      <d2p1:_x003C_DueDate_x003E_k__BackingField>2025-05-09T06:23:41.6732068-10:00</d2p1:_x003C_DueDate_x003E_k__BackingField>
      <d2p1:_x003C_InstallmentFee_x003E_k__BackingField>1</d2p1:_x003C_InstallmentFee_x003E_k__BackingField>
      <d2p1:_x003C_InstallmentNumber_x003E_k__BackingField>1</d2p1:_x003C_InstallmentNumber_x003E_k__BackingField>
    </d2p1:BillHistoryDetailInstallmentDTO>
    <d2p1:BillHistoryDetailInstallmentDTO>
      <d2p1:_x003C_AmountDue_x003E_k__BackingField>1</d2p1:_x003C_AmountDue_x003E_k__BackingField>
      <d2p1:_x003C_Balance_x003E_k__BackingField>1</d2p1:_x003C_Balance_x003E_k__BackingField>
      <d2p1:_x003C_DueDate_x003E_k__BackingField>2025-05-09T06:23:41.6732068-10:00</d2p1:_x003C_DueDate_x003E_k__BackingField>
      <d2p1:_x003C_InstallmentFee_x003E_k__BackingField>1</d2p1:_x003C_InstallmentFee_x003E_k__BackingField>
      <d2p1:_x003C_InstallmentNumber_x003E_k__BackingField>1</d2p1:_x003C_InstallmentNumber_x003E_k__BackingField>
    </d2p1:BillHistoryDetailInstallmentDTO>
  </Installments>
  <InsuredCommercialName>sample string 18</InsuredCommercialName>
  <InsuredFirstName>sample string 19</InsuredFirstName>
  <InsuredLastName>sample string 21</InsuredLastName>
  <InsuredMiddleName>sample string 20</InsuredMiddleName>
  <IssueDate>2025-05-09T06:23:41.6681996-10:00</IssueDate>
  <LoanNumber>sample string 75</LoanNumber>
  <MinimumAmountDue>1</MinimumAmountDue>
  <MortgageeAddress1>sample string 77</MortgageeAddress1>
  <MortgageeAddress2>sample string 78</MortgageeAddress2>
  <MortgageeCity>sample string 79</MortgageeCity>
  <MortgageeName>sample string 76</MortgageeName>
  <MortgageeState>sample string 80</MortgageeState>
  <MortgageeZipcode1>sample string 81</MortgageeZipcode1>
  <MortgageeZipcode2>sample string 82</MortgageeZipcode2>
  <NextPostalDate>2025-05-09T06:23:41.6732068-10:00</NextPostalDate>
  <NonRenewal>sample string 15</NonRenewal>
  <NumberOfInstallments>1</NumberOfInstallments>
  <OffsetAmount>65</OffsetAmount>
  <OtherBillingFee>1</OtherBillingFee>
  <PaymentActivity>1</PaymentActivity>
  <PaymentMethod>sample string 67</PaymentMethod>
  <PayorType>sample string 73</PayorType>
  <Phone1>sample string 28</Phone1>
  <Phone2>sample string 29</Phone2>
  <PolicyFee>1</PolicyFee>
  <PolicyNumber>sample string 1</PolicyNumber>
  <PolicyType>sample string 83</PolicyType>
  <Premium>1</Premium>
  <PremiumAdjustment>1</PremiumAdjustment>
  <PreviousBalance>1</PreviousBalance>
  <RenewalPending>sample string 14</RenewalPending>
  <RiskAddress1>sample string 31</RiskAddress1>
  <RiskAddress2>sample string 32</RiskAddress2>
  <RiskCity>sample string 33</RiskCity>
  <RiskCityStZip>sample string 36</RiskCityStZip>
  <RiskStateCode>sample string 34</RiskStateCode>
  <RiskZipcode>sample string 35</RiskZipcode>
  <ScanLine>sample string 74</ScanLine>
  <StateCode>sample string 25</StateCode>
  <SystemDate>2025-05-09T06:23:41.6732068-10:00</SystemDate>
  <TermMonths>1</TermMonths>
  <ThirdPartyBilling>sample string 17</ThirdPartyBilling>
  <TotalBalance>64</TotalBalance>
  <TransEffDate>2025-05-09T06:23:41.6681996-10:00</TransEffDate>
  <TransitCode>sample string 71</TransitCode>
  <UWFee>1</UWFee>
  <UnderwriterFirstName>sample string 12</UnderwriterFirstName>
  <UnderwriterLastName>sample string 13</UnderwriterLastName>
  <UnderwritingCompanyAddress>sample string 6</UnderwritingCompanyAddress>
  <UnderwritingCompanyBulkMailingAddress>sample string 10</UnderwritingCompanyBulkMailingAddress>
  <UnderwritingCompanyCityStateZip>sample string 7</UnderwritingCompanyCityStateZip>
  <UnderwritingCompanyFaxNumber>sample string 9</UnderwritingCompanyFaxNumber>
  <UnderwritingCompanyMailingCityStateZip>sample string 11</UnderwritingCompanyMailingCityStateZip>
  <UnderwritingCompanyName>sample string 5</UnderwritingCompanyName>
  <UnderwritingCompanyPhoneNumber>sample string 8</UnderwritingCompanyPhoneNumber>
  <Zipcode1>sample string 26</Zipcode1>
  <Zipcode2>sample string 27</Zipcode2>
</BillHistoryDetailOutboundDTO>