Oper Credits Third Parties API
The Third Parties API from Oper Credits — 20 operation(s) for third parties.
The Third Parties API from Oper Credits — 20 operation(s) for third parties.
openapi: 3.0.3
info:
title: Oper Credits Agent Documents Third Parties API
version: ''
tags:
- name: Third Parties
paths:
/api/third-parties/broker-relationships/:
get:
operationId: api_third_parties_broker_relationships_list
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BrokerRelationshipAuto'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
post:
operationId: api_third_parties_broker_relationships_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/broker-relationships/{id}/:
delete:
operationId: api_third_parties_broker_relationships_destroy
parameters:
- description: A unique integer value identifying this Broker Relationship.
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- jwtAuth: []
tags:
- Third Parties
get:
operationId: api_third_parties_broker_relationships_retrieve
parameters:
- description: A unique integer value identifying this Broker Relationship.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
patch:
operationId: api_third_parties_broker_relationships_partial_update
parameters:
- description: A unique integer value identifying this Broker Relationship.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBrokerRelationshipAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedBrokerRelationshipAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBrokerRelationshipAuto'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
put:
operationId: api_third_parties_broker_relationships_update
parameters:
- description: A unique integer value identifying this Broker Relationship.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerRelationshipAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/broker-territories/:
get:
operationId: api_third_parties_broker_territories_list
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BrokerTerritoryAuto'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
post:
operationId: api_third_parties_broker_territories_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/broker-territories/{id}/:
delete:
operationId: api_third_parties_broker_territories_destroy
parameters:
- description: A unique integer value identifying this Broker territory.
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- jwtAuth: []
tags:
- Third Parties
get:
operationId: api_third_parties_broker_territories_retrieve
parameters:
- description: A unique integer value identifying this Broker territory.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
patch:
operationId: api_third_parties_broker_territories_partial_update
parameters:
- description: A unique integer value identifying this Broker territory.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBrokerTerritoryAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedBrokerTerritoryAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBrokerTerritoryAuto'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
put:
operationId: api_third_parties_broker_territories_update
parameters:
- description: A unique integer value identifying this Broker territory.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerTerritoryAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/broker-users/:
get:
operationId: api_third_parties_broker_users_list
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
post:
operationId: api_third_parties_broker_users_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/broker-users/{id}/:
delete:
operationId: api_third_parties_broker_users_destroy
parameters:
- description: A unique integer value identifying this Third Party to Application User.
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: No response body
security:
- jwtAuth: []
tags:
- Third Parties
get:
operationId: api_third_parties_broker_users_retrieve
parameters:
- description: A unique integer value identifying this Third Party to Application User.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
patch:
operationId: api_third_parties_broker_users_partial_update
parameters:
- description: A unique integer value identifying this Third Party to Application User.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedThirdParty2BaseUserAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedThirdParty2BaseUserAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedThirdParty2BaseUserAuto'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
put:
operationId: api_third_parties_broker_users_update
parameters:
- description: A unique integer value identifying this Third Party to Application User.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
multipart/form-data:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ThirdParty2BaseUserAuto'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/brokers-imports/:
get:
operationId: api_third_parties_brokers_imports_list
parameters:
- description: Which field to use when ordering the results.
in: query
name: ordering
required: false
schema:
type: string
- description: '* `initialized` - Initialized
* `running` - Running
* `error` - Error
* `finished` - Finished'
in: query
name: status
schema:
enum:
- error
- finished
- initialized
- running
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BrokerBulkImportLog'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
post:
operationId: api_third_parties_brokers_imports_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerBulkImportLog'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BrokerBulkImportLog'
multipart/form-data:
schema:
$ref: '#/components/schemas/BrokerBulkImportLog'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerBulkImportLog'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/brokers-imports/{id}/:
get:
operationId: api_third_parties_brokers_imports_retrieve
parameters:
- description: A unique integer value identifying this Broker Bulk Import Log.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerBulkImportLog'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/brokers/:
get:
description: 'Returns the list of brokers.
For brokers, this returns only themselves.
For analysts, this returns all brokers.'
operationId: api_third_parties_brokers_list
parameters:
- description: A search term.
in: query
name: search
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ListBroker'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
post:
description: 'Returns the list of brokers.
For brokers, this returns only themselves.
For analysts, this returns all brokers.'
operationId: api_third_parties_brokers_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Broker'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Broker'
multipart/form-data:
schema:
$ref: '#/components/schemas/Broker'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Broker'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/brokers/direct-broker/:
get:
operationId: api_third_parties_brokers_direct_broker_retrieve
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DirectBroker'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/brokers/user-profiles/import:
post:
operationId: api_third_parties_brokers_user_profiles_import_create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerUserProfileBulkImport'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BrokerUserProfileBulkImport'
multipart/form-data:
schema:
$ref: '#/components/schemas/BrokerUserProfileBulkImport'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BrokerUserProfileBulkImport'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/brokers/{id}/:
get:
description: 'Returns the list of brokers.
For brokers, this returns only themselves.
For analysts, this returns all brokers.'
operationId: api_third_parties_brokers_retrieve
parameters:
- description: A unique integer value identifying this Broker.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Broker'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
patch:
description: 'Returns the list of brokers.
For brokers, this returns only themselves.
For analysts, this returns all brokers.'
operationId: api_third_parties_brokers_partial_update
parameters:
- description: A unique integer value identifying this Broker.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBroker'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedBroker'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBroker'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Broker'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
put:
description: 'Returns the list of brokers.
For brokers, this returns only themselves.
For analysts, this returns all brokers.'
operationId: api_third_parties_brokers_update
parameters:
- description: A unique integer value identifying this Broker.
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Broker'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Broker'
multipart/form-data:
schema:
$ref: '#/components/schemas/Broker'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Broker'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/estimators/:
get:
description: Returns the list of estimators.
operationId: api_third_parties_estimators_list
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ReducedEstimator'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/estimators/{id}/:
get:
description: Returns the list of estimators.
operationId: api_third_parties_estimators_retrieve
parameters:
- description: A unique integer value identifying this Estimator.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Estimator'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/insurance-providers/:
get:
description: Returns the list of insurance providers.
operationId: api_third_parties_insurance_providers_list
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ReducedInsuranceProvider'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/insurance-providers/{id}/:
get:
description: Returns the list of insurance providers.
operationId: api_third_parties_insurance_providers_retrieve
parameters:
- description: A unique integer value identifying this Insurance provider.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InsuranceProvider'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/lead-generators/:
get:
description: Returns the list of lead generators.
operationId: api_third_parties_lead_generators_list
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ReducedLeadGenerator'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/lead-generators/{id}/:
get:
description: Returns the list of lead generators.
operationId: api_third_parties_lead_generators_retrieve
parameters:
- description: A unique integer value identifying this Lead Generator.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LeadGenerator'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/notaries/:
get:
description: Returns the list of notaries.
operationId: api_third_parties_notaries_list
parameters:
- description: A search term.
in: query
name: search
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Notary'
type: array
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
/api/third-parties/notaries/{id}/:
get:
description: Returns the list of notaries.
operationId: api_third_parties_notaries_retrieve
parameters:
- description: A unique integer value identifying this Notary.
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Notary'
description: ''
security:
- jwtAuth: []
tags:
- Third Parties
components:
schemas:
ReducedLeadGenerator:
description: "Baseclass for Reduced serializers.\n\nWill validate whether the objects exists, and returns the instance in to_internal_value\nSubclasses must implement Meta with at least the model and field attributes\n\nRaises\n------\n Validations errors if the object doesn't exist\n OperBadConfigurationException if the model isn't set"
properties:
bank_account:
readOnly: true
type: string
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
readOnly: true
fsma_reference:
nullable: true
readOnly: true
type: string
id:
type: integer
name:
readOnly: true
type: string
vat_number:
readOnly: true
type: string
required:
- bank_account
- company_type
- fsma_reference
- id
- name
- vat_number
type: object
DirectBroker:
description: "Baseclass for Reduced serializers.\n\nWill validate whether the objects exists, and returns the instance in to_internal_value\nSubclasses must implement Meta with at least the model and field attributes\n\nRaises\n------\n Validations errors if the object doesn't exist\n OperBadConfigurationException if the model isn't set"
properties:
bank_account:
readOnly: true
type: string
company_registration_number:
nullable: true
readOnly: true
type: string
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
readOnly: true
fsma_reference:
nullable: true
readOnly: true
type: string
id:
type: integer
main_address:
additionalProperties: {}
nullable: true
readOnly: true
type: object
name:
readOnly: true
type: string
vat_number:
readOnly: true
type: string
required:
- bank_account
- company_registration_number
- company_type
- fsma_reference
- id
- main_address
- name
- vat_number
type: object
UserRole:
description: Can be managed at /resources/user-role
properties:
definition:
type: string
id:
type: integer
order:
readOnly: true
type: integer
required:
- definition
- id
- order
type: object
Estimator:
description: "Baseclass for Reduced serializers.\n\nWill validate whether the objects exists, and returns the instance in to_internal_value\nSubclasses must implement Meta with at least the model and field attributes\n\nRaises\n------\n Validations errors if the object doesn't exist\n OperBadConfigurationException if the model isn't set"
properties:
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
readOnly: true
type: array
bank_account:
readOnly: true
type: string
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
readOnly: true
default_for_active_directory:
readOnly: true
type: boolean
emails:
items:
$ref: '#/components/schemas/Profile2Email'
readOnly: true
type: array
external_reference:
maxLength: 128
readOnly: true
type: string
fsma_reference:
nullable: true
readOnly: true
type: string
id:
type: integer
is_active:
readOnly: true
type: boolean
name:
readOnly: true
type: string
oper_reference:
format: uuid
readOnly: true
type: string
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
readOnly: true
type: array
profile:
readOnly: true
type: integer
sector:
allOf:
- $ref: '#/components/schemas/Sector'
nullable: true
readOnly: true
vat_number:
readOnly: true
type: string
required:
- addresses
- bank_account
- company_type
- default_for_active_directory
- emails
- external_reference
- fsma_reference
- id
- is_active
- name
- oper_reference
- phone_numbers
- profile
- sector
- vat_number
type: object
BrokerTerritoryAuto:
properties:
broker:
type: integer
id:
readOnly: true
type: integer
location:
maxLength: 256
type: string
required:
- broker
- id
- location
type: object
ReducedBaseUser:
description: User reduced representation
properties:
first_name:
default: ''
readOnly: true
type: string
id:
type: integer
last_name:
default: ''
readOnly: true
type: string
role:
allOf:
- $ref: '#/components/schemas/UserRole'
readOnly: true
verified:
readOnly: true
type: boolean
required:
- first_name
- id
- last_name
- role
- verified
type: object
BulkUserProfile:
properties:
birth_city:
maxLength: 128
type: string
birth_date:
format: date
nullable: true
type: string
first_name:
maxLength: 64
type: string
last_name:
maxLength: 128
type: string
mother_maiden_name:
maxLength: 128
type: string
type: object
PatchedBrokerTerritoryAuto:
properties:
broker:
type: integer
id:
readOnly: true
type: integer
location:
maxLength: 256
type: string
type: object
Broker:
properties:
account_manager:
allOf:
- $ref: '#/components/schemas/ReducedBaseUser'
nullable: true
addresses:
items:
$ref: '#/components/schemas/Profile2Address'
type: array
bank_account:
type: string
commission_email:
allOf:
- $ref: '#/components/schemas/Profile2Email'
readOnly: true
company_type:
allOf:
- $ref: '#/components/schemas/CompanyType'
nullable: true
confiscate_commission:
type: boolean
emails:
items:
$ref: '#/components/schemas/Profile2Email'
type: array
fsma_reference:
nullable: true
type: string
fsma_status:
allOf:
- $ref: '#/components/schemas/FsmaStatus'
nullable: true
id:
readOnly: true
type: integer
legal_address:
allOf:
- $ref: '#/components/schemas/Profile2Address'
readOnly: true
main_contact:
allOf:
- $ref: '#/components/schemas/BaseUserProfileWithContacts'
readOnly: true
name:
type: string
outstanding_debt:
format: double
readOnly: true
type: number
phone_numbers:
items:
$ref: '#/components/schemas/Profile2Phone'
type: array
sector:
allOf:
- $ref: '#/components/schemas/Sector'
nullable: true
vat_number:
type: string
required:
- addresses
- commission_email
- emails
- id
- legal_address
- main_contact
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oper-credits/refs/heads/main/openapi/oper-credits-third-parties-api-openapi.yml