GET v1/Policies/{policyId}/Contacts/{contactId}/Billing/CompanyPremium?numDaysPrior={numDaysPrior}

Gets Company Premium Billing Information for a policy

Request Information

URI Parameters

NameDescriptionTypeAdditional information
policyId

The Id of the policy

integer

Required

contactId

The Id of the contact

integer

Required

numDaysPrior

Optional: number of days prior to today

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BillingScreenTransactionDTO
NameDescriptionTypeAdditional information
RecordID

globally unique identifier

None.

IsPayment

boolean

None.

IsCredit

boolean

None.

DBCD

boolean

None.

TransactionDate

string

None.

DueDate

string

None.

Description

string

None.

PolicyNumber

string

None.

IsVoided

boolean

None.

Amount

decimal number

None.

PdfId

integer

None.

SyncStatus

integer

None.

Due

string

None.

Paid

string

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "RecordID": "b0fc8ca5-5099-49b9-bd9d-dca4d8a7046e",
    "IsPayment": true,
    "IsCredit": true,
    "DBCD": true,
    "TransactionDate": "sample string 5",
    "DueDate": "sample string 6",
    "Description": "sample string 7",
    "PolicyNumber": "sample string 8",
    "IsVoided": true,
    "Amount": 10.0,
    "PdfId": 1,
    "SyncStatus": 11,
    "Due": "sample string 12",
    "Paid": "sample string 13",
    "ErrorMessage": "sample string 14"
  },
  {
    "RecordID": "b0fc8ca5-5099-49b9-bd9d-dca4d8a7046e",
    "IsPayment": true,
    "IsCredit": true,
    "DBCD": true,
    "TransactionDate": "sample string 5",
    "DueDate": "sample string 6",
    "Description": "sample string 7",
    "PolicyNumber": "sample string 8",
    "IsVoided": true,
    "Amount": 10.0,
    "PdfId": 1,
    "SyncStatus": 11,
    "Due": "sample string 12",
    "Paid": "sample string 13",
    "ErrorMessage": "sample string 14"
  }
]

application/xml, text/xml

Sample:
<ArrayOfBillingScreenTransactionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Finance">
  <BillingScreenTransactionDTO>
    <Amount>10</Amount>
    <DBCD>true</DBCD>
    <Description>sample string 7</Description>
    <Due>sample string 12</Due>
    <DueDate>sample string 6</DueDate>
    <ErrorMessage>sample string 14</ErrorMessage>
    <IsCredit>true</IsCredit>
    <IsPayment>true</IsPayment>
    <IsVoided>true</IsVoided>
    <Paid>sample string 13</Paid>
    <PdfId>1</PdfId>
    <PolicyNumber>sample string 8</PolicyNumber>
    <RecordID>b0fc8ca5-5099-49b9-bd9d-dca4d8a7046e</RecordID>
    <SyncStatus>11</SyncStatus>
    <TransactionDate>sample string 5</TransactionDate>
  </BillingScreenTransactionDTO>
  <BillingScreenTransactionDTO>
    <Amount>10</Amount>
    <DBCD>true</DBCD>
    <Description>sample string 7</Description>
    <Due>sample string 12</Due>
    <DueDate>sample string 6</DueDate>
    <ErrorMessage>sample string 14</ErrorMessage>
    <IsCredit>true</IsCredit>
    <IsPayment>true</IsPayment>
    <IsVoided>true</IsVoided>
    <Paid>sample string 13</Paid>
    <PdfId>1</PdfId>
    <PolicyNumber>sample string 8</PolicyNumber>
    <RecordID>b0fc8ca5-5099-49b9-bd9d-dca4d8a7046e</RecordID>
    <SyncStatus>11</SyncStatus>
    <TransactionDate>sample string 5</TransactionDate>
  </BillingScreenTransactionDTO>
</ArrayOfBillingScreenTransactionDTO>