Commissions Module API

API reference for commission processing and related workflows.

BriteCore v2 Commissions API endpoint wrappers.

britecore_sdk.api.api_calls.v2.commissions.delete_batch_payments(payment_ids=None, **kwargs)

Delete commission payments in batch..

POST /api/v2/commissions/delete_batch_payments

Parameters:

• payment_ids (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.delete_payment(payment_id=None, **kwargs)

Delete a single commission payment..

POST /api/v2/commissions/delete_payment

Parameters:

• payment_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_commission_payees(**kwargs)

Retrieve the list of commission payee agency numbers..

POST /api/v2/commissions/get_commission_payees

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_payment(commission_payment_id=None, **kwargs)

Retrieve a commission payment record..

POST /api/v2/commissions/get_payment

Parameters:

• commission_payment_id (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_unexported_commissions(**kwargs)

Retrieve commission records that have not yet been exported..

POST /api/v2/commissions/get_unexported_commissions

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.save_batch_payments(payments=None, **kwargs)

Save commission payments in batch..

POST /api/v2/commissions/save_batch_payments

Parameters:

• payments (list[dict[str, Any]] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.save_batch_payments_csv(data=None, **kwargs)

Save commission payments in batch from CSV data..

POST /api/v2/commissions/save_batch_payments_csv

Parameters:

• data (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.save_payment(amount=None, agency_number=None, **kwargs)

Save a single commission payment..

POST /api/v2/commissions/save_payment

Parameters:

• amount (float | int | None)

• agency_number (str | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.update_commission_payments_complete(commission_payment_ids=None, **kwargs)

Clear selected payments from the commission queue..

POST /api/v2/commissions/update_commission_payments_complete

Parameters:

• commission_payment_ids (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.batch_export_payments(commission_payment_ids=None, **kwargs)

Batch Export Payments.

POST /api/v2/commissions/batch_export_payments

Parameters:

• commission_payment_ids (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.batch_review_payments(commission_payment_ids=None, **kwargs)

Batch Review Payments.

POST /api/v2/commissions/batch_review_payments

Parameters:

• commission_payment_ids (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.batch_update_payment_methods(operations=None, **kwargs)

Batch Update Payment Methods.

POST /api/v2/commissions/batch_update_payment_methods

Parameters:

• operations (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.create_adjustment(source_accounting_id=None, adjustment_amount=None, **kwargs)

Create Adjustment.

POST /api/v2/commissions/create_adjustment

Parameters:

• source_accounting_id (Any | None)

• adjustment_amount (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.download_commission_report(report=None, year=None, month=None, contacts=None, **kwargs)

Download Commission Report.

POST /api/v2/commissions/download_commission_report

Parameters:

• report (str | None)

• year (str | None)

• month (str | None)

• contacts (list[str] | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.email_commission_report(contacts=None, report=None, **kwargs)

Email Commission Report.

POST /api/v2/commissions/email_commission_report

Parameters:

• contacts (Any | None)

• report (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_commission_accounting_entries(**kwargs)

Get Commission Accounting Entries.

POST /api/v2/commissions/get_commission_accounting_entries

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_commission_payment_composition(commission_payment_id=None, **kwargs)

Get Commission Payment Composition.

POST /api/v2/commissions/get_commission_payment_composition

Parameters:

• commission_payment_id (Any | None)

• kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_commission_payments(**kwargs)

Get Commission Payments.

POST /api/v2/commissions/get_commission_payments

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_delayed_commission_accounting_entries(**kwargs)

Get Delayed Commission Accounting Entries.

POST /api/v2/commissions/get_delayed_commission_accounting_entries

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.get_delayed_commission_entries_summary(**kwargs)

Get Delayed Commission Entries Summary.

POST /api/v2/commissions/get_delayed_commission_entries_summary

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.commissions.write_off_negative_amount(**kwargs)

Write Off Negative Amount.

POST /api/v2/commissions/write_off_negative_amount

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any