Bombshell Agency Platform Service

<back to all web services

CommissionRequest

The following routes are available for this service:
POST,PUT,OPTIONS/v1/Commission/
GET,OPTIONS/v1/Commission/{CommissionId}
GET,OPTIONS/v1/Commission/Batch/{CommissionBatchId}/{Carrier}
GET,OPTIONS/v1/Commission/Operation/{CommissionId}/{Action}
GET,OPTIONS/v1/Commission/Operation/{CommissionId}/{Action}/{AgentId}
GET,OPTIONS/v1/Commission/Operation/{CommissionId}/{Action}/{FieldName}/{FieldValue}
GET,OPTIONS/v1/Commission/Operation/ArchiveImport/{Action}/{Carrier}/{PolicyNumber}
GET,OPTIONS/v1/Commission/Operation/{CommissionId}/{Action}/{Premium}/{ChargebackOrPayoutAmount}/{CommissionRate}/{AdvanceRate}/{Part}
GET,OPTIONS/v1/Commission/Operation/CappedPayout/{Action}/{CappedPayout}/{AdvanceRate}/{CommissionId}

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/CommissionRequest HTTP/1.1 
Host: api2.exactmedicare.com 
Content-Type: application/xml
Content-Length: length

<CommissionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <Action>String</Action>
  <AdvanceRate>0</AdvanceRate>
  <AgentId>0</AgentId>
  <Carrier>String</Carrier>
  <ChargebackOrPayoutAmount>0</ChargebackOrPayoutAmount>
  <Commission>
    <CommissionRecord>
      <AdvanceRate>0</AdvanceRate>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <AgentNumber>String</AgentNumber>
      <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
      <CappedPayout>false</CappedPayout>
      <ChargebackAgent />
      <CommRate>0</CommRate>
      <CommissionBatchId>0</CommissionBatchId>
      <CommissionRecordId />
      <Company>String</Company>
      <ComponentsToProcess>String</ComponentsToProcess>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateProcessed>0001-01-01T00:00:00</DateProcessed>
      <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
      <GrossCommission>0</GrossCommission>
      <Id>0</Id>
      <InsuredAnnuitant>String</InsuredAnnuitant>
      <IsRenewal />
      <LastUpdatedUser>String</LastUpdatedUser>
      <LinkedId />
      <MID>String</MID>
      <Market>String</Market>
      <NumberOfCommissionListings>0</NumberOfCommissionListings>
      <Part>0</Part>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <Plan>String</Plan>
      <PlanType>String</PlanType>
      <PolicyNumber>String</PolicyNumber>
      <PolicyType>String</PolicyType>
      <Premium>0</Premium>
      <PriorPlan />
      <ProcessDate>0001-01-01T00:00:00</ProcessDate>
      <ProductType>String</ProductType>
    </CommissionRecord>
  </Commission>
  <CommissionBatchId>0</CommissionBatchId>
  <CommissionId>0</CommissionId>
  <CommissionRate>0</CommissionRate>
  <EndDate>0001-01-01T00:00:00</EndDate>
  <FieldName>String</FieldName>
  <FieldValue>String</FieldValue>
  <Part>0</Part>
  <PolicyNumber>String</PolicyNumber>
  <Premium>0</Premium>
  <StartDate>0001-01-01T00:00:00</StartDate>
</CommissionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommissionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bombshell.AgencyPlatform.API.Internal">
  <Commission>
    <CommissionRecord>
      <AdvanceRate>0</AdvanceRate>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <AgentNumber>String</AgentNumber>
      <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
      <CappedPayout>false</CappedPayout>
      <ChargebackAgent />
      <CommRate>0</CommRate>
      <CommissionBatchId>0</CommissionBatchId>
      <CommissionRecordId />
      <Company>String</Company>
      <ComponentsToProcess>String</ComponentsToProcess>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateProcessed>0001-01-01T00:00:00</DateProcessed>
      <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
      <GrossCommission>0</GrossCommission>
      <Id>0</Id>
      <InsuredAnnuitant>String</InsuredAnnuitant>
      <IsRenewal />
      <LastUpdatedUser>String</LastUpdatedUser>
      <LinkedId />
      <MID>String</MID>
      <Market>String</Market>
      <NumberOfCommissionListings>0</NumberOfCommissionListings>
      <Part>0</Part>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <Plan>String</Plan>
      <PlanType>String</PlanType>
      <PolicyNumber>String</PolicyNumber>
      <PolicyType>String</PolicyType>
      <Premium>0</Premium>
      <PriorPlan />
      <ProcessDate>0001-01-01T00:00:00</ProcessDate>
      <ProductType>String</ProductType>
    </CommissionRecord>
  </Commission>
  <ReportData>
    <CommissionRecord>
      <AdvanceRate>0</AdvanceRate>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <AgentNumber>String</AgentNumber>
      <ApprovalDate>0001-01-01T00:00:00</ApprovalDate>
      <CappedPayout>false</CappedPayout>
      <ChargebackAgent />
      <CommRate>0</CommRate>
      <CommissionBatchId>0</CommissionBatchId>
      <CommissionRecordId />
      <Company>String</Company>
      <ComponentsToProcess>String</ComponentsToProcess>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DateProcessed>0001-01-01T00:00:00</DateProcessed>
      <EffectiveDate>0001-01-01T00:00:00</EffectiveDate>
      <GrossCommission>0</GrossCommission>
      <Id>0</Id>
      <InsuredAnnuitant>String</InsuredAnnuitant>
      <IsRenewal />
      <LastUpdatedUser>String</LastUpdatedUser>
      <LinkedId />
      <MID>String</MID>
      <Market>String</Market>
      <NumberOfCommissionListings>0</NumberOfCommissionListings>
      <Part>0</Part>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <Plan>String</Plan>
      <PlanType>String</PlanType>
      <PolicyNumber>String</PolicyNumber>
      <PolicyType>String</PolicyType>
      <Premium>0</Premium>
      <PriorPlan />
      <ProcessDate>0001-01-01T00:00:00</ProcessDate>
      <ProductType>String</ProductType>
    </CommissionRecord>
  </ReportData>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</CommissionResponse>