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 .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/CommissionRequest HTTP/1.1 
Host: api2.exactmedicare.com 
Content-Type: text/jsv
Content-Length: length

{
	Commission: 
	[
		{
			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: {}
		}
	],
	CommissionId: 0,
	AgentId: 0,
	CommissionBatchId: 0,
	StartDate: 0001-01-01,
	EndDate: 0001-01-01,
	Action: String,
	FieldName: String,
	FieldValue: String,
	Carrier: String,
	Premium: 0,
	ChargebackOrPayoutAmount: 0,
	CommissionRate: 0,
	AdvanceRate: 0,
	Part: 0,
	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
			}
		]
	},
	Commission: 
	[
		{
			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: {}
		}
	],
	ReportData: 
	[
		{
			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: {}
		}
	]
}