Bombshell Agency Platform Service

<back to all web services

PolicyRequest

The following routes are available for this service:
GET, OPTIONS/v1/Policy/{PolicyNumber}

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

HTTP + JSV

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

POST /jsv/reply/PolicyRequest HTTP/1.1 
Host: api2.exactmedicare.com 
Content-Type: text/jsv
Content-Length: length

{
	PolicyNumber: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	Policy: 
	{
		IssueDate: 0001-01-01,
		PolicyNumber: String,
		Insured: String,
		Carrier: String,
		Plan: String,
		Premium: 0,
		CommissionRate: 0,
		Part: 0,
		AdvanceRate: 0,
		PolicyType: String,
		PolicyCode: String,
		Age: 0,
		ControlledBusiness: False,
		StatusId: 0,
		Type: String,
		PayoutsSoFar: 0,
		TotalPayouts: 0,
		PaidSoFar: 0,
		AdvanceAmount: 0,
		TotalPayoutAmount: 0,
		CanGenerateFutureCommissionRecords: False,
		Statuses: 
		[
			{
				ID: 0,
				PendingStatusName: String,
				PendingStatusDescription: String
			}
		],
		WritingAgents: 
		[
			{
				Id: 0,
				PolicyNumber: String,
				AgentId: 0,
				AgentNumber: String,
				AgentName: String,
				Part: 0
			}
		],
		CommissionRecords: 
		[
			{
				Id: 0,
				DateCreated: 0001-01-01,
				AgentNumber: String,
				AgentName: String,
				PolicyNumber: String,
				InsuredAnnuitant: String,
				ProcessDate: 0001-01-01,
				Premium: 0,
				GrossCommission: 0,
				CommRate: 0,
				Part: 0,
				PaymentDate: 0001-01-01,
				PolicyType: String,
				Company: String,
				AgentId: 0,
				DateProcessed: 0001-01-01,
				CommissionBatchId: 0,
				EffectiveDate: 0001-01-01,
				Market: String,
				ProductType: String,
				PlanType: String,
				Plan: String,
				LastUpdatedUser: String,
				AdvanceRate: 0,
				ApprovalDate: 0001-01-01,
				NumberOfCommissionListings: 0,
				ComponentsToProcess: String,
				CappedPayout: False,
				MID: String,
				ChargebackAgent: {},
				IsRenewal: {},
				PriorPlan: {},
				LinkedId: {},
				CommissionRecordId: {}
			}
		],
		CommissionListings: 
		[
			{
				ID: 0,
				ProcessDate: 0001-01-01,
				PaymentDate: 0001-01-01,
				AgentId: 0,
				AgentName: String,
				OAgentID: 0,
				OAgent: String,
				Policy: String,
				PolicyType: String,
				Insured: String,
				Premium: 0,
				Part: 0,
				PartPercent: 0,
				Amount: 0,
				Company: String,
				Gross: 0,
				AgentNumber: String,
				CommissionRate: 0,
				Description: String,
				CommissionBatchId: 0,
				Adjustment: False,
				CommissionRecordId: 0,
				FieldPayoutPercent: 0,
				AgentLevel: 0,
				DateCreated: 0001-01-01,
				SunfireId: 0,
				CommissionFutureListingId: 0,
				CommissionRecordTempRerunId: 0,
				CommissionNote: String,
				OrigProcessDate: 0001-01-01,
				OrigPaymentDate: 0001-01-01,
				EffectiveDate: 0001-01-01,
				CanPublish: False,
				MedicareIdNumber: String,
				StatementString: String,
				SubmitDate: 0001-01-01
			}
		],
		FutureCommissionRecords: 
		[
			{
				Id: 0,
				DateCreated: 0001-01-01,
				PayoutNumber: 0,
				ToBeMovedDate: 0001-01-01,
				MovedDate: 0001-01-01,
				AgentNumber: String,
				AgentName: String,
				PolicyNumber: String,
				InsuredAnnuitant: String,
				ProcessDate: 0001-01-01,
				Premium: 0,
				GrossCommission: 0,
				CommRate: 0,
				Part: 0,
				PolicyType: String,
				Company: String,
				AgentId: 0,
				IsRenewal: False,
				PolicyCode: String,
				Age: 0,
				AdvanceRate: 0,
				Plan: String,
				ControlledBusiness: False,
				CappedPayout: 0,
				LastUpdatedUser: String,
				CommissionRecordId: 0,
				CommissionBatchId: 0,
				NumberOfFutureCommissionListings: 0,
				FutureCommissionListings: 
				[
					{
						Id: 0,
						Type: String,
						TotalAmount: 0,
						TotalPayouts: 0,
						PayoutNumber: 0,
						ToBeMovedDate: 0001-01-01,
						MovedDate: 0001-01-01,
						CommissionListingId: 0,
						ProcessDate: 0001-01-01,
						PaymentDate: 0001-01-01,
						AgentId: 0,
						AgentName: String,
						OAgentID: 0,
						OAgent: String,
						Policy: String,
						PolicyType: String,
						Insured: String,
						Premium: 0,
						Part: 0,
						PartPercent: 0,
						Amount: 0,
						Company: String,
						Gross: 0,
						AgentNumber: String,
						CommissionRate: 0,
						Description: String,
						CommissionBatchId: 0,
						Adjustment: False,
						FutureCommissionRecordId: 0,
						Plan: String,
						AdvanceRate: 0,
						CommissionPercent: 0,
						AgentLevel: 0,
						GloEligible: False,
						LastUpdatedUser: String,
						ApprovalDate: 0001-01-01
					}
				]
			}
		],
		FutureCommissionListings: 
		[
			{
				Id: 0,
				Type: String,
				TotalAmount: 0,
				TotalPayouts: 0,
				PayoutNumber: 0,
				ToBeMovedDate: 0001-01-01,
				MovedDate: 0001-01-01,
				CommissionListingId: 0,
				ProcessDate: 0001-01-01,
				PaymentDate: 0001-01-01,
				AgentId: 0,
				AgentName: String,
				OAgentID: 0,
				OAgent: String,
				Policy: String,
				PolicyType: String,
				Insured: String,
				Premium: 0,
				Part: 0,
				PartPercent: 0,
				Amount: 0,
				Company: String,
				Gross: 0,
				AgentNumber: String,
				CommissionRate: 0,
				Description: String,
				CommissionBatchId: 0,
				Adjustment: False,
				FutureCommissionRecordId: 0,
				Plan: String,
				AdvanceRate: 0,
				CommissionPercent: 0,
				AgentLevel: 0,
				GloEligible: False,
				LastUpdatedUser: String,
				ApprovalDate: 0001-01-01
			}
		],
		Hierarchies: 
		[
			{
				Id: 0,
				PolicyNumber: String,
				WritingAgentId: 0,
				PolicyWritingAgent: 
				{
					Id: 0,
					PolicyNumber: String,
					AgentId: 0,
					AgentNumber: String,
					AgentName: String,
					Part: 0
				},
				HierarchyDate: 0001-01-01
			}
		],
		PolicyNotes: 
		[
			{
				Id: 0,
				PolicyNumber: String,
				Username: String,
				Message: String,
				CreatedDate: 0001-01-01
			}
		],
		PolicyCommissionRecordsLogs: 
		[
			{
				CommissionRecordLogs: 
				[
					{
						Id: 0,
						CommissionRecordId: 0,
						DateCreated: 0001-01-01,
						AgentNumber: String,
						AgentName: String,
						PolicyNumber: String,
						InsuredAnnuitant: String,
						ProcessDate: 0001-01-01,
						Premium: 0,
						GrossCommission: 0,
						CommRate: 0,
						Part: 0,
						PaymentDate: 0001-01-01,
						PolicyType: String,
						Company: String,
						AgentId: 0,
						DateProcessed: 0001-01-01,
						IsRenewal: False,
						PolicyCode: String,
						Age: 0,
						CommissionBatchId: 0,
						AdvanceRate: 0,
						Plan: String,
						CarrierAgentNumber: String,
						ControlledBusiness: False,
						CappedPayout: 0,
						FileBatchId: 0,
						FileDate: 0001-01-01,
						LastUpdatedUser: String,
						ApprovalDate: 0001-01-01,
						DateModified: 0001-01-01,
						ChangeType: String
					}
				],
				CommissionRecordId: 0
			}
		],
		CurrentPayoutMatrix: 
		{
			Id: 0,
			Tier: String,
			ProductType: String,
			FullComp: 0,
			AgentPay: 0,
			AdminFee: 0,
			Payout: 0,
			PayoutType: String,
			AdjustedPayout: 0,
			PolicyState: String,
			PlanType: String,
			FullCompPerMonth: 0,
			AgentPayPerMonth: 0,
			AdminFeePerMonth: 0,
			Carrier: String
		}
	}
}