Brokerage back-office and accounting API covering the money side of the transaction — commissions, commission fees and tiers, deposits, conditions and condition types, classifications, employees, offices, transactions, and business and client contacts. This is the brokerWOLF/Back Office Online lineage, the system of record for brokerage accounting. 39 paths / 69 operations in the published OpenAPI 3.0.1 definition.
openapi: 3.0.1
info:
title: Back Office API
version: '1.0'
servers:
- url: 'https://api.lwolf.com/backoffice'
paths:
'/v1/transactions/{transactionId}/business-contacts':
get:
tags:
- Business Contacts
summary: Get Business Contacts
description: Returns all the business contacts for the specified transaction.
operationId: get-v1-transactions-transactionid-business-contacts
parameters:
- name: transactionId
in: path
description: The id of the transaction.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessContact'
example:
- id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
post:
tags:
- Business Contacts
summary: Create Business Contact
description: Creates a new business contact for the transaction.
operationId: post-v1-transactions-transactionid-business-contacts
parameters:
- name: transactionId
in: path
description: The id of the transaction.
required: true
schema:
type: string
format: uuid
requestBody:
description: The business contact to create.
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
responses:
'200':
description: OK
'201':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'409':
description: Conflict. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'422':
description: Validation failed. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'/v1/business-contacts/{businessContactId}':
get:
tags:
- Business Contacts
summary: Get Business Contact
description: Retrieves a single business contact.
operationId: get-v1-business-contacts-businesscontactid
parameters:
- name: businessContactId
in: path
description: The id of the business contact.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
patch:
tags:
- Business Contacts
summary: Update Business Contact
description: Make changes to existing business contacts.
operationId: patch-v1-business-contacts-businesscontactid
parameters:
- name: businessContactId
in: path
description: The id of the business contact.
required: true
schema:
type: string
format: uuid
requestBody:
description: The properties of the business contact to update.
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessContactPatchRequest'
example:
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'422':
description: Validation failed. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
delete:
tags:
- Business Contacts
summary: Delete Business Contact
description: Delete an existing business contact.
operationId: delete-v1-business-contacts-businesscontactid
parameters:
- name: businessContactId
in: path
description: The id of the business contact.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
/v1/classifications:
get:
tags:
- Classifications
summary: Get Classifications
operationId: get-v1-classifications
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Classification'
example:
- id: string
createdTimestamp: string
modifiedTimestamp: string
name: string
code: string
endCount: 0
endTypeCode: B
inactiveDate: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'/v1/classifications/{classificationId}':
get:
tags:
- Classifications
summary: Get Classification
operationId: get-v1-classifications-classificationid
parameters:
- name: classificationId
in: path
description: The id of the classification.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Classification'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
name: string
code: string
endCount: 0
endTypeCode: B
inactiveDate: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'/v1/transactions/{transactionId}/client-contacts':
get:
tags:
- Client Contacts
summary: Get Client Contacts
operationId: get-v1-transactions-transactionid-client-contacts
parameters:
- name: transactionId
in: path
description: The id of the transaction.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientContact'
example:
- id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
post:
tags:
- Client Contacts
summary: Create Client Contact
operationId: post-v1-transactions-transactionid-client-contacts
parameters:
- name: transactionId
in: path
description: The id of the transaction.
required: true
schema:
type: string
format: uuid
requestBody:
description: The client contact to create.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
responses:
'200':
description: OK
'201':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'403':
description: Permission denied. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'404':
description: Not found. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'409':
description: Conflict. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'422':
description: Validation failed. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'/v1/client-contacts/{clientContactId}':
get:
tags:
- Client Contacts
summary: Get Client Contact
operationId: get-v1-client-contacts-clientcontactid
parameters:
- name: clientContactId
in: path
description: The id of the client contact.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientContact'
example:
id: string
createdTimestamp: string
modifiedTimestamp: string
contactTypeId: string
endCode: B
prefix: string
firstName: string
lastName: string
companyName: string
addressLine1: string
addressLine2: string
addressCity: string
addressPostalCode: string
addressProvinceCode: string
addressCountryCode: string
phoneNumberMain: string
phoneNumberBusiness: string
phoneNumberMobile: string
faxNumberMain: string
emailAddressMain: string
emailAddressWork: string
contactType:
name: string
code: string
'400':
description: Invalid request. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
details:
- string
'401':
description: Unauthorized. See response body for details.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
id: string
code: 0
message: string
# --- truncated at 32 KB (337 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lone-wolf/refs/heads/main/openapi/lone-wolf-back-office-online-api-openapi.yml